Repository: transitive-bullshit/agentic
Branch: main
Commit: beffa8ecfaff
Files: 1049
Total size: 24.1 MB

Directory structure:
gitextract_8yb8dgx_/

├── .cursor/
│   └── rules/
│       └── general.mdc
├── .editorconfig
├── .github/
│   ├── funding.yml
│   └── workflows/
│       ├── main.yml
│       └── release.yml
├── .gitignore
├── .npmrc
├── .prettierignore
├── .vscode/
│   └── launch.json
├── CLAUDE.md
├── Tiltfile
├── apps/
│   ├── api/
│   │   ├── drizzle.config.ts
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── api-v1/
│   │   │   │   ├── auth/
│   │   │   │   │   ├── github-callback.ts
│   │   │   │   │   ├── github-exchange.ts
│   │   │   │   │   ├── github-init.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   ├── sign-in-with-password.ts
│   │   │   │   │   ├── sign-up-with-password.ts
│   │   │   │   │   └── utils.ts
│   │   │   │   ├── consumers/
│   │   │   │   │   ├── admin-activate-consumer.ts
│   │   │   │   │   ├── admin-get-consumer-by-api-key.ts
│   │   │   │   │   ├── create-billing-portal-session.ts
│   │   │   │   │   ├── create-consumer-billing-portal-session.ts
│   │   │   │   │   ├── create-consumer-checkout-session.ts
│   │   │   │   │   ├── create-consumer.ts
│   │   │   │   │   ├── get-consumer-by-project-identifier.ts
│   │   │   │   │   ├── get-consumer.ts
│   │   │   │   │   ├── list-consumers.ts
│   │   │   │   │   ├── list-project-consumers.ts
│   │   │   │   │   ├── refresh-consumer-api-key.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   ├── update-consumer.ts
│   │   │   │   │   └── utils.ts
│   │   │   │   ├── deployments/
│   │   │   │   │   ├── admin-get-deployment-by-identifier.ts
│   │   │   │   │   ├── create-deployment.ts
│   │   │   │   │   ├── get-deployment-by-identifier.ts
│   │   │   │   │   ├── get-deployment.ts
│   │   │   │   │   ├── get-public-deployment-by-identifier.ts
│   │   │   │   │   ├── list-deployments.ts
│   │   │   │   │   ├── publish-deployment.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   └── update-deployment.ts
│   │   │   │   ├── health-check.ts
│   │   │   │   ├── index.ts
│   │   │   │   ├── projects/
│   │   │   │   │   ├── create-project.ts
│   │   │   │   │   ├── get-project-by-identifier.ts
│   │   │   │   │   ├── get-project.ts
│   │   │   │   │   ├── get-public-project-by-identifier.ts
│   │   │   │   │   ├── get-public-project.ts
│   │   │   │   │   ├── list-projects.ts
│   │   │   │   │   ├── list-public-projects.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   └── update-project.ts
│   │   │   │   ├── storage/
│   │   │   │   │   └── get-signed-storage-upload-url.ts
│   │   │   │   ├── teams/
│   │   │   │   │   ├── create-team.ts
│   │   │   │   │   ├── delete-team.ts
│   │   │   │   │   ├── get-team.ts
│   │   │   │   │   ├── list-teams.ts
│   │   │   │   │   ├── members/
│   │   │   │   │   │   ├── create-team-member.ts
│   │   │   │   │   │   ├── delete-team-member.ts
│   │   │   │   │   │   ├── schemas.ts
│   │   │   │   │   │   └── update-team-member.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   └── update-team.ts
│   │   │   │   ├── users/
│   │   │   │   │   ├── get-user.ts
│   │   │   │   │   ├── schemas.ts
│   │   │   │   │   └── update-user.ts
│   │   │   │   └── webhooks/
│   │   │   │       └── stripe-webhook.ts
│   │   │   ├── db/
│   │   │   │   ├── index.ts
│   │   │   │   ├── schema/
│   │   │   │   │   ├── account.ts
│   │   │   │   │   ├── auth-data.ts
│   │   │   │   │   ├── common.test.ts
│   │   │   │   │   ├── common.ts
│   │   │   │   │   ├── consumer.ts
│   │   │   │   │   ├── deployment.ts
│   │   │   │   │   ├── index.ts
│   │   │   │   │   ├── log-entry.ts
│   │   │   │   │   ├── project.ts
│   │   │   │   │   ├── team-member.ts
│   │   │   │   │   ├── team.ts
│   │   │   │   │   └── user.ts
│   │   │   │   ├── schemas.ts
│   │   │   │   ├── types.test.ts
│   │   │   │   ├── types.ts
│   │   │   │   └── utils.ts
│   │   │   ├── lib/
│   │   │   │   ├── __snapshots__/
│   │   │   │   │   └── storage.test.ts.snap
│   │   │   │   ├── acl-admin.ts
│   │   │   │   ├── acl-public-project.ts
│   │   │   │   ├── acl-team-admin.ts
│   │   │   │   ├── acl-team-member.ts
│   │   │   │   ├── acl.ts
│   │   │   │   ├── auth/
│   │   │   │   │   ├── auth-storage.ts
│   │   │   │   │   ├── create-auth-token.ts
│   │   │   │   │   ├── drizzle-auth-storage.ts
│   │   │   │   │   └── upsert-or-link-user-account.ts
│   │   │   │   ├── billing/
│   │   │   │   │   ├── create-stripe-checkout-session.ts
│   │   │   │   │   ├── upsert-stripe-connect-customer.ts
│   │   │   │   │   ├── upsert-stripe-customer.ts
│   │   │   │   │   ├── upsert-stripe-pricing-resources.ts
│   │   │   │   │   └── upsert-stripe-subscription.ts
│   │   │   │   ├── cache-control.ts
│   │   │   │   ├── consumers/
│   │   │   │   │   ├── upsert-consumer-stripe-checkout.ts
│   │   │   │   │   ├── upsert-consumer.ts
│   │   │   │   │   └── utils.ts
│   │   │   │   ├── create-avatar.ts
│   │   │   │   ├── create-consumer-api-key.ts
│   │   │   │   ├── deployments/
│   │   │   │   │   ├── get-deployment-by-id.ts
│   │   │   │   │   ├── normalize-deployment-version.ts
│   │   │   │   │   ├── publish-deployment.ts
│   │   │   │   │   └── try-get-deployment-by-identifier.ts
│   │   │   │   ├── ensure-auth-user.ts
│   │   │   │   ├── ensure-unique-namespace.ts
│   │   │   │   ├── env.ts
│   │   │   │   ├── exit-hooks.ts
│   │   │   │   ├── external/
│   │   │   │   │   ├── github.ts
│   │   │   │   │   ├── resend.ts
│   │   │   │   │   ├── sentry.ts
│   │   │   │   │   └── stripe.ts
│   │   │   │   ├── middleware/
│   │   │   │   │   ├── authenticate.ts
│   │   │   │   │   ├── index.ts
│   │   │   │   │   ├── me.ts
│   │   │   │   │   └── team.ts
│   │   │   │   ├── openapi-utils.ts
│   │   │   │   ├── projects/
│   │   │   │   │   └── try-get-project-by-identifier.ts
│   │   │   │   ├── storage.test.ts
│   │   │   │   ├── storage.ts
│   │   │   │   ├── temp
│   │   │   │   ├── types.ts
│   │   │   │   └── utils.ts
│   │   │   ├── oauth-redirect.ts
│   │   │   ├── reset.d.ts
│   │   │   └── server.ts
│   │   ├── tsconfig.json
│   │   ├── tsup.config.ts
│   │   └── vitest.config.ts
│   ├── e2e/
│   │   ├── bin/
│   │   │   ├── deploy-fixtures.ts
│   │   │   ├── publish-fixtures.ts
│   │   │   └── seed-db.ts
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   ├── http-e2e.test.ts.snap
│   │   │   │   └── mcp-e2e.test.ts.snap
│   │   │   ├── agentic-examples.ts
│   │   │   ├── deploy-projects.ts
│   │   │   ├── dev-client.ts
│   │   │   ├── dev-fixtures.ts
│   │   │   ├── env.ts
│   │   │   ├── http-e2e.test.ts
│   │   │   ├── http-fixtures.ts
│   │   │   ├── mcp-e2e.test.ts
│   │   │   ├── mcp-fixtures.ts
│   │   │   └── publish-deployments.ts
│   │   ├── tsconfig.json
│   │   └── vitest.config.ts
│   ├── gateway/
│   │   ├── .dev.vars.example
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── app.ts
│   │   │   ├── lib/
│   │   │   │   ├── __snapshots__/
│   │   │   │   │   └── utils.test.ts.snap
│   │   │   │   ├── agentic-client.ts
│   │   │   │   ├── cf-validate-json-schema.ts
│   │   │   │   ├── create-http-request-for-openapi-operation.ts
│   │   │   │   ├── create-http-response-from-mcp-tool-call-response.ts
│   │   │   │   ├── durable-mcp-client.ts
│   │   │   │   ├── durable-mcp-server.ts
│   │   │   │   ├── env.ts
│   │   │   │   ├── external/
│   │   │   │   │   └── stripe.ts
│   │   │   │   ├── fetch-cache.ts
│   │   │   │   ├── get-admin-consumer.ts
│   │   │   │   ├── get-admin-deployment.ts
│   │   │   │   ├── get-request-cache-key.ts
│   │   │   │   ├── get-tool-args-from-request.ts
│   │   │   │   ├── get-tool.ts
│   │   │   │   ├── handle-mcp-tool-call-error.ts
│   │   │   │   ├── normalize-url.test.ts
│   │   │   │   ├── normalize-url.ts
│   │   │   │   ├── rate-limits/
│   │   │   │   │   ├── durable-rate-limiter.ts
│   │   │   │   │   └── enforce-rate-limit.ts
│   │   │   │   ├── record-tool-call-usage.ts
│   │   │   │   ├── reset.d.ts
│   │   │   │   ├── resolve-edge-request.ts
│   │   │   │   ├── resolve-http-edge-request.ts
│   │   │   │   ├── resolve-mcp-edge-request.ts
│   │   │   │   ├── resolve-origin-tool-call.ts
│   │   │   │   ├── temp
│   │   │   │   ├── temp-mcp
│   │   │   │   ├── transform-http-response-to-mcp-tool-call-response.ts
│   │   │   │   ├── types.ts
│   │   │   │   ├── update-origin-request.ts
│   │   │   │   ├── utils.test.ts
│   │   │   │   └── utils.ts
│   │   │   └── worker.ts
│   │   ├── tsconfig.json
│   │   ├── vitest.config.ts
│   │   └── wrangler.jsonc
│   └── web/
│       ├── components.json
│       ├── next.config.ts
│       ├── package.json
│       ├── postcss.config.mjs
│       ├── public/
│       │   ├── adamsbridge.hdr
│       │   └── schema.json
│       ├── readme.md
│       ├── src/
│       │   ├── app/
│       │   │   ├── about/
│       │   │   │   └── page.tsx
│       │   │   ├── app/
│       │   │   │   ├── app-dashboard.tsx
│       │   │   │   ├── consumers/
│       │   │   │   │   ├── [consumerId]/
│       │   │   │   │   │   ├── app-consumer-index.tsx
│       │   │   │   │   │   └── page.tsx
│       │   │   │   │   ├── app-consumers-index.tsx
│       │   │   │   │   └── page.tsx
│       │   │   │   ├── page.tsx
│       │   │   │   ├── projects/
│       │   │   │   │   ├── [namespace]/
│       │   │   │   │   │   └── [project-slug]/
│       │   │   │   │   │       ├── app-project-index.tsx
│       │   │   │   │   │       └── page.tsx
│       │   │   │   │   ├── app-projects-index.tsx
│       │   │   │   │   └── page.tsx
│       │   │   │   └── temp-testing
│       │   │   ├── auth/
│       │   │   │   └── [provider]/
│       │   │   │       └── success/
│       │   │   │           ├── oauth-success-callback.tsx
│       │   │   │           └── page.tsx
│       │   │   ├── contact/
│       │   │   │   └── page.tsx
│       │   │   ├── globals.css
│       │   │   ├── layout.tsx
│       │   │   ├── login/
│       │   │   │   ├── login-form.tsx
│       │   │   │   └── page.tsx
│       │   │   ├── logout/
│       │   │   │   └── page.tsx
│       │   │   ├── marketplace/
│       │   │   │   ├── marketplace-index.tsx
│       │   │   │   ├── page.tsx
│       │   │   │   └── projects/
│       │   │   │       └── [namespace]/
│       │   │   │           └── [project-slug]/
│       │   │   │               ├── marketplace-nav.tsx
│       │   │   │               ├── marketplace-public-project-detail.tsx
│       │   │   │               ├── page.tsx
│       │   │   │               └── utils.ts
│       │   │   ├── not-found.tsx
│       │   │   ├── page.tsx
│       │   │   ├── pricing/
│       │   │   │   └── page.tsx
│       │   │   ├── privacy/
│       │   │   │   └── page.tsx
│       │   │   ├── providers.tsx
│       │   │   ├── publishing/
│       │   │   │   └── page.tsx
│       │   │   ├── signup/
│       │   │   │   ├── page.tsx
│       │   │   │   └── signup-form.tsx
│       │   │   └── terms/
│       │   │       └── page.tsx
│       │   ├── components/
│       │   │   ├── active-link.tsx
│       │   │   ├── agentic-provider.tsx
│       │   │   ├── app-consumers-list.tsx
│       │   │   ├── app-projects-list.tsx
│       │   │   ├── bootstrap.tsx
│       │   │   ├── code-block/
│       │   │   │   ├── highlight.ts
│       │   │   │   └── index.tsx
│       │   │   ├── confetti.tsx
│       │   │   ├── dark-mode-toggle.tsx
│       │   │   ├── demand-side-cta.tsx
│       │   │   ├── dots-section.tsx
│       │   │   ├── example-agentic-configs.tsx
│       │   │   ├── example-usage-section.tsx
│       │   │   ├── example-usage.tsx
│       │   │   ├── feature.tsx
│       │   │   ├── footer/
│       │   │   │   ├── dynamic.tsx
│       │   │   │   └── index.tsx
│       │   │   ├── github-star-counter.tsx
│       │   │   ├── grid-pattern.tsx
│       │   │   ├── header/
│       │   │   │   ├── authenticated-header.tsx
│       │   │   │   ├── index.tsx
│       │   │   │   ├── styles.module.css
│       │   │   │   └── unauthenticated-header.tsx
│       │   │   ├── hero-button/
│       │   │   │   ├── index.tsx
│       │   │   │   └── styles.module.css
│       │   │   ├── hero-simulation-2.tsx
│       │   │   ├── hero-simulation.tsx
│       │   │   ├── loading-indicator/
│       │   │   │   ├── index.tsx
│       │   │   │   ├── loading-dark.json
│       │   │   │   ├── loading-light.json
│       │   │   │   └── styles.module.css
│       │   │   ├── markdown/
│       │   │   │   ├── index.tsx
│       │   │   │   ├── ssr-markdown.tsx
│       │   │   │   └── styles.module.css
│       │   │   ├── mcp-gateway-features.tsx
│       │   │   ├── mcp-marketplace-features.tsx
│       │   │   ├── page-container.tsx
│       │   │   ├── posthog-provider.tsx
│       │   │   ├── project-pricing-plans/
│       │   │   │   ├── index.tsx
│       │   │   │   └── project-pricing-plan.tsx
│       │   │   ├── public-project.tsx
│       │   │   ├── supply-side-cta.tsx
│       │   │   ├── theme-provider.tsx
│       │   │   └── ui/
│       │   │       ├── avatar.tsx
│       │   │       ├── breadcrumb.tsx
│       │   │       ├── button.tsx
│       │   │       ├── collapsible.tsx
│       │   │       ├── dropdown-menu.tsx
│       │   │       ├── input.tsx
│       │   │       ├── label.tsx
│       │   │       ├── tabs.tsx
│       │   │       └── tooltip.tsx
│       │   ├── icons/
│       │   │   ├── github.tsx
│       │   │   ├── twitter.tsx
│       │   │   └── typescript.tsx
│       │   ├── lib/
│       │   │   ├── auth-copy.ts
│       │   │   ├── bootstrap.ts
│       │   │   ├── config.ts
│       │   │   ├── default-agentic-api-client.ts
│       │   │   ├── developer-config.ts
│       │   │   ├── global-api.ts
│       │   │   ├── notifications.ts
│       │   │   ├── query-client.ts
│       │   │   ├── utils.test.ts
│       │   │   └── utils.ts
│       │   └── reset.d.ts
│       └── tsconfig.json
├── contributing.md
├── docs/
│   ├── contact.mdx
│   ├── docs.json
│   ├── index.mdx
│   ├── inject.js
│   ├── marketplace/
│   │   ├── index.mdx
│   │   ├── mcp-clients/
│   │   │   ├── claude-code.mdx
│   │   │   ├── claude-desktop.mdx
│   │   │   ├── cline.mdx
│   │   │   ├── cursor.mdx
│   │   │   ├── raycast.mdx
│   │   │   ├── trae.mdx
│   │   │   ├── vscode.mdx
│   │   │   ├── warp.mdx
│   │   │   └── windsurf.mdx
│   │   └── ts-sdks/
│   │       ├── ai-sdk.mdx
│   │       ├── genkit.mdx
│   │       ├── langchain.mdx
│   │       ├── llamaindex.mdx
│   │       ├── mastra.mdx
│   │       ├── openai-chat.mdx
│   │       └── openai-responses.mdx
│   ├── package.json
│   └── publishing/
│       ├── config/
│       │   ├── auth.mdx
│       │   ├── caching.mdx
│       │   ├── examples.mdx
│       │   ├── index.mdx
│       │   ├── pricing.mdx
│       │   ├── rate-limits.mdx
│       │   └── tool-config.mdx
│       ├── guides/
│       │   ├── existing-mcp-server.mdx
│       │   ├── existing-openapi-service.mdx
│       │   ├── py-fastmcp.mdx
│       │   ├── ts-fastmcp.mdx
│       │   ├── ts-mcp-hono.mdx
│       │   ├── ts-modelfetch.mdx
│       │   ├── ts-openapi-hono.mdx
│       │   └── ts-xmcp.mdx
│       ├── index.mdx
│       ├── origin/
│       │   ├── index.mdx
│       │   ├── metadata.mdx
│       │   └── security.mdx
│       └── quickstart.mdx
├── eslint.config.js
├── examples/
│   ├── mcp-servers/
│   │   ├── context7/
│   │   │   ├── agentic.config.ts
│   │   │   ├── package.json
│   │   │   └── tsconfig.json
│   │   ├── github/
│   │   │   ├── agentic.config.ts
│   │   │   ├── package.json
│   │   │   └── tsconfig.json
│   │   ├── search/
│   │   │   ├── .dev.vars.example
│   │   │   ├── agentic.config.ts
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── env.ts
│   │   │   │   └── worker.ts
│   │   │   ├── tsconfig.json
│   │   │   └── wrangler.jsonc
│   │   └── xmcp/
│   │       ├── .gitignore
│   │       ├── agentic.config.ts
│   │       ├── package.json
│   │       ├── src/
│   │       │   └── tools/
│   │       │       └── greet.ts
│   │       ├── tsconfig.json
│   │       ├── vercel.json
│   │       ├── xmcp-env.d.ts
│   │       └── xmcp.config.ts
│   └── ts-sdks/
│       ├── ai-sdk/
│       │   ├── bin/
│       │   │   ├── mcp-filesystem.ts
│       │   │   ├── weather-experimental-active-tools.ts
│       │   │   └── weather.ts
│       │   ├── package.json
│       │   └── tsconfig.json
│       ├── genkit/
│       │   ├── bin/
│       │   │   └── weather.ts
│       │   ├── package.json
│       │   └── tsconfig.json
│       ├── langchain/
│       │   ├── bin/
│       │   │   └── weather.ts
│       │   ├── package.json
│       │   └── tsconfig.json
│       ├── llamaindex/
│       │   ├── bin/
│       │   │   └── weather.ts
│       │   ├── package.json
│       │   └── tsconfig.json
│       ├── mastra/
│       │   ├── bin/
│       │   │   └── weather.ts
│       │   ├── package.json
│       │   └── tsconfig.json
│       └── openai/
│           ├── bin/
│           │   ├── weather-responses.ts
│           │   └── weather.ts
│           ├── package.json
│           └── tsconfig.json
├── fixtures/
│   ├── invalid/
│   │   ├── invalid-metadata-0/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-metadata-1/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-name-0/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-name-1/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-name-2/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-origin-url-0/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-origin-url-1/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-origin-url-2/
│   │   │   └── agentic.config.json
│   │   ├── invalid-origin-url-3/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-slug-0/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-slug-1/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-slug-2/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-slug-3/
│   │   │   └── agentic.config.ts
│   │   ├── invalid-slug-4/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-base-inconsistent/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-custom-inconsistent/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-duplicate-0/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-duplicate-1/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-empty-0/
│   │   │   └── agentic.config.ts
│   │   ├── pricing-empty-1/
│   │   │   └── agentic.config.ts
│   │   └── pricing-empty-2/
│   │       └── agentic.config.ts
│   ├── package.json
│   ├── tsconfig.json
│   └── valid/
│       ├── basic-mcp/
│       │   ├── agentic.config.ts
│       │   ├── package.json
│       │   ├── src/
│       │   │   ├── env.ts
│       │   │   └── index.ts
│       │   └── tsconfig.json
│       ├── basic-openapi/
│       │   ├── agentic.config.ts
│       │   └── jsonplaceholder.json
│       ├── basic-raw-free-json/
│       │   └── agentic.config.json
│       ├── basic-raw-free-ts/
│       │   └── agentic.config.ts
│       ├── everything-openapi/
│       │   ├── agentic.config.ts
│       │   ├── package.json
│       │   ├── readme.md
│       │   ├── src/
│       │   │   ├── exit-hooks.ts
│       │   │   ├── lib/
│       │   │   │   └── db.ts
│       │   │   ├── routes/
│       │   │   │   ├── custom-cache-control-tool.ts
│       │   │   │   ├── custom-rate-limit-approximate-tool.ts
│       │   │   │   ├── custom-rate-limit-tool.ts
│       │   │   │   ├── disabled-for-free-plan-tool.ts
│       │   │   │   ├── disabled-rate-limit-tool.ts
│       │   │   │   ├── disabled-tool.ts
│       │   │   │   ├── echo-headers.ts
│       │   │   │   ├── echo.ts
│       │   │   │   ├── get-user.ts
│       │   │   │   ├── health-check.ts
│       │   │   │   ├── no-cache-cache-control-tool.ts
│       │   │   │   ├── no-store-cache-control-tool.ts
│       │   │   │   ├── pure.ts
│       │   │   │   ├── strict-additional-properties.ts
│       │   │   │   └── unpure-marked-pure.ts
│       │   │   └── server.ts
│       │   └── tsconfig.json
│       ├── metadata-0/
│       │   ├── agentic.config.ts
│       │   └── readme.md
│       ├── metadata-1/
│       │   └── agentic.config.ts
│       ├── metadata-2/
│       │   └── agentic.config.ts
│       ├── pricing-3-plans/
│       │   └── agentic.config.ts
│       ├── pricing-custom-0/
│       │   └── agentic.config.ts
│       ├── pricing-freemium/
│       │   └── agentic.config.ts
│       ├── pricing-monthly-annual/
│       │   └── agentic.config.ts
│       └── pricing-pay-as-you-go/
│           └── agentic.config.ts
├── legacy/
│   ├── .editorconfig
│   ├── .github/
│   │   ├── funding.yml
│   │   └── workflows/
│   │       ├── main.yml
│   │       └── release.yml
│   ├── .gitignore
│   ├── .husky/
│   │   └── _/
│   │       └── pre-commit
│   ├── .npmrc
│   ├── .prettierignore
│   ├── .vscode/
│   │   └── launch.json
│   ├── docs/
│   │   ├── intro.mdx
│   │   ├── mint.json
│   │   ├── quickstart.mdx
│   │   ├── scratch.md
│   │   ├── sdks/
│   │   │   ├── genaiscript.mdx
│   │   │   └── xsai.mdx
│   │   ├── tools/
│   │   │   ├── airtable.mdx
│   │   │   ├── apollo.mdx
│   │   │   ├── arxiv.mdx
│   │   │   ├── bing.mdx
│   │   │   ├── brave-search.mdx
│   │   │   ├── calculator.mdx
│   │   │   ├── clearbit.mdx
│   │   │   ├── dexa.mdx
│   │   │   ├── diffbot.mdx
│   │   │   ├── duck-duck-go.mdx
│   │   │   ├── e2b.mdx
│   │   │   ├── exa.mdx
│   │   │   ├── firecrawl.mdx
│   │   │   ├── google-custom-search.mdx
│   │   │   ├── google-docs.mdx
│   │   │   ├── google-drive.mdx
│   │   │   ├── gravatar.mdx
│   │   │   ├── hacker-news.mdx
│   │   │   ├── hunter.mdx
│   │   │   ├── jina.mdx
│   │   │   ├── leadmagic.mdx
│   │   │   ├── mcp.mdx
│   │   │   ├── midjourney.mdx
│   │   │   ├── notion.mdx
│   │   │   ├── novu.mdx
│   │   │   ├── open-meteo.mdx
│   │   │   ├── people-data-labs.mdx
│   │   │   ├── perigon.mdx
│   │   │   ├── polygon.mdx
│   │   │   ├── predict-leads.mdx
│   │   │   ├── proxycurl.mdx
│   │   │   ├── reddit.mdx
│   │   │   ├── rocketreach.mdx
│   │   │   ├── searxng.mdx
│   │   │   ├── serpapi.mdx
│   │   │   ├── serper.mdx
│   │   │   ├── slack.mdx
│   │   │   ├── social-data.mdx
│   │   │   ├── tavily.mdx
│   │   │   ├── twilio.mdx
│   │   │   ├── twitter.mdx
│   │   │   ├── typeform.mdx
│   │   │   ├── weather.mdx
│   │   │   ├── wikidata.mdx
│   │   │   ├── wikipedia.mdx
│   │   │   ├── wolfram-alpha.mdx
│   │   │   ├── youtube.mdx
│   │   │   └── zoominfo.mdx
│   │   └── usage.mdx
│   ├── eslint.config.js
│   ├── examples/
│   │   ├── dexter/
│   │   │   ├── bin/
│   │   │   │   ├── code-interpreter.ts
│   │   │   │   ├── election-news.ts
│   │   │   │   └── weather.ts
│   │   │   ├── package.json
│   │   │   └── tsconfig.json
│   │   ├── playground/
│   │   │   ├── bin/
│   │   │   │   └── scratch.ts
│   │   │   ├── package.json
│   │   │   └── tsconfig.json
│   │   └── xsai/
│   │       ├── bin/
│   │       │   └── weather.ts
│   │       ├── package.json
│   │       └── tsconfig.json
│   ├── license
│   ├── package.json
│   ├── packages/
│   │   ├── airtable/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── airtable-client.ts
│   │   │   │   ├── airtable.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── apollo/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── apollo-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── arxiv/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── arxiv-client.ts
│   │   │   │   ├── index.ts
│   │   │   │   └── utils.ts
│   │   │   └── tsconfig.json
│   │   ├── bing/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── bing-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── brave-search/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── brave-search-client.ts
│   │   │   │   ├── brave-search.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── calculator/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── calculator.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── clearbit/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── clearbit-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── diffbot/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── diffbot-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── duck-duck-go/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── duck-duck-go-client.ts
│   │   │   │   ├── index.ts
│   │   │   │   └── paginate.ts
│   │   │   └── tsconfig.json
│   │   ├── e2b/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── e2b.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── exa/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── exa-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── firecrawl/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── firecrawl-client.test.ts
│   │   │   │   ├── firecrawl-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── github/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── github-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── google-custom-search/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── google-custom-search-client.ts
│   │   │   │   ├── index.ts
│   │   │   │   └── paginate.ts
│   │   │   └── tsconfig.json
│   │   ├── google-docs/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── google-docs-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── google-drive/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── google-drive-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── gravatar/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── gravatar-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── hacker-news/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── hacker-news-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── hunter/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── hunter-client.ts
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── jigsawstack/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   ├── integration.test.ts
│   │   │   │   ├── jigsawstack-client.ts
│   │   │   │   └── tool.test.ts
│   │   │   └── tsconfig.json
│   │   ├── jina/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── jina-client.ts
│   │   │   └── tsconfig.json
│   │   ├── leadmagic/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── leadmagic-client.ts
│   │   │   └── tsconfig.json
│   │   ├── midjourney/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── midjourney-client.ts
│   │   │   └── tsconfig.json
│   │   ├── notion/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   ├── notion-client.ts
│   │   │   │   └── notion.ts
│   │   │   └── tsconfig.json
│   │   ├── novu/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── novu-client.ts
│   │   │   └── tsconfig.json
│   │   ├── open-meteo/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   ├── open-meteo-client.ts
│   │   │   │   └── open-meteo.ts
│   │   │   └── tsconfig.json
│   │   ├── openapi-to-ts/
│   │   │   ├── bin/
│   │   │   │   └── openapi-to-ts.ts
│   │   │   ├── fixtures/
│   │   │   │   ├── generated/
│   │   │   │   │   ├── firecrawl-client.ts
│   │   │   │   │   ├── firecrawl.ts
│   │   │   │   │   ├── github-client.ts
│   │   │   │   │   ├── github.ts
│   │   │   │   │   ├── notion-client.ts
│   │   │   │   │   ├── notion.ts
│   │   │   │   │   ├── open-meteo-client.ts
│   │   │   │   │   ├── open-meteo.ts
│   │   │   │   │   ├── pet-store-client.ts
│   │   │   │   │   ├── pet-store.ts
│   │   │   │   │   ├── petstore-expanded-client.ts
│   │   │   │   │   ├── petstore-expanded.ts
│   │   │   │   │   ├── security-client.ts
│   │   │   │   │   ├── security.ts
│   │   │   │   │   ├── tic-tac-toe-client.ts
│   │   │   │   │   └── tic-tac-toe.ts
│   │   │   │   └── openapi/
│   │   │   │       ├── firecrawl.json
│   │   │   │       ├── github.json
│   │   │   │       ├── notion.json
│   │   │   │       ├── open-meteo.yaml
│   │   │   │       ├── pet-store.json
│   │   │   │       ├── petstore-expanded.json
│   │   │   │       ├── readme.json
│   │   │   │       ├── security.json
│   │   │   │       ├── stripe.json
│   │   │   │       └── tic-tac-toe.json
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── __snapshots__/
│   │   │   │   │   └── generate-ts-from-openapi.test.ts.snap
│   │   │   │   ├── generate-ts-from-openapi.test.ts
│   │   │   │   ├── generate-ts-from-openapi.ts
│   │   │   │   ├── index.ts
│   │   │   │   ├── openapi-parameters-to-json-schema.ts
│   │   │   │   ├── types.ts
│   │   │   │   └── utils.ts
│   │   │   ├── tsconfig.json
│   │   │   └── tsup.config.ts
│   │   ├── people-data-labs/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── people-data-labs-client.ts
│   │   │   └── tsconfig.json
│   │   ├── perigon/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── perigon-client.ts
│   │   │   └── tsconfig.json
│   │   ├── polygon/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── polygon-client.ts
│   │   │   └── tsconfig.json
│   │   ├── predict-leads/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── predict-leads-client.ts
│   │   │   └── tsconfig.json
│   │   ├── proxycurl/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── proxycurl-client.ts
│   │   │   └── tsconfig.json
│   │   ├── reddit/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── reddit-client.ts
│   │   │   └── tsconfig.json
│   │   ├── rocketreach/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── rocketreach-client.ts
│   │   │   └── tsconfig.json
│   │   ├── searxng/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── searxng-client.ts
│   │   │   └── tsconfig.json
│   │   ├── slack/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   ├── slack-client.ts
│   │   │   │   └── slack.ts
│   │   │   └── tsconfig.json
│   │   ├── social-data/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── social-data-client.ts
│   │   │   └── tsconfig.json
│   │   ├── stdlib/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   └── index.ts
│   │   │   └── tsconfig.json
│   │   ├── tavily/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── tavily-client.ts
│   │   │   └── tsconfig.json
│   │   ├── twilio/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── twilio-client.ts
│   │   │   └── tsconfig.json
│   │   ├── twitter/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── client.ts
│   │   │   │   ├── error.ts
│   │   │   │   ├── index.ts
│   │   │   │   ├── nango.ts
│   │   │   │   ├── twitter-client.ts
│   │   │   │   ├── types.ts
│   │   │   │   └── utils.ts
│   │   │   └── tsconfig.json
│   │   ├── typeform/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── typeform-client.ts
│   │   │   └── tsconfig.json
│   │   ├── weather/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── weather-client.ts
│   │   │   └── tsconfig.json
│   │   ├── wikidata/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── wikidata-client.ts
│   │   │   └── tsconfig.json
│   │   ├── wikipedia/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── wikipedia-client.ts
│   │   │   └── tsconfig.json
│   │   ├── wolfram-alpha/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── wolfram-alpha-client.ts
│   │   │   └── tsconfig.json
│   │   ├── xsai/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   ├── xsai.test.ts
│   │   │   │   └── xsai.ts
│   │   │   └── tsconfig.json
│   │   ├── youtube/
│   │   │   ├── package.json
│   │   │   ├── src/
│   │   │   │   ├── index.ts
│   │   │   │   └── youtube-client.ts
│   │   │   └── tsconfig.json
│   │   └── zoominfo/
│   │       ├── package.json
│   │       ├── src/
│   │       │   ├── index.ts
│   │       │   └── zoominfo-client.ts
│   │       └── tsconfig.json
│   ├── pnpm-workspace.yaml
│   ├── readme.md
│   ├── tsconfig.json
│   ├── tsup.config.ts
│   ├── turbo.json
│   └── vite.config.ts
├── license
├── package.json
├── packages/
│   ├── api-client/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── agentic-api-client.ts
│   │   │   ├── index.ts
│   │   │   └── types.ts
│   │   └── tsconfig.json
│   ├── cli/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── cli.ts
│   │   │   ├── commands/
│   │   │   │   ├── debug.ts
│   │   │   │   ├── deploy.ts
│   │   │   │   ├── get.ts
│   │   │   │   ├── list.ts
│   │   │   │   ├── publish.ts
│   │   │   │   ├── signin.ts
│   │   │   │   ├── signout.ts
│   │   │   │   ├── signup.ts
│   │   │   │   └── whoami.ts
│   │   │   ├── lib/
│   │   │   │   ├── auth-store.ts
│   │   │   │   ├── auth.ts
│   │   │   │   ├── commander.d.ts
│   │   │   │   ├── env.ts
│   │   │   │   ├── exit-hooks.ts
│   │   │   │   ├── handle-error.ts
│   │   │   │   ├── prompt-for-deployment-version.ts
│   │   │   │   ├── reset.d.ts
│   │   │   │   ├── resolve-deployment.ts
│   │   │   │   └── utils.ts
│   │   │   └── types.ts
│   │   ├── tsconfig.json
│   │   └── tsup.config.ts
│   ├── emails/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── emails/
│   │   │   │   └── send-verify-code-email.tsx
│   │   │   ├── index.ts
│   │   │   └── resend-email-client.tsx
│   │   └── tsconfig.json
│   ├── hono/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── env.ts
│   │   │   ├── error-handler.ts
│   │   │   ├── header-utils.ts
│   │   │   ├── index.ts
│   │   │   ├── json-rpc-errors.ts
│   │   │   ├── logger/
│   │   │   │   ├── index.ts
│   │   │   │   ├── logger.ts
│   │   │   │   └── utils.ts
│   │   │   ├── middleware/
│   │   │   │   ├── access-logger.ts
│   │   │   │   ├── index.ts
│   │   │   │   ├── init.ts
│   │   │   │   ├── response-time.ts
│   │   │   │   └── unless.ts
│   │   │   ├── sentry.test.ts
│   │   │   ├── sentry.ts
│   │   │   └── types.ts
│   │   └── tsconfig.json
│   ├── json-schema/
│   │   ├── license
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── coercion.ts
│   │   │   ├── deep-compare-strict.ts
│   │   │   ├── dereference.ts
│   │   │   ├── format.ts
│   │   │   ├── index.ts
│   │   │   ├── pointer.ts
│   │   │   ├── types.ts
│   │   │   ├── ucs2-length.ts
│   │   │   ├── validate.ts
│   │   │   └── validator.ts
│   │   ├── test/
│   │   │   ├── coercion.test.ts
│   │   │   ├── index.test.ts
│   │   │   ├── json-schema-test-suite.ts
│   │   │   ├── meta-schema.ts
│   │   │   ├── types.ts
│   │   │   ├── unsupported.ts
│   │   │   └── validator.spec.ts
│   │   └── tsconfig.json
│   ├── openapi-utils/
│   │   ├── fixtures/
│   │   │   ├── basic.json
│   │   │   ├── firecrawl.json
│   │   │   ├── mixed.json
│   │   │   ├── notion.json
│   │   │   ├── open-meteo.yaml
│   │   │   ├── pet-store.json
│   │   │   ├── petstore-expanded.json
│   │   │   ├── readme.json
│   │   │   ├── security.json
│   │   │   └── tic-tac-toe.json
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   ├── get-tools-from-openapi-spec.test.ts.snap
│   │   │   │   └── validate-openapi-spec.test.ts.snap
│   │   │   ├── get-tools-from-openapi-spec.test.ts
│   │   │   ├── get-tools-from-openapi-spec.ts
│   │   │   ├── index.ts
│   │   │   ├── openapi-parameters-to-json-schema.ts
│   │   │   ├── redocly-config.ts
│   │   │   ├── types.ts
│   │   │   ├── utils.ts
│   │   │   ├── validate-json-schema-object.ts
│   │   │   ├── validate-openapi-spec.test.ts
│   │   │   └── validate-openapi-spec.ts
│   │   └── tsconfig.json
│   ├── platform/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   └── load-agentic-config.test.ts.snap
│   │   │   ├── define-config.ts
│   │   │   ├── index.ts
│   │   │   ├── load-agentic-config.test.ts
│   │   │   ├── load-agentic-config.ts
│   │   │   ├── origin-adapters/
│   │   │   │   ├── mcp.ts
│   │   │   │   └── openapi.ts
│   │   │   ├── parse-agentic-project-config.ts
│   │   │   ├── resolve-agentic-project-config.ts
│   │   │   ├── resolve-metadata-file.ts
│   │   │   ├── resolve-metadata-files.ts
│   │   │   ├── resolve-metadata.ts
│   │   │   ├── resolve-origin-adapter.ts
│   │   │   ├── types.ts
│   │   │   ├── validate-agentic-project-config.ts
│   │   │   ├── validate-metadata-file.ts
│   │   │   ├── validate-metadata-files.ts
│   │   │   ├── validate-origin-adapter.ts
│   │   │   ├── validate-origin-url.ts
│   │   │   ├── validate-pricing.ts
│   │   │   └── validate-tools.ts
│   │   └── tsconfig.json
│   ├── platform-core/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   └── utils.test.ts.snap
│   │   │   ├── errors.ts
│   │   │   ├── hash-object.test.ts
│   │   │   ├── hash-object.ts
│   │   │   ├── index.ts
│   │   │   ├── rate-limit-headers.ts
│   │   │   ├── types.test.ts
│   │   │   ├── types.ts
│   │   │   ├── utils.test.ts
│   │   │   └── utils.ts
│   │   └── tsconfig.json
│   ├── tool-client/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── agentic-tool-client.ts
│   │   │   └── index.ts
│   │   └── tsconfig.json
│   ├── types/
│   │   ├── bin/
│   │   │   └── generate-project-config-json-schema.ts
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   └── rate-limit.test.ts.snap
│   │   │   ├── agentic-project-config.test.ts
│   │   │   ├── agentic-project-config.ts
│   │   │   ├── auth-subjects.ts
│   │   │   ├── index.ts
│   │   │   ├── mcp.ts
│   │   │   ├── openapi.d.ts
│   │   │   ├── origin-adapter.ts
│   │   │   ├── pricing.test.ts
│   │   │   ├── pricing.ts
│   │   │   ├── rate-limit.test.ts
│   │   │   ├── rate-limit.ts
│   │   │   ├── temp
│   │   │   ├── tools.ts
│   │   │   ├── types.ts
│   │   │   ├── utils.ts
│   │   │   └── webhook.ts
│   │   └── tsconfig.json
│   └── validators/
│       ├── package.json
│       ├── readme.md
│       ├── src/
│       │   ├── __snapshots__/
│       │   │   ├── parse-deployment-identifier.test.ts.snap
│       │   │   ├── parse-project-identifier.test.ts.snap
│       │   │   └── parse-tool-identifier.test.ts.snap
│       │   ├── index.ts
│       │   ├── namespace-blacklist.ts
│       │   ├── parse-deployment-identifier.test.ts
│       │   ├── parse-deployment-identifier.ts
│       │   ├── parse-project-identifier.test.ts
│       │   ├── parse-project-identifier.ts
│       │   ├── parse-tool-identifier.test.ts
│       │   ├── parse-tool-identifier.ts
│       │   ├── tool-name-blacklist.ts
│       │   ├── types.ts
│       │   ├── utils.ts
│       │   ├── validators.test.ts
│       │   └── validators.ts
│       └── tsconfig.json
├── pnpm-workspace.yaml
├── readme.md
├── stdlib/
│   ├── ai-sdk/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── ai-sdk.test.ts
│   │   │   ├── ai-sdk.ts
│   │   │   └── index.ts
│   │   └── tsconfig.json
│   ├── core/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── __snapshots__/
│   │   │   │   ├── parse-structured-output.test.ts.snap
│   │   │   │   └── utils.test.ts.snap
│   │   │   ├── _utils.ts
│   │   │   ├── ai-function-set.test.ts
│   │   │   ├── ai-function-set.ts
│   │   │   ├── assert.ts
│   │   │   ├── create-ai-function.test.ts
│   │   │   ├── create-ai-function.ts
│   │   │   ├── echo.ts
│   │   │   ├── errors.ts
│   │   │   ├── fns.ts
│   │   │   ├── index.ts
│   │   │   ├── message.test.ts
│   │   │   ├── message.ts
│   │   │   ├── parse-structured-output.test.ts
│   │   │   ├── parse-structured-output.ts
│   │   │   ├── reset.d.ts
│   │   │   ├── schema.test.ts
│   │   │   ├── schema.ts
│   │   │   ├── types.ts
│   │   │   ├── utils.test.ts
│   │   │   ├── utils.ts
│   │   │   ├── zod-to-json-schema.test.ts
│   │   │   └── zod-to-json-schema.ts
│   │   └── tsconfig.json
│   ├── genkit/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── genkit.test.ts
│   │   │   ├── genkit.ts
│   │   │   └── index.ts
│   │   ├── tsconfig.json
│   │   └── vitest.config.ts
│   ├── langchain/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   ├── langchain.test.ts
│   │   │   └── langchain.ts
│   │   └── tsconfig.json
│   ├── license
│   ├── llamaindex/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   ├── llamaindex.test.ts
│   │   │   └── llamaindex.ts
│   │   └── tsconfig.json
│   ├── mastra/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   ├── mastra.test.ts
│   │   │   └── mastra.ts
│   │   └── tsconfig.json
│   ├── mcp/
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   ├── mcp-tools.ts
│   │   │   ├── paginate.ts
│   │   │   └── types.ts
│   │   └── tsconfig.json
│   ├── serpapi/
│   │   ├── package.json
│   │   ├── readme.md
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   └── serpapi-client.ts
│   │   └── tsconfig.json
│   └── serper/
│       ├── package.json
│       ├── readme.md
│       ├── src/
│       │   ├── index.ts
│       │   └── serper-client.ts
│       └── tsconfig.json
├── todo.md
├── tsconfig.json
├── tsup.config.ts
└── turbo.json

================================================
FILE CONTENTS
================================================

================================================
FILE: .cursor/rules/general.mdc
================================================
---
description:
globs:
alwaysApply: false
---
---
description: General TypeScript coding guidelines
globs:
---

## General

- Write elegant, concise, and readable code
- Prefer `const` over `let` (never use `var`)
- Use kebab-case for file and directory names
- Use clear, descriptive names for variables, functions, and components

## Modules

### Imports & Exports

- Always use ESM `import` and `export` (never use CJS `require`)
  - File imports should never use an extension (NOT `.js`, `.ts` or `.tsx`).
  - GOOD examples:
    - `import { Foo } from './foo'`
    - `import { type Route } from './types/root'`
    - `import zod from 'zod'`
    - `import { logger } from '~/types'`
  - BAD examples:
    - `import { Foo } from './foo.js'`
    - `import { type Route } from './types/root.js'`
    - `import { Foo } from './foo.ts'`
- Always prefer named exports over default exports

### Packages

All packages must follow these `package.json` rules:

- `type` must be set to `module`

## TypeScript

- Avoid semicolons at the end of lines
- Use TypeScript's utility types (e.g., `Partial`, `Pick`, `Omit`) to manipulate existing types
- Create custom types for complex data structures used throughout the application
- If possible, avoid using `any`/`unknown` or casting values like `(value as any)` in TypeScript outside of test files e.g. `*.test.ts` or test fixtures e.g. `**/test-data.ts`.
- Don't rely on `typeof`, `ReturnType<>`, `Awaited<>`, etc for complex type inference (it's ok for simple types)
- You can use `as const` as needed for better type inference
- Functions should accept an object parameter instead of multiple parameters
  - Good examples:
    ```ts
    function myFunction({ foo, bar }: { foo: boolean; bar: string }) {}
    function VideoPlayer({ sid }: { sid: string }) {}
    ```
  - Bad examples:
    ```ts
    function myFunction(foo: boolean, bar: string, baz: number) {}
    ```
- Arguments should generally be destructured in the function definition, not the function body.
  - Good example:
    ```ts
    function myFunction({ foo, bar }: { foo: boolean; bar: string }) {}
    ```
  - Bad example:
    ```ts
    function myFunction(args: { foo: boolean; bar: string }) {
      const { foo, bar } = args
    }
    ```
- Zod should be used to parse untrusted data, but not for data that is trusted like function arguments
- Prefer Zod unions over Zod enums
  - For example, this union `z.union([ z.literal('youtube'), z.literal('spotify') ])` is better than this enum `z.enum([ 'youtube', 'spotify' ])`
- Promises (and `async` functions which implicitly create Promises) must always be properly handled, either via:
  - Using `await` to wait for the Promise to resolve successfully
  - Using `.then` or `.catch` to handle Promise resolution
  - Returning a Promise to a calling function which itself has to handle the Promise.

## Node.js

- Utilize the `node:` protocol when importing Node.js modules (e.g., `import fs from 'node:fs/promises'`)
- Prefer promise-based APIs over Node's legacy callback APIs
- Use environment variables for secrets (avoid hardcoding sensitive information)

### Web Standard APIs

Always prefer using standard web APIs like `fetch`, `WebSocket`, and `ReadableStream` when possible. Avoid redundant libraries (like `node-fetch`).

- Prefer the `fetch` API for making HTTP requests instead of Node.js modules like `http` or `https`
  - Use the native `fetch` API instead of `node-fetch` or polyfilled `cross-fetch`
  - Use the `ky` library for HTTP requests instead of `axios` or `superagent`
- Use the WHATWG `URL` and `URLSearchParams` classes instead of the Node.js `url` module
- Use `Request` and `Response` objects from the Fetch API instead of Node.js-specific request and response objects

## Error Handling

- Prefer `async`/`await` over `.then()` and `.catch()`
- Always handle errors correctly (eg: `try`/`catch` or `.catch()`)
- Avoid swallowing errors silently; always log or handle caught errors appropriately

## Comments

Comments should be used to document and explain code. They should complement the use of descriptive variable and function names and type declarations.

- Add comments to explain complex sections of code
- Add comments that will improve the autocompletion preview in IDEs (eg: functions and types)
- Don't add comments that just reword symbol names or repeat type declarations
- Use **JSDoc** formatting for comments (not TSDoc or inline comments)

## Logging

- Just use `console` for logging.

## Testing

### Unit Testing

- **All unit tests should use Vitest**
  - DO NOT attempt to install or use other testing libraries like Jest
- Test files should be named `[target].test.ts` and placed in the same directory as the code they are testing (NOT a separate directory)
  - Good example: `src/my-file.ts` and `src/my-file.test.ts`
  - Bad example: `src/my-file.ts` and `src/test/my-file.test.ts` or `test/my-file.test.ts` or `src/__tests__/my-file.test.ts`
- Tests should be run with `pnpm test:unit`
- It's acceptable to use `any`/`unknown` in test files (such as `*.test.ts`) or test fixtures (like `**/test-data.ts`) to facilitate mocking or stubbing external modules or partial function arguments, referencing the usage guidelines in the TypeScript section.
- Frontend react code does not need unit tests

### Test Coverage

- Test critical business logic and edge cases
- Don't add tests for trivial code or just to increase test coverage
- Don't make tests too brittle or flaky by relying on implementation details

## Git

- When possible, combine the `git add` and `git commit` commands into a single `git commit -am` command, to speed things up


================================================
FILE: .editorconfig
================================================
root = true

[*]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true


================================================
FILE: .github/funding.yml
================================================
github: [transitive-bullshit]


================================================
FILE: .github/workflows/main.yml
================================================
name: CI

on: [push]

jobs:
  test:
    name: Test Node.js ${{ matrix.node-version }}
    runs-on: ubuntu-latest

    strategy:
      fail-fast: true
      matrix:
        node-version:
          - 22

    env:
      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
      NODE_OPTIONS: --max-old-space-size=8192

    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'pnpm'

      - run: pnpm install --frozen-lockfile --strict-peer-dependencies

      - name: Cache turbo build setup
        uses: actions/cache@v4
        with:
          path: .turbo
          key: ${{ runner.os }}-node-${{ matrix.node-version }}-turbo-${{ github.sha }}
          restore-keys: |
            ${{ runner.os }}-node-${{ matrix.node-version }}-turbo-

      - run: pnpm build
      - run: pnpm test


================================================
FILE: .github/workflows/release.yml
================================================
name: Release

on:
  push:
    tags:
      - 'v*'
  workflow_dispatch:

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: pnpm
      - run: pnpm dlx changelogithub
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


================================================
FILE: .gitignore
================================================
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
.next/

# production
build/
dist/

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# dotenv files
.env
.env.production
.env.staging
.env.test
.env*.local

# cloudflare env vars
.dev.vars
.dev.vars.production
.dev.vars.staging
.dev.vars.test

# turbo
.turbo

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

old/
out/

.wrangler
.sentryclirc
.eslintcache
.nitro
.tanstack

.xmcp


================================================
FILE: .npmrc
================================================
enable-pre-post-scripts=true
package-manager-strict=false


================================================
FILE: .prettierignore
================================================
# autogenerated files
packages/types/src/openapi.d.ts
apps/web/src/routeTree.gen.ts
legacy/packages/openapi-to-ts/fixtures/generated
examples/mcp-servers/xmcp/xmcp-env.d.ts


================================================
FILE: .vscode/launch.json
================================================
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Debug API",
      "type": "node",
      "request": "launch",

      // Debug server in VSCode
      "cwd": "${workspaceFolder}/apps/api",
      "program": "src/server.ts",
      // "program": "${file}",

      /*
       * Path to tsx binary
       * Assuming locally installed
       */
      "runtimeExecutable": "tsx",

      /*
       * Open terminal when debugging starts (Optional)
       * Useful to see console.logs
       */
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",

      // Files to exclude from debugger (e.g. call stack)
      "skipFiles": [
        // Node.js internal core modules
        "<node_internals>/**"

        // Ignore all dependencies (optional)
        // "${workspaceFolder}/node_modules/**"
      ]
    }
    // Wrangler's vscode support seems to be extremely buggy. It sometimes works
    // 1/10th of the time, but nothing I tried could improve that consistency.
    // Will use browser debugger instead for now.
    // {
    //   "name": "gateway",
    //   "type": "node",
    //   "request": "attach",
    //   "port": 9229,
    //   "cwd": "${workspaceFolder}/apps/gateway",
    //   // "cwd": "${workspaceFolder}",
    //   // "cwd": "/",
    //   "attachExistingChildren": false,
    //   "autoAttachChildProcesses": false,
    //   "sourceMaps": true,
    //   "outFiles": ["${workspaceFolder}/apps/gateway/.wrangler/tmp/**/*"],
    //   "resolveSourceMapLocations": null,
    //   // "resolveSourceMapLocations": ["**", "!**/node_modules/**"],
    //   "skipFiles": ["<node_internals>/**"],
    //   "internalConsoleOptions": "neverOpen",
    //   "restart": true
    // },
    // {
    //   "name": "Wrangler",
    //   "type": "node",
    //   "request": "attach",
    //   "port": 9229,
    //   "cwd": "/",
    //   "resolveSourceMapLocations": null,
    //   "attachExistingChildren": false,
    //   "autoAttachChildProcesses": false,
    //   "sourceMaps": true // works with or without this line (supposedly)
    // }
  ]
  // "compounds": [
  //   {
  //     "name": "Debug Workers",
  //     "configurations": ["gateway"],
  //     "stopAll": true
  //   }
  // ]
}


================================================
FILE: CLAUDE.md
================================================
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

This is a monorepo for Agentic - a platform that provides API gateway services for MCP (Model Context Protocol) and OpenAPI integrations.

### Core Architecture

The platform consists of:

- **API Service** (`apps/api/`) - Platform backend API with authentication, billing, and resource management
- **Gateway Service** (`apps/gateway/`) - Cloudflare Worker that proxies requests to origin MCP/OpenAPI services
- **Website** (`apps/web/`) - Next.js site for both the marketing site and authenticated webapp
- **E2E Tests** (`apps/e2e/`) - End-to-end test suite for HTTP and MCP gateway requests
- **Shared Packages** (`packages/`) - Common utilities, types, validators, and config
- **StdLib Packages** (`stdlib/`) - TS AI SDK adapters

The gateway accepts HTTP requests at `https://gateway.agentic.so/deploymentIdentifier/tool-name` or `https://gateway.agentic.so/deploymentIdentifier/mcp` for MCP.

### Development Commands

**Main development workflow:**

- `pnpm dev` - Start all services in development mode
- `pnpm build` - Build all packages and apps (except for the website)
- `pnpm test` - Run all tests (format, lint, typecheck, unit, but not e2e tests)
- `pnpm clean` - Clean all build artifacts

**Individual test commands:**

- `pnpm test:format` - Check code formatting with Prettier
- `pnpm test:lint` - Run ESLint across all packages
- `pnpm test:typecheck` - Run TypeScript type checking
- `pnpm test:unit` - Run unit tests with Vitest

**Code quality:**

- `pnpm fix` - Auto-fix formatting and linting issues
- `pnpm knip` - Check for unused dependencies

**E2E testing:**

- (from the `apps/e2e` directory)
- `pnpm e2e` - Run all E2E tests
- `pnpm e2e-http` - Run HTTP edge E2E tests
- `pnpm e2e-mcp` - Run MCP edge E2E tests

### Key Database Models

The system uses Drizzle ORM with PostgreSQL. Core entities:

- **User** - Platform users
- **Team** - Organizations with members and billing
- **Project** - Namespace API products comprised of immutable Deployments
- **Deployment** - Immutable instances of MCP/OpenAPI services, including gateway and pricing config
- **Consumer** - Customer subscription tracking usage and billing

### Agentic Configuration

Agentic projects use `agentic.config.{ts,js,json}` files to define:

- Project name and metadata
- Origin adapter (MCP server or OpenAPI spec)
- Tool configurations and permissions
- Pricing plans and rate limits
- Authentication requirements

The platform supports both MCP servers and OpenAPI specifications as origin adapters.

### Gateway Request Flow

1. Request hits gateway with deployment identifier
2. Gateway validates consumer authentication/rate limits/caching
3. Request is transformed and forwarded to origin service
4. Response is processed and returned with appropriate headers
5. Usage is tracked for billing and analytics

### Environment Setup

All apps require environment variables for:

- Database connections (`DATABASE_URL`)
- External services (Stripe, GitHub, Resend, Sentry)
- Internal services (API, gateway, etc)
- Authentication secrets
- Stripe secrets
- Admin API keys
- Sentry DSN
- etc

## Coding Conventions

### General

- Write elegant, concise, and readable code
- Prefer `const` over `let` (never use `var`)
- Use kebab-case for file and directory names
- Use clear, descriptive names for variables, functions, and components

### Modules

- Always use ESM `import` and `export` (never use CJS `require`)
  - File imports should never use an extension (NOT `.js`, `.ts` or `.tsx`).
  - GOOD examples:
    - `import { Foo } from './foo'`
    - `import { type Route } from './types/root'`
    - `import zod from 'zod'`
    - `import { logger } from '~/types'`
  - BAD examples:
    - `import { Foo } from './foo.js'`
    - `import { type Route } from './types/root.js'`
    - `import { Foo } from './foo.ts'`
- Always prefer named exports over default exports except for when default exports are required (like in Next.js `page.tsx` components)

### Packages

All packages must follow these `package.json` rules:

- `type` must be set to `module`

### TypeScript

- Avoid semicolons at the end of lines
- Use TypeScript's utility types (e.g., `Partial`, `Pick`, `Omit`) to manipulate existing types
- Create custom types for complex data structures used throughout the application
- If possible, avoid using `any`/`unknown` or casting values like `(value as any)` in TypeScript outside of test files e.g. `*.test.ts` or test fixtures e.g. `**/test-data.ts`.
- Try not to rely on `typeof`, `ReturnType<>`, `Awaited<>`, etc for complex type inference (it's ok for simple types)
- You can use `as const` as needed for better type inference
- Functions should accept an object parameter instead of multiple parameters
  - GOOD examples:
    ```ts
    function myFunction({ foo, bar }: { foo: boolean; bar: string }) {}
    function VideoPlayer({ sid }: { sid: string }) {}
    ```
  - BAD examples:
    ```ts
    function myFunction(foo: boolean, bar: string, baz: number) {}
    ```
- Arguments should generally be destructured in the function definition, not the function body.
  - GOOD example:
    ```ts
    function myFunction({ foo, bar }: { foo: boolean; bar: string }) {}
    function exampleWithOptionalParams({
      foo = 'example'
    }: { foo?: string } = {}) {}
    ```
  - BAD example:
    ```ts
    function myFunction(opts: { foo: boolean; bar: string }) {
      const { foo, bar } = opts
    }
    ```
- Zod should be used to parse untrusted data, but not for data that is trusted like function arguments
- Prefer Zod unions over Zod enums
  - For example, this union `z.union([ z.literal('youtube'), z.literal('spotify') ])` is better than this enum `z.enum([ 'youtube', 'spotify' ])`
- Promises (and `async` functions which implicitly create Promises) must always be properly handled, either via:
  - Using `await` to wait for the Promise to resolve successfully
  - Using `.then` or `.catch` to handle Promise resolution
  - Returning a Promise to a calling function which itself has to handle the Promise.

## Node.js

- Utilize the `node:` protocol when importing Node.js modules (e.g., `import fs from 'node:fs/promises'`)
- Prefer promise-based APIs over Node's legacy callback APIs
- Use environment variables for secrets (avoid hardcoding sensitive information)

### Web Standard APIs

Always prefer using standard web APIs like `fetch`, `WebSocket`, and `ReadableStream` when possible. Avoid redundant libraries (like `node-fetch`).

- Prefer the `fetch` API for making HTTP requests instead of Node.js modules like `http` or `https`
  - Prefer using the `ky` `fetch` wrapper for HTTP requests instead of `axios`, `superagent`, `node-fetch` or any other HTTP request library
  - Never use `node-fetch`; prefer `ky` or native `fetch` directly
- Use the WHATWG `URL` and `URLSearchParams` classes instead of the Node.js `url` module
- Use `Request` and `Response` objects from the Fetch API instead of Node.js-specific request and response objects

### Error Handling

- Prefer `async`/`await` over `.then()` and `.catch()`
- Always handle errors correctly (eg: `try`/`catch` or `.catch()`)
- Avoid swallowing errors silently; always log or handle caught errors appropriately

### Comments

Comments should be used to document and explain code. They should complement the use of descriptive variable and function names and type declarations.

- Add comments to explain complex sections of code
- Add comments that will improve the autocompletion preview in IDEs (eg: functions and types)
- Don't add comments that just reword symbol names or repeat type declarations
- Use **JSDoc** formatting for comments (not TSDoc or inline comments)

### Logging

- Just use `console` for logging.

### Testing

#### Unit Testing

- **All unit tests should use Vitest**
  - DO NOT attempt to install or use other testing libraries like Jest
- Test files should be named `[target].test.ts` and placed in the same directory as the code they are testing (NOT a separate directory)
  - GOOD example: `src/my-file.ts` and `src/my-file.test.ts`
  - BAD example: `src/my-file.ts` and `src/test/my-file.test.ts` or `test/my-file.test.ts` or `src/__tests__/my-file.test.ts`
- Tests should be run with `pnpm test:unit`
- You may use `any`/`unknown` in test files (such as `*.test.ts`) or test fixtures (like `**/test-data.ts`) to facilitate mocking or stubbing external modules or partial function arguments, referencing the usage guidelines in the TypeScript section.
- Frontend react code does not need unit tests

#### Test Coverage

- Test critical business logic and edge cases
- Don't add tests for trivial code or just to increase test coverage
- Don't make tests too brittle or flaky by relying on implementation details

### Git

- When possible, combine the `git add` and `git commit` commands into a single `git commit -am` command, to speed things up


================================================
FILE: Tiltfile
================================================
# 🌊 run `tilt up` to start
# then open http://localhost:10350/r/(all)/overview

load('ext://uibutton', 'cmd_button', 'bool_input', 'location')
# Find docs on Tilt at https://docs.tilt.dev/api.html#api.local_resource
# Find icons at https://fonts.google.com/icons
 
local_resource(
    '🍍 API',
    serve_dir='apps/api',
    serve_cmd='pnpm dev:server',
    links=[ link('http://localhost:3001/v1/health', 'API'), ],
    labels=['Agentic']
)

local_resource(
    '🌶️ Web',
    serve_dir='apps/web',
    serve_cmd='pnpm dev',
    links=[ link('http://localhost:3000', 'Web'), ],
    labels=['Agentic']
)

local_resource(
    '🍉 Gateway',
    serve_dir='apps/gateway',
    serve_cmd='pnpm dev',
    labels=['Agentic']
)

local_resource(
    '🧪 E2E Tests',
    cmd='echo 0',
    labels=['Testing'],
    auto_init=False
)

local_resource(
    '🔍 Drizzle Studio',
    serve_dir='apps/api',
    serve_cmd='pnpm drizzle-kit studio',
    links=[ link('https://local.drizzle.studio', 'Drizzle Studio'), ],
    labels=['Services'],
)

local_resource(
    '💸 Stripe Webhooks',
    serve_dir='apps/api',
    serve_cmd='pnpm dev:stripe',
    # links=[ link('http://localhost:4983', 'Stripe Webhooks'), ],
    labels=['Services'],
)

cmd_button(
    'Seed Database',
    argv=['sh', '-c', 'cd apps/e2e && pnpm run seed-db'],
    location=location.NAV,
    icon_name='nature',
    text='Seed Database',
)


================================================
FILE: apps/api/drizzle.config.ts
================================================
import { defineConfig } from 'drizzle-kit'

export default defineConfig({
  out: './drizzle',
  schema: './src/db/schema/index.ts',
  dialect: 'postgresql',
  dbCredentials: {
    // eslint-disable-next-line no-process-env
    url: process.env.DATABASE_URL!
  }
})


================================================
FILE: apps/api/package.json
================================================
{
  "name": "api",
  "private": true,
  "version": "8.4.4",
  "description": "Internal Agentic platform API service.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "apps/api"
  },
  "type": "module",
  "source": "./src/server.ts",
  "scripts": {
    "build": "tsup",
    "dev": "run-p dev:*",
    "dev:server": "dotenvx run -- tsx src/server.ts",
    "dev:stripe": "dotenvx run -- stripe listen --forward-to http://localhost:3001/v1/webhooks/stripe",
    "prod": "run-p prod:*",
    "prod:server": "dotenvx run -o -f .env.production -- tsx src/server.ts",
    "prod:stripe": "dotenvx run -o -f .env.production -- stripe listen --forward-to http://localhost:3001/v1/webhooks/stripe",
    "start": "tsx src/server.ts",
    "drizzle-kit": "dotenvx run -- drizzle-kit",
    "drizzle-kit:prod": "dotenvx run -o -f .env.production -- drizzle-kit",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "[ -n \"$CI\" ] || dotenvx run -- vitest run"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-emails": "workspace:*",
    "@agentic/platform-hono": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@aws-sdk/client-s3": "^3.726.1",
    "@aws-sdk/s3-request-presigner": "^3.726.1",
    "@dicebear/collection": "catalog:",
    "@dicebear/core": "catalog:",
    "@fisch0920/drizzle-orm": "catalog:",
    "@fisch0920/drizzle-zod": "catalog:",
    "@hono/node-server": "catalog:",
    "@hono/zod-openapi": "catalog:",
    "@paralleldrive/cuid2": "catalog:",
    "@sentry/node": "catalog:",
    "bcryptjs": "catalog:",
    "exit-hook": "catalog:",
    "file-type": "^21.0.0",
    "hono": "catalog:",
    "ky": "catalog:",
    "mrmime": "^2.0.1",
    "octokit": "catalog:",
    "p-all": "catalog:",
    "postgres": "catalog:",
    "restore-cursor": "catalog:",
    "semver": "catalog:",
    "stripe": "catalog:",
    "type-fest": "catalog:",
    "zod-validation-error": "catalog:"
  },
  "devDependencies": {
    "@types/semver": "catalog:",
    "drizzle-kit": "catalog:",
    "drizzle-orm": "catalog:"
  }
}


================================================
FILE: apps/api/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# Agentic API <!-- omit from toc -->

> Backend API for the Agentic platform.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so)

## Dependencies

- **Postgres**
  - `DATABASE_URL` - Postgres connection string
  - [On macOS](https://wiki.postgresql.org/wiki/Homebrew): `brew install postgresql && brew services start postgresql`
  - You'll need to run `pnpm drizzle-kit push` to set up your database schema
- **S3** - Required to use file attachments
  - Any S3-compatible provider is supported, such as [Cloudflare R2](https://developers.cloudflare.com/r2/)
  - Alterantively, you can use a local S3 server like [MinIO](https://github.com/minio/minio#homebrew-recommended) or [LocalStack](https://github.com/localstack/localstack)
    - To run LocalStack on macOS: `brew install localstack/tap/localstack-cli && localstack start -d`
    - To run MinIO macOS: `brew install minio/stable/minio && minio server /data`
  - I recommend using Cloudflare R2, though – it's amazing and should be free for most use cases!
  - `S3_BUCKET` - Required
  - `S3_REGION` - Optional; defaults to `auto`
  - `S3_ENDPOINT` - Required; example: `https://<id>.r2.cloudflarestorage.com`
  - `ACCESS_KEY_ID` - Required ([cloudflare R2 docs](https://developers.cloudflare.com/r2/api/s3/tokens/))
  - `SECRET_ACCESS_KEY` - Required ([cloudflare R2 docs](https://developers.cloudflare.com/r2/api/s3/tokens/))

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: apps/api/src/api-v1/auth/github-callback.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import type { OpenAPIHono } from '@hono/zod-openapi'
import { assert } from '@agentic/platform-core'

import { authStorage } from './utils'

export function registerV1GitHubOAuthCallback(
  app: OpenAPIHono<DefaultHonoEnv>
) {
  return app.get('auth/github/callback', async (c) => {
    const logger = c.get('logger')
    const query = c.req.query()

    assert(query.state, 400, 'State is required')

    const entry = await authStorage.get(['github', query.state, 'redirectUri'])
    assert(entry, 400, 'Redirect URI not found')
    const redirectUri = entry.redirectUri
    assert(entry.redirectUri, 400, 'Redirect URI not found')

    const url = new URL(redirectUri)
    for (const [key, value] of Object.entries(query)) {
      url.searchParams.set(key, value)
    }

    logger.info('GitHub auth callback', query, '=>', url.toString(), {
      rawUrl: redirectUri,
      query
    })
    return c.redirect(url.toString())
  })
}


================================================
FILE: apps/api/src/api-v1/auth/github-exchange.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import { createAuthToken } from '@/lib/auth/create-auth-token'
import { upsertOrLinkUserAccount } from '@/lib/auth/upsert-or-link-user-account'
import {
  exchangeGitHubOAuthCodeForAccessToken,
  getGitHubClient
} from '@/lib/external/github'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { authSessionResponseSchema } from './schemas'

const route = createRoute({
  description: 'Exchanges a GitHub OAuth code for an Agentic auth session.',
  tags: ['auth'],
  operationId: 'exchangeOAuthCodeWithGitHub',
  method: 'post',
  path: 'auth/github/exchange',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: z
            .object({
              code: z.string()
            })
            .passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'An auth session',
      content: {
        'application/json': {
          schema: authSessionResponseSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GitHubOAuthExchange(
  app: OpenAPIHono<DefaultHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const logger = c.get('logger')
    const body = c.req.valid('json')

    const result = await exchangeGitHubOAuthCodeForAccessToken(body)
    logger.info('github oauth', result)

    const client = getGitHubClient({ accessToken: result.access_token! })
    const { data: ghUser } = await client.rest.users.getAuthenticated()

    logger.info('github user', ghUser)

    if (!ghUser.email) {
      const { data: emails } = await client.request('GET /user/emails')
      const primary = emails.find((e) => e.primary)
      const verified = emails.find((e) => e.verified)
      const fallback = emails.find((e) => e.email)
      const email = primary?.email || verified?.email || fallback?.email
      ghUser.email = email!
    }

    assert(
      ghUser.email,
      'Error authenticating with GitHub: user email is required.'
    )

    const now = Date.now()
    const user = await upsertOrLinkUserAccount({
      partialAccount: {
        provider: 'github',
        accountId: `${ghUser.id}`,
        accountUsername: ghUser.login.toLowerCase(),
        accessToken: result.access_token,
        refreshToken: result.refresh_token,
        // `expires_in` and `refresh_token_expires_in` are given in seconds
        accessTokenExpiresAt: result.expires_in
          ? new Date(now + result.expires_in * 1000)
          : undefined,
        refreshTokenExpiresAt: result.refresh_token_expires_in
          ? new Date(now + result.refresh_token_expires_in * 1000)
          : undefined,
        scope: result.scope || undefined
      },
      partialUser: {
        email: ghUser.email,
        isEmailVerified: true,
        name: ghUser.name || undefined,
        username: ghUser.login.toLowerCase(),
        image: ghUser.avatar_url
      }
    })

    logger.info('github user result', user)

    const token = await createAuthToken(user)
    return c.json(parseZodSchema(authSessionResponseSchema, { token, user }))
  })
}


================================================
FILE: apps/api/src/api-v1/auth/github-init.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { authStorage } from './utils'

const route = createRoute({
  description: 'Starts a GitHub OAuth flow.',
  tags: ['auth'],
  operationId: 'initGitHubOAuthFlow',
  method: 'get',
  path: 'auth/github/init',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: z
      .object({
        redirect_uri: z.string(),
        client_id: z.string().optional(),
        scope: z.string().optional()
      })
      .passthrough()
  },
  responses: {
    302: {
      description: 'Redirected to GitHub'
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GitHubOAuthInitFlow(
  app: OpenAPIHono<DefaultHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const logger = c.get('logger')
    const {
      client_id: clientId = env.GITHUB_CLIENT_ID,
      scope = 'user:email',
      redirect_uri: redirectUri
    } = c.req.query()

    const state = crypto.randomUUID()

    // TODO: unique identifier!
    // TODO: THIS IS IMPORTANT!! if multiple users are authenticating with github concurrently, this will currently really mess things up...
    await authStorage.set(['github', state, 'redirectUri'], { redirectUri })

    const publicRedirectUri = `${env.apiBaseUrl}/v1/auth/github/callback`

    const url = new URL('https://github.com/login/oauth/authorize')
    url.searchParams.append('client_id', clientId)
    url.searchParams.append('scope', scope)
    url.searchParams.append('state', state)
    url.searchParams.append('redirect_uri', publicRedirectUri)

    logger.info('Redirecting to GitHub', {
      url: url.toString(),
      clientId,
      scope,
      publicRedirectUri
    })

    return c.redirect(url.toString())
  })
}


================================================
FILE: apps/api/src/api-v1/auth/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import { schema } from '@/db'

export const authSessionResponseSchema = z
  .object({
    token: z.string().nonempty(),
    user: schema.userSelectSchema
  })
  .openapi('AuthSession')


================================================
FILE: apps/api/src/api-v1/auth/sign-in-with-password.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import type { Context } from 'hono'
import { assert, parseZodSchema } from '@agentic/platform-core'
import { isValidPassword } from '@agentic/platform-validators'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'
import { compare } from 'bcryptjs'

import { and, db, eq, schema } from '@/db'
import { createAuthToken } from '@/lib/auth/create-auth-token'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { authSessionResponseSchema } from './schemas'

const route = createRoute({
  description: 'Signs in with email and password.',
  tags: ['auth'],
  operationId: 'signInWithPassword',
  method: 'post',
  path: 'auth/password/signin',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: z.object({
            email: z.string().email(),
            password: z.string().refine((password) => isValidPassword(password))
          })
        }
      }
    }
  },
  responses: {
    200: {
      description: 'An auth session',
      content: {
        'application/json': {
          schema: authSessionResponseSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1SignInWithPassword(app: OpenAPIHono<DefaultHonoEnv>) {
  return app.openapi(route, trySignIn)
}

export async function trySignIn(
  c: Context<
    DefaultHonoEnv,
    'auth/password/signin',
    {
      in: {
        json: {
          password: string
          email: string
        }
      }
      out: {
        json: {
          password: string
          email: string
        }
      }
    }
  >
) {
  const { email, password } = c.req.valid('json')

  const user = await db.query.users.findFirst({
    where: eq(schema.users.email, email)
  })
  assert(user, 404, `User not found "${email}"`)

  const account = await db.query.accounts.findFirst({
    where: and(
      eq(schema.accounts.userId, user.id),
      eq(schema.accounts.provider, 'password')
    )
  })
  assert(account?.password, 404, `User "${email}" does not have a password set`)
  assert(compare(password, account.password), 403, 'Authentication error')

  const token = await createAuthToken(user)
  return c.json(parseZodSchema(authSessionResponseSchema, { token, user }))
}


================================================
FILE: apps/api/src/api-v1/auth/sign-up-with-password.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { parseZodSchema } from '@agentic/platform-core'
import { isValidPassword } from '@agentic/platform-validators'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'
import { genSalt, hash } from 'bcryptjs'

import { usernameSchema } from '@/db'
import { createAuthToken } from '@/lib/auth/create-auth-token'
import { upsertOrLinkUserAccount } from '@/lib/auth/upsert-or-link-user-account'
import { ensureUniqueNamespace } from '@/lib/ensure-unique-namespace'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { authSessionResponseSchema } from './schemas'
import { trySignIn } from './sign-in-with-password'

const route = createRoute({
  description: 'Signs up for a new account with email and password.',
  tags: ['auth'],
  operationId: 'signUpWithPassword',
  method: 'post',
  path: 'auth/password/signup',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: z.object({
            username: usernameSchema,
            email: z.string().email(),
            password: z.string().refine((password) => isValidPassword(password))
          })
        }
      }
    }
  },
  responses: {
    200: {
      description: 'An auth session',
      content: {
        'application/json': {
          schema: authSessionResponseSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1SignUpWithPassword(app: OpenAPIHono<DefaultHonoEnv>) {
  return app.openapi(route, async (c) => {
    try {
      // try signing in to see if the user already exists
      return await trySignIn(c)
    } catch {
      // Ignore errors
    }

    const { username, email, password } = c.req.valid('json')
    await ensureUniqueNamespace(username, { label: 'username' })

    const salt = await genSalt()
    const hashedPassword = await hash(password, salt)

    // TODO: fail if username is taken
    const user = await upsertOrLinkUserAccount({
      partialAccount: {
        provider: 'password',
        accountId: email,
        password: hashedPassword
      },
      partialUser: {
        username,
        email
      }
    })

    const token = await createAuthToken(user)
    return c.json(parseZodSchema(authSessionResponseSchema, { token, user }))
  })
}


================================================
FILE: apps/api/src/api-v1/auth/utils.ts
================================================
import { DrizzleAuthStorage } from '@/lib/auth/drizzle-auth-storage'

export const authStorage = DrizzleAuthStorage()


================================================
FILE: apps/api/src/api-v1/consumers/admin-activate-consumer.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { aclAdmin } from '@/lib/acl-admin'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerIdParamsSchema } from './schemas'
import { setAdminCacheControlForConsumer } from './utils'

const route = createRoute({
  description:
    "Activates a consumer signifying that at least one API call has been made using the consumer's API token. This method is idempotent and admin-only.",
  tags: ['admin', 'consumers'],
  operationId: 'adminActivateConsumer',
  method: 'put',
  path: 'admin/consumers/{consumerId}/activate',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerIdParamsSchema
  },
  responses: {
    200: {
      description: 'An admin consumer object',
      content: {
        'application/json': {
          schema: schema.consumerAdminSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1AdminActivateConsumer(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { consumerId } = c.req.valid('param')
    await aclAdmin(c)

    const [consumer] = await db
      .update(schema.consumers)
      .set({ activated: true })
      .where(eq(schema.consumers.id, consumerId))
      .returning()
    assert(consumer, 404, `Consumer not found "${consumerId}"`)

    setAdminCacheControlForConsumer(c, consumer)
    return c.json(parseZodSchema(schema.consumerAdminSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/admin-get-consumer-by-api-key.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { aclAdmin } from '@/lib/acl-admin'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerApiKeyParamsSchema, populateConsumerSchema } from './schemas'
import { setAdminCacheControlForConsumer } from './utils'

const route = createRoute({
  description: 'Gets a consumer by API key. This route is admin-only.',
  tags: ['admin', 'consumers'],
  operationId: 'adminGetConsumerByApiKey',
  method: 'get',
  // TODO: is it wise to use a path param for the API key? especially wehn it'll
  // be cached in cloudflare's shared cache?
  path: 'admin/consumers/api-keys/{apiKey}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerApiKeyParamsSchema,
    query: populateConsumerSchema
  },
  responses: {
    200: {
      description: 'An admin consumer object',
      content: {
        'application/json': {
          schema: schema.consumerAdminSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1AdminGetConsumerByApiKey(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { apiKey } = c.req.valid('param')
    const { populate = [] } = c.req.valid('query')
    await aclAdmin(c)

    const consumer = await db.query.consumers.findFirst({
      where: eq(schema.consumers.token, apiKey),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(consumer, 404, `API key not found "${apiKey}"`)

    setAdminCacheControlForConsumer(c, consumer)
    return c.json(parseZodSchema(schema.consumerAdminSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/create-billing-portal-session.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { upsertStripeCustomer } from '@/lib/billing/upsert-stripe-customer'
import { env } from '@/lib/env'
import { stripe } from '@/lib/external/stripe'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description:
    'Creates a Stripe billing portal session for the authenticated user.',
  tags: ['consumers'],
  operationId: 'createBillingPortalSession',
  method: 'post',
  path: 'consumers/billing-portal',
  security: openapiAuthenticatedSecuritySchemas,
  responses: {
    200: {
      description: 'A billing portal session URL',
      content: {
        'application/json': {
          schema: z.object({
            url: z.string().url()
          })
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1CreateBillingPortalSession(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { stripeCustomer } = await upsertStripeCustomer(c)

    const portalSession = await stripe.billingPortal.sessions.create({
      customer: stripeCustomer.id,
      return_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers`
    })

    return c.json({ url: portalSession.url })
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/create-consumer-billing-portal-session.ts
================================================
import { assert } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { env } from '@/lib/env'
import { stripe } from '@/lib/external/stripe'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Creates a Stripe billing portal session for a customer.',
  tags: ['consumers'],
  operationId: 'createConsumerBillingPortalSession',
  method: 'post',
  path: 'consumers/{consumerId}/billing-portal',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerIdParamsSchema
  },
  responses: {
    200: {
      description: 'A billing portal session URL',
      content: {
        'application/json': {
          schema: z.object({
            url: z.string().url()
          })
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1CreateConsumerBillingPortalSession(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { consumerId } = c.req.valid('param')
    const consumer = await db.query.consumers.findFirst({
      where: eq(schema.consumers.id, consumerId)
    })
    assert(consumer, 404, `Consumer not found "${consumerId}"`)
    await acl(c, consumer, { label: 'Consumer' })

    const portalSession = await stripe.billingPortal.sessions.create({
      customer: consumer._stripeCustomerId,
      return_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers/${consumerId}`
    })

    return c.json({ url: portalSession.url })
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/create-consumer-checkout-session.ts
================================================
import { parseZodSchema, pick } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { upsertConsumerStripeCheckout } from '@/lib/consumers/upsert-consumer-stripe-checkout'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description:
    'Creates a Stripe checkout session for a consumer to modify their subscription to a project.',
  tags: ['consumers'],
  operationId: 'createConsumerCheckoutSession',
  method: 'post',
  path: 'consumers/checkout',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.consumerInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: z.object({
            checkoutSession: z.object({
              id: z.string(),
              url: z.string().url()
            }),
            consumer: schema.consumerSelectSchema
          })
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1CreateConsumerCheckoutSession(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const body = c.req.valid('json')
    const { checkoutSession, consumer } = await upsertConsumerStripeCheckout(
      c,
      body
    )

    return c.json({
      checkoutSession: pick(checkoutSession, 'id', 'url'),
      consumer: parseZodSchema(schema.consumerSelectSchema, consumer)
    })
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/create-consumer.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { upsertConsumer } from '@/lib/consumers/upsert-consumer'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description:
    "Upserts a consumer by modifying a customer's subscription to a project.",
  tags: ['consumers'],
  operationId: 'createConsumer',
  method: 'post',
  path: 'consumers',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.consumerInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: schema.consumerSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1CreateConsumer(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const body = c.req.valid('json')
    const consumer = await upsertConsumer(c, body)

    return c.json(parseZodSchema(schema.consumerSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/get-consumer-by-project-identifier.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { aclPublicProject } from '@/lib/acl-public-project'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { projectIdentifierAndPopulateConsumerSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a consumer for the authenticated user and the given project identifier.',
  tags: ['consumers'],
  operationId: 'getConsumerByProjectIdentifier',
  method: 'get',
  path: 'consumers/by-project-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: projectIdentifierAndPopulateConsumerSchema
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: schema.consumerSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetConsumerByProjectIdentifier(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { projectIdentifier, populate = [] } = c.req.valid('query')
    const userId = c.get('userId')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier)
    })
    assert(project, 404, `Project not found "${projectIdentifier}"`)
    aclPublicProject(project)

    const consumer = await db.query.consumers.findFirst({
      where: and(
        eq(schema.consumers.userId, userId),
        eq(schema.consumers.projectId, project.id)
      ),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(
      consumer,
      404,
      `Consumer not found for user "${userId}" and project "${projectIdentifier}"`
    )
    await acl(c, consumer, { label: 'Consumer' })

    return c.json(parseZodSchema(schema.consumerSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/get-consumer.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerIdParamsSchema, populateConsumerSchema } from './schemas'

const route = createRoute({
  description: 'Gets a consumer by ID.',
  tags: ['consumers'],
  operationId: 'getConsumer',
  method: 'get',
  path: 'consumers/{consumerId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerIdParamsSchema,
    query: populateConsumerSchema
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: schema.consumerSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetConsumer(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { consumerId } = c.req.valid('param')
    const { populate = [] } = c.req.valid('query')

    const consumer = await db.query.consumers.findFirst({
      where: eq(schema.consumers.id, consumerId),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(consumer, 404, `Consumer not found "${consumerId}"`)
    await acl(c, consumer, { label: 'Consumer' })

    return c.json(parseZodSchema(schema.consumerSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/list-consumers.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { paginationAndPopulateConsumerSchema } from './schemas'

const route = createRoute({
  description: 'Lists all of the customer subscriptions for the current user.',
  tags: ['consumers'],
  operationId: 'listConsumers',
  method: 'get',
  path: 'consumers',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: paginationAndPopulateConsumerSchema
  },
  responses: {
    200: {
      description: 'A list of consumers',
      content: {
        'application/json': {
          schema: z.array(schema.consumerSelectSchema)
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1ListConsumers(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt',
      populate = []
    } = c.req.valid('query')

    const user = await ensureAuthUser(c)

    const consumers = await db.query.consumers.findMany({
      where: eq(schema.consumers.userId, user.id),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      },
      orderBy: (consumers, { asc, desc }) => [
        sort === 'desc' ? desc(consumers[sortBy]) : asc(consumers[sortBy])
      ],
      offset,
      limit
    })

    return c.json(
      parseZodSchema(z.array(schema.consumerSelectSchema), consumers)
    )
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/list-project-consumers.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { projectIdParamsSchema } from '../projects/schemas'
import { paginationAndPopulateConsumerSchema } from './schemas'

const route = createRoute({
  description: 'Lists all of the customers for a project.',
  tags: ['consumers'],
  operationId: 'listConsumersForProject',
  method: 'get',
  path: 'projects/{projectId}/consumers',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: projectIdParamsSchema,
    query: paginationAndPopulateConsumerSchema
  },
  responses: {
    200: {
      description: 'A list of consumers subscribed to the given project',
      content: {
        'application/json': {
          schema: z.array(schema.consumerSelectSchema)
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1ListConsumersForProject(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt',
      populate = []
    } = c.req.valid('query')

    const { projectId } = c.req.valid('param')
    assert(projectId, 400, 'Project ID is required')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.id, projectId)
    })
    assert(project, 404, `Project not found "${projectId}"`)
    await acl(c, project, { label: 'Project' })

    const consumers = await db.query.consumers.findMany({
      where: eq(schema.consumers.projectId, projectId),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      },
      orderBy: (consumers, { asc, desc }) => [
        sort === 'desc' ? desc(consumers[sortBy]) : asc(consumers[sortBy])
      ],
      offset,
      limit
    })

    return c.json(
      parseZodSchema(z.array(schema.consumerSelectSchema), consumers)
    )
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/refresh-consumer-api-key.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { createConsumerApiKey } from '@/lib/create-consumer-api-key'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerIdParamsSchema } from './schemas'

const route = createRoute({
  description: "Refreshes a consumer's API key.",
  tags: ['consumers'],
  operationId: 'refreshConsumerApiKey',
  method: 'post',
  path: 'consumers/{consumerId}/refresh-api-key',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerIdParamsSchema
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: schema.consumerSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1RefreshConsumerApiKey(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { consumerId } = c.req.valid('param')

    let consumer = await db.query.consumers.findFirst({
      where: eq(schema.consumers.id, consumerId)
    })
    assert(consumer, 404, 'Consumer not found')
    await acl(c, consumer, { label: 'Consumer' })

    // Update the consumer's API token
    ;[consumer] = await db
      .update(schema.consumers)
      .set({
        token: await createConsumerApiKey()
      })
      .where(eq(schema.consumers.id, consumer.id))
      .returning()
    assert(consumer, 500, 'Error updating consumer')

    return c.json(parseZodSchema(schema.consumerSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import {
  consumerIdSchema,
  consumerRelationsSchema,
  paginationSchema,
  projectIdentifierSchema
} from '@/db'

export const consumerIdParamsSchema = z.object({
  consumerId: consumerIdSchema.openapi({
    param: {
      description: 'Consumer ID',
      name: 'consumerId',
      in: 'path'
    }
  })
})

export const consumerApiKeyParamsSchema = z.object({
  apiKey: z
    .string()
    .nonempty()
    .openapi({
      param: {
        description: 'Consumer API key',
        name: 'apiKey',
        in: 'path'
      }
    })
})

export const projectIdentifierQuerySchema = z.object({
  projectIdentifier: projectIdentifierSchema
})

export const populateConsumerSchema = z.object({
  populate: z
    .union([consumerRelationsSchema, z.array(consumerRelationsSchema)])
    .default([])
    .transform((p) => (Array.isArray(p) ? p : [p]))
    .optional()
})

export const paginationAndPopulateConsumerSchema = z.object({
  ...paginationSchema.shape,
  ...populateConsumerSchema.shape
})

export const projectIdentifierAndPopulateConsumerSchema = z.object({
  ...projectIdentifierQuerySchema.shape,
  ...populateConsumerSchema.shape
})


================================================
FILE: apps/api/src/api-v1/consumers/update-consumer.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { upsertConsumer } from '@/lib/consumers/upsert-consumer'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponse410,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { consumerIdParamsSchema } from './schemas'

const route = createRoute({
  description:
    "Updates a consumer's subscription to a different deployment or pricing plan. Set `plan` to undefined to cancel the subscription.",
  tags: ['consumers'],
  operationId: 'updateConsumer',
  method: 'post',
  path: 'consumers/{consumerId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: consumerIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.consumerUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A consumer object',
      content: {
        'application/json': {
          schema: schema.consumerSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409,
    ...openapiErrorResponse410
  }
})

export function registerV1UpdateConsumer(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { consumerId } = c.req.valid('param')
    const body = c.req.valid('json')

    const consumer = await upsertConsumer(c, {
      ...body,
      consumerId
    })

    return c.json(parseZodSchema(schema.consumerSelectSchema, consumer))
  })
}


================================================
FILE: apps/api/src/api-v1/consumers/utils.ts
================================================
import type { RawConsumer } from '@/db'
import type { AuthenticatedHonoContext } from '@/lib/types'
import { setPublicCacheControl } from '@/lib/cache-control'
import { env } from '@/lib/env'

export function setAdminCacheControlForConsumer(
  c: AuthenticatedHonoContext,
  consumer: RawConsumer
) {
  if (
    consumer.plan === 'free' ||
    !consumer.activated ||
    !consumer.isStripeSubscriptionActive
  ) {
    // TODO: should we cache free-tier consumers for longer on prod?
    // We really don't want free tier customers to cause our backend API so
    // much traffic, but we'd also like for customers upgrading to a paid tier
    // to have a snappy, smooth experience – without having to wait for their
    // free tier subscription to expire from the cache.
    setPublicCacheControl(c.res, env.isProd ? '30s' : '10s')
  } else {
    // We don't want the gateway hitting our API too often, so cache active
    // customer subscriptions for longer in production
    setPublicCacheControl(c.res, env.isProd ? '30m' : '1m')
  }
}


================================================
FILE: apps/api/src/api-v1/deployments/admin-get-deployment-by-identifier.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { acl } from '@/lib/acl'
import { aclAdmin } from '@/lib/acl-admin'
import { setPublicCacheControl } from '@/lib/cache-control'
import { tryGetDeploymentByIdentifier } from '@/lib/deployments/try-get-deployment-by-identifier'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdentifierAndPopulateSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a deployment by its public identifier. This route is admin-only.',
  tags: ['admin', 'deployments'],
  operationId: 'adminGetDeploymentByIdentifier',
  method: 'get',
  path: 'admin/deployments/by-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: deploymentIdentifierAndPopulateSchema
  },
  responses: {
    200: {
      description: 'An admin deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentAdminSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1AdminGetDeploymentByIdentifier(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentIdentifier, populate = [] } = c.req.valid('query')
    await aclAdmin(c)

    const { project, ...deployment } = await tryGetDeploymentByIdentifier(c, {
      deploymentIdentifier,
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true])),
        project: true
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
    assert(
      project,
      404,
      `Project not found for deployment "${deploymentIdentifier}"`
    )
    await acl(c, deployment, { label: 'Deployment' })

    // TODO: ensure that the deployment's project is either public OR the
    // consumer has access to it?

    const hasPopulateProject = populate.includes('project')

    if (env.isProd) {
      // Published deployments are immutable, so cache them for longer in production
      setPublicCacheControl(c.res, deployment.published ? '1h' : '5m')
    } else {
      setPublicCacheControl(c.res, '10s')
    }

    return c.json(
      parseZodSchema(schema.deploymentAdminSelectSchema, {
        ...deployment,
        ...(hasPopulateProject ? { project } : {}),
        _secret: project._secret
      })
    )
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/create-deployment.ts
================================================
import { resolveAgenticProjectConfig } from '@agentic/platform'
import { assert, parseZodSchema, sha256, slugify } from '@agentic/platform-core'
import {
  isValidDeploymentIdentifier,
  parseProjectIdentifier
} from '@agentic/platform-validators'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { normalizeDeploymentVersion } from '@/lib/deployments/normalize-deployment-version'
import { publishDeployment } from '@/lib/deployments/publish-deployment'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponses
} from '@/lib/openapi-utils'
import { uploadFileUrlToStorage } from '@/lib/storage'

import { createDeploymentQuerySchema } from './schemas'

const route = createRoute({
  description: 'Creates a new deployment within a project.',
  tags: ['deployments'],
  operationId: 'createDeployment',
  method: 'post',
  path: 'deployments',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: createDeploymentQuerySchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.deploymentInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409
  }
})

export function registerV1CreateDeployment(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const user = await ensureAuthUser(c)
    const { publish } = c.req.valid('query')
    const body = c.req.valid('json')
    const teamMember = c.get('teamMember')
    const logger = c.get('logger')

    const inputNamespace = teamMember ? teamMember.teamSlug : user.username
    const slug = body.slug ?? slugify(body.name) // TODO: don't duplicate this logic here
    const inputProjectIdentifier = `@${inputNamespace}/${slug}`
    const { projectIdentifier, projectNamespace, projectSlug } =
      parseProjectIdentifier(inputProjectIdentifier)

    let project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier),
      with: {
        lastPublishedDeployment: true
      }
    })

    if (!project) {
      // Used for testing e2e fixtures in the development marketplace
      const isPrivate = !(
        (user.username === 'dev' && env.isDev) ||
        user.username === 'agentic'
      )

      // Used to simplify recreating the demo `@agentic/search` project during
      // development while we're frequently resetting the database
      const secret =
        projectIdentifier === '@dev/search' ||
        projectIdentifier === '@agentic/search'
          ? env.AGENTIC_SEARCH_PROXY_SECRET
          : await sha256()

      // Upsert the project if it doesn't already exist
      // The typecast is necessary here because we're not populating the
      // lastPublishedDeployment, but that's fine because it's a new project
      // so it will be empty anyway.
      project = (
        await db
          .insert(schema.projects)
          .values({
            name: body.name,
            identifier: projectIdentifier,
            namespace: projectNamespace,
            slug: projectSlug,
            userId: user.id,
            teamId: teamMember?.teamId,
            private: isPrivate,
            _secret: secret
          })
          .returning()
      )[0] as typeof project
    }

    assert(project, 404, `Project not found "${projectIdentifier}"`)
    await acl(c, project, { label: 'Project' })
    const projectId = project.id

    // TODO: investigate better short hash generation
    const hash = (await sha256()).slice(0, 8)
    const deploymentIdentifier = `${project.identifier}@${hash}`
    assert(
      isValidDeploymentIdentifier(deploymentIdentifier),
      400,
      `Invalid deployment identifier "${deploymentIdentifier}"`
    )

    let { version } = body
    if (publish) {
      assert(
        version,
        400,
        `Deployment "version" field is required to publish deployment "${deploymentIdentifier}"`
      )
    }

    if (version) {
      version = normalizeDeploymentVersion({
        deploymentIdentifier,
        project,
        version
      })
    }

    // Validate project config, including:
    // - pricing plans
    // - origin adapter config
    // - origin API base URL
    // - origin adapter OpenAPI or MCP specs
    // - tool definitions
    const agenticProjectConfig = await resolveAgenticProjectConfig(body, {
      label: `deployment "${deploymentIdentifier}"`,
      logger,
      uploadFileUrlToStorage: async (source) => {
        return uploadFileUrlToStorage(source, {
          prefix: projectIdentifier
        })
      }
    })

    // Create the deployment
    let [deployment] = await db
      .insert(schema.deployments)
      .values({
        iconUrl: user.image,
        ...agenticProjectConfig,
        identifier: deploymentIdentifier,
        hash,
        userId: user.id,
        teamId: teamMember?.teamId,
        projectId,
        version
      })
      .returning()
    assert(
      deployment,
      500,
      `Failed to create deployment "${deploymentIdentifier}"`
    )

    // Update the project
    await db
      .update(schema.projects)
      .set({
        lastDeploymentId: deployment.id
      })
      .where(eq(schema.projects.id, projectId))

    if (publish) {
      deployment = await publishDeployment(c, {
        deployment,
        version: deployment.version!
      })
    }

    return c.json(parseZodSchema(schema.deploymentSelectSchema, deployment))
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/get-deployment-by-identifier.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { acl } from '@/lib/acl'
import { tryGetDeploymentByIdentifier } from '@/lib/deployments/try-get-deployment-by-identifier'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdentifierAndPopulateSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a deployment by its identifier (eg, "@username/project-slug@latest").',
  tags: ['deployments'],
  operationId: 'getDeploymentByIdentifier',
  method: 'get',
  path: 'deployments/by-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: deploymentIdentifierAndPopulateSchema
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetDeploymentByIdentifier(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentIdentifier, populate = [] } = c.req.valid('query')

    const deployment = await tryGetDeploymentByIdentifier(c, {
      deploymentIdentifier,
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
    await acl(c, deployment, { label: 'Deployment' })

    return c.json(parseZodSchema(schema.deploymentSelectSchema, deployment))
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/get-deployment.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { acl } from '@/lib/acl'
import { getDeploymentById } from '@/lib/deployments/get-deployment-by-id'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdParamsSchema, populateDeploymentSchema } from './schemas'

const route = createRoute({
  description: 'Gets a deployment by its ID',
  tags: ['deployments'],
  operationId: 'getDeployment',
  method: 'get',
  path: 'deployments/{deploymentId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: deploymentIdParamsSchema,
    query: populateDeploymentSchema
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetDeployment(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentId } = c.req.valid('param')
    const { populate = [] } = c.req.valid('query')

    const deployment = await getDeploymentById({
      deploymentId,
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentId}"`)
    await acl(c, deployment, { label: 'Deployment' })

    return c.json(parseZodSchema(schema.deploymentSelectSchema, deployment))
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/get-public-deployment-by-identifier.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import { schema } from '@/db'
import { aclPublicProject } from '@/lib/acl-public-project'
import { setPublicCacheControl } from '@/lib/cache-control'
import { tryGetDeploymentByIdentifier } from '@/lib/deployments/try-get-deployment-by-identifier'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdentifierAndPopulateSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a public deployment by its identifier (eg, "@username/project-slug@latest").',
  tags: ['deployments'],
  operationId: 'getPublicDeploymentByIdentifier',
  method: 'get',
  path: 'deployments/public/by-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: deploymentIdentifierAndPopulateSchema
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetPublicDeploymentByIdentifier(
  app: OpenAPIHono<DefaultHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentIdentifier, populate = [] } = c.req.valid('query')

    const deployment = await tryGetDeploymentByIdentifier(c, {
      deploymentIdentifier,
      with: {
        project: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
    assert(
      deployment.project,
      404,
      `Project not found for deployment "${deploymentIdentifier}"`
    )
    aclPublicProject(deployment.project!)

    if (deployment.published) {
      // Note that published deployments should be immutable
      setPublicCacheControl(c.res, '1m')
    } else {
      setPublicCacheControl(c.res, '10s')
    }

    return c.json(parseZodSchema(schema.deploymentSelectSchema, deployment))
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/list-deployments.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'
import { tryGetProjectByIdentifier } from '@/lib/projects/try-get-project-by-identifier'

import { paginationAndPopulateAndFilterDeploymentSchema } from './schemas'

const route = createRoute({
  description:
    'Lists deployments the user or team has access to, optionally filtering by project.',
  tags: ['deployments'],
  operationId: 'listDeployments',
  method: 'get',
  path: 'deployments',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: paginationAndPopulateAndFilterDeploymentSchema
  },
  responses: {
    200: {
      description: 'A list of deployments',
      content: {
        'application/json': {
          schema: z.array(schema.deploymentSelectSchema)
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1ListDeployments(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt',
      populate = [],
      projectIdentifier,
      deploymentIdentifier
    } = c.req.valid('query')

    const userId = c.get('userId')
    const teamMember = c.get('teamMember')
    const user = await ensureAuthUser(c)
    const isAdmin = user.role === 'admin'

    let projectId: string | undefined

    if (projectIdentifier) {
      const project = await tryGetProjectByIdentifier(c, {
        projectIdentifier
      })
      await acl(c, project, { label: 'Project' })
      projectId = project.id
    }

    const deployments = await db.query.deployments.findMany({
      where: and(
        isAdmin
          ? undefined
          : teamMember
            ? eq(schema.deployments.teamId, teamMember.teamId)
            : eq(schema.deployments.userId, userId),
        projectId ? eq(schema.deployments.projectId, projectId) : undefined,
        deploymentIdentifier
          ? eq(schema.deployments.identifier, deploymentIdentifier)
          : undefined
      ),
      with: {
        ...Object.fromEntries(populate.map((field) => [field, true]))
      },
      orderBy: (deployments, { asc, desc }) => [
        sort === 'desc' ? desc(deployments[sortBy]) : asc(deployments[sortBy])
      ],
      offset,
      limit
    })

    return c.json(
      parseZodSchema(z.array(schema.deploymentSelectSchema), deployments)
    )
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/publish-deployment.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { schema } from '@/db'
import { acl } from '@/lib/acl'
import { getDeploymentById } from '@/lib/deployments/get-deployment-by-id'
import { publishDeployment } from '@/lib/deployments/publish-deployment'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Publishes a deployment.',
  tags: ['deployments'],
  operationId: 'publishDeployment',
  method: 'post',
  path: 'deployments/{deploymentId}/publish',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: deploymentIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.deploymentPublishSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1PublishDeployment(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentId } = c.req.valid('param')
    const { version } = c.req.valid('json')

    // First ensure the deployment exists and the user has access to it
    const deployment = await getDeploymentById({ deploymentId })
    assert(deployment, 404, `Deployment not found "${deploymentId}"`)
    await acl(c, deployment, { label: 'Deployment' })

    const publishedDeployment = await publishDeployment(c, {
      deployment,
      version
    })

    return c.json(
      parseZodSchema(schema.deploymentSelectSchema, publishedDeployment)
    )
  })
}


================================================
FILE: apps/api/src/api-v1/deployments/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import {
  deploymentIdentifierSchema,
  deploymentIdSchema,
  deploymentRelationsSchema,
  paginationSchema,
  projectIdentifierSchema
} from '@/db'

export const deploymentIdParamsSchema = z.object({
  deploymentId: deploymentIdSchema.openapi({
    param: {
      description: 'deployment ID',
      name: 'deploymentId',
      in: 'path'
    }
  })
})

export const createDeploymentQuerySchema = z.object({
  publish: z
    .union([z.literal('true'), z.literal('false')])
    .default('false')
    .transform((p) => p === 'true')
})

export const filterDeploymentSchema = z.object({
  projectIdentifier: projectIdentifierSchema.optional(),
  deploymentIdentifier: deploymentIdentifierSchema.optional()
})

export const populateDeploymentSchema = z.object({
  populate: z
    .union([deploymentRelationsSchema, z.array(deploymentRelationsSchema)])
    .default([])
    .transform((p) => (Array.isArray(p) ? p : [p]))
    .optional()
})

export const deploymentIdentifierQuerySchema = z.object({
  deploymentIdentifier: deploymentIdentifierSchema
})

export const deploymentIdentifierAndPopulateSchema = z.object({
  ...populateDeploymentSchema.shape,
  ...deploymentIdentifierQuerySchema.shape
})

export const paginationAndPopulateAndFilterDeploymentSchema = z.object({
  ...paginationSchema.shape,
  ...populateDeploymentSchema.shape,
  ...filterDeploymentSchema.shape
})


================================================
FILE: apps/api/src/api-v1/deployments/update-deployment.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { getDeploymentById } from '@/lib/deployments/get-deployment-by-id'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { deploymentIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Updates a deployment.',
  tags: ['deployments'],
  operationId: 'updateDeployment',
  method: 'post',
  path: 'deployments/{deploymentId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: deploymentIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.deploymentUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A deployment object',
      content: {
        'application/json': {
          schema: schema.deploymentSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1UpdateDeployment(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { deploymentId } = c.req.valid('param')
    const body = c.req.valid('json')

    // First ensure the deployment exists and the user has access to it
    let deployment = await getDeploymentById({ deploymentId })
    assert(deployment, 404, `Deployment not found "${deploymentId}"`)
    await acl(c, deployment, { label: 'Deployment' })

    // Update the deployment
    ;[deployment] = await db
      .update(schema.deployments)
      .set(body)
      .where(eq(schema.deployments.id, deploymentId))
      .returning()
    assert(deployment, 500, `Failed to update deployment "${deploymentId}"`)

    return c.json(parseZodSchema(schema.deploymentSelectSchema, deployment))
  })
}


================================================
FILE: apps/api/src/api-v1/health-check.ts
================================================
import { createRoute, z } from '@hono/zod-openapi'

import type { HonoApp } from '@/lib/types'

const route = createRoute({
  description: 'Health check endpoint.',
  operationId: 'healthCheck',
  method: 'get',
  path: 'health',
  responses: {
    200: {
      description: 'OK',
      content: {
        'application/json': {
          schema: z.object({
            status: z.string()
          })
        }
      }
    }
  }
})

export function registerHealthCheck(app: HonoApp) {
  return app.openapi(route, async (c) => {
    return c.json({ status: 'ok' })
  })
}


================================================
FILE: apps/api/src/api-v1/index.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import * as middleware from '@/lib/middleware'
import { defaultHook, registerOpenAPIErrorResponses } from '@/lib/openapi-utils'

import { registerV1GitHubOAuthCallback } from './auth/github-callback'
import { registerV1GitHubOAuthExchange } from './auth/github-exchange'
import { registerV1GitHubOAuthInitFlow } from './auth/github-init'
import { registerV1SignInWithPassword } from './auth/sign-in-with-password'
import { registerV1SignUpWithPassword } from './auth/sign-up-with-password'
import { registerV1AdminActivateConsumer } from './consumers/admin-activate-consumer'
import { registerV1AdminGetConsumerByApiKey } from './consumers/admin-get-consumer-by-api-key'
import { registerV1CreateBillingPortalSession } from './consumers/create-billing-portal-session'
import { registerV1CreateConsumer } from './consumers/create-consumer'
import { registerV1CreateConsumerBillingPortalSession } from './consumers/create-consumer-billing-portal-session'
import { registerV1CreateConsumerCheckoutSession } from './consumers/create-consumer-checkout-session'
import { registerV1GetConsumer } from './consumers/get-consumer'
import { registerV1GetConsumerByProjectIdentifier } from './consumers/get-consumer-by-project-identifier'
import { registerV1ListConsumers } from './consumers/list-consumers'
import { registerV1ListConsumersForProject } from './consumers/list-project-consumers'
import { registerV1RefreshConsumerApiKey } from './consumers/refresh-consumer-api-key'
import { registerV1UpdateConsumer } from './consumers/update-consumer'
import { registerV1AdminGetDeploymentByIdentifier } from './deployments/admin-get-deployment-by-identifier'
import { registerV1CreateDeployment } from './deployments/create-deployment'
import { registerV1GetDeployment } from './deployments/get-deployment'
import { registerV1GetDeploymentByIdentifier } from './deployments/get-deployment-by-identifier'
import { registerV1GetPublicDeploymentByIdentifier } from './deployments/get-public-deployment-by-identifier'
import { registerV1ListDeployments } from './deployments/list-deployments'
import { registerV1PublishDeployment } from './deployments/publish-deployment'
import { registerV1UpdateDeployment } from './deployments/update-deployment'
import { registerHealthCheck } from './health-check'
import { registerV1CreateProject } from './projects/create-project'
import { registerV1GetProject } from './projects/get-project'
import { registerV1GetProjectByIdentifier } from './projects/get-project-by-identifier'
import { registerV1GetPublicProject } from './projects/get-public-project'
import { registerV1GetPublicProjectByIdentifier } from './projects/get-public-project-by-identifier'
import { registerV1ListProjects } from './projects/list-projects'
import { registerV1ListPublicProjects } from './projects/list-public-projects'
import { registerV1UpdateProject } from './projects/update-project'
import { registerV1GetSignedStorageUploadUrl } from './storage/get-signed-storage-upload-url'
import { registerV1CreateTeam } from './teams/create-team'
import { registerV1DeleteTeam } from './teams/delete-team'
import { registerV1GetTeam } from './teams/get-team'
import { registerV1ListTeams } from './teams/list-teams'
import { registerV1CreateTeamMember } from './teams/members/create-team-member'
import { registerV1DeleteTeamMember } from './teams/members/delete-team-member'
import { registerV1UpdateTeamMember } from './teams/members/update-team-member'
import { registerV1UpdateTeam } from './teams/update-team'
import { registerV1GetUser } from './users/get-user'
import { registerV1UpdateUser } from './users/update-user'
import { registerV1StripeWebhook } from './webhooks/stripe-webhook'

// Note that the order of some of these routes is important because of
// wildcards, so be careful when updating them or adding new routes.

export const apiV1 = new OpenAPIHono<DefaultHonoEnv>({ defaultHook })

apiV1.openAPIRegistry.registerComponent('securitySchemes', 'Bearer', {
  type: 'http',
  scheme: 'bearer',
  bearerFormat: 'JWT'
})

registerOpenAPIErrorResponses(apiV1)

// Public routes
const publicRouter = new OpenAPIHono<DefaultHonoEnv>({ defaultHook })

// Private, authenticated routes
const privateRouter = new OpenAPIHono<AuthenticatedHonoEnv>({ defaultHook })

registerHealthCheck(publicRouter)

// Auth
registerV1SignInWithPassword(publicRouter)
registerV1SignUpWithPassword(publicRouter)
registerV1GitHubOAuthExchange(publicRouter)
registerV1GitHubOAuthInitFlow(publicRouter)
registerV1GitHubOAuthCallback(publicRouter)

// Users
registerV1GetUser(privateRouter)
registerV1UpdateUser(privateRouter)

// Teams
registerV1CreateTeam(privateRouter)
registerV1ListTeams(privateRouter)
registerV1GetTeam(privateRouter)
registerV1DeleteTeam(privateRouter)
registerV1UpdateTeam(privateRouter)

// Team members
registerV1CreateTeamMember(privateRouter)
registerV1UpdateTeamMember(privateRouter)
registerV1DeleteTeamMember(privateRouter)

// Storage
registerV1GetSignedStorageUploadUrl(privateRouter)

// Public projects
registerV1ListPublicProjects(publicRouter)
registerV1GetPublicProjectByIdentifier(publicRouter) // must be before `registerV1GetPublicProject`
registerV1GetPublicProject(publicRouter)

// Private projects
registerV1CreateProject(privateRouter)
registerV1ListProjects(privateRouter)
registerV1GetProjectByIdentifier(privateRouter) // must be before `registerV1GetProject`
registerV1GetProject(privateRouter)
registerV1UpdateProject(privateRouter)

// Consumers
registerV1GetConsumerByProjectIdentifier(privateRouter) // must be before `registerV1GetConsumer`
registerV1CreateBillingPortalSession(privateRouter)
registerV1GetConsumer(privateRouter)
registerV1CreateConsumer(privateRouter)
registerV1CreateConsumerCheckoutSession(privateRouter)
registerV1CreateConsumerBillingPortalSession(privateRouter)
registerV1UpdateConsumer(privateRouter)
registerV1RefreshConsumerApiKey(privateRouter)
registerV1ListConsumers(privateRouter)
registerV1ListConsumersForProject(privateRouter)

// Deployments
registerV1GetPublicDeploymentByIdentifier(publicRouter)
registerV1GetDeploymentByIdentifier(privateRouter) // must be before `registerV1GetDeployment`
registerV1GetDeployment(privateRouter)
registerV1CreateDeployment(privateRouter)
registerV1UpdateDeployment(privateRouter)
registerV1ListDeployments(privateRouter)
registerV1PublishDeployment(privateRouter)

// Internal admin routes
registerV1AdminGetConsumerByApiKey(privateRouter)
registerV1AdminActivateConsumer(privateRouter)
registerV1AdminGetDeploymentByIdentifier(privateRouter)

// Webhook event handlers
registerV1StripeWebhook(publicRouter)

// Setup routes and middleware
apiV1.route('/', publicRouter)
apiV1.use(middleware.authenticate)
apiV1.use(middleware.team)
apiV1.use(middleware.me)
apiV1.route('/', privateRouter)

// API route types to be used by Hono's RPC client.
// Should include all routes except for internal and admin routes.
// NOTE: Removing for now because Hono's RPC client / types are clunky and slow.
// export type ApiRoutes =
//   | ReturnType<typeof registerHealthCheck>


================================================
FILE: apps/api/src/api-v1/projects/create-project.ts
================================================
import { assert, parseZodSchema, sha256 } from '@agentic/platform-core'
import { parseProjectIdentifier } from '@agentic/platform-validators'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, schema } from '@/db'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description: 'Creates a new project.',
  tags: ['projects'],
  operationId: 'createProject',
  method: 'post',
  path: 'projects',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.projectInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The created project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1CreateProject(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const body = c.req.valid('json')
    const user = await ensureAuthUser(c)

    // if (body.teamId) {
    //   await aclTeamMember(c, { teamId: body.teamId })
    // }

    const teamMember = c.get('teamMember')
    const namespace = teamMember ? teamMember.teamSlug : user.username
    const identifier = `@${namespace}/${body.slug}`
    const { projectIdentifier, projectNamespace, projectSlug } =
      parseProjectIdentifier(identifier)

    // Used for testing e2e fixtures in the development marketplace
    const isPrivate = !(
      (user.username === 'dev' && env.isDev) ||
      user.username === 'agentic'
    )

    // Used to simplify recreating the demo `@agentic/search` project during
    // development while we're frequently resetting the database
    const secret =
      projectIdentifier === '@dev/search' ||
      projectIdentifier === '@agentic/search'
        ? env.AGENTIC_SEARCH_PROXY_SECRET
        : await sha256()

    const [project] = await db
      .insert(schema.projects)
      .values({
        ...body,
        identifier: projectIdentifier,
        namespace: projectNamespace,
        slug: projectSlug,
        teamId: teamMember?.teamId,
        userId: user.id,
        private: isPrivate,
        _secret: secret
      })
      .returning()
    assert(project, 500, `Failed to create project "${body.name}"`)

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/get-project-by-identifier.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { projectIdentifierAndPopulateSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a project by its public identifier (eg, "@username/project-slug").',
  tags: ['projects'],
  operationId: 'getProjectByIdentifier',
  method: 'get',
  path: 'projects/by-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: projectIdentifierAndPopulateSchema
  },
  responses: {
    200: {
      description: 'A project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetProjectByIdentifier(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { projectIdentifier, populate = [] } = c.req.valid('query')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(project, 404, `Project not found "${projectIdentifier}"`)
    await acl(c, project, { label: 'Project' })

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/get-project.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { populateProjectSchema, projectIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Gets a project by ID.',
  tags: ['projects'],
  operationId: 'getProject',
  method: 'get',
  path: 'projects/{projectId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: projectIdParamsSchema,
    query: populateProjectSchema
  },
  responses: {
    200: {
      description: 'A project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetProject(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { projectId } = c.req.valid('param')
    const { populate = [] } = c.req.valid('query')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.id, projectId),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    assert(project, 404, `Project not found "${projectId}"`)
    await acl(c, project, { label: 'Project' })

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/get-public-project-by-identifier.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import { db, eq, schema } from '@/db'
import { aclPublicProject } from '@/lib/acl-public-project'
import { setPublicCacheControl } from '@/lib/cache-control'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { projectIdentifierAndPopulateSchema } from './schemas'

const route = createRoute({
  description:
    'Gets a public project by its public identifier (eg, "@username/project-slug").',
  tags: ['projects'],
  operationId: 'getPublicProjectByIdentifier',
  method: 'get',
  path: 'projects/public/by-identifier',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: projectIdentifierAndPopulateSchema
  },
  responses: {
    200: {
      description: 'A project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetPublicProjectByIdentifier(
  app: OpenAPIHono<DefaultHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { projectIdentifier, populate = [] } = c.req.valid('query')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    aclPublicProject(project, projectIdentifier)
    setPublicCacheControl(c.res, env.isProd ? '1m' : '10s')

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/get-public-project.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import { db, eq, schema } from '@/db'
import { aclPublicProject } from '@/lib/acl-public-project'
import { setPublicCacheControl } from '@/lib/cache-control'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { populateProjectSchema, projectIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Gets a public project by ID.',
  tags: ['projects'],
  operationId: 'getPublicProject',
  method: 'get',
  path: 'projects/public/{projectId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: projectIdParamsSchema,
    query: populateProjectSchema
  },
  responses: {
    200: {
      description: 'A project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetPublicProject(app: OpenAPIHono<DefaultHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { projectId } = c.req.valid('param')
    const { populate = [] } = c.req.valid('query')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.id, projectId),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      }
    })
    aclPublicProject(project, projectId)
    setPublicCacheControl(c.res, env.isProd ? '1m' : '10s')

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/list-projects.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { paginationAndPopulateProjectSchema } from './schemas'

const route = createRoute({
  description: 'Lists projects owned by the authenticated user or team.',
  tags: ['projects'],
  operationId: 'listProjects',
  method: 'get',
  path: 'projects',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: paginationAndPopulateProjectSchema
  },
  responses: {
    200: {
      description: 'A list of projects',
      content: {
        'application/json': {
          schema: z.array(schema.projectSelectSchema)
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1ListProjects(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt',
      populate = []
    } = c.req.valid('query')

    const user = await ensureAuthUser(c)
    const teamMember = c.get('teamMember')
    const isAdmin = user.role === 'admin'

    const projects = await db.query.projects.findMany({
      where: isAdmin
        ? undefined
        : teamMember
          ? eq(schema.projects.teamId, teamMember.teamId)
          : eq(schema.projects.userId, user.id),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      },
      orderBy: (projects, { asc, desc }) => [
        sort === 'desc' ? desc(projects[sortBy]) : asc(projects[sortBy])
      ],
      offset,
      limit
    })

    return c.json(parseZodSchema(z.array(schema.projectSelectSchema), projects))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/list-public-projects.ts
================================================
import { env } from 'node:process'

import type { DefaultHonoEnv } from '@agentic/platform-hono'
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import {
  and,
  arrayContains,
  db,
  eq,
  isNotNull,
  isNull,
  not,
  or,
  schema
} from '@/db'
import { setPublicCacheControl } from '@/lib/cache-control'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { listPublicProjectsQuerySchema } from './schemas'

const route = createRoute({
  description:
    'Lists projects that have been published publicly to the marketplace.',
  tags: ['projects'],
  operationId: 'listPublicProjects',
  method: 'get',
  path: 'projects/public',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: listPublicProjectsQuerySchema
  },
  responses: {
    200: {
      description: 'A list of projects',
      content: {
        'application/json': {
          schema: z.array(schema.projectSelectSchema)
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1ListPublicProjects(app: OpenAPIHono<DefaultHonoEnv>) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt',
      populate = [],
      tag,
      notTag
    } = c.req.valid('query')

    const projects = await db.query.projects.findMany({
      // List projects that are not private and have at least one published deployment
      // And optionally match a given tag
      where: and(
        eq(schema.projects.private, false),
        isNotNull(schema.projects.lastPublishedDeploymentId),
        tag ? arrayContains(schema.projects.tags, [tag]) : undefined,
        notTag
          ? or(
              not(arrayContains(schema.projects.tags, [notTag])),
              isNull(schema.projects.tags)
            )
          : undefined
      ),
      with: {
        lastPublishedDeployment: true,
        ...Object.fromEntries(populate.map((field) => [field, true]))
      },
      orderBy: (projects, { asc, desc }) => [
        sort === 'desc' ? desc(projects[sortBy]) : asc(projects[sortBy])
      ],
      offset,
      limit
    })
    setPublicCacheControl(c.res, env.isProd ? '1m' : '10s')

    return c.json(parseZodSchema(z.array(schema.projectSelectSchema), projects))
  })
}


================================================
FILE: apps/api/src/api-v1/projects/schemas.ts
================================================
// import { isValidNamespace } from '@agentic/platform-validators'
import { z } from '@hono/zod-openapi'

import {
  paginationSchema,
  projectIdentifierSchema,
  projectIdSchema,
  projectRelationsSchema
} from '@/db'

export const projectIdParamsSchema = z.object({
  projectId: projectIdSchema.openapi({
    param: {
      description: 'Project ID',
      name: 'projectId',
      in: 'path'
    }
  })
})

// export const namespaceParamsSchema = z.object({
//   namespace: z
//     .string()
//     .refine((namespace) => isValidNamespace(namespace), {
//       message: 'Invalid namespace'
//     })
//     .openapi({
//       param: {
//         description: 'Namespace',
//         name: 'namespace',
//         in: 'path'
//       }
//     })
// })

export const projectIdentifierQuerySchema = z.object({
  projectIdentifier: projectIdentifierSchema
})

export const filterPublicProjectSchema = z.object({
  tag: z.string().optional(),
  notTag: z.string().optional()
})

export const populateProjectSchema = z.object({
  populate: z
    .union([projectRelationsSchema, z.array(projectRelationsSchema)])
    .default([])
    .transform((p) => (Array.isArray(p) ? p : [p]))
    .optional()
})

export const projectIdentifierAndPopulateSchema = z.object({
  ...populateProjectSchema.shape,
  ...projectIdentifierQuerySchema.shape
})

export const paginationAndPopulateProjectSchema = z.object({
  ...paginationSchema.shape,
  ...populateProjectSchema.shape
})

export const listPublicProjectsQuerySchema = z.object({
  ...paginationSchema.shape,
  ...populateProjectSchema.shape,
  ...filterPublicProjectSchema.shape
})


================================================
FILE: apps/api/src/api-v1/projects/update-project.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { projectIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Updates a project.',
  tags: ['projects'],
  operationId: 'updateProject',
  method: 'post',
  path: 'projects/{projectId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: projectIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.projectUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The updated project',
      content: {
        'application/json': {
          schema: schema.projectSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1UpdateProject(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { projectId } = c.req.valid('param')
    const body = c.req.valid('json')

    // First ensure the project exists and the user has access to it
    let project = await db.query.projects.findFirst({
      where: eq(schema.projects.id, projectId)
    })
    assert(project, 404, `Project not found "${projectId}"`)
    await acl(c, project, { label: 'Project' })

    // Update the project
    ;[project] = await db
      .update(schema.projects)
      .set(body)
      .where(eq(schema.projects.id, projectId))
      .returning()
    assert(project, 500, `Failed to update project "${projectId}"`)

    return c.json(parseZodSchema(schema.projectSelectSchema, project))
  })
}


================================================
FILE: apps/api/src/api-v1/storage/get-signed-storage-upload-url.ts
================================================
import { assert } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, projectIdentifierSchema, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'
import {
  getStorageObjectPublicUrl,
  getStorageSignedUploadUrl
} from '@/lib/storage'

export const getSignedUploadUrlQuerySchema = z.object({
  projectIdentifier: projectIdentifierSchema,

  /**
   * Should be a hash of the contents of the file to upload with the correct
   * file extension.
   *
   * @example `9f86d081884c7d659a2feaa0c55ad015a.png`
   */
  key: z
    .string()
    .nonempty()
    .describe(
      'Should be a hash of the contents of the file to upload with the correct file extension (eg, "9f86d081884c7d659a2feaa0c55ad015a.png").'
    )
})

const route = createRoute({
  description:
    "Gets a signed URL for uploading a file to Agentic's blob storage. Files are namespaced to a given project and are identified by a key that should be a hash of the file's contents, with the correct file extension.",
  tags: ['storage'],
  operationId: 'getSignedStorageUploadUrl',
  method: 'get',
  path: 'storage/signed-upload-url',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: getSignedUploadUrlQuerySchema
  },
  responses: {
    200: {
      description: 'A signed upload URL',
      content: {
        'application/json': {
          schema: z.object({
            signedUploadUrl: z
              .string()
              .url()
              .describe('The signed upload URL.'),
            publicObjectUrl: z
              .string()
              .url()
              .describe('The public URL the object will have once uploaded.')
          })
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetSignedStorageUploadUrl(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { projectIdentifier, key } = c.req.valid('query')

    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier)
    })
    assert(project, 404, `Project not found "${projectIdentifier}"`)
    await acl(c, project, { label: 'Project' })

    const compoundKey = `${project.identifier}/${key}`
    const signedUploadUrl = await getStorageSignedUploadUrl(compoundKey)
    const publicObjectUrl = getStorageObjectPublicUrl(compoundKey)

    return c.json({ signedUploadUrl, publicObjectUrl })
  })
}


================================================
FILE: apps/api/src/api-v1/teams/create-team.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, schema } from '@/db'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import { ensureUniqueNamespace } from '@/lib/ensure-unique-namespace'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description: 'Creates a new team.',
  tags: ['teams'],
  operationId: 'createTeam',
  method: 'post',
  path: 'teams',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.teamInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The created team',
      content: {
        'application/json': {
          schema: schema.teamSelectSchema
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1CreateTeam(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const user = await ensureAuthUser(c)
    const body = c.req.valid('json')

    await ensureUniqueNamespace(body.slug, { label: 'Team slug' })

    return db.transaction(async (tx) => {
      const [team] = await tx
        .insert(schema.teams)
        .values({
          ...body,
          ownerId: user.id
        })
        .returning()
      assert(team, 500, `Failed to create team "${body.slug}"`)

      const [teamMember] = await tx
        .insert(schema.teamMembers)
        .values({
          userId: user.id,
          teamId: team.id,
          teamSlug: team.slug,
          role: 'admin',
          confirmed: true
        })
        .returning()
      assert(
        teamMember,
        500,
        `Failed to create team member owner for team "${body.slug}"`
      )

      return c.json(parseZodSchema(schema.teamSelectSchema, team))
    })
  })
}


================================================
FILE: apps/api/src/api-v1/teams/delete-team.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { aclTeamAdmin } from '@/lib/acl-team-admin'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Deletes a team by ID.',
  tags: ['teams'],
  operationId: 'deleteTeam',
  method: 'delete',
  path: 'teams/{teamId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdParamsSchema
  },
  responses: {
    200: {
      description: 'The team that was deleted',
      content: {
        'application/json': {
          schema: schema.teamSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1DeleteTeam(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { teamId } = c.req.valid('param')
    await aclTeamAdmin(c, { teamId })

    const [team] = await db
      .delete(schema.teams)
      .where(eq(schema.teams.id, teamId))
      .returning()
    assert(team, 404, `Team not found "${teamId}"`)

    return c.json(parseZodSchema(schema.teamSelectSchema, team))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/get-team.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { aclTeamMember } from '@/lib/acl-team-member'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Gets a team by ID.',
  tags: ['teams'],
  operationId: 'getTeam',
  method: 'get',
  path: 'teams/{teamId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdParamsSchema
  },
  responses: {
    200: {
      description: 'A team object',
      content: {
        'application/json': {
          schema: schema.teamSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetTeam(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { teamId } = c.req.valid('param')
    await aclTeamMember(c, { teamId })

    const team = await db.query.teams.findFirst({
      where: eq(schema.teams.id, teamId)
    })
    assert(team, 404, `Team not found "${teamId}"`)

    return c.json(parseZodSchema(schema.teamSelectSchema, team))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/list-teams.ts
================================================
import { parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, paginationSchema, schema } from '@/db'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponses
} from '@/lib/openapi-utils'

const route = createRoute({
  description: 'Lists all teams the authenticated user belongs to.',
  tags: ['teams'],
  operationId: 'listTeams',
  method: 'get',
  path: 'teams',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    query: paginationSchema
  },
  responses: {
    200: {
      description: 'A list of teams',
      content: {
        'application/json': {
          schema: z.array(schema.teamSelectSchema)
        }
      }
    },
    ...openapiErrorResponses
  }
})

export function registerV1ListTeams(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const {
      offset = 0,
      limit = 10,
      sort = 'desc',
      sortBy = 'createdAt'
    } = c.req.valid('query')
    const userId = c.get('userId')

    // schema.teamMembers._.columns

    const teamMembers = await db.query.teamMembers.findMany({
      where: eq(schema.teamMembers.userId, userId),
      with: {
        team: true
      },
      orderBy: (teamMembers, { asc, desc }) => [
        sort === 'desc' ? desc(teamMembers[sortBy]) : asc(teamMembers[sortBy])
      ],
      offset,
      limit
    })

    return c.json(parseZodSchema(z.array(schema.teamSelectSchema), teamMembers))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/members/create-team-member.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { aclTeamAdmin } from '@/lib/acl-team-admin'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponse409,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdParamsSchema } from '../schemas'

const route = createRoute({
  description: 'Creates a new team member.',
  tags: ['teams'],
  operationId: 'createTeamMember',
  method: 'post',
  path: 'teams/{teamId}/members',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.teamMemberInsertSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The created team member',
      content: {
        'application/json': {
          schema: schema.teamMemberSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404,
    ...openapiErrorResponse409
  }
})

export function registerV1CreateTeamMember(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { teamId } = c.req.valid('param')
    const body = c.req.valid('json')
    await aclTeamAdmin(c, { teamId })

    const team = await db.query.teams.findFirst({
      where: eq(schema.teams.id, teamId)
    })
    assert(team, 404, `Team not found "${teamId}"`)

    const existingTeamMember = await db.query.teamMembers.findFirst({
      where: and(
        eq(schema.teamMembers.teamId, teamId),
        eq(schema.teamMembers.userId, body.userId)
      )
    })
    assert(
      existingTeamMember,
      409,
      `User "${body.userId}" is already a member of team "${teamId}"`
    )

    const [teamMember] = await db
      .insert(schema.teamMembers)
      .values({
        ...body,
        teamId,
        teamSlug: team.slug
      })
      .returning()
    assert(
      teamMember,
      500,
      `Failed to create team member "${body.userId}"for team "${teamId}"`
    )

    // TODO: send team invite email

    return c.json(parseZodSchema(schema.teamMemberSelectSchema, teamMember))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/members/delete-team-member.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { aclTeamAdmin } from '@/lib/acl-team-admin'
import { aclTeamMember } from '@/lib/acl-team-member'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdTeamMemberUserIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Deletes a team member.',
  tags: ['teams'],
  operationId: 'deleteTeamMember',
  method: 'delete',
  path: 'teams/{teamId}/members/{userId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdTeamMemberUserIdParamsSchema
  },
  responses: {
    200: {
      description: 'The deleted team member',
      content: {
        'application/json': {
          schema: schema.teamMemberSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1DeleteTeamMember(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { teamId, userId } = c.req.valid('param')

    await aclTeamAdmin(c, { teamId })
    await aclTeamMember(c, { teamId, userId })

    const [teamMember] = await db
      .delete(schema.teamMembers)
      .where(
        and(
          eq(schema.teamMembers.teamId, teamId),
          eq(schema.teamMembers.userId, userId)
        )
      )
      .returning()
    assert(
      teamMember,
      400,
      `Failed to update team member "${userId}" for team "${teamId}"`
    )

    return c.json(parseZodSchema(schema.teamMemberSelectSchema, teamMember))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/members/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import { userIdSchema } from '@/db'

import { teamIdParamsSchema } from '../schemas'

export const teamIdTeamMemberUserIdParamsSchema = z.object({
  ...teamIdParamsSchema.shape,

  userId: userIdSchema.openapi({
    param: {
      description: 'Team member user ID',
      name: 'userId',
      in: 'path'
    }
  })
})


================================================
FILE: apps/api/src/api-v1/teams/members/update-team-member.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { aclTeamAdmin } from '@/lib/acl-team-admin'
import { aclTeamMember } from '@/lib/acl-team-member'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdTeamMemberUserIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Updates a team member.',
  tags: ['teams'],
  operationId: 'updateTeamMember',
  method: 'post',
  path: 'teams/{teamId}/members/{userId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdTeamMemberUserIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.teamMemberUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The updated team member',
      content: {
        'application/json': {
          schema: schema.teamMemberSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1UpdateTeamMember(
  app: OpenAPIHono<AuthenticatedHonoEnv>
) {
  return app.openapi(route, async (c) => {
    const { teamId, userId } = c.req.valid('param')
    const body = c.req.valid('json')

    await aclTeamAdmin(c, { teamId })
    await aclTeamMember(c, { teamId, userId })

    const [teamMember] = await db
      .update(schema.teamMembers)
      .set(body)
      .where(
        and(
          eq(schema.teamMembers.teamId, teamId),
          eq(schema.teamMembers.userId, userId)
        )
      )
      .returning()
    assert(
      teamMember,
      400,
      `Failed to update team member "${userId}" for team "${teamId}"`
    )

    return c.json(parseZodSchema(schema.teamMemberSelectSchema, teamMember))
  })
}


================================================
FILE: apps/api/src/api-v1/teams/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import { teamIdSchema } from '@/db'

export const teamIdParamsSchema = z.object({
  teamId: teamIdSchema.openapi({
    param: {
      description: 'Team ID',
      name: 'teamId',
      in: 'path'
    }
  })
})


================================================
FILE: apps/api/src/api-v1/teams/update-team.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { aclTeamAdmin } from '@/lib/acl-team-admin'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { teamIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Updates a team.',
  tags: ['teams'],
  operationId: 'updateTeam',
  method: 'post',
  path: 'teams/{teamId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: teamIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.teamUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'The updated team',
      content: {
        'application/json': {
          schema: schema.teamSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1UpdateTeam(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { teamId } = c.req.valid('param')
    const body = c.req.valid('json')
    await aclTeamAdmin(c, { teamId })

    const [team] = await db
      .update(schema.teams)
      .set(body)
      .where(eq(schema.teams.id, teamId))
      .returning()
    assert(team, 404, `Team not found "${teamId}"`)

    return c.json(parseZodSchema(schema.teamSelectSchema, team))
  })
}


================================================
FILE: apps/api/src/api-v1/users/get-user.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import { setPublicCacheControl } from '@/lib/cache-control'
import { env } from '@/lib/env'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { userIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Gets a user by ID.',
  tags: ['users'],
  operationId: 'getUser',
  method: 'get',
  path: 'users/{userId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: userIdParamsSchema
  },
  responses: {
    200: {
      description: 'A user object',
      content: {
        'application/json': {
          schema: schema.userSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1GetUser(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { userId } = c.req.valid('param')
    await acl(c, { userId }, { label: 'User' })

    const user = await db.query.users.findFirst({
      where: eq(schema.users.id, userId)
    })
    assert(user, 404, `User not found "${userId}"`)
    setPublicCacheControl(c.res, env.isProd ? '30s' : '10s')

    return c.json(parseZodSchema(schema.userSelectSchema, user))
  })
}


================================================
FILE: apps/api/src/api-v1/users/schemas.ts
================================================
import { z } from '@hono/zod-openapi'

import { userIdSchema } from '@/db'

export const userIdParamsSchema = z.object({
  userId: userIdSchema.openapi({
    param: {
      description: 'User ID',
      name: 'userId',
      in: 'path'
    }
  })
})


================================================
FILE: apps/api/src/api-v1/users/update-user.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import { createRoute, type OpenAPIHono } from '@hono/zod-openapi'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { db, eq, schema } from '@/db'
import { acl } from '@/lib/acl'
import {
  openapiAuthenticatedSecuritySchemas,
  openapiErrorResponse404,
  openapiErrorResponses
} from '@/lib/openapi-utils'

import { userIdParamsSchema } from './schemas'

const route = createRoute({
  description: 'Updates a user by ID.',
  tags: ['users'],
  operationId: 'updateUser',
  method: 'post',
  path: 'users/{userId}',
  security: openapiAuthenticatedSecuritySchemas,
  request: {
    params: userIdParamsSchema,
    body: {
      required: true,
      content: {
        'application/json': {
          schema: schema.userUpdateSchema
        }
      }
    }
  },
  responses: {
    200: {
      description: 'A user object',
      content: {
        'application/json': {
          schema: schema.userSelectSchema
        }
      }
    },
    ...openapiErrorResponses,
    ...openapiErrorResponse404
  }
})

export function registerV1UpdateUser(app: OpenAPIHono<AuthenticatedHonoEnv>) {
  return app.openapi(route, async (c) => {
    const { userId } = c.req.valid('param')
    await acl(c, { userId }, { label: 'User' })
    const body = c.req.valid('json')

    const [user] = await db
      .update(schema.users)
      .set(body)
      .where(eq(schema.users.id, userId))
      .returning()
    assert(user, 404, `User not found "${userId}"`)

    return c.json(parseZodSchema(schema.userSelectSchema, user))
  })
}


================================================
FILE: apps/api/src/api-v1/webhooks/stripe-webhook.ts
================================================
import type Stripe from 'stripe'
import { assert, HttpError } from '@agentic/platform-core'

import type { HonoApp } from '@/lib/types'
import {
  and,
  db,
  eq,
  getStripePriceIdForPricingPlanLineItem,
  type RawConsumer,
  type RawDeployment,
  type RawProject,
  schema
} from '@/db'
import { setConsumerStripeSubscriptionStatus } from '@/lib/consumers/utils'
import { env } from '@/lib/env'
import { stripe } from '@/lib/external/stripe'

const relevantStripeEvents = new Set<Stripe.Event.Type>([
  // Stripe Checkout Sessions
  'checkout.session.completed',

  // TODO: Handle these events
  // 'checkout.session.expired',
  // 'checkout.session.async_payment_failed',
  // 'checkout.session.async_payment_succeeded',

  // Stripe Subscriptions
  'customer.subscription.created',

  // TODO: Test these events which should be able to all use the same code path
  'customer.subscription.updated',
  'customer.subscription.paused',
  'customer.subscription.resumed',
  'customer.subscription.deleted'

  // TODO: Handle these events
  // 'customer.subscription.pending_update_applied',
  // 'customer.subscription.pending_update_expired',
  // 'customer.subscription.trial_will_end'
])

export function registerV1StripeWebhook(app: HonoApp) {
  return app.post('webhooks/stripe', async (ctx) => {
    const logger = ctx.get('logger')
    const body = await ctx.req.text()
    const signature = ctx.req.header('Stripe-Signature')
    assert(
      signature,
      400,
      'error invalid stripe webhook event: missing signature'
    )

    let event: Stripe.Event

    try {
      event = stripe.webhooks.constructEvent(
        body,
        signature,
        env.STRIPE_WEBHOOK_SECRET
      )
    } catch (err) {
      throw new HttpError({
        message: 'error invalid stripe webhook event: signature mismatch',
        cause: err,
        statusCode: 400
      })
    }

    // Shouldn't ever happen because the signatures _should_ be different, but
    // it's a useful sanity check just in case.
    assert(
      event.livemode === env.isStripeLive,
      400,
      'error invalid stripe webhook event: livemode mismatch'
    )

    if (!relevantStripeEvents.has(event.type)) {
      return ctx.json({ status: 'ok' })
    }

    logger.info('stripe webhook', event.type, event.data?.object)

    try {
      switch (event.type) {
        case 'checkout.session.completed': {
          const checkoutSession = event.data.object
          const { subscription: subscriptionOrId } = checkoutSession
          assert(subscriptionOrId, 400, 'missing subscription')
          const { consumerId, plan, userId, projectId, deploymentId } =
            checkoutSession.metadata ?? {}
          assert(consumerId, 400, 'missing metadata.consumerId')
          assert(plan !== undefined, 400, 'missing metadata.plan')

          const subscriptionId =
            typeof subscriptionOrId === 'string'
              ? subscriptionOrId
              : subscriptionOrId.id

          const [subscription, consumer, deployment] = await Promise.all([
            // Make sure we have the full subscription instead of just the id
            typeof subscriptionOrId === 'string'
              ? stripe.subscriptions.retrieve(subscriptionId)
              : subscriptionOrId,

            db.query.consumers.findFirst({
              where: and(eq(schema.consumers.id, consumerId)),
              with: { project: true }
            }),

            deploymentId
              ? db.query.deployments.findFirst({
                  where: and(eq(schema.deployments.id, deploymentId))
                })
              : undefined
          ])
          assert(
            subscription,
            404,
            `stripe subscription "${subscriptionId}" not found`
          )
          assert(consumer, 404, `consumer "${consumerId}" not found`)
          if (deploymentId) {
            assert(deployment, 404, `deployment "${deploymentId}" not found`)
          }
          const { project } = consumer
          assert(project, 404, `project "${projectId}" not found`)

          // TODO: Treat this as a transaction...
          await Promise.all([
            // Ensure the underlying Stripe Subscription has all the necessary
            // metadata
            stripe.subscriptions.update(subscription.id, {
              metadata: {
                ...subscription.metadata,
                ...checkoutSession.metadata
              }
            }),

            // Sync our Consumer's state with the Stripe Subscription's state
            syncConsumerWithStripeSubscription({
              consumer,
              deployment,
              project,
              subscription,
              plan,
              userId,
              projectId,
              deploymentId
            })
          ])
          break
        }

        case 'customer.subscription.created': {
          // Stripe Checkout-created subscriptions won't have the metadata
          // necessary to identify the consumer, so ignore this event for now.
          const subscription = event.data.object
          const { consumerId, userId, projectId, deploymentId, plan } =
            subscription.metadata

          // TODO: This should be coming from Stripe Checkout, and a subsequent
          // webhook event should record the subscription and initialize the
          // consumer, but it feels wrong to me to just be logging and ignore
          // this event. In the future, if we support both Stripe Checkout and
          // non-Stripe Checkout-based subscription flows, then this codepath
          // should act very similarly to `customer.subscription.updated`.
          if (
            !consumerId ||
            !userId ||
            !projectId ||
            !deploymentId ||
            plan === undefined
          ) {
            break
          }

          // Intentional fallthrough
        }

        case 'customer.subscription.paused':
        case 'customer.subscription.resumed':
        case 'customer.subscription.deleted':
        case 'customer.subscription.updated': {
          // https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses
          const subscription = event.data.object
          const { consumerId, userId, projectId, deploymentId, plan } =
            subscription.metadata
          assert(consumerId, 'missing metadata.consumerId')
          assert(plan !== undefined, 400, 'missing metadata.plan')

          logger.info('stripe webhook', event.type, {
            consumerId,
            userId,
            projectId,
            deploymentId,
            plan,
            status: subscription.status
          })

          const [consumer, deployment] = await Promise.all([
            db.query.consumers.findFirst({
              where: eq(schema.consumers.id, consumerId),
              with: { project: true }
            }),

            deploymentId
              ? db.query.deployments.findFirst({
                  where: and(eq(schema.deployments.id, deploymentId))
                })
              : undefined
          ])
          assert(consumer, 404, `consumer "${consumerId}" not found`)
          if (deploymentId) {
            assert(deployment, 404, `deployment "${deploymentId}" not found`)
          }
          const { project } = consumer

          // Sync our Consumer's state with the Stripe Subscription's state
          await syncConsumerWithStripeSubscription({
            consumer,
            deployment,
            project,
            subscription,
            plan,
            userId,
            projectId,
            deploymentId
          })
          break
        }

        default:
          logger.warn(
            `unexpected unhandled event "${event.id}" type "${event.type}"`,
            event.data?.object
          )
      }
    } catch (err: any) {
      throw new HttpError({
        message: `error processing stripe webhook event "${event.id}" type "${event.type}": ${err.message}`,
        cause: err.cause ?? err,
        statusCode: err.statusCode ?? err
      })
    }

    return ctx.json({ status: 'ok' })
  })
}

/**
 * Sync our database Consumer's state with the Stripe Subscription's state.
 *
 * For anything billing-related, Stripe's resources is always considered the
 * single source of truth. Our database's `Consumer` state should always be
 * derived from the corresponding Stripe subscription.
 */
export async function syncConsumerWithStripeSubscription({
  consumer,
  project,
  deployment,
  subscription,
  plan,
  userId,
  projectId,
  deploymentId
}: {
  consumer: RawConsumer
  project: RawProject
  deployment?: RawDeployment
  subscription: Stripe.Subscription
  plan: string | null | undefined
  userId?: string
  projectId?: string
  deploymentId?: string
}): Promise<RawConsumer> {
  // These extra checks aren't really necessary, but they're nice sanity checks
  // to ensure metadata consistency with our consumer
  assert(
    consumer.userId === userId,
    400,
    `consumer "${consumer.id}" user "${consumer.userId}" does not match stripe checkout metadata user "${userId}"`
  )
  assert(
    consumer.projectId === projectId,
    400,
    `consumer "${consumer.id}" project "${consumer.projectId}" does not match stripe checkout metadata project "${projectId}"`
  )

  consumer._stripeSubscriptionId = subscription.id
  consumer.stripeStatus = subscription.status
  consumer.plan = plan as any // TODO: types
  setConsumerStripeSubscriptionStatus(consumer)

  if (deploymentId) {
    consumer.deploymentId = deploymentId
  }

  const pricingPlan = plan
    ? deployment?.pricingPlans.find((p) => p.slug === plan)
    : undefined

  if (pricingPlan) {
    for (const lineItem of pricingPlan.lineItems) {
      const stripeSubscriptionItemId =
        consumer._stripeSubscriptionItemIdMap[lineItem.slug]

      const stripePriceId: string | undefined = stripeSubscriptionItemId
        ? undefined
        : await getStripePriceIdForPricingPlanLineItem({
            pricingPlan,
            pricingPlanLineItem: lineItem,
            project
          })

      const stripeSubscriptionItem: Stripe.SubscriptionItem | undefined =
        subscription.items.data.find((item) =>
          stripeSubscriptionItemId
            ? item.id === stripeSubscriptionItemId
            : item.price.id === stripePriceId
        )

      assert(
        stripeSubscriptionItem,
        500,
        `Error post-processing stripe subscription "${subscription.id}" for line-item "${lineItem.slug}" on plan "${pricingPlan.slug}"`
      )

      consumer._stripeSubscriptionItemIdMap[lineItem.slug] =
        stripeSubscriptionItem.id
      assert(
        consumer._stripeSubscriptionItemIdMap[lineItem.slug],
        500,
        `Error post-processing stripe subscription "${subscription.id}" for line-item "${lineItem.slug}" on plan "${pricingPlan.slug}"`
      )
    }
  }

  const [updatedConsumer] = await db
    .update(schema.consumers)
    .set(consumer)
    .where(eq(schema.consumers.id, consumer.id))
    .returning()
  assert(updatedConsumer, 500, `consumer "${consumer.id}" not found`)

  // TODO: invoke provider webhooks
  // event.data.customer = consumer.getPublicDocument()
  // await invokeWebhooks(consumer.project, event)

  return updatedConsumer
}


================================================
FILE: apps/api/src/db/index.ts
================================================
import { drizzle } from '@fisch0920/drizzle-orm/postgres-js'
import postgres from 'postgres'

import { env } from '@/lib/env'

import * as schema from './schema'

type PostgresClient = ReturnType<typeof postgres>

let _postgresClient: PostgresClient | undefined
const postgresClient =
  _postgresClient ?? (_postgresClient = postgres(env.DATABASE_URL))

export const db = drizzle({ client: postgresClient, schema })

export * as schema from './schema'
export {
  createIdForModel,
  idMaxLength,
  idPrefixMap,
  type ModelType
} from './schema/common'
export * from './schemas'
export type * from './types'
export * from './utils'
export {
  and,
  arrayContained,
  arrayContains,
  arrayOverlaps,
  asc,
  between,
  desc,
  eq,
  exists,
  gt,
  gte,
  ilike,
  inArray,
  isNotNull,
  isNull,
  like,
  lt,
  lte,
  ne,
  not,
  notBetween,
  notExists,
  notIlike,
  notInArray,
  notLike,
  or
} from '@fisch0920/drizzle-orm'


================================================
FILE: apps/api/src/db/schema/account.ts
================================================
import { relations } from '@fisch0920/drizzle-orm'
import { index, pgTable, text, timestamp } from '@fisch0920/drizzle-orm/pg-core'

import { userIdSchema } from '../schemas'
import {
  accountPrimaryId,
  authProviderTypeEnum,
  createSelectSchema,
  timestamps,
  userId
} from './common'
import { users } from './user'

export const accounts = pgTable(
  'accounts',
  {
    ...accountPrimaryId,
    ...timestamps,

    userId: userId()
      .notNull()
      .references(() => users.id, { onDelete: 'cascade' }),
    provider: authProviderTypeEnum().notNull(),

    /** Provider-specific account ID (or email in the case of `password` provider) */
    accountId: text().notNull(),

    password: text(),

    /** Provider-specific username */
    accountUsername: text(),

    /** Standard OAuth2 access token */
    accessToken: text(),

    /** Standard OAuth2 refresh token */
    refreshToken: text(),

    /** Standard OAuth2 access token expires at */
    accessTokenExpiresAt: timestamp(),

    /** Standard OAuth2 refresh token expires at */
    refreshTokenExpiresAt: timestamp(),

    /** OAuth scope(s) */
    scope: text()
  },
  (table) => [
    index('account_provider_idx').on(table.provider),
    index('account_userId_idx').on(table.userId),
    index('account_createdAt_idx').on(table.createdAt),
    index('account_updatedAt_idx').on(table.updatedAt),
    index('account_deletedAt_idx').on(table.deletedAt)
  ]
)

export const accountsRelations = relations(accounts, ({ one }) => ({
  user: one(users, {
    fields: [accounts.userId],
    references: [users.id]
  })
}))

export const accountSelectSchema = createSelectSchema(accounts, {
  userId: userIdSchema
})
  .omit({
    password: true,
    accessToken: true,
    refreshToken: true,
    accessTokenExpiresAt: true,
    refreshTokenExpiresAt: true
  })
  .strip()
  .openapi('Account')


================================================
FILE: apps/api/src/db/schema/auth-data.ts
================================================
import { jsonb, pgTable, text, timestamp } from '@fisch0920/drizzle-orm/pg-core'

import { timestamps } from './common'

// Simple key-value store of JSON data for OpenAuth-related state.
// TODO: remove this and/or replace this with non-openauth version
export const authData = pgTable('auth_data', {
  // Example ID keys:
  // "oauth:refresh\u001fuser:f99d3004946f9abb\u001f2cae301e-3fdc-40c4-8cda-83b25a616d06"
  // "signing:key\u001ff001a516-838d-4c88-aa9e-719d8fc9d5a3"
  // "email\u001ft@t.com\u001fpassword"
  // "encryption:key\u001f14d3c324-f9c7-4867-81a9-b0b77b0db0be"
  id: text().primaryKey(),
  ...timestamps,

  value: jsonb().$type<Record<string, any>>().notNull(),
  expiry: timestamp()
})


================================================
FILE: apps/api/src/db/schema/common.test.ts
================================================
import { expect, test } from 'vitest'

import { getIdSchemaForModelType } from '../schemas'
import {
  createIdForModel,
  idMaxLength,
  idPrefixMap,
  type ModelType
} from './common'

for (const modelType of Object.keys(idPrefixMap)) {
  test(`${modelType} id`, () => {
    for (let i = 0; i < 100; ++i) {
      const id = createIdForModel(modelType as ModelType)
      expect(id.startsWith(idPrefixMap[modelType as ModelType])).toBe(true)
      expect(id.length).toBeLessThanOrEqual(idMaxLength)
      expect(getIdSchemaForModelType(modelType as ModelType).parse(id)).toBe(id)
    }
  })
}


================================================
FILE: apps/api/src/db/schema/common.ts
================================================
import { assert } from '@agentic/platform-core'
import { type Equal, sql, type Writable } from '@fisch0920/drizzle-orm'
import {
  pgEnum,
  type PgTimestampBuilderInitial,
  type PgTimestampConfig,
  type PgTimestampStringBuilderInitial,
  type PgVarcharBuilderInitial,
  type PgVarcharConfig,
  timestamp as timestampImpl,
  varchar
} from '@fisch0920/drizzle-orm/pg-core'
import { createSchemaFactory } from '@fisch0920/drizzle-zod'
import { z } from '@hono/zod-openapi'
import { createId as createCuid2 } from '@paralleldrive/cuid2'

export const namespaceMaxLength = 256 as const
export const projectSlugMaxLength = 256 as const
export const projectNameMaxLength = 1024 as const

// prefix is max 5 characters
// separator is 1 character
// cuid2 is max 24 characters
// so use 32 characters to be safe for storing ids
export const idMaxLength = 32 as const

export const idPrefixMap = {
  team: 'team',
  project: 'proj',
  deployment: 'depl',
  consumer: 'csmr',
  logEntry: 'log',

  // auth
  user: 'user',
  account: 'acct'
} as const

export type ModelType = keyof typeof idPrefixMap

export function createIdForModel(modelType: ModelType): string {
  const prefix = idPrefixMap[modelType]
  assert(prefix, 500, `Invalid model type: ${modelType}`)

  return `${prefix}_${createCuid2()}`
}

/**
 * Returns the primary `id` key to use for a given model type.
 */
function getPrimaryId(modelType: ModelType) {
  return {
    id: id()
      .primaryKey()
      .$defaultFn(() => createIdForModel(modelType))
  }
}

export const projectPrimaryId = getPrimaryId('project')
export const deploymentPrimaryId = getPrimaryId('deployment')
export const consumerPrimaryId = getPrimaryId('consumer')
export const logEntryPrimaryId = getPrimaryId('logEntry')
export const teamPrimaryId = getPrimaryId('team')
export const userPrimaryId = getPrimaryId('user')
export const accountPrimaryId = getPrimaryId('account')

/**
 * All of our model primary ids have the following format:
 *
 * `${modelPrefix}_${cuid2}`
 */
export function id<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof idMaxLength> {
  return varchar({ length: idMaxLength, ...config })
}

export const projectId = id
export const deploymentId = id
export const consumerId = id
export const logEntryId = id
export const teamId = id
export const userId = id

export function stripeId<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, 255> {
  return varchar({ length: 255, ...config })
}

/**
 * `namespace/project-slug`
 */
export function projectIdentifier<
  U extends string,
  T extends Readonly<[U, ...U[]]>
>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, 514> {
  return varchar({ length: 514, ...config })
}

/**
 * `namespace/project-slug@hash`
 */
export function deploymentIdentifier<
  U extends string,
  T extends Readonly<[U, ...U[]]>
>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, 530> {
  return varchar({ length: 530, ...config })
}

export function username<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof namespaceMaxLength> {
  return varchar({ length: namespaceMaxLength, ...config })
}

export function teamSlug<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof namespaceMaxLength> {
  return varchar({ length: namespaceMaxLength, ...config })
}

export function projectNamespace<
  U extends string,
  T extends Readonly<[U, ...U[]]>
>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof namespaceMaxLength> {
  return varchar({ length: namespaceMaxLength, ...config })
}

export function projectSlug<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof projectSlugMaxLength> {
  return varchar({ length: projectSlugMaxLength, ...config })
}

export function projectName<U extends string, T extends Readonly<[U, ...U[]]>>(
  config?: PgVarcharConfig<T | Writable<T>, never>
): PgVarcharBuilderInitial<'', Writable<T>, typeof projectNameMaxLength> {
  return varchar({ length: projectNameMaxLength, ...config })
}

/**
 * Timestamp with mode `string`
 */
export function timestamp<
  TMode extends PgTimestampConfig['mode'] & {} = 'string'
>(
  config?: PgTimestampConfig<TMode>
): Equal<TMode, 'string'> extends true
  ? PgTimestampStringBuilderInitial<''>
  : PgTimestampBuilderInitial<''> {
  return timestampImpl<TMode>({
    mode: 'string' as unknown as TMode,
    withTimezone: true,
    ...config
  })
}

export const timestamps = {
  createdAt: timestamp().notNull().defaultNow(),
  updatedAt: timestamp()
    .notNull()
    .default(sql`now()`),
  deletedAt: timestamp()
}

export const userRoleEnum = pgEnum('UserRole', ['user', 'admin'])
export const teamMemberRoleEnum = pgEnum('TeamMemberRole', ['user', 'admin'])
export const logEntryTypeEnum = pgEnum('LogEntryType', ['log'])
export const logEntryLevelEnum = pgEnum('LogEntryLevel', [
  'trace',
  'debug',
  'info',
  'warn',
  'error'
])
export const pricingIntervalEnum = pgEnum('PricingInterval', [
  'day',
  'week',
  'month',
  'year'
])
export const pricingCurrencyEnum = pgEnum('PricingCurrency', ['usd'])
export const authProviderTypeEnum = pgEnum('AuthProviderType', [
  'github',
  'password'
])

export const { createInsertSchema, createSelectSchema, createUpdateSchema } =
  createSchemaFactory({
    zodInstance: z,
    coerce: {
      // Coerce dates / strings to timetamps
      date: true
    }
  })


================================================
FILE: apps/api/src/db/schema/consumer.ts
================================================
import {
  type StripeSubscriptionItemIdMap,
  stripeSubscriptionItemIdMapSchema
} from '@agentic/platform-types'
import { relations } from '@fisch0920/drizzle-orm'
import {
  boolean,
  index,
  jsonb,
  pgTable,
  text
} from '@fisch0920/drizzle-orm/pg-core'
import { z } from '@hono/zod-openapi'

import { env } from '@/lib/env'

import {
  consumerIdSchema,
  deploymentIdSchema,
  projectIdSchema,
  userIdSchema
} from '../schemas'
import {
  consumerPrimaryId,
  createInsertSchema,
  createSelectSchema,
  createUpdateSchema,
  deploymentId,
  projectId,
  stripeId,
  timestamps,
  userId
} from './common'
import { deployments, deploymentSelectSchema } from './deployment'
import { projects, projectSelectSchema } from './project'
import { users, userSelectSchema } from './user'

// TODO: Consumers should be valid for any enabled project like in RapidAPI and GCP.
// This may require a separate model to aggregate User Applications.
// https://docs.rapidapi.com/docs/keys#section-different-api-keys-per-application

/**
 * A `Consumer` represents a user who has subscribed to a `Project` and is used
 * to track usage and billing.
 *
 * Consumers are linked to a corresponding Stripe Customer and Subscription.
 * The Stripe customer will either be the user's default Stripe Customer if the
 * project uses the default Agentic platform account, or a customer on the project
 * owner's connected Stripe account if the project has Stripe Connect enabled.
 */
export const consumers = pgTable(
  'consumers',
  {
    ...consumerPrimaryId,
    ...timestamps,

    // API key for this consumer
    // (called "token" for backwards compatibility)
    token: text().notNull(),

    // The slug of the PricingPlan in the target deployment that this consumer
    // is subscribed to.
    plan: text(),

    // Whether the consumer has made at least one successful API call after
    // initializing their subscription.
    activated: boolean().default(false).notNull(),

    // TODO: Re-add coupon support
    // coupon: text(),

    // only used during initial creation
    source: text(),

    userId: userId()
      .notNull()
      .references(() => users.id),

    // The project this user is subscribed to
    projectId: projectId()
      .notNull()
      .references(() => projects.id, {
        onDelete: 'cascade'
      }),

    // The specific deployment this user is subscribed to, since pricing can
    // change across deployment versions)
    deploymentId: deploymentId()
      .notNull()
      .references(() => deployments.id, {
        onDelete: 'cascade'
      }),

    // Stripe subscription status (synced via webhooks). Should move from
    // `incomplete` to `active` after the first successful payment.
    stripeStatus: text().default('incomplete').notNull(),

    // Whether the consumer's subscription is currently active, depending on
    // `stripeStatus`.
    isStripeSubscriptionActive: boolean().default(true).notNull(),

    // Main Stripe Subscription id
    _stripeSubscriptionId: stripeId(),

    // [pricingPlanLineItemSlug: string]: string
    _stripeSubscriptionItemIdMap: jsonb()
      .$type<StripeSubscriptionItemIdMap>()
      .default({})
      .notNull(),

    // Denormalized from User or possibly separate for stripe connect
    // TODO: is this necessary?
    _stripeCustomerId: stripeId().notNull()
  },
  (table) => [
    index('consumer_token_idx').on(table.token),
    index('consumer_userId_idx').on(table.userId),
    index('consumer_projectId_idx').on(table.projectId),
    index('consumer_deploymentId_idx').on(table.deploymentId),
    index('consumer_isStripeSubscriptionActive_idx').on(
      table.isStripeSubscriptionActive
    ),
    index('consumer_createdAt_idx').on(table.createdAt),
    index('consumer_updatedAt_idx').on(table.updatedAt),
    index('consumer_deletedAt_idx').on(table.deletedAt)
  ]
)

export const consumersRelations = relations(consumers, ({ one }) => ({
  user: one(users, {
    fields: [consumers.userId],
    references: [users.id]
  }),
  project: one(projects, {
    fields: [consumers.projectId],
    references: [projects.id]
  }),
  deployment: one(deployments, {
    fields: [consumers.deploymentId],
    references: [deployments.id]
  })
}))

export const consumerSelectBaseSchema = createSelectSchema(consumers, {
  id: consumerIdSchema,
  userId: userIdSchema,
  projectId: projectIdSchema,
  deploymentId: deploymentIdSchema,

  _stripeSubscriptionItemIdMap: stripeSubscriptionItemIdMapSchema
})
  .omit({
    _stripeSubscriptionId: true,
    _stripeSubscriptionItemIdMap: true,
    _stripeCustomerId: true
  })
  .extend({
    user: z
      .lazy(() => userSelectSchema)
      .optional()
      .openapi('User', { type: 'object' }),

    project: z
      .lazy(() => projectSelectSchema)
      .optional()
      .openapi('Project', { type: 'object' }),

    // deployment: z
    //   .lazy(() => deploymentSelectSchema)
    //   .optional()
    //   .openapi('Deployment', { type: 'object' })

    // TODO: Improve the self-referential typing here that `@hono/zod-openapi`
    // trips up on.
    deployment: z
      .any()
      .refine(
        (deployment): boolean =>
          !deployment || deploymentSelectSchema.safeParse(deployment).success,
        {
          message: 'Invalid lastDeployment'
        }
      )
      .transform((deployment): any => {
        if (!deployment) return undefined
        return deploymentSelectSchema.parse(deployment)
      })
      .optional()
  })

// These are all derived virtual URLs that are not stored in the database
export const derivedConsumerFields = {
  /**
   * A private admin URL for managing the customer's subscription. This URL
   * is only accessible by the customer.
   *
   * @example https://agentic.so/app/consumers/cons_123
   */
  adminUrl: z
    .string()
    .url()
    .describe(
      "A private admin URL for managing the customer's subscription. This URL is only accessible by the customer."
    )
} as const

export const consumerSelectSchema = consumerSelectBaseSchema
  .transform((consumer) => ({
    ...consumer,
    adminUrl: `${env.AGENTIC_WEB_BASE_URL}/app/consumers/${consumer.id}`
  }))
  .pipe(consumerSelectBaseSchema.extend(derivedConsumerFields).strip())
  .describe(
    `A Consumer represents a user who has subscribed to a Project and is used
to track usage and billing.

Consumers are linked to a corresponding Stripe Customer and Subscription.
The Stripe customer will either be the user's default Stripe Customer if the
project uses the default Agentic platform account, or a customer on the project
owner's connected Stripe account if the project has Stripe Connect enabled.`
  )
  .openapi('Consumer')

export const consumerAdminSelectSchema = consumerSelectBaseSchema
  .extend({
    _stripeCustomerId: z.string().nonempty()
  })
  .transform((consumer) => ({
    ...consumer,
    adminUrl: `${env.AGENTIC_WEB_BASE_URL}/app/consumers/${consumer.id}`
  }))
  .openapi('AdminConsumer')

export const consumerInsertSchema = createInsertSchema(consumers, {
  deploymentId: deploymentIdSchema.optional(),

  plan: z.string().nonempty()
})
  .pick({
    plan: true,
    source: true,
    deploymentId: true
  })
  .strict()

export const consumerUpdateSchema = createUpdateSchema(consumers, {
  deploymentId: deploymentIdSchema.optional()
})
  .pick({
    plan: true,
    deploymentId: true
  })
  .strict()


================================================
FILE: apps/api/src/db/schema/deployment.ts
================================================
import {
  agenticProjectConfigSchema,
  defaultRequestsRateLimit,
  type OriginAdapter,
  type PricingPlanList,
  type RateLimit,
  resolvedAgenticProjectConfigSchema,
  type Tool,
  type ToolConfig
} from '@agentic/platform-types'
import {
  isValidDeploymentHash,
  parseDeploymentIdentifier
} from '@agentic/platform-validators'
import { relations } from '@fisch0920/drizzle-orm'
import {
  boolean,
  index,
  jsonb,
  pgTable,
  text,
  uniqueIndex
} from '@fisch0920/drizzle-orm/pg-core'
import { z } from '@hono/zod-openapi'

import { env } from '@/lib/env'

import {
  deploymentIdentifierSchema,
  deploymentIdSchema,
  projectIdSchema,
  teamIdSchema,
  userIdSchema
} from '../schemas'
import {
  createSelectSchema,
  createUpdateSchema,
  deploymentIdentifier,
  deploymentPrimaryId,
  pricingIntervalEnum,
  projectId,
  projectName,
  teamId,
  timestamps,
  userId
} from './common'
import { projects, projectSelectSchema } from './project'
import { teams } from './team'
import { users } from './user'

/**
 * A Deployment is a single, immutable instance of a Project. Each deployment
 * contains pricing plans, origin server config (OpenAPI or MCP server), tool
 * definitions, and metadata.
 *
 * Deployments are private to a developer or team until they are published, at
 * which point they are accessible to any customers with access to the parent
 * Project.
 */
export const deployments = pgTable(
  'deployments',
  {
    ...deploymentPrimaryId,
    ...timestamps,

    identifier: deploymentIdentifier().unique().notNull(),
    hash: text().notNull(),
    version: text(),

    published: boolean().default(false).notNull(),

    // display name
    name: projectName().notNull(),

    description: text().default('').notNull(),
    readme: text(), // URL to uploaded markdown document
    iconUrl: text(),
    sourceUrl: text(),
    homepageUrl: text(),

    userId: userId()
      .notNull()
      .references(() => users.id),
    teamId: teamId().references(() => teams.id),
    projectId: projectId()
      .notNull()
      .references(() => projects.id, {
        onDelete: 'cascade'
      }),

    // Tool definitions exposed by the origin server
    tools: jsonb().$type<Tool[]>().notNull(),

    // Tool configs customize the behavior of tools for different pricing plans
    toolConfigs: jsonb().$type<ToolConfig[]>().default([]).notNull(),

    // Origin API adapter config (url, openapi/mcp/raw, internal/external hosting, etc)
    origin: jsonb().$type<OriginAdapter>().notNull(),

    // Array<PricingPlan>
    pricingPlans: jsonb().$type<PricingPlanList>().notNull(),

    // Which pricing intervals are supported for subscriptions to this project
    pricingIntervals: pricingIntervalEnum()
      .array()
      .default(['month'])
      .notNull(),

    // Default rate limit across all pricing plans
    defaultRateLimit: jsonb()
      .$type<RateLimit>()
      .notNull()
      .default(defaultRequestsRateLimit)

    // TODO: metadata config (logo, keywords, examples, etc)
    // TODO: webhooks
    // TODO: coupons
    // TODO: third-party auth provider config
    // NOTE: will need consumer.authProviders as well as user.authProviders for
    // this because custom oauth credentials that are deployment-specific. will
    // prolly also need to hash the individual AuthProviders in
    // deployment.authProviders to compare across deployments.
  },
  (table) => [
    uniqueIndex('deployment_identifier_idx').on(table.identifier),
    index('deployment_userId_idx').on(table.userId),
    index('deployment_teamId_idx').on(table.teamId),
    index('deployment_projectId_idx').on(table.projectId),
    index('deployment_published_idx').on(table.published),
    index('deployment_version_idx').on(table.version),
    index('deployment_createdAt_idx').on(table.createdAt),
    index('deployment_updatedAt_idx').on(table.updatedAt),
    index('deployment_deletedAt_idx').on(table.deletedAt)
  ]
)

export const deploymentsRelations = relations(deployments, ({ one }) => ({
  user: one(users, {
    fields: [deployments.userId],
    references: [users.id]
  }),
  team: one(teams, {
    fields: [deployments.teamId],
    references: [teams.id]
  }),
  project: one(projects, {
    fields: [deployments.projectId],
    references: [projects.id]
  })
}))

// TODO: virtual hasFreeTier
// TODO: virtual url
// TODO: virtual openApiUrl
// TODO: virtual saasUrl
// TODO: virtual authProviders?
// TODO: virtual openapi spec? (hide openapi.servers)

export const deploymentSelectBaseSchema = createSelectSchema(deployments, {
  id: deploymentIdSchema,
  userId: userIdSchema,
  teamId: teamIdSchema.optional(),
  projectId: projectIdSchema,
  identifier: deploymentIdentifierSchema,

  hash: (schema) =>
    schema.refine((hash) => isValidDeploymentHash(hash), {
      message: 'Invalid deployment hash'
    }),

  name: resolvedAgenticProjectConfigSchema.shape.name,
  version: resolvedAgenticProjectConfigSchema.shape.version,
  description: resolvedAgenticProjectConfigSchema.shape.description,
  readme: resolvedAgenticProjectConfigSchema.shape.readme,
  iconUrl: resolvedAgenticProjectConfigSchema.shape.iconUrl,
  sourceUrl: resolvedAgenticProjectConfigSchema.shape.sourceUrl,
  homepageUrl: resolvedAgenticProjectConfigSchema.shape.homepageUrl,
  origin: resolvedAgenticProjectConfigSchema.shape.origin,
  pricingPlans: resolvedAgenticProjectConfigSchema.shape.pricingPlans,
  pricingIntervals: resolvedAgenticProjectConfigSchema.shape.pricingIntervals,
  tools: resolvedAgenticProjectConfigSchema.shape.tools,
  toolConfigs: resolvedAgenticProjectConfigSchema.shape.toolConfigs,
  defaultRateLimit: resolvedAgenticProjectConfigSchema.shape.defaultRateLimit
})
  .omit({
    origin: true
  })
  .extend({
    // user: z
    //   .lazy(() => userSelectSchema)
    //   .optional()
    //   .openapi('User', { type: 'object' }),
    // team: z
    //   .lazy(() => teamSelectSchema)
    //   .optional()
    //   .openapi('Team', { type: 'object' }),
    // project: z
    //   .lazy(() => projectSelectSchema)
    //   .optional()
    //   .openapi('Project', { type: 'object' })

    // TODO: Improve the self-referential typing here that `@hono/zod-openapi`
    // trips up on.
    project: z
      .any()
      .refine(
        (project): boolean =>
          !project || projectSelectSchema.safeParse(project).success,
        {
          message: 'Invalid lastDeployment'
        }
      )
      .transform((project): any => {
        if (!project) return undefined
        return projectSelectSchema.parse(project)
      })
      .optional()
    // .openapi('Project', { type: 'object' })

    // TODO: Circular references make this schema less than ideal
    // project: z.object({}).optional().openapi('Project', { type: 'object' })
  })

// These are all derived virtual URLs that are not stored in the database
export const derivedDeploymentFields = {
  /**
   * The public base HTTP URL for the deployment supporting HTTP POST requests
   * for individual tools at `/tool-name` subpaths.
   *
   * @example https://gateway.agentic.so/@agentic/search@latest
   */
  gatewayBaseUrl: z
    .string()
    .url()
    .describe(
      'The public base HTTP URL for the deployment supporting HTTP POST requests for individual tools at `/tool-name` subpaths.'
    ),

  /**
   * The public MCP URL for the deployment supporting the Streamable HTTP
   * transport.
   *
   * @example https://gateway.agentic.so/@agentic/search@latest/mcp
   */
  gatewayMcpUrl: z
    .string()
    .url()
    .describe(
      'The public MCP URL for the deployment supporting the Streamable HTTP transport.'
    ),

  /**
   * The public marketplace URL for the deployment's project.
   *
   * Note that only published deployments are visible on the marketplace.
   *
   * @example https://agentic.so/marketplace/projects/@agentic/search
   */
  marketplaceUrl: z
    .string()
    .url()
    .describe("The public marketplace URL for the deployment's project."),

  /**
   * A private admin URL for managing the deployment. This URL is only accessible
   * by project owners.
   *
   * @example https://agentic.so/app/projects/@agentic/search/deployments/123
   */
  adminUrl: z
    .string()
    .url()
    .describe(
      'A private admin URL for managing the deployment. This URL is only accessible by project owners.'
    )
} as const

export const deploymentSelectSchema = deploymentSelectBaseSchema
  .transform((deployment) => {
    const { projectIdentifier, deploymentIdentifier } =
      parseDeploymentIdentifier(deployment.identifier)

    return {
      ...deployment,
      gatewayBaseUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${deploymentIdentifier}`,
      gatewayMcpUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${deploymentIdentifier}/mcp`,
      marketplaceUrl: `${env.AGENTIC_WEB_BASE_URL}/marketplace/projects/${projectIdentifier}`,
      adminUrl: `${env.AGENTIC_WEB_BASE_URL}/app/projects/${projectIdentifier}/deployments/${deployment.hash}`
    }
  })
  .pipe(deploymentSelectBaseSchema.extend(derivedDeploymentFields).strip())
  .describe(
    `A Deployment is a single, immutable instance of a Project. Each deployment contains pricing plans, origin server config (OpenAPI or MCP server), tool definitions, and metadata.

Deployments are private to a developer or team until they are published, at which point they are accessible to any customers with access to the parent Project.`
  )
  .openapi('Deployment')

export const deploymentAdminSelectSchema = deploymentSelectBaseSchema
  .extend({
    origin: resolvedAgenticProjectConfigSchema.shape.origin,
    _secret: z.string().nonempty()
  })
  .transform((deployment) => {
    const { projectIdentifier, deploymentIdentifier } =
      parseDeploymentIdentifier(deployment.identifier)

    return {
      ...deployment,
      gatewayBaseUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${deploymentIdentifier}`,
      gatewayMcpUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${deploymentIdentifier}/mcp`,
      marketplaceUrl: `${env.AGENTIC_WEB_BASE_URL}/marketplace/projects/${projectIdentifier}`,
      adminUrl: `${env.AGENTIC_WEB_BASE_URL}/app/projects/${projectIdentifier}/deployments/${deployment.hash}`
    }
  })
  .openapi('AdminDeployment')

export const deploymentInsertSchema = agenticProjectConfigSchema.strict()

// TODO: Deployments should be immutable, so we should not allow updates aside
// from publishing. But editing a project's description should be possible from
// the admin UI, so maybe we allow only updates to some properties? Or we
// denormalize these fields in `project`?
export const deploymentUpdateSchema = createUpdateSchema(deployments)
  .pick({
    deletedAt: true,
    description: true
  })
  .strict()

export const deploymentPublishSchema = createUpdateSchema(deployments, {
  version: z.string().nonempty()
})
  .pick({
    version: true
  })
  .strict()


================================================
FILE: apps/api/src/db/schema/index.ts
================================================
export * from './account'
export * from './auth-data'
export * from './common'
export * from './consumer'
export * from './deployment'
export * from './log-entry'
export * from './project'
export * from './team'
export * from './team-member'
export * from './user'


================================================
FILE: apps/api/src/db/schema/log-entry.ts
================================================
import { relations } from '@fisch0920/drizzle-orm'
import {
  index,
  jsonb,
  pgTable,
  text,
  varchar
} from '@fisch0920/drizzle-orm/pg-core'

import {
  consumerIdSchema,
  deploymentIdSchema,
  projectIdSchema,
  userIdSchema
} from '../schemas'
import {
  consumerId,
  createSelectSchema,
  deploymentId,
  logEntryLevelEnum,
  logEntryPrimaryId,
  logEntryTypeEnum,
  projectId,
  timestamps,
  userId
} from './common'
import { consumers } from './consumer'
import { deployments } from './deployment'
import { projects } from './project'
import { users } from './user'

/**
 * A `LogEntry` is an internal audit log entry.
 */
export const logEntries = pgTable(
  'log_entries',
  {
    ...logEntryPrimaryId,
    ...timestamps,

    // core data (required)
    type: logEntryTypeEnum().notNull().default('log'),
    level: logEntryLevelEnum().notNull().default('info'),
    message: text().notNull(),

    // context info (required)
    environment: text(),
    service: text(),
    requestId: varchar({ length: 512 }),
    traceId: varchar({ length: 512 }),

    // relations (optional)
    userId: userId(),
    projectId: projectId(),
    deploymentId: deploymentId(),
    consumerId: consumerId(),

    // misc metadata (optional)
    metadata: jsonb().$type<Record<string, unknown>>().default({}).notNull()
  },
  (table) => [
    index('log_entry_type_idx').on(table.type),
    // TODO: Don't add these extra indices until we need them. They'll become
    // very large very fast.
    // index('log_entry_level_idx').on(table.level),
    // index('log_entry_environment_idx').on(table.environment),
    // index('log_entry_service_idx').on(table.service),
    // index('log_entry_requestId_idx').on(table.requestId),
    // index('log_entry_traceId_idx').on(table.traceId),
    index('log_entry_userId_idx').on(table.userId),
    index('log_entry_projectId_idx').on(table.projectId),
    index('log_entry_deploymentId_idx').on(table.deploymentId),
    // index('log_entry_consumerId_idx').on(table.consumerId),
    index('log_entry_createdAt_idx').on(table.createdAt),
    index('log_entry_updatedAt_idx').on(table.updatedAt),
    index('log_entry_deletedAt_idx').on(table.deletedAt)
  ]
)

export const logEntriesRelations = relations(logEntries, ({ one }) => ({
  user: one(users, {
    fields: [logEntries.userId],
    references: [users.id]
  }),
  project: one(projects, {
    fields: [logEntries.projectId],
    references: [projects.id]
  }),
  deployment: one(deployments, {
    fields: [logEntries.deploymentId],
    references: [deployments.id]
  }),
  consumer: one(consumers, {
    fields: [logEntries.consumerId],
    references: [consumers.id]
  })
}))

export const logEntrySelectSchema = createSelectSchema(logEntries, {
  userId: userIdSchema.optional(),
  projectId: projectIdSchema.optional(),
  deploymentId: deploymentIdSchema.optional(),
  consumerId: consumerIdSchema.optional()
})
  // .extend({
  //   user: z
  //     .lazy(() => userSelectSchema)
  //     .optional()
  //     .openapi('User', { type: 'object' }),

  //   project: z
  //     .lazy(() => projectSelectSchema)
  //     .optional()
  //     .openapi('Project', { type: 'object' }),

  //   deployment: z
  //     .lazy(() => deploymentSelectSchema)
  //     .optional()
  //     .openapi('Deployment', { type: 'object' }),

  //   consumer: z
  //     .lazy(() => consumerSelectSchema)
  //     .optional()
  //     .openapi('Consumer', { type: 'object' })
  // })
  .strip()
  .openapi('LogEntry')


================================================
FILE: apps/api/src/db/schema/project.ts
================================================
import {
  agenticProjectConfigSchema,
  pricingIntervalSchema,
  type StripeMeterIdMap,
  stripeMeterIdMapSchema,
  type StripePriceIdMap,
  stripePriceIdMapSchema,
  type StripeProductIdMap,
  stripeProductIdMapSchema
} from '@agentic/platform-types'
import { relations } from '@fisch0920/drizzle-orm'
import {
  boolean,
  index,
  integer,
  jsonb,
  pgTable,
  text,
  uniqueIndex
} from '@fisch0920/drizzle-orm/pg-core'
import { z } from '@hono/zod-openapi'

import { env } from '@/lib/env'

import {
  deploymentIdSchema,
  projectIdentifierSchema,
  projectIdSchema,
  teamIdSchema,
  userIdSchema
} from '../schemas'
import {
  createInsertSchema,
  createSelectSchema,
  createUpdateSchema,
  deploymentId,
  pricingCurrencyEnum,
  pricingIntervalEnum,
  projectIdentifier,
  projectName,
  projectNamespace,
  projectPrimaryId,
  projectSlug,
  stripeId,
  teamId,
  timestamps,
  userId
} from './common'
import { deployments, deploymentSelectSchema } from './deployment'
import { teams, teamSelectSchema } from './team'
import { users, userSelectSchema } from './user'

/**
 * A Project represents a single Agentic API product. Is is comprised of a
 * series of immutable Deployments, each of which contains pricing data, origin
 * API config, OpenAPI or MCP specs, tool definitions, and various metadata.
 *
 * You can think of Agentic Projects as similar to Vercel projects. They both
 * hold some common configuration and are comprised of a series of immutable
 * Deployments.
 *
 * Internally, Projects manage all of the Stripe billing resources across
 * Deployments (Stripe Products, Prices, and Meters for usage-based billing).
 */
export const projects = pgTable(
  'projects',
  {
    ...projectPrimaryId,
    ...timestamps,

    // display name
    name: projectName().notNull(),

    // identifier is `@namespace/slug`
    identifier: projectIdentifier().unique().notNull(),

    // namespace is either a username or team slug
    namespace: projectNamespace().notNull(),

    // slug is a unique identifier for the project within its namespace
    slug: projectSlug().notNull(),

    // Defaulting to `true` for now to hide all projects from the marketplace
    // by default. Will need to manually set to `true` to allow projects to be
    // visible on the marketplace.
    private: boolean().default(true).notNull(),

    // Admin-controlled tags for organizing and featuring on the marketplace
    tags: text().array(),

    // TODO: allow for multiple aliases like vercel
    // alias: text(),

    userId: userId()
      .notNull()
      .references(() => users.id),
    teamId: teamId(),

    // Most recently published Deployment if one exists
    lastPublishedDeploymentId: deploymentId(),

    // Most recent Deployment if one exists
    lastDeploymentId: deploymentId(),

    // Semver version of the most recently published Deployment (if one exists)
    // (denormalized for convenience)
    lastPublishedDeploymentVersion: text(),

    applicationFeePercent: integer().default(20).notNull(),

    // TODO: This is going to need to vary from dev to prod
    //isStripeConnectEnabled: boolean().default(false).notNull(),

    // Default pricing interval for subscriptions to this project
    // Note: This is essentially hard-coded and not configurable by users for now.
    defaultPricingInterval: pricingIntervalEnum().default('month').notNull(),

    // Pricing currency used across all prices and subscriptions to this project
    pricingCurrency: pricingCurrencyEnum().default('usd').notNull(),

    // All deployments share the same underlying proxy secret, which allows
    // origin servers to verify that requests are coming from Agentic's API
    // gateway.
    _secret: text().notNull(),

    // Auth token used to access the platform API on behalf of this project
    // _providerToken: text().notNull(),

    // TODO: Full-text search
    // _text: text().default('').notNull(),

    // Stripe coupons associated with this project, mapping from unique coupon
    // object hash to stripe coupon id.
    // `[hash: string]: string`
    // _stripeCouponsMap: jsonb()
    //   .$type<Record<string, string>>()
    //   .default({})
    //   .notNull(),

    // Stripe billing Products associated with this project across deployments,
    // mapping from PricingPlanLineItem **slug** to Stripe Product id.
    // NOTE: This map uses slugs as keys, unlike `_stripePriceIdMap`, because
    // Stripe Products are agnostic to the PricingPlanLineItem config. This is
    // important for them to be shared across deployments even if the pricing
    // details change.
    _stripeProductIdMap: jsonb()
      .$type<StripeProductIdMap>()
      .default({})
      .notNull(),

    // Stripe billing Prices associated with this project, mapping from unique
    // PricingPlanLineItem **hash** to Stripe Price id.
    // NOTE: This map uses hashes as keys, because Stripe Prices are dependent
    // on the PricingPlanLineItem config. This is important for them to be shared
    // across deployments even if the pricing details change.
    _stripePriceIdMap: jsonb().$type<StripePriceIdMap>().default({}).notNull(),

    // Stripe billing LineItems associated with this project, mapping from unique
    // PricingPlanLineItem **slug** to Stripe Meter id.
    // NOTE: This map uses slugs as keys, unlike `_stripePriceIdMap`, because
    // Stripe Products are agnostic to the PricingPlanLineItem config. This is
    // important for them to be shared across deployments even if the pricing
    // details change.
    _stripeMeterIdMap: jsonb().$type<StripeMeterIdMap>().default({}).notNull(),

    // Connected Stripe account (standard or express).
    // If not defined, then subscriptions for this project route through our
    // main Stripe account.
    _stripeAccountId: stripeId()
  },
  (table) => [
    uniqueIndex('project_identifier_idx').on(table.identifier),
    index('project_namespace_idx').on(table.namespace),
    index('project_userId_idx').on(table.userId),
    index('project_teamId_idx').on(table.teamId),
    // index('project_alias_idx').on(table.alias),
    index('project_private_idx').on(table.private),
    index('project_tags_idx').on(table.tags),
    index('project_lastPublishedDeploymentId_idx').on(
      table.lastPublishedDeploymentId
    ),
    index('project_createdAt_idx').on(table.createdAt),
    index('project_updatedAt_idx').on(table.updatedAt),
    index('project_deletedAt_idx').on(table.deletedAt)
  ]
)

export const projectsRelations = relations(projects, ({ one }) => ({
  user: one(users, {
    fields: [projects.userId],
    references: [users.id]
  }),
  team: one(teams, {
    fields: [projects.teamId],
    references: [teams.id]
  }),
  lastPublishedDeployment: one(deployments, {
    fields: [projects.lastPublishedDeploymentId],
    references: [deployments.id],
    relationName: 'lastPublishedDeployment'
  }),
  lastDeployment: one(deployments, {
    fields: [projects.lastDeploymentId],
    references: [deployments.id],
    relationName: 'lastDeployment'
  })
  // deployments: many(deployments, {
  //   relationName: 'deployments'
  // }),
  // publishedDeployments: many(deployments, {
  //   relationName: 'publishedDeployments'
  // })
}))

export const projectSelectBaseSchema = createSelectSchema(projects, {
  id: projectIdSchema,
  userId: userIdSchema,
  teamId: teamIdSchema.optional(),
  identifier: projectIdentifierSchema,
  name: agenticProjectConfigSchema.shape.name,
  slug: agenticProjectConfigSchema.shape.slug,
  tags: z.array(z.string()).optional(),
  lastPublishedDeploymentId: deploymentIdSchema.optional(),
  lastDeploymentId: deploymentIdSchema.optional(),

  applicationFeePercent: (schema) => schema.nonnegative(),

  defaultPricingInterval: pricingIntervalSchema,

  _stripeProductIdMap: stripeProductIdMapSchema,
  _stripePriceIdMap: stripePriceIdMapSchema,
  _stripeMeterIdMap: stripeMeterIdMapSchema
})
  .omit({
    applicationFeePercent: true,
    _secret: true,
    // _text: true,
    _stripeProductIdMap: true,
    _stripePriceIdMap: true,
    _stripeMeterIdMap: true,
    _stripeAccountId: true
  })
  .extend({
    user: z
      .lazy(() => userSelectSchema)
      .optional()
      .openapi('User', { type: 'object' }),

    team: z
      .lazy(() => teamSelectSchema)
      .optional()
      .openapi('Team', { type: 'object' }),

    // TODO: Improve the self-referential typing here that `@hono/zod-openapi`
    // trips up on.
    lastPublishedDeployment: z
      .any()
      .refine(
        (deployment): boolean =>
          !deployment || deploymentSelectSchema.safeParse(deployment).success,
        {
          message: 'Invalid lastPublishedDeployment'
        }
      )
      .transform((deployment): any => {
        if (!deployment) return undefined

        return deploymentSelectSchema.parse(deployment)
      })
      .optional(),

    lastDeployment: z
      .any()
      .refine(
        (deployment): boolean =>
          !deployment || deploymentSelectSchema.safeParse(deployment).success,
        {
          message: 'Invalid lastDeployment'
        }
      )
      .transform((deployment): any => {
        if (!deployment) return undefined
        return deploymentSelectSchema.parse(deployment)
      })
      .optional(),

    deployment: z
      .any()
      .refine(
        (deployment): boolean =>
          !deployment || deploymentSelectSchema.safeParse(deployment).success,
        {
          message: 'Invalid lastDeployment'
        }
      )
      .transform((deployment): any => {
        if (!deployment) return undefined
        return deploymentSelectSchema.parse(deployment)
      })
      .optional()
  })

// These are all derived virtual URLs that are not stored in the database
export const derivedProjectFields = {
  /**
   * The public base HTTP URL for the project supporting HTTP POST requests for
   * individual tools at `/tool-name` subpaths.
   *
   * @example https://gateway.agentic.so/@agentic/search
   */
  gatewayBaseUrl: z
    .string()
    .url()
    .describe(
      'The public base HTTP URL for the project supporting HTTP POST requests for individual tools at `/tool-name` subpaths.'
    ),

  /**
   * The public MCP URL for the project supporting the Streamable HTTP transport.
   *
   * @example https://gateway.agentic.so/@agentic/search/mcp
   */
  gatewayMcpUrl: z
    .string()
    .url()
    .describe(
      'The public MCP URL for the project supporting the Streamable HTTP transport.'
    ),

  /**
   * The public marketplace URL for the project.
   *
   * @example https://agentic.so/marketplace/projects/@agentic/search
   */
  marketplaceUrl: z
    .string()
    .url()
    .describe('The public marketplace URL for the project.'),

  /**
   * A private admin URL for managing the project. This URL is only accessible
   * by project owners.
   *
   * @example https://agentic.so/app/projects/@agentic/search
   */
  adminUrl: z
    .string()
    .url()
    .describe(
      'A private admin URL for managing the project. This URL is only accessible by project owners.'
    )
} as const

export const projectSelectSchema = projectSelectBaseSchema
  .transform((project) => ({
    ...project,
    gatewayBaseUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${project.identifier}`,
    gatewayMcpUrl: `${env.AGENTIC_GATEWAY_BASE_URL}/${project.identifier}/mcp`,
    marketplaceUrl: `${env.AGENTIC_WEB_BASE_URL}/marketplace/projects/${project.identifier}`,
    adminUrl: `${env.AGENTIC_WEB_BASE_URL}/app/projects/${project.identifier}`
  }))
  .pipe(projectSelectBaseSchema.extend(derivedProjectFields).strip())
  .describe(
    `A Project represents a single Agentic API product. It is comprised of a series of immutable Deployments, each of which contains pricing data, origin API config, OpenAPI or MCP specs, tool definitions, and various metadata.

You can think of Agentic Projects as similar to Vercel projects. They both hold some common configuration and are comprised of a series of immutable Deployments.

Internally, Projects manage all of the Stripe billing resources across Deployments (Stripe Products, Prices, and Meters for usage-based billing).`
  )
  .openapi('Project')

export const projectInsertSchema = createInsertSchema(projects, {
  identifier: projectIdentifierSchema,

  name: agenticProjectConfigSchema.shape.name,
  slug: agenticProjectConfigSchema.shape.slug
})
  .pick({
    name: true,
    slug: true
  })
  .strict()

export const projectUpdateSchema = createUpdateSchema(projects)
  .pick({
    name: true
    // alias: true
  })
  .strict()

// TODO: virtual saasUrl
// TODO: virtual aliasUrl


================================================
FILE: apps/api/src/db/schema/team-member.ts
================================================
import { relations } from '@fisch0920/drizzle-orm'
import {
  boolean,
  index,
  pgTable,
  primaryKey
} from '@fisch0920/drizzle-orm/pg-core'

import { userIdSchema } from '../schemas'
import {
  createInsertSchema,
  createSelectSchema,
  createUpdateSchema,
  teamId,
  teamMemberRoleEnum,
  teamSlug,
  timestamp,
  timestamps,
  userId
} from './common'
import { teams } from './team'
import { users } from './user'

export const teamMembers = pgTable(
  'team_members',
  {
    ...timestamps,

    userId: userId()
      .notNull()
      .references(() => users.id, { onDelete: 'cascade' }),
    teamSlug: teamSlug()
      .notNull()
      .references(() => teams.slug, { onDelete: 'cascade' }),
    teamId: teamId()
      .notNull()
      .references(() => teams.id, { onDelete: 'cascade' }),
    role: teamMemberRoleEnum().default('user').notNull(),

    confirmed: boolean().default(false).notNull(),
    confirmedAt: timestamp()
  },
  (table) => [
    primaryKey({ columns: [table.userId, table.teamId] }),
    index('team_member_user_idx').on(table.userId),
    index('team_member_team_idx').on(table.teamId),
    index('team_member_slug_idx').on(table.teamSlug),
    index('team_member_createdAt_idx').on(table.createdAt),
    index('team_member_updatedAt_idx').on(table.updatedAt),
    index('team_member_deletedAt_idx').on(table.deletedAt)
  ]
)

export const teamMembersRelations = relations(teamMembers, ({ one }) => ({
  user: one(users, {
    fields: [teamMembers.userId],
    references: [users.id]
  }),
  team: one(teams, {
    fields: [teamMembers.teamId],
    references: [teams.id]
  })
}))

export const teamMemberSelectSchema = createSelectSchema(teamMembers)
  // .extend({
  //   user: z
  //     .lazy(() => userSelectSchema)
  //     .optional()
  //     .openapi('User', { type: 'object' }),

  //   team: z
  //     .lazy(() => teamSelectSchema)
  //     .optional()
  //     .openapi('Team', { type: 'object' })
  // })
  .strip()
  .openapi('TeamMember')

export const teamMemberInsertSchema = createInsertSchema(teamMembers, {
  userId: userIdSchema
})
  .pick({
    userId: true,
    role: true
  })
  .strict()

export const teamMemberUpdateSchema = createUpdateSchema(teamMembers)
  .pick({
    role: true
  })
  .strict()


================================================
FILE: apps/api/src/db/schema/team.ts
================================================
import { isValidTeamSlug } from '@agentic/platform-validators'
import { relations } from '@fisch0920/drizzle-orm'
import {
  index,
  pgTable,
  text,
  uniqueIndex
} from '@fisch0920/drizzle-orm/pg-core'

import { userIdSchema } from '../schemas'
import {
  createInsertSchema,
  createSelectSchema,
  createUpdateSchema,
  teamPrimaryId,
  teamSlug,
  timestamps,
  userId
} from './common'
import { teamMembers } from './team-member'
import { users } from './user'

export const teams = pgTable(
  'teams',
  {
    ...teamPrimaryId,
    ...timestamps,

    slug: teamSlug().unique().notNull(),
    name: text().notNull(),

    ownerId: userId().notNull()
  },
  (table) => [
    uniqueIndex('team_slug_idx').on(table.slug),
    index('team_createdAt_idx').on(table.createdAt),
    index('team_updatedAt_idx').on(table.updatedAt),
    index('team_deletedAt_idx').on(table.deletedAt)
  ]
)

export const teamsRelations = relations(teams, ({ one, many }) => ({
  owner: one(users, {
    fields: [teams.ownerId],
    references: [users.id]
  }),
  members: many(teamMembers)
}))

export const teamSelectSchema = createSelectSchema(teams)
  // .extend({
  //   owner: z
  //     .lazy(() => userSelectSchema)
  //     .optional()
  //     .openapi('User', { type: 'object' })
  // })
  .strip()
  .openapi('Team')

export const teamInsertSchema = createInsertSchema(teams, {
  slug: (schema) =>
    schema.refine((slug) => isValidTeamSlug(slug), {
      message: 'Invalid team slug'
    })
})
  .omit({ id: true, createdAt: true, updatedAt: true, ownerId: true })
  .strict()

export const teamUpdateSchema = createUpdateSchema(teams, {
  ownerId: userIdSchema
})
  .pick({
    name: true,
    ownerId: true
  })
  .strict()


================================================
FILE: apps/api/src/db/schema/user.ts
================================================
import { relations } from '@fisch0920/drizzle-orm'
import {
  boolean,
  index,
  pgTable,
  text,
  uniqueIndex
} from '@fisch0920/drizzle-orm/pg-core'

import { accounts } from './account'
import {
  createSelectSchema,
  createUpdateSchema,
  stripeId,
  timestamps,
  username,
  // username,
  userPrimaryId,
  userRoleEnum
} from './common'

export const users = pgTable(
  'users',
  {
    ...userPrimaryId,
    ...timestamps,

    username: username().unique().notNull(),
    role: userRoleEnum().default('user').notNull(),

    email: text().notNull().unique(),
    isEmailVerified: boolean().default(false).notNull(),

    name: text(),
    bio: text(),
    image: text(),

    //isStripeConnectEnabledByDefault: boolean().default(true).notNull(),

    stripeCustomerId: stripeId()
  },
  (table) => [
    uniqueIndex('user_email_idx').on(table.email),
    uniqueIndex('user_username_idx').on(table.username),
    index('user_createdAt_idx').on(table.createdAt),
    index('user_updatedAt_idx').on(table.updatedAt)
    // index('user_deletedAt_idx').on(table.deletedAt)
  ]
)

export const usersRelations = relations(users, ({ many }) => ({
  accounts: many(accounts)
}))

export const userSelectSchema = createSelectSchema(users)
  .strip()
  .openapi('User')

export const userUpdateSchema = createUpdateSchema(users)
  .pick({
    name: true,
    bio: true,
    image: true
    //isStripeConnectEnabledByDefault: true
  })
  .strict()


================================================
FILE: apps/api/src/db/schemas.ts
================================================
import { assert } from '@agentic/platform-core'
import {
  isNamespaceAllowed,
  isValidCuid,
  isValidDeploymentIdentifier,
  isValidProjectIdentifier,
  isValidTeamSlug,
  isValidUsername
} from '@agentic/platform-validators'
import { z } from '@hono/zod-openapi'

import type { consumersRelations } from './schema/consumer'
import type { deploymentsRelations } from './schema/deployment'
import type { projectsRelations } from './schema/project'
import { idPrefixMap, type ModelType } from './schema/common'

export function getIdSchemaForModelType(modelType: ModelType) {
  const idPrefix = idPrefixMap[modelType]
  assert(idPrefix, 500, `Invalid model type: ${modelType}`)

  // Convert model type to PascalCase
  const modelDisplayName =
    modelType.charAt(0).toUpperCase() + modelType.slice(1)
  const example = `${idPrefix}_tz4a98xxat96iws9zmbrgj3a`

  return z
    .string()
    .refine(
      (id) => {
        const parts = id.split('_')
        if (parts.length !== 2) return false
        if (parts[0] !== idPrefix) return false
        if (!isValidCuid(parts[1])) return false

        return true
      },
      {
        message: `Invalid ${modelDisplayName} id`
      }
    )
    .describe(`${modelDisplayName} id (e.g. "${example}")`)
  // TODO: is this necessary?
  // .openapi(`${modelDisplayName}Id`, { example })
}

export const userIdSchema = getIdSchemaForModelType('user')
export const teamIdSchema = getIdSchemaForModelType('team')
export const consumerIdSchema = getIdSchemaForModelType('consumer')
export const projectIdSchema = getIdSchemaForModelType('project')
export const deploymentIdSchema = getIdSchemaForModelType('deployment')
export const logEntryIdSchema = getIdSchemaForModelType('logEntry')

export const projectIdentifierSchema = z
  .string()
  .refine(
    (id) =>
      isValidProjectIdentifier(id, { strict: false }) ||
      projectIdSchema.safeParse(id).success,
    {
      message: 'Invalid project identifier'
    }
  )
  .describe('Public project identifier (e.g. "@namespace/project-slug")')
  .openapi('ProjectIdentifier')

export const deploymentIdentifierSchema = z
  .string()
  .refine(
    (id) =>
      isValidDeploymentIdentifier(id, { strict: false }) ||
      deploymentIdSchema.safeParse(id).success,
    {
      message: 'Invalid deployment identifier'
    }
  )
  .describe(
    'Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}")'
  )
  .openapi('DeploymentIdentifier')

export const usernameSchema = z
  .string()
  .refine((username) => isValidUsername(username), {
    message: 'Invalid username'
  })
  .refine((username) => isNamespaceAllowed(username), {
    message:
      'Username is not allowed (reserved, offensive, or otherwise confusing)'
  })

export const teamSlugSchema = z
  .string()
  .refine((slug) => isValidTeamSlug(slug), {
    message: 'Invalid team slug'
  })
  .refine((slug) => isNamespaceAllowed(slug), {
    message:
      'Team slug is not allowed (reserved, offensive, or otherwise confusing)'
  })

export const paginationSchema = z.object({
  offset: z.coerce.number().int().nonnegative().default(0).optional(),
  limit: z.coerce.number().int().positive().max(100).default(10).optional(),
  sort: z.enum(['asc', 'desc']).default('desc').optional(),
  sortBy: z.enum(['createdAt', 'updatedAt']).default('createdAt').optional()
})

export type ProjectRelationFields = keyof ReturnType<
  (typeof projectsRelations)['config']
>
export const projectRelationsSchema: z.ZodType<ProjectRelationFields> = z.enum([
  'user',
  'team',
  'lastPublishedDeployment',
  'lastDeployment'
])

export type DeploymentRelationFields = keyof ReturnType<
  (typeof deploymentsRelations)['config']
>
export const deploymentRelationsSchema: z.ZodType<DeploymentRelationFields> =
  z.enum(['user', 'team', 'project'])

export type ConsumerRelationFields = keyof ReturnType<
  (typeof consumersRelations)['config']
>
export const consumerRelationsSchema: z.ZodType<ConsumerRelationFields> =
  z.enum(['user', 'project', 'deployment'])


================================================
FILE: apps/api/src/db/types.test.ts
================================================
import type { Simplify } from 'type-fest'
import { expectTypeOf, test } from 'vitest'

import type {
  Consumer,
  LogEntry,
  RawConsumer,
  RawConsumerUpdate,
  RawDeployment,
  RawLogEntry,
  RawProject,
  RawUser,
  User
} from './types'

type UserKeys = Exclude<keyof User & keyof RawUser, 'authProviders'>
type LogEntryKeys = keyof RawLogEntry & keyof LogEntry
type ConsumerKeys = keyof RawConsumer & keyof Consumer

type TODOFixedConsumer = Simplify<
  Omit<
    Consumer,
    | 'user'
    | 'project'
    | 'deployment'
    | 'gatewayBaseUrl'
    | 'gatewayMcpUrl'
    | 'marketplaceUrl'
    | 'adminUrl'
  > & {
    user?: RawUser | null
    project?: RawProject | null
    deployment?: RawDeployment | null
  }
>

test('User types are compatible', () => {
  expectTypeOf<RawUser>().toExtend<User>()

  expectTypeOf<User[UserKeys]>().toEqualTypeOf<RawUser[UserKeys]>()
})

test('LogEntry types are compatible', () => {
  expectTypeOf<RawLogEntry>().toExtend<LogEntry>()

  expectTypeOf<LogEntry[LogEntryKeys]>().toEqualTypeOf<
    RawLogEntry[LogEntryKeys]
  >()
})

test('Consumer types are compatible', () => {
  expectTypeOf<RawConsumer>().toExtend<TODOFixedConsumer>()

  expectTypeOf<TODOFixedConsumer[ConsumerKeys]>().toEqualTypeOf<
    RawConsumer[ConsumerKeys]
  >()

  // Ensure that we can pass any Consumer as a RawConsumerUpdate
  expectTypeOf<Consumer>().toExtend<RawConsumerUpdate>()

  // Ensure that we can pass any RawConsumer as a RawConsumerUpdate
  expectTypeOf<RawConsumer>().toExtend<RawConsumerUpdate>()
})


================================================
FILE: apps/api/src/db/types.ts
================================================
import type {
  BuildQueryResult,
  ExtractTablesWithRelations,
  InferInsertModel,
  InferSelectModel
} from '@fisch0920/drizzle-orm'
import type { z } from '@hono/zod-openapi'
import type { Simplify } from 'type-fest'

import type * as schema from './schema'

export type Tables = ExtractTablesWithRelations<typeof schema>

export type User = z.infer<typeof schema.userSelectSchema>
export type RawUser = InferSelectModel<typeof schema.users>

export type Team = z.infer<typeof schema.teamSelectSchema>
export type TeamWithMembers = BuildQueryResult<
  Tables,
  Tables['teams'],
  { with: { members: true } }
>
export type RawTeam = InferSelectModel<typeof schema.teams>

export type TeamMember = z.infer<typeof schema.teamMemberSelectSchema>
export type TeamMemberWithTeam = BuildQueryResult<
  Tables,
  Tables['teamMembers'],
  { with: { team: true } }
>
export type RawTeamMember = InferSelectModel<typeof schema.teamMembers>

export type Project = z.infer<typeof schema.projectSelectSchema>
export type ProjectWithLastPublishedDeployment = BuildQueryResult<
  Tables,
  Tables['projects'],
  { with: { lastPublishedDeployment: true } }
>
export type RawProject = Simplify<
  InferSelectModel<typeof schema.projects> & {
    lastPublishedDeployment?: RawDeployment | null // TODO: remove null (requires drizzle-orm changes)
    lastDeployment?: RawDeployment | null // TODO: remove null (requires drizzle-orm changes)
  }
>

export type Deployment = z.infer<typeof schema.deploymentSelectSchema>
export type DeploymentWithProject = BuildQueryResult<
  Tables,
  Tables['deployments'],
  { with: { project: true } }
>
export type RawDeployment = Simplify<
  InferSelectModel<typeof schema.deployments> & {
    project?: RawProject | null // TODO: remove null (requires drizzle-orm changes)
  }
>

export type Consumer = z.infer<typeof schema.consumerSelectSchema>
export type ConsumerWithProjectAndDeployment = BuildQueryResult<
  Tables,
  Tables['consumers'],
  { with: { project: true; deployment: true } }
>
export type RawConsumer = Simplify<
  InferSelectModel<typeof schema.consumers> & {
    user?: RawUser | undefined | null // TODO: remove null (requires drizzle-orm changes)
    project?: RawProject | undefined | null // TODO: remove null (requires drizzle-orm changes)
    deployment?: RawDeployment | undefined | null // TODO: remove null (requires drizzle-orm changes)
  }
>
export type RawConsumerUpdate = Partial<
  Omit<
    InferInsertModel<typeof schema.consumers>,
    'id' | 'projectId' | 'userId' | 'deploymentId'
  >
>

export type LogEntry = z.infer<typeof schema.logEntrySelectSchema>
export type RawLogEntry = InferSelectModel<typeof schema.logEntries>

export type Account = z.infer<typeof schema.accountSelectSchema>
export type RawAccount = InferSelectModel<typeof schema.accounts>


================================================
FILE: apps/api/src/db/utils.ts
================================================
import type { PricingPlan, PricingPlanLineItem } from '@agentic/platform-types'
import { hashObject } from '@agentic/platform-core'

import type { RawProject } from './types'

/**
 * Gets the hash used to uniquely map a PricingPlanLineItem to its
 * corresponding Stripe Price in a stable way across deployments within a
 * project.
 *
 * This hash is used as the key for the `Project._stripePriceIdMap`.
 */
export async function getPricingPlanLineItemHashForStripePrice({
  pricingPlan,
  pricingPlanLineItem,
  project
}: {
  pricingPlan: PricingPlan
  pricingPlanLineItem: PricingPlanLineItem
  project: RawProject
}): Promise<string> {
  // TODO: use pricingPlan.slug as well here?
  // TODO: not sure if this is needed or not...
  // With pricing plan slug:
  //   - 'price:free:base:<hash>'
  //   - 'price:basic-monthly:base:<hash>'
  //   - 'price:basic-monthly:requests:<hash>'
  // Without pricing plan slug:
  //   - 'price:base:<hash>'
  //   - 'price:base:<hash>'
  //   - 'price:requests:<hash>'

  const hash = await hashObject({
    ...pricingPlanLineItem,
    projectId: project.id,
    stripeAccountId: project._stripeAccountId,
    currency: project.pricingCurrency
  })

  return `price:${pricingPlan.slug}:${pricingPlanLineItem.slug}:${hash}`
}

export async function getStripePriceIdForPricingPlanLineItem({
  pricingPlan,
  pricingPlanLineItem,
  project
}: {
  pricingPlan: PricingPlan
  pricingPlanLineItem: PricingPlanLineItem
  project: RawProject
}): Promise<string | undefined> {
  const pricingPlanLineItemHash =
    await getPricingPlanLineItemHashForStripePrice({
      pricingPlan,
      pricingPlanLineItem,
      project
    })

  return project._stripePriceIdMap[pricingPlanLineItemHash]
}


================================================
FILE: apps/api/src/lib/__snapshots__/storage.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`Storage > uploadFileUrlToStorage data-uri 1`] = `"https://storage.agentic.so/@dev/test/ef4238fba78887e0974cd48809a66e284cdd78ce92d6b2d485c25a552fb39631.svg"`;

exports[`Storage > uploadFileUrlToStorage data-uri 2 1`] = `"https://storage.agentic.so/@dev/test/efbc1f0409b730d93b01c918be9e024bf7777801cfd252221c39e36c08c1b4fb"`;

exports[`Storage > uploadFileUrlToStorage url 1`] = `"https://storage.agentic.so/@dev/test/6da6ef895be2a42606b99e5e3b9c25687c92c81986a9718e07f32e574d41cf7a.svg"`;


================================================
FILE: apps/api/src/lib/acl-admin.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from './types'
import { ensureAuthUser } from './ensure-auth-user'

export async function aclAdmin(ctx: AuthenticatedHonoContext) {
  const user = await ensureAuthUser(ctx)
  assert(user, 401, 'Authentication required')
  assert(user.role === 'admin', 403, 'Access denied')
}


================================================
FILE: apps/api/src/lib/acl-public-project.ts
================================================
import { assert } from '@agentic/platform-core'

import type { RawProject } from '@/db'

export function aclPublicProject(
  project: RawProject | undefined,
  projectId?: string
): asserts project {
  assert(
    project,
    404,
    `Public project not found${projectId ? ` "${projectId}"` : ''}`
  )

  assert(
    !project.private && project.lastPublishedDeploymentId,
    404,
    `Public project not found "${project.id}"`
  )

  assert(!project.deletedAt, 410, `Project has been deleted "${project.id}"`)
}


================================================
FILE: apps/api/src/lib/acl-team-admin.ts
================================================
import { assert } from '@agentic/platform-core'

import { and, db, eq, schema, type TeamMember } from '@/db'

import type { AuthenticatedHonoContext } from './types'
import { ensureAuthUser } from './ensure-auth-user'

export async function aclTeamAdmin(
  ctx: AuthenticatedHonoContext,
  {
    teamId,
    teamSlug,
    teamMember
  }: {
    teamId?: string
    teamSlug?: string
    teamMember?: TeamMember
  } & (
    | {
        teamId: string
        teamSlug?: never
      }
    | {
        teamId?: never
        teamSlug: string
      }
  )
) {
  const teamLabel = teamId ?? teamSlug
  assert(teamLabel, 500, 'Either teamSlug or teamId must be provided')

  const user = await ensureAuthUser(ctx)

  if (user.role === 'admin') {
    // TODO: Allow admins to access all team resources
    return
  }

  if (!teamMember) {
    teamMember = await db.query.teamMembers.findFirst({
      where: and(
        teamId
          ? eq(schema.teamMembers.teamId, teamId)
          : eq(schema.teamMembers.teamSlug, teamSlug!),
        eq(schema.teamMembers.userId, user.id)
      )
    })
  }

  assert(teamMember, 403, `User does not have access to team "${teamLabel}"`)

  assert(
    teamMember.role === 'admin',
    403,
    `User does not have "admin" role for team "${teamLabel}"`
  )

  assert(
    teamMember.userId === user.id,
    403,
    `User does not have access to team "${teamLabel}"`
  )

  assert(
    teamMember.confirmed,
    403,
    `User has not confirmed their invitation to team "${teamLabel}"`
  )
}


================================================
FILE: apps/api/src/lib/acl-team-member.ts
================================================
import { assert } from '@agentic/platform-core'

import { and, db, eq, type RawTeamMember, schema } from '@/db'

import type { AuthenticatedHonoContext } from './types'
import { ensureAuthUser } from './ensure-auth-user'

export async function aclTeamMember(
  ctx: AuthenticatedHonoContext,
  {
    teamId,
    teamSlug,
    teamMember,
    userId
  }: {
    teamId?: string
    teamSlug?: string
    teamMember?: RawTeamMember
    userId?: string
  } & (
    | { teamSlug: string }
    | { teamId: string }
    | { teamMember: RawTeamMember }
  )
) {
  const teamLabel = teamId ?? teamSlug
  assert(teamLabel, 500, 'Either teamSlug or teamId must be provided')

  const user = await ensureAuthUser(ctx)

  if (user.role === 'admin') {
    // TODO: Allow admins to access all team resources
    return
  }

  userId ??= user.id

  if (!teamMember) {
    teamMember = await db.query.teamMembers.findFirst({
      where: and(
        teamId
          ? eq(schema.teamMembers.teamId, teamId)
          : eq(schema.teamMembers.teamSlug, teamSlug!),
        eq(schema.teamMembers.userId, userId)
      )
    })
  }

  assert(teamMember, 403, `User does not have access to team "${teamLabel}"`)
  if (!ctx.get('teamMember')) {
    ctx.set('teamMember', teamMember)
  }

  assert(
    teamMember.userId === userId,
    403,
    `User does not have access to team "${teamLabel}"`
  )

  assert(
    teamMember.confirmed,
    403,
    `User has not confirmed their invitation to team "${teamLabel}"`
  )
}


================================================
FILE: apps/api/src/lib/acl.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from './types'
import { ensureAuthUser } from './ensure-auth-user'

export async function acl<
  TModel extends Record<string, unknown>,
  TUserField extends keyof TModel = 'userId',
  TTeamField extends keyof TModel = 'teamId'
>(
  ctx: AuthenticatedHonoContext,
  model: TModel,
  {
    label,
    userField = 'userId' as TUserField,
    teamField = 'teamId' as TTeamField
  }: {
    label: string
    userField?: TUserField
    teamField?: TTeamField
  }
) {
  const user = await ensureAuthUser(ctx)
  const teamMember = ctx.get('teamMember')

  const userFieldValue = model[userField]
  const teamFieldValue = model[teamField]

  const isAuthUserOwner = userFieldValue && userFieldValue === user.id
  const isAuthUserAdmin = user.role === 'admin'
  const hasTeamAccess =
    teamMember && teamFieldValue && teamFieldValue === teamMember.teamId

  assert(
    isAuthUserOwner || isAuthUserAdmin || hasTeamAccess,
    403,
    `User does not have access to ${label} "${model.id ?? userFieldValue}"`
  )
}


================================================
FILE: apps/api/src/lib/auth/auth-storage.ts
================================================
export interface AuthStorageAdapter {
  get(key: string[]): Promise<Record<string, any> | undefined>
  remove(key: string[]): Promise<void>
  set(key: string[], value: any, expiry?: Date): Promise<void>
  scan(prefix: string[]): AsyncIterable<[string[], any]>
}

const SEPERATOR = String.fromCodePoint(0x1f)

export function joinKey(key: string[]) {
  return key.join(SEPERATOR)
}

export function splitKey(key: string) {
  return key.split(SEPERATOR)
}

export namespace AuthStorage {
  function encode(key: string[]) {
    return key.map((k) => k.replaceAll(SEPERATOR, ''))
  }
  export function get<T>(adapter: AuthStorageAdapter, key: string[]) {
    return adapter.get(encode(key)) as Promise<T | null>
  }

  export function set(
    adapter: AuthStorageAdapter,
    key: string[],
    value: any,
    ttl?: number
  ) {
    const expiry = ttl ? new Date(Date.now() + ttl * 1000) : undefined
    return adapter.set(encode(key), value, expiry)
  }

  export function remove(adapter: AuthStorageAdapter, key: string[]) {
    return adapter.remove(encode(key))
  }

  export function scan<T>(
    adapter: AuthStorageAdapter,
    key: string[]
  ): AsyncIterable<[string[], T]> {
    return adapter.scan(encode(key))
  }
}


================================================
FILE: apps/api/src/lib/auth/create-auth-token.ts
================================================
import { sign } from 'hono/jwt'

import type { RawUser } from '@/db'
import { env } from '@/lib/env'

export async function createAuthToken(user: RawUser): Promise<string> {
  return sign(
    {
      type: 'user',
      id: user.id,
      username: user.username
    },
    env.JWT_SECRET
  )
}


================================================
FILE: apps/api/src/lib/auth/drizzle-auth-storage.ts
================================================
import { and, db, eq, gt, isNull, like, or, schema } from '@/db'

import { type AuthStorageAdapter, joinKey, splitKey } from './auth-storage'

export function DrizzleAuthStorage(): AuthStorageAdapter {
  return {
    async get(key: string[]) {
      const id = joinKey(key)
      const entry = await db.query.authData.findFirst({
        where: eq(schema.authData.id, id)
      })
      if (!entry) return undefined

      if (entry.expiry && Date.now() >= entry.expiry.getTime()) {
        await db.delete(schema.authData).where(eq(schema.authData.id, id))
        return undefined
      }

      return entry.value
    },

    async set(key: string[], value: Record<string, any>, expiry?: Date) {
      const id = joinKey(key)

      await db
        .insert(schema.authData)
        .values({
          id,
          value,
          expiry
        })
        .onConflictDoUpdate({
          target: schema.authData.id,
          set: {
            value,
            expiry: expiry ?? null
          }
        })
    },

    async remove(key: string[]) {
      const id = joinKey(key)
      await db.delete(schema.authData).where(eq(schema.authData.id, id))
    },

    async *scan(prefix: string[]) {
      const now = new Date()
      const idPrefix = joinKey(prefix)

      const entries = await db.query.authData.findMany({
        where: and(
          like(schema.authData.id, `${idPrefix}%`),
          or(isNull(schema.authData.expiry), gt(schema.authData.expiry, now))
        )
      })

      for (const entry of entries) {
        yield [splitKey(entry.id), entry.value]
      }
    }
  }
}


================================================
FILE: apps/api/src/lib/auth/upsert-or-link-user-account.ts
================================================
import type { SetRequired, Simplify } from 'type-fest'
import { assert } from '@agentic/platform-core'

import { and, db, eq, type RawAccount, type RawUser, schema } from '@/db'

import { createAvatar } from '../create-avatar'
import { getUniqueNamespace } from '../ensure-unique-namespace'
import { uploadFileUrlToStorage } from '../storage'

/**
 * After a user completes an authentication flow, we'll have partial account info
 * and partial suer info. This function takes these partial values and maps them
 * to a valid database Account and User.
 *
 * This will result in the Account being upserted, and may result in a new User
 * being created.
 */
export async function upsertOrLinkUserAccount({
  partialAccount,
  partialUser
}: {
  partialAccount: Simplify<
    SetRequired<
      Partial<
        Pick<
          RawAccount,
          | 'provider'
          | 'accountId'
          | 'accountUsername'
          | 'accessToken'
          | 'refreshToken'
          | 'accessTokenExpiresAt'
          | 'refreshTokenExpiresAt'
          | 'scope'
          | 'password'
        >
      >,
      'provider' | 'accountId'
    >
  >
  partialUser: Simplify<
    SetRequired<
      Partial<
        Pick<
          RawUser,
          'email' | 'name' | 'username' | 'image' | 'isEmailVerified'
        >
      >,
      'email'
    >
  >
}): Promise<RawUser> {
  const { provider, accountId } = partialAccount

  const [existingAccount, existingUser] = await Promise.all([
    db.query.accounts.findFirst({
      where: and(
        eq(schema.accounts.provider, provider),
        eq(schema.accounts.accountId, accountId)
      ),
      with: {
        user: true
      }
    }),

    db.query.users.findFirst({
      where: eq(schema.users.email, partialUser.email)
    })
  ])

  async function resolveUserProfileImage({ prefix }: { prefix: string }) {
    // Set a default profile image if one isn't provided
    partialUser.image = await uploadFileUrlToStorage(
      partialUser.image ?? createAvatar(partialUser.email),
      {
        prefix
      }
    )
  }

  if (existingAccount && existingUser) {
    // Happy path case: the user is just logging in with an existing account
    // that's already linked to a user.
    assert(
      existingAccount.userId === existingUser.id,
      `Error authenticating with ${provider}: Account id "${existingAccount.id}" user id "${existingAccount.userId}" does not match expected user id "${existingUser.id}"`
    )
    assert(provider !== 'password', 500)

    // Update the account with the up-to-date provider data, including any OAuth
    // tokens.
    await db
      .update(schema.accounts)
      .set(partialAccount)
      .where(eq(schema.accounts.id, existingAccount.id))

    return existingUser
  } else if (existingUser && !existingAccount) {
    // Linking a new account to an existing user
    await db.insert(schema.accounts).values({
      ...partialAccount,
      userId: existingUser.id
    })

    // TODO: Same caveat as below: if the existing user has a different email than
    // the one in the account we're linking, we should throw an error unless it's
    // a "trusted" provider.
    if (provider === 'password' && existingUser.email !== partialUser.email) {
      await resolveUserProfileImage({ prefix: existingUser.username })

      const [user] = await db
        .update(schema.users)
        .set(partialUser)
        .where(eq(schema.users.id, existingUser.id))
        .returning()
      assert(
        user,
        500,
        `Error updating existing user during ${provider} authentication`
      )
      return user
    }

    return existingUser
  } else if (existingAccount && !existingUser) {
    assert(
      existingAccount.user,
      404,
      `Error authenticating with ${provider}: Account id "${existingAccount.id}" is linked to a user with a different email address than their ${provider} account, but the linked account user id "${existingAccount.userId}" is not found.`
    )

    // Existing account is linked to a user with a different email address than
    // this provider account. This should be fine since it's pretty common for
    // users to have multiple email addresses, but we may want to limit the
    // ability to automatically link accounts like this in the future to only
    // certain, trusted providers like `better-auth` does.
    return existingAccount.user
  } else {
    const username = await getUniqueNamespace(
      partialUser.username || partialUser.email.split('@')[0]!.toLowerCase(),
      { label: 'Username' }
    )

    await resolveUserProfileImage({ prefix: username })

    // This is a user's first time signing up with the platform, so create both
    // a new user and linked account.
    return db.transaction(async (tx) => {
      // Create a new user
      const [user] = await tx
        .insert(schema.users)
        .values({
          ...partialUser,
          username
        })
        .returning()
      assert(
        user,
        500,
        `Error creating new user during ${provider} authentication`
      )

      // Create a new account linked to the new user
      await tx.insert(schema.accounts).values({
        ...partialAccount,
        userId: user.id
      })

      return user
    })
  }
}


================================================
FILE: apps/api/src/lib/billing/create-stripe-checkout-session.ts
================================================
import type Stripe from 'stripe'
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import {
  getStripePriceIdForPricingPlanLineItem,
  type RawConsumer,
  type RawDeployment,
  type RawProject,
  type RawUser
} from '@/db'
import { stripe } from '@/lib/external/stripe'

import { env } from '../env'

export async function createStripeCheckoutSession(
  ctx: AuthenticatedHonoContext,
  {
    consumer,
    user,
    deployment,
    project,
    plan
  }: {
    consumer: RawConsumer
    user: RawUser
    deployment: RawDeployment
    project: RawProject
    plan?: string
  }
): Promise<{ id: string; url: string }> {
  const logger = ctx.get('logger')
  const stripeConnectParams = project._stripeAccountId
    ? [
        {
          stripeAccount: project._stripeAccountId
        }
      ]
    : []

  const stripeCustomerId = consumer._stripeCustomerId || user.stripeCustomerId
  assert(
    stripeCustomerId,
    500,
    `Missing valid stripe customer. Please contact support for deployment "${deployment.id}" and consumer "${consumer.id}"`
  )

  const pricingPlan = plan
    ? deployment.pricingPlans.find((pricingPlan) => pricingPlan.slug === plan)
    : undefined

  const action: 'create' | 'update' | 'cancel' = consumer._stripeSubscriptionId
    ? plan
      ? 'update'
      : 'cancel'
    : 'create'

  // TODO: test cancel => resubscribe flow

  if (consumer._stripeSubscriptionId) {
    // customer has an existing subscription
    const existingStripeSubscription = await stripe.subscriptions.retrieve(
      consumer._stripeSubscriptionId,
      ...stripeConnectParams
    )
    const existingStripeSubscriptionItems =
      existingStripeSubscription.items.data
    logger.debug()
    logger.debug(
      'existing stripe subscription',
      JSON.stringify(existingStripeSubscription, null, 2)
    )
    logger.debug()

    assert(
      existingStripeSubscription.metadata?.userId === consumer.userId,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.userId for consumer "${consumer.id}"`
    )
    assert(
      existingStripeSubscription.metadata?.consumerId === consumer.id,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.consumerId for consumer "${consumer.id}"`
    )
    assert(
      existingStripeSubscription.metadata?.projectId === project.id,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.projectId for consumer "${consumer.id}"`
    )

    if (!plan) {
      const billingPortalSession = await stripe.billingPortal.sessions.create(
        {
          customer: stripeCustomerId,
          return_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers`,
          flow_data: {
            type: 'subscription_cancel',
            subscription_cancel: {
              subscription: consumer._stripeSubscriptionId
            },
            after_completion: {
              type: 'redirect',
              redirect: {
                return_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers/${consumer.id}?checkout=canceled`
              }
            }
          }
        },
        ...stripeConnectParams
      )

      return {
        id: billingPortalSession.id,
        url: billingPortalSession.url
      }
    }

    assert(
      pricingPlan,
      404,
      `Unable to update stripe subscription for invalid pricing plan "${plan}"`
    )

    const updateParams: Stripe.SubscriptionUpdateParams = {
      collection_method: 'charge_automatically',
      description:
        pricingPlan.description ??
        `Subscription to ${project.name} ${pricingPlan.name}`,
      metadata: {
        plan: plan ?? null,
        consumerId: consumer.id,
        userId: consumer.userId,
        projectId: project.id,
        deploymentId: deployment.id
      }
    }

    const items: Stripe.SubscriptionUpdateParams.Item[] = await Promise.all(
      pricingPlan.lineItems.map(async (lineItem) => {
        const priceId = await getStripePriceIdForPricingPlanLineItem({
          pricingPlan,
          pricingPlanLineItem: lineItem,
          project
        })
        assert(
          priceId,
          500,
          `Error updating stripe subscription: missing expected Stripe Price for plan "${pricingPlan.slug}" line-item "${lineItem.slug}"`
        )

        // An existing Stripe Subscription Item may or may not exist for this
        // LineItem. It should exist if this is an update to an existing
        // LineItem. It won't exist if it's a new LineItem.
        const id = consumer._stripeSubscriptionItemIdMap[lineItem.slug]

        return {
          price: priceId,
          id,
          metadata: {
            lineItemSlug: lineItem.slug
          }
        }
      })
    )

    // Sanity check that LineItems we think should exist are all present in
    // the current subscription's items.
    for (const item of items) {
      if (item.id) {
        const existingItem = existingStripeSubscriptionItems.find(
          (existingItem) => item.id === existingItem.id
        )

        assert(
          existingItem,
          500,
          `Error updating stripe subscription: invalid pricing plan "${plan}" missing existing Subscription Item for "${item.id}"`
        )
      }
    }

    for (const existingItem of existingStripeSubscriptionItems) {
      const updatedItem = items.find((item) => item.id === existingItem.id)

      if (!updatedItem) {
        const deletedItem: Stripe.SubscriptionUpdateParams.Item = {
          id: existingItem.id,
          deleted: true
        }

        items.push(deletedItem)
      }
    }

    assert(
      items.length || !plan,
      500,
      `Error updating stripe subscription "${consumer._stripeSubscriptionId}"`
    )

    for (const item of items) {
      if (!item.id) {
        delete item.id
      }
    }

    updateParams.items = items

    if (pricingPlan.trialPeriodDays) {
      const trialEnd =
        Math.trunc(Date.now() / 1000) +
        24 * 60 * 60 * pricingPlan.trialPeriodDays

      // Reuse the existing trial end date if one exists. Otherwise, set a new
      // one for the updated subscription.
      updateParams.trial_end = existingStripeSubscription.trial_end ?? trialEnd
    } else if (existingStripeSubscription.trial_end) {
      // If the existing subscription has a trial end date, but the updated
      // subscription doesn't, we should end the trial now.
      updateParams.trial_end = 'now'
    }

    logger.info('>>> subscription', action, { items })

    // TODO: Stripe Connect
    // if (project.isStripeConnectEnabled && project.applicationFeePercent > 0) {
    //   updateParams.application_fee_percent = project.applicationFeePercent
    // }

    const subscription = await stripe.subscriptions.update(
      consumer._stripeSubscriptionId,
      updateParams,
      ...stripeConnectParams
    )

    logger.info('<<< subscription', action, subscription)

    const billingPortalSession = await stripe.billingPortal.sessions.create(
      {
        customer: stripeCustomerId,
        return_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers`
      },
      ...stripeConnectParams
    )

    return {
      id: billingPortalSession.id,
      url: billingPortalSession.url
    }
  } else {
    // Creating a new subscription for this consumer for the first time.
    assert(
      pricingPlan,
      404,
      `Unable to update stripe subscription for invalid pricing plan "${plan}"`
    )

    const items: Stripe.Checkout.SessionCreateParams.LineItem[] =
      await Promise.all(
        pricingPlan.lineItems.map(async (lineItem) => {
          // An existing Stripe Subscription Item may or may not exist for this
          // LineItem. It should exist if this is an update to an existing
          // LineItem. It won't exist if it's a new LineItem.
          const id = consumer._stripeSubscriptionItemIdMap[lineItem.slug]
          assert(
            !id,
            500,
            `Error creating stripe subscription: consumer contains a Stripe Subscription Item for LineItem "${lineItem.slug}" and pricing plan "${pricingPlan.slug}"`
          )

          const priceId = await getStripePriceIdForPricingPlanLineItem({
            pricingPlan,
            pricingPlanLineItem: lineItem,
            project
          })
          assert(
            priceId,
            500,
            `Error creating stripe subscription: missing expected Stripe Price for plan "${pricingPlan.slug}" line item "${lineItem.slug}"`
          )

          return {
            price: priceId,
            // TODO: Make this customizable
            quantity: lineItem.usageType === 'licensed' ? 1 : undefined
            // metadata: {
            //   lineItemSlug: lineItem.slug
            // }
          } satisfies Stripe.Checkout.SessionCreateParams.LineItem
        })
      )

    assert(
      items.length,
      500,
      `Error creating stripe subscription: invalid plan "${plan}"`
    )

    const checkoutSessionParams: Stripe.Checkout.SessionCreateParams = {
      customer: stripeCustomerId,
      mode: 'subscription',
      line_items: items,
      success_url: `${env.AGENTIC_WEB_BASE_URL}/app/consumers/${consumer.id}?checkout=success&plan=${plan}`,
      cancel_url: `${env.AGENTIC_WEB_BASE_URL}/marketplace/projects/${project.identifier}?checkout=canceled`,
      submit_type: 'subscribe',
      saved_payment_method_options: {
        payment_method_save: 'enabled'
      },
      subscription_data: {
        description:
          pricingPlan.description ??
          `Subscription to ${project.name} ${pricingPlan.name}`,
        trial_period_days: pricingPlan.trialPeriodDays,
        metadata: {
          plan: plan ?? null,
          consumerId: consumer.id,
          userId: consumer.userId,
          projectId: project.id,
          deploymentId: deployment.id
        }
        // TODO: Stripe Connect
        // application_fee_percent: project.applicationFeePercent
      },
      // TODO: coupons
      // coupon: filterConsumerCoupon(ctx, consumer, deployment),
      // TODO: discounts
      // collection_method: 'charge_automatically',
      // TODO: consider custom_fields
      // TODO: consider custom_text
      // TODO: consider optional_items
      metadata: {
        plan: plan ?? null,
        consumerId: consumer.id,
        userId: consumer.userId,
        projectId: project.id,
        deploymentId: deployment.id
      }
    }

    // TODO: Stripe Connect
    // if (project.isStripeConnectEnabled && project.applicationFeePercent > 0) {
    //   createParams.application_fee_percent = project.applicationFeePercent
    // }

    logger.debug('checkout session line_items', items)
    const checkoutSession = await stripe.checkout.sessions.create(
      checkoutSessionParams,
      ...stripeConnectParams
    )
    assert(checkoutSession.url, 500, 'Missing stripe checkout session URL')

    return {
      id: checkoutSession.id,
      url: checkoutSession.url
    }
  }
}


================================================
FILE: apps/api/src/lib/billing/upsert-stripe-connect-customer.ts
================================================
import type Stripe from 'stripe'
import { assert } from '@agentic/platform-core'

import { db, eq, type RawConsumer, type RawProject, schema } from '@/db'
import { stripe } from '@/lib/external/stripe'

// TODO: Update this for the new / updated Stripe Connect API

export async function upsertStripeConnectCustomer({
  stripeCustomer,
  consumer,
  project
}: {
  stripeCustomer: Stripe.Customer
  consumer: RawConsumer
  project: RawProject
}): Promise<Stripe.Customer | undefined> {
  if (!project._stripeAccountId) {
    return stripeCustomer
  }

  const stripeConnectParams = project._stripeAccountId
    ? [
        {
          stripeAccount: project._stripeAccountId
        }
      ]
    : []

  const stripeConnectCustomer = consumer._stripeCustomerId
    ? await stripe.customers.retrieve(
        consumer._stripeCustomerId,
        ...stripeConnectParams
      )
    : await stripe.customers.create(
        {
          email: stripeCustomer.email!,
          metadata: stripeCustomer.metadata
        },
        ...stripeConnectParams
      )
  assert(
    stripeConnectCustomer,
    500,
    `Failed to create stripe connect customer for user "${consumer.userId}"`
  )
  assert(
    !stripeConnectCustomer.deleted,
    500,
    `Stripe connect customer "${stripeConnectCustomer.id}" has been deleted`
  )

  if (consumer._stripeCustomerId !== stripeConnectCustomer.id) {
    consumer._stripeCustomerId = stripeConnectCustomer.id

    await db
      .update(schema.consumers)
      .set({ _stripeCustomerId: stripeConnectCustomer.id })
      .where(eq(schema.consumers.id, consumer.id))
  }

  // TODO: Ensure stripe connect default "source" exists and is cloned from
  // platform stripe account.

  return stripeConnectCustomer
}


================================================
FILE: apps/api/src/lib/billing/upsert-stripe-customer.ts
================================================
import type Stripe from 'stripe'
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import { db, eq, type RawUser, schema } from '@/db'
import { ensureAuthUser } from '@/lib/ensure-auth-user'
import { stripe } from '@/lib/external/stripe'

export async function upsertStripeCustomer(
  ctx: AuthenticatedHonoContext
): Promise<{
  user: RawUser
  stripeCustomer: Stripe.Customer
}> {
  const user = await ensureAuthUser(ctx)

  if (user.stripeCustomerId) {
    const stripeCustomer = await stripe.customers.retrieve(
      user.stripeCustomerId
    )
    assert(
      stripeCustomer,
      404,
      `Stripe customer "${user.stripeCustomerId}" not found for user "${user.id}"`
    )

    // TODO: handle this edge case
    assert(
      !stripeCustomer.deleted,
      404,
      `Stripe customer "${user.stripeCustomerId}" is deleted for user "${user.id}"`
    )

    return {
      user,
      stripeCustomer
    }
  }

  // TODO: add more metadata referencing signup LogEntry
  const metadata = {
    userId: user.id,
    email: user.email,
    username: user.username ?? null
  }

  const stripeCustomer = await stripe.customers.create({
    email: user.email,
    metadata
  })
  assert(
    stripeCustomer,
    500,
    `Failed to create stripe customer for user "${user.id}"`
  )

  user.stripeCustomerId = stripeCustomer.id
  await db
    .update(schema.users)
    .set({ stripeCustomerId: stripeCustomer.id })
    .where(eq(schema.users.id, user.id))

  return {
    user,
    stripeCustomer
  }
}


================================================
FILE: apps/api/src/lib/billing/upsert-stripe-pricing-resources.ts
================================================
import type Stripe from 'stripe'
import { assert } from '@agentic/platform-core'
import {
  getLabelForPricingInterval,
  type PricingPlan,
  type PricingPlanLineItem
} from '@agentic/platform-types'
import pAll from 'p-all'

import {
  db,
  eq,
  getPricingPlanLineItemHashForStripePrice,
  type RawDeployment,
  type RawProject,
  schema
} from '@/db'
import { stripe } from '@/lib/external/stripe'

/**
 * Upserts all the Stripe resources corresponding to a Deployment's pricing
 * plans.
 *
 * This includes Stripe `Product`, `Meter`, and `Price` objects.
 *
 * All Stripe resource IDs are stored in the `_stripeProductIdMap`,
 * `_stripeMeterIdMap`, and `_stripePriceIdMap` fields of the given `project`.
 *
 * The `project` will be updated in the DB with any changes.
 *
 * The `deployment` is readonly and will not be updated, since all Stripe
 * resources persist on its Project so they can be reused if possible across
 * deployments.
 *
 * @note This function assumes that the deployment's pricing config has already
 * been validated.
 */
export async function upsertStripePricingResources({
  deployment,
  project
}: {
  deployment: Readonly<RawDeployment>
  project: RawProject
}): Promise<void> {
  assert(
    deployment.projectId === project.id,
    'Deployment and project must match'
  )

  // Keep track of promises for Stripe resources that are created in parallel
  // to avoid race conditions.
  const stripeProductIdPromiseMap = new Map<string, Promise<string>>()
  const stripeMeterIdPromiseMap = new Map<string, Promise<string>>()
  const stripePriceIdPromiseMap = new Map<string, Promise<string>>()

  const stripeConnectParams = project._stripeAccountId
    ? [
        {
          stripeAccount: project._stripeAccountId
        }
      ]
    : []
  let dirty = false

  async function upsertStripeResourcesForPricingPlanLineItem({
    pricingPlan,
    pricingPlanLineItem
  }: {
    pricingPlan: PricingPlan
    pricingPlanLineItem: PricingPlanLineItem
  }) {
    const { slug: pricingPlanSlug } = pricingPlan
    const { slug: pricingPlanLineItemSlug } = pricingPlanLineItem

    // Upsert the Stripe Product
    if (!project._stripeProductIdMap[pricingPlanLineItemSlug]) {
      if (stripeProductIdPromiseMap.has(pricingPlanLineItemSlug)) {
        const stripeProductId = await stripeProductIdPromiseMap.get(
          pricingPlanLineItemSlug
        )!

        project._stripeProductIdMap[pricingPlanLineItemSlug] = stripeProductId
        dirty = true
      } else {
        const productParams: Stripe.ProductCreateParams = {
          name: `${project.identifier} ${pricingPlanLineItemSlug}`,
          type: 'service',
          metadata: {
            projectId: project.id,
            pricingPlanLineItemSlug
          }
        }

        if (pricingPlanLineItem.usageType === 'licensed') {
          productParams.unit_label = pricingPlanLineItem.label
        } else {
          productParams.unit_label = pricingPlanLineItem.unitLabel
        }

        const productP = stripe.products.create(
          productParams,
          ...stripeConnectParams
        )
        stripeProductIdPromiseMap.set(
          pricingPlanLineItemSlug,
          productP.then((p) => p.id)
        )

        const product = await productP

        project._stripeProductIdMap[pricingPlanLineItemSlug] = product.id
        dirty = true
      }
    }

    assert(project._stripeProductIdMap[pricingPlanLineItemSlug])

    if (pricingPlanLineItem.usageType === 'metered') {
      // Upsert the Stripe Meter
      if (!project._stripeMeterIdMap[pricingPlanLineItemSlug]) {
        if (stripeMeterIdPromiseMap.has(pricingPlanLineItemSlug)) {
          const stripeMeterId = await stripeMeterIdPromiseMap.get(
            pricingPlanLineItemSlug
          )!

          project._stripeMeterIdMap[pricingPlanLineItemSlug] = stripeMeterId
          dirty = true
        } else {
          const meterP = stripe.billing.meters.create(
            {
              display_name: `${project.identifier} ${pricingPlanLineItem.label || pricingPlanLineItemSlug}`,
              event_name: `meter-${project.id}-${pricingPlanLineItemSlug}`,
              // TODO: This currently isn't taken into account for the slug, so if it
              // changes across deployments, the meter will not be updated.
              default_aggregation: {
                formula:
                  pricingPlanLineItem.defaultAggregation?.formula ?? 'sum'
              },
              customer_mapping: {
                event_payload_key: 'stripe_customer_id',
                type: 'by_id'
              },
              value_settings: {
                event_payload_key: 'value'
              }
            },
            ...stripeConnectParams
          )

          stripeMeterIdPromiseMap.set(
            pricingPlanLineItemSlug,
            meterP.then((m) => m.id)
          )

          const stripeMeter = await meterP

          project._stripeMeterIdMap[pricingPlanLineItemSlug] = stripeMeter.id
          dirty = true
        }
      }

      assert(project._stripeMeterIdMap[pricingPlanLineItemSlug])
    } else {
      assert(pricingPlanLineItem.usageType === 'licensed', 400)

      assert(
        !project._stripeMeterIdMap[pricingPlanLineItemSlug],
        400,
        `Invalid pricing plan metric "${pricingPlanLineItemSlug}" for pricing plan "${pricingPlanSlug}": licensed pricing plan metrics cannot replace a previous metered pricing plan metric. Use a different pricing plan metric slug for the new licensed plan.`
      )
    }

    const pricingPlanLineItemHashForStripePrice =
      await getPricingPlanLineItemHashForStripePrice({
        pricingPlan,
        pricingPlanLineItem,
        project
      })

    // Upsert the Stripe Price
    if (!project._stripePriceIdMap[pricingPlanLineItemHashForStripePrice]) {
      if (stripePriceIdPromiseMap.has(pricingPlanLineItemHashForStripePrice)) {
        const stripePriceId = await stripePriceIdPromiseMap.get(
          pricingPlanLineItemHashForStripePrice
        )!

        project._stripePriceIdMap[pricingPlanLineItemHashForStripePrice] =
          stripePriceId
        dirty = true
      } else {
        const interval = pricingPlan.interval ?? project.defaultPricingInterval

        // (nickname is hidden from customers)
        const nickname = [
          'price',
          project.id,
          pricingPlanLineItemSlug,
          getLabelForPricingInterval(interval)
        ]
          .filter(Boolean)
          .join('-')

        const priceParams: Stripe.PriceCreateParams = {
          product: project._stripeProductIdMap[pricingPlanLineItemSlug],
          currency: project.pricingCurrency,
          nickname,
          recurring: {
            interval,

            // TODO: support this
            interval_count: 1,

            usage_type: pricingPlanLineItem.usageType,

            meter: project._stripeMeterIdMap[pricingPlanLineItemSlug]
          },
          metadata: {
            projectId: project.id,
            pricingPlanLineItemSlug
          }
        }

        if (pricingPlanLineItem.usageType === 'licensed') {
          priceParams.unit_amount_decimal =
            pricingPlanLineItem.amount.toFixed(12)
        } else {
          priceParams.billing_scheme = pricingPlanLineItem.billingScheme

          if (pricingPlanLineItem.billingScheme === 'tiered') {
            assert(
              pricingPlanLineItem.tiers?.length,
              400,
              `Invalid pricing plan metric "${pricingPlanLineItemSlug}" for pricing plan "${pricingPlanSlug}": tiered billing schemes must have at least one tier.`
            )

            priceParams.tiers_mode = pricingPlanLineItem.tiersMode
            priceParams.tiers = pricingPlanLineItem.tiers.map((tierData) => {
              const tier: Stripe.PriceCreateParams.Tier = {
                up_to: tierData.upTo
              }

              if (tierData.unitAmount !== undefined) {
                tier.unit_amount_decimal = tierData.unitAmount.toFixed(12)
              }

              if (tierData.flatAmount !== undefined) {
                tier.flat_amount_decimal = tierData.flatAmount.toFixed(12)
              }

              return tier
            })
          } else {
            assert(
              pricingPlanLineItem.billingScheme === 'per_unit',
              400,
              `Invalid pricing plan metric "${pricingPlanLineItemSlug}" for pricing plan "${pricingPlanSlug}": invalid billing scheme.`
            )
            assert(
              pricingPlanLineItem.unitAmount !== undefined,
              400,
              `Invalid pricing plan metric "${pricingPlanLineItemSlug}" for pricing plan "${pricingPlanSlug}": unitAmount is required for per_unit billing schemes.`
            )

            priceParams.unit_amount_decimal =
              pricingPlanLineItem.unitAmount.toFixed(12)

            if (pricingPlanLineItem.transformQuantity) {
              priceParams.transform_quantity = {
                divide_by: pricingPlanLineItem.transformQuantity.divideBy,
                round: pricingPlanLineItem.transformQuantity.round
              }
            }
          }
        }

        const stripePriceP = stripe.prices.create(
          priceParams,
          ...stripeConnectParams
        )

        stripePriceIdPromiseMap.set(
          pricingPlanLineItemHashForStripePrice,
          stripePriceP.then((p) => p.id)
        )

        const stripePrice = await stripePriceP

        project._stripePriceIdMap[pricingPlanLineItemHashForStripePrice] =
          stripePrice.id
        dirty = true
      }
    }

    assert(project._stripePriceIdMap[pricingPlanLineItemHashForStripePrice])
  }

  const upserts: Array<() => Promise<void>> = []
  for (const pricingPlan of deployment.pricingPlans) {
    for (const pricingPlanLineItem of pricingPlan.lineItems) {
      upserts.push(() =>
        upsertStripeResourcesForPricingPlanLineItem({
          pricingPlan,
          pricingPlanLineItem
        })
      )
    }
  }

  await pAll(upserts, { concurrency: 8 })

  if (dirty) {
    await db
      .update(schema.projects)
      .set(project)
      .where(eq(schema.projects.id, project.id))
  }
}


================================================
FILE: apps/api/src/lib/billing/upsert-stripe-subscription.ts
================================================
import type Stripe from 'stripe'
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import {
  db,
  eq,
  getStripePriceIdForPricingPlanLineItem,
  type RawConsumer,
  type RawConsumerUpdate,
  type RawDeployment,
  type RawProject,
  type RawUser,
  schema
} from '@/db'
import { stripe } from '@/lib/external/stripe'

import { setConsumerStripeSubscriptionStatus } from '../consumers/utils'

export async function upsertStripeSubscription(
  ctx: AuthenticatedHonoContext,
  {
    consumer,
    user,
    deployment,
    project
  }: {
    consumer: RawConsumer
    user: RawUser
    deployment: RawDeployment
    project: RawProject
  }
): Promise<{
  subscription: Stripe.Subscription
  consumer: RawConsumer
}> {
  const logger = ctx.get('logger')
  const stripeConnectParams = project._stripeAccountId
    ? [
        {
          stripeAccount: project._stripeAccountId
        }
      ]
    : []

  const stripeCustomerId = consumer._stripeCustomerId || user.stripeCustomerId
  assert(
    stripeCustomerId,
    500,
    `Missing valid stripe customer. Please contact support for deployment "${deployment.id}" and consumer "${consumer.id}"`
  )

  const { plan } = consumer
  const pricingPlan = plan
    ? deployment.pricingPlans.find((pricingPlan) => pricingPlan.slug === plan)
    : undefined

  const action: 'create' | 'update' | 'cancel' = consumer._stripeSubscriptionId
    ? plan
      ? 'update'
      : 'cancel'
    : 'create'
  let subscription: Stripe.Subscription | undefined

  if (consumer._stripeSubscriptionId) {
    // customer has an existing subscription
    const existingStripeSubscription = await stripe.subscriptions.retrieve(
      consumer._stripeSubscriptionId,
      ...stripeConnectParams
    )
    const existingStripeSubscriptionItems =
      existingStripeSubscription.items.data
    logger.debug()
    logger.debug(
      'existing stripe subscription',
      JSON.stringify(existingStripeSubscription, null, 2)
    )
    logger.debug()

    assert(
      existingStripeSubscription.metadata?.userId === consumer.userId,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.userId for consumer "${consumer.id}"`
    )
    assert(
      existingStripeSubscription.metadata?.consumerId === consumer.id,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.consumerId for consumer "${consumer.id}"`
    )
    assert(
      existingStripeSubscription.metadata?.projectId === project.id,
      500,
      `Error updating stripe subscription: invalid existing subscription "${existingStripeSubscription.id}" metadata.projectId for consumer "${consumer.id}"`
    )

    const updateParams: Stripe.SubscriptionUpdateParams = {
      collection_method: 'charge_automatically',
      metadata: {
        plan: plan ?? null,
        userId: consumer.userId,
        consumerId: consumer.id,
        projectId: project.id,
        deploymentId: deployment.id
      }
    }

    if (plan) {
      assert(
        pricingPlan,
        404,
        `Unable to update stripe subscription for invalid pricing plan "${plan}"`
      )

      const items: Stripe.SubscriptionUpdateParams.Item[] = await Promise.all(
        pricingPlan.lineItems.map(async (lineItem) => {
          const priceId = await getStripePriceIdForPricingPlanLineItem({
            pricingPlan,
            pricingPlanLineItem: lineItem,
            project
          })
          assert(
            priceId,
            500,
            `Error updating stripe subscription: missing expected Stripe Price for plan "${pricingPlan.slug}" line-item "${lineItem.slug}"`
          )

          // An existing Stripe Subscription Item may or may not exist for this
          // LineItem. It should exist if this is an update to an existing
          // LineItem. It won't exist if it's a new LineItem.
          const id = consumer._stripeSubscriptionItemIdMap[lineItem.slug]

          return {
            price: priceId,
            id,
            metadata: {
              lineItemSlug: lineItem.slug
            }
          }
        })
      )

      // Sanity check that LineItems we think should exist are all present in
      // the current subscription's items.
      for (const item of items) {
        if (item.id) {
          const existingItem = existingStripeSubscriptionItems.find(
            (existingItem) => item.id === existingItem.id
          )

          assert(
            existingItem,
            500,
            `Error updating stripe subscription: invalid pricing plan "${plan}" missing existing Subscription Item for "${item.id}"`
          )
        }
      }

      for (const existingItem of existingStripeSubscriptionItems) {
        const updatedItem = items.find((item) => item.id === existingItem.id)

        if (!updatedItem) {
          const deletedItem: Stripe.SubscriptionUpdateParams.Item = {
            id: existingItem.id,
            deleted: true
          }

          items.push(deletedItem)
        }
      }

      assert(
        items.length || !plan,
        500,
        `Error updating stripe subscription "${consumer._stripeSubscriptionId}"`
      )

      for (const item of items) {
        if (!item.id) {
          delete item.id
        }
      }

      updateParams.items = items

      if (pricingPlan.trialPeriodDays) {
        const trialEnd =
          Math.trunc(Date.now() / 1000) +
          24 * 60 * 60 * pricingPlan.trialPeriodDays

        // Reuse the existing trial end date if one exists. Otherwise, set a new
        // one for the updated subscription.
        updateParams.trial_end =
          existingStripeSubscription.trial_end ?? trialEnd
      } else if (existingStripeSubscription.trial_end) {
        // If the existing subscription has a trial end date, but the updated
        // subscription doesn't, we should end the trial now.
        updateParams.trial_end = 'now'
      }

      logger.debug('subscription', action, { items })
    } else {
      updateParams.cancel_at_period_end = true
    }

    // TODO: Stripe Connect
    // if (project.isStripeConnectEnabled && project.applicationFeePercent > 0) {
    //   updateParams.application_fee_percent = project.applicationFeePercent
    // }

    subscription = await stripe.subscriptions.update(
      consumer._stripeSubscriptionId,
      updateParams,
      ...stripeConnectParams
    )

    // TODO: this will cancel the subscription without resolving current usage / invoices
    // await stripe.subscriptions.del(consumer.stripeSubscription)
  } else {
    // Creating a new subscription for this consumer for the first time.
    assert(
      pricingPlan,
      404,
      `Unable to update stripe subscription for invalid pricing plan "${plan}"`
    )

    const items: Stripe.SubscriptionCreateParams.Item[] = await Promise.all(
      pricingPlan.lineItems.map(async (lineItem) => {
        const priceId = await getStripePriceIdForPricingPlanLineItem({
          pricingPlan,
          pricingPlanLineItem: lineItem,
          project
        })
        assert(
          priceId,
          500,
          `Error creating stripe subscription: missing expected Stripe Price for plan "${pricingPlan.slug}" line item "${lineItem.slug}"`
        )

        // An existing Stripe Subscription Item may or may not exist for this
        // LineItem. It should exist if this is an update to an existing
        // LineItem. It won't exist if it's a new LineItem.
        const id = consumer._stripeSubscriptionItemIdMap[lineItem.slug]
        assert(
          !id,
          500,
          `Error creating stripe subscription: consumer contains a Stripe Subscription Item for LineItem "${lineItem.slug}" and pricing plan "${pricingPlan.slug}"`
        )

        return {
          price: priceId,
          metadata: {
            lineItemSlug: lineItem.slug
          }
        }
      })
    )

    assert(
      items.length,
      500,
      `Error creating stripe subscription: invalid plan "${plan}"`
    )

    const createParams: Stripe.SubscriptionCreateParams = {
      customer: stripeCustomerId,
      description: `Agentic subscription to project "${project.identifier}"`,
      // TODO: coupons
      // coupon: filterConsumerCoupon(ctx, consumer, deployment),
      items,
      // collection_method: 'charge_automatically',
      metadata: {
        plan: plan ?? null,
        consumerId: consumer.id,
        userId: consumer.userId,
        projectId: project.id,
        deploymentId: deployment.id
      }
    }

    if (pricingPlan.trialPeriodDays) {
      createParams.trial_period_days = pricingPlan.trialPeriodDays
    }

    // TODO: Stripe Connect
    // if (project.isStripeConnectEnabled && project.applicationFeePercent > 0) {
    //   createParams.application_fee_percent = project.applicationFeePercent
    // }

    logger.debug('subscription', action, { items })
    subscription = await stripe.subscriptions.create(
      createParams,
      ...stripeConnectParams
    )

    consumer._stripeSubscriptionId = subscription.id
  }

  // ----------------------------------------------------
  // Same codepath for updating, creating, and cancelling
  // ----------------------------------------------------

  assert(subscription, 500, 'Missing stripe subscription')
  logger.debug('subscription', subscription)

  const consumerUpdate: RawConsumerUpdate = consumer
  consumerUpdate.stripeStatus = subscription.status
  setConsumerStripeSubscriptionStatus(consumerUpdate)

  // if (!plan) {
  // TODO: we cancel at the end of the billing interval, so we shouldn't
  // invalidate the stripe subscription just yet. That should happen via
  // webhook. And we should never set `_stripeSubscriptionId` to `null`.
  // consumerUpdate._stripeSubscriptionId = null
  // consumerUpdate.stripeStatus = 'cancelled'
  // }

  if (pricingPlan) {
    for (const lineItem of pricingPlan.lineItems) {
      const stripeSubscriptionItemId =
        consumer._stripeSubscriptionItemIdMap[lineItem.slug]

      const stripeSubscriptionItem: Stripe.SubscriptionItem | undefined =
        subscription.items.data.find((item) =>
          stripeSubscriptionItemId
            ? item.id === stripeSubscriptionItemId
            : item.metadata?.lineItemSlug === lineItem.slug
        )

      assert(
        stripeSubscriptionItem,
        500,
        `Error post-processing stripe subscription for line-item "${lineItem.slug}" on plan "${pricingPlan.slug}"`
      )

      consumerUpdate._stripeSubscriptionItemIdMap![lineItem.slug] =
        stripeSubscriptionItem.id
      assert(
        consumerUpdate._stripeSubscriptionItemIdMap![lineItem.slug],
        500,
        `Error post-processing stripe subscription for line-item "${lineItem.slug}" on plan "${pricingPlan.slug}"`
      )
    }
  }

  logger.debug()
  logger.debug('consumer update', consumerUpdate)

  const [updatedConsumer] = await db
    .update(schema.consumers)
    .set(consumerUpdate)
    .where(eq(schema.consumers.id, consumer.id))
    .returning()
  assert(updatedConsumer, 500, 'Error updating consumer')

  // await auditLog.createStripeSubscriptionLogEntry(ctx, {
  //   consumer,
  //   user,
  //   plan: consumer.plan,
  //   subtype: action
  // })

  return {
    subscription,
    consumer: updatedConsumer
  }
}


================================================
FILE: apps/api/src/lib/cache-control.ts
================================================
import { assert } from '@agentic/platform-core'

export type PublicCacheControlLevels =
  | '1s'
  | '10s'
  | '30s'
  | '1m'
  | '5m'
  | '10m'
  | '30m'
  | '1h'
  | '1d'

const publicCacheControlLevelsMap: Record<PublicCacheControlLevels, string> = {
  '1s': 'public, max-age=1, s-maxage=1 stale-while-revalidate=0',
  '10s': 'public, max-age=10, s-maxage=10 stale-while-revalidate=1',
  '30s': 'public, max-age=30, s-maxage=30 stale-while-revalidate=5',
  '1m': 'public, max-age=60, s-maxage=60 stale-while-revalidate=10',
  '5m': 'public, max-age=300, s-maxage=300 stale-while-revalidate=60',
  '10m': 'public, max-age=600, s-maxage=600 stale-while-revalidate=120',
  '30m': 'public, max-age=1800, s-maxage=1800 stale-while-revalidate=300',
  '1h': 'public, max-age=3600, s-maxage=3600, stale-while-revalidate=500',
  '1d': 'public, max-age=86400, s-maxage=86400, stale-while-revalidate=3600'
}

export function setPublicCacheControl(
  res: Response,
  level: PublicCacheControlLevels
) {
  const cacheControl = publicCacheControlLevelsMap[level]
  assert(cacheControl, `Invalid cache control level "${level}"`)

  res.headers.set('cache-control', cacheControl)
}


================================================
FILE: apps/api/src/lib/consumers/upsert-consumer-stripe-checkout.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import {
  and,
  db,
  eq,
  type RawConsumer,
  type RawDeployment,
  type RawProject,
  schema
} from '@/db'
import { acl } from '@/lib/acl'
import { upsertStripeConnectCustomer } from '@/lib/billing/upsert-stripe-connect-customer'
import { upsertStripeCustomer } from '@/lib/billing/upsert-stripe-customer'
import { upsertStripePricingResources } from '@/lib/billing/upsert-stripe-pricing-resources'
import { createConsumerApiKey } from '@/lib/create-consumer-api-key'

import { aclPublicProject } from '../acl-public-project'
import { createStripeCheckoutSession } from '../billing/create-stripe-checkout-session'

export async function upsertConsumerStripeCheckout(
  c: AuthenticatedHonoContext,
  {
    plan,
    deploymentId,
    consumerId
  }: {
    plan?: string
    deploymentId?: string
    consumerId?: string
  }
): Promise<{
  checkoutSession: { id: string; url: string }
  consumer: RawConsumer
}> {
  assert(
    consumerId || deploymentId,
    400,
    'Internal error: upsertConsumerStripeCheckout missing required "deploymentId" or "consumerId"'
  )
  const logger = c.get('logger')
  const userId = c.get('userId')
  let deployment: RawDeployment | undefined
  let project: RawProject | undefined
  let projectId: string | undefined

  logger.info('upsertConsumerStripeCheckout', {
    plan,
    deploymentId,
    consumerId
  })

  async function initDeploymentAndProject() {
    assert(deploymentId, 400, 'Missing required "deploymentId"')
    if (deployment && project) {
      // Already initialized
      return
    }

    deployment = await db.query.deployments.findFirst({
      where: eq(schema.deployments.id, deploymentId),
      with: {
        project: true
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentId}"`)

    project = deployment.project!
    assert(
      project,
      404,
      `Project not found "${projectId}" for deployment "${deploymentId}"`
    )
    aclPublicProject(project)

    // Validate the deployment only after we're sure the project is publicly
    // accessible.
    assert(
      !deployment.deletedAt,
      410,
      `Deployment has been deleted by its owner "${deployment.id}"`
    )

    projectId = project.id
  }

  if (deploymentId) {
    await initDeploymentAndProject()
  }

  if (!consumerId) {
    assert(projectId, 400, 'Missing required "projectId"')
  }

  const [{ user, stripeCustomer }, existingConsumer] = await Promise.all([
    upsertStripeCustomer(c),

    db.query.consumers.findFirst({
      where: consumerId
        ? eq(schema.consumers.id, consumerId)
        : and(
            eq(schema.consumers.userId, userId),
            eq(schema.consumers.projectId, projectId!)
          )
    })
  ])

  if (consumerId) {
    assert(existingConsumer, 404, `Consumer not found "${consumerId}"`)
    assert(existingConsumer.id === consumerId, 403)
    await acl(c, existingConsumer, { label: 'Consumer' })

    if (projectId) {
      assert(
        existingConsumer.projectId === projectId,
        400,
        `Deployment "${deploymentId}" does not belong to project "${existingConsumer.projectId}" for consumer "${consumerId}"`
      )
    }

    deploymentId ??= existingConsumer.deploymentId
    projectId ??= existingConsumer.projectId
  }

  assert(deploymentId)
  assert(projectId)

  assert(
    !existingConsumer ||
      !existingConsumer.isStripeSubscriptionActive ||
      existingConsumer.plan !== plan ||
      existingConsumer.deploymentId !== deploymentId,
    409,

    plan
      ? `User "${user.email}" already has an active subscription to plan "${plan}" for project "${projectId}"`
      : `User "${user.email}" already has cancelled their subscription for project "${projectId}"`
  )

  await initDeploymentAndProject()
  assert(deployment, 500, `Error getting deployment "${deploymentId}"`)
  assert(project, 500, `Error getting project "${projectId}"`)

  if (plan) {
    const pricingPlan = deployment.pricingPlans.find((p) => p.slug === plan)
    assert(
      pricingPlan,
      400,
      `Pricing plan "${plan}" not found for deployment "${deploymentId}"`
    )
  }

  let consumer = existingConsumer

  if (consumer) {
    // Don't update the consumer until the checkout session is completed
    // successfully.
    // ;[consumer] = await db
    //   .update(schema.consumers)
    //   .set({
    //     plan,
    //     deploymentId
    //   })
    //   .where(eq(schema.consumers.id, consumer.id))
    //   .returning()
  } else {
    // Create a new consumer, but don't set the plan yet until the checkout
    // session is completed successfully.
    ;[consumer] = await db
      .insert(schema.consumers)
      .values({
        // plan,
        userId,
        projectId,
        deploymentId,
        token: await createConsumerApiKey(),
        _stripeCustomerId: stripeCustomer.id
      })
      .returning()
  }

  assert(
    consumer,
    500,
    'Internal error: upsertConsumerStripeCheckout error creating consumer'
  )

  // Ensure that all Stripe pricing resources exist for this deployment
  await upsertStripePricingResources({ deployment, project })

  // Ensure that customer and default source are created on the stripe connect account
  // TODO: is this necessary?
  // consumer._stripeAccount = project._stripeAccount
  // TODO: this function may mutate `consumer`
  await upsertStripeConnectCustomer({ stripeCustomer, consumer, project })

  logger.info(
    'CONSUMER STRIPE CHECKOUT',
    existingConsumer ? 'UPDATE' : 'CREATE',
    {
      project,
      deployment,
      consumer
    }
  )

  const checkoutSession = await createStripeCheckoutSession(c, {
    consumer,
    user,
    project,
    deployment,
    plan
  })
  logger.info('checkout session', checkoutSession)

  return {
    checkoutSession,
    consumer
  }
}


================================================
FILE: apps/api/src/lib/consumers/upsert-consumer.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import { and, db, eq, type RawDeployment, type RawProject, schema } from '@/db'
import { acl } from '@/lib/acl'
import { upsertStripeConnectCustomer } from '@/lib/billing/upsert-stripe-connect-customer'
import { upsertStripeCustomer } from '@/lib/billing/upsert-stripe-customer'
import { upsertStripePricingResources } from '@/lib/billing/upsert-stripe-pricing-resources'
import { upsertStripeSubscription } from '@/lib/billing/upsert-stripe-subscription'
import { createConsumerApiKey } from '@/lib/create-consumer-api-key'

import { aclPublicProject } from '../acl-public-project'

export async function upsertConsumer(
  c: AuthenticatedHonoContext,
  {
    plan,
    deploymentId,
    consumerId
  }: {
    plan?: string
    deploymentId?: string
    consumerId?: string
  }
) {
  assert(
    consumerId || deploymentId,
    400,
    'Internal error: upsertConsumer missing required "deploymentId" or "consumerId"'
  )
  const logger = c.get('logger')
  const userId = c.get('userId')
  let deployment: RawDeployment | undefined
  let project: RawProject | undefined
  let projectId: string | undefined

  async function initDeploymentAndProject() {
    assert(deploymentId, 400, 'Missing required "deploymentId"')
    if (deployment && project) {
      // Already initialized
      return
    }

    deployment = await db.query.deployments.findFirst({
      where: eq(schema.deployments.id, deploymentId),
      with: {
        project: true
      }
    })
    assert(deployment, 404, `Deployment not found "${deploymentId}"`)
    assert(
      !deployment.deletedAt,
      410,
      `Deployment has been deleted by its owner "${deployment.id}"`
    )

    project = deployment.project!
    assert(
      project,
      404,
      `Project not found "${projectId}" for deployment "${deploymentId}"`
    )
    aclPublicProject(project)

    // Validate the deployment only after we're sure the project is publicly
    // accessible.
    assert(
      !deployment.deletedAt,
      410,
      `Deployment has been deleted by its owner "${deployment.id}"`
    )

    projectId = project.id
  }

  if (deploymentId) {
    await initDeploymentAndProject()
  }

  if (!consumerId) {
    assert(projectId, 400, 'Missing required "deploymentId"')
  }

  const [{ user, stripeCustomer }, existingConsumer] = await Promise.all([
    upsertStripeCustomer(c),

    db.query.consumers.findFirst({
      where: consumerId
        ? eq(schema.consumers.id, consumerId)
        : and(
            eq(schema.consumers.userId, userId),
            eq(schema.consumers.projectId, projectId!)
          )
    })
  ])

  if (consumerId) {
    assert(existingConsumer, 404, `Consumer not found "${consumerId}"`)
    assert(existingConsumer.id === consumerId, 403)
    await acl(c, existingConsumer, { label: 'Consumer' })

    if (projectId) {
      assert(
        existingConsumer.projectId === projectId,
        400,
        `Deployment "${deploymentId}" does not belong to project "${existingConsumer.projectId}" for consumer "${consumerId}"`
      )
    }

    deploymentId ??= existingConsumer.deploymentId
    projectId ??= existingConsumer.projectId
  } else {
    assert(
      !existingConsumer,
      409,
      `User "${user.email}" already has a subscription for project "${projectId ?? ''}"`
    )
  }

  assert(deploymentId)
  assert(projectId)

  assert(
    !existingConsumer ||
      !existingConsumer.isStripeSubscriptionActive ||
      existingConsumer.plan !== plan ||
      existingConsumer.deploymentId !== deploymentId,
    409,

    plan
      ? `User "${user.email}" already has an active subscription to plan "${plan}" for project "${projectId}"`
      : `User "${user.email}" already has cancelled their subscription for project "${projectId}"`
  )

  await initDeploymentAndProject()
  assert(deployment, 500, `Error getting deployment "${deploymentId}"`)
  assert(project, 500, `Error getting project "${projectId}"`)

  if (plan) {
    const pricingPlan = deployment.pricingPlans.find((p) => p.slug === plan)
    assert(
      pricingPlan,
      400,
      `Pricing plan "${plan}" not found for deployment "${deploymentId}"`
    )
  }

  let consumer = existingConsumer

  if (consumer) {
    ;[consumer] = await db
      .update(schema.consumers)
      .set({
        plan,
        deploymentId
      })
      .where(eq(schema.consumers.id, consumer.id))
      .returning()
  } else {
    ;[consumer] = await db
      .insert(schema.consumers)
      .values({
        plan,
        userId,
        projectId,
        deploymentId,
        token: await createConsumerApiKey(),
        _stripeCustomerId: stripeCustomer.id
      })
      .returning()
  }

  assert(consumer, 500, 'Error creating consumer')

  // Ensure that all Stripe pricing resources exist for this deployment
  await upsertStripePricingResources({ deployment, project })

  // Ensure that customer and default source are created on the stripe connect account
  // TODO: is this necessary?
  // consumer._stripeAccount = project._stripeAccount
  await upsertStripeConnectCustomer({ stripeCustomer, consumer, project })

  logger.info('SUBSCRIPTION', existingConsumer ? 'UPDATE' : 'CREATE', {
    project,
    deployment,
    consumer
  })

  const { subscription, consumer: updatedConsumer } =
    await upsertStripeSubscription(c, {
      consumer,
      user,
      project,
      deployment
    })
  logger.info('subscription', subscription)

  return updatedConsumer
}


================================================
FILE: apps/api/src/lib/consumers/utils.ts
================================================
import type { RawConsumerUpdate } from '@/db'

// https://docs.stripe.com/api/subscriptions/object#subscription_object-status
const stripeValidSubscriptionStatuses = new Set([
  'active',
  'trialing',
  'incomplete',
  'past_due'
])

export function setConsumerStripeSubscriptionStatus(
  consumer: Pick<
    RawConsumerUpdate,
    'plan' | 'stripeStatus' | 'isStripeSubscriptionActive'
  >
) {
  consumer.isStripeSubscriptionActive =
    consumer.plan === 'free' ||
    (!!consumer.stripeStatus &&
      stripeValidSubscriptionStatuses.has(consumer.stripeStatus))
}


================================================
FILE: apps/api/src/lib/create-avatar.ts
================================================
import { identicon } from '@dicebear/collection'
import { createAvatar as createAvatarImpl } from '@dicebear/core'

const defaultAgenticAvatar =
  'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iODIiIGhlaWdodD0iODIiIHZpZXdCb3g9IjAgMCA4MiA4MiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGNpcmNsZSBjeD0iNDEiIGN5PSI0MSIgcj0iNDEiIGZpbGw9ImJsYWNrIi8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNMjIuNDU3OCA2MS41MzA4QzE5LjMyNTMgNjEuNTcyIDE2LjIxNDIgNjEuNTMwNSAxMy4xMjQ1IDYxLjQwNjNDMjIuODUwNiA0Ni4wMjAxIDMyLjU3OCAzMC42MzA2IDQyLjMwNjcgMTUuMjM3NEM0My43MDIxIDEzLjgwMjEgNDUuMjU3NyAxMy42MTU0IDQ2Ljk3MzQgMTQuNjc3NEM0OS4xMDY5IDE2LjQ3MjcgNDkuNzQ5OSAxOC42OTE5IDQ4LjkwMjMgMjEuMzM1MkM0Ny4zOTg4IDIzLjg4NjMgNDUuODY0IDI2LjQxNjcgNDQuMjk3OCAyOC45MjYzQzM3Ljc0MzcgMzkuMjk2NyAzMS4xODk3IDQ5LjY2NzEgMjQuNjM1NiA2MC4wMzc0QzI0LjE2MSA2MC45MDY4IDIzLjQzNTEgNjEuNDA0NiAyMi40NTc4IDYxLjUzMDhaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTQ3LjM0NjYgMzAuOTE3NUM0Ny42MjU0IDMxLjA1MDQgNDcuODUzNiAzMS4yNTc3IDQ4LjAzMSAzMS41Mzk3QzU0Ljk3NDcgNDEuNTkwMSA2MS45NjQzIDUxLjYwNzkgNjguOTk5OSA2MS41OTNDNjUuOTMwMyA2MS42NzYgNjIuODYwNyA2MS42NzYgNTkuNzkxIDYxLjU5M0M1OC45MTk4IDYxLjM5NiA1OC4xOTM5IDYwLjk2MDUgNTcuNjEzMyA2MC4yODY0QzUzLjI0NjkgNTMuOTE4IDQ4Ljg0OTkgNDcuNTcxNCA0NC40MjIyIDQxLjI0NjRDNDMuOTU3NyA0MC41NzM2IDQzLjU0MyAzOS44Njg0IDQzLjE3NzcgMzkuMTMwOEM0My4wMjUgMzguMTc3NiA0My4yMzI1IDM3LjMwNjUgNDMuNzk5OSAzNi41MTc1QzQ1LjAxMzQgMzQuNjYzMSA0Ni4xOTU2IDMyLjc5NjUgNDcuMzQ2NiAzMC45MTc1WiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01NC41NjQ1IDYxLjQwNjNDNTEuMDE4NSA2MS41MzA1IDQ3LjQ1MSA2MS41NzE5IDQzLjg2MjMgNjEuNTMwN0M0Mi45MTQ5IDYwLjEwNTUgNDEuOTQwMSA1OC42OTUyIDQwLjkzNzggNTcuMjk5NkM0MC4wMTM2IDU4LjY5MjUgMzkuMTIxNyA2MC4xMDI5IDM4LjI2MjMgNjEuNTMwN0MzNC43NTY0IDYxLjU3MTkgMzEuMjcyIDYxLjUzMDUgMjcuODA5IDYxLjQwNjNDMzEuMDc4OSA1Ni4yNDgxIDM0LjM3NjYgNTEuMTA0NCAzNy43MDIzIDQ1Ljk3NTJDMzkuMDUwMyA0NC41NjI5IDQwLjY0NzQgNDQuMjEwMyA0Mi40OTM0IDQ0LjkxNzRDNDIuOTgzNyA0NS4xNTIxIDQzLjQxOTMgNDUuNDYzMiA0My44MDAxIDQ1Ljg1MDdDNDcuNDE1NyA1MS4wMjEgNTEuMDAzOCA1Ni4yMDYzIDU0LjU2NDUgNjEuNDA2M1oiIGZpbGw9IndoaXRlIi8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNMTMuMTI0NCA2MS40MDYzQzE2LjIxNDIgNjEuNTMwNSAxOS4zMjUzIDYxLjU3MTkgMjIuNDU3OCA2MS41MzA4QzE5LjMyNTUgNjEuNjk2MSAxNi4xNzMgNjEuNjk2MSAxMyA2MS41MzA4QzEzLjAxNTQgNjEuNDU1MiAxMy4wNTY5IDYxLjQxMzggMTMuMTI0NCA2MS40MDYzWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0yNy44MDg5IDYxLjQwNjNDMzEuMjcxOSA2MS41MzA1IDM0Ljc1NjQgNjEuNTcxOSAzOC4yNjIyIDYxLjUzMDhDMzQuNzU2NiA2MS42OTYxIDMxLjIzMDcgNjEuNjk2MSAyNy42ODQ0IDYxLjUzMDhDMjcuNjk5OSA2MS40NTUyIDI3Ljc0MTMgNjEuNDEzOCAyNy44MDg5IDYxLjQwNjNaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTU0LjU2NDQgNjEuNDA2M0M1NC42MzIgNjEuNDEzOCA1NC42NzM0IDYxLjQ1NTIgNTQuNjg4OCA2MS41MzA4QzUxLjA1OTYgNjEuNjk2MyA0Ny40NTA3IDYxLjY5NjMgNDMuODYyMiA2MS41MzA4QzQ3LjQ1MDkgNjEuNTcxOSA1MS4wMTg0IDYxLjUzMDUgNTQuNTY0NCA2MS40MDYzWiIgZmlsbD0id2hpdGUiLz4KPC9zdmc+Cg=='

const defaultDevAgenticAvatar =
  'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iOTYiIGhlaWdodD0iOTYiIHZpZXdCb3g9IjAgMCA5NiA5NiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGNpcmNsZSBjeD0iNDgiIGN5PSI0OCIgcj0iNDgiIGZpbGw9IiM4ODg4ODgiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0yNi4yOTIyIDczLjIwNjdDMjIuNjI0OCA3My4yNTUgMTguOTgyNSA3My4yMDY1IDE1LjM2NTMgNzMuMDYxMUMyNi43NTIgNTUuMDQ4IDM4LjE0MDIgMzcuMDMwOSA0OS41Mjk5IDE5LjAwOTdDNTEuMTYzNSAxNy4zMjkzIDUyLjk4NDcgMTcuMTEwNyA1NC45OTMzIDE4LjM1NDFDNTcuNDkxIDIwLjQ1NTggNTguMjQzOCAyMy4wNTM5IDU3LjI1MTUgMjYuMTQ4NUM1NS40OTEzIDI5LjEzNTIgNTMuNjk0NSAzMi4wOTc1IDUxLjg2MDkgMzUuMDM1N0M0NC4xODc4IDQ3LjE3NjYgMzYuNTE0OSA1OS4zMTc2IDI4Ljg0MTcgNzEuNDU4NUMyOC4yODYxIDcyLjQ3NjMgMjcuNDM2MyA3My4wNTkgMjYuMjkyMiA3My4yMDY3WiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01NS40MzAyIDM3LjM2NjhDNTUuNzU2NiAzNy41MjI0IDU2LjAyMzcgMzcuNzY1MSA1Ni4yMzE1IDM4LjA5NTJDNjQuMzYwNiA0OS44NjE1IDcyLjU0MzcgNjEuNTg5NyA4MC43ODA0IDczLjI3OTZDNzcuMTg2NyA3My4zNzY4IDczLjU5MzEgNzMuMzc2OCA2OS45OTkzIDczLjI3OTZDNjguOTc5MyA3My4wNDkgNjguMTI5NSA3Mi41MzkxIDY3LjQ0OTcgNzEuNzQ5OUM2Mi4zMzc5IDY0LjI5NDMgNTcuMTkwMiA1Ni44NjQgNTIuMDA2NSA0OS40NTkxQzUxLjQ2MjcgNDguNjcxNSA1MC45NzcyIDQ3Ljg0NTkgNTAuNTQ5NiA0Ni45ODI0QzUwLjM3MDggNDUuODY2NCA1MC42MTM3IDQ0Ljg0NjYgNTEuMjc4IDQzLjkyMjlDNTIuNjk4NiA0MS43NTE5IDU0LjA4MjcgMzkuNTY2NiA1NS40MzAyIDM3LjM2NjhaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTYzLjg4MDMgNzMuMDYxQzU5LjcyODggNzMuMjA2NCA1NS41NTIzIDczLjI1NSA1MS4zNTA5IDczLjIwNjdDNTAuMjQxNyA3MS41MzgxIDQ5LjEwMDUgNjkuODg3IDQ3LjkyNzEgNjguMjUzMkM0Ni44NDUxIDY5Ljg4NCA0NS44MDA5IDcxLjUzNTEgNDQuNzk0OCA3My4yMDY3QzQwLjY5MDQgNzMuMjU1IDM2LjYxMSA3My4yMDY0IDMyLjU1NjcgNzMuMDYxQzM2LjM4NDkgNjcuMDIyMSA0MC4yNDU3IDYxLjAwMDMgNDQuMTM5MiA1NC45OTUzQzQ1LjcxNzMgNTMuMzQxOSA0Ny41ODcxIDUyLjkyOTIgNDkuNzQ4MyA1My43NTdDNTAuMzIyMyA1NC4wMzE3IDUwLjgzMjIgNTQuMzk2IDUxLjI3OCA1NC44NDk3QzU1LjUxMDkgNjAuOTAyNyA1OS43MTE3IDY2Ljk3MzIgNjMuODgwMyA3My4wNjFaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTE1LjM2NTIgNzMuMDYxMUMxOC45ODI1IDczLjIwNjUgMjIuNjI0NyA3My4yNTUgMjYuMjkyMSA3My4yMDY3QzIyLjYyNSA3My40MDA0IDE4LjkzNDIgNzMuNDAwNCAxNS4yMTk1IDczLjIwNjdDMTUuMjM3NiA3My4xMTgzIDE1LjI4NjEgNzMuMDY5OCAxNS4zNjUyIDczLjA2MTFaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTMyLjU1NjggNzMuMDYxMUMzNi42MTExIDczLjIwNjUgNDAuNjkwNCA3My4yNTUgNDQuNzk0OCA3My4yMDY3QzQwLjY5MDcgNzMuNDAwNCAzNi41NjI5IDczLjQwMDQgMzIuNDExMSA3My4yMDY3QzMyLjQyOTIgNzMuMTE4MyAzMi40Nzc3IDczLjA2OTggMzIuNTU2OCA3My4wNjExWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik02My44ODAzIDczLjA2MTFDNjMuOTU5NCA3My4wNjk4IDY0LjAwNzkgNzMuMTE4MyA2NC4wMjYgNzMuMjA2N0M1OS43NzcxIDczLjQwMDUgNTUuNTUyIDczLjQwMDUgNTEuMzUwOSA3My4yMDY3QzU1LjU1MjMgNzMuMjU1IDU5LjcyODkgNzMuMjA2NSA2My44ODAzIDczLjA2MTFaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4='

export function createAvatar(seed: string): string {
  if (seed === 'info@agentic.so') {
    return defaultAgenticAvatar
  }

  if (seed === 'dev@agentic.so') {
    return defaultDevAgenticAvatar
  }

  return createAvatarImpl(identicon, { seed }).toDataUri()
}


================================================
FILE: apps/api/src/lib/create-consumer-api-key.ts
================================================
import { sha256 } from '@agentic/platform-core'

export async function createConsumerApiKey(): Promise<string> {
  const hash = await sha256()

  return `sk-${hash}`
}


================================================
FILE: apps/api/src/lib/deployments/get-deployment-by-id.ts
================================================
import { assert } from '@agentic/platform-core'

import { db, eq, type RawDeployment, schema } from '@/db'

/**
 * Finds the Deployment with the given id.
 *
 * Does not take care of ACLs.
 *
 * Returns `undefined` if not found.
 */
export async function getDeploymentById({
  deploymentId,
  ...dbQueryOpts
}: {
  deploymentId: string
  with?: {
    user?: true
    team?: true
    project?: true
  }
}): Promise<RawDeployment | undefined> {
  assert(deploymentId, 400, 'Missing required deployment id')

  const deployment = await db.query.deployments.findFirst({
    ...dbQueryOpts,
    where: eq(schema.deployments.id, deploymentId)
  })

  return deployment
}


================================================
FILE: apps/api/src/lib/deployments/normalize-deployment-version.ts
================================================
import { assert } from '@agentic/platform-core'
import semver from 'semver'

import type { RawProject } from '@/db'

export function normalizeDeploymentVersion({
  deploymentIdentifier,
  version: rawVersion,
  project
}: {
  deploymentIdentifier: string
  version: string
  project: RawProject
}): string | undefined {
  const version = semver.clean(rawVersion)
  assert(version, 400, `Invalid semver version "${rawVersion}"`)

  assert(
    semver.valid(version),
    400,
    `Invalid semver version "${version}" for deployment "${deploymentIdentifier}"`
  )

  const lastPublishedVersion = project.lastPublishedDeployment?.version
  assert(
    !lastPublishedVersion || semver.gt(version, lastPublishedVersion),
    400,
    `Semver version "${version}" must be greater than the current published version "${lastPublishedVersion}" for deployment "${deploymentIdentifier}"`
  )

  return version
}


================================================
FILE: apps/api/src/lib/deployments/publish-deployment.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import { db, eq, type RawDeployment, schema } from '@/db'
import { acl } from '@/lib/acl'

import { normalizeDeploymentVersion } from './normalize-deployment-version'

export async function publishDeployment(
  ctx: AuthenticatedHonoContext,
  {
    deployment,
    version: rawVersion
  }: {
    deployment: RawDeployment
    version: string
  }
): Promise<RawDeployment> {
  const project = await db.query.projects.findFirst({
    where: eq(schema.projects.id, deployment.projectId),
    with: {
      lastPublishedDeployment: true
    }
  })
  assert(project, 404, `Project not found "${deployment.projectId}"`)
  await acl(ctx, project, { label: 'Project' })

  const version = normalizeDeploymentVersion({
    deploymentIdentifier: deployment.identifier,
    project,
    version: rawVersion
  })

  // TODO: enforce additional semver constraints
  // - pricing changes require major version update
  // - deployment shouldn't already be published?
  // - any others?

  // Update the deployment and project together in a transaction
  const [[updatedDeployment]] = await db.transaction(async (tx) => {
    return Promise.all([
      // Update the deployment
      tx
        .update(schema.deployments)
        .set({
          published: true,
          version
        })
        .where(eq(schema.deployments.id, deployment.id))
        .returning(),

      // Update the project
      tx
        .update(schema.projects)
        .set({
          name: deployment.name,
          lastPublishedDeploymentId: deployment.id,
          lastPublishedDeploymentVersion: version
        })
        .where(eq(schema.projects.id, project.id))

      // TODO: add publishDeploymentLogEntry
    ])
  })
  assert(
    updatedDeployment,
    500,
    `Failed to update deployment "${deployment.id}"`
  )

  return updatedDeployment
}


================================================
FILE: apps/api/src/lib/deployments/try-get-deployment-by-identifier.ts
================================================
import type { DefaultHonoContext } from '@agentic/platform-hono'
import { assert } from '@agentic/platform-core'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'

import {
  and,
  db,
  deploymentIdSchema,
  eq,
  type RawDeployment,
  schema
} from '@/db'
import { setPublicCacheControl } from '@/lib/cache-control'

import type { AuthenticatedHonoContext } from '../types'

/**
 * Attempts to find the Deployment matching the given deployment ID or
 * identifier.
 *
 * Throws a HTTP 404 error if not found.
 *
 * Does not take care of ACLs.
 */
export async function tryGetDeploymentByIdentifier(
  ctx: AuthenticatedHonoContext | DefaultHonoContext,
  {
    deploymentIdentifier,
    strict = false,
    ...dbQueryOpts
  }: {
    deploymentIdentifier: string
    strict?: boolean
    with?: {
      user?: true
      team?: true
      project?: true
    }
  }
): Promise<RawDeployment> {
  assert(deploymentIdentifier, 400, 'Missing required deployment identifier')

  // First check if the identifier is a deployment ID
  if (deploymentIdSchema.safeParse(deploymentIdentifier).success) {
    const deployment = await db.query.deployments.findFirst({
      ...dbQueryOpts,
      where: eq(schema.deployments.id, deploymentIdentifier)
    })
    assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
    setPublicCacheControl(ctx.res, '1h')
    return deployment
  }

  const parsedDeploymentIdentifier = parseDeploymentIdentifier(
    deploymentIdentifier,
    { strict }
  )

  const { projectIdentifier, deploymentHash, deploymentVersion } =
    parsedDeploymentIdentifier
  deploymentIdentifier = parsedDeploymentIdentifier.deploymentIdentifier

  if (deploymentHash) {
    const deployment = await db.query.deployments.findFirst({
      ...dbQueryOpts,
      where: eq(schema.deployments.identifier, deploymentIdentifier)
    })
    assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
    setPublicCacheControl(ctx.res, '1h')

    return deployment
  } else if (deploymentVersion) {
    const project = await db.query.projects.findFirst({
      where: eq(schema.projects.identifier, projectIdentifier)
    })
    assert(project, 404, `Project not found "${projectIdentifier}"`)

    if (deploymentVersion === 'latest') {
      const deploymentId =
        project.lastPublishedDeploymentId || project.lastDeploymentId
      assert(
        deploymentId,
        404,
        `Project has no published deployments (referenced by "${deploymentIdentifier}")`
      )

      const deployment = await db.query.deployments.findFirst({
        ...dbQueryOpts,
        where: eq(schema.deployments.id, deploymentId)
      })
      assert(
        deployment,
        404,
        `Deployment not found "${project.lastPublishedDeploymentId}" (referenced by "${deploymentIdentifier}")`
      )
      setPublicCacheControl(ctx.res, '10s')

      return deployment
    } else if (deploymentVersion === 'dev') {
      assert(
        project.lastDeploymentId,
        404,
        `Project has no published deployments (referenced by "${deploymentIdentifier}")`
      )

      const deployment = await db.query.deployments.findFirst({
        ...dbQueryOpts,
        where: eq(schema.deployments.id, project.lastDeploymentId)
      })
      assert(
        deployment,
        404,
        `Deployment not found "${project.lastDeploymentId}" (referenced by "${deploymentIdentifier}")`
      )
      setPublicCacheControl(ctx.res, '10s')

      return deployment
    } else {
      const deployment = await db.query.deployments.findFirst({
        ...dbQueryOpts,
        where: and(
          eq(schema.deployments.projectId, project.id),
          eq(schema.deployments.version, deploymentVersion)
        )
      })
      assert(deployment, 404, `Deployment not found "${deploymentIdentifier}"`)
      setPublicCacheControl(ctx.res, '1h')

      return deployment
    }
  }

  assert(false, 400, `Invalid Deployment identifier "${deploymentIdentifier}"`)
}


================================================
FILE: apps/api/src/lib/ensure-auth-user.ts
================================================
import { assert } from '@agentic/platform-core'

import type { AuthenticatedHonoContext } from '@/lib/types'
import { db, eq, type RawUser, schema } from '@/db'

export async function ensureAuthUser(
  ctx: AuthenticatedHonoContext
): Promise<RawUser> {
  let user = ctx.get('user')
  if (user) return user

  const userId = ctx.get('userId')
  assert(userId, 401, 'Unauthorized')

  user = await db.query.users.findFirst({
    where: eq(schema.users.id, userId)
  })
  assert(user, 401, 'Unauthorized')
  ctx.set('user', user)

  return user
}


================================================
FILE: apps/api/src/lib/ensure-unique-namespace.ts
================================================
import { assert, sha256 } from '@agentic/platform-core'

import { db, eq, schema } from '@/db'

export async function ensureUniqueNamespace(
  namespace: string,
  { label = 'Namespace' }: { label?: string } = {}
) {
  namespace = namespace.toLocaleLowerCase()

  const [existingTeam, existingUser] = await Promise.all([
    db.query.teams.findFirst({
      where: eq(schema.teams.slug, namespace)
    }),

    db.query.users.findFirst({
      where: eq(schema.users.username, namespace)
    })
  ])

  assert(
    !existingUser && !existingTeam,
    409,
    `${label} "${namespace}" is not available`
  )
}

export async function getUniqueNamespace(
  namespace?: string,
  { label = 'Namespace' }: { label?: string } = {}
) {
  namespace ??= `${label}_${(await sha256()).slice(0, 24)}`
  namespace = namespace
    .replaceAll(/[^a-zA-Z0-9_-]/g, '')
    .toLowerCase()
    .slice(0, schema.namespaceMaxLength - 1)

  let currentNamespace = namespace
  let attempts = 0

  do {
    try {
      await ensureUniqueNamespace(namespace, { label })

      return currentNamespace
    } catch (err) {
      if (++attempts > 10) {
        throw err
      }

      const suffix = (await sha256()).slice(0, 8)
      currentNamespace = `${namespace.slice(0, schema.namespaceMaxLength - 1 - suffix.length)}${suffix}`
    }
  } while (true)
}


================================================
FILE: apps/api/src/lib/env.ts
================================================
import type { Simplify } from 'type-fest'
import { parseZodSchema } from '@agentic/platform-core'
import {
  envSchema as baseEnvSchema,
  parseEnv as parseBaseEnv
} from '@agentic/platform-hono'
import { z } from 'zod'

export const envSchema = baseEnvSchema
  .extend({
    DATABASE_URL: z.string().url(),

    AGENTIC_WEB_BASE_URL: z.string().url(),
    AGENTIC_GATEWAY_BASE_URL: z.string().url(),
    AGENTIC_STORAGE_BASE_URL: z
      .string()
      .url()
      .optional()
      .default('https://storage.agentic.so'),

    JWT_SECRET: z.string().nonempty(),

    PORT: z.coerce.number().default(3001),

    STRIPE_SECRET_KEY: z.string().nonempty(),
    STRIPE_WEBHOOK_SECRET: z.string().nonempty(),

    GITHUB_CLIENT_ID: z.string().nonempty(),
    GITHUB_CLIENT_SECRET: z.string().nonempty(),

    RESEND_API_KEY: z.string().nonempty(),

    // Used to make admin API calls from the API gateway
    AGENTIC_ADMIN_API_KEY: z.string().nonempty(),

    // Used to simplify recreating the demo `@agentic/search` project during
    // development while we're frequently resetting the database
    AGENTIC_SEARCH_PROXY_SECRET: z.string().nonempty(),

    S3_BUCKET: z.string().nonempty().optional().default('agentic'),
    S3_REGION: z.string().nonempty().optional().default('auto'),
    S3_ENDPOINT: z.string().nonempty().url(),
    S3_ACCESS_KEY_ID: z.string().nonempty(),
    S3_ACCESS_KEY_SECRET: z.string().nonempty()
  })
  .strip()
export type RawEnv = z.infer<typeof envSchema>

export function parseEnv(inputEnv: Record<string, unknown>) {
  const baseEnv = parseBaseEnv({
    SERVICE: 'api',
    ...inputEnv
  })

  const env = parseZodSchema(
    envSchema,
    { ...inputEnv, ...baseEnv },
    {
      error: 'Invalid environment variables'
    }
  )

  const isStripeLive = env.STRIPE_SECRET_KEY.startsWith('sk_live_')
  const apiBaseUrl = baseEnv.isProd
    ? 'https://api.agentic.so'
    : 'http://localhost:3001'

  return {
    ...baseEnv,
    ...env,
    isStripeLive,
    apiBaseUrl
  }
}

export type Env = Simplify<ReturnType<typeof parseEnv>>

// eslint-disable-next-line no-process-env
export const env = parseEnv(process.env)


================================================
FILE: apps/api/src/lib/exit-hooks.ts
================================================
import { promisify } from 'node:util'

import type { ServerType } from '@hono/node-server'
import * as Sentry from '@sentry/node'
import { asyncExitHook } from 'exit-hook'
import restoreCursor from 'restore-cursor'

import { db } from '@/db'

export function initExitHooks({
  server,
  timeoutMs = 10_000
}: {
  server: ServerType
  timeoutMs?: number
}) {
  // Gracefully restore the cursor if run from a TTY
  restoreCursor()

  // Gracefully shutdown the HTTP server
  asyncExitHook(
    async function shutdownServerExitHook() {
      try {
        await promisify(server.close)()
      } catch {
        // TODO
      }
    },
    {
      wait: timeoutMs
    }
  )

  // Gracefully shutdown the postgres database connection
  asyncExitHook(
    async function shutdownDbExitHook() {
      try {
        if ('end' in db.$client) {
          await db.$client.end({ timeout: timeoutMs })
        }
      } catch {
        // TODO
      }
    },
    {
      wait: timeoutMs
    }
  )

  // Gracefully flush Sentry events
  asyncExitHook(
    async function flushSentryExitHook() {
      await Sentry.flush(timeoutMs)
    },
    {
      wait: timeoutMs
    }
  )

  // TODO: On Node.js, log unhandledRejection, uncaughtException, and warning events
}


================================================
FILE: apps/api/src/lib/external/github.ts
================================================
import ky from 'ky'
import { Octokit } from 'octokit'

import { env } from '@/lib/env'

const USER_AGENT = 'agentic-platform'

/**
 * GitHub (user-level) OAuth token response.
 *
 * @see https://docs.github.com/apps/oauth
 */
export interface GitHubUserTokenResponse {
  /**
   * The user access token (always starts with `ghu_`).
   * Example: `ghu_xxx…`
   */
  access_token: string

  /**
   * Seconds until `access_token` expires.
   * Omitted (`undefined`) if you’ve disabled token expiration.
   * Constant `28800` (8 hours) when present.
   */
  expires_in?: number

  /**
   * Refresh token for renewing the user access token (starts with `ghr_`).
   * Omitted (`undefined`) if you’ve disabled token expiration.
   */
  refresh_token?: string

  /**
   * Seconds until `refresh_token` expires.
   * Omitted (`undefined`) if you’ve disabled token expiration.
   * Constant `15897600` (6 months) when present.
   */
  refresh_token_expires_in?: number

  /**
   * Scopes granted to the token.
   * Always an empty string because the token is limited to
   * the intersection of app-level and user-level permissions.
   */
  scope: ''

  /**
   * Token type – always `'bearer'`.
   */
  token_type: 'bearer'
}

export function getGitHubClient({
  accessToken
}: {
  accessToken: string
}): Octokit {
  return new Octokit({ auth: accessToken })
}

export async function exchangeGitHubOAuthCodeForAccessToken({
  code,
  clientId = env.GITHUB_CLIENT_ID,
  clientSecret = env.GITHUB_CLIENT_SECRET,
  redirectUri
}: {
  code: string
  clientId?: string
  clientSecret?: string
  redirectUri?: string
}): Promise<GitHubUserTokenResponse> {
  return ky
    .post('https://github.com/login/oauth/access_token', {
      json: {
        code,
        client_id: clientId,
        client_secret: clientSecret,
        redirect_uri: redirectUri
      },
      headers: {
        'user-agent': USER_AGENT
      }
    })
    .json<GitHubUserTokenResponse>()
}


================================================
FILE: apps/api/src/lib/external/resend.ts
================================================
import { ResendEmailClient } from '@agentic/platform-emails'

import { env } from '@/lib/env'

export const resend = new ResendEmailClient({
  apiKey: env.RESEND_API_KEY
})


================================================
FILE: apps/api/src/lib/external/sentry.ts
================================================
import * as Sentry from '@sentry/node'

// This MUST be run before anything else (imported first in the root file).
// No other imports (like env) should be imported in this file.
Sentry.init({
  dsn: process.env.SENTRY_DSN, // eslint-disable-line no-process-env
  environment: process.env.ENVIRONMENT || 'development', // eslint-disable-line no-process-env
  integrations: [Sentry.extraErrorDataIntegration()],
  tracesSampleRate: 1.0,
  sendDefaultPii: true
})


================================================
FILE: apps/api/src/lib/external/stripe.ts
================================================
import Stripe from 'stripe'

import { env } from '@/lib/env'

const version = '2025-06-30.basil'

export const stripe = new Stripe(env.STRIPE_SECRET_KEY, {
  apiVersion: version,
  appInfo: {
    name: 'transitive-bullshit/agentic',
    version,
    url: 'https://agentic.so'
  }
})


================================================
FILE: apps/api/src/lib/middleware/authenticate.ts
================================================
import { assert } from '@agentic/platform-core'
import { authUserSchema } from '@agentic/platform-types'
import { createMiddleware } from 'hono/factory'
import { verify } from 'hono/jwt'

import type { RawUser } from '@/db'
import type { AuthenticatedHonoEnv } from '@/lib/types'
import { env } from '@/lib/env'
import { timingSafeCompare } from '@/lib/utils'

export const authenticate = createMiddleware<AuthenticatedHonoEnv>(
  async function authenticateMiddleware(ctx, next) {
    const credentials = ctx.req.raw.headers.get('Authorization')
    assert(credentials, 401, 'Unauthorized')

    const parts = credentials.split(/\s+/)
    assert(
      parts.length === 1 ||
        (parts.length === 2 && parts[0]?.toLowerCase() === 'bearer'),
      401,
      'Unauthorized'
    )
    const token = parts.at(-1)
    assert(token, 401, 'Unauthorized')

    // TODO: Use a more secure way to authenticate gateway admin requests.
    if (timingSafeCompare(token, env.AGENTIC_ADMIN_API_KEY)) {
      ctx.set('userId', 'admin')
      ctx.set('user', {
        id: 'admin',
        name: 'Admin',
        username: 'admin',
        role: 'admin',
        email: 'admin@agentic.so',
        isEmailVerified: true,
        image: undefined,
        stripeCustomerId: undefined,
        createdAt: new Date().toISOString(),
        updatedAt: new Date().toISOString(),
        deletedAt: undefined
      } as RawUser)
    } else {
      const payload = await verify(token, env.JWT_SECRET)
      assert(payload, 401, 'Unauthorized')

      const parsedAuthUser = authUserSchema.safeParse(payload)
      assert(parsedAuthUser.success, 401, 'Unauthorized')
      ctx.set('userId', parsedAuthUser.data.id)
    }

    await next()
  }
)


================================================
FILE: apps/api/src/lib/middleware/index.ts
================================================
export * from './authenticate'
export * from './me'
export * from './team'
export {
  accessLogger,
  compress,
  cors,
  init,
  responseTime,
  sentry,
  unless
} from '@agentic/platform-hono'


================================================
FILE: apps/api/src/lib/middleware/me.ts
================================================
import { createMiddleware } from 'hono/factory'

import type { AuthenticatedHonoEnv } from '@/lib/types'

import { ensureAuthUser } from '../ensure-auth-user'

export const me = createMiddleware<AuthenticatedHonoEnv>(
  async function meMiddleware(ctx, next) {
    const regex = /^\/(me)(\/|$)/

    if (regex.test(ctx.req.path)) {
      const user = await ensureAuthUser(ctx)

      if (user) {
        // TODO: redirect instead?
        ctx.req.path = ctx.req.path.replace(regex, `/users/${user.id}$2`)
      }
    }

    await next()
  }
)


================================================
FILE: apps/api/src/lib/middleware/team.ts
================================================
import { assert } from '@agentic/platform-core'
import { createMiddleware } from 'hono/factory'

import type { AuthenticatedHonoEnv } from '@/lib/types'
import { and, db, eq, schema } from '@/db'
import { aclTeamMember } from '@/lib/acl-team-member'

// TODO: Instead of accepting `teamId` query param, change the authenticate
// middleware to accept a different JWT payload and then use that to
// determine the intended user and/or team.

export const team = createMiddleware<AuthenticatedHonoEnv>(
  async function teamMiddleware(ctx, next) {
    const teamId = ctx.req.query('teamId')
    const userId = ctx.get('userId')

    if (teamId && userId) {
      const teamMember = await db.query.teamMembers.findFirst({
        where: and(
          eq(schema.teamMembers.teamId, teamId),
          eq(schema.teamMembers.userId, userId)
        )
      })
      assert(teamMember, 403, 'Unauthorized')

      await aclTeamMember(ctx, { teamMember })

      ctx.set('teamMember', teamMember)
    }

    await next()
  }
)


================================================
FILE: apps/api/src/lib/openapi-utils.ts
================================================
import { fromError } from 'zod-validation-error'

import type { HonoApp } from './types'

export const openapiErrorResponses = {
  400: {
    $ref: '#/components/responses/400'
  },
  401: {
    $ref: '#/components/responses/401'
  },
  403: {
    $ref: '#/components/responses/403'
  }
} as const

export const openapiErrorResponse404 = {
  404: {
    $ref: '#/components/responses/404'
  }
} as const

export const openapiErrorResponse409 = {
  409: {
    $ref: '#/components/responses/409'
  }
} as const

export const openapiErrorResponse410 = {
  410: {
    $ref: '#/components/responses/410'
  }
} as const

// No `as const` because zod openapi doesn't support readonly for `security`
export const openapiAuthenticatedSecuritySchemas = [
  {
    Bearer: []
  }
]

const openapiErrorContent = {
  'application/json': {
    schema: {
      type: 'object' as const,
      properties: {
        error: {
          type: 'string' as const
        },
        requestId: {
          type: 'string' as const
        }
      },
      required: ['error', 'requestId']
    }
  }
}

export function registerOpenAPIErrorResponses(app: HonoApp) {
  app.openAPIRegistry.registerComponent('responses', '400', {
    description: 'Bad Request',
    content: openapiErrorContent
  })

  app.openAPIRegistry.registerComponent('responses', '401', {
    description: 'Unauthorized',
    content: openapiErrorContent
  })

  app.openAPIRegistry.registerComponent('responses', '403', {
    description: 'Forbidden',
    content: openapiErrorContent
  })

  app.openAPIRegistry.registerComponent('responses', '404', {
    description: 'Not Found',
    content: openapiErrorContent
  })

  app.openAPIRegistry.registerComponent('responses', '409', {
    description: 'Conflict',
    content: openapiErrorContent
  })

  app.openAPIRegistry.registerComponent('responses', '410', {
    description: 'Gone',
    content: openapiErrorContent
  })
}

export function defaultHook(result: any, ctx: any) {
  if (!result.success) {
    const requestId = ctx.get('requestId')

    return ctx.json(
      {
        error: fromError(result.error).toString(),
        requestId
      },
      400
    )
  }
}


================================================
FILE: apps/api/src/lib/projects/try-get-project-by-identifier.ts
================================================
import { assert } from '@agentic/platform-core'
import { parseProjectIdentifier } from '@agentic/platform-validators'

import type { AuthenticatedHonoContext } from '@/lib/types'
import { db, eq, projectIdSchema, type RawProject, schema } from '@/db'

/**
 * Attempts to find the Project matching the given ID or identifier.
 *
 * Throws a HTTP 404 error if not found.
 *
 * Does not take care of ACLs.
 */
export async function tryGetProjectByIdentifier(
  ctx: AuthenticatedHonoContext,
  {
    projectIdentifier,
    strict = false,
    ...dbQueryOpts
  }: {
    projectIdentifier: string
    strict?: boolean
    with?: {
      user?: true
      team?: true
      lastPublishedproject?: true
      lastproject?: true
    }
  }
): Promise<RawProject> {
  assert(projectIdentifier, 400, 'Missing required project identifier')

  // First check if the identifier is a project ID
  if (projectIdSchema.safeParse(projectIdentifier).success) {
    const project = await db.query.projects.findFirst({
      ...dbQueryOpts,
      where: eq(schema.projects.id, projectIdentifier)
    })
    assert(project, 404, `Project not found "${projectIdentifier}"`)
    return project
  }

  const parsedProjectIdentifier = parseProjectIdentifier(projectIdentifier, {
    strict
  })
  projectIdentifier = parsedProjectIdentifier.projectIdentifier

  const project = await db.query.projects.findFirst({
    ...dbQueryOpts,
    where: eq(schema.projects.identifier, projectIdentifier)
  })
  assert(project, 404, `Project not found "${projectIdentifier}"`)

  return project
}


================================================
FILE: apps/api/src/lib/storage.test.ts
================================================
import { describe, expect, test } from 'vitest'

import {
  deleteStorageObject,
  getStorageObject,
  putStorageObject,
  uploadFileUrlToStorage
} from './storage'

describe('Storage', () => {
  test('putObject, getObject, deleteObject', async () => {
    await putStorageObject('test.txt', 'hello world', {
      ContentType: 'text/plain'
    })

    const obj = await getStorageObject('test.txt')
    expect(obj.ContentType).toEqual('text/plain')

    const body = await obj.Body?.transformToString()
    expect(body).toEqual('hello world')

    const res = await deleteStorageObject('test.txt')
    expect(res.$metadata.httpStatusCode).toEqual(204)
  })

  test('uploadFileUrlToStorage url', async () => {
    const url = await uploadFileUrlToStorage(
      'https://agentic.so/agentic-icon-circle-light.svg',
      {
        prefix: '@dev/test'
      }
    )

    expect(url).toBeTruthy()
    expect(new URL(url).origin).toEqual('https://storage.agentic.so')
    expect(url).toMatchSnapshot()
  })

  test('uploadFileUrlToStorage data-uri', async () => {
    const url = await uploadFileUrlToStorage(
      'data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%22400%22%20height%3D%22400%22%20viewBox%3D%220%200%20124%20124%22%20fill%3D%22none%22%3E%3Crect%20width%3D%22124%22%20height%3D%22124%22%20rx%3D%2224%22%20fill%3D%22%23F97316%22%2F%3E%3Cpath%20d%3D%22M19.375%2036.7818V100.625C19.375%20102.834%2021.1659%20104.625%2023.375%20104.625H87.2181C90.7818%20104.625%2092.5664%20100.316%2090.0466%2097.7966L26.2034%2033.9534C23.6836%2031.4336%2019.375%2033.2182%2019.375%2036.7818Z%22%20fill%3D%22white%22%2F%3E%3Ccircle%20cx%3D%2263.2109%22%20cy%3D%2237.5391%22%20r%3D%2218.1641%22%20fill%3D%22black%22%2F%3E%3Crect%20opacity%3D%220.4%22%20x%3D%2281.1328%22%20y%3D%2280.7198%22%20width%3D%2217.5687%22%20height%3D%2217.3876%22%20rx%3D%224%22%20transform%3D%22rotate(-45%2081.1328%2080.7198)%22%20fill%3D%22%23FDBA74%22%2F%3E%3C%2Fsvg%3E',
      {
        prefix: '@dev/test'
      }
    )

    expect(url).toBeTruthy()
    expect(new URL(url).origin).toEqual('https://storage.agentic.so')
    expect(url).toMatchSnapshot()
  })

  test('uploadFileUrlToStorage data-uri 2', async () => {
    const url = await uploadFileUrlToStorage(
      'data:application/octet-stream;base64,IyBUZXN0IEV2ZXJ5dGhpbmcgT3BlbkFQSQoKVGhpcyBpcyB0ZXN0aW5nICoqcmVhZG1lIHJlbmRlcmluZyoqLgoKIyMgTWlzYwoKLSBbIF0gSXRlbSAxCi0gWyBdIEl0ZW0gMgotIFt4XSBJdGVtIDMKCi0tLQoKLSBfaXRhbGljXwotICoqYm9sZCoqCi0gW2xpbmtdKGh0dHBzOi8vd3d3Lmdvb2dsZS5jb20pCi0gYGNvZGVgCgojIyBDb2RlCgpgYGB0cwpjb25zdCBhID0gMQoKZXhwb3J0IGZ1bmN0aW9uIGZvbygpIHsKICBjb25zb2xlLmxvZygnaGVsbG8gd29ybGQnKQp9CmBgYAoKIyMgSW1hZ2VzCgohW0ltYWdlXShodHRwczovL3BsYWNlaG9sZC5jby82MDB4NDAwKQo=',
      {
        prefix: '@dev/test'
      }
    )

    expect(url).toBeTruthy()
    expect(new URL(url).origin).toEqual('https://storage.agentic.so')
    expect(url).toMatchSnapshot()
  })
})


================================================
FILE: apps/api/src/lib/storage.ts
================================================
import { sha256 } from '@agentic/platform-core'
import {
  DeleteObjectCommand,
  type DeleteObjectCommandInput,
  GetObjectCommand,
  type GetObjectCommandInput,
  PutObjectCommand,
  type PutObjectCommandInput,
  S3Client
} from '@aws-sdk/client-s3'
import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
import { fileTypeFromBuffer } from 'file-type'
import ky from 'ky'
import { lookup as lookupMimeType } from 'mrmime'

import { env } from './env'

// This storage client is designed to work with any S3-compatible storage provider.
// For Cloudflare R2, see https://developers.cloudflare.com/r2/examples/aws/aws-sdk-js-v3/

const STORAGE_DOMAIN = 'storage.agentic.so'
const Bucket = env.S3_BUCKET

export const storageClient = new S3Client({
  region: env.S3_REGION,
  endpoint: env.S3_ENDPOINT,
  credentials: {
    accessKeyId: env.S3_ACCESS_KEY_ID,
    secretAccessKey: env.S3_ACCESS_KEY_SECRET
  },
  requestChecksumCalculation: 'WHEN_REQUIRED',
  responseChecksumValidation: 'WHEN_REQUIRED'
})

// This ensures that buckets are created automatically if they don't exist on
// Cloudflare R2. It won't affect other providers.
// @see https://developers.cloudflare.com/r2/examples/aws/custom-header/
storageClient.middlewareStack.add(
  (next, _) => async (args) => {
    const r = args.request as RequestInit
    r.headers = {
      'cf-create-bucket-if-missing': 'true',
      ...r.headers
    }

    return next(args)
  },
  { step: 'build', name: 'customHeaders' }
)

export async function getStorageObject(
  key: string,
  opts?: Omit<GetObjectCommandInput, 'Bucket' | 'Key'>
) {
  return storageClient.send(new GetObjectCommand({ Bucket, Key: key, ...opts }))
}

export async function putStorageObject(
  key: string,
  value: PutObjectCommandInput['Body'],
  opts?: Omit<PutObjectCommandInput, 'Bucket' | 'Key' | 'Body'>
) {
  return storageClient.send(
    new PutObjectCommand({ Bucket, Key: key, Body: value, ...opts })
  )
}

export async function deleteStorageObject(
  key: string,
  opts?: Omit<DeleteObjectCommandInput, 'Bucket' | 'Key'>
) {
  return storageClient.send(
    new DeleteObjectCommand({ Bucket, Key: key, ...opts })
  )
}

export function getStorageObjectInternalUrl(key: string) {
  return `${env.S3_ENDPOINT}/${Bucket}/${key}`
}

export function getStorageObjectPublicUrl(key: string) {
  return `${env.AGENTIC_STORAGE_BASE_URL}/${key}`
}

// TODO: Signed uploads don't seem to be working; getting a signature mismatch
// error, and no idea why. Switched to using non-presigned URL uploads for now,
// but this will be necessary in the future, for instance, for the web client
// to upload files.
export async function getStorageSignedUploadUrl(
  key: string,
  {
    expiresIn = 5 * 60 * 1000 // 5 minutes
  }: {
    expiresIn?: number
  } = {}
) {
  return getSignedUrl(
    storageClient,
    new PutObjectCommand({ Bucket, Key: key }),
    { expiresIn }
  )
}

export async function uploadFileUrlToStorage(
  inputUrl: string,
  {
    prefix
  }: {
    prefix: string
  }
): Promise<string> {
  let source: URL

  try {
    source = new URL(inputUrl)
  } catch {
    // Not a URL
    throw new Error(`Invalid source file URL: ${inputUrl}`)
  }

  if (source.hostname === STORAGE_DOMAIN) {
    // The source is already a public URL hosted on Agentic's blob storage.
    return source.toString()
  }

  const sourceBuffer = await ky.get(source).arrayBuffer()

  const [hash, inferredFileType] = await Promise.all([
    sha256(sourceBuffer),
    fileTypeFromBuffer(sourceBuffer)
  ])

  const maybeSourceExt = source.pathname.split('.').at(-1)
  const maybeSourceExt2 = maybeSourceExt
    ? /^[a-z]+$/i.test(maybeSourceExt)
      ? maybeSourceExt
      : undefined
    : undefined
  const maybeSourceMime =
    source.protocol === 'data:'
      ? source.pathname.split(',')[0]?.split(';')[0]
      : undefined
  const sourceExt0 =
    maybeSourceExt2 ??
    (maybeSourceMime && maybeSourceMime !== 'application/octet-stream'
      ? maybeSourceMime.split('/')[1]?.split('+')[0]
      : undefined)
  const sourceExt = sourceExt0 === 'markdown' ? 'md' : sourceExt0

  const fileType =
    inferredFileType ??
    (sourceExt
      ? {
          ext: sourceExt,
          mime: lookupMimeType(sourceExt)
        }
      : undefined)

  const filename = fileType?.ext ? `${hash}.${fileType.ext}` : hash
  const key = `${prefix}/${filename}`

  const publicObjectUrl = getStorageObjectPublicUrl(key)

  // console.log('uploading to r2', {
  //   key,
  //   source,
  //   sourceExt,
  //   maybeSourceMime,
  //   maybeSourceExt,
  //   maybeSourceExt2,
  //   inputUrl,
  //   fileType,
  //   publicObjectUrl
  // })

  try {
    // Check if the object already exists.
    await ky.head(publicObjectUrl)
  } catch {
    const body = Buffer.from(sourceBuffer)

    // Object doesn't exist yet, so upload it.
    try {
      await putStorageObject(key, body, {
        ContentType: fileType?.mime ?? 'application/octet-stream'
      })
    } catch (err: any) {
      const error = await err.response.text()
      // eslint-disable-next-line no-console
      console.error('error uploading to r2', err.message, error)
      throw err
    }
  }

  return publicObjectUrl
}


================================================
FILE: apps/api/src/lib/temp
================================================
import ky from 'ky'

import { env } from './env'

const USER_AGENT = 'agentic-platform'

/**
 * GitHub (user-level) OAuth token response.
 *
 * @see https://docs.github.com/apps/oauth
 */
export interface GitHubUserTokenResponse {
  /**
   * The user access token (always starts with `ghu_`).
   * Example: `ghu_xxx…`
   */
  access_token: string

  /**
   * Seconds until `access_token` expires.
   * Omitted (`undefined`) if you’ve disabled token expiration.
   * Constant `28800` (8 hours) when present.
   */
  expires_in?: number

  /**
   * Refresh token for renewing the user access token (starts with `ghr_`).
   * Omitted (`undefined`) if you’ve disabled token expiration.
   */
  refresh_token?: string

  /**
   * Seconds until `refresh_token` expires.
   * Omitted (`undefined`) if you’ve disabled token expiration.
   * Constant `15897600` (6 months) when present.
   */
  refresh_token_expires_in?: number

  /**
   * Scopes granted to the token.
   * Always an empty string because the token is limited to
   * the intersection of app-level and user-level permissions.
   */
  scope: ''

  /**
   * Token type – always `'bearer'`.
   */
  token_type: 'bearer'
}

export interface GitHubUser {
  login: string
  id: number
  user_view_type?: string
  node_id: string
  avatar_url: string
  gravatar_id: string | null
  url: string
  html_url: string
  followers_url: string
  following_url: string
  gists_url: string
  starred_url: string
  subscriptions_url: string
  organizations_url: string
  repos_url: string
  events_url: string
  received_events_url: string
  type: string
  site_admin: boolean
  name: string | null
  company: string | null
  blog: string | null
  location: string | null
  email: string | null
  notification_email?: string | null
  hireable: boolean | null
  bio: string | null
  twitter_username?: string | null
  public_repos: number
  public_gists: number
  followers: number
  following: number
  created_at: string
  updated_at: string
  plan?: {
    collaborators: number
    name: string
    space: number
    private_repos: number
    [k: string]: unknown
  }
  private_gists?: number
  total_private_repos?: number
  owned_private_repos?: number
  disk_usage?: number
  collaborators?: number
}

export interface GitHubUserEmail {
  email: string
  primary: boolean
  verified: boolean
  visibility?: string | null
}

export async function exchangeOAuthCodeForAccessToken({
  code,
  clientId = env.GITHUB_CLIENT_ID,
  clientSecret = env.GITHUB_CLIENT_SECRET,
  redirectUri
}: {
  code: string
  clientId?: string
  clientSecret?: string
  redirectUri?: string
}): Promise<GitHubUserTokenResponse> {
  return ky
    .post('https://github.com/login/oauth/access_token', {
      json: {
        code,
        client_id: clientId,
        client_secret: clientSecret,
        redirect_uri: redirectUri
      },
      headers: {
        'user-agent': USER_AGENT
      }
    })
    .json<GitHubUserTokenResponse>()
}

export async function getMe({ token }: { token: string }): Promise<GitHubUser> {
  return ky
    .get('https://api.github.com/user', {
      headers: {
        Authorization: `Bearer ${token}`,
        'user-agent': USER_AGENT
      }
    })
    .json<GitHubUser>()
}

export async function getUserEmails({
  token
}: {
  token: string
}): Promise<GitHubUserEmail[]> {
  return ky
    .get('https://api.github.com/user/emails', {
      headers: {
        Authorization: `Bearer ${token}`,
        'user-agent': USER_AGENT
      }
    })
    .json<GitHubUserEmail[]>()
}

// TODO: currently unused
// export type NullToUndefinedDeep<T> = T extends null
//   ? undefined
//   : T extends Date
//     ? T
//     : T extends readonly (infer U)[]
//       ? NullToUndefinedDeep<U>[]
//       : T extends object
//         ? { [K in keyof T]: NullToUndefinedDeep<T[K]> }
//         : T

// // TODO: currently unused
// export type UndefinedToNullDeep<T> = T extends undefined
//   ? T | null
//   : T extends Date
//     ? T | null
//     : T extends readonly (infer U)[]
//       ? UndefinedToNullDeep<U>[]
//       : T extends object
//         ? { [K in keyof T]: UndefinedToNullDeep<T[K]> }
//         : T | null

// // TODO: currently unused
// export type UndefinedValuesToNullableValues<T> = T extends object
//   ? { [K in keyof T]: T[K] extends undefined ? T[K] | null : T[K] }
//   : T


================================================
FILE: apps/api/src/lib/types.ts
================================================
import type {
  DefaultHonoBindings,
  DefaultHonoEnv,
  DefaultHonoVariables
} from '@agentic/platform-hono'
import type { OpenAPIHono } from '@hono/zod-openapi'
import type { Context } from 'hono'
import type { Simplify } from 'type-fest'

import type { RawTeamMember, RawUser } from '@/db'

import type { Env } from './env'

export type AuthenticatedHonoVariables = Simplify<
  DefaultHonoVariables & {
    userId: string
    user?: RawUser
    teamMember?: RawTeamMember
  }
>

export type AuthenticatedHonoBindings = Simplify<DefaultHonoBindings & Env>

export type AuthenticatedHonoEnv = {
  Bindings: AuthenticatedHonoBindings
  Variables: AuthenticatedHonoVariables
}

export type AuthenticatedHonoContext = Context<AuthenticatedHonoEnv>

export type HonoApp = OpenAPIHono<DefaultHonoEnv>
export type AuthenticatedHonoApp = OpenAPIHono<AuthenticatedHonoEnv>


================================================
FILE: apps/api/src/lib/utils.ts
================================================
import { timingSafeEqual } from 'node:crypto'

export function timingSafeCompare(a: string, b: string): boolean {
  if (typeof a !== 'string' || typeof b !== 'string') {
    return false
  }

  if (a.length !== b.length) {
    return false
  }

  return timingSafeEqual(Buffer.from(a), Buffer.from(b))
}


================================================
FILE: apps/api/src/oauth-redirect.ts
================================================
import type { DefaultHonoEnv } from '@agentic/platform-hono'
import type { OpenAPIHono } from '@hono/zod-openapi'
import { assert } from '@agentic/platform-core'

export function registerOAuthRedirect(app: OpenAPIHono<DefaultHonoEnv>) {
  return app.all('/oauth/callback', async (ctx) => {
    const logger = ctx.get('logger')

    if (ctx.req.query('state')) {
      const { state: state64, ...query } = ctx.req.query()

      // google oauth + others
      const { uri, ...state } = JSON.parse(
        Buffer.from(state64!, 'base64').toString()
      ) as any

      assert(
        uri,
        404,
        `Error oauth redirect not found "${new URLSearchParams(ctx.req.query()).toString()}"`
      )

      const searchParams = new URLSearchParams({
        ...state,
        ...query
      })
      const redirectUri = `${uri}?${searchParams.toString()}`

      logger.info(
        'OAUTH CALLBACK',
        ctx.req.method,
        ctx.req.url,
        ctx.req.query(),
        '=>',
        redirectUri
      )
      return ctx.redirect(redirectUri)
    } else {
      // github oauth
      // https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#redirect-urls
      const { uri, ...params } = ctx.req.query()

      assert(
        uri,
        404,
        `Error oauth redirect not found "${new URLSearchParams(ctx.req.query()).toString()}"`
      )

      const searchParams = new URLSearchParams(params)
      const redirectUri = `${uri}?${searchParams.toString()}`
      logger.info(
        'OAUTH CALLBACK',
        ctx.req.method,
        ctx.req.url,
        ctx.req.query(),
        '=>',
        redirectUri
      )

      return ctx.redirect(redirectUri)
    }
  })
}


================================================
FILE: apps/api/src/reset.d.ts
================================================
import '@fisch0920/config/ts-reset'


================================================
FILE: apps/api/src/server.ts
================================================
import '@/lib/external/sentry'

import { type DefaultHonoEnv, errorHandler } from '@agentic/platform-hono'
import { serve } from '@hono/node-server'
import { OpenAPIHono } from '@hono/zod-openapi'
import * as Sentry from '@sentry/node'

import { apiV1 } from '@/api-v1'
import { env } from '@/lib/env'
import * as middleware from '@/lib/middleware'

import { initExitHooks } from './lib/exit-hooks'
// import { registerOAuthRedirect } from './oauth-redirect'

export const app = new OpenAPIHono<DefaultHonoEnv>()

app.onError(errorHandler)
app.use(middleware.sentry())
app.use(middleware.compress())
app.use(
  middleware.cors({
    origin: '*',
    allowHeaders: ['Content-Type', 'Authorization'],
    allowMethods: ['POST', 'GET', 'OPTIONS'],
    exposeHeaders: ['Content-Length'],
    maxAge: 600,
    credentials: true
  })
)
app.use(middleware.init)
app.use(middleware.accessLogger)
app.use(middleware.responseTime)

// TODO: top-level auth routes
// registerOAuthRedirect(app)

// Mount all v1 API routes
app.route('/v1', apiV1)

app.doc31('/docs', {
  openapi: '3.1.0',
  info: { title: 'Agentic', version: '0.1.0' }
})

const server = serve({
  fetch: (req, bindings) =>
    app.fetch(req, { ...bindings, ...env, sentry: Sentry }),
  port: env.PORT
})

initExitHooks({ server })

// eslint-disable-next-line no-console
console.log(`Server running on port ${env.PORT}`)


================================================
FILE: apps/api/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    }
  },
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: apps/api/tsup.config.ts
================================================
import { defineConfig } from 'tsup'

export default defineConfig([
  {
    entry: ['src/server.ts'],
    outDir: 'dist',
    target: 'node22',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  }
])


================================================
FILE: apps/api/vitest.config.ts
================================================
import tsconfigPaths from 'vite-tsconfig-paths'
import { defineConfig } from 'vitest/config'

export default defineConfig({
  plugins: [tsconfigPaths()],
  test: {
    environment: 'node',
    globals: true,
    watch: false,
    restoreMocks: true
  }
})


================================================
FILE: apps/e2e/bin/deploy-fixtures.ts
================================================
import { deployProjects } from '../src/deploy-projects'
import { devClient } from '../src/dev-client'
import { fixtures } from '../src/dev-fixtures'

async function main() {
  console.log('\n\nDeploying dev fixtures...\n\n')

  const deployments = await deployProjects(fixtures, { client: devClient })
  console.log(JSON.stringify(deployments, null, 2))

  // eslint-disable-next-line unicorn/no-process-exit
  process.exit(0)
}

await main()


================================================
FILE: apps/e2e/bin/publish-fixtures.ts
================================================
import { deployProjects } from '../src/deploy-projects'
import { devClient } from '../src/dev-client'
import { fixtures } from '../src/dev-fixtures'
import { publishDeployments } from '../src/publish-deployments'

async function main() {
  console.log('\n\nDeploying dev fixtures...\n\n')

  const deployments = await deployProjects(fixtures, { client: devClient })
  console.log(JSON.stringify(deployments, null, 2))

  console.log('\n\nPublishing dev fixture deployments...\n\n')

  const publishedDeployments = await publishDeployments(deployments, {
    client: devClient
  })
  console.log(JSON.stringify(publishedDeployments, null, 2))

  // eslint-disable-next-line unicorn/no-process-exit
  process.exit(0)
}

await main()


================================================
FILE: apps/e2e/bin/seed-db.ts
================================================
import { AgenticApiClient } from '@agentic/platform-api-client'

import { examples } from '../src/agentic-examples'
import { deployProjects } from '../src/deploy-projects'
import { fixtures } from '../src/dev-fixtures'
import { env, isProd } from '../src/env'
import { publishDeployments } from '../src/publish-deployments'

export const client = new AgenticApiClient({
  apiBaseUrl: env.AGENTIC_API_BASE_URL
})

async function main() {
  {
    console.log('\n\nCreating "dev" user...\n\n')

    const devAuthSession = await client.signUpWithPassword({
      username: 'dev',
      email: env.AGENTIC_DEV_EMAIL,
      password: env.AGENTIC_DEV_PASSWORD
    })
    console.log(JSON.stringify(devAuthSession, null, 2))

    console.warn(
      `\n\nREMEMBER TO UPDATE "AGENTIC_DEV_ACCESS_TOKEN" in e2e/.env${isProd ? '.production' : ''}\n\n`
    )

    console.log('\n\nDeploying dev fixtures...\n\n')

    const deployments = await deployProjects(fixtures, { client })
    console.log(JSON.stringify(deployments, null, 2))

    console.log('\n\nPublishing dev fixture deployments...\n\n')

    const publishedDeployments = await publishDeployments(deployments, {
      client
    })
    console.log(JSON.stringify(publishedDeployments, null, 2))
  }

  {
    console.log('\n\nCreating "agentic" user...\n\n')

    const agenticAuthSession = await client.signUpWithPassword({
      username: 'agentic',
      email: env.AGENTIC_AGENTIC_EMAIL,
      password: env.AGENTIC_AGENTIC_PASSWORD
    })
    console.log(JSON.stringify(agenticAuthSession, null, 2))

    console.log('\n\nDeploying example projects...\n\n')

    const deployments = await deployProjects(examples, { client })
    console.log(JSON.stringify(deployments, null, 2))

    console.log('\n\nPublishing example project deployments...\n\n')

    const publishedDeployments = await publishDeployments(deployments, {
      client
    })
    console.log(JSON.stringify(publishedDeployments, null, 2))
  }

  // eslint-disable-next-line unicorn/no-process-exit
  process.exit(0)
}

await main()


================================================
FILE: apps/e2e/package.json
================================================
{
  "name": "@agentic/platform-e2e-tests",
  "private": true,
  "version": "8.4.4",
  "description": "Internal Agentic platform E2E tests.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "apps/e2e"
  },
  "type": "module",
  "scripts": {
    "deploy-fixtures": "dotenvx run -- tsx bin/deploy-fixtures.ts",
    "deploy-fixtures:prod": "dotenvx run -o -f .env.production -- tsx bin/deploy-fixtures.ts",
    "publish-fixtures": "dotenvx run -- tsx bin/publish-fixtures.ts",
    "publish-fixtures:prod": "dotenvx run -o -f .env.production -- tsx bin/publish-fixtures.ts",
    "seed-db": "dotenvx run -- tsx bin/seed-db.ts",
    "seed-db:prod": "dotenvx run -o -f .env.production -- tsx bin/seed-db.ts",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "e2e": "dotenvx run -- vitest run",
    "e2e-http": "dotenvx run -- vitest run src/http-e2e.test.ts",
    "e2e-mcp": "dotenvx run -- vitest run src/mcp-e2e.test.ts",
    "e2e:prod": "dotenvx run -o -f .env.production -- vitest run",
    "e2e-http:prod": "dotenvx run -o -f .env.production -- vitest run src/http-e2e.test.ts",
    "e2e-mcp:prod": "dotenvx run -o -f .env.production -- vitest run src/mcp-e2e.test.ts"
  },
  "dependencies": {
    "dotenv": "catalog:",
    "ky": "catalog:",
    "p-map": "catalog:",
    "p-times": "catalog:",
    "semver": "catalog:"
  },
  "devDependencies": {
    "@agentic/platform": "workspace:*",
    "@agentic/platform-api-client": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-fixtures": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@modelcontextprotocol/sdk": "catalog:",
    "@types/semver": "catalog:",
    "fast-content-type-parse": "catalog:"
  }
}


================================================
FILE: apps/e2e/src/__snapshots__/http-e2e.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`HTTP => MCP origin basic "add" tool > 6.0: POST @dev/test-basic-mcp/add 1`] = `
[
  {
    "text": "42",
    "type": "text",
  },
]
`;

exports[`HTTP => MCP origin basic "add" tool > 6.1: GET @dev/test-basic-mcp/add 1`] = `
[
  {
    "text": "42",
    "type": "text",
  },
]
`;

exports[`HTTP => OpenAPI origin basic GET caching > 4.0: GET @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "aut dicta possimus sint mollitia voluptas commodi quo doloremque
iste corrupti reiciendis voluptatem eius rerum
sit cumque quod eligendi laborum minima
perferendis recusandae assumenda consectetur porro architecto ipsum ipsam",
  "id": 13,
  "title": "dolorum ut in voluptas mollitia et saepe quo animi",
  "userId": 2,
}
`;

exports[`HTTP => OpenAPI origin basic GET caching > 4.1: GET @dev/test-basic-openapi/getPost?postId=13 1`] = `
{
  "body": "aut dicta possimus sint mollitia voluptas commodi quo doloremque
iste corrupti reiciendis voluptatem eius rerum
sit cumque quod eligendi laborum minima
perferendis recusandae assumenda consectetur porro architecto ipsum ipsam",
  "id": 13,
  "title": "dolorum ut in voluptas mollitia et saepe quo animi",
  "userId": 2,
}
`;

exports[`HTTP => OpenAPI origin basic GET caching > 4.2: GET @dev/test-basic-openapi/get_post?postId=13 1`] = `
{
  "body": "aut dicta possimus sint mollitia voluptas commodi quo doloremque
iste corrupti reiciendis voluptatem eius rerum
sit cumque quod eligendi laborum minima
perferendis recusandae assumenda consectetur porro architecto ipsum ipsam",
  "id": 13,
  "title": "dolorum ut in voluptas mollitia et saepe quo animi",
  "userId": 2,
}
`;

exports[`HTTP => OpenAPI origin basic POST caching > 5.0: POST @dev/test-basic-openapi/get_post 1`] = `
{
  "body": "aut dicta possimus sint mollitia voluptas commodi quo doloremque
iste corrupti reiciendis voluptatem eius rerum
sit cumque quod eligendi laborum minima
perferendis recusandae assumenda consectetur porro architecto ipsum ipsam",
  "id": 13,
  "title": "dolorum ut in voluptas mollitia et saepe quo animi",
  "userId": 2,
}
`;

exports[`HTTP => OpenAPI origin basic POST caching > 5.1: POST @dev/test-basic-openapi/get_post 1`] = `
{
  "body": "aut dicta possimus sint mollitia voluptas commodi quo doloremque
iste corrupti reiciendis voluptatem eius rerum
sit cumque quod eligendi laborum minima
perferendis recusandae assumenda consectetur porro architecto ipsum ipsam",
  "id": 13,
  "title": "dolorum ut in voluptas mollitia et saepe quo animi",
  "userId": 2,
}
`;

exports[`HTTP => OpenAPI origin basic bypass caching > 3.0: GET @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "consectetur animi nesciunt iure dolore
enim quia ad
veniam autem ut quam aut nobis
et est aut quod aut provident voluptas autem voluptas",
  "id": 9,
  "title": "nesciunt iure omnis dolorem tempora et accusantium",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic bypass caching > 3.1: GET @dev/test-basic-openapi/getPost?postId=9 1`] = `
{
  "body": "consectetur animi nesciunt iure dolore
enim quia ad
veniam autem ut quam aut nobis
et est aut quod aut provident voluptas autem voluptas",
  "id": 9,
  "title": "nesciunt iure omnis dolorem tempora et accusantium",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic bypass caching > 3.2: GET @dev/test-basic-openapi/get_post?postId=9 1`] = `
{
  "body": "consectetur animi nesciunt iure dolore
enim quia ad
veniam autem ut quam aut nobis
et est aut quod aut provident voluptas autem voluptas",
  "id": 9,
  "title": "nesciunt iure omnis dolorem tempora et accusantium",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic bypass caching > 3.3: GET @dev/test-basic-openapi/get_post?postId=9 1`] = `
{
  "body": "consectetur animi nesciunt iure dolore
enim quia ad
veniam autem ut quam aut nobis
et est aut quod aut provident voluptas autem voluptas",
  "id": 9,
  "title": "nesciunt iure omnis dolorem tempora et accusantium",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic bypass caching > 3.4: GET @dev/test-basic-openapi/get_post?postId=9 1`] = `
{
  "body": "consectetur animi nesciunt iure dolore
enim quia ad
veniam autem ut quam aut nobis
et est aut quod aut provident voluptas autem voluptas",
  "id": 9,
  "title": "nesciunt iure omnis dolorem tempora et accusantium",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost errors > 1.8: POST @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost errors > 1.9: GET @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.0: POST @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.1: POST @dev/test-basic-openapi@latest/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.2: GET @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.3: GET @dev/test-basic-openapi/getPost?postId=1 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.4: GET @dev/test-basic-openapi/get_post?postId=1 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin basic getPost success > 0.5: GET @dev/test-basic-openapi/getPost 1`] = `
{
  "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "userId": 1,
}
`;

exports[`HTTP => OpenAPI origin default bypass caching > 2.0: GET @dev/test-everything-openapi/echo 1`] = `
{
  "postId": "9",
}
`;

exports[`HTTP => OpenAPI origin everything "echo" tool with empty body > 10.0: POST @dev/test-everything-openapi/echo 1`] = `{}`;

exports[`HTTP => OpenAPI origin everything "pure" tool > 8.0: POST @dev/test-everything-openapi/pure 1`] = `
{
  "foo": "bar",
  "nala": "kitten",
}
`;

exports[`HTTP => OpenAPI origin everything "pure" tool > 8.1: POST @dev/test-everything-openapi/pure 1`] = `
{
  "foo": "bar",
  "nala": "kitten",
}
`;


================================================
FILE: apps/e2e/src/__snapshots__/mcp-e2e.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`MCP => OpenAPI origin basic @ dev get_post success  > 2.0: @dev/test-basic-openapi@dev/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "dignissimos aperiam dolorem qui eum
facilis quibusdam animi sint suscipit qui sint possimus cum
quaerat magni maiores excepturi
ipsam ut commodi dolor voluptatum modi aut vitae",
    "id": 8,
    "title": "dolorem dolore est ipsam",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic @ latest get_post success  > 1.0: @dev/test-basic-openapi@latest/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "et iusto sed quo iure
voluptatem occaecati omnis eligendi aut ad
voluptatem doloribus vel accusantium quis pariatur
molestiae porro eius odio et labore et velit aut",
    "id": 3,
    "title": "ea molestias quasi exercitationem repellat qui ipsa sit aut",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic bypass caching > 6.0: @dev/test-everything-openapi/mcp echo 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "postId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic caching > 7.0: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic caching > 7.1: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic caching > 7.2: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic get_post errors > 4.3: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "dolore placeat quibusdam ea quo vitae
magni quis enim qui quis quo nemo aut saepe
quidem repellat excepturi ut quia
sunt ut sequi eos ea sed quas",
    "id": 7,
    "title": "magnam facilis autem",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic get_post success > 0.0: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic normalized caching > 8.0: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin basic normalized caching > 8.1: @dev/test-basic-openapi/mcp get_post 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "body": "quia et suscipit
suscipit recusandae consequuntur expedita et cum
reprehenderit molestiae ut ut quas totam
nostrum rerum est autem sunt rem eveniet architecto",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1,
  },
}
`;

exports[`MCP => OpenAPI origin everything "echo" tool with empty body > 13.0: @dev/test-everything-openapi/mcp echo 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {},
}
`;

exports[`MCP => OpenAPI origin everything "pure" tool > 11.0: @dev/test-everything-openapi/mcp echo 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "foo": "bar",
    "nala": "kitten",
  },
}
`;

exports[`MCP => OpenAPI origin everything "pure" tool > 11.1: @dev/test-everything-openapi/mcp echo 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "foo": "bar",
    "nala": "kitten",
  },
}
`;

exports[`MCP => OpenAPI origin everything errors > 5.0: @dev/test-everything-openapi/mcp strict_additional_properties 1`] = `
{
  "content": [],
  "isError": false,
  "structuredContent": {
    "foo": "bar",
  },
}
`;


================================================
FILE: apps/e2e/src/agentic-examples.ts
================================================
import path from 'node:path'
import { fileURLToPath } from 'node:url'

const exampleProjectNames = ['search']

const examplesDir = path.join(
  fileURLToPath(import.meta.url),
  '..',
  '..',
  '..',
  '..',
  'examples',
  'mcp-servers'
)

export const examples = exampleProjectNames.map((name) =>
  path.join(examplesDir, name)
)


================================================
FILE: apps/e2e/src/deploy-projects.ts
================================================
import type { AgenticApiClient } from '@agentic/platform-api-client'
import { loadAgenticConfig } from '@agentic/platform'
import pMap from 'p-map'

export async function deployProjects(
  projects: string[],
  {
    client,
    concurrency = 1
  }: {
    client: AgenticApiClient
    concurrency?: number
  }
) {
  const deployments = await pMap(
    projects,
    async (project) => {
      const config = await loadAgenticConfig({
        cwd: project
      })
      const deployment = await client.createDeployment(config)
      console.log(`Deployed ${project} => ${deployment.identifier}`)

      return deployment
    },
    {
      concurrency
    }
  )

  return deployments
}


================================================
FILE: apps/e2e/src/dev-client.ts
================================================
import { AgenticApiClient } from '@agentic/platform-api-client'

import { env } from './env'

export const devClient = new AgenticApiClient({
  apiBaseUrl: env.AGENTIC_API_BASE_URL,
  apiKey: env.AGENTIC_DEV_ACCESS_TOKEN
})


================================================
FILE: apps/e2e/src/dev-fixtures.ts
================================================
import path from 'node:path'
import { fileURLToPath } from 'node:url'

const fixtureNames = [
  // TODO: re-add these
  // 'basic-raw-free-ts',
  // 'basic-raw-free-json',
  // 'pricing-freemium',
  // 'pricing-pay-as-you-go',
  // 'pricing-3-plans',
  // 'pricing-monthly-annual',
  // 'pricing-custom-0',
  'basic-openapi',
  'basic-mcp',
  'everything-openapi'
]

const fixturesDir = path.join(
  fileURLToPath(import.meta.url),
  '..',
  '..',
  '..',
  '..',
  'fixtures'
)
const validFixturesDir = path.join(fixturesDir, 'valid')

export const fixtures = fixtureNames.map((name) =>
  path.join(validFixturesDir, name)
)


================================================
FILE: apps/e2e/src/env.ts
================================================
import 'dotenv/config'

import { parseZodSchema } from '@agentic/platform-core'
import { z } from 'zod'

// TODO: derive AGENTIC_API_BASE_URL and AGENTIC_GATEWAY_BASE_URL based on
// environment.
// TODO: use `@agentic/platform-hono` base env like other services

export const envSchema = z.object({
  ENVIRONMENT: z
    .enum(['development', 'test', 'production'])
    .default('development'),

  AGENTIC_API_BASE_URL: z.string().url().optional(),

  AGENTIC_DEV_EMAIL: z.string().email(),
  AGENTIC_DEV_PASSWORD: z.string().nonempty(),
  AGENTIC_DEV_ACCESS_TOKEN: z.string().nonempty(),

  AGENTIC_AGENTIC_EMAIL: z.string().email(),
  AGENTIC_AGENTIC_PASSWORD: z.string().nonempty(),

  AGENTIC_GATEWAY_BASE_URL: z
    .string()
    .url()
    .optional()
    .default('http://localhost:8787')
})

// eslint-disable-next-line no-process-env
export const env = parseZodSchema(envSchema, process.env, {
  error: 'Invalid environment variables'
})

export const isProd = env.ENVIRONMENT === 'production'


================================================
FILE: apps/e2e/src/http-e2e.test.ts
================================================
import contentType from 'fast-content-type-parse'
import defaultKy from 'ky'
import pTimes from 'p-times'
import { describe, expect, test } from 'vitest'

import { env } from './env'
import { fixtureSuites } from './http-fixtures'

const ky = defaultKy.extend({
  prefixUrl: env.AGENTIC_GATEWAY_BASE_URL,

  // Disable automatic retries for testing.
  retry: 0,

  // Some tests expect HTTP errors, so handle them manually instead of throwing.
  throwHttpErrors: false
})

for (const [i, fixtureSuite] of fixtureSuites.entries()) {
  const {
    title,
    fixtures,
    compareResponseBodies = false,
    repeat,
    repeatConcurrency = 1,
    repeatSuccessCriteria = 'all'
  } = fixtureSuite

  const describeFn = fixtureSuite.only ? describe.only : describe
  describeFn(title, () => {
    let fixtureResponseBody: any | undefined

    if (repeat) {
      expect(repeat).toBeGreaterThan(0)
    }

    for (const [j, fixture] of fixtures.entries()) {
      const method = fixture.request?.method ?? 'GET'
      const timeout = fixture.timeout ?? 30_000
      const {
        status = 200,
        contentType: expectedContentType = 'application/json',
        headers: expectedHeaders,
        body: expectedBody,
        validate
      } = fixture.response ?? {}
      const snapshot =
        fixture.response?.snapshot ??
        fixtureSuite.snapshot ??
        (status >= 200 && status < 300)
      const debugFixture = !!(
        fixture.debug ??
        fixtureSuite.debug ??
        fixture.only ??
        fixtureSuite.only
      )
      const fixtureName = `${i}.${j}: ${method} ${fixture.path}`

      let testFn = (fixture.only ?? fixture.debug) ? test.only : test
      if (fixtureSuite.sequential) {
        testFn = testFn.sequential
      }

      testFn(
        fixtureName,
        {
          timeout
        },
        // eslint-disable-next-line no-loop-func
        async () => {
          const numIterations = repeat ?? 1
          let numSuccessCases = 0

          await pTimes(
            numIterations,
            async (iteration: number) => {
              const repeatIterationPrefix = repeat
                ? `[${iteration}/${numIterations}] `
                : ''

              const res = await ky(fixture.path, {
                timeout,
                ...fixture.request
              })

              if (
                res.status !== status &&
                (res.status >= 500 || status === 200)
              ) {
                let body: any
                try {
                  body = await res.json()
                } catch {}

                console.error(
                  `${repeatIterationPrefix}${fixtureName} => UNEXPECTED ERROR ${res.status} (expected ${status}):`,
                  JSON.stringify(body, null, 2)
                )
              }

              if (repeat) {
                if (res.status === status) {
                  ++numSuccessCases
                } else {
                  if (debugFixture) {
                    console.log(
                      `${repeatIterationPrefix}${fixtureName} => ${res.status} (invalid sample; expected ${status})`,
                      {
                        headers: Object.fromEntries(res.headers.entries())
                      }
                    )
                  }

                  return
                }
              } else {
                expect(res.status).toBe(status)
              }

              const { type } = contentType.safeParse(
                res.headers.get('content-type') ?? ''
              )
              expect(type).toBe(expectedContentType)

              let body: any

              if (type.includes('json')) {
                try {
                  body = await res.json()
                } catch (err) {
                  console.error('json error', err)
                  throw err
                }
              } else if (type.includes('text')) {
                body = await res.text()
              } else {
                body = await res.arrayBuffer()
              }

              if (debugFixture) {
                console.log(
                  `${repeatIterationPrefix}${fixtureName} => ${res.status}`,
                  body,
                  {
                    headers: Object.fromEntries(res.headers.entries())
                  }
                )
              }

              if (expectedBody) {
                expect(body).toEqual(expectedBody)
              }

              if (validate) {
                await Promise.resolve(validate(body))
              }

              if (snapshot) {
                expect(body).toMatchSnapshot()
              }

              if (expectedHeaders) {
                for (const [key, value] of Object.entries(expectedHeaders)) {
                  expect(res.headers.get(key)).toBe(value)
                }
              }

              if (compareResponseBodies && status >= 200 && status < 300) {
                if (!fixtureResponseBody) {
                  fixtureResponseBody = body
                } else {
                  expect(body).toEqual(fixtureResponseBody)
                }
              }
            },
            { concurrency: repeatConcurrency, stopOnError: true }
          )

          if (repeat) {
            if (repeatSuccessCriteria === 'all') {
              expect(numSuccessCases).toBe(numIterations)
            } else if (repeatSuccessCriteria === 'some') {
              expect(numSuccessCases).toBeGreaterThan(0)
            } else if (typeof repeatSuccessCriteria === 'function') {
              await Promise.resolve(repeatSuccessCriteria(numSuccessCases))
            }
          }
        }
      )
    }
  })
}


================================================
FILE: apps/e2e/src/http-fixtures.ts
================================================
import { expect } from 'vitest'

export type E2ETestFixture = {
  path: string

  /** @default 60_000 milliseconds */
  timeout?: number

  /** @default false */
  only?: boolean

  /** @default false */
  debug?: boolean

  request?: {
    /** @default 'GET' */
    method?: 'GET' | 'POST' | 'PUT' | 'DELETE'
    searchParams?: Record<string, string | number | boolean>
    headers?: Record<string, string>
    json?: Record<string, unknown>
    body?: any
  }

  response?: {
    /** @default 200 */
    status?: number
    /** @default 'application/json' */
    contentType?: string
    headers?: Record<string, string>
    body?: any
    validate?: (body: any) => void | Promise<void>
    /** @default true */
    snapshot?: boolean
  }
}

export type E2ETestFixtureSuite = {
  title: string
  fixtures: E2ETestFixture[]

  /**
   * Development-only flag that runs exclusively this test suite, ignoring all others.
   * Uses Vitest's `describe.only()` to focus on a single test suite.
   *
   * ⚠️ WARNING: Never commit this as `true` - it will cause CI to skip all other tests.
   *
   * @default false
   */
  only?: boolean

  /** @default false */
  sequential?: boolean

  /** @default false */
  compareResponseBodies?: boolean

  /** @default false */
  debug?: boolean

  /** @default undefined */
  snapshot?: boolean

  /** @default undefined */
  repeat?: number

  /** @default 1 */
  repeatConcurrency?: number

  /** @default 'all' */
  repeatSuccessCriteria?:
    | 'all'
    | 'some'
    | ((numRepeatSuccesses: number) => void | Promise<void>)
}

const now = Date.now()

export const fixtureSuites: E2ETestFixtureSuite[] = [
  {
    title: 'HTTP => OpenAPI origin basic getPost success',
    compareResponseBodies: true,
    fixtures: [
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'POST',
          json: {
            postId: 1
          }
        }
      },
      {
        path: '@dev/test-basic-openapi@latest/getPost',
        request: {
          method: 'POST',
          json: {
            postId: 1
          }
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          searchParams: {
            // all of these GET requests implicitly test type coercion since
            // `postId` as a query param will be a string, but the tool expects
            // an integer.
            postId: 1
          }
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost?postId=1'
      },
      {
        path: '@dev/test-basic-openapi/get_post?postId=1'
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          searchParams: {
            postId: 1
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin basic getPost errors',
    fixtures: [
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'GET'
        },
        response: {
          // Missing `postId` parameter.
          status: 400
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost?postId=foo',
        response: {
          status: 400
        }
      },
      {
        path: '@dev/test-basic-openapi@00000000/getPost',
        response: {
          // deployment hash 00000000 doesn't exist
          status: 404
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'PUT',
          json: {
            postId: 1
          }
        },
        response: {
          // PUT is not a valid method (must be POST)
          status: 405
        }
      },
      {
        path: '@dev/test-basic-openapi@latest/get_kittens?postId=1',
        response: {
          status: 404
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          searchParams: {
            // invalid `postId` field type
            postId: 'not-a-number'
          }
        },
        response: {
          status: 400
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'POST',
          json: {
            // invalid `postId` field type
            postId: 'not-a-number'
          }
        },
        response: {
          status: 400
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'POST',
          json: {
            // missing required `postId` field
          }
        },
        response: {
          status: 400
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          method: 'POST',
          json: {
            postId: 1,
            // additional json body params are allowed by default
            foo: 'bar'
          }
        },
        response: {
          status: 200
        }
      },
      {
        path: '@dev/test-basic-openapi/getPost',
        request: {
          searchParams: {
            postId: 1,
            // additional search params should allowed by default
            foo: 'bar'
          }
        },
        response: {
          status: 200
        }
      },
      {
        path: '@dev/test-everything-openapi/strict_additional_properties',
        request: {
          method: 'POST',
          json: {
            foo: 'bar',
            // additional json body params should throw an error if the tool
            // config has `additionalProperties: false`
            extra: 'nala'
          }
        },
        response: {
          status: 400
        }
      },
      {
        path: '@dev/test-everything-openapi/strict_additional_properties',
        request: {
          method: 'GET',
          searchParams: {
            foo: 'bar',
            // additional search params should throw an error if the tool
            // config has `additionalProperties: false`
            extra: 'nala'
          }
        },
        response: {
          status: 400
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin default bypass caching',
    compareResponseBodies: true,
    fixtures: [
      {
        // ensure we bypass the cache for requests for tools which do not have
        // a custom `pure` or `cacheControl` set in their tool config.
        path: '@dev/test-everything-openapi/echo',
        request: {
          searchParams: {
            postId: 9
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin basic bypass caching',
    compareResponseBodies: true,
    fixtures: [
      {
        // ensure we bypass the cache for requests with `pragma: no-cache`
        path: '@dev/test-basic-openapi/getPost',
        request: {
          headers: {
            pragma: 'no-cache'
          },
          searchParams: {
            postId: 9
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      },
      {
        // ensure we bypass the cache for requests with `cache-control: no-cache`
        path: '@dev/test-basic-openapi/getPost?postId=9',
        request: {
          headers: {
            'cache-control': 'no-cache'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      },
      {
        // ensure we bypass the cache for requests with `cache-control: no-store`
        path: '@dev/test-basic-openapi/get_post?postId=9',
        request: {
          headers: {
            'cache-control': 'no-store'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      },
      {
        path: '@dev/test-basic-openapi/get_post?postId=9',
        request: {
          headers: {
            'cache-control': 'max-age=0, must-revalidate, no-cache'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      },
      {
        path: '@dev/test-basic-openapi/get_post?postId=9',
        request: {
          headers: {
            'cache-control': 'private, max-age=3600, must-revalidate'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'BYPASS'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin basic GET caching',
    compareResponseBodies: true,
    sequential: true,
    fixtures: [
      {
        // first request to ensure the cache is populated
        path: '@dev/test-basic-openapi/getPost',
        request: {
          headers: {
            'cache-control':
              'public, max-age=3600, s-maxage=3600, stale-while-revalidate=3600'
          },
          searchParams: {
            postId: 13
          }
        }
      },
      {
        // second request should hit the cache
        path: '@dev/test-basic-openapi/getPost?postId=13',
        request: {
          headers: {
            'cache-control':
              'public, max-age=3600, s-maxage=3600, stale-while-revalidate=3600'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'HIT'
          }
        }
      },
      {
        // normalized request with different path should also hit the cache
        path: '@dev/test-basic-openapi/get_post?postId=13',
        request: {
          headers: {
            'cache-control':
              'public, max-age=3600, s-maxage=3600, stale-while-revalidate=3600'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin basic POST caching',
    compareResponseBodies: true,
    sequential: true,
    fixtures: [
      {
        // first request to ensure the cache is populated
        path: '@dev/test-basic-openapi/get_post',
        request: {
          method: 'POST',
          json: {
            postId: 13
          }
        }
      },
      {
        // second request should hit the cache
        path: '@dev/test-basic-openapi/get_post',
        request: {
          method: 'POST',
          json: {
            postId: 13
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => MCP origin basic "add" tool',
    compareResponseBodies: true,
    fixtures: [
      {
        path: '@dev/test-basic-mcp/add',
        request: {
          method: 'POST',
          json: {
            a: 22,
            b: 20
          }
        },
        response: {
          body: [{ type: 'text', text: '42' }]
        }
      },
      {
        path: '@dev/test-basic-mcp/add',
        request: {
          searchParams: {
            a: 22,
            b: 20
          }
        },
        response: {
          body: [{ type: 'text', text: '42' }]
        }
      }
    ]
  },
  {
    title: 'HTTP => MCP origin basic "echo" tool',
    snapshot: false,
    fixtures: [
      {
        path: '@dev/test-basic-mcp/echo',
        request: {
          method: 'POST',
          json: {
            nala: 'kitten',
            num: 123,
            now
          }
        },
        response: {
          body: [
            {
              type: 'text',
              text: JSON.stringify({ nala: 'kitten', num: 123, now })
            }
          ]
        }
      },
      {
        path: '@dev/test-basic-mcp/echo',
        request: {
          searchParams: {
            nala: 'kitten',
            num: 123,
            now
          }
        },
        response: {
          body: [
            {
              type: 'text',
              text: JSON.stringify({
                nala: 'kitten',
                num: '123',
                now: `${now}`
              })
            }
          ]
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin everything "pure" tool',
    sequential: true,
    compareResponseBodies: true,
    fixtures: [
      {
        path: '@dev/test-everything-openapi/pure',
        request: {
          method: 'POST',
          json: {
            nala: 'kitten',
            foo: 'bar'
          }
        },
        response: {
          headers: {
            'cache-control':
              'public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600'
          },
          body: {
            nala: 'kitten',
            foo: 'bar'
          }
        }
      },
      {
        // second request should hit the cache
        path: '@dev/test-everything-openapi/pure',
        request: {
          method: 'POST',
          json: {
            nala: 'kitten',
            foo: 'bar'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'HIT',
            'cache-control':
              'public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600'
          },
          body: {
            nala: 'kitten',
            foo: 'bar'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin everything "disabled_tool" tool',
    fixtures: [
      {
        path: '@dev/test-everything-openapi/disabled_tool',
        request: {
          method: 'POST'
        },
        response: {
          // 400 because the request body is missing
          status: 400
        }
      },
      {
        path: '@dev/test-everything-openapi/disabled_tool',
        request: {
          method: 'POST',
          json: {}
        },
        response: {
          // 404 because the tool is disabled which means its hidden
          status: 404
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin everything "echo" tool with empty body',
    compareResponseBodies: true,
    fixtures: [
      {
        path: '@dev/test-everything-openapi/echo',
        request: {
          method: 'POST',
          json: {}
        },
        response: {
          body: {}
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin everything "unpure_marked_pure" tool',
    compareResponseBodies: true,
    snapshot: false,
    fixtures: [
      {
        path: '@dev/test-everything-openapi/unpure_marked_pure',
        request: {
          method: 'POST',
          json: {
            nala: 'cat'
          }
        },
        response: {
          validate: (body) => {
            expect(body?.nala).toEqual('cat')
            expect(typeof body.now).toBe('number')
            expect(body.now).toBeGreaterThan(0)
          }
        }
      },
      {
        // compareResponseBodies should result in the same cached response body,
        // even though the origin would return a different `now` value if it
        // weren't marked `pure`.
        path: '@dev/test-everything-openapi/unpure_marked_pure',
        request: {
          method: 'POST',
          json: {
            nala: 'cat'
          }
        },
        response: {
          headers: {
            'cf-cache-status': 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'HTTP => OpenAPI origin everything "echo_headers" tool',
    snapshot: false,
    fixtures: [
      {
        path: '@dev/test-everything-openapi/echo_headers',
        response: {
          validate: (body) => {
            expect(body['x-agentic-proxy-secret']).toBeTruthy()
            expect(body['x-agentic-proxy-secret']?.length).toBe(64)
            expect(body['x-agentic-deployment-id']).toBeTruthy()
            expect(
              body['x-agentic-deployment-id']?.startsWith('depl_')
            ).toBeTruthy()
            expect(body['x-agentic-deployment-identifier']).toBeTruthy()
            expect(body['x-agentic-is-customer-subscription-active']).toEqual(
              'false'
            )
            expect(body['x-agentic-user-id']).toBeUndefined()
            expect(body['x-agentic-customer-id']).toBeUndefined()
          }
        }
      }
    ]
  },
  {
    title:
      'HTTP => OpenAPI origin everything "custom_rate_limit_tool" (strict mode)',
    repeat: 5,
    repeatSuccessCriteria: (numRepeatSuccesses) => {
      expect(
        numRepeatSuccesses,
        'should have at least three 429 responses out of 5 requests with a strict rate limit of 2 requests per 30s'
      ).toBeGreaterThanOrEqual(3)
    },
    fixtures: [
      {
        path: '@dev/test-everything-openapi/custom_rate_limit_tool',
        response: {
          status: 429,
          headers: {
            'ratelimit-policy': '2;w=30',
            'ratelimit-limit': '2'
          }
        }
      }
    ]
  },
  {
    title:
      'HTTP => OpenAPI origin everything "custom_rate_limit_approximate_tool" (approximate mode)',
    repeat: 16,
    repeatConcurrency: 8,
    repeatSuccessCriteria: (numRepeatSuccesses) => {
      expect(
        numRepeatSuccesses,
        'should have at least one 429 response'
      ).toBeGreaterThan(0)
    },
    fixtures: [
      {
        path: '@dev/test-everything-openapi/custom_rate_limit_approximate_tool',
        response: {
          status: 429,
          headers: {
            'ratelimit-policy': '2;w=30',
            'ratelimit-limit': '2'
          }
        }
      }
    ]
  }
  // TODO
  // {
  //   title: 'HTTP => Production MCP origin "search" tool',
  //   // NOTE: this one actually hits a production service and costs a small
  //   // amount of $ per request.
  //   fixtures: [
  //     {
  //       path: '@agentic/search/search',
  //       request: {
  //         method: 'POST',
  //         json: {
  //           query: 'latest ai news'
  //         }
  //       },
  //       response: {
  //         snapshot: false
  //       }
  //     }
  //   ]
  // }
]


================================================
FILE: apps/e2e/src/mcp-e2e.test.ts
================================================
import { pick } from '@agentic/platform-core'
import { Client as McpClient } from '@modelcontextprotocol/sdk/client/index.js'
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'
import pTimes from 'p-times'
import { afterAll, beforeAll, describe, expect, test } from 'vitest'

import { env } from './env'
import { fixtureSuites } from './mcp-fixtures'

for (const [i, fixtureSuite] of fixtureSuites.entries()) {
  const {
    title,
    fixtures,
    compareResponseBodies = false,
    repeat,
    repeatConcurrency = 1,
    repeatSuccessCriteria = 'all'
  } = fixtureSuite

  const describeFn = fixtureSuite.only ? describe.only : describe
  describeFn(title, () => {
    let fixtureResult: any | undefined
    let client: McpClient

    if (repeat) {
      expect(repeat).toBeGreaterThan(0)
    }

    beforeAll(async () => {
      client = new McpClient({
        name: fixtureSuite.path,
        version: '0.0.0'
      })

      // TODO: add origin requestInit headers
      const transport = new StreamableHTTPClientTransport(
        new URL(fixtureSuite.path, env.AGENTIC_GATEWAY_BASE_URL)
      )
      await client.connect(transport)

      const { tools } = await client.listTools()

      // Ensure all tools used by the test fixtures in this suite are available.
      // Ignore test fixtures which are expected to error.
      for (const [_, fixture] of fixtures.entries()) {
        const { isError } = fixture.response ?? {}
        if (!isError) {
          const toolName = fixture.request.name
          expect(tools.map((t) => t.name)).toContain(toolName)
        }
      }
    }, 120_000)

    afterAll(async () => {
      await client.close()
    })

    for (const [j, fixture] of fixtures.entries()) {
      const {
        isError,
        result: expectedResult,
        content: expectedContent,
        structuredContent: expectedStructuredContent,
        _meta: expectedMeta,
        _agenticMeta: expectedAgenticMeta,
        _agenticMetaHeaders: expectedAgenticMetaHeaders,
        validate
      } = fixture.response ?? {}
      const toolName = fixture.request.name
      const expectedSnapshot =
        fixture.response?.snapshot ?? fixtureSuite.snapshot ?? false
      const expectedStableSnapshot =
        fixture.response?.stableSnapshot ??
        fixture.response?.snapshot ??
        fixtureSuite.stableSnapshot ??
        fixtureSuite.snapshot ??
        !isError
      const debugFixture = !!(
        fixture.debug ??
        fixtureSuite.debug ??
        fixture.only ??
        fixtureSuite.only
      )
      const fixtureName = `${i}.${j}: ${fixtureSuite.path} ${toolName}`

      let testFn = (fixture.only ?? fixture.debug) ? test.only : test
      if (fixtureSuite.sequential) {
        testFn = testFn.sequential
      }

      testFn(
        fixtureName,
        {
          timeout: fixture.timeout ?? 60_000
        },
        // eslint-disable-next-line no-loop-func
        async () => {
          const numIterations = repeat ?? 1
          let numSuccessCases = 0

          await pTimes(
            numIterations,
            async (iteration: number) => {
              const repeatIterationPrefix = repeat
                ? `[${iteration}/${numIterations}] `
                : ''

              const result = await client.callTool({
                name: toolName,
                arguments: fixture.request.args,
                _meta: fixture.request._meta
              })

              if (repeat) {
                if (result.isError === isError) {
                  ++numSuccessCases
                } else {
                  if (debugFixture) {
                    console.log(
                      `${repeatIterationPrefix}${fixtureName} => (invalid sample; expected ${result.isError ? 'error' : 'no error'})`,
                      JSON.stringify(result, null, 2)
                    )
                  }

                  return
                }
              }

              if (debugFixture) {
                console.log(
                  `${repeatIterationPrefix}${fixtureName} =>`,
                  JSON.stringify(result, null, 2)
                )
              }

              if (isError) {
                expect(result.isError).toBeTruthy()
              } else {
                expect(result.isError).toBeFalsy()
              }

              if (expectedResult) {
                expect(result).toEqual(expectedResult)
              }

              if (expectedContent) {
                expect(result.content).toEqual(expectedContent)
              }

              if (expectedStructuredContent) {
                expect(result.structuredContent).toEqual(
                  expectedStructuredContent
                )
              }

              if (expectedMeta) {
                expect(result._meta).toBeDefined()
                expect(typeof result._meta).toEqual('object')
                expect(!Array.isArray(result._meta)).toBeTruthy()
                for (const [key, value] of Object.entries(expectedMeta)) {
                  expect(result._meta![key]).toEqual(value)
                }
              }
              if (expectedAgenticMeta) {
                expect(result._meta).toBeDefined()
                expect(result._meta?.agentic).toBeDefined()
                expect(typeof result._meta?.agentic).toEqual('object')
                expect(!Array.isArray(result._meta?.agentic)).toBeTruthy()
                for (const [key, value] of Object.entries(
                  expectedAgenticMeta
                )) {
                  expect((result._meta!.agentic as any)[key]).toEqual(value)
                }
              }

              if (expectedAgenticMetaHeaders) {
                expect(result._meta).toBeDefined()
                expect(result._meta?.agentic).toBeDefined()
                expect(typeof result._meta?.agentic).toEqual('object')
                expect(!Array.isArray(result._meta?.agentic)).toBeTruthy()
                expect(typeof (result._meta?.agentic as any)?.headers).toEqual(
                  'object'
                )
                expect(
                  !Array.isArray((result._meta?.agentic as any)?.headers)
                ).toBeTruthy()
                for (const [key, value] of Object.entries(
                  expectedAgenticMetaHeaders
                )) {
                  expect((result._meta!.agentic as any).headers[key]).toEqual(
                    value
                  )
                }
              }

              if (expectedSnapshot) {
                expect(result).toMatchSnapshot()
              }

              const stableResult = pick(
                result,
                'content',
                'structuredContent',
                'isError'
              )

              if (expectedStableSnapshot) {
                expect(stableResult).toMatchSnapshot()
              }

              if (validate) {
                await Promise.resolve(validate(result))
              }

              if (compareResponseBodies && !isError) {
                if (!fixtureResult) {
                  fixtureResult = stableResult
                } else {
                  expect(stableResult).toEqual(fixtureResult)
                }
              }
            },
            { concurrency: repeatConcurrency, stopOnError: true }
          )

          if (repeat) {
            if (repeatSuccessCriteria === 'all') {
              expect(numSuccessCases).toBe(numIterations)
            } else if (repeatSuccessCriteria === 'some') {
              expect(numSuccessCases).toBeGreaterThan(0)
            } else if (typeof repeatSuccessCriteria === 'function') {
              await Promise.resolve(repeatSuccessCriteria(numSuccessCases))
            }
          }
        }
      )
    }
  })
}


================================================
FILE: apps/e2e/src/mcp-fixtures.ts
================================================
import { expect } from 'vitest'

export type MCPE2ETestFixture = {
  /** @default 60_000 milliseconds */
  timeout?: number

  /** @default false */
  only?: boolean

  /** @default false */
  debug?: boolean

  request: {
    name: string
    args: Record<string, unknown>
    _meta?: Record<string, unknown>
  }

  response?: {
    result?: any
    /** @default false */
    isError?: boolean
    content?: Array<Record<string, unknown>>
    structuredContent?: any
    _meta?: Record<string, unknown>
    _agenticMeta?: Record<string, unknown>
    _agenticMetaHeaders?: Record<string, unknown>
    validate?: (result: any) => void | Promise<void>
    /** @default undefined */
    snapshot?: boolean
    /** @default true */
    stableSnapshot?: boolean
  }
}

export type MCPE2ETestFixtureSuite = {
  title: string
  path: string
  fixtures: MCPE2ETestFixture[]

  /** @default false */
  only?: boolean

  /** @default false */
  sequential?: boolean

  /** @default false */
  compareResponseBodies?: boolean

  /** @default false */
  debug?: boolean

  /**
   * Not used by default because the result `_meta.agentic` contains some
   * metadata which may not be stable across test runs such as `cacheStatus`
   * and `headers`.
   *
   * @default false
   */
  snapshot?: boolean

  /** @default undefined */
  stableSnapshot?: boolean

  /** @default undefined */
  repeat?: number

  /** @default 1 */
  repeatConcurrency?: number

  /** @default 'all' */
  repeatSuccessCriteria?:
    | 'all'
    | 'some'
    | ((numRepeatSuccesses: number) => void | Promise<void>)
}

const now = Date.now()

export const fixtureSuites: MCPE2ETestFixtureSuite[] = [
  {
    title: 'MCP => OpenAPI origin basic get_post success',
    path: '@dev/test-basic-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            postId: 1
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic @ latest get_post success ',
    path: '@dev/test-basic-openapi@latest/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            postId: 3
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic @ dev get_post success ',
    path: '@dev/test-basic-openapi@dev/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            postId: 8
          }
        }
      }
    ]
  },
  {
    title: 'MCP => MCP origin basic "echo" tool call success',
    path: '@dev/test-basic-mcp/mcp',
    stableSnapshot: false,
    fixtures: [
      {
        request: {
          name: 'echo',
          args: {
            nala: 'kitten',
            num: 123,
            now
          }
        },
        response: {
          content: [
            {
              type: 'text',
              text: JSON.stringify({ nala: 'kitten', num: 123, now })
            }
          ],
          _agenticMeta: {
            cacheStatus: 'DYNAMIC'
          }
        }
      },
      {
        request: {
          name: 'echo',
          args: {
            nala: 'kitten',
            num: 123,
            now: `${now}`
          }
        },
        response: {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                nala: 'kitten',
                num: 123,
                now: `${now}`
              })
            }
          ],
          _agenticMeta: {
            cacheStatus: 'DYNAMIC'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic get_post errors',
    path: '@dev/test-basic-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            // Missing required `postId` parameter
            nala: 'kitten',
            num: 123,
            now
          }
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 400
          }
        }
      },
      {
        request: {
          name: 'get_post',
          args: {
            // invalid `postId` parameter
            postId: 'not-a-number'
          }
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 400
          }
        }
      },
      {
        request: {
          name: 'get_kittens',
          args: {
            postId: 7
          }
        },
        response: {
          isError: true,
          _agenticMeta: {
            // 'get_kittens' tool doesn't exist
            status: 404,
            toolName: 'get_kittens'
          }
        }
      },
      {
        request: {
          name: 'get_post',
          args: {
            postId: 7,
            // additional json body params are allowed by default
            foo: 'bar'
          }
        },
        response: {
          isError: false
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything errors',
    path: '@dev/test-everything-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'strict_additional_properties',
          args: {
            foo: 'bar'
          }
        },
        response: {
          isError: false
        }
      },
      {
        request: {
          name: 'strict_additional_properties',
          args: {
            foo: 'bar',
            // additional params should throw an error if the tool
            // config has `additionalProperties: false`
            extra: 'nala'
          }
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 400
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic bypass caching',
    path: '@dev/test-everything-openapi/mcp',
    fixtures: [
      {
        // ensure we bypass the cache for requests for tools which do not have
        // a custom `pure` or `cacheControl` set in their tool config.
        request: {
          name: 'echo',
          args: {
            postId: 1
          }
        },
        response: {
          isError: false,
          _agenticMeta: {
            cacheStatus: 'BYPASS'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic caching',
    path: '@dev/test-basic-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            postId: 1
          }
        },
        response: {
          isError: false
        }
      },
      {
        request: {
          name: 'get_post',
          args: {
            postId: 1
          }
        },
        response: {
          isError: false,
          _agenticMeta: {
            // second request should hit the cache
            cacheStatus: 'HIT'
          }
        }
      },
      {
        request: {
          name: 'get_post',
          args: {
            postId: 1
          },
          // disable caching via a custom metadata cache-control header
          _meta: {
            agentic: {
              headers: {
                'cache-control': 'no-store'
              }
            }
          }
        },
        response: {
          isError: false,
          _agenticMeta: {
            cacheStatus: 'BYPASS'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin basic normalized caching',
    path: '@dev/test-basic-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'get_post',
          args: {
            postId: 1,
            foo: true,
            nala: 'kitten'
          }
        },
        response: {
          isError: false
        }
      },
      {
        request: {
          name: 'get_post',
          args: {
            foo: true,
            postId: 1,
            nala: 'kitten'
          }
        },
        response: {
          isError: false,
          _agenticMeta: {
            // second request should hit the cache even though the args are in a
            // different order
            cacheStatus: 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => MCP origin basic "add" tool call success',
    path: '@dev/test-basic-mcp/mcp',
    stableSnapshot: false,
    fixtures: [
      {
        request: {
          name: 'add',
          args: {
            a: 13,
            b: 49
          }
        },
        response: {
          isError: false,
          content: [{ type: 'text', text: '62' }]
        }
      }
    ]
  },
  {
    title: 'MCP => MCP origin basic "echo" tool',
    path: '@dev/test-basic-mcp/mcp',
    stableSnapshot: false,
    fixtures: [
      {
        request: {
          name: 'echo',
          args: {
            nala: 'kitten',
            num: 123,
            now
          }
        },
        response: {
          isError: false,
          content: [
            {
              type: 'text',
              text: JSON.stringify({ nala: 'kitten', num: 123, now })
            }
          ]
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything "pure" tool',
    path: '@dev/test-everything-openapi/mcp',
    compareResponseBodies: true,
    fixtures: [
      {
        request: {
          name: 'echo',
          args: {
            nala: 'kitten',
            foo: 'bar'
          },
          _meta: {
            agentic: {
              headers: {
                'cache-control':
                  'public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600'
              }
            }
          }
        },
        response: {
          isError: false,
          structuredContent: {
            nala: 'kitten',
            foo: 'bar'
          }
        }
      },
      {
        // second request should hit the cache
        request: {
          name: 'echo',
          args: {
            nala: 'kitten',
            foo: 'bar'
          },
          _meta: {
            agentic: {
              headers: {
                'cache-control':
                  'public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600'
              }
            }
          }
        },
        response: {
          isError: false,
          structuredContent: {
            nala: 'kitten',
            foo: 'bar'
          },
          _agenticMeta: {
            cacheStatus: 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything "disabled_tool" tool',
    path: '@dev/test-everything-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'disabled_tool',
          args: {
            foo: 'bar'
          }
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 404,
            toolName: 'disabled_tool'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything "echo" tool with empty body',
    path: '@dev/test-everything-openapi/mcp',
    fixtures: [
      {
        request: {
          name: 'echo',
          args: {}
        },
        response: {
          isError: false,
          structuredContent: {}
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything "unpure_marked_pure" tool',
    path: '@dev/test-everything-openapi/mcp',
    compareResponseBodies: true,
    stableSnapshot: false,
    fixtures: [
      {
        request: {
          name: 'unpure_marked_pure',
          args: {
            nala: 'cat'
          }
        },
        response: {
          isError: false,
          validate: (result) => {
            const body = result.structuredContent
            expect(body?.nala).toEqual('cat')
            expect(typeof body.now).toBe('number')
            expect(body.now).toBeGreaterThan(0)
          }
        }
      },
      {
        // compareResponseBodies should result in the same cached response body,
        // even though the origin would return a different `now` value if it
        // weren't marked `pure`.
        request: {
          name: 'unpure_marked_pure',
          args: {
            nala: 'cat'
          }
        },
        response: {
          isError: false,
          _agenticMeta: {
            cacheStatus: 'HIT'
          }
        }
      }
    ]
  },
  {
    title: 'MCP => OpenAPI origin everything "echo_headers" tool',
    path: '@dev/test-everything-openapi/mcp',
    stableSnapshot: false,
    fixtures: [
      {
        request: {
          name: 'echo_headers',
          args: {}
        },
        response: {
          validate: (result) => {
            expect(
              result.structuredContent['x-agentic-proxy-secret']
            ).toBeTruthy()
            expect(
              result.structuredContent['x-agentic-proxy-secret']?.length
            ).toBe(64)
            expect(
              result.structuredContent['x-agentic-deployment-id']
            ).toBeTruthy()
            expect(
              result.structuredContent['x-agentic-deployment-id']?.startsWith(
                'depl_'
              )
            ).toBeTruthy()
            expect(
              result.structuredContent['x-agentic-deployment-identifier']
            ).toBeTruthy()
            expect(
              result.structuredContent[
                'x-agentic-is-customer-subscription-active'
              ]
            ).toEqual('false')
            expect(
              result.structuredContent['x-agentic-user-id']
            ).toBeUndefined()
            expect(
              result.structuredContent['x-agentic-customer-id']
            ).toBeUndefined()
          }
        }
      }
    ]
  },
  {
    title:
      'MCP => OpenAPI origin everything "custom_rate_limit_tool" (strict mode)',
    path: '@dev/test-everything-openapi/mcp',
    repeat: 5,
    repeatSuccessCriteria: (numRepeatSuccesses) => {
      expect(
        numRepeatSuccesses,
        'should have at least three 429 responses out of 5 requests with a strict rate limit of 2 requests per 30s'
      ).toBeGreaterThanOrEqual(3)
    },
    fixtures: [
      {
        request: {
          name: 'custom_rate_limit_tool',
          args: {}
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 429
          },
          _agenticMetaHeaders: {
            'ratelimit-policy': '2;w=30',
            'ratelimit-limit': '2'
          }
        }
      }
    ]
  },
  {
    title:
      'MCP => OpenAPI origin everything "custom_rate_limit_approximate_tool" (approximate mode)',
    path: '@dev/test-everything-openapi/mcp',
    repeat: 16,
    repeatConcurrency: 8,
    repeatSuccessCriteria: (numRepeatSuccesses) => {
      expect(
        numRepeatSuccesses,
        'should have at least one 429 response'
      ).toBeGreaterThan(0)
    },
    fixtures: [
      {
        request: {
          name: 'custom_rate_limit_approximate_tool',
          args: {}
        },
        response: {
          isError: true,
          _agenticMeta: {
            status: 429
          },
          _agenticMetaHeaders: {
            'ratelimit-policy': '2;w=30',
            'ratelimit-limit': '2'
          }
        }
      }
    ]
  }
]


================================================
FILE: apps/e2e/src/publish-deployments.ts
================================================
import type { AgenticApiClient } from '@agentic/platform-api-client'
import type { Deployment } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import pMap from 'p-map'
import semver from 'semver'

export async function publishDeployments(
  deployments: Deployment[],
  {
    client,
    concurrency = 1
  }: {
    client: AgenticApiClient
    concurrency?: number
  }
) {
  const publishedDeployments = await pMap(
    deployments,
    async (deployment) => {
      const project = await client.getProject({
        projectId: deployment.projectId,
        populate: ['lastDeployment']
      })

      const baseVersion = project.lastPublishedDeploymentVersion || '0.0.0'
      const version = semver.inc(baseVersion, 'patch')
      assert(version, `Failed to increment deployment version "${baseVersion}"`)

      const publishedDeployment = await client.publishDeployment(
        { version },
        {
          deploymentId: deployment.id
        }
      )
      console.log(`Published ${deployment.identifier} => ${version}`)

      return publishedDeployment
    },
    {
      concurrency
    }
  )

  return publishedDeployments
}


================================================
FILE: apps/e2e/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "bin", "*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: apps/e2e/vitest.config.ts
================================================
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    environment: 'node',
    globals: true,
    watch: false,
    restoreMocks: true
  }
})


================================================
FILE: apps/gateway/.dev.vars.example
================================================
ENVIRONMENT=
SENTRY_DSN=

AGENTIC_API_BASE_URL=
AGENTIC_API_KEY=

STRIPE_SECRET_KEY=


================================================
FILE: apps/gateway/package.json
================================================
{
  "name": "gateway",
  "private": true,
  "version": "8.4.4",
  "description": "Internal Agentic platform API gateway.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "apps/gateway"
  },
  "type": "module",
  "source": "./src/worker.ts",
  "scripts": {
    "dev": "wrangler dev",
    "deploy": "wrangler deploy --env production --outdir dist --upload-source-maps --var SENTRY_RELEASE:$(sentry-cli releases propose-version)",
    "deploy:cf": "wrangler deploy --env production --outdir dist --upload-source-maps",
    "cf-clear-cache": "del .wrangler",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run",
    "sentry:sourcemaps": "_SENTRY_RELEASE=$(sentry-cli releases propose-version) && sentry-cli releases new $_SENTRY_RELEASE --org=agentic-platform --project=gateway && sentry-cli sourcemaps upload --org=agentic-platform --project=gateway --release=$_SENTRY_RELEASE --strip-prefix 'dist/..' dist",
    "postdeploy": "pnpm sentry:sourcemaps"
  },
  "dependencies": {
    "@agentic/json-schema": "workspace:*",
    "@agentic/platform-api-client": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-hono": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@hono/zod-validator": "catalog:",
    "@modelcontextprotocol/sdk": "catalog:",
    "@sentry/cloudflare": "catalog:",
    "agents": "catalog:",
    "fast-content-type-parse": "catalog:",
    "hono": "catalog:",
    "ky": "catalog:",
    "plur": "catalog:",
    "sort-keys": "catalog:",
    "stripe": "catalog:",
    "type-fest": "catalog:"
  },
  "devDependencies": {
    "@cloudflare/workers-types": "catalog:",
    "@edge-runtime/vm": "catalog:",
    "@sentry/cli": "catalog:",
    "wrangler": "catalog:"
  }
}


================================================
FILE: apps/gateway/src/app.ts
================================================
import { assert } from '@agentic/platform-core'
import {
  applyRateLimitHeaders,
  cors,
  errorHandler,
  init,
  responseTime,
  sentry
} from '@agentic/platform-hono'
import { Hono } from 'hono'

import type {
  GatewayHonoEnv,
  ResolvedHttpEdgeRequest,
  ResolvedOriginToolCallResult
} from './lib/types'
import { createAgenticClient } from './lib/agentic-client'
import { createHttpResponseFromMcpToolCallResponse } from './lib/create-http-response-from-mcp-tool-call-response'
import { recordToolCallUsage } from './lib/record-tool-call-usage'
import { resolveEdgeRequest } from './lib/resolve-edge-request'
import { resolveHttpEdgeRequest } from './lib/resolve-http-edge-request'
import { resolveMcpEdgeRequest } from './lib/resolve-mcp-edge-request'
import { resolveOriginToolCall } from './lib/resolve-origin-tool-call'
import { isRequestPubliclyCacheable } from './lib/utils'
import { DurableMcpServer } from './worker'

export const app = new Hono<GatewayHonoEnv>()

app.onError(errorHandler)
app.use(sentry())

// TODO: Compression is causing a weird bug on dev even for simple responses.
// I think it's because wrangler is changing the response to be streamed
// with `transfer-encoding: chunked`, which is not compatible with
// `hono/compress`.
// app.use(compress())

app.use(
  cors({
    origin: '*',
    allowHeaders: ['Content-Type', 'Authorization', 'mcp-session-id'],
    allowMethods: ['GET', 'POST', 'DELETE', 'OPTIONS'],
    exposeHeaders: ['Content-Length', 'mcp-session-id'],
    maxAge: 86_400,
    credentials: true
  })
)
app.use(init)

// Wrangler does this for us. TODO: Does this happen on prod?
// app.use(accessLogger)

app.use(responseTime)

app.all(async (ctx) => {
  const waitUntil = ctx.executionCtx.waitUntil.bind(ctx.executionCtx)
  const isCachingEnabled = isRequestPubliclyCacheable(ctx.req.raw)
  ctx.set('cache', caches.default)
  ctx.set(
    'client',
    createAgenticClient({
      env: ctx.env,
      cache: caches.default,
      isCachingEnabled,
      waitUntil
    })
  )

  // Resolve the edge request to a specific deployment and mode (MCP or HTTP)
  const resolvedEdgeRequest = await resolveEdgeRequest(ctx)

  // Handle MCP requests
  if (resolvedEdgeRequest.edgeRequestMode === 'MCP') {
    ctx.set('isJsonRpcRequest', true)
    const executionCtx = ctx.executionCtx as any
    const mcpInfo = await resolveMcpEdgeRequest(ctx, resolvedEdgeRequest)
    executionCtx.props = mcpInfo

    return DurableMcpServer.serve('/*', {
      binding: 'DO_MCP_SERVER'
    }).fetch(ctx.req.raw, ctx.env, executionCtx)
  }

  // Handle HTTP requests
  let resolvedHttpEdgeRequest: ResolvedHttpEdgeRequest | undefined
  let resolvedOriginToolCallResult: ResolvedOriginToolCallResult | undefined
  let originResponse: Response | undefined
  let res: Response | undefined

  try {
    // Resolve the http edge request to a specific consumer and tool call
    resolvedHttpEdgeRequest = await resolveHttpEdgeRequest(
      ctx,
      resolvedEdgeRequest
    )

    // Invoke the origin tool call.
    resolvedOriginToolCallResult = await resolveOriginToolCall({
      ...resolvedHttpEdgeRequest,
      args: resolvedHttpEdgeRequest.toolCallArgs,
      sessionId: ctx.get('sessionId')!,
      env: ctx.env,
      waitUntil
    })

    // Transform the origin tool call response into an http response.
    if (resolvedOriginToolCallResult.originResponse) {
      originResponse = resolvedOriginToolCallResult.originResponse
    } else {
      originResponse = await createHttpResponseFromMcpToolCallResponse(ctx, {
        ...resolvedHttpEdgeRequest,
        toolCallResponse: resolvedOriginToolCallResult.toolCallResponse,
        toolConfig: resolvedOriginToolCallResult.toolConfig
      })
    }

    assert(originResponse, 500, 'Origin response is required')

    // Post-process the origin response.
    res = updateResponse(originResponse, resolvedOriginToolCallResult)
    return res
  } catch (err: any) {
    // Convert the error into an http response and post-process it.
    res = errorHandler(err, ctx)
    res = updateResponse(res, resolvedOriginToolCallResult)
    return res
  } finally {
    // Record the tool call usage.
    if (resolvedHttpEdgeRequest && res) {
      recordToolCallUsage({
        ...resolvedHttpEdgeRequest,
        httpResponse: res,
        resolvedOriginToolCallResult,
        sessionId: ctx.get('sessionId')!,
        env: ctx.env,
        waitUntil
      })
    }
  }
})

function updateResponse(
  response: Response,
  resolvedOriginToolCallResult?: ResolvedOriginToolCallResult
) {
  const res = new Response(response.body, response)

  if (resolvedOriginToolCallResult) {
    if (resolvedOriginToolCallResult.rateLimitResult) {
      applyRateLimitHeaders({
        res,
        rateLimitResult: resolvedOriginToolCallResult.rateLimitResult
      })
    }

    // Record the time it took for the origin to respond.
    res.headers.set(
      'x-origin-response-time',
      `${resolvedOriginToolCallResult.originTimespanMs}ms`
    )
  }

  // Reset server to Agentic because Cloudflare likes to override things
  res.headers.set('server', 'agentic')

  // Remove extra Cloudflare headers
  res.headers.delete('x-powered-by')
  res.headers.delete('via')
  res.headers.delete('nel')
  res.headers.delete('report-to')
  res.headers.delete('server-timing')
  res.headers.delete('reporting-endpoints')

  return res
}


================================================
FILE: apps/gateway/src/lib/__snapshots__/utils.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`createAgenticMcpMetadata 1`] = `"{"agentic":{"deploymentId":"123","consumerId":"456","toolName":"test","status":200,"cacheStatus":"HIT"}}"`;


================================================
FILE: apps/gateway/src/lib/agentic-client.ts
================================================
import { AgenticApiClient } from '@agentic/platform-api-client'
import defaultKy from 'ky'

import type { RawEnv } from './env'
import type { WaitUntil } from './types'
import { isCacheControlPubliclyCacheable } from './utils'

export function createAgenticClient({
  env,
  cache,
  waitUntil,
  isCachingEnabled = true
}: {
  env: RawEnv
  cache: Cache
  waitUntil: WaitUntil
  isCachingEnabled?: boolean
}) {
  const client = new AgenticApiClient({
    apiBaseUrl: env.AGENTIC_API_BASE_URL,
    apiKey: env.AGENTIC_API_KEY,
    ky: isCachingEnabled
      ? defaultKy.extend({
          hooks: {
            // NOTE: The order of the `beforeRequest` hook matters, and it only
            // works alongside the one in AgenticApiClient because that one's body
            // should never be run. This only works because we're using `apiKey`
            // authentication, which is a lil hacky since it's actually a long-
            // lived access token.
            beforeRequest: [
              async (request) => {
                // Check the cache first before making a request to Agentic's
                // backend API.
                return cache.match(request)
              }
            ],

            afterResponse: [
              async (request, _options, response) => {
                if (
                  !isCacheControlPubliclyCacheable(
                    response.headers.get('cache-control')
                  )
                ) {
                  return
                }

                // Asynchronously update the cache with the response from
                // Agentic's backend API.
                waitUntil(
                  cache.put(request, response.clone()).catch((err) => {
                    // eslint-disable-next-line no-console
                    console.warn('cache put error', request, err)
                  })
                )
              }
            ]
          }
        })
      : defaultKy
  })

  return client
}


================================================
FILE: apps/gateway/src/lib/cf-validate-json-schema.ts
================================================
import { Validator } from '@agentic/json-schema'
import { assert, HttpError } from '@agentic/platform-core'
import plur from 'plur'

/**
 * Validates `data` against the provided JSON schema.
 *
 * This method uses a fork of `@cfworker/json-schema`. It does not use `ajv`
 * because `ajv` is not supported on CF workers due to its dynamic code
 * generation and evaluation.
 *
 * If you want a stricter version of this method which uses `ajv` and you're
 * not running on CF workers, consider using `validateJsonSchemaObject` from
 * `@agentic/platform-openapi-utils`.
 */
export function cfValidateJsonSchema<T = unknown>({
  schema,
  data,
  coerce = false,
  strictAdditionalProperties = false,
  errorPrefix,
  errorStatusCode = 400
}: {
  schema: any
  data: unknown
  coerce?: boolean
  strictAdditionalProperties?: boolean
  errorPrefix?: string
  errorStatusCode?: number
}): T {
  assert(schema, 400, '`schema` is required')
  const isSchemaObject =
    typeof schema === 'object' &&
    !Array.isArray(schema) &&
    schema.type === 'object'
  const isDataObject = typeof data === 'object' && !Array.isArray(data)
  if (isSchemaObject && !isDataObject) {
    throw new HttpError({
      statusCode: 400,
      message: `${errorPrefix ? errorPrefix + ': ' : ''}Data must be an object according to its schema.`
    })
  }

  // Special-case check for required fields to give better error messages
  if (isSchemaObject && Array.isArray(schema.required)) {
    const missingRequiredFields: string[] = schema.required.filter(
      (field: string) => (data as Record<string, unknown>)[field] === undefined
    )

    if (missingRequiredFields.length > 0) {
      throw new HttpError({
        statusCode: errorStatusCode,
        message: `${errorPrefix ? errorPrefix + ': ' : ''}Missing required ${plur('parameter', missingRequiredFields.length)}: ${missingRequiredFields.map((field) => `"${field}"`).join(', ')}`
      })
    }
  }

  // Special-case check for additional top-level fields to give better error
  // messages.
  if (
    isSchemaObject &&
    schema.properties &&
    (schema.additionalProperties === false ||
      (schema.additionalProperties === undefined && strictAdditionalProperties))
  ) {
    const extraProperties = Object.keys(data as Record<string, unknown>).filter(
      (key) => !schema.properties[key]
    )

    if (extraProperties.length > 0) {
      throw new HttpError({
        statusCode: errorStatusCode,
        message: `${errorPrefix ? errorPrefix + ': ' : ''}Unexpected additional ${plur('parameter', extraProperties.length)}: ${extraProperties.map((property) => `"${property}"`).join(', ')}`
      })
    }
  }

  const validator = new Validator({
    schema,
    coerce,
    strictAdditionalProperties
  })
  const result = validator.validate(data)
  if (result.valid) {
    // console.log('validate', {
    //   schema,
    //   data,
    //   result: result.instance
    // })

    // Return the (possibly) coerced data
    return result.instance as T
  }

  const finalErrorMessage = `${
    errorPrefix ? errorPrefix + ': ' : ''
  }${result.errors
    .map(({ keyword, error }) => `keyword "${keyword}" error ${error}`)
    .join(' ')}`

  throw new HttpError({
    statusCode: errorStatusCode,
    message: finalErrorMessage
  })
}


================================================
FILE: apps/gateway/src/lib/create-http-request-for-openapi-operation.ts
================================================
import type {
  AdminDeployment,
  OpenAPIToolOperation,
  ToolConfig
} from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'

import type { ToolCallArgs } from './types'

export async function createHttpRequestForOpenAPIOperation({
  toolCallArgs,
  operation,
  deployment,
  request,
  toolConfig
}: {
  toolCallArgs: ToolCallArgs
  operation: OpenAPIToolOperation
  deployment: AdminDeployment
  request?: Request
  toolConfig?: ToolConfig
}): Promise<Request> {
  assert(toolCallArgs, 500, 'Tool args are required')
  assert(
    deployment.origin.type === 'openapi',
    500,
    `Internal logic error for origin adapter type "${deployment.origin.type}"`
  )

  const { method } = operation
  const methodHasBody =
    method === 'post' || method === 'put' || method === 'patch'

  // TODO: Make this more efficient by changing the `parameterSources` data structure
  const params = Object.entries(operation.parameterSources)
  const bodyParams = params.filter(([_key, source]) => source === 'body')
  const formDataParams = params.filter(
    ([_key, source]) => source === 'formData'
  )
  const headerParams = params.filter(([_key, source]) => source === 'header')
  const pathParams = params.filter(([_key, source]) => source === 'path')
  const queryParams = params.filter(([_key, source]) => source === 'query')
  const cookieParams = params.filter(([_key, source]) => source === 'cookie')
  assert(
    !cookieParams.length,
    500,
    'Cookie parameters for OpenAPI operations are not yet supported. If you need cookie parameter support, please contact support@agentic.so.'
  )

  const extraArgs =
    toolConfig?.inputSchemaAdditionalProperties === false
      ? []
      : // TODO: Make this more efficient...
        Object.keys(toolCallArgs).filter((key) => {
          if (bodyParams.some(([paramKey]) => paramKey === key)) return false
          if (formDataParams.some(([paramKey]) => paramKey === key))
            return false
          if (headerParams.some(([paramKey]) => paramKey === key)) return false
          if (queryParams.some(([paramKey]) => paramKey === key)) return false
          if (pathParams.some(([paramKey]) => paramKey === key)) return false
          if (cookieParams.some(([paramKey]) => paramKey === key)) return false
          return true
        })
  const extraArgsEntries = extraArgs
    .map((key) => [key, toolCallArgs[key]])
    .filter(([, value]) => value !== undefined)

  const headers: Record<string, string> = {}
  if (request) {
    // TODO: do we want to expose these? especially authorization?
    for (const [key, value] of request.headers.entries()) {
      headers[key] = value
    }
  }

  if (headerParams.length > 0) {
    for (const [key] of headerParams) {
      headers[key] = (request?.headers.get(key) as string) ?? toolCallArgs[key]
    }
  }

  for (const [key] of cookieParams) {
    headers[key] = String(toolCallArgs[key])
  }

  let body: string | undefined
  if (methodHasBody) {
    if (bodyParams.length > 0 || !formDataParams.length) {
      const bodyJson = Object.fromEntries(
        bodyParams
          .map(([key]) => [key, toolCallArgs[key]])
          .concat(extraArgsEntries)
          // Prune undefined values. We know these aren't required fields,
          // because the incoming request params have already been validated
          // against the tool's input schema.
          .filter(([, value]) => value !== undefined)
      )

      body = JSON.stringify(bodyJson)
      headers['content-type'] = 'application/json'
      headers['content-length'] = body.length.toString()
    } else if (formDataParams.length > 0) {
      // TODO: Double-check FormData usage.
      const bodyFormData = new FormData()

      for (const [key] of formDataParams) {
        const value = toolCallArgs[key]
        if (value !== undefined) {
          bodyFormData.append(key, value)
        }
      }

      for (const [key, value] of extraArgsEntries) {
        bodyFormData.append(key, value)
      }

      body = bodyFormData.toString()
      headers['content-type'] = 'application/x-www-form-urlencoded'
      headers['content-length'] = body.length.toString()
    }
  }

  let path = operation.path
  if (pathParams.length > 0) {
    for (const [key] of pathParams) {
      const value: string = toolCallArgs[key]
      assert(value, 400, `Missing required parameter "${key}"`)

      const pathParamPlaceholder = `{${key}}`
      assert(
        path.includes(pathParamPlaceholder),
        500,
        `Misconfigured OpenAPI deployment "${deployment.id}": invalid path "${operation.path}" missing required path parameter "${key}"`
      )

      path = path.replaceAll(pathParamPlaceholder, value)
    }
  }
  assert(
    !/\{\w+\}/.test(path),
    500,
    `Misconfigured OpenAPI deployment "${deployment.id}": invalid path "${operation.path}"`
  )

  const query = new URLSearchParams()
  for (const [key] of queryParams) {
    query.set(key, toolCallArgs[key] as string)
  }

  if (!methodHasBody) {
    for (const [key, value] of extraArgsEntries) {
      query.set(key, value)
    }
  }

  const queryString = query.toString()
  const originRequestUrl = `${deployment.origin.url}${path}${
    queryString ? `?${queryString}` : ''
  }`

  return new Request(originRequestUrl, {
    method: method.toUpperCase(),
    body,
    headers
  })
}


================================================
FILE: apps/gateway/src/lib/create-http-response-from-mcp-tool-call-response.ts
================================================
import type { AdminDeployment, Tool, ToolConfig } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'

import type { GatewayHonoContext, McpToolCallResponse } from './types'
import { cfValidateJsonSchema } from './cf-validate-json-schema'

export async function createHttpResponseFromMcpToolCallResponse(
  _ctx: GatewayHonoContext,
  {
    tool,
    deployment,
    toolCallResponse,
    toolConfig
  }: {
    tool: Tool
    deployment: AdminDeployment
    toolCallResponse: McpToolCallResponse
    toolConfig?: ToolConfig
  }
): Promise<Response> {
  assert(
    deployment.origin.type === 'mcp',
    500,
    `Internal logic error for origin adapter type "${deployment.origin.type}"`
  )
  assert(
    !toolCallResponse.isError,
    502,
    // TODO: add content or structuredContent to the error message
    `MCP tool "${tool.name}" returned an error.`
  )

  if (tool.outputSchema) {
    // eslint-disable-next-line no-console
    console.log(`tool call "${tool.name}" structured response:`, {
      outputSchema: tool.outputSchema,
      toolCallResponse
    })

    assert(
      toolCallResponse.structuredContent,
      502,
      `Structured content is required for MCP origin requests to tool "${tool.name}" because it has an output schema.`
    )

    // Validate tool response against the tool's output schema.
    const toolCallResponseContent = cfValidateJsonSchema({
      schema: tool.outputSchema,
      data: toolCallResponse.structuredContent as Record<string, unknown>,
      coerce: false,
      // TODO: double-check MCP schema on whether additional properties are allowed
      strictAdditionalProperties:
        toolConfig?.outputSchemaAdditionalProperties === false,
      errorPrefix: `Invalid tool response for tool "${tool.name}"`,
      errorStatusCode: 502
    })

    return new Response(JSON.stringify(toolCallResponseContent), {
      headers: {
        'content-type': 'application/json'
      }
    })
  }

  return new Response(JSON.stringify(toolCallResponse.content), {
    headers: {
      'content-type': 'application/json'
    }
  })
}


================================================
FILE: apps/gateway/src/lib/durable-mcp-client.ts
================================================
import type { AgenticMcpRequestMetadata } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import { Client as McpClient } from '@modelcontextprotocol/sdk/client/index.js'
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'
import * as Sentry from '@sentry/cloudflare'
import { DurableObject } from 'cloudflare:workers'

import type { RawEnv } from './env'

export type DurableMcpClientInfo = {
  url: string
  name: string
  version: string
  headers?: Record<string, string>
}

// TODO: not sure if there's a better way to handle re-using client connections
// across requests. Maybe we use one DurableObject per unique
// customer<>DurableMcpClientInfo connection?
// Currently using `sessionId`

export class DurableMcpClientBase extends DurableObject<RawEnv> {
  protected client?: McpClient
  protected clientConnectionP?: Promise<void>

  async init(mcpClientInfo: DurableMcpClientInfo) {
    const existingMcpClientInfo =
      await this.ctx.storage.get<DurableMcpClientInfo>('mcp-client-info')

    await this.ctx.storage.put('mcp-client-info', mcpClientInfo)
    if (existingMcpClientInfo) {
      if (mcpClientInfo.url !== existingMcpClientInfo.url) {
        // eslint-disable-next-line no-console
        console.warn(
          `DurableMcpClientInfo url changed from "${existingMcpClientInfo.url}" to "${mcpClientInfo.url}"`
        )
      }

      await this.client?.close()
      this.clientConnectionP = undefined
      this.client = undefined
    }

    return this.ensureClientConnection(mcpClientInfo)
  }

  async isInitialized(): Promise<boolean> {
    return !!(await this.ctx.storage.get('mcp-client-info'))
  }

  async ensureClientConnection(mcpClientInfo?: DurableMcpClientInfo) {
    if (this.clientConnectionP) return this.clientConnectionP

    mcpClientInfo ??=
      await this.ctx.storage.get<DurableMcpClientInfo>('mcp-client-info')
    assert(mcpClientInfo, 500, 'DurableMcpClient has not been initialized')
    const { name, version, url } = mcpClientInfo

    this.client = new McpClient({
      name,
      version
    })

    // console.log('DurableMcpClient.ensureClientConnection', {
    //   url,
    //   headers: mcpClientInfo.headers
    // })
    const transport = new StreamableHTTPClientTransport(new URL(url), {
      requestInit: {
        headers: mcpClientInfo.headers
      }
    })
    this.clientConnectionP = this.client.connect(transport)
    await this.clientConnectionP
  }

  async callTool({
    name,
    args,
    metadata
  }: {
    name: string
    args: Record<string, unknown>
    metadata: AgenticMcpRequestMetadata
  }): Promise<string> {
    await this.ensureClientConnection()

    // console.log('DurableMcpClient.callTool', {
    //   name,
    //   args,
    //   metadata
    // })

    const toolCallResponse = await this.client!.callTool({
      name,
      arguments: args,
      _meta: { agentic: metadata }
    })

    // TODO: The `McpToolCallResponse` type is seemingly too complex for the CF
    // serialization type inference to handle, so bypass it by serializing to
    // a string and parsing it on the other end.
    return JSON.stringify(toolCallResponse)
  }
}

export const DurableMcpClient = Sentry.instrumentDurableObjectWithSentry(
  (env: RawEnv) => ({
    dsn: env.SENTRY_DSN,
    environment: env.ENVIRONMENT,
    integrations: [Sentry.extraErrorDataIntegration()]
  }),
  DurableMcpClientBase
)


================================================
FILE: apps/gateway/src/lib/durable-mcp-server.ts
================================================
import { assert, getRateLimitHeaders } from '@agentic/platform-core'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'
import { Server } from '@modelcontextprotocol/sdk/server/index.js'
import {
  CallToolRequestSchema,
  ListToolsRequestSchema
} from '@modelcontextprotocol/sdk/types.js'
import * as Sentry from '@sentry/cloudflare'
import { McpAgent } from 'agents/mcp'

import type { RawEnv } from './env'
import type {
  McpToolCallResponse,
  ResolvedMcpEdgeRequest,
  ResolvedOriginToolCallResult
} from './types'
import { handleMcpToolCallError } from './handle-mcp-tool-call-error'
import { recordToolCallUsage } from './record-tool-call-usage'
import { resolveOriginToolCall } from './resolve-origin-tool-call'
import { transformHttpResponseToMcpToolCallResponse } from './transform-http-response-to-mcp-tool-call-response'
import { createAgenticMcpMetadata } from './utils'

export class DurableMcpServerBase extends McpAgent<
  RawEnv,
  never, // We aren't currently using local state, so set it to `never`.
  ResolvedMcpEdgeRequest
> {
  protected _serverP = Promise.withResolvers<Server>()
  override server = this._serverP.promise

  // NOTE: This empty constructor is required for the Sentry wrapper to work.
  public constructor(state: DurableObjectState, env: RawEnv) {
    super(state, env)
  }

  override async init() {
    const { consumer, deployment, pricingPlan } = this.props
    const { projectIdentifier } = parseDeploymentIdentifier(
      deployment.identifier
    )

    const server = new Server(
      { name: projectIdentifier, version: deployment.version ?? '0.0.0' },
      {
        capabilities: {
          tools: {}
        }
      }
    )
    this._serverP.resolve(server)

    const tools = deployment.tools
      .map((tool) => {
        const toolConfig = deployment.toolConfigs.find(
          (toolConfig) => toolConfig.name === tool.name
        )

        if (toolConfig) {
          const pricingPlanToolOverride = pricingPlan
            ? toolConfig.pricingPlanOverridesMap?.[pricingPlan.slug]
            : undefined

          if (pricingPlanToolOverride?.enabled === true) {
            // Tool is explicitly enabled for the customer's pricing plan
          } else if (pricingPlanToolOverride?.enabled === false) {
            // Tool is disabled for the customer's pricing plan
            return undefined
          } else if (toolConfig.enabled === false) {
            // Tool is disabled for all pricing plans
            return undefined
          }
        }

        return tool
      })
      .filter(Boolean)

    server.setRequestHandler(ListToolsRequestSchema, async () => ({
      tools
    }))

    server.setRequestHandler(CallToolRequestSchema, async (request) => {
      const { name: toolName, arguments: args, _meta } = request.params
      const sessionId = this.ctx.id.toString()
      const tool = tools.find((tool) => tool.name === toolName)

      const cacheControl = (_meta?.agentic as any)?.headers?.['cache-control']
      let resolvedOriginToolCallResult: ResolvedOriginToolCallResult | undefined
      let toolCallResponse: McpToolCallResponse | undefined

      try {
        assert(tool, 404, `Unknown tool "${toolName}"`)

        resolvedOriginToolCallResult = await resolveOriginToolCall({
          ...this.props,
          tool,
          args,
          cacheControl,
          sessionId,
          env: this.env,
          waitUntil: this.ctx.waitUntil.bind(this.ctx)
        })

        if (resolvedOriginToolCallResult.originResponse) {
          toolCallResponse = await transformHttpResponseToMcpToolCallResponse({
            ...resolvedOriginToolCallResult,
            tool
          })
        } else {
          toolCallResponse = resolvedOriginToolCallResult.toolCallResponse
          assert(toolCallResponse, 500, 'Missing tool call response')
        }

        return toolCallResponse
      } catch (err: unknown) {
        // Gracefully handle tool call exceptions, whether they were thrown by
        // the origin server or internally by the gateway.
        toolCallResponse = handleMcpToolCallError(err, {
          toolName,
          env: this.env
        })

        return toolCallResponse
      } finally {
        assert(toolCallResponse, 500, 'Missing tool call response')

        // Augment the MCP tool call response with agentic metadata, which
        // makes it easier to debug tool calls and adds some much-needed HTTP
        // header-like functionality to tool call responses.
        toolCallResponse._meta = createAgenticMcpMetadata(
          {
            deploymentId: deployment.id,
            consumerId: consumer?.id,
            toolName,
            cacheStatus: resolvedOriginToolCallResult?.cacheStatus,
            headers: getRateLimitHeaders(
              resolvedOriginToolCallResult?.rateLimitResult
            )
          },
          toolCallResponse._meta
        )

        // Record tool call usage, whether the call was successful or not.
        recordToolCallUsage({
          ...this.props,
          tool,
          mcpToolCallResponse: toolCallResponse!,
          resolvedOriginToolCallResult,
          sessionId,
          env: this.env,
          waitUntil: this.ctx.waitUntil.bind(this.ctx)
        })
      }
    })
  }
}

export const DurableMcpServer = Sentry.instrumentDurableObjectWithSentry(
  (env: RawEnv) => ({
    dsn: env.SENTRY_DSN,
    environment: env.ENVIRONMENT,
    integrations: [Sentry.extraErrorDataIntegration()]
  }),
  DurableMcpServerBase
)


================================================
FILE: apps/gateway/src/lib/env.ts
================================================
import type {
  AnalyticsEngineDataset,
  DurableObjectNamespace
} from '@cloudflare/workers-types'
import type { Simplify } from 'type-fest'
import { parseZodSchema } from '@agentic/platform-core'
import {
  envSchema as baseEnvSchema,
  parseEnv as parseBaseEnv
} from '@agentic/platform-hono'
import { z } from 'zod'

export const envSchema = baseEnvSchema
  .extend({
    AGENTIC_API_BASE_URL: z.string().url(),
    AGENTIC_API_KEY: z.string().nonempty(),

    STRIPE_SECRET_KEY: z.string().nonempty(),

    DO_RATE_LIMITER: z.custom<DurableObjectNamespace>((ns) =>
      isDurableObjectNamespace(ns)
    ),

    DO_MCP_SERVER: z.custom<DurableObjectNamespace>((ns) =>
      isDurableObjectNamespace(ns)
    ),

    DO_MCP_CLIENT: z.custom<DurableObjectNamespace>((ns) =>
      isDurableObjectNamespace(ns)
    ),

    AE_USAGE_DATASET: z.custom<AnalyticsEngineDataset>((ae) =>
      isAnalyticsEngineDataset(ae)
    )
  })
  .strip()
export type RawEnv = z.infer<typeof envSchema>

export function isDurableObjectNamespace(
  namespace: unknown
): namespace is DurableObjectNamespace {
  return (
    !!namespace &&
    typeof namespace === 'object' &&
    'newUniqueId' in namespace &&
    typeof namespace.newUniqueId === 'function' &&
    'idFromName' in namespace &&
    typeof namespace.idFromName === 'function'
  )
}

function isAnalyticsEngineDataset(ae: unknown): ae is AnalyticsEngineDataset {
  return !!ae && typeof ae === 'object' && 'writeDataPoint' in ae
}

export function parseEnv(inputEnv: Record<string, unknown>) {
  const baseEnv = parseBaseEnv({
    SERVICE: 'gateway',
    ...inputEnv
  })

  const env = parseZodSchema(
    envSchema,
    { ...inputEnv, ...baseEnv },
    {
      error: 'Invalid environment variables'
    }
  )

  const isStripeLive = env.STRIPE_SECRET_KEY.startsWith('sk_live_')

  return {
    ...baseEnv,
    ...env,
    isStripeLive
  }
}

export type Env = Simplify<ReturnType<typeof parseEnv>>


================================================
FILE: apps/gateway/src/lib/external/stripe.ts
================================================
import Stripe from 'stripe'

import type { RawEnv } from '../env'

export function createStripe(env: RawEnv): Stripe {
  return new Stripe(env.STRIPE_SECRET_KEY, {
    apiVersion: '2025-06-30.basil'
  })
}


================================================
FILE: apps/gateway/src/lib/fetch-cache.ts
================================================
import type { WaitUntil } from './types'

export async function fetchCache({
  cacheKey,
  fetchResponse,
  waitUntil
}: {
  cacheKey?: Request
  fetchResponse: () => Promise<Response>
  waitUntil: WaitUntil
}): Promise<Response> {
  const cache = caches.default
  let response: Response | undefined

  if (cacheKey) {
    response = await cache.match(cacheKey)
  }

  if (!response) {
    response = await fetchResponse()
    response = new Response(response.body, response)

    if (cacheKey) {
      if (response.headers.has('Cache-Control')) {
        // Note that cloudflare's `cache` should respect response headers.
        waitUntil(
          cache.put(cacheKey, response.clone()).catch((err) => {
            // eslint-disable-next-line no-console
            console.warn('cache put error', cacheKey, err)
          })
        )
      }

      response.headers.set('cf-cache-status', 'MISS')
    } else {
      response.headers.set('cf-cache-status', 'BYPASS')
    }
  }

  return response
}


================================================
FILE: apps/gateway/src/lib/get-admin-consumer.ts
================================================
import { assert, HttpError } from '@agentic/platform-core'

import type { AdminConsumer, GatewayHonoContext } from './types'

export async function getAdminConsumer(
  ctx: GatewayHonoContext,
  apiKey: string
): Promise<AdminConsumer> {
  const client = ctx.get('client')
  let consumer: AdminConsumer | undefined

  try {
    consumer = await client.adminGetConsumerByApiKey({
      apiKey,
      populate: ['user']
    })
  } catch (err: any) {
    if (err.response?.status === 404) {
      // Hide the underlying error message from the client
      throw new HttpError({
        statusCode: 404,
        message: `API key not found "${apiKey}"`,
        cause: err
      })
    }

    throw err
  }

  assert(consumer, 404, `API key not found "${apiKey}"`)
  return consumer
}


================================================
FILE: apps/gateway/src/lib/get-admin-deployment.ts
================================================
import type { AdminDeployment } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'

import type { GatewayHonoContext } from './types'

export async function getAdminDeployment(
  ctx: GatewayHonoContext,
  identifier: string
): Promise<AdminDeployment> {
  const parsedDeploymentIdentifier = parseDeploymentIdentifier(identifier, {
    strict: true,
    errorStatusCode: 404
  })

  const client = ctx.get('client')
  const deployment = await client.adminGetDeploymentByIdentifier({
    deploymentIdentifier: parsedDeploymentIdentifier.deploymentIdentifier
  })
  assert(deployment, 404, `Deployment not found "${identifier}"`)

  return deployment
}


================================================
FILE: apps/gateway/src/lib/get-request-cache-key.ts
================================================
import { hashObject, sha256 } from '@agentic/platform-core'
import contentType from 'fast-content-type-parse'

import { normalizeUrl } from './normalize-url'
import { isRequestPubliclyCacheable } from './utils'

// TODO: what is a reasonable upper bound for hashing the POST body size?
const MAX_POST_BODY_SIZE_BYTES = 10_000

export async function getRequestCacheKey(
  request: Request
): Promise<Request | undefined> {
  try {
    if (!isRequestPubliclyCacheable(request)) {
      return
    }

    if (
      request.method === 'POST' ||
      request.method === 'PUT' ||
      request.method === 'PATCH'
    ) {
      const contentLength = Number.parseInt(
        request.headers.get('content-length') ?? '0'
      )

      if (contentLength < MAX_POST_BODY_SIZE_BYTES) {
        const { type } = contentType.safeParse(
          request.headers.get('content-type') || 'application/octet-stream'
        )
        let hash = '___AGENTIC_CACHE_KEY_EMPTY_BODY___'

        if (contentLength > 0) {
          if (type.includes('json')) {
            const bodyJson: any = await request.clone().json()
            hash = await hashObject(bodyJson)
          } else if (type.includes('text/')) {
            const bodyString = await request.clone().text()
            hash = await sha256(bodyString)
          } else {
            const bodyBuffer = await request.clone().arrayBuffer()
            hash = await sha256(bodyBuffer)
          }
        }

        const cacheUrl = new URL(request.url)
        cacheUrl.searchParams.set('x-agentic-cache-key', hash)
        const normalizedUrl = normalizeUrl(cacheUrl.toString())

        // Convert POST and PUT requests to GET with a query param containing
        // a hash of the request body. This enables us to cache these requests
        // more easily, since we want to move the the "cacheability" logic to a
        // higher-level, config-based approach. E.g., individual tools can
        // opt-in to aggressive caching by declaring themselves `pure` or
        // `immutable` regardless of the HTTP method used to call the tool.
        const newReq = normalizeRequestHeaders(
          new Request(normalizedUrl, {
            headers: request.headers,
            method: 'GET'
          })
        )

        return newReq
      }
    } else if (request.method === 'GET' || request.method === 'HEAD') {
      const url = request.url
      const normalizedUrl = normalizeUrl(url)

      if (url !== normalizedUrl) {
        return normalizeRequestHeaders(
          new Request(normalizedUrl, {
            method: request.method
          })
        )
      }
    }

    return normalizeRequestHeaders(new Request(request))
  } catch (err) {
    // eslint-disable-next-line no-console
    console.warn(
      'warning: failed to compute cache key',
      request.method,
      request.url,
      err
    )
  }
}

const requestHeaderWhitelist = new Set([
  'cache-control',
  'content-type',
  'mcp-session-id'
])

function normalizeRequestHeaders(request: Request) {
  const headers = Object.fromEntries(request.headers.entries())
  const keys = Object.keys(headers)

  for (const key of keys) {
    if (!requestHeaderWhitelist.has(key)) {
      request.headers.delete(key)
    }
  }

  return request
}


================================================
FILE: apps/gateway/src/lib/get-tool-args-from-request.ts
================================================
import type { AdminDeployment, Tool } from '@agentic/platform-types'
import { assert, HttpError } from '@agentic/platform-core'

import type { GatewayHonoContext } from './types'
import { cfValidateJsonSchema } from './cf-validate-json-schema'

export async function getToolArgsFromRequest(
  ctx: GatewayHonoContext,
  {
    tool,
    deployment
  }: {
    tool: Tool
    deployment: AdminDeployment
  }
): Promise<Record<string, any>> {
  const logger = ctx.get('logger')
  const request = ctx.req.raw
  assert(
    deployment.origin.type !== 'raw',
    500,
    `Internal logic error for origin adapter type "${deployment.origin.type}"`
  )

  if (request.method === 'GET') {
    // Args will be coerced to match their expected types via
    // `cfValidateJsonSchemaObject` since all values will be strings.
    const incomingRequestArgsRaw = Object.fromEntries(
      new URL(request.url).searchParams.entries()
    )

    const toolConfig = deployment.toolConfigs.find(
      (toolConfig) => toolConfig.name === tool.name
    )

    // Validate incoming request params against the tool's input schema.
    const incomingRequestArgs = cfValidateJsonSchema<Record<string, any>>({
      schema: tool.inputSchema,
      data: incomingRequestArgsRaw,
      errorPrefix: `Invalid request parameters for tool "${tool.name}"`,
      coerce: true,
      strictAdditionalProperties:
        toolConfig?.inputSchemaAdditionalProperties === false
    })

    return incomingRequestArgs
  } else if (request.method === 'POST') {
    let incomingRequestArgsRaw: unknown = {}

    // TODO: verify content-type of request is application/json

    try {
      incomingRequestArgsRaw = (await request.json()) as Record<string, any>
    } catch (err) {
      // Error if the request body is not JSON or is malformed.
      logger.error('Error parsing incoming request body', request, err)
      throw new HttpError({
        message: 'Invalid request body json',
        statusCode: 400,
        cause: err
      })
    }

    // console.log(
    //   'incomingRequestArgsRaw',
    //   typeof incomingRequestArgsRaw,
    //   request.headers,
    //   incomingRequestArgsRaw
    // )

    // TODO: Proper support for empty params with POST requests
    assert(incomingRequestArgsRaw, 400, 'Invalid empty request body')
    assert(
      typeof incomingRequestArgsRaw === 'object',
      400,
      `Invalid request body: expected type "object", received type "${typeof incomingRequestArgsRaw}"`
    )
    assert(!Array.isArray(incomingRequestArgsRaw), 400, 'Invalid request body')
    return incomingRequestArgsRaw
  } else {
    assert(false, 405, `HTTP method "${request.method}" not allowed`)
  }
}


================================================
FILE: apps/gateway/src/lib/get-tool.ts
================================================
import type { AdminDeployment, Tool } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'

export function getTool({
  toolName,
  deployment,
  method,
  strict = false
}: {
  toolName: string
  deployment: AdminDeployment
  method?: string
  strict?: boolean
}): Tool {
  assert(toolName, 404, `Invalid input empty tool name`)

  let tool = deployment.tools.find((tool) => tool.name === toolName)

  if (!tool && !strict) {
    if (deployment.origin.type === 'openapi') {
      // Check if the tool name is an operation ID since it's easy to forget
      // and mistake the two (`getPost` vs `get_post`).
      // TODO: In the future, we should be consistent about how we handle tool
      // names. Do we always allow camelCase and snake_case, or do we just allow
      // alternates for operationIds? We should also make sure alternates are
      // uniquely defined.
      const operationToolName = Object.entries(
        deployment.origin.toolToOperationMap
      ).find(([_, operation]) => {
        if (operation.operationId === toolName) {
          return true
        }

        return false
      })?.[0]

      if (operationToolName) {
        tool = deployment.tools.find((tool) => tool.name === operationToolName)

        assert(
          tool,
          404,
          `Tool not found "${toolName}" for deployment "${deployment.identifier}": did you mean "${operationToolName}"?`
        )
      }
    }
  }

  assert(
    tool,
    404,
    `Tool not found "${toolName}" for deployment "${deployment.identifier}"`
  )

  if (deployment.origin.type === 'openapi') {
    const operation = deployment.origin.toolToOperationMap[tool.name]
    assert(
      operation,
      404,
      `OpenAPI operation not found for tool "${tool.name}"`
    )
    if (method) {
      assert(
        method === 'GET' || method === 'POST',
        405,
        `Invalid HTTP method "${method}" for tool "${tool.name}"`
      )
    }
  }

  return tool
}


================================================
FILE: apps/gateway/src/lib/handle-mcp-tool-call-error.ts
================================================
import type { ContentfulStatusCode } from 'hono/utils/http-status'
import { HttpError } from '@agentic/platform-core'
import { suppressedHttpStatuses } from '@agentic/platform-hono'
import * as Sentry from '@sentry/cloudflare'
import { HTTPException } from 'hono/http-exception'
import { HTTPError } from 'ky'

import type { RawEnv } from './env'
import type { McpToolCallResponse } from './types'

/**
 * Turns a thrown error into an MCP error tool call response, and attempts to
 * capture as much context as possible for potential debugging.
 *
 * @note This function is synchronous and should never throw.
 */
export function handleMcpToolCallError(
  err: any,
  {
    toolName,
    env
  }: {
    toolName: string
    env: RawEnv
  }
): McpToolCallResponse {
  const isProd = env.ENVIRONMENT === 'production'
  let message = 'Internal Server Error'
  let status: ContentfulStatusCode = 500

  const res: McpToolCallResponse = {
    _meta: {
      agentic: {
        toolName,
        headers: {}
      }
    },
    isError: true,
    content: [
      {
        type: 'text',
        text: message
      }
    ]
  }

  if (err instanceof HttpError) {
    message = err.message
    status = err.statusCode as ContentfulStatusCode

    // This is where rate-limit headers will be set, since `RateLimitError`
    // is a subclass of `HttpError`.
    if (err.headers) {
      for (const [key, value] of Object.entries(err.headers)) {
        ;(res._meta!.agentic as any).headers[key] = value
      }
    }
  } else if (err instanceof HTTPException) {
    message = err.message
    status = err.status
  } else if (err instanceof HTTPError) {
    message = err.message
    status = err.response.status as ContentfulStatusCode
  } else if (!isProd && err.message) {
    message = err.message
  }

  if (!Number.isSafeInteger(status)) {
    status = 500
  }

  if (!suppressedHttpStatuses.has(status)) {
    if (status >= 500) {
      // eslint-disable-next-line no-console
      console.error(`mcp tool call "${toolName}" error`, status, err)

      if (isProd) {
        try {
          Sentry.captureException(err)
        } catch (err_) {
          // eslint-disable-next-line no-console
          console.error('Error Sentry.captureException failed', err, err_)
        }
      }
    } else {
      // eslint-disable-next-line no-console
      console.warn(`mcp tool call "${toolName}" warning`, status, err)
    }
  }

  ;(res._meta!.agentic as any).status = status
  res.content = [
    {
      type: 'text',
      text: message
    }
  ]

  return res
}


================================================
FILE: apps/gateway/src/lib/normalize-url.test.ts
================================================
import { expect, test } from 'vitest'

import { normalizeUrl } from './normalize-url'

test('main', () => {
  expect(normalizeUrl('http://sindresorhus.com')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('http://sindresorhus.com ')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('http://sindresorhus.com.')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('http://SindreSorhus.com')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('http://sindresorhus.com')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('HTTP://sindresorhus.com')).toBe(
    'https://sindresorhus.com'
  )

  // TODO: why isn't this parsed correctly by Node.js URL?
  // t.is(normalizeUrl('//sindresorhus.com'), 'https://sindresorhus.com')

  expect(normalizeUrl('http://sindresorhus.com')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('http://sindresorhus.com:80')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('https://sindresorhus.com:443')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('ftp://sindresorhus.com:21')).toBe(
    'ftp://sindresorhus.com'
  )
  expect(normalizeUrl('https://sindresorhus.com/foo/')).toBe(
    'https://sindresorhus.com/foo'
  )
  expect(normalizeUrl('http://sindresorhus.com/?foo=bar baz')).toBe(
    'https://sindresorhus.com/?foo=bar+baz'
  )
  expect(normalizeUrl('https://foo.com/https://bar.com')).toBe(
    'https://foo.com/https://bar.com'
  )
  expect(normalizeUrl('https://foo.com/https://bar.com/foo//bar')).toBe(
    'https://foo.com/https://bar.com/foo/bar'
  )
  expect(normalizeUrl('https://foo.com/http://bar.com')).toBe(
    'https://foo.com/http://bar.com'
  )
  expect(normalizeUrl('https://foo.com/http://bar.com/foo//bar')).toBe(
    'https://foo.com/http://bar.com/foo/bar'
  )
  expect(normalizeUrl('https://foo.com/http://bar.com/foo//bar')).toBe(
    'https://foo.com/http://bar.com/foo/bar'
  )
  expect(normalizeUrl('https://sindresorhus.com/%7Efoo/')).toBe(
    'https://sindresorhus.com/~foo'
  )
  expect(normalizeUrl('https://sindresorhus.com/?')).toBe(
    'https://sindresorhus.com'
  )
  expect(normalizeUrl('https://êxample.com')).toBe('https://xn--xample-hva.com')
  expect(
    normalizeUrl('https://sindresorhus.com/?b=bar&a=foo'),
    'https://sindresorhus.com/?a=foo&b=bar'
  )
  expect(normalizeUrl('https://sindresorhus.com/?foo=bar*|<>:"')).toBe(
    'https://sindresorhus.com/?foo=bar*%7C%3C%3E%3A%22'
  )
  expect(normalizeUrl('https://sindresorhus.com:5000')).toBe(
    'https://sindresorhus.com:5000'
  )
  expect(normalizeUrl('https://sindresorhus.com/foo#bar')).toBe(
    'https://sindresorhus.com/foo#bar'
  )
  expect(normalizeUrl('https://sindresorhus.com/foo/bar/../baz')).toBe(
    'https://sindresorhus.com/foo/baz'
  )
  expect(normalizeUrl('https://sindresorhus.com/foo/bar/./baz')).toBe(
    'https://sindresorhus.com/foo/bar/baz'
  )
  expect(
    normalizeUrl(
      'https://i.vimeocdn.com/filter/overlay?src0=https://i.vimeocdn.com/video/598160082_1280x720.jpg&src1=https://f.vimeocdn.com/images_v6/share/play_icon_overlay.png'
    )
  ).toBe(
    'https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F598160082_1280x720.jpg&src1=https%3A%2F%2Ff.vimeocdn.com%2Fimages_v6%2Fshare%2Fplay_icon_overlay.png'
  )
})

test('removeTrailingSlash and removeDirectoryIndex options)', () => {
  expect(normalizeUrl('https://sindresorhus.com/path/')).toBe(
    'https://sindresorhus.com/path'
  )
  expect(normalizeUrl('https://sindresorhus.com/#/path/')).toBe(
    'https://sindresorhus.com/#/path/'
  )
  expect(normalizeUrl('https://sindresorhus.com/foo/#/bar/')).toBe(
    'https://sindresorhus.com/foo#/bar/'
  )
})

test('sortQueryParameters', () => {
  expect(normalizeUrl('https://sindresorhus.com/?a=Z&b=Y&c=X&d=W')).toBe(
    'https://sindresorhus.com/?a=Z&b=Y&c=X&d=W'
  )
  expect(normalizeUrl('https://sindresorhus.com/?b=Y&c=X&a=Z&d=W')).toBe(
    'https://sindresorhus.com/?a=Z&b=Y&c=X&d=W'
  )
  expect(normalizeUrl('https://sindresorhus.com/?a=Z&d=W&b=Y&c=X')).toBe(
    'https://sindresorhus.com/?a=Z&b=Y&c=X&d=W'
  )
  expect(normalizeUrl('https://sindresorhus.com/')).toBe(
    'https://sindresorhus.com'
  )
})

test('invalid urls', () => {
  expect(() => {
    normalizeUrl('http://')
  }).toThrow('Invalid URL')

  expect(() => {
    normalizeUrl('/')
  }).toThrow('Invalid URL')

  expect(() => {
    normalizeUrl('/relative/path/')
  }).toThrow('Invalid URL')
})

test('remove duplicate pathname slashes', () => {
  expect(normalizeUrl('https://sindresorhus.com////foo/bar')).toBe(
    'https://sindresorhus.com/foo/bar'
  )
  expect(normalizeUrl('https://sindresorhus.com////foo////bar')).toBe(
    'https://sindresorhus.com/foo/bar'
  )
  expect(normalizeUrl('ftp://sindresorhus.com//foo')).toBe(
    'ftp://sindresorhus.com/foo'
  )
  expect(normalizeUrl('https://sindresorhus.com:5000///foo')).toBe(
    'https://sindresorhus.com:5000/foo'
  )
  expect(normalizeUrl('https://sindresorhus.com///foo')).toBe(
    'https://sindresorhus.com/foo'
  )
  expect(normalizeUrl('https://sindresorhus.com:5000//foo')).toBe(
    'https://sindresorhus.com:5000/foo'
  )
  expect(normalizeUrl('https://sindresorhus.com//foo')).toBe(
    'https://sindresorhus.com/foo'
  )
})


================================================
FILE: apps/gateway/src/lib/normalize-url.ts
================================================
/**
 * Stripped down version of [normalize-url](https://github.com/sindresorhus/normalize-url)
 * by sindresorhus
 *
 * - always converts http => https
 * - removed unused options
 * - removed dataURL support
 */
export function normalizeUrl(url: string): string {
  const urlObj = new URL(url)

  if (urlObj.protocol === 'http:') {
    urlObj.protocol = 'https:'
  }

  /*
  // Remove auth
  // TODO: Cloudflare Workers seems to have a subtle bug where if you set URL.username and
  // URL.password at all, it will include the @ authentication prefix in the resulting URL.
  // This does not repro in normal web or Node.js contexts.
  if (options.stripAuthentication) {
    urlObj.username = ''
    urlObj.password = ''
  }
  */

  // Remove duplicate slashes if not preceded by a protocol
  if (urlObj.pathname) {
    urlObj.pathname = urlObj.pathname.replaceAll(/(?<!https?:)\/{2,}/g, '/')
  }

  // Decode URI octets
  if (urlObj.pathname) {
    urlObj.pathname = decodeURI(urlObj.pathname)
  }

  if (urlObj.hostname) {
    // Remove trailing dot
    urlObj.hostname = urlObj.hostname.replace(/\.$/, '')
  }

  // Sort query parameters
  urlObj.searchParams.sort()

  // Remove trailing `/`
  urlObj.pathname = urlObj.pathname.replace(/\/$/, '')

  url = urlObj.toString()

  // Remove trailing `/` for real this time
  if (urlObj.pathname === '/' && urlObj.hash === '') {
    url = url.replace(/\/$/, '')
  }

  return url
}


================================================
FILE: apps/gateway/src/lib/rate-limits/durable-rate-limiter.ts
================================================
import type { SetOptional } from 'type-fest'
import * as Sentry from '@sentry/cloudflare'
import { DurableObject } from 'cloudflare:workers'

import type { RawEnv } from '../env'
import type { RateLimitState } from '../types'

const initialState: SetOptional<RateLimitState, 'resetTimeMs'> = {
  current: 0
}

export class DurableRateLimiterBase extends DurableObject<RawEnv> {
  async update({
    intervalMs,
    cost = 1
  }: {
    intervalMs: number
    cost?: number
  }): Promise<RateLimitState> {
    const existingState = await this.ctx.storage.get<RateLimitState>('value')
    const currentAlarm = await this.ctx.storage.getAlarm()

    const now = Date.now()
    const updatedResetTimeMs = now + intervalMs

    // Update the payload
    const state =
      existingState && currentAlarm && currentAlarm > now
        ? existingState
        : {
            current: 0,
            resetTimeMs: updatedResetTimeMs
          }
    state.current += cost

    // Update the alarm
    if (!currentAlarm || currentAlarm <= now) {
      await this.ctx.storage.setAlarm(state.resetTimeMs)
    }

    await this.ctx.storage.put('value', state)

    // const updatedState = await this.ctx.storage.get<RateLimitState>('value')
    // console.log('DurableRateLimiter.update', this.ctx.id.toString(), {
    //   existingState,
    //   state,
    //   updatedState,
    //   now,
    //   intervalMs,
    //   updatedResetTimeMs,
    //   currentAlarm
    // })

    return state
  }

  async reset() {
    // console.log('reset rate-limit', this.ctx.id)
    await this.ctx.storage.put('value', initialState)
  }

  override async alarm() {
    await this.reset()
  }
}

export const DurableRateLimiter = Sentry.instrumentDurableObjectWithSentry(
  (env: RawEnv) => ({
    dsn: env.SENTRY_DSN,
    environment: env.ENVIRONMENT,
    integrations: [Sentry.extraErrorDataIntegration()]
  }),
  DurableRateLimiterBase
)


================================================
FILE: apps/gateway/src/lib/rate-limits/enforce-rate-limit.ts
================================================
import type { RateLimit } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'

import type { RawEnv } from '../env'
import type {
  RateLimitCache,
  RateLimitResult,
  RateLimitState,
  WaitUntil
} from '../types'
import type { DurableRateLimiterBase } from './durable-rate-limiter'

/**
 * This maps persists across worker executions and is used for caching active
 * rate limits. It's purely a performance optimization and is not used as a
 * source of truth.
 */
const globalRateLimitCache: RateLimitCache = new Map()

export async function enforceRateLimit({
  rateLimit,
  id,
  cost = 1,
  env,
  cache = globalRateLimitCache,
  waitUntil
}: {
  /**
   * The rate limit to enforce.
   */
  rateLimit: RateLimit

  /**
   * The identifier used to uniquely track this rate limit.
   */
  id: string

  /**
   * The cost of the request.
   *
   * @default 1
   */
  cost?: number

  env: RawEnv
  cache?: RateLimitCache
  waitUntil: WaitUntil
}): Promise<RateLimitResult | undefined> {
  if (rateLimit.enabled === false) {
    return
  }

  assert(id, 400, 'Unauthenticated requests must have a valid IP address')

  const { interval, limit, mode } = rateLimit
  const intervalMs = interval * 1000
  const now = Date.now()

  const initialRateLimitState = cache.get(id) ?? {
    current: 0,
    resetTimeMs: now + intervalMs
  }
  let rateLimitState = initialRateLimitState

  function updateCache(info: RateLimitState) {
    cache.set(id, info)
    rateLimitState = info
  }

  /**
   * Short-circuit check for active rate limits that are currently exceeded.
   *
   * This might not happen too often, but in extreme cases the cache should hit
   * and we can skip the request to the durable object entirely, which speeds
   * everything up and is cheaper for us.
   */
  if (rateLimitState.current > limit && now <= rateLimitState.resetTimeMs) {
    return {
      id,
      passed: false,
      current: rateLimitState.current,
      limit,
      resetTimeMs: rateLimitState.resetTimeMs,
      intervalMs,
      remaining: Math.max(0, limit - rateLimitState.current)
    }
  }

  const durableRateLimiterId = env.DO_RATE_LIMITER.idFromName(id)
  const durableRateLimiter = env.DO_RATE_LIMITER.get(
    durableRateLimiterId
  ) as DurableObjectStub<DurableRateLimiterBase>

  const updatedRateLimitStateP = durableRateLimiter.update({ cost, intervalMs })

  if (mode === 'strict') {
    const updatedRateLimitState = await updatedRateLimitStateP
    updateCache(updatedRateLimitState)
  } else {
    waitUntil(
      updatedRateLimitStateP
        .then((updatedRateLimitState: RateLimitState) => {
          updateCache(updatedRateLimitState)
        })
        .catch((err: Error) => {
          // eslint-disable-next-line no-console
          console.error(
            `error updating rate limit for id "${id}": ${err.message}`
          )
        })
    )

    rateLimitState.current += cost
    updateCache(rateLimitState)
  }

  // console.log('rateLimit', {
  //   id,
  //   initial: initialRateLimitState,
  //   current: rateLimitState,
  //   mode,
  //   cost
  // })

  return {
    id,
    passed: rateLimitState.current <= limit,
    limit,
    current: rateLimitState.current,
    remaining: Math.max(0, limit - rateLimitState.current),
    resetTimeMs: rateLimitState.resetTimeMs,
    intervalMs
  }
}


================================================
FILE: apps/gateway/src/lib/record-tool-call-usage.ts
================================================
import type {
  AdminDeployment,
  PricingPlan,
  Tool
} from '@agentic/platform-types'

import type { RawEnv } from './env'
import type {
  AdminConsumer,
  EdgeRequestMode,
  McpToolCallResponse,
  ResolvedOriginToolCallResult,
  WaitUntil
} from './types'
import { createAgenticClient } from './agentic-client'
import { createStripe } from './external/stripe'

/**
 * Records usage data to Cloudflare Analytics Engine.
 *
 * Also asynchronously activates the `consumer` if it's present and hasn't been
 * activated yet.
 *
 * Also asynchronously reports usage to Stripe if `consumer` is present and
 * `resolvedOriginToolCallResult.reportUsage` is `true`.
 *
 * @note This function should be **synchronous**. Any asynchronous operations
 * should use the `waitUntil` callback to not block the response from returning
 * to the end user promptly.
 *
 * @see https://developers.cloudflare.com/analytics/analytics-engine/limits/
 */
export function recordToolCallUsage({
  edgeRequestMode,
  deployment,
  consumer,
  tool,
  resolvedOriginToolCallResult,
  httpResponse,
  mcpToolCallResponse,
  ip,
  sessionId,
  requestId,
  env,
  waitUntil
}: {
  edgeRequestMode: EdgeRequestMode
  deployment: AdminDeployment
  consumer?: AdminConsumer
  pricingPlan?: PricingPlan
  tool?: Tool
  resolvedOriginToolCallResult?: ResolvedOriginToolCallResult
  httpResponse?: Response
  mcpToolCallResponse?: McpToolCallResponse
  ip?: string
  sessionId: string
  requestId?: string
  env: RawEnv
  waitUntil: WaitUntil
} & (
  | {
      // For http requests, an http response is required.
      edgeRequestMode: 'HTTP'
      httpResponse: Response
      mcpToolCallResponse?: never
    }
  | {
      // For mcp cool call requests, an mcp tool call response is required.
      edgeRequestMode: 'MCP'
      httpResponse?: never
      mcpToolCallResponse: McpToolCallResponse
    }
)): void {
  const { projectId } = deployment
  const {
    rateLimitResult,
    cacheStatus,
    originTimespanMs,
    toolCallArgs,
    numRequestsCost,
    reportUsage
  } = resolvedOriginToolCallResult ?? {
    numRequestsCost: 0,
    reportUsage: false
  }
  mcpToolCallResponse ??= resolvedOriginToolCallResult?.toolCallResponse

  const requestSize = toolCallArgs ? JSON.stringify(toolCallArgs).length : 0
  const responseSize =
    Number.parseInt(httpResponse?.headers.get('content-length') ?? '0') ||
    (mcpToolCallResponse ? JSON.stringify(mcpToolCallResponse).length : 0)

  // The string dimensions used for grouping and filtering (sometimes called
  // labels in other metrics systems).
  // NOTE: The ordering of these fields is important and must remain consistent!
  // Max of 20 blobs with total size <= 5120 bytes.
  const blobs = [
    // Project ID of the request
    projectId,

    // Deployment ID of the request
    deployment.id,

    // Name of the tool that was called
    tool?.name ?? null,

    // Whether this request was made via MCP or HTTP
    edgeRequestMode,

    // IP address or session ID
    ip ?? sessionId,

    // Request customer ID
    consumer?.id ?? null,

    // Request customer subscription plan
    consumer?.plan ?? null,

    // Request customer subscription status
    consumer?.stripeStatus ?? null,

    // Whether the request was rate-limited
    rateLimitResult
      ? rateLimitResult.passed
        ? 'rl-passed'
        : 'rl-exceeded'
      : mcpToolCallResponse?._meta?.status === 429
        ? 'rl-exceeded'
        : null,

    // Whether the request hit the cache
    cacheStatus ?? null,

    // HTTP response status
    httpResponse?.status?.toString() ||
      (mcpToolCallResponse
        ? mcpToolCallResponse._meta?.status?.toString() ||
          (mcpToolCallResponse?.isError ? 'error' : '200')
        : 'error')
  ]

  // Numberic values to record in this data point.
  // NOTE: The ordering of these fields is important and must remain consistent!
  const doubles = [
    // Origin timespan in milliseconds
    originTimespanMs ?? 0,

    // Request bandwidth in bytes
    requestSize,

    // Response bandwidth in bytes
    responseSize,

    // Total bandwidth in bytes
    // TODO: Correctly calculate total bandwidth using `content-length`
    requestSize + responseSize,

    // Number of requests cost
    numRequestsCost ?? 0
  ]

  // Cloudflare Analytics Engine only supports writing a single index at a time,
  // so we associate this usage with the project.
  // TODO: Should we also index based on customer ID / IP? Or is being able to
  // filter by these fields in the project's `blobs` enough?
  env.AE_USAGE_DATASET.writeDataPoint({
    indexes: [projectId],
    blobs,
    doubles
  })

  if (consumer && !consumer.activated) {
    const client = createAgenticClient({
      env,
      cache: caches.default,
      waitUntil,
      isCachingEnabled: false
    })

    // If there's a consumer and it hasn't been activated yet, make sure it's
    // activated. This may be called multiple times if the consumer is cached,
    // but this method is intentionally idempotent, and we don't cache non-
    // activated consumers for long, so it shouldn't be a problem.
    waitUntil(client.adminActivateConsumer({ consumerId: consumer.id }))
  }

  if (consumer && reportUsage) {
    const stripe = createStripe(env)

    const pricingPlanLineItemSlug = 'requests'
    const eventName = `meter-${projectId}-${pricingPlanLineItemSlug}`
    const identifier = requestId
      ? `${requestId}:${consumer.id}:${tool?.name || 'unknown-tool'}`
      : undefined

    // Report usage to Stripe asynchronously.
    waitUntil(
      stripe.billing.meterEvents.create({
        event_name: eventName,
        identifier,
        payload: {
          value: numRequestsCost.toString(),
          stripe_customer_id: consumer._stripeCustomerId
        }
      })
    )
  }
}


================================================
FILE: apps/gateway/src/lib/reset.d.ts
================================================
import '@fisch0920/config/ts-reset'


================================================
FILE: apps/gateway/src/lib/resolve-edge-request.ts
================================================
import type { AdminDeployment, PricingPlan } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import { parseToolIdentifier } from '@agentic/platform-validators'

import type {
  AdminConsumer,
  GatewayHonoContext,
  ResolvedEdgeRequest
} from './types'
import { getAdminConsumer } from './get-admin-consumer'
import { getAdminDeployment } from './get-admin-deployment'

/**
 * Resolves an input HTTP request to a specific deployment and edge request
 * mode (MCP or HTTP).
 */
export async function resolveEdgeRequest(
  ctx: GatewayHonoContext
): Promise<ResolvedEdgeRequest> {
  const requestUrl = new URL(ctx.req.url)
  const { pathname } = requestUrl
  const requestedToolIdentifier = pathname.replace(/^\//, '').replace(/\/$/, '')
  const parsedToolIdentifier = parseToolIdentifier(requestedToolIdentifier)

  const deployment = await getAdminDeployment(
    ctx,
    parsedToolIdentifier.deploymentIdentifier
  )

  const edgeRequestMode =
    parsedToolIdentifier.toolName === 'mcp' ? 'MCP' : 'HTTP'

  return {
    edgeRequestMode,
    parsedToolIdentifier,
    deployment,
    requestId: ctx.get('requestId'),
    ip: ctx.get('ip')
  }
}

/**
 * Resolves a consumer and pricing plan for an edge request.
 */
export async function resolveConsumerForEdgeRequest(
  ctx: GatewayHonoContext,
  {
    deployment,
    apiKey
  }: {
    deployment: AdminDeployment
    apiKey?: string
  }
): Promise<{
  consumer?: AdminConsumer
  pricingPlan?: PricingPlan
}> {
  let pricingPlan: PricingPlan | undefined
  let consumer: AdminConsumer | undefined

  if (apiKey) {
    consumer = await getAdminConsumer(ctx, apiKey)
    assert(consumer, 401, `Invalid API key "${apiKey}"`)
    assert(
      consumer.isStripeSubscriptionActive,
      402,
      `API key "${apiKey}" does not have an active subscription`
    )
    assert(
      consumer.projectId === deployment.projectId,
      403,
      `API key "${apiKey}" is not authorized for project "${deployment.projectId}"`
    )

    // TODO: Ensure that consumer.plan is compatible with the target deployment?
    // TODO: This could definitely cause issues when changing pricing plans.

    pricingPlan = deployment.pricingPlans.find(
      (pricingPlan) => consumer!.plan === pricingPlan.slug
    )

    // assert(
    //   pricingPlan,
    //   403,
    //   `Auth token "${token}" unable to find matching pricing plan for project "${deployment.project}"`
    // )
  } else {
    // For unauthenticated requests, default to a free pricing plan if available.
    pricingPlan = deployment.pricingPlans.find((plan) => plan.slug === 'free')
  }

  return {
    consumer,
    pricingPlan
  }
}


================================================
FILE: apps/gateway/src/lib/resolve-http-edge-request.ts
================================================
import { assert } from '@agentic/platform-core'

import type {
  GatewayHonoContext,
  ResolvedEdgeRequest,
  ResolvedHttpEdgeRequest
} from './types'
import { getTool } from './get-tool'
import { getToolArgsFromRequest } from './get-tool-args-from-request'
import { resolveConsumerForEdgeRequest } from './resolve-edge-request'
import { isRequestPubliclyCacheable } from './utils'

/**
 * Resolves an input HTTP request to a specific deployment, tool call, consumer,
 * and pricing plan.
 */
export async function resolveHttpEdgeRequest(
  ctx: GatewayHonoContext,
  resolvedEdgeRequest: ResolvedEdgeRequest
): Promise<ResolvedHttpEdgeRequest> {
  assert(
    resolvedEdgeRequest.edgeRequestMode === 'HTTP',
    500,
    `Internal error: Invalid edge request mode "${resolvedEdgeRequest.edgeRequestMode}" (expected "HTTP")`
  )
  const logger = ctx.get('logger')
  const ip = ctx.get('ip')

  const cacheControl = isRequestPubliclyCacheable(ctx.req.raw)
    ? ctx.req.header('cache-control')
    : 'no-store'

  const { deployment, parsedToolIdentifier } = resolvedEdgeRequest
  const { toolName } = parsedToolIdentifier
  const { method } = ctx.req

  const tool = getTool({
    method,
    deployment,
    toolName
  })

  logger.debug('request', {
    method,
    deploymentIdentifier: deployment.identifier,
    toolName,
    tool
  })

  const apiKey = (ctx.req.header('authorization') || '')
    .replace(/^Bearer /i, '')
    .trim()

  const { consumer, pricingPlan } = await resolveConsumerForEdgeRequest(ctx, {
    deployment,
    apiKey
  })

  if (consumer) {
    if (!ctx.get('sessionId')) {
      ctx.set('sessionId', `${consumer.id}:${deployment.id}`)
    }
  } else {
    if (!ctx.get('sessionId')) {
      assert(ip, 500, 'IP address is required for unauthenticated requests')
      ctx.set('sessionId', `${ip}:${deployment.projectId}`)
    }
  }

  // Parse tool call arguments from the request body.
  const toolCallArgs = await getToolArgsFromRequest(ctx, { tool, deployment })

  return {
    ...resolvedEdgeRequest,
    edgeRequestMode: 'HTTP',
    consumer,
    pricingPlan,
    tool,
    toolCallArgs,
    cacheControl
  }
}


================================================
FILE: apps/gateway/src/lib/resolve-mcp-edge-request.ts
================================================
import { assert } from '@agentic/platform-core'

import type {
  GatewayHonoContext,
  ResolvedEdgeRequest,
  ResolvedMcpEdgeRequest
} from './types'
import { resolveConsumerForEdgeRequest } from './resolve-edge-request'

export async function resolveMcpEdgeRequest(
  ctx: GatewayHonoContext,
  resolvedEdgeRequest: ResolvedEdgeRequest
): Promise<ResolvedMcpEdgeRequest> {
  assert(
    resolvedEdgeRequest.edgeRequestMode === 'MCP',
    500,
    `Internal error: Invalid edge request mode "${resolvedEdgeRequest.edgeRequestMode}" (expected "MCP")`
  )

  const { deployment } = resolvedEdgeRequest

  // TODO: Should MCP edge requests also support Authorization header?
  const apiKey = ctx.req.query('apiKey')?.trim()

  const { consumer, pricingPlan } = await resolveConsumerForEdgeRequest(ctx, {
    deployment,
    apiKey
  })

  return {
    ...resolvedEdgeRequest,
    edgeRequestMode: 'MCP',
    consumer,
    pricingPlan
  }
}


================================================
FILE: apps/gateway/src/lib/resolve-origin-tool-call.ts
================================================
import type {
  AdminDeployment,
  AgenticMcpRequestMetadata,
  PricingPlan,
  Tool
} from '@agentic/platform-types'
import type { DurableObjectStub } from '@cloudflare/workers-types'
import { assert, RateLimitError } from '@agentic/platform-core'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'

import type { DurableMcpClientBase } from './durable-mcp-client'
import type { RawEnv } from './env'
import type {
  AdminConsumer,
  CacheStatus,
  McpToolCallResponse,
  RateLimitResult,
  ResolvedOriginToolCallResult,
  ToolCallArgs,
  WaitUntil
} from './types'
import { cfValidateJsonSchema } from './cf-validate-json-schema'
import { createHttpRequestForOpenAPIOperation } from './create-http-request-for-openapi-operation'
import { fetchCache } from './fetch-cache'
import { getRequestCacheKey } from './get-request-cache-key'
import { enforceRateLimit } from './rate-limits/enforce-rate-limit'
import { updateOriginRequest } from './update-origin-request'
import {
  isCacheControlPubliclyCacheable,
  isResponsePubliclyCacheable
} from './utils'

export async function resolveOriginToolCall({
  tool,
  args,
  deployment,
  consumer,
  pricingPlan,
  ip,
  sessionId,
  env,
  cacheControl,
  waitUntil
}: {
  tool: Tool
  args?: ToolCallArgs
  deployment: AdminDeployment
  consumer?: AdminConsumer
  pricingPlan?: PricingPlan
  ip?: string
  sessionId: string
  env: RawEnv
  cacheControl?: string
  waitUntil: WaitUntil
}): Promise<ResolvedOriginToolCallResult> {
  // TODO: consider moving all of this per-request logic to a diff method since
  // it's not specific to tool calls. eg, other MCP requests may still need to
  // be rate-limited / cached / tracked / etc.

  const { origin } = deployment
  // TODO: make this configurable via `ToolConfig.cost`
  const numRequestsCost = 1
  let rateLimit = deployment.defaultRateLimit
  let rateLimitResult: RateLimitResult | undefined
  let cacheStatus: CacheStatus | undefined
  let reportUsage = true

  // Resolve rate limit and whether to report `requests` usage based on the
  // customer's pricing plan and deployment config.
  if (pricingPlan) {
    if (pricingPlan.rateLimit) {
      rateLimit = pricingPlan.rateLimit
    }

    const requestsLineItem = pricingPlan.lineItems.find(
      (lineItem) => lineItem.slug === 'requests'
    )

    if (!requestsLineItem) {
      // No `requests` line-item, so we don't report usage for this tool.
      reportUsage = false
    }
  }

  const toolConfig = deployment.toolConfigs.find(
    (toolConfig) => toolConfig.name === tool.name
  )

  if (toolConfig) {
    if (toolConfig.reportUsage !== undefined) {
      reportUsage &&= !!toolConfig.reportUsage
    }

    if (toolConfig.rateLimit !== undefined) {
      rateLimit = toolConfig.rateLimit
    }

    if (cacheControl) {
      if (!isCacheControlPubliclyCacheable(cacheControl)) {
        // Incoming request explicitly requests to bypass the gateway's cache.
        cacheStatus = 'BYPASS'
      } else {
        // TODO: Should we allow incoming cache-control headers to override the
        // gateway's cache behavior?
      }
    } else {
      // If the incoming request doesn't specify a desired `cache-control`,
      // then use a default based on the tool's configured settings.
      if (toolConfig.cacheControl !== undefined) {
        cacheControl = toolConfig.cacheControl
      } else if (toolConfig.pure) {
        // If the tool is marked as `pure`, then we can cache responses in our
        // public, shared cache indefinitely.
        cacheControl =
          'public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600'
      } else {
        // Default to not caching any responses.
        cacheControl = 'no-store'
        cacheStatus = 'DYNAMIC'
      }
    }

    const pricingPlanToolOverride = pricingPlan
      ? toolConfig.pricingPlanOverridesMap?.[pricingPlan.slug]
      : undefined
    const isToolEnabled = toolConfig.enabled ?? true

    // Check if this tool is configured for pricing-plan-specific overrides
    // which take precedence over the tool's default behavior.
    if (pricingPlan && pricingPlanToolOverride) {
      if (pricingPlanToolOverride.enabled !== undefined) {
        assert(
          pricingPlanToolOverride.enabled,
          isToolEnabled ? 403 : 404,
          `Tool "${tool.name}" is disabled for pricing plan "${pricingPlan.slug}"`
        )
      } else {
        assert(isToolEnabled, 404, `Tool "${tool.name}" is disabled`)
      }

      if (pricingPlanToolOverride.reportUsage !== undefined) {
        reportUsage &&= !!pricingPlanToolOverride.reportUsage
      }

      if (pricingPlanToolOverride.rateLimit !== undefined) {
        rateLimit = pricingPlanToolOverride.rateLimit
      }
    } else {
      assert(isToolEnabled, 404, `Tool "${tool.name}" is disabled`)
    }
  } else {
    if (cacheControl) {
      if (!isCacheControlPubliclyCacheable(cacheControl)) {
        // Incoming request explicitly requests to bypass the gateway's cache.
        cacheStatus = 'BYPASS'
      } else {
        // TODO: Should we allow incoming cache-control headers to override the
        // gateway's cache behavior?
      }
    } else {
      // Default to not caching any responses.
      cacheControl = 'no-store'
      cacheStatus = 'DYNAMIC'
    }
  }

  if (rateLimit) {
    // TODO: Consider decrementing rate limit if the response is cached or
    // errors? this doesn't seem too important, so will leave as-is for now.
    rateLimitResult = await enforceRateLimit({
      rateLimit,
      id: consumer?.id ?? ip ?? sessionId,
      cost: numRequestsCost,
      env,
      waitUntil
    })

    if (rateLimitResult && !rateLimitResult.passed) {
      throw new RateLimitError({ rateLimitResult })
    }
  }

  if (origin.type === 'raw') {
    // TODO
    assert(false, 500, 'Raw origin adapter not implemented')
  } else {
    // Validate incoming request params against the tool's input schema.
    const toolCallArgs = cfValidateJsonSchema<Record<string, any>>({
      schema: tool.inputSchema,
      data: args,
      errorPrefix: `Invalid request parameters for tool "${tool.name}"`,
      strictAdditionalProperties:
        toolConfig?.inputSchemaAdditionalProperties === false
    })

    const originStartTimeMs = Date.now()

    if (origin.type === 'openapi') {
      const operation = origin.toolToOperationMap[tool.name]
      assert(operation, 404, `Tool "${tool.name}" not found in OpenAPI spec`)
      assert(toolCallArgs, 500)

      const originRequest = await createHttpRequestForOpenAPIOperation({
        toolCallArgs,
        operation,
        deployment
      })

      updateOriginRequest(originRequest, { consumer, deployment, cacheControl })

      const cacheKey = await getRequestCacheKey(originRequest)

      // TODO: transform origin 5XX errors to 502 errors...
      const originResponse = await fetchCache({
        cacheKey,
        fetchResponse: async () => {
          let response = await fetch(originRequest)

          if (cacheControl && isResponsePubliclyCacheable(response)) {
            response = new Response(response.body, response)
            response.headers.set('cache-control', cacheControl)
          }

          return response
        },
        waitUntil
      })

      // Fetch the origin response without caching (useful for debugging)
      // const originResponse = await fetch(originRequest)

      cacheStatus =
        (originResponse.headers.get('cf-cache-status') as CacheStatus) ??
        cacheStatus ??
        (cacheKey ? 'MISS' : 'BYPASS')

      return {
        cacheStatus,
        reportUsage,
        rateLimit,
        rateLimitResult,
        toolCallArgs,
        originRequest,
        originResponse,
        originTimespanMs: Date.now() - originStartTimeMs,
        numRequestsCost,
        toolConfig
      }
    } else if (origin.type === 'mcp') {
      const { projectIdentifier } = parseDeploymentIdentifier(
        deployment.identifier,
        { errorStatusCode: 500 }
      )

      const id = env.DO_MCP_CLIENT.idFromName(sessionId)
      const originMcpClient = env.DO_MCP_CLIENT.get(
        id
      ) as DurableObjectStub<DurableMcpClientBase>

      await originMcpClient.init({
        url: deployment.origin.url,
        name: origin.serverInfo.name,
        version: origin.serverInfo.version,
        headers: origin.headers
      })

      const originMcpRequestMetadata = {
        agenticProxySecret: deployment._secret,
        sessionId,
        ip,
        isCustomerSubscriptionActive: !!consumer?.isStripeSubscriptionActive,
        customerId: consumer?.id,
        customerSubscriptionPlan: consumer?.plan,
        customerSubscriptionStatus: consumer?.stripeStatus,
        userId: consumer?.user.id,
        userEmail: consumer?.user.email,
        userUsername: consumer?.user.username,
        userName: consumer?.user.name,
        userCreatedAt: consumer?.user.createdAt,
        userUpdatedAt: consumer?.user.updatedAt,
        deploymentId: deployment.id,
        deploymentIdentifier: deployment.identifier,
        projectId: deployment.projectId,
        projectIdentifier
      } as AgenticMcpRequestMetadata

      let cacheKey: Request | undefined

      if (cacheControl && isCacheControlPubliclyCacheable(cacheControl)) {
        const fakeOriginRequest = new Request(deployment.origin.url, {
          method: 'POST',
          headers: {
            'content-type': 'application/json',
            'cache-control': cacheControl
          },
          body: JSON.stringify({
            name: tool.name,
            args: toolCallArgs,
            metadata: originMcpRequestMetadata
          })
        })

        cacheKey = await getRequestCacheKey(fakeOriginRequest)
        if (cacheKey) {
          const response = await caches.default.match(cacheKey)
          if (response) {
            return {
              cacheStatus: 'HIT',
              reportUsage,
              rateLimit,
              rateLimitResult,
              toolCallArgs,
              toolCallResponse: (await response.json()) as McpToolCallResponse,
              originTimespanMs: Date.now() - originStartTimeMs,
              numRequestsCost,
              toolConfig
            }
          }
        }
      }

      // TODO: add timeout support to the origin tool call?
      const toolCallResponseString = await originMcpClient.callTool({
        name: tool.name,
        args: toolCallArgs,
        metadata: originMcpRequestMetadata
      })
      const toolCallResponse = JSON.parse(
        toolCallResponseString
      ) as McpToolCallResponse

      if (cacheControl && cacheKey) {
        const fakeHttpResponse = new Response(toolCallResponseString, {
          headers: {
            'content-type': 'application/json',
            'cache-control': cacheControl
          }
        })
        waitUntil(caches.default.put(cacheKey, fakeHttpResponse))
      }

      return {
        cacheStatus: cacheStatus ?? (cacheKey ? 'MISS' : 'BYPASS'),
        reportUsage,
        rateLimit,
        rateLimitResult,
        toolCallArgs,
        toolCallResponse,
        originTimespanMs: Date.now() - originStartTimeMs,
        numRequestsCost,
        toolConfig
      }
    } else {
      assert(
        false,
        500,
        `Internal error: origin adapter type "${(origin as any).type}"`
      )
    }
  }
}


================================================
FILE: apps/gateway/src/lib/temp
================================================
// import type { AdminDeployment, PricingPlan } from '@agentic/platform-types'
// import type { JSONRPCRequest } from '@modelcontextprotocol/sdk/types.js'
// // import type { JSONRPCRequest } from '@modelcontextprotocol/sdk/types.js'
// import { assert } from '@agentic/platform-core'
// import { parseDeploymentIdentifier } from '@agentic/platform-validators'
// import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
// import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'
// import { DurableObject } from 'cloudflare:workers'

// import type { AdminConsumer } from './types'

// export type DurableMcpServerInfo = {
//   deployment: AdminDeployment
//   consumer?: AdminConsumer
//   pricingPlan?: PricingPlan
// }

// export class DurableMcpServer extends DurableObject {
//   protected server?: McpServer
//   protected serverTransport?: StreamableHTTPServerTransport
//   protected serverConnectionP?: Promise<void>

//   async init(mcpServerInfo: DurableMcpServerInfo) {
//     const existingMcpServerInfo =
//       await this.ctx.storage.get<DurableMcpServerInfo>('mcp-server-info')

//     if (!existingMcpServerInfo) {
//       await this.ctx.storage.put('mcp-server-info', mcpServerInfo)
//     } else {
//       assert(
//         mcpServerInfo.deployment.id === existingMcpServerInfo.deployment.id,
//         500,
//         `DurableMcpServerInfo deployment id mismatch: "${mcpServerInfo.deployment.id}" vs "${existingMcpServerInfo.deployment.id}"`
//       )
//     }

//     return this.ensureServerConnection(mcpServerInfo)
//   }

//   async isInitialized(): Promise<boolean> {
//     return !!(await this.ctx.storage.get('mcp-server-info'))
//   }

//   async ensureServerConnection(mcpServerInfo?: DurableMcpServerInfo) {
//     if (this.serverConnectionP) return this.serverConnectionP

//     mcpServerInfo ??=
//       await this.ctx.storage.get<DurableMcpServerInfo>('mcp-server-info')
//     assert(mcpServerInfo, 500, 'DurableMcpServer has not been initialized')
//     const { deployment } = mcpServerInfo

//     const { projectIdentifier } = parseDeploymentIdentifier(
//       deployment.identifier
//     )

//     this.server = new McpServer({
//       name: projectIdentifier,
//       version: deployment.version ?? '0.0.0'
//     })

//     for (const tool of deployment.tools) {
//       this.server.registerTool(
//         tool.name,
//         {
//           description: tool.description,
//           inputSchema: tool.inputSchema as any, // TODO: investigate types
//           outputSchema: tool.outputSchema as any, // TODO: investigate types
//           annotations: tool.annotations
//         },
//         (_args: Record<string, unknown>) => {
//           assert(false, 500, `Tool call not implemented: ${tool.name}`)

//           // TODO???
//           return {
//             content: [],
//             _meta: {
//               toolName: tool.name
//             }
//           }
//         }
//       )
//     }

//     const transport = new StreamableHTTPServerTransport({
//       sessionIdGenerator: () => {
//         // TODO: improve this
//         return crypto.randomUUID()
//       },
//       onsessioninitialized: (sessionId) => {
//         // TODO: improve this
//         // eslint-disable-next-line no-console
//         console.log(`Session initialized: ${sessionId}`)
//       }
//     })
//     this.serverConnectionP = this.server.connect(transport)

//     return this.serverConnectionP
//   }

//   // async fetch(request: Request) {
//   //   await this.ensureServerConnection()
//   //   const { readable, writable } = new TransformStream()
//   //   const writer = writable.getWriter()
//   //   const encoder = new TextEncoder()

//   //   const response = new Response(readable, {
//   //     headers: {
//   //       'Content-Type': 'text/event-stream',
//   //       'Cache-Control': 'no-cache',
//   //       Connection: 'keep-alive'
//   //       // 'mcp-session-id': sessionId
//   //     }
//   //   })

//   //   await this.serverTransport!.handleRequest(request, response)
//   // }

//   async onRequest(message: JSONRPCRequest) {
//     await this.ensureServerConnection()

//     // We need to map every incoming message to the connection that it came in on
//     // so that we can send relevant responses and notifications back on the same connection
//     // if (isJSONRPCRequest(message)) {
//     //   this._requestIdToConnectionId.set(message.id.toString(), connection.id);
//     // }

//     this.serverTransport!.onmessage?.(message)
//   }
// }


================================================
FILE: apps/gateway/src/lib/temp-mcp
================================================
// import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
// import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'
// import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js'
import { assert, JsonRpcError } from '@agentic/platform-core'
import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'
import {
  InitializeRequestSchema,
  isJSONRPCError,
  isJSONRPCNotification,
  isJSONRPCRequest,
  isJSONRPCResponse,
  type JSONRPCMessage,
  JSONRPCMessageSchema
} from '@modelcontextprotocol/sdk/types.js'

import type { GatewayHonoContext } from './lib/types'
import { createConsumerMcpServer } from './lib/consumer-mcp-server'
import { resolveMcpEdgeRequest } from './lib/resolve-mcp-edge-request'
// import { DurableMcpServer } from './lib/durable-mcp-server'

// TODO: https://github.com/modelcontextprotocol/servers/blob/8fb7bbdab73eddb42aba72e8eab81102efe1d544/src/everything/sse.ts
// TODO: https://github.com/cloudflare/agents

// const transports: Map<string, StreamableHTTPClientTransport> = new Map<
//   string,
//   StreamableHTTPClientTransport
// >()
// const server = new McpServer({
//   name: 'weather',
//   version: '1.0.0',
//   capabilities: {
//     resources: {},
//     tools: {}
//   }
// })

// class McpStreamableHttpTransport implements Transport {
//   onclose?: () => void
//   onerror?: (error: Error) => void
//   onmessage?: (message: JSONRPCMessage) => void
//   sessionId?: string

//   // TODO: If there is an open connection to send server-initiated messages
//   // back, we should use that connection
//   private _getWebSocketForGetRequest: () => WebSocket | null

//   // Get the appropriate websocket connection for a given message id
//   private _getWebSocketForMessageID: (id: string) => WebSocket | null

//   // Notify the server that a response has been sent for a given message id
//   // so that it may clean up it's mapping of message ids to connections
//   // once they are no longer needed
//   private _notifyResponseIdSent: (id: string) => void

//   private _started = false
//   constructor(
//     getWebSocketForMessageID: (id: string) => WebSocket | null,
//     notifyResponseIdSent: (id: string | number) => void
//   ) {
//     this._getWebSocketForMessageID = getWebSocketForMessageID
//     this._notifyResponseIdSent = notifyResponseIdSent
//     // TODO
//     this._getWebSocketForGetRequest = () => null
//   }

//   async start() {
//     // The transport does not manage the WebSocket connection since it's terminated
//     // by the Durable Object in order to allow hibernation. There's nothing to initialize.
//     if (this._started) {
//       throw new Error('Transport already started')
//     }
//     this._started = true
//   }

//   async send(message: JSONRPCMessage) {
//     if (!this._started) {
//       throw new Error('Transport not started')
//     }

//     let websocket: WebSocket | null = null

//     if (isJSONRPCResponse(message) || isJSONRPCError(message)) {
//       websocket = this._getWebSocketForMessageID(message.id.toString())
//       if (!websocket) {
//         throw new Error(
//           `Could not find WebSocket for message id: ${message.id}`
//         )
//       }
//     } else if (isJSONRPCRequest(message)) {
//       // requests originating from the server must be sent over the
//       // the connection created by a GET request
//       websocket = this._getWebSocketForGetRequest()
//     } else if (isJSONRPCNotification(message)) {
//       // notifications do not have an id
//       // but do have a relatedRequestId field
//       // so that they can be sent to the correct connection
//       websocket = null
//     }

//     try {
//       websocket?.send(JSON.stringify(message))
//       if (isJSONRPCResponse(message)) {
//         this._notifyResponseIdSent(message.id.toString())
//       }
//     } catch (err) {
//       this.onerror?.(err as Error)
//       throw err
//     }
//   }

//   async close() {
//     // Similar to start, the only thing to do is to pass the event on to the server
//     this.onclose?.()
//   }
// }

const MAXIMUM_MESSAGE_SIZE_BYTES = 4 * 1024 * 1024 // 4MB

export async function handleMcpRequest(ctx: GatewayHonoContext) {
  const request = ctx.req.raw
  ctx.set('isJsonRpcRequest', true)

  if (request.method !== 'POST') {
    // We don't yet support GET or DELETE requests
    throw new JsonRpcError({
      message: 'Method not allowed',
      statusCode: 405,
      jsonRpcErrorCode: -32_000,
      jsonRpcId: null
    })
  }

  // validate the Accept header
  const acceptHeader = request.headers.get('accept')

  // The client MUST include an Accept header, listing both application/json and text/event-stream as supported content types.
  if (
    !acceptHeader?.includes('application/json') ||
    !acceptHeader.includes('text/event-stream')
  ) {
    throw new JsonRpcError({
      message:
        'Not Acceptable: Client must accept both "application/json" and "text/event-stream"',
      statusCode: 406,
      jsonRpcErrorCode: -32_000,
      jsonRpcId: null
    })
  }

  const ct = request.headers.get('content-type')
  if (!ct?.includes('application/json')) {
    throw new JsonRpcError({
      message:
        'Unsupported Media Type: Content-Type must be "application/json"',
      statusCode: 415,
      jsonRpcErrorCode: -32_000,
      jsonRpcId: null
    })
  }

  // Check content length against maximum allowed size
  const contentLength = Number.parseInt(
    request.headers.get('content-length') ?? '0',
    10
  )
  if (contentLength > MAXIMUM_MESSAGE_SIZE_BYTES) {
    throw new JsonRpcError({
      message: `Request body too large. Maximum size is ${MAXIMUM_MESSAGE_SIZE_BYTES} bytes`,
      statusCode: 413,
      jsonRpcErrorCode: -32_000,
      jsonRpcId: null
    })
  }

  let sessionId = request.headers.get('mcp-session-id')
  let rawMessage: unknown

  try {
    rawMessage = await request.json()
  } catch {
    throw new JsonRpcError({
      message: 'Parse error: Invalid JSON',
      statusCode: 400,
      jsonRpcErrorCode: -32_700,
      jsonRpcId: null
    })
  }

  // Make sure the message is an array to simplify logic
  const rawMessages = Array.isArray(rawMessage) ? rawMessage : [rawMessage]

  // Try to parse each message as JSON RPC. Fail if any message is invalid
  const messages: JSONRPCMessage[] = rawMessages.map((msg) => {
    const parsed = JSONRPCMessageSchema.safeParse(msg)
    if (!parsed.success) {
      throw new JsonRpcError({
        message: 'Parse error: Invalid JSON-RPC message',
        statusCode: 400,
        jsonRpcErrorCode: -32_700,
        jsonRpcId: null
      })
    }
    return parsed.data
  })

  // Before we pass the messages to the agent, there's another error condition
  // we need to enforce. Check if this is an initialization request
  // https://spec.modelcontextprotocol.io/specification/2025-03-26/basic/lifecycle/
  const isInitializationRequest = messages.some(
    (msg) => InitializeRequestSchema.safeParse(msg).success
  )

  if (isInitializationRequest && sessionId) {
    throw new JsonRpcError({
      message:
        'Invalid Request: Initialization requests must not include a sessionId',
      statusCode: 400,
      jsonRpcErrorCode: -32_600,
      jsonRpcId: null
    })
  }

  // The initialization request must be the only request in the batch
  if (isInitializationRequest && messages.length > 1) {
    throw new JsonRpcError({
      message: 'Invalid Request: Only one initialization request is allowed',
      statusCode: 400,
      jsonRpcErrorCode: -32_600,
      jsonRpcId: null
    })
  }

  // If an Mcp-Session-Id is returned by the server during initialization,
  // clients using the Streamable HTTP transport MUST include it
  // in the Mcp-Session-Id header on all of their subsequent HTTP requests.
  if (!isInitializationRequest && !sessionId) {
    throw new JsonRpcError({
      message: 'Bad Request: Mcp-Session-Id header is required',
      statusCode: 400,
      jsonRpcErrorCode: -32_000,
      jsonRpcId: null
    })
  }

  // If we don't have a sessionId, we are serving an initialization request
  // and need to generate a new sessionId
  sessionId = sessionId ?? ctx.env.DO_MCP_SERVER.newUniqueId().toString()
  assert(
    !ctx.get('sessionId'),
    500,
    'Session ID should be set by MCP handler for MCP edge requests'
  )
  ctx.set('sessionId', sessionId)

  // TODO: first version using the McpServer locally instead of a DurableMcpServer
  // Fetch the durable mcp server for this session
  // const id = ctx.env.DO_MCP_SERVER.idFromName(`streamable-http:${sessionId}`)
  // const durableMcpServer = ctx.env.DO_MCP_SERVER.get(id)
  // const isInitialized = await durableMcpServer.isInitialized()

  // if (!isInitializationRequest && !isInitialized) {
  //   // A session id that was never initialized was provided
  //   throw new JsonRpcError({
  //     message: 'Session not found',
  //     statusCode: 404,
  //     jsonRpcErrorCode: -32_001,
  //     jsonRpcId: null
  //   })
  // }

  const { deployment, consumer, pricingPlan } = await resolveMcpEdgeRequest(ctx)
  const server = createConsumerMcpServer(ctx, {
    sessionId,
    deployment,
    consumer,
    pricingPlan
  })

  const transport = new StreamableHTTPServerTransport({
    sessionIdGenerator: () => {
      return ctx.env.DO_MCP_SERVER.newUniqueId().toString()
    },
    onsessioninitialized: (sessionId) => {
      // TODO: improve this
      // eslint-disable-next-line no-console
      console.log(`Session initialized: ${sessionId}`)
    }
  })
  await server.connect(transport)

  // if (isInitializationRequest) {
  //   await durableMcpServer.init({
  //     deployment,
  //     consumer,
  //     pricingPlan
  //   })
  // }

  // We've validated and initialized the request! Now it's time to actually
  // handle the JSON RPC messages in the request and respond with an SSE
  // stream.

  // Create a Transform Stream for SSE
  const { readable, writable } = new TransformStream()
  const writer = writable.getWriter()
  const encoder = new TextEncoder()

  // Keep track of the request ids that we have sent to the server
  // so that we can close the connection once we have received
  // all the responses
  const requestIds = new Set<string | number>()

  // eslint-disable-next-line unicorn/prefer-add-event-listener
  transport.onmessage = async (message) => {
    // eslint-disable-next-line no-console
    console.log('onmessage', message)

    // validate that the message is a valid JSONRPC message
    const result = JSONRPCMessageSchema.safeParse(message)
    if (!result.success) {
      // TODO: add a warning here
      return
    }

    // If the message is a response or an error, remove the id from the set of
    // request ids
    if (isJSONRPCResponse(result.data) || isJSONRPCError(result.data)) {
      requestIds.delete(result.data.id)
    }

    // Send the message as an SSE event
    const messageText = `event: message\ndata: ${JSON.stringify(result.data)}\n\n`
    await writer.write(encoder.encode(messageText))

    // If we have received all the responses, close the connection
    if (!requestIds.size) {
      ctx.executionCtx.waitUntil(transport.close())
      await writer.close()
    }
  }

  // If there are no requests, we send the messages downstream and
  // acknowledge the request with a 202 since we don't expect any responses
  // back through this connection.
  const hasOnlyNotificationsOrResponses = messages.every(
    (msg) => isJSONRPCNotification(msg) || isJSONRPCResponse(msg)
  )
  if (hasOnlyNotificationsOrResponses) {
    await Promise.all(messages.map((message) => transport.send(message)))

    return new Response(null, {
      status: 202
    })
  }

  for (const message of messages) {
    if (isJSONRPCRequest(message)) {
      // Add each request id that we send off to a set so that we can keep
      // track of which requests we still need a response for.
      requestIds.add(message.id)
    }

    await transport.send(message)
  }

  // console.log('>>> waiting...')
  // await new Promise((resolve) => setTimeout(resolve, 2000))
  // console.log('<<< waiting...')

  // Return the streamable http response.
  return new Response(readable, {
    headers: {
      'Content-Type': 'text/event-stream',
      'Cache-Control': 'no-cache',
      Connection: 'keep-alive',
      'mcp-session-id': sessionId
    },
    status: 200
  })
}


================================================
FILE: apps/gateway/src/lib/transform-http-response-to-mcp-tool-call-response.ts
================================================
import type { Tool, ToolConfig } from '@agentic/platform-types'
import { assert, HttpError } from '@agentic/platform-core'
import contentType from 'fast-content-type-parse'

import type { McpToolCallResponse, ToolCallArgs } from './types'
import { cfValidateJsonSchema } from './cf-validate-json-schema'

export async function transformHttpResponseToMcpToolCallResponse({
  originRequest,
  originResponse,
  tool,
  toolCallArgs,
  toolConfig
}: {
  originRequest: Request
  originResponse: Response
  tool: Tool
  toolCallArgs: ToolCallArgs
  toolConfig?: ToolConfig
}) {
  const { type: mimeType } = contentType.safeParse(
    originResponse.headers.get('content-type') || 'application/octet-stream'
  )

  // TODO: move these logs should be higher up
  // eslint-disable-next-line no-console
  console.log('httpOriginResponse', {
    tool: tool.name,
    toolCallArgs,
    url: originRequest.url,
    method: originRequest.method,
    originResponse: {
      mimeType,
      status: originResponse.status
      // headers: Object.fromEntries(originResponse.headers.entries())
    }
  })

  if (originResponse.status >= 400) {
    let message = originResponse.statusText
    try {
      message = await originResponse.text()
    } catch {}

    // eslint-disable-next-line no-console
    console.error('httpOriginResponse ERROR', {
      tool: tool.name,
      toolCallArgs,
      url: originRequest.url,
      method: originRequest.method,
      originResponse: {
        mimeType,
        status: originResponse.status,
        // headers: Object.fromEntries(originResponse.headers.entries()),
        message
      }
    })

    throw new HttpError({
      statusCode: originResponse.status,
      message,
      cause: originResponse
    })
  }

  const result: McpToolCallResponse = {
    isError: originResponse.status >= 400
  }

  if (tool.outputSchema) {
    assert(
      mimeType.includes('json'),
      502,
      `Tool "${tool.name}" requires a JSON response, but the origin returned content type "${mimeType}"`
    )
    const data = (await originResponse.json()) as Record<string, unknown>

    const toolCallResponseContent = cfValidateJsonSchema({
      data,
      schema: tool.outputSchema,
      coerce: false,
      strictAdditionalProperties:
        toolConfig?.outputSchemaAdditionalProperties === false,
      errorPrefix: `Invalid tool response for tool "${tool.name}"`,
      errorStatusCode: 502
    })

    result.structuredContent = toolCallResponseContent
  } else {
    if (mimeType.includes('json')) {
      result.structuredContent = await originResponse.json()
    } else if (mimeType.includes('text')) {
      result.content = [
        {
          type: 'text',
          text: await originResponse.text()
        }
      ]
    } else {
      const resBody = await originResponse.arrayBuffer()
      const resBodyBase64 = Buffer.from(resBody).toString('base64')
      const type = mimeType.includes('image')
        ? 'image'
        : mimeType.includes('audio')
          ? 'audio'
          : 'resource'

      // TODO: this needs work
      result.content = [
        {
          type,
          mimeType,
          ...(type === 'resource'
            ? {
                blob: resBodyBase64
              }
            : {
                data: resBodyBase64
              })
        }
      ]
    }
  }

  return result
}


================================================
FILE: apps/gateway/src/lib/types.ts
================================================
import type { AgenticApiClient } from '@agentic/platform-api-client'
import type { RateLimitResult } from '@agentic/platform-core'
import type {
  DefaultHonoBindings,
  DefaultHonoVariables
} from '@agentic/platform-hono'
import type {
  AdminConsumer as AdminConsumerImpl,
  AdminDeployment,
  PricingPlan,
  RateLimit,
  Tool,
  ToolConfig,
  User
} from '@agentic/platform-types'
import type { ParsedToolIdentifier } from '@agentic/platform-validators'
import type { Client as McpClient } from '@modelcontextprotocol/sdk/client/index.js'
import type { Context } from 'hono'
import type { Simplify } from 'type-fest'

import type { Env } from './env'

export type { RateLimitResult } from '@agentic/platform-core'

export type McpToolCallResponse = Simplify<
  Awaited<ReturnType<McpClient['callTool']>>
>

export type AdminConsumer = Simplify<
  AdminConsumerImpl & {
    user: User
  }
>

export type GatewayHonoVariables = Simplify<
  DefaultHonoVariables & {
    client: AgenticApiClient
    cache: Cache
    sessionId?: string
    reportUsage?: boolean
  }
>

export type GatewayHonoBindings = Simplify<DefaultHonoBindings & Env>

export type GatewayHonoEnv = {
  Bindings: GatewayHonoBindings
  Variables: GatewayHonoVariables
}

export type GatewayHonoContext = Context<GatewayHonoEnv>

// TODO: better type here
export type ToolCallArgs = Record<string, any>

export type RateLimitState = {
  current: number
  resetTimeMs: number
}

export type RateLimitCache = Map<string, RateLimitState>

export type CacheStatus = 'HIT' | 'MISS' | 'BYPASS' | 'DYNAMIC'
export type EdgeRequestMode = 'MCP' | 'HTTP'

export type WaitUntil = (promise: Promise<any>) => void

export interface ResolvedEdgeRequest extends Record<string, unknown> {
  edgeRequestMode: EdgeRequestMode
  parsedToolIdentifier: ParsedToolIdentifier
  deployment: AdminDeployment
  requestId: string
  ip?: string
}

export interface ResolvedMcpEdgeRequest extends ResolvedEdgeRequest {
  edgeRequestMode: 'MCP'
  consumer?: AdminConsumer
  pricingPlan?: PricingPlan
}

export interface ResolvedHttpEdgeRequest extends ResolvedEdgeRequest {
  edgeRequestMode: 'HTTP'
  consumer?: AdminConsumer
  pricingPlan?: PricingPlan
  tool: Tool
  toolCallArgs: ToolCallArgs
  cacheControl?: string
}

export type ResolvedOriginToolCallResult = {
  toolCallArgs: ToolCallArgs
  originRequest?: Request
  originResponse?: Response
  toolCallResponse?: McpToolCallResponse
  rateLimit?: RateLimit
  rateLimitResult?: RateLimitResult
  cacheStatus: CacheStatus
  reportUsage: boolean
  toolConfig?: ToolConfig
  originTimespanMs: number
  numRequestsCost: number
} & (
  | {
      originRequest: Request
      originResponse: Response
      toolCallResponse?: never
    }
  | {
      originRequest?: never
      originResponse?: never
      toolCallResponse: McpToolCallResponse
    }
)


================================================
FILE: apps/gateway/src/lib/update-origin-request.ts
================================================
import type { AdminDeployment } from '@agentic/platform-types'

import type { AdminConsumer } from './types'

// TODO: support custom auth providers
// const authProviders = ['github', 'google', 'spotify', 'linkedin', 'twitter']

export function updateOriginRequest(
  originRequest: Request,
  {
    deployment,
    consumer,
    cacheControl
  }: {
    deployment: AdminDeployment
    consumer?: AdminConsumer
    cacheControl?: string
  }
) {
  // originRequest.headers.delete('authorization')

  // for (const provider of authProviders) {
  //   const headerAccessToken = `x-${provider}-access-token`
  //   const headerRefreshToken = `x-${provider}-refresh-token`
  //   const headerAccessTokenSecret = `x-${provider}-access-token-secret`
  //   const headerId = `x-${provider}-id`
  //   const headerUsername = `x-${provider}-username`

  //   originRequest.headers.delete(headerAccessToken)
  //   originRequest.headers.delete(headerRefreshToken)
  //   originRequest.headers.delete(headerAccessTokenSecret)
  //   originRequest.headers.delete(headerId)
  //   originRequest.headers.delete(headerUsername)
  // }

  // Delete all Cloudflare headers since we want origin requests to be agnostic
  // to Agentic's choice of hosting provider.
  for (const headerKey of Object.keys(
    Object.fromEntries(originRequest.headers.entries())
  )) {
    if (headerKey.startsWith('cf-')) {
      originRequest.headers.delete(headerKey)
    }
  }

  originRequest.headers.delete('x-agentic-consumer')
  originRequest.headers.delete('x-agentic-user')
  originRequest.headers.delete('x-agentic-plan')
  originRequest.headers.delete('x-agentic-is-subscription-active')
  originRequest.headers.delete('x-agentic-subscription-status')
  originRequest.headers.delete('x-agentic-user-email')
  originRequest.headers.delete('x-agentic-user-username')
  originRequest.headers.delete('x-agentic-user-name')
  originRequest.headers.delete('x-agentic-user-created-at')
  originRequest.headers.delete('x-forwarded-for')

  if (consumer) {
    originRequest.headers.set('x-agentic-customer-id', consumer.id)

    originRequest.headers.set(
      'x-agentic-is-customer-subscription-active',
      consumer.isStripeSubscriptionActive.toString()
    )
    originRequest.headers.set(
      'x-agentic-customer-subscription-status',
      consumer.stripeStatus
    )

    originRequest.headers.set('x-agentic-user-id', consumer.user.id)
    originRequest.headers.set('x-agentic-user-email', consumer.user.email)
    originRequest.headers.set('x-agentic-user-username', consumer.user.username)
    originRequest.headers.set(
      'x-agentic-user-created-at',
      consumer.user.createdAt
    )
    originRequest.headers.set(
      'x-agentic-user-updated-at',
      consumer.user.updatedAt
    )

    if (consumer.plan) {
      originRequest.headers.set(
        'x-agentic-customer-subscription-plan',
        consumer.plan
      )
    }

    if (consumer.user.name) {
      originRequest.headers.set('x-agentic-user-name', consumer.user.name)
    }
  } else {
    originRequest.headers.set(
      'x-agentic-is-customer-subscription-active',
      'false'
    )
  }

  // TODO: this header is causing some random upstream cloudflare errors
  // https://support.cloudflare.com/hc/en-us/articles/360029779472-Troubleshooting-Cloudflare-1XXX-errors#error1000
  // originRequest.headers.set('x-forwarded-for', ip)

  if (cacheControl) {
    originRequest.headers.set('cache-control', cacheControl)
  }

  originRequest.headers.set('x-agentic-deployment-id', deployment.id)
  originRequest.headers.set(
    'x-agentic-deployment-identifier',
    deployment.identifier
  )
  originRequest.headers.set('x-agentic-proxy-secret', deployment._secret)
}


================================================
FILE: apps/gateway/src/lib/utils.test.ts
================================================
import { expect, test } from 'vitest'

import {
  createAgenticMcpMetadata,
  isCacheControlPubliclyCacheable,
  isRequestPubliclyCacheable
} from './utils'

test('isRequestPubliclyCacheable true', () => {
  expect(isRequestPubliclyCacheable(new Request('https://example.com'))).toBe(
    true
  )
  expect(
    isRequestPubliclyCacheable(
      new Request('https://example.com', {
        headers: {
          'cache-control': 'public, max-age=3600'
        }
      })
    )
  ).toBe(true)
})

test('isRequestPubliclyCacheable false', () => {
  expect(
    isRequestPubliclyCacheable(
      new Request('https://example.com', {
        headers: {
          pragma: 'no-cache'
        }
      })
    )
  ).toBe(false)
  expect(
    isRequestPubliclyCacheable(
      new Request('https://example.com', {
        headers: {
          'cache-control': 'no-store'
        }
      })
    )
  ).toBe(false)
})

test('isCacheControlPubliclyCacheable true', () => {
  expect(isCacheControlPubliclyCacheable('public')).toBe(true)
  expect(isCacheControlPubliclyCacheable('public, max-age=3600')).toBe(true)
  expect(isCacheControlPubliclyCacheable('public, s-maxage=3600')).toBe(true)
  expect(
    isCacheControlPubliclyCacheable('public, max-age=3600, s-maxage=3600')
  ).toBe(true)
  expect(isCacheControlPubliclyCacheable('max-age=3600')).toBe(true)
  expect(isCacheControlPubliclyCacheable('s-maxage=3600')).toBe(true)
  expect(
    isCacheControlPubliclyCacheable(
      'public, max-age=86400, s-maxage=86400, stale-while-revalidate=3600'
    )
  ).toBe(true)
  expect(isCacheControlPubliclyCacheable('stale-while-revalidate=180')).toBe(
    true
  )
})

test('isCacheControlPubliclyCacheable false', () => {
  expect(isCacheControlPubliclyCacheable('no-store')).toBe(false)
  expect(isCacheControlPubliclyCacheable('no-cache')).toBe(false)
  expect(isCacheControlPubliclyCacheable('private')).toBe(false)
  expect(isCacheControlPubliclyCacheable('max-age=0')).toBe(false)
  expect(isCacheControlPubliclyCacheable('private, max-age=3600')).toBe(false)
  expect(isCacheControlPubliclyCacheable('private, s-maxage=3600')).toBe(false)
  expect(
    isCacheControlPubliclyCacheable('private, max-age=3600, s-maxage=3600')
  ).toBe(false)
  expect(
    isCacheControlPubliclyCacheable('max-age=0, must-revalidate, no-cache')
  ).toBe(false)
  expect(
    isCacheControlPubliclyCacheable('private, max-age=3600, must-revalidate')
  ).toBe(false)
})

test('createAgenticMcpMetadata', () => {
  expect(
    // Test the stringified version because we want to test the order of the
    // keys.
    JSON.stringify(
      createAgenticMcpMetadata({
        deploymentId: '123',
        consumerId: '456',
        toolName: 'test',
        cacheStatus: 'HIT'
      })
    )
  ).toMatchSnapshot()
})


================================================
FILE: apps/gateway/src/lib/utils.ts
================================================
import { pruneEmpty } from '@agentic/platform-core'
import sortKeys from 'sort-keys'

export function isRequestPubliclyCacheable(request: Request): boolean {
  const pragma = request.headers.get('pragma')
  if (pragma === 'no-cache') {
    return false
  }

  return isCacheControlPubliclyCacheable(request.headers.get('cache-control'))
}

export function isResponsePubliclyCacheable(response: Response): boolean {
  const pragma = response.headers.get('pragma')
  if (pragma === 'no-cache') {
    return false
  }

  return isCacheControlPubliclyCacheable(response.headers.get('cache-control'))
}

export function isCacheControlPubliclyCacheable(
  cacheControl?: string | null
): boolean {
  if (!cacheControl) {
    // TODO: should we default to true or false?
    return true
  }

  const directives = new Set(cacheControl.split(',').map((s) => s.trim()))
  if (
    directives.has('no-store') ||
    directives.has('no-cache') ||
    directives.has('private') ||
    directives.has('max-age=0')
  ) {
    return false
  }

  return true
}

const agenticMcpMetadataFieldOrder: string[] = [
  'deploymentId',
  'consumerId',
  'toolName',
  'status',
  'cacheStatus',
  'headers'
]

const agenticMcpMetadataFieldsOrderMap = Object.fromEntries(
  agenticMcpMetadataFieldOrder.map((f, i) => [f, i])
)

function agenticMcpMetadataFieldComparator(a: string, b: string): number {
  const aIndex = agenticMcpMetadataFieldsOrderMap[a] ?? Infinity
  const bIndex = agenticMcpMetadataFieldsOrderMap[b] ?? Infinity

  return aIndex - bIndex
}

/**
 * Sanitizes agentic MCP metadata by sorting the keys and pruning empty values.
 */
export function createAgenticMcpMetadata(
  metadata: {
    deploymentId: string
    consumerId?: string
    toolName?: string
    status?: number
    cacheStatus?: string
    headers?: Record<string, any>
  },
  existingMetadata?: Record<string, any>
): Record<string, any> {
  const rawAgenticMcpMetadata = pruneEmpty({
    status: 200,
    ...existingMetadata?.agentic,
    ...metadata,
    headers: {
      ...existingMetadata?.agentic?.headers,
      ...metadata.headers
    }
  })

  const agentic = sortKeys(rawAgenticMcpMetadata, {
    compare: agenticMcpMetadataFieldComparator
  })

  return {
    ...existingMetadata,
    agentic
  }
}


================================================
FILE: apps/gateway/src/worker.ts
================================================
import * as Sentry from '@sentry/cloudflare'

import { app } from './app'
import { type Env, parseEnv, type RawEnv } from './lib/env'

// Export Durable Objects for cloudflare
export { DurableMcpClient } from './lib/durable-mcp-client'
export { DurableMcpServer } from './lib/durable-mcp-server'
export { DurableRateLimiter } from './lib/rate-limits/durable-rate-limiter'

// Main worker entrypoint
export default Sentry.withSentry(
  (env: RawEnv) => ({
    dsn: env.SENTRY_DSN,
    environment: env.ENVIRONMENT,
    integrations: [Sentry.extraErrorDataIntegration()],
    tracesSampleRate: 1.0,
    sendDefaultPii: true
  }),
  {
    async fetch(
      request: Request,
      env: Env,
      ctx: ExecutionContext
    ): Promise<Response> {
      let parsedEnv: Env

      // Validate the environment
      try {
        parsedEnv = parseEnv(env)
      } catch (err: any) {
        // eslint-disable-next-line no-console
        console.error('api gateway error invalid env:', err.message)

        return new Response(
          JSON.stringify({ error: 'Invalid api gateway environment' }),
          {
            status: 500,
            headers: {
              'content-type': 'application/json'
            }
          }
        )
      }

      // Handle the request with `hono`
      return app.fetch(request, parsedEnv, ctx)
    }
  } satisfies ExportedHandler<Env>
)


================================================
FILE: apps/gateway/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "compilerOptions": {
    "types": ["@cloudflare/workers-types"]
  },
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: apps/gateway/vitest.config.ts
================================================
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    environment: 'edge-runtime',
    globals: true,
    watch: false,
    restoreMocks: true
  }
})


================================================
FILE: apps/gateway/wrangler.jsonc
================================================
/**
 * https://developers.cloudflare.com/workers/wrangler/configuration/
 */
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "agentic-gateway",
  "main": "src/worker.ts",
  "compatibility_date": "2025-05-25",
  "compatibility_flags": ["nodejs_compat"],
  "placement": { "mode": "smart" },
  "upload_source_maps": true,
  "observability": {
    "enabled": true,
    "head_sampling_rate": 1
  },
  "migrations": [
    {
      "tag": "v1",
      "new_sqlite_classes": [
        "DurableRateLimiter",
        "DurableMcpServer",
        "DurableMcpClient"
      ]
    }
  ],
  "vars": {
    "ENVIRONMENT": "development",
    "AGENTIC_API_BASE_URL": "http://localhost:3001"
  },
  "durable_objects": {
    "bindings": [
      {
        "class_name": "DurableRateLimiter",
        "name": "DO_RATE_LIMITER"
      },
      {
        "class_name": "DurableMcpServer",
        "name": "DO_MCP_SERVER"
      },
      {
        "class_name": "DurableMcpClient",
        "name": "DO_MCP_CLIENT"
      }
    ]
  },
  "analytics_engine_datasets": [
    {
      "binding": "AE_USAGE_DATASET",
      "dataset": "agentic_gateway_usage"
    }
  ],
  "env": {
    "production": {
      "routes": [
        {
          "pattern": "gateway.agentic.so",
          "custom_domain": true
        }
      ],
      "vars": {
        "ENVIRONMENT": "production",
        "AGENTIC_API_BASE_URL": "https://api.agentic.so"
      },
      // TODO: double-check whether all of this needs to be duplicated for each environment
      "durable_objects": {
        "bindings": [
          {
            "class_name": "DurableRateLimiter",
            "name": "DO_RATE_LIMITER"
          },
          {
            "class_name": "DurableMcpServer",
            "name": "DO_MCP_SERVER"
          },
          {
            "class_name": "DurableMcpClient",
            "name": "DO_MCP_CLIENT"
          }
        ]
      },
      "analytics_engine_datasets": [
        {
          "binding": "AE_USAGE_DATASET",
          "dataset": "agentic_gateway_usage"
        }
      ]
    }
  }
}


================================================
FILE: apps/web/components.json
================================================
{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "new-york",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "config": "tailwind.config.ts",
    "css": "src/app/globals.css",
    "baseColor": "neutral",
    "cssVariables": true,
    "prefix": ""
  },
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "ui": "@/components/ui",
    "lib": "@/lib",
    "hooks": "@/hooks"
  },
  "iconLibrary": "lucide"
}


================================================
FILE: apps/web/next.config.ts
================================================
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  // TODO: handle remote profile pictures or upload them properly on backend
}

export default nextConfig


================================================
FILE: apps/web/package.json
================================================
{
  "name": "web",
  "private": true,
  "version": "8.4.4",
  "description": "Agentic platform webapp.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "apps/web"
  },
  "type": "module",
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "clean": "del .next",
    "test": "run-s test:*",
    "test:lint": "next lint",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@agentic/platform-api-client": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@date-fns/utc": "catalog:",
    "@fisch0920/markdown-to-html": "catalog:",
    "@number-flow/react": "catalog:",
    "@pmndrs/assets": "catalog:",
    "@radix-ui/react-avatar": "^1.1.10",
    "@radix-ui/react-collapsible": "catalog:",
    "@radix-ui/react-dropdown-menu": "catalog:",
    "@radix-ui/react-label": "catalog:",
    "@radix-ui/react-slot": "catalog:",
    "@radix-ui/react-tabs": "catalog:",
    "@radix-ui/react-tooltip": "catalog:",
    "@react-three/cannon": "catalog:",
    "@react-three/drei": "catalog:",
    "@react-three/fiber": "catalog:",
    "@react-three/postprocessing": "catalog:",
    "@react-three/rapier": "catalog:",
    "@tanstack/react-form": "catalog:",
    "@tanstack/react-query": "catalog:",
    "@tanstack/react-query-devtools": "catalog:",
    "@types/canvas-confetti": "catalog:",
    "canvas-confetti": "catalog:",
    "class-variance-authority": "catalog:",
    "clsx": "catalog:",
    "date-fns": "catalog:",
    "hast-util-to-jsx-runtime": "catalog:",
    "human-number": "^2.0.4",
    "ky": "catalog:",
    "lucide-react": "catalog:",
    "motion": "catalog:",
    "next": "catalog:",
    "next-themes": "catalog:",
    "plur": "catalog:",
    "posthog-js": "catalog:",
    "pretty-ms": "^9.2.0",
    "react": "catalog:",
    "react-dom": "catalog:",
    "react-infinite-scroll-hook": "catalog:",
    "react-lottie-player": "catalog:",
    "react-medium-image-zoom": "catalog:",
    "react-use": "catalog:",
    "server-only": "catalog:",
    "shiki": "catalog:",
    "sonner": "catalog:",
    "stripe": "catalog:",
    "suspend-react": "catalog:",
    "tailwind-merge": "catalog:",
    "three": "catalog:",
    "type-fest": "catalog:"
  },
  "devDependencies": {
    "@tailwindcss/postcss": "catalog:",
    "@tailwindcss/typography": "catalog:",
    "@types/human-number": "^1.0.2",
    "@types/react": "catalog:",
    "@types/react-dom": "catalog:",
    "@types/three": "catalog:",
    "autoprefixer": "catalog:",
    "postcss": "catalog:",
    "tailwindcss": "catalog:",
    "tw-animate-css": "catalog:"
  }
}


================================================
FILE: apps/web/postcss.config.mjs
================================================
export default {
  plugins: {
    '@tailwindcss/postcss': {}
  }
}


================================================
FILE: apps/web/public/schema.json
================================================
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 1024,
      "minLength": 1,
      "description": "Display name for the project. Max length 1024 characters."
    },
    "slug": {
      "type": "string",
      "minLength": 1,
      "description": "Unique project slug. Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. If not provided, it will be derived by slugifying `name`."
    },
    "version": {
      "type": "string",
      "minLength": 1,
      "description": "Optional semantic version of the project as a semver string. Ex: 1.0.0, 0.0.1, 5.0.1, etc."
    },
    "description": {
      "type": "string",
      "description": "A short description of the project."
    },
    "readme": {
      "type": "string",
      "description": "Optional markdown readme documenting the project (supports GitHub-flavored markdown)."
    },
    "icon": {
      "type": "string",
      "description": "Optional logo image to use for the project. Logos should have a square aspect ratio."
    },
    "sourceUrl": {
      "type": "string",
      "format": "uri",
      "description": "Optional URL to the source code of the project (eg, GitHub repo)."
    },
    "homepageUrl": {
      "type": "string",
      "format": "uri",
      "description": "Optional URL to the product's homepage."
    },
    "origin": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "location": {
              "type": "string",
              "const": "external",
              "default": "external"
            },
            "url": {
              "type": "string",
              "format": "uri",
              "description": "Required base URL of the externally hosted origin API server. Must be a valid `https` URL.\n\nNOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so."
            },
            "type": {
              "type": "string",
              "const": "openapi"
            },
            "spec": {
              "type": "string",
              "description": "Local file path, URL, or JSON stringified OpenAPI spec describing the origin API server."
            }
          },
          "required": [
            "url",
            "type",
            "spec"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "location": {
              "$ref": "#/properties/origin/anyOf/0/properties/location"
            },
            "url": {
              "$ref": "#/properties/origin/anyOf/0/properties/url"
            },
            "type": {
              "type": "string",
              "const": "mcp"
            },
            "headers": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "required": [
            "url",
            "type"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "location": {
              "$ref": "#/properties/origin/anyOf/0/properties/location"
            },
            "url": {
              "$ref": "#/properties/origin/anyOf/0/properties/url"
            },
            "type": {
              "type": "string",
              "const": "raw"
            }
          },
          "required": [
            "url",
            "type"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Origin adapter is used to configure the origin API server downstream from Agentic's API gateway. It specifies whether the origin API server denoted by `url` is hosted externally or deployed internally to Agentic's infrastructure. It also specifies the format for how origin tools are defined: either an OpenAPI spec or an MCP server.\n\nNOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so."
    },
    "pricingPlans": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Display name for the pricing plan (eg, \"Free\", \"Starter Monthly\", \"Pro Annual\", etc)"
          },
          "slug": {
            "type": "string",
            "minLength": 1,
            "description": "PricingPlan slug (eg, \"free\", \"starter-monthly\", \"pro-annual\", etc). Should be lower-cased and kebab-cased. Should be stable across deployments."
          },
          "interval": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "description": "The frequency at which a subscription is billed."
          },
          "description": {
            "type": "string"
          },
          "features": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "trialPeriodDays": {
            "type": "number",
            "minimum": 0
          },
          "rateLimit": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean",
                    "const": false
                  }
                },
                "required": [
                  "enabled"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "interval": {
                    "anyOf": [
                      {
                        "type": "number",
                        "exclusiveMinimum": 0
                      },
                      {
                        "type": "string",
                        "minLength": 1
                      }
                    ],
                    "description": "The interval at which the rate limit is applied. Either a positive integer expressed in seconds or a valid positive [ms](https://github.com/vercel/ms) string (eg, \"10s\", \"1m\", \"8h\", \"2d\", \"1w\", \"1y\", etc)."
                  },
                  "limit": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Maximum number of operations per interval (unitless)."
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "strict",
                      "approximate"
                    ],
                    "default": "approximate",
                    "description": "How to enforce the rate limit: \"strict\" (more precise but slower) or \"approximate\" (the default; faster and asynchronous but less precise)."
                  },
                  "enabled": {
                    "type": "boolean",
                    "default": true
                  }
                },
                "required": [
                  "interval",
                  "limit"
                ],
                "additionalProperties": false
              }
            ]
          },
          "lineItems": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "usageType": {
                      "type": "string",
                      "const": "licensed"
                    },
                    "amount": {
                      "type": "number",
                      "minimum": 0
                    }
                  },
                  "required": [
                    "slug",
                    "usageType",
                    "amount"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "$ref": "#/properties/pricingPlans/items/properties/lineItems/items/anyOf/0/properties/slug"
                    },
                    "label": {
                      "$ref": "#/properties/pricingPlans/items/properties/lineItems/items/anyOf/0/properties/label"
                    },
                    "usageType": {
                      "type": "string",
                      "const": "metered"
                    },
                    "unitLabel": {
                      "type": "string"
                    },
                    "billingScheme": {
                      "type": "string",
                      "enum": [
                        "per_unit",
                        "tiered"
                      ]
                    },
                    "unitAmount": {
                      "type": "number",
                      "minimum": 0
                    },
                    "tiersMode": {
                      "type": "string",
                      "enum": [
                        "graduated",
                        "volume"
                      ]
                    },
                    "tiers": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "unitAmount": {
                            "type": "number"
                          },
                          "flatAmount": {
                            "type": "number"
                          },
                          "upTo": {
                            "anyOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string",
                                "const": "inf"
                              }
                            ]
                          }
                        },
                        "required": [
                          "upTo"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "defaultAggregation": {
                      "type": "object",
                      "properties": {
                        "formula": {
                          "type": "string",
                          "enum": [
                            "sum",
                            "count"
                          ],
                          "default": "sum"
                        }
                      },
                      "additionalProperties": false
                    },
                    "transformQuantity": {
                      "type": "object",
                      "properties": {
                        "divideBy": {
                          "type": "number",
                          "exclusiveMinimum": 0
                        },
                        "round": {
                          "type": "string",
                          "enum": [
                            "down",
                            "up"
                          ]
                        }
                      },
                      "required": [
                        "divideBy",
                        "round"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "slug",
                    "usageType",
                    "billingScheme"
                  ],
                  "additionalProperties": false
                }
              ],
              "description": "PricingPlanLineItems represent a single line-item in a Stripe Subscription. They map to a Stripe billing `Price` and possibly a corresponding Stripe `Meter` for usage-based line-items."
            },
            "minItems": 1,
            "maxItems": 20
          }
        },
        "required": [
          "name",
          "slug",
          "lineItems"
        ],
        "additionalProperties": false,
        "description": "Represents the config for a Stripe subscription with one or more PricingPlanLineItems."
      },
      "minItems": 1,
      "description": "List of PricingPlans configuring which Stripe subscriptions should be available for the project. Defaults to a single free plan which is useful for developing and testing your project.",
      "default": [
        {
          "name": "Free",
          "slug": "free",
          "lineItems": [
            {
              "slug": "base",
              "usageType": "licensed",
              "amount": 0
            }
          ],
          "rateLimit": {
            "enabled": true,
            "interval": 60,
            "limit": 1000,
            "mode": "approximate"
          }
        }
      ]
    },
    "pricingIntervals": {
      "type": "array",
      "items": {
        "$ref": "#/properties/pricingPlans/items/properties/interval"
      },
      "minItems": 1,
      "description": "Optional list of billing intervals to enable in the pricingPlans.\n\nDefaults to a single monthly interval `['month']`.\n\nTo add support for annual pricing plans, for example, you can use: `['month', 'year']`.",
      "default": [
        "month"
      ]
    },
    "defaultRateLimit": {
      "$ref": "#/properties/pricingPlans/items/properties/rateLimit",
      "default": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate"
      }
    },
    "toolConfigs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "pattern": "^[a-zA-Z_][a-zA-Z0-9_-]{0,63}$",
            "description": "Agentic tool name"
          },
          "enabled": {
            "type": "boolean"
          },
          "pure": {
            "type": "boolean"
          },
          "cacheControl": {
            "type": "string"
          },
          "reportUsage": {
            "type": "boolean"
          },
          "rateLimit": {
            "$ref": "#/properties/pricingPlans/items/properties/rateLimit"
          },
          "inputSchemaAdditionalProperties": {
            "type": "boolean"
          },
          "outputSchemaAdditionalProperties": {
            "type": "boolean"
          },
          "pricingPlanOverridesMap": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "reportUsage": {
                  "type": "boolean"
                },
                "rateLimit": {
                  "$ref": "#/properties/pricingPlans/items/properties/rateLimit"
                }
              },
              "additionalProperties": false
            },
            "propertyNames": {
              "minLength": 1
            },
            "description": "Allows you to override this tool's behavior or disable it entirely for different pricing plans. This is a map of PricingPlan slug to PricingPlanToolOverrides for that plan."
          },
          "examples": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The display name of the example. If not given, defaults to `Example 1`, `Example 2`, etc."
                },
                "prompt": {
                  "type": "string",
                  "description": "The input prompt for agents to use when running this example."
                },
                "systemPrompt": {
                  "type": "string",
                  "description": "An optional system prompt for agents to use when running this example. Defaults to `You are a helpful assistant. Be as concise as possible.`"
                },
                "args": {
                  "type": "object",
                  "additionalProperties": {},
                  "description": "The arguments to pass to the tool for this example."
                },
                "featured": {
                  "type": "boolean",
                  "description": "Whether this example should be featured in the docs for the project."
                },
                "description": {
                  "type": "string",
                  "description": "A description of the example."
                }
              },
              "required": [
                "prompt",
                "args"
              ],
              "additionalProperties": false
            },
            "description": "Examples of how to use this tool. Used to generate example usage in the tool's docs."
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      },
      "default": []
    }
  },
  "required": [
    "name",
    "origin"
  ],
  "additionalProperties": false,
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Agentic Project Config Schema",
  "description": "JSON Schema used by `agentic.config.{ts,js,json}` files to configure Agentic projects."
}


================================================
FILE: apps/web/readme.md
================================================
## TODO

- better auth error handling
- display validation errors in auth forms
- race condition on login; sometimes doesn't actually login


================================================
FILE: apps/web/src/app/about/page.tsx
================================================
import Link from 'next/link'

import { DotsSection } from '@/components/dots-section'
import { Markdown } from '@/components/markdown'
import { PageContainer } from '@/components/page-container'
import { SupplySideCTA } from '@/components/supply-side-cta'
import { githubUrl, twitterUrl } from '@/lib/config'

export default function AboutPage() {
  return (
    <PageContainer>
      <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
        About
      </h1>

      <section>
        <Markdown>
          <h2>Setting the stage</h2>

          <p>Building reliable agents is hard.</p>

          <p>But building them without the right tools is even harder.</p>

          <p>
            MCP is really promising, but it's still early and the ecosystem's a
            bit of a mess.
          </p>

          <p>
            Add to that the fact that most MCPs are just thin wrappers around
            REST APIs – which works, but is far from ideal in terms of context
            efficiency and instruction following.
          </p>

          <p>
            The best agents require their tools to be optimized for LLM usage
            with a fundamentally different UX than REST APIs.
          </p>

          <p>
            There's a lot that will change in AI over the next decade, but one
            thing I believe strongly is that no matter how much the underlying
            AI systems change,{' '}
            <span className='font-semibold'>
              providing access to high quality tools that are specifically
              designed and optimized for agents will become increasingly
              important
            </span>
            .
          </p>

          <p>
            We call this <span className='font-semibold'>Agentic UX</span>, and
            it's at the heart of Agentic's mission.
          </p>

          <h2>Mission</h2>
          <p className='font-semibold italic'>
            Agentic's mission is to provide the world's best library of tools
            for AI agents.
          </p>

          {/* <h2>What is Agentic UX?</h2>
        <p>
          Agentic User Experience measures how optimized a resource is for
          consumption by LLM-based apps and more autonomous AI agents.
        </p>

        <p>
          `llms.txt` is a great example of a readonly format optimized for
          Agentic UX.
        </p>

        <p>
          Anthropic's Model Context Protocol (MCP) and Google's Agent to Agent
          Protocol (A2A) are both examples of protocols purpose-built for
          Agentic UX. There are dozens of other aspirational protocols with
          similar aims. [xkcd standards]
        </p> */}

          <h2>Team</h2>
          <p>
            Agentic was founded in 2023 by{' '}
            <Link
              href={twitterUrl}
              target='_blank'
              rel='noopener'
              className='link'
            >
              Travis Fischer
            </Link>{' '}
            (hey hey 👋) . We're backed by{' '}
            <Link
              href='https://hf0.com'
              target='_blank'
              rel='noopener'
              className='link'
            >
              HF0
            </Link>
            ,{' '}
            <Link
              href='https://hf0.com'
              target='_blank'
              rel='noopener'
              className='link'
            >
              Backend Capital
            </Link>
            , and
            <Link
              href='https://hf0.com'
              target='_blank'
              rel='noopener'
              className='link'
            >
              Transpose Capital
            </Link>
            .
          </p>

          <p>
            I'm currently running Agentic as a solo founder while traveling
            around the world, but i'm actively looking to hire a few remote
            engineers and would consider bringing on a co-founder if they're a
            really strong fit.
          </p>

          <p>
            If you're an expert TypeScript dev who vibes with our mission and
            loves open source – and if you have an interest in AI engineering,
            AI agents, API gateways, OpenAPI, MCP, AI codegen, etc, feel free to{' '}
            <Link
              href={twitterUrl}
              target='_blank'
              rel='noopener'
              className='link'
            >
              DM me on twitter
            </Link>
            , and please include a few links to your GitHub + related projects.
          </p>

          <p className='text-sm italic'>
            (this page was written with love and an intentional lack of LLM
            assistance on a very long and sleepy international flight 💕)
          </p>

          <h2>Tech stack</h2>
          <ul>
            <li>TypeScript</li>
            <li>Node.js</li>
            <li>Postgres</li>
            <li>Drizzle ORM</li>
            <li>Hono</li>
            <li>Next.js</li>
            <li>Stripe</li>
            <li>Cloudflare Workers</li>
            <li>Vercel</li>
            <li>Sentry</li>
            <li>Resend</li>
            <li>Cursor</li>
          </ul>

          <p>
            <Link
              href={githubUrl}
              target='_blank'
              rel='noopener'
              className='link'
            >
              Check out the source on GitHub for more details
            </Link>
            .
          </p>
        </Markdown>
      </section>

      {/* CTA section */}
      <DotsSection className='flex flex-col gap-12'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Don't miss out on the AI wave
        </h2>

        <SupplySideCTA variant='github-2' />
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/app-dashboard.tsx
================================================
import { AppConsumersList } from '@/components/app-consumers-list'
import { AppProjectsList } from '@/components/app-projects-list'
import { PageContainer } from '@/components/page-container'

export function AppDashboard() {
  return (
    <PageContainer>
      <section>
        <h1
          className='text-center text-balance leading-snug md:leading-none
        text-4xl font-extrabold mb-8'
        >
          Dashboard
        </h1>

        <div className='flex flex-col lg:flex-row gap-8 space-around'>
          <AppConsumersList />

          <AppProjectsList />
        </div>
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/consumers/[consumerId]/app-consumer-index.tsx
================================================
'use client'

import { Loader2Icon } from 'lucide-react'
import { useSearchParams } from 'next/navigation'
import { useCallback, useEffect, useRef, useState } from 'react'
import { toast } from 'sonner'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'
import { useConfettiFireworks } from '@/components/confetti'
import { LoadingIndicator } from '@/components/loading-indicator'
import { PageContainer } from '@/components/page-container'
import { Button } from '@/components/ui/button'
import { toastError } from '@/lib/notifications'
import { useQuery } from '@/lib/query-client'

export function AppConsumerIndex({ consumerId }: { consumerId: string }) {
  const ctx = useAuthenticatedAgentic()
  const searchParams = useSearchParams()
  const checkout = searchParams.get('checkout')
  const plan = searchParams.get('plan')
  const { fireConfetti } = useConfettiFireworks()
  const [isLoadingStripeBillingPortal, setIsLoadingStripeBillingPortal] =
    useState(false)

  const {
    data: consumer,
    isLoading,
    isError
  } = useQuery({
    queryKey: ['consumer', consumerId],
    queryFn: () =>
      ctx!.api.getConsumer({
        consumerId,
        populate: ['project']
      }),
    enabled: !!ctx
  })

  const firstLoadConsumer = useRef(true)

  useEffect(() => {
    if (!ctx || !consumer || !firstLoadConsumer.current) return

    if (checkout === 'canceled') {
      firstLoadConsumer.current = false
      toast('Subscription canceled')
    } else if (checkout === 'success') {
      if (plan) {
        firstLoadConsumer.current = false
        toast(
          `Congrats! You are now subscribed to the "${plan}" plan for project "${consumer.project.name}"`,
          {
            duration: 10_000
          }
        )

        // Return the confetti cleanup handler, so if this component is
        // unmounted, the confetti will stop as well.
        return fireConfetti()
      } else {
        firstLoadConsumer.current = false
        toast(
          `Your subscription has been cancelled for project "${consumer.project.name}"`,
          {
            duration: 10_000
          }
        )
      }
    }
  }, [checkout, ctx, plan, consumer, fireConfetti])

  const onManageSubscription = useCallback(async () => {
    if (!ctx || !consumer) {
      void toastError('Failed to create billing portal session')
      return
    }

    let url: string | undefined
    try {
      setIsLoadingStripeBillingPortal(true)
      const res = await ctx!.api.createConsumerBillingPortalSession({
        consumerId: consumer.id
      })
      url = res.url
    } catch (err) {
      void toastError(err, { label: 'Error creating billing portal session' })
    } finally {
      setIsLoadingStripeBillingPortal(false)
    }

    if (url) {
      globalThis.open(url, '_blank')
    }
  }, [ctx, consumer])

  return (
    <PageContainer>
      <section className='flex flex-col gap-16'>
        {!ctx || isLoading ? (
          <LoadingIndicator />
        ) : isError ? (
          <p>Error fetching customer subscription "{consumerId}"</p>
        ) : !consumer ? (
          <p>Customer subscription "{consumerId}" not found</p>
        ) : (
          <>
            <h1
              className='text-center text-balance leading-snug md:leading-none
        text-4xl font-extrabold'
            >
              Subscription to {consumer.project.name}
            </h1>

            <div className=''>
              <pre className='max-w-lg'>
                {JSON.stringify(consumer, null, 2)}
              </pre>
            </div>

            <Button
              onClick={onManageSubscription}
              disabled={isLoadingStripeBillingPortal}
            >
              {isLoadingStripeBillingPortal && (
                <Loader2Icon className='animate-spin mr-2' />
              )}

              <span>Manage Subscription</span>
            </Button>
          </>
        )}
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/consumers/[consumerId]/page.tsx
================================================
import { AppConsumerIndex } from './app-consumer-index'

export default async function AppConsumerIndexPage({
  params
}: {
  params: Promise<{
    consumerId: string
  }>
}) {
  const { consumerId } = await params

  return <AppConsumerIndex consumerId={consumerId} />
}


================================================
FILE: apps/web/src/app/app/consumers/app-consumers-index.tsx
================================================
'use client'

import { Loader2Icon } from 'lucide-react'
import { useCallback, useState } from 'react'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'
import { AppConsumersList } from '@/components/app-consumers-list'
import { PageContainer } from '@/components/page-container'
import { Button } from '@/components/ui/button'
import { toastError } from '@/lib/notifications'

export function AppConsumersIndex() {
  const ctx = useAuthenticatedAgentic()
  const [isLoadingStripeBillingPortal, setIsLoadingStripeBillingPortal] =
    useState(false)

  const onManageSubscriptions = useCallback(async () => {
    let url: string | undefined
    try {
      setIsLoadingStripeBillingPortal(true)
      const res = await ctx!.api.createBillingPortalSession()
      url = res.url
    } catch (err) {
      void toastError(err, { label: 'Error creating billing portal session' })
    } finally {
      setIsLoadingStripeBillingPortal(false)
    }

    if (url) {
      globalThis.open(url, '_blank')
    }
  }, [ctx])

  return (
    <PageContainer>
      <h1
        className='text-center text-balance leading-snug md:leading-none
        text-4xl font-extrabold'
      >
        Subscriptions
      </h1>

      <Button onClick={onManageSubscriptions}>
        {isLoadingStripeBillingPortal && (
          <Loader2Icon className='animate-spin mr-2' />
        )}

        <span>Manage your subscriptions</span>
      </Button>

      <AppConsumersList />
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/consumers/page.tsx
================================================
import { AppConsumersIndex } from './app-consumers-index'

export default function AppConsumersIndexPage() {
  return <AppConsumersIndex />
}


================================================
FILE: apps/web/src/app/app/page.tsx
================================================
import { AppDashboard } from './app-dashboard'

export default function AppIndexPage() {
  return <AppDashboard />
}


================================================
FILE: apps/web/src/app/app/projects/[namespace]/[project-slug]/app-project-index.tsx
================================================
'use client'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'
import { LoadingIndicator } from '@/components/loading-indicator'
import { PageContainer } from '@/components/page-container'
import { useQuery } from '@/lib/query-client'

export function AppProjectIndex({
  projectIdentifier
}: {
  projectIdentifier: string
}) {
  const ctx = useAuthenticatedAgentic()
  const {
    data: project,
    isLoading,
    isError
  } = useQuery({
    queryKey: ['project', projectIdentifier],
    queryFn: () =>
      ctx!.api.getProjectByIdentifier({
        projectIdentifier,
        populate: ['lastPublishedDeployment']
      }),
    enabled: !!ctx
  })

  // TODO: show deployments

  return (
    <PageContainer>
      <section>
        {!ctx || isLoading ? (
          <LoadingIndicator />
        ) : isError ? (
          <p>Error fetching project</p>
        ) : !project ? (
          <p>Project "{projectIdentifier}" not found</p>
        ) : (
          <>
            <h1
              className='text-center text-balance leading-snug md:leading-none
        text-4xl font-extrabold'
            >
              {project.name}
            </h1>

            <div className='mt-8'>
              <pre className='max-w-lg'>{JSON.stringify(project, null, 2)}</pre>
            </div>
          </>
        )}
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/projects/[namespace]/[project-slug]/page.tsx
================================================
import { parseProjectIdentifier } from '@agentic/platform-validators'
import { notFound } from 'next/navigation'

import { toastError } from '@/lib/notifications'

import { AppProjectIndex } from './app-project-index'

export default async function AppProjectIndexPage({
  params
}: {
  params: Promise<{
    namespace: string
    'project-slug': string
  }>
}) {
  const { namespace: rawNamespace, 'project-slug': rawProjectSlug } =
    await params

  try {
    const namespace = decodeURIComponent(rawNamespace)
    const projectSlug = decodeURIComponent(rawProjectSlug)

    const { projectIdentifier } = parseProjectIdentifier(
      `${namespace}/${projectSlug}`,
      { strict: true }
    )

    return <AppProjectIndex projectIdentifier={projectIdentifier} />
  } catch (err: any) {
    void toastError(err, { label: 'Invalid project identifier' })

    return notFound()
  }
}


================================================
FILE: apps/web/src/app/app/projects/app-projects-index.tsx
================================================
import { AppProjectsList } from '@/components/app-projects-list'
import { PageContainer } from '@/components/page-container'

export function AppProjectsIndex() {
  return (
    <PageContainer>
      <section>
        <div className='flex gap-8 space-around'>
          <AppProjectsList />
        </div>
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/app/projects/page.tsx
================================================
import { AppProjectsIndex } from './app-projects-index'

export default function AppProjectsIndexPage() {
  return <AppProjectsIndex />
}


================================================
FILE: apps/web/src/app/app/temp-testing
================================================
          await new Promise((resolve) => setTimeout(resolve, 2000))
          console.log(projects)
          const p = [
            {
              id: 'proj_pk4ui2lpcepx1aaf21zlf0lj' + pageParam,
              createdAt: '2025-06-16 01:50:23.948105',
              updatedAt: '2025-06-16 01:50:23.948105',
              identifier: '@dev/test-everything-openapi',
              name: 'test-everything-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_ub815xwoj8bzj1gqdlfzim91',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_j5lvlamp2fax4n7kx09eypjx' + pageParam,
              createdAt: '2025-06-16 01:50:20.288698',
              updatedAt: '2025-06-16 01:50:20.288698',
              identifier: '@dev/test-basic-mcp',
              name: 'test-basic-mcp',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_krkn9nedwes1s662kky7a991',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_xrt1zzegoa3sun3kynh7itss' + pageParam,
              createdAt: '2025-06-16 01:50:17.138037',
              updatedAt: '2025-06-16 01:50:17.138037',
              identifier: '@dev/test-basic-openapi',
              name: 'test-basic-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_frbnya7wukdto64y93osfp8a',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_pk4ui2lpcepx1aaf21zlf0lj' + 'foo' + pageParam,
              createdAt: '2025-06-16 01:50:23.948105',
              updatedAt: '2025-06-16 01:50:23.948105',
              identifier: '@dev/test-everything-openapi',
              name: 'test-everything-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_ub815xwoj8bzj1gqdlfzim91',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_j5lvlamp2fax4n7kx09eypjx' + 'foo' + pageParam,
              createdAt: '2025-06-16 01:50:20.288698',
              updatedAt: '2025-06-16 01:50:20.288698',
              identifier: '@dev/test-basic-mcp',
              name: 'test-basic-mcp',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_krkn9nedwes1s662kky7a991',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_xrt1zzegoa3sun3kynh7itss' + 'foo' + pageParam,
              createdAt: '2025-06-16 01:50:17.138037',
              updatedAt: '2025-06-16 01:50:17.138037',
              identifier: '@dev/test-basic-openapi',
              name: 'test-basic-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_frbnya7wukdto64y93osfp8a',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_pk4ui2lpcepx1aaf21zlf0lj' + 'bar' + pageParam,
              createdAt: '2025-06-16 01:50:23.948105',
              updatedAt: '2025-06-16 01:50:23.948105',
              identifier: '@dev/test-everything-openapi',
              name: 'test-everything-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_ub815xwoj8bzj1gqdlfzim91',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_j5lvlamp2fax4n7kx09eypjx' + 'bar' + pageParam,
              createdAt: '2025-06-16 01:50:20.288698',
              updatedAt: '2025-06-16 01:50:20.288698',
              identifier: '@dev/test-basic-mcp',
              name: 'test-basic-mcp',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_krkn9nedwes1s662kky7a991',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_xrt1zzegoa3sun3kynh7itss' + 'bar' + pageParam,
              createdAt: '2025-06-16 01:50:17.138037',
              updatedAt: '2025-06-16 01:50:17.138037',
              identifier: '@dev/test-basic-openapi',
              name: 'test-basic-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_frbnya7wukdto64y93osfp8a',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            },
            {
              id: 'proj_pk4ui2lpcepx1aaf21zlf0lj' + 'baz' + pageParam,
              createdAt: '2025-06-16 01:50:23.948105',
              updatedAt: '2025-06-16 01:50:23.948105',
              identifier: '@dev/test-everything-openapi',
              name: 'test-everything-openapi',
              userId: 'user_x7awoo6vxk7acinkjx1fc6kf',
              lastDeploymentId: 'depl_ub815xwoj8bzj1gqdlfzim91',
              applicationFeePercent: 20,
              defaultPricingInterval: 'month',
              pricingCurrency: 'usd'
            }
          ]
          if (pageParam < 200) {
            projects = p as any
          }


================================================
FILE: apps/web/src/app/auth/[provider]/success/oauth-success-callback.tsx
================================================
'use client'

import { sanitizeSearchParams } from '@agentic/platform-core'
import { useRouter, useSearchParams } from 'next/navigation'
import { useEffect } from 'react'

import {
  useNextUrl,
  useUnauthenticatedAgentic
} from '@/components/agentic-provider'
import { LoadingIndicator } from '@/components/loading-indicator'
import { toastError } from '@/lib/notifications'

export function OAuthSuccessCallback({
  provider:
    // TODO: make generic using this provider instead of hard-coding github
    _provider
}: {
  provider: string
}) {
  const searchParams = useSearchParams()
  const code = searchParams.get('code')
  const ctx = useUnauthenticatedAgentic()
  const nextUrl = useNextUrl()
  const router = useRouter()

  useEffect(() => {
    ;(async function () {
      if (!ctx) {
        return
      }

      if (!code) {
        // TODO
        throw new Error('Missing code or challenge')
      }

      // TODO: make generic using `provider`
      try {
        await ctx.api.exchangeOAuthCodeWithGitHub({ code })
      } catch (err) {
        await toastError(err, { label: 'Auth error' })

        return router.replace(
          `/login?${sanitizeSearchParams({ next: nextUrl }).toString()}`
        )
      }

      return router.replace(nextUrl || '/app')
    })()
  }, [code, ctx, nextUrl, router])

  return <LoadingIndicator />
}


================================================
FILE: apps/web/src/app/auth/[provider]/success/page.tsx
================================================
import { assert } from '@agentic/platform-core'
import { Suspense } from 'react'

import { OAuthSuccessCallback } from './oauth-success-callback'

export default async function Page({
  params
}: {
  params: Promise<{ provider: string }>
}) {
  const { provider } = await params
  assert(provider, 'Missing provider')

  return (
    <Suspense>
      <OAuthSuccessCallback provider={provider} />
    </Suspense>
  )
}


================================================
FILE: apps/web/src/app/contact/page.tsx
================================================
import Link from 'next/link'

import { DotsSection } from '@/components/dots-section'
import { GitHubStarCounter } from '@/components/github-star-counter'
import { HeroButton } from '@/components/hero-button'
import { PageContainer } from '@/components/page-container'
import { Button } from '@/components/ui/button'
import { calendarBookingUrl, emailUrl, twitterUrl } from '@/lib/config'

export default function AboutPage() {
  return (
    <PageContainer className='gap-12'>
      <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
        Contact
      </h1>

      <section className='flex flex-col gap-4 max-w-2xl text-center'>
        <p>
          Agentic is currently a solo effort by{' '}
          <Link
            href={twitterUrl}
            className='link'
            target='_blank'
            rel='noopener'
          >
            Travis Fischer
          </Link>
          . 👋
        </p>

        <p>
          As with MCP itself, Agentic is an active work in progress, so please
          reach out if you have any questions, feedback, or feature requests.
        </p>
      </section>

      {/* CTA section */}
      <DotsSection className='max-w-2xl'>
        <div className='relative grid grid-cols-1 sm:grid-cols-2 gap-8'>
          <HeroButton asChild heroVariant='orange'>
            <Link href={twitterUrl} target='_blank' rel='noopener'>
              DM me on Twitter / X
            </Link>
          </HeroButton>

          <Button asChild variant='outline' className='h-full py-[9px]'>
            <Link href={emailUrl}>Send me an email</Link>
          </Button>

          <Button asChild variant='outline' className='h-full py-[9px]'>
            <Link href={calendarBookingUrl} target='_blank' rel='noopener'>
              Book a call with me
            </Link>
          </Button>

          <GitHubStarCounter className='h-full py-[9px]' />
        </div>
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/globals.css
================================================
@import 'tailwindcss';
@plugin '@tailwindcss/typography';

@custom-variant dark (&:is(.dark *));

@theme {
  --font-heading: var(--font-geist);
  --font-body: var(--font-geist);
}

:root {
  --radius: 0.625rem;
  --background: oklch(1 0 0);
  --foreground: oklch(0.145 0 0);
  --card: oklch(1 0 0);
  --card-foreground: oklch(0.145 0 0);
  --popover: oklch(1 0 0);
  --popover-foreground: oklch(0.145 0 0);
  --primary: oklch(0.205 0 0);
  --primary-foreground: oklch(0.985 0 0);
  --secondary: oklch(0.97 0 0);
  --secondary-foreground: oklch(0.205 0 0);
  --muted: oklch(0.97 0 0);
  --muted-foreground: oklch(0.556 0 0);
  --accent: oklch(0.97 0 0);
  --accent-foreground: oklch(0.205 0 0);
  --destructive: oklch(0.577 0.245 27.325);
  --border: oklch(0.922 0 0);
  --input: oklch(0.922 0 0);
  --ring: oklch(0.708 0 0);
  --chart-1: oklch(0.646 0.222 41.116);
  --chart-2: oklch(0.6 0.118 184.704);
  --chart-3: oklch(0.398 0.07 227.392);
  --chart-4: oklch(0.828 0.189 84.429);
  --chart-5: oklch(0.769 0.188 70.08);
  --sidebar: oklch(0.985 0 0);
  --sidebar-foreground: oklch(0.145 0 0);
  --sidebar-primary: oklch(0.205 0 0);
  --sidebar-primary-foreground: oklch(0.985 0 0);
  --sidebar-accent: oklch(0.97 0 0);
  --sidebar-accent-foreground: oklch(0.205 0 0);
  --sidebar-border: oklch(0.922 0 0);
  --sidebar-ring: oklch(0.708 0 0);
}

.dark {
  --background: oklch(0.145 0 0);
  --foreground: oklch(0.985 0 0);
  --card: oklch(0.205 0 0);
  --card-foreground: oklch(0.985 0 0);
  --popover: oklch(0.205 0 0);
  --popover-foreground: oklch(0.985 0 0);
  --primary: oklch(0.922 0 0);
  --primary-foreground: oklch(0.205 0 0);
  --secondary: oklch(0.269 0 0);
  --secondary-foreground: oklch(0.985 0 0);
  --muted: oklch(0.269 0 0);
  --muted-foreground: oklch(0.708 0 0);
  --accent: oklch(0.269 0 0);
  --accent-foreground: oklch(0.985 0 0);
  --destructive: oklch(0.704 0.191 22.216);
  --border: oklch(1 0 0 / 10%);
  --input: oklch(1 0 0 / 15%);
  --ring: oklch(0.556 0 0);
  --chart-1: oklch(0.488 0.243 264.376);
  --chart-2: oklch(0.696 0.17 162.48);
  --chart-3: oklch(0.769 0.188 70.08);
  --chart-4: oklch(0.627 0.265 303.9);
  --chart-5: oklch(0.645 0.246 16.439);
  --sidebar: oklch(0.205 0 0);
  --sidebar-foreground: oklch(0.985 0 0);
  --sidebar-primary: oklch(0.488 0.243 264.376);
  --sidebar-primary-foreground: oklch(0.985 0 0);
  --sidebar-accent: oklch(0.269 0 0);
  --sidebar-accent-foreground: oklch(0.985 0 0);
  --sidebar-border: oklch(1 0 0 / 10%);
  --sidebar-ring: oklch(0.556 0 0);
}

@theme inline {
  --radius-sm: calc(var(--radius) - 4px);
  --radius-md: calc(var(--radius) - 2px);
  --radius-lg: var(--radius);
  --radius-xl: calc(var(--radius) + 4px);
  --color-background: var(--background);
  --color-foreground: var(--foreground);
  --color-card: var(--card);
  --color-card-foreground: var(--card-foreground);
  --color-popover: var(--popover);
  --color-popover-foreground: var(--popover-foreground);
  --color-primary: var(--primary);
  --color-primary-foreground: var(--primary-foreground);
  --color-secondary: var(--secondary);
  --color-secondary-foreground: var(--secondary-foreground);
  --color-muted: var(--muted);
  --color-muted-foreground: var(--muted-foreground);
  --color-accent: var(--accent);
  --color-accent-foreground: var(--accent-foreground);
  --color-destructive: var(--destructive);
  --color-border: var(--border);
  --color-input: var(--input);
  --color-ring: var(--ring);
  --color-chart-1: var(--chart-1);
  --color-chart-2: var(--chart-2);
  --color-chart-3: var(--chart-3);
  --color-chart-4: var(--chart-4);
  --color-chart-5: var(--chart-5);
  --color-sidebar: var(--sidebar);
  --color-sidebar-foreground: var(--sidebar-foreground);
  --color-sidebar-primary: var(--sidebar-primary);
  --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
  --color-sidebar-accent: var(--sidebar-accent);
  --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
  --color-sidebar-border: var(--sidebar-border);
  --color-sidebar-ring: var(--sidebar-ring);
}

@layer base {
  * {
    @apply border-border outline-ring/50;
  }
  body {
    @apply bg-background text-foreground;
  }
}

body {
  font-family: var(--font-body), Arial, Helvetica, sans-serif;
}

* {
  box-sizing: border-box;
}

html,
body {
  max-width: 100vw;
  height: 100%;
}

a {
  text-decoration: none;
}

a:hover {
  text-decoration: none;
}

a.link,
a .link {
  position: relative;
  transition: unset;
  opacity: 1;
  padding-bottom: 0.1rem;
  border-bottom-width: 0.1rem;
  border-bottom-color: transparent;
  background: transparent;
  background-origin: border-box;
  background-repeat: no-repeat;
  background-position: 50% 100%;
  background-size: 0 0.1rem;
}

a.link:focus,
a.link:hover,
a:focus .link,
a:hover .link {
  border-bottom-color: transparent;

  background-image: linear-gradient(90.68deg, #b439df 0.26%, #e5337e 102.37%);
  background-repeat: no-repeat;
  background-position: 0 100%;
  background-size: 100% 0.1rem;

  transition-property: background-position, background-size;
  transition-duration: 300ms;
}

main section {
  width: 100%;
  display: flex;
  flex-direction: column;
  align-items: center;
}

main section:last-of-type {
  margin-bottom: 0;
}


================================================
FILE: apps/web/src/app/layout.tsx
================================================
import './globals.css'

import type { Metadata } from 'next'
import { Geist } from 'next/font/google'
import { Toaster } from 'sonner'

import { Bootstrap } from '@/components/bootstrap'
import { Footer } from '@/components/footer'
import { Header } from '@/components/header'
import * as config from '@/lib/config'

import Providers from './providers'

const geist = Geist({
  variable: '--font-geist',
  subsets: ['latin']
})

export const metadata: Metadata = {
  title: config.title,
  description: config.description,
  authors: [{ name: config.author, url: config.twitterUrl }],
  metadataBase: new URL(config.prodUrl),
  keywords: config.keywords,
  openGraph: {
    title: config.title,
    description: config.description,
    siteName: config.title,
    locale: 'en_US',
    type: 'website',
    url: config.prodUrl
  },
  twitter: {
    card: 'summary_large_image',
    creator: `@${config.authorTwitterUsername}`,
    title: config.title,
    description: config.description
  }
}

export default function RootLayout({
  children
}: Readonly<{
  children: React.ReactNode
}>) {
  return (
    <html lang='en' suppressHydrationWarning>
      <body className={`${geist.variable} antialiased`}>
        <Providers>
          <div className='relative w-full min-h-[100vh] flex flex-col items-center'>
            <Header />

            <main className='relative w-full flex-1 flex flex-col items-center gap-16 pt-8 pb-16 px-2 overflow-hidden'>
              {children}
            </main>

            <Toaster richColors duration={5000} />
            <Footer />
          </div>

          <Bootstrap />
        </Providers>
      </body>
    </html>
  )
}


================================================
FILE: apps/web/src/app/login/login-form.tsx
================================================
'use client'

import { sanitizeSearchParams } from '@agentic/platform-core'
import { isValidEmail, isValidPassword } from '@agentic/platform-validators'
import { useForm } from '@tanstack/react-form'
import { Loader2Icon } from 'lucide-react'
import { useRouter } from 'next/navigation'
import { useCallback, useState } from 'react'
import { z } from 'zod'

import {
  useNextUrl,
  useUnauthenticatedAgentic
} from '@/components/agentic-provider'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import { GitHubIcon } from '@/icons/github'
import { toastError } from '@/lib/notifications'
import { cn } from '@/lib/utils'

export function LoginForm() {
  const ctx = useUnauthenticatedAgentic()
  const nextUrl = useNextUrl()
  const router = useRouter()
  const [isGitHubLoading, setIsGitHubLoading] = useState(false)

  const onAuthWithGitHub = useCallback(async () => {
    setIsGitHubLoading(true)
    try {
      const redirectUri = `${globalThis.location.origin}/auth/github/success?${sanitizeSearchParams({ next: nextUrl }).toString()}`

      const url = await ctx!.api.initAuthFlowWithGitHub({ redirectUri })

      void router.push(url)
    } catch (err: any) {
      setIsGitHubLoading(false)
      void toastError(err, { label: 'GitHub auth error' })
    }
  }, [ctx, nextUrl, router])

  const form = useForm({
    defaultValues: {
      email: '',
      password: ''
    },
    validators: {
      onChange: z.object({
        email: z
          .string()
          .email()
          .refine((email) => isValidEmail(email)),
        password: z.string().refine((password) => isValidPassword(password))
      })
    },
    onSubmit: async ({ value }) => {
      try {
        const res = await ctx!.api.signInWithPassword({
          email: value.email,
          password: value.password
        })

        console.log('login success', res)
      } catch (err: any) {
        void toastError(err, { label: 'Login error' })
        return
      }

      return router.push(nextUrl || '/app')
    }
  })

  return (
    <section>
      <div className='flex flex-col flex-1 items-center justify-center w-full max-w-xs gap-6'>
        <form
          className={cn('flex flex-col gap-6 w-full')}
          onSubmit={(e) => {
            e.preventDefault()
            void form.handleSubmit()
          }}
        >
          <div className='flex flex-col items-center gap-2 text-center'>
            <h1 className='text-2xl font-bold'>Login to your account</h1>
          </div>

          <div className='grid gap-6'>
            <form.Field
              name='email'
              children={(field) => (
                <div className='grid gap-3'>
                  <Label htmlFor={field.name}>Email</Label>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='email'
                    required
                    placeholder='Email'
                    autoComplete='email'
                    autoFocus={true}
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e: any) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Field
              name='password'
              children={(field) => (
                <div className='grid gap-3'>
                  <div className='flex items-center'>
                    <Label htmlFor={field.name}>Password</Label>

                    {/* <a
                        href='/forgot-password'
                        className='ml-auto text-xs underline-offset-4 hover:underline'
                        tabIndex={-1}
                      >
                        Forgot your password?
                      </a> */}
                  </div>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='password'
                    required
                    placeholder='Password'
                    // autoFocus={error?.type === 'invalid_password'}
                    autoComplete='current-password'
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Subscribe
              selector={(state) => [
                state.canSubmit,
                state.isSubmitting,
                state.isTouched
              ]}
              children={([canSubmit, isSubmitting, isTouched]) => (
                <Button
                  type='submit'
                  disabled={!(isTouched && canSubmit && ctx)}
                  className='w-full'
                >
                  {isSubmitting && <Loader2Icon className='animate-spin' />}

                  <span>Login</span>
                </Button>
              )}
            />
          </div>
        </form>

        <div className='flex items-center gap-2 text-center text-sm w-full'>
          <div className='border-border border-t inset-0 flex-1' />
          <div className='text-muted-foreground'>Or continue with</div>
          <div className='border-border border-t inset-0 flex-1' />
        </div>

        <form
          className='w-full'
          onSubmit={(e) => {
            e.preventDefault()
            void onAuthWithGitHub()
          }}
        >
          <Button
            type='submit'
            variant='outline'
            className='w-full'
            disabled={isGitHubLoading || !ctx}
          >
            {isGitHubLoading && <Loader2Icon className='animate-spin' />}
            <GitHubIcon />

            <span>Login with GitHub</span>
          </Button>
        </form>

        <div className='text-center text-xs'>
          Don&apos;t have an account?{' '}
          <a
            href={`/signup?${sanitizeSearchParams({ next: nextUrl }).toString()}`}
            className='underline underline-offset-4'
          >
            Sign up
          </a>
        </div>
      </div>
    </section>
  )
}


================================================
FILE: apps/web/src/app/login/page.tsx
================================================
import { Suspense } from 'react'

import { PageContainer } from '@/components/page-container'

import { LoginForm } from './login-form'

export default function Page() {
  return (
    <Suspense>
      <PageContainer>
        <LoginForm />
      </PageContainer>
    </Suspense>
  )
}


================================================
FILE: apps/web/src/app/logout/page.tsx
================================================
'use client'

import { useEffect } from 'react'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'

export default function LogoutPage() {
  const ctx = useAuthenticatedAgentic()

  useEffect(() => {
    ;(async () => {
      if (ctx) {
        ctx.logout()
      }
    })()
  }, [ctx])

  return null
}


================================================
FILE: apps/web/src/app/marketplace/marketplace-index.tsx
================================================
'use client'

import useInfiniteScroll from 'react-infinite-scroll-hook'

import { DotsSection } from '@/components/dots-section'
import { LoadingIndicator } from '@/components/loading-indicator'
import { PageContainer } from '@/components/page-container'
import { PublicProject } from '@/components/public-project'
import { SupplySideCTA } from '@/components/supply-side-cta'
import { defaultAgenticApiClient } from '@/lib/default-agentic-api-client'
import { useInfiniteQuery, useQuery } from '@/lib/query-client'

export function MarketplaceIndex({ limit }: { limit: number }) {
  const {
    data: featuredProjects,
    isLoading: isFeaturedProjectsLoading,
    isError: isFeaturedProjectsError
  } = useQuery({
    queryKey: ['featured-public-projects'],
    queryFn: () =>
      defaultAgenticApiClient.listPublicProjects({
        populate: ['lastPublishedDeployment'],
        limit: 3,
        tag: 'featured',
        sortBy: 'createdAt',
        sort: 'asc'
      })
  })

  const {
    data,
    isLoading,
    isError,
    hasNextPage,
    fetchNextPage,
    isFetchingNextPage
  } = useInfiniteQuery({
    queryKey: ['public-projects'],
    queryFn: ({ pageParam = 0 }) =>
      defaultAgenticApiClient
        .listPublicProjects({
          populate: ['lastPublishedDeployment'],
          offset: pageParam,
          limit,
          notTag: 'featured'
        })
        .then(async (projects) => {
          return {
            projects,
            offset: pageParam,
            limit,
            nextOffset:
              projects.length >= limit ? pageParam + projects.length : undefined
          }
        }),
    getNextPageParam: (lastGroup) => lastGroup?.nextOffset,
    initialPageParam: 0
  })

  const [sentryRef] = useInfiniteScroll({
    loading: isLoading || isFetchingNextPage,
    hasNextPage,
    onLoadMore: fetchNextPage,
    disabled: isError,
    rootMargin: '0px 0px 200px 0px'
  })

  const projects = data ? data.pages.flatMap((p) => p.projects) : []

  return (
    <PageContainer>
      <section className='flex flex-col gap-8'>
        <h1
          className='text-center text-balance leading-snug md:leading-none
        text-4xl font-extrabold'
        >
          Marketplace
        </h1>

        <div className='flex flex-col gap-16'>
          <div className=''>
            <h2 className='text-xl font-semibold mb-4'>Featured</h2>

            {isFeaturedProjectsError ? (
              <p>Error fetching featured projects</p>
            ) : isFeaturedProjectsLoading ? (
              <LoadingIndicator />
            ) : !featuredProjects?.length ? (
              <p>
                No projects found. This is likely an issue on Agentic's side.
                Please refresh or contact support.
              </p>
            ) : (
              <div className='grid grid-cols grid-cols-1 gap-4 sm:grid-cols-2 xl:grid-cols-3'>
                {featuredProjects.map((project) => (
                  <PublicProject key={project.id} project={project} />
                ))}
              </div>
            )}
          </div>

          <div className=''>
            <h2 className='text-xl font-semibold mb-4'>General</h2>

            {isError ? (
              <p>Error fetching projects</p>
            ) : isLoading ? (
              <LoadingIndicator />
            ) : !projects.length ? (
              <p>
                No projects found. This is likely an issue on Agentic's side.
                Please refresh or contact support.
              </p>
            ) : (
              <div className='grid grid-cols grid-cols-1 gap-4 sm:grid-cols-2 xl:grid-cols-3'>
                {projects.map((project) => (
                  <PublicProject key={project.id} project={project} />
                ))}

                {hasNextPage && (
                  <div ref={sentryRef} className=''>
                    {isLoading || (isFetchingNextPage && <LoadingIndicator />)}
                  </div>
                )}
              </div>
            )}
          </div>
        </div>
      </section>

      {/* CTA section */}
      <DotsSection className='flex flex-col gap-12 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Your API → Paid MCP, Instantly
        </h2>

        <h5 className='text-center max-w-2xl bg-background/50 rounded-xl'>
          Run one command to turn any MCP server or OpenAPI service into a paid
          MCP product. With built-in support for every major LLM SDK and MCP
          client.
        </h5>

        <SupplySideCTA variant='docs' />
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/marketplace/page.tsx
================================================
import {
  dehydrate,
  HydrationBoundary,
  QueryClient
} from '@tanstack/react-query'

import { defaultAgenticApiClient } from '@/lib/default-agentic-api-client'

import { MarketplaceIndex } from './marketplace-index'

export default async function MarketplaceIndexPage() {
  const queryClient = new QueryClient()
  const limit = 10

  await Promise.all([
    queryClient.prefetchQuery({
      queryKey: ['featured-public-projects'],
      queryFn: () =>
        defaultAgenticApiClient.listPublicProjects({
          populate: ['lastPublishedDeployment'],
          limit: 3,
          tag: 'featured',
          sortBy: 'createdAt',
          sort: 'asc'
        })
    }),

    queryClient.prefetchInfiniteQuery({
      queryKey: ['public-projects'],
      queryFn: ({ pageParam = 0 }) =>
        defaultAgenticApiClient
          .listPublicProjects({
            populate: ['lastPublishedDeployment'],
            offset: pageParam,
            limit,
            notTag: 'featured'
          })
          .then(async (projects) => {
            return {
              projects,
              offset: pageParam,
              limit,
              nextOffset:
                projects.length >= limit
                  ? pageParam + projects.length
                  : undefined
            }
          }),
      initialPageParam: 0
    })
  ])

  return (
    <HydrationBoundary state={dehydrate(queryClient)}>
      <MarketplaceIndex limit={limit} />
    </HydrationBoundary>
  )
}


================================================
FILE: apps/web/src/app/marketplace/projects/[namespace]/[project-slug]/marketplace-nav.tsx
================================================
import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator
} from '@/components/ui/breadcrumb'

export function MarketplacePublicProjectDetailNav({
  projectIdentifier
}: {
  projectIdentifier: string
}) {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href='/marketplace'>Marketplace</BreadcrumbLink>
        </BreadcrumbItem>

        <BreadcrumbSeparator />

        <BreadcrumbItem>
          <BreadcrumbPage>{projectIdentifier}</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  )
}


================================================
FILE: apps/web/src/app/marketplace/projects/[namespace]/[project-slug]/marketplace-public-project-detail.tsx
================================================
'use client'

import type { Project } from '@agentic/platform-types'
import { assert, omit, sanitizeSearchParams } from '@agentic/platform-core'
import ky from 'ky'
import { ChevronsUpDownIcon, ExternalLinkIcon } from 'lucide-react'
import Link from 'next/link'
import { useRouter, useSearchParams } from 'next/navigation'
import plur from 'plur'
import { useCallback, useEffect, useMemo, useRef, useState } from 'react'
import { useAsync } from 'react-use'

import { useAgentic } from '@/components/agentic-provider'
import { CodeBlock } from '@/components/code-block'
import { ExampleUsage } from '@/components/example-usage'
import { HeroButton } from '@/components/hero-button'
import { LoadingIndicator } from '@/components/loading-indicator'
import { SSRMarkdown } from '@/components/markdown/ssr-markdown'
import { PageContainer } from '@/components/page-container'
import { ProjectPricingPlans } from '@/components/project-pricing-plans'
import { Button } from '@/components/ui/button'
import {
  Collapsible,
  CollapsibleContent,
  CollapsibleTrigger
} from '@/components/ui/collapsible'
import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'
import { GitHubIcon } from '@/icons/github'
import { defaultAgenticApiClient } from '@/lib/default-agentic-api-client'
import { toast, toastError } from '@/lib/notifications'
import { useQuery } from '@/lib/query-client'

import {
  type MarketplacePublicProjectDetailTab,
  marketplacePublicProjectDetailTabsSet,
  MAX_TOOLS_TO_SHOW
} from './utils'

export function MarketplacePublicProjectDetail({
  projectIdentifier
}: {
  projectIdentifier: string
}) {
  const ctx = useAgentic()
  const searchParams = useSearchParams()
  const checkout = searchParams.get('checkout')
  const plan = searchParams.get('plan')
  const [isLoadingStripeCheckoutForPlan, setIsLoadingStripeCheckoutForPlan] =
    useState<string | null>(null)
  const router = useRouter()

  // Load the public project
  const {
    data: project,
    isLoading,
    isError
  } = useQuery({
    queryKey: ['public-project', projectIdentifier],
    queryFn: () =>
      defaultAgenticApiClient.getPublicProjectByIdentifier({
        projectIdentifier,
        populate: ['lastPublishedDeployment']
      })
  })

  // If the user is authenticated, check if they have an active subscription to
  // this project
  const {
    data: consumer,
    isLoading: isConsumerLoading
    // isError: isConsumerError
  } = useQuery({
    queryKey: [
      'project',
      projectIdentifier,
      'user',
      ctx?.api.authSession?.user.id
    ],
    queryFn: () =>
      ctx!.api.getConsumerByProjectIdentifier({
        projectIdentifier
      }),
    enabled: !!ctx?.isAuthenticated
  })

  const onSubscribe = useCallback(
    async (pricingPlanSlug: string) => {
      assert(ctx, 500, 'Agentic context is required')
      assert(project, 500, 'Project is required')
      const { lastPublishedDeploymentId } = project
      assert(
        lastPublishedDeploymentId,
        500,
        `Public project "${projectIdentifier}" expected to have a last published deployment, but none found.`
      )

      if (!ctx.isAuthenticated) {
        return router.push(
          `/signup?${sanitizeSearchParams({
            next: `/marketplace/projects/${projectIdentifier}?tab=pricing&checkout=true&plan=${pricingPlanSlug}`
          }).toString()}`
        )
      }

      let checkoutSession: { url: string; id: string } | undefined

      try {
        setIsLoadingStripeCheckoutForPlan(pricingPlanSlug)
        const res = await ctx!.api.createConsumerCheckoutSession({
          deploymentId: lastPublishedDeploymentId!,
          plan: pricingPlanSlug
        })

        console.log('checkout', res)
        checkoutSession = res.checkoutSession
      } catch (err) {
        return toastError(err, { label: 'Error creating checkout session' })
      } finally {
        setIsLoadingStripeCheckoutForPlan(null)
      }

      return router.push(checkoutSession.url)
    },
    [ctx, projectIdentifier, project, router]
  )

  const hasInitializedCheckoutFromSearchParams = useRef(false)

  useEffect(() => {
    if (!ctx) return

    if (checkout === 'canceled') {
      toast('Checkout canceled')
    } else if (
      checkout === 'true' &&
      plan &&
      project &&
      !isConsumerLoading &&
      !hasInitializedCheckoutFromSearchParams.current
    ) {
      hasInitializedCheckoutFromSearchParams.current = true

      if (consumer?.plan !== plan) {
        // Start checkout flow if search params have `?checkout=true&plan={plan}`
        // This is to allow unauthenticated users to subscribe to a plan by first
        // visiting `/login` or `/signup` and then being redirected to this page
        // with the target checkout search params already pre-filled.
        // Another use case for this functionality is providing a single link to
        // subscribe to a specific project and pricing plan – with the checkout
        // details pre-filled.
        void onSubscribe(checkout)
      }
    }
  }, [
    checkout,
    plan,
    ctx,
    project,
    isConsumerLoading,
    consumer,
    onSubscribe,
    hasInitializedCheckoutFromSearchParams
  ])

  const deployment = useMemo(() => project?.lastPublishedDeployment, [project])
  const featuredToolName = useMemo(() => {
    const toolConfigs = deployment?.toolConfigs?.filter(
      (toolConfig) => toolConfig?.enabled !== false
    )

    return (
      toolConfigs?.find((toolConfig) =>
        toolConfig.examples?.find((example) => example.featured)
      )?.name ??
      toolConfigs?.find((toolConfig) => toolConfig.examples?.length)?.name ??
      toolConfigs?.[0]?.name ??
      deployment?.tools[0]?.name
    )
  }, [deployment])

  const tab = useMemo<MarketplacePublicProjectDetailTab>(() => {
    const tab = searchParams.get('tab')?.toLowerCase()
    if (!tab || !marketplacePublicProjectDetailTabsSet.has(tab)) {
      return 'overview'
    }

    if (tab === 'readme' && !deployment?.readme?.trim()) {
      return 'overview'
    }

    return tab as MarketplacePublicProjectDetailTab
  }, [searchParams, deployment])

  const { value: readme, loading: isReadmeLoading } = useAsync(async () => {
    if (deployment?.readme?.trim()) {
      return ky.get(deployment.readme).text()
    }

    return undefined
  }, [deployment])

  const tools = useMemo(() => {
    if (!deployment) return []
    const toolConfigsMap = new Map(
      deployment.toolConfigs.map((toolConfig) => [toolConfig.name, toolConfig])
    )

    return deployment.tools
      .map((tool) => {
        const toolConfig = toolConfigsMap.get(tool.name)
        if (toolConfig?.enabled === false) return null

        // TODO: add to tool if disabled on current pricing plan
        return tool
      })
      .filter(Boolean)
  }, [deployment])

  return (
    <PageContainer compact>
      <section>
        {isLoading ? (
          <LoadingIndicator />
        ) : isError ? (
          <p>Error fetching project</p>
        ) : !project ? (
          <p>Project "{projectIdentifier}" not found</p>
        ) : (
          <div className='flex flex-col gap-4 w-full'>
            <ProjectHeader project={project} tab={tab} />

            <Tabs
              value={tab}
              onValueChange={(value) => {
                if (value === 'overview') {
                  router.push(`/marketplace/projects/${projectIdentifier}`)
                } else {
                  router.push(
                    `/marketplace/projects/${projectIdentifier}?tab=${value}`
                  )
                }
              }}
            >
              <TabsList>
                <TabsTrigger value='overview' className='cursor-pointer'>
                  Overview
                </TabsTrigger>

                {deployment?.readme?.trim() && (
                  <TabsTrigger value='readme' className='cursor-pointer'>
                    Readme
                  </TabsTrigger>
                )}

                <TabsTrigger
                  value='tools'
                  className='cursor-pointer'
                  disabled={!deployment}
                >
                  Tools
                </TabsTrigger>

                <TabsTrigger
                  value='pricing'
                  className='cursor-pointer'
                  disabled={!deployment}
                >
                  Pricing
                </TabsTrigger>

                <TabsTrigger value='debug' className='cursor-pointer'>
                  Debug
                </TabsTrigger>
              </TabsList>

              <div className='bg-card p-4 border rounded-lg shadow-sm color-card-foreground'>
                {tab === 'overview' && (
                  <TabsContent value='overview' className='flex flex-col gap-4'>
                    <h2 className='text-balance leading-snug md:leading-none text-xl font-semibold'>
                      Overview
                    </h2>

                    <div className='grid grid-cols grid-cols-1 lg:grid-cols-2 gap-8 md:gap-4'>
                      <div className='flex flex-col gap-8'>
                        {deployment ? (
                          <>
                            <p>
                              {deployment.description ||
                                'No description available'}
                            </p>

                            <div className='flex flex-col gap-4'>
                              <h3 className='text-balance leading-snug md:leading-none text-lg font-semibold'>
                                Tools
                              </h3>

                              <ul className='flex flex-col gap-4'>
                                {deployment.tools
                                  .slice(0, MAX_TOOLS_TO_SHOW)
                                  .map((tool) => (
                                    <li
                                      key={tool.name}
                                      className='p-4 border rounded-sm w-full flex flex-col gap-4'
                                    >
                                      <h3 className='text-balance leading-snug md:leading-none text-md font-semibold'>
                                        {tool.name}
                                      </h3>

                                      <p className='text-sm text-gray-500'>
                                        {tool.description}
                                      </p>
                                    </li>
                                  ))}

                                {tools.length > MAX_TOOLS_TO_SHOW && (
                                  <li>
                                    <Button
                                      asChild
                                      className='w-full flex flex-col gap-4'
                                      variant='outline'
                                    >
                                      <Link
                                        href={`/marketplace/projects/${projectIdentifier}?tab=tools`}
                                      >
                                        View{' '}
                                        {deployment.tools.length -
                                          MAX_TOOLS_TO_SHOW}{' '}
                                        more{' '}
                                        {plur(
                                          'tool',
                                          deployment.tools.length -
                                            MAX_TOOLS_TO_SHOW
                                        )}
                                      </Link>
                                    </Button>
                                  </li>
                                )}
                              </ul>
                            </div>
                          </>
                        ) : (
                          <p>
                            This project doesn't have any published deployments.
                          </p>
                        )}
                      </div>

                      <div className='flex flex-col gap-4'>
                        <ExampleUsage
                          projectIdentifier={projectIdentifier}
                          project={project}
                          tool={featuredToolName}
                        />
                      </div>
                    </div>
                  </TabsContent>
                )}

                {tab === 'readme' && (
                  <TabsContent value='readme' className='flex flex-col gap-4'>
                    {isReadmeLoading ? (
                      <LoadingIndicator />
                    ) : readme ? (
                      <SSRMarkdown markdown={readme} className='' />
                    ) : (
                      <p>Readme not found</p>
                    )}
                  </TabsContent>
                )}

                {tab === 'tools' && (
                  <TabsContent value='tools' className='flex flex-col gap-4'>
                    <h2 className='text-balance leading-snug md:leading-none text-xl font-semibold'>
                      Tools
                    </h2>

                    {deployment && (
                      <ul className='flex flex-col gap-4'>
                        {tools.map((tool) => (
                          <li
                            key={tool.name}
                            className='p-4 border rounded-sm w-full flex flex-col gap-4'
                          >
                            <h3 className='text-balance leading-snug md:leading-none text-md font-semibold'>
                              {tool.name}
                            </h3>

                            <p className='text-sm text-gray-500'>
                              {tool.description}
                            </p>

                            <Collapsible className='w-full flex flex-col align-start gap-2'>
                              <CollapsibleTrigger asChild>
                                <Button
                                  variant='outline'
                                  className='self-start'
                                >
                                  Input schema
                                  <ChevronsUpDownIcon />
                                </Button>
                              </CollapsibleTrigger>

                              <CollapsibleContent>
                                <CodeBlock
                                  lang='json'
                                  code={JSON.stringify(
                                    tool.inputSchema,
                                    null,
                                    2
                                  )}
                                  className='border rounded-sm'
                                />
                              </CollapsibleContent>
                            </Collapsible>

                            {tool.outputSchema && (
                              <Collapsible className='w-full flex flex-col align-start gap-2'>
                                <CollapsibleTrigger asChild>
                                  <Button
                                    variant='outline'
                                    className='self-start'
                                  >
                                    Output schema
                                    <ChevronsUpDownIcon />
                                  </Button>
                                </CollapsibleTrigger>

                                <CollapsibleContent>
                                  <CodeBlock
                                    lang='json'
                                    code={JSON.stringify(
                                      tool.outputSchema,
                                      null,
                                      2
                                    )}
                                    className='border rounded-sm'
                                  />
                                </CollapsibleContent>
                              </Collapsible>
                            )}
                          </li>
                        ))}
                      </ul>
                    )}
                  </TabsContent>
                )}

                {tab === 'pricing' && (
                  <TabsContent value='pricing' className='flex flex-col gap-4'>
                    <h2 className='text-balance leading-snug md:leading-none text-xl font-semibold'>
                      Pricing
                    </h2>

                    <ProjectPricingPlans
                      project={project}
                      consumer={consumer}
                      isLoadingStripeCheckoutForPlan={
                        isLoadingStripeCheckoutForPlan
                      }
                      onSubscribe={onSubscribe}
                    />
                  </TabsContent>
                )}

                {tab === 'debug' && (
                  <TabsContent value='debug' className='flex flex-col gap-4'>
                    <h2 className='text-balance leading-snug md:leading-none text-xl font-semibold'>
                      Debug
                    </h2>

                    <Collapsible
                      defaultOpen
                      className='w-full flex flex-col align-start gap-2'
                    >
                      <CollapsibleTrigger asChild>
                        <Button variant='outline' className='self-start'>
                          Project
                          <ChevronsUpDownIcon />
                        </Button>
                      </CollapsibleTrigger>

                      <CollapsibleContent>
                        <CodeBlock
                          lang='json'
                          code={JSON.stringify(
                            omit(
                              project,
                              'lastPublishedDeployment',
                              'lastDeployment'
                            ),
                            null,
                            2
                          )}
                          className='border rounded-sm max-w-full overflow-x-auto'
                        />
                      </CollapsibleContent>
                    </Collapsible>

                    {deployment && (
                      <Collapsible className='w-full flex flex-col align-start gap-2'>
                        <CollapsibleTrigger asChild>
                          <Button variant='outline' className='self-start'>
                            Last Published Deployment
                            <ChevronsUpDownIcon />
                          </Button>
                        </CollapsibleTrigger>

                        <CollapsibleContent>
                          <CodeBlock
                            lang='json'
                            code={JSON.stringify(
                              omit(deployment, 'project'),
                              null,
                              2
                            )}
                            className='border rounded-sm max-w-full overflow-x-auto'
                          />
                        </CollapsibleContent>
                      </Collapsible>
                    )}

                    {consumer && (
                      <Collapsible className='w-full flex flex-col align-start gap-2'>
                        <CollapsibleTrigger asChild>
                          <Button variant='outline' className='self-start'>
                            Consumer
                            <ChevronsUpDownIcon />
                          </Button>
                        </CollapsibleTrigger>

                        <CollapsibleContent>
                          <CodeBlock
                            lang='json'
                            code={JSON.stringify(
                              omit(consumer, 'project', 'deployment'),
                              null,
                              2
                            )}
                            className='border rounded-sm max-w-full overflow-x-auto'
                          />
                        </CollapsibleContent>
                      </Collapsible>
                    )}
                  </TabsContent>
                )}
              </div>
            </Tabs>
          </div>
        )}
      </section>
    </PageContainer>
  )
}

function ProjectHeader({
  project,
  tab
}: {
  project: Project
  tab?: MarketplacePublicProjectDetailTab
}) {
  const ctx = useAgentic()

  const pricingTabHref = `/marketplace/projects/${project.identifier}?tab=pricing`

  return (
    <>
      {/* <MarketplacePublicProjectDetailNav
        projectIdentifier={project.identifier}
      /> */}

      <div className='flex flex-col gap-2'>
        <div className='w-full flex flex-row gap-2.5 items-center'>
          <img
            src={
              project.lastPublishedDeployment?.iconUrl ||
              project.user?.image ||
              '/agentic-icon-circle-light.svg'
            }
            alt={project.name}
            className='aspect-square w-10 h-10'
          />

          <h1 className='flex-1 font-semibold text-balance text-3xl leading-tight'>
            {project.name}
          </h1>

          <HeroButton
            heroVariant='orange'
            className='justify-self-end'
            disabled={tab === 'pricing' && !!ctx?.isAuthenticated}
            asChild={tab !== 'pricing'}
          >
            <Link
              href={
                ctx?.isAuthenticated
                  ? pricingTabHref
                  : `/signup?${sanitizeSearchParams({ next: pricingTabHref })}`
              }
            >
              Subscribe to {project.identifier}
            </Link>
          </HeroButton>
        </div>

        <div className='flex flex-row items-center'>
          <div className='text-sm text-muted-foreground flex flex-row gap-0.5 items-center hover:no-underline! no-underline!'>
            <span>{project.identifier}</span>

            {/* TODO: <CopyIcon className='w-4 h-4' /> */}
          </div>

          {project.lastPublishedDeployment?.homepageUrl && (
            <Button asChild variant='link'>
              <Link
                href={project.lastPublishedDeployment.homepageUrl}
                className='text-sm flex flex-row gap-1.5! items-center text-muted-foreground! py-1! px-2!'
                target='_blank'
                rel='noopener noreferrer'
              >
                <ExternalLinkIcon className='w-4 h-4' />

                <span>Homepage</span>
              </Link>
            </Button>
          )}

          {project.lastPublishedDeployment?.sourceUrl && (
            <Button asChild variant='link'>
              <Link
                href={project.lastPublishedDeployment.sourceUrl}
                className='text-sm flex flex-row gap-1.5! items-center text-muted-foreground! py-1! px-2!'
                target='_blank'
                rel='noopener noreferrer'
              >
                <GitHubIcon className='w-4 h-4' />

                <span>GitHub</span>
              </Link>
            </Button>
          )}
        </div>
      </div>
    </>
  )
}


================================================
FILE: apps/web/src/app/marketplace/projects/[namespace]/[project-slug]/page.tsx
================================================
import { parseProjectIdentifier } from '@agentic/platform-validators'
import {
  dehydrate,
  HydrationBoundary,
  QueryClient
} from '@tanstack/react-query'
import { notFound } from 'next/navigation'

import { defaultAgenticApiClient } from '@/lib/default-agentic-api-client'
import { toastError } from '@/lib/notifications'

import { MarketplacePublicProjectDetail } from './marketplace-public-project-detail'

export default async function MarketplacePublicProjectDetailPage({
  params
}: {
  params: Promise<{
    namespace: string
    'project-slug': string
  }>
}) {
  const { namespace: rawNamespace, 'project-slug': rawProjectSlug } =
    await params

  let projectIdentifier: string
  try {
    const namespace = decodeURIComponent(rawNamespace)
    const projectSlug = decodeURIComponent(rawProjectSlug)

    const parsedProjectIdentifier = parseProjectIdentifier(
      `${namespace}/${projectSlug}`,
      { strict: true }
    )
    projectIdentifier = parsedProjectIdentifier.projectIdentifier
  } catch (err: any) {
    void toastError(err, { label: 'Invalid project identifier' })

    return notFound()
  }

  const queryClient = new QueryClient()

  await queryClient.prefetchQuery({
    queryKey: ['public-project', projectIdentifier],
    queryFn: () =>
      defaultAgenticApiClient.getPublicProjectByIdentifier({
        projectIdentifier,
        populate: ['lastPublishedDeployment']
      })
  })

  return (
    <HydrationBoundary state={dehydrate(queryClient)}>
      <MarketplacePublicProjectDetail projectIdentifier={projectIdentifier} />
    </HydrationBoundary>
  )
}


================================================
FILE: apps/web/src/app/marketplace/projects/[namespace]/[project-slug]/utils.ts
================================================
export const MAX_TOOLS_TO_SHOW = 5
export const marketplacePublicProjectDetailTabs = [
  'overview',
  'readme',
  'tools',
  'pricing',
  'debug'
] as const
export const marketplacePublicProjectDetailTabsSet = new Set(
  marketplacePublicProjectDetailTabs
)
export type MarketplacePublicProjectDetailTab =
  (typeof marketplacePublicProjectDetailTabs)[number]


================================================
FILE: apps/web/src/app/not-found.tsx
================================================
import { ArrowLeft } from 'lucide-react'
import Image from 'next/image'
import Link from 'next/link'

import { Button } from '@/components/ui/button'
// https://images.unsplash.com/photo-1545972154-9bb223aac798?ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&ixlib=rb-1.2.1&fm=jpg&fit=crop&w=2048&q=80&exp=8&con=-15&sat=-75
import NotFoundImage from '@/public/not-found.jpg'

export default function NotFound() {
  return (
    <>
      <section className='relative max-w-2xl isolate min-h-full flex-auto'>
        <Image
          alt='404 not found'
          src={NotFoundImage.src}
          width={NotFoundImage.width}
          height={NotFoundImage.height}
          blurDataURL={NotFoundImage.blurDataURL}
          placeholder='blur'
          priority
          className='absolute inset-0 -z-10 size-full object-cover object-top rounded-xl'
        />

        <div className='mx-auto max-w-7xl px-6 py-32 text-center sm:py-40 lg:px-8'>
          <p className='text-base/8 font-semibold text-white'>404</p>

          <h1 className='mt-4 text-balance text-5xl font-semibold tracking-tight text-white sm:text-7xl'>
            Page not found
          </h1>

          <p className='mt-6 text-pretty text-lg font-medium text-white/70 sm:text-xl/8'>
            Sorry, we couldn’t find the page you’re looking for.
          </p>
        </div>
      </section>

      <Button asChild>
        <Link href='/'>
          <ArrowLeft
            aria-hidden='true'
            className='inline-block w-[1.2em] h-[1.2em] mr-1'
          />
          Back to home
        </Link>
      </Button>
    </>
  )
}


================================================
FILE: apps/web/src/app/page.tsx
================================================
import Link from 'next/link'

import { DemandSideCTA } from '@/components/demand-side-cta'
import { DotsSection } from '@/components/dots-section'
import { ExampleUsageSection } from '@/components/example-usage-section'
import { GitHubStarCounter } from '@/components/github-star-counter'
import { HeroSimulation2 } from '@/components/hero-simulation-2'
import { MCPMarketplaceFeatures } from '@/components/mcp-marketplace-features'
import { PageContainer } from '@/components/page-container'
import { SupplySideCTA } from '@/components/supply-side-cta'
import { githubUrl, twitterUrl } from '@/lib/config'

export default async function TheBestDamnLandingPageEver() {
  return (
    <PageContainer>
      {/* Hero section */}
      <section className='flex flex-col gap-10 mb-16'>
        <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
          The App Store for LLM Tools
        </h1>

        <h5 className='text-center text-lg max-w-2xl'>
          Agentic is a curated marketplace of LLM tools that work with every
          major LLM SDK and MCP client.
        </h5>

        <DemandSideCTA />
      </section>

      {/* Example usage section */}
      <ExampleUsageSection />

      {/* Features section */}
      <section className='flex flex-col items-center gap-8 text-center mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Agentic tools are{' '}
          <span className='font-semibold'>optimized for LLMs</span>
        </h2>

        <MCPMarketplaceFeatures />
      </section>

      {/* MCP section */}
      <section className='flex flex-col items-center gap-8 text-center mb-16 max-w-2xl'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Agentic makes <span className='font-semibold'>MCP fun!</span>
        </h2>

        <div className='h-96 w-full rounded-lg overflow-hidden shadow-sm'>
          <HeroSimulation2 />
        </div>

        <p className='italic font-semibold'>
          Agentic's mission is to provide the world's best library of tools for
          AI agents.
        </p>

        <p>
          <Link
            href='https://docs.agentic.so/publishing/quickstart'
            className='link'
          >
            And of course, <span className='font-semibold'>MCP</span> is an
            integral part of that mission. We're working on a bunch of features
            designed to simplify advanced MCP use cases like bundling multiple
            tools, shared auth profiles, Vercel-like preview deployments, and a
            lot more...
          </Link>
        </p>
      </section>

      {/* CTA section */}
      <DotsSection className='flex flex-col gap-12 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Publish your own MCP products with Agentic
        </h2>

        <h5 className='text-center max-w-2xl'>
          Run one command to turn any MCP server or OpenAPI service into a paid
          MCP product. With built-in support for every major LLM SDK and MCP
          client.
        </h5>

        <SupplySideCTA variant='docs' />
      </DotsSection>

      {/* Open source section */}
      <section className='flex flex-col items-center gap-8 max-w-2xl text-center mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Agentic is 100% Open Source
        </h2>

        <p className=''>
          Agentic is a fully OSS{' '}
          <span className='font-semibold'>TypeScript</span> project with a small
          but vibrant developer community.{' '}
          <Link
            href={githubUrl}
            target='_blank'
            rel='noopener'
            className='link'
          >
            Check out the source on GitHub
          </Link>{' '}
          or{' '}
          <Link
            href={twitterUrl}
            target='_blank'
            rel='noopener'
            className='link'
          >
            ping me on Twitter with questions / feedback
          </Link>
          .
        </p>

        <GitHubStarCounter />
      </section>

      {/* Social proof section (TODO) */}
      {/* <section className='gap-8 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          TODO: social proof
        </h2>

        <p className='text-center text-lg max-w-2xl'>TODO</p>
      </section> */}

      {/* Demand-side CTA section */}
      <DotsSection className='flex flex-col gap-12 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Level up your AI Agents with the best tools
        </h2>

        <DemandSideCTA />
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/pricing/page.tsx
================================================
import Link from 'next/link'

import { DotsSection } from '@/components/dots-section'
import { GitHubStarCounter } from '@/components/github-star-counter'
import { HeroButton } from '@/components/hero-button'
import { PageContainer } from '@/components/page-container'
import { Button } from '@/components/ui/button'
import { calendarBookingUrl, emailUrl, twitterUrl } from '@/lib/config'

export default function AboutPage() {
  return (
    <PageContainer className='gap-12'>
      <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
        Pricing
      </h1>

      <div className='grid grid-cols-1 rounded-[2rem] shadow-[inset_0_0_2px_1px_#ffffff4d] ring-1 ring-black/5 max-lg:mx-auto max-lg:w-full max-lg:max-w-md max-w-lg'>
        <div className='grid grid-cols-1 rounded-[2rem] p-2 shadow-md shadow-black/5'>
          <div className='rounded-3xl bg-background p-8 pb-9 shadow-2xl ring-1 ring-black/5 flex flex-col gap-4'>
            <p>
              Pricing for devs publishing products on Agentic is a work in
              progress. We're looking for early adopters to work with us to
              figure out the best pricing structure.
            </p>

            <p>
              If you're interested in publishing a product on Agentic, please
              get in touch.
            </p>
          </div>
        </div>
      </div>

      {/* CTA section */}
      <DotsSection className='max-w-2xl'>
        <div className='relative grid grid-cols-1 sm:grid-cols-2 gap-8'>
          <HeroButton asChild heroVariant='orange'>
            <Link href={twitterUrl} target='_blank' rel='noopener'>
              DM me on Twitter / X
            </Link>
          </HeroButton>

          <Button asChild variant='outline' className='h-full py-[9px]'>
            <Link href={emailUrl}>Send me an email</Link>
          </Button>

          <Button asChild variant='outline' className='h-full py-[9px]'>
            <Link href={calendarBookingUrl} target='_blank' rel='noopener'>
              Book a call with me
            </Link>
          </Button>

          <GitHubStarCounter className='h-full py-[9px]' />
        </div>
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/privacy/page.tsx
================================================
import Link from 'next/link'

import { Markdown } from '@/components/markdown'
import { PageContainer } from '@/components/page-container'

const lastUpdatedDate = 'June 30, 2025'

export default function AboutPage() {
  return (
    <PageContainer>
      <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
        Privacy Policy
      </h1>

      <section>
        <Markdown>
          <p>
            <em>Last updated: {lastUpdatedDate}</em>
          </p>

          <h2>1. Overview</h2>
          <p>
            Agentic Systems, Inc. (<strong>"Agentic"</strong>,{' '}
            <strong>"we"</strong>,<strong>"us"</strong>, or{' '}
            <strong>"our"</strong>) provides a modern AI platform comprised of:
          </p>

          <ul>
            <li>
              <strong>Marketplace</strong> – a curated directory of LLM-powered
              tool products that can be called via the Model Context Protocol
              ("MCP") or standard HTTP&nbsp;APIs.
            </li>

            <li>
              <strong>Gateway</strong> – a fully-managed MCP gateway that allows
              developers to deploy, monetize, and optionally publish their own
              MCP or OpenAPI products.
            </li>

            <li>
              <strong>Open-Source Project</strong> – the Agentic
              source-available codebase released under the GNU&nbsp;AGPL-3.0
              license.
            </li>
          </ul>

          <p>
            This Privacy Policy explains how we collect, use, disclose, and
            safeguard information in connection with the Agentic website,
            console, Marketplace, Gateway, and any related services
            (collectively, the <strong>"Service"</strong>).
          </p>

          <h2>2. Information We Collect</h2>
          <p>
            We collect the following categories of information when you use the
            Service:
          </p>

          <ul>
            <li>
              <strong>Account Information</strong>: name, email, billing
              address, and authentication credentials that you provide when you
              create an Agentic account.
            </li>

            <li>
              <strong>Payment Information</strong>: payment method details
              (e.g.&nbsp;card type and last four digits) processed by Stripe on
              our behalf. Stripe's privacy practices are described in its own
              policy.
            </li>

            <li>
              <strong>Usage Data</strong>: log files, API request metadata, IP
              address, browser type, referring pages, and other diagnostic
              information automatically collected when you interact with the
              Service.
            </li>

            <li>
              <strong>Developer Content</strong>: API specifications,
              configuration, and other content that you upload to the Gateway or
              Marketplace.
            </li>

            <li>
              <strong>Cookies &amp; Similar Technologies</strong>: small data
              files placed on your device to enable site functionality,
              analytics, and preference storage. You can disable cookies in your
              browser settings, but parts of the Service may not function
              properly.
            </li>
          </ul>

          <h2>3. How We Use Information</h2>
          <p>We use the information we collect to:</p>

          <ul>
            <li>Provide, maintain, and improve the Service;</li>

            <li>
              Facilitate Marketplace and Gateway transactions, including billing
              through Stripe;
            </li>

            <li>Authenticate users and secure the Service;</li>

            <li>
              Monitor usage and detect, prevent, or address technical issues or
              fraudulent activity;
            </li>

            <li>
              Respond to inquiries, provide customer support, and send
              administrative messages;
            </li>

            <li>
              Send product updates, promotional communications, or other
              information that may be of interest to you (you may opt out at any
              time);
            </li>

            <li>Carry out research, analytics, and product development;</li>

            <li>
              Comply with legal obligations and enforce our Terms of Service.
            </li>
          </ul>

          <h2>4. Sharing &amp; Disclosure</h2>
          <p>We may share information as follows:</p>

          <ul>
            <li>
              <strong>Service Providers</strong>: with vendors who perform
              services on our behalf, such as hosting, analytics, and payment
              processing.
            </li>

            <li>
              <strong>API Providers &amp; Consumers</strong>: Marketplace
              product owners may receive usage metrics related to their own
              products; conversely, when you list a product we may display your
              developer profile to potential consumers.
            </li>

            <li>
              <strong>Business Transfers</strong>: as part of a merger,
              acquisition, financing, or sale of assets.
            </li>

            <li>
              <strong>Affiliates</strong>: with our corporate affiliates who are
              bound to honor this policy.
            </li>

            <li>
              <strong>Legal Requirements</strong>: when required to comply with
              law or protect the rights, property, or safety of Agentic, our
              users, or the public.
            </li>

            <li>
              <strong>With Your Consent</strong>: in any other situation where
              you direct us to share the information.
            </li>
          </ul>

          <h2>5. Payments via Stripe</h2>
          <p>
            All Marketplace purchases and Gateway subscription fees are
            processed by Stripe. Agentic does not store full payment-card
            numbers or CVC codes. Stripe acts as a separate controller of your
            payment information – please review the{' '}
            <a
              href='https://stripe.com/privacy'
              target='_blank'
              rel='noopener noreferrer'
            >
              Stripe&nbsp;Privacy&nbsp;Policy
            </a>{' '}
            for details.
          </p>

          <h2>6. Data Retention</h2>
          <p>
            We retain information for as long as necessary to fulfill the
            purposes described in this Policy, comply with our legal
            obligations, resolve disputes, and enforce our agreements. Log data
            is typically retained for no more than 18&nbsp;months unless we are
            legally required to keep it longer.
          </p>

          <h2>7. International Transfers</h2>
          <p>
            We are a U.S.-based company and may process information in the
            United States and other countries where we or our service providers
            operate. We rely on appropriate safeguards, such as Standard
            Contractual Clauses, for the transfer of personal data from the
            EU/EEA, UK, and Switzerland.
          </p>

          <h2>8. Security</h2>
          <p>
            We employ technical and organizational measures designed to protect
            information against loss, misuse, and unauthorized access or
            disclosure. However, no system can be guaranteed to be 100% secure.
          </p>

          <h2>9. Your Rights</h2>
          <p>
            Depending on your jurisdiction, you may have rights to access,
            rectify, delete, restrict, or object to our processing of your
            personal information, as well as the right to data portability and
            to withdraw consent. To exercise these rights, please contact us as
            set forth below. We respond to all requests consistent with
            applicable law.
          </p>

          <h2>10. Children's Privacy</h2>
          <p>
            The Service is not directed to children under 13, and we do not
            knowingly collect personal information from children. If you believe
            a child has provided us with personal information, please contact us
            and we will take steps to delete such information.
          </p>

          <h2>11. Third-Party Links</h2>
          <p>
            The Service may contain links to third-party websites. We are not
            responsible for the privacy practices of those sites. We encourage
            you to review the privacy policies of every site you visit.
          </p>

          <h2>12. Changes to This Policy</h2>
          <p>
            We may update this Privacy Policy from time to time. We will post
            the revised version on this page and indicate the date of the latest
            revision at the top. If changes are material, we will provide
            additional notice (e.g., email or in-app alert) at least 7&nbsp;days
            before they take effect.
          </p>

          <h2>13. Contact Us</h2>
          <p>
            If you have any questions or concerns about this Privacy Policy or
            our privacy practices, please{' '}
            <Link href='/contact'>contact us</Link> or email us at{' '}
            <a href='mailto:support@agentic.so'>support@agentic.so</a>.
          </p>
        </Markdown>
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/providers.tsx
================================================
'use client'

import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { ReactQueryDevtools } from '@tanstack/react-query-devtools'

import { AgenticProvider } from '@/components/agentic-provider'
import { PostHogProvider } from '@/components/posthog-provider'
import { ThemeProvider } from '@/components/theme-provider'
import { TooltipProvider } from '@/components/ui/tooltip'
import { isServer } from '@/lib/config'

function createQueryClient() {
  return new QueryClient({
    defaultOptions: {
      queries: {
        staleTime: 60 * 1000
      }
    }
  })
}

let browserQueryClient: QueryClient | undefined

function getQueryClient(): QueryClient {
  if (isServer) {
    // Server: always make a new query client
    return createQueryClient()
  } else {
    // Browser: make a new query client if we don't already have one
    // This is very important, so we don't re-make a new client if React
    // suspends during the initial render. This may not be needed if we
    // have a suspense boundary BELOW the creation of the query client
    if (!browserQueryClient) {
      browserQueryClient = createQueryClient()
    }

    return browserQueryClient
  }
}

export default function Providers({ children }: { children: React.ReactNode }) {
  const queryClient = getQueryClient()

  return (
    <PostHogProvider>
      <AgenticProvider>
        <ThemeProvider
          attribute='class'
          defaultTheme='dark'
          disableTransitionOnChange
        >
          <QueryClientProvider client={queryClient}>
            <TooltipProvider>{children}</TooltipProvider>

            <ReactQueryDevtools />
          </QueryClientProvider>
        </ThemeProvider>
      </AgenticProvider>
    </PostHogProvider>
  )
}


================================================
FILE: apps/web/src/app/publishing/page.tsx
================================================
import Image from 'next/image'
import Link from 'next/link'
import Zoom from 'react-medium-image-zoom'

import { DotsSection } from '@/components/dots-section'
import { ExampleUsageSection } from '@/components/example-usage-section'
import { GitHubStarCounter } from '@/components/github-star-counter'
import { MCPGatewayFeatures } from '@/components/mcp-gateway-features'
import { PageContainer } from '@/components/page-container'
import { SupplySideCTA } from '@/components/supply-side-cta'
import { githubUrl, twitterUrl } from '@/lib/config'
import mcpGatewayDemo from '@/public/agentic-mcp-gateway-mvp-diagram-light.png'

export default function PublishingMCPsPage() {
  return (
    <PageContainer>
      {/* Hero section */}
      <section className='flex flex-col gap-8 mb-16'>
        <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
          Your API → Paid MCP, Instantly
        </h1>

        <h5 className='text-center text-lg max-w-2xl'>
          Run one command to turn any MCP server or OpenAPI service into a paid
          MCP product. With built-in support for every major LLM SDK and MCP
          client.
        </h5>

        <SupplySideCTA />
      </section>

      {/* How it works section */}
      <section className='flex flex-col gap-8 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          How It Works
        </h2>

        <div className='w-full max-w-3xl flex flex-col items-center border rounded-lg shadow-sm overflow-hidden p-4 bg-white'>
          <Zoom>
            <Image
              src={mcpGatewayDemo.src}
              alt='MCP Gateway Demo'
              width={mcpGatewayDemo.width}
              height={mcpGatewayDemo.height}
              blurDataURL={mcpGatewayDemo.blurDataURL}
              placeholder='blur'
              className='w-full rounded-lg overflow-hidden'
            />
          </Zoom>
        </div>

        <p className='text-sm max-w-2xl text-center'>
          <Link href='https://docs.agentic.so/publishing' className='link'>
            Deploy any MCP server or OpenAPI service to Agentic's MCP Gateway,
            which handles auth, billing, rate-limiting, caching, etc. And
            instantly turn your API into a paid MCP product that supports every
            major LLM SDK and MCP client.
          </Link>
        </p>
      </section>

      {/* Example usage section */}
      <ExampleUsageSection />

      {/* Features section */}
      <section className='flex flex-col gap-8 md:gap-12 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Production-Ready MCP Gateway
        </h2>

        <MCPGatewayFeatures />
      </section>

      {/* Open source section */}
      <section className='flex flex-col items-center gap-8 max-w-2xl text-center mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Agentic is 100% Open Source
        </h2>

        <p className=''>
          Agentic is a fully OSS{' '}
          <span className='font-semibold'>TypeScript</span> project with a small
          but vibrant developer community.{' '}
          <Link
            href={githubUrl}
            target='_blank'
            rel='noopener'
            className='link'
          >
            Check out the source on GitHub
          </Link>{' '}
          or{' '}
          <Link
            href={twitterUrl}
            target='_blank'
            rel='noopener'
            className='link'
          >
            ping me on Twitter with questions / feedback
          </Link>
          .
        </p>

        <GitHubStarCounter />
      </section>

      {/* CTA section */}
      <DotsSection className='flex flex-col gap-12 mb-16'>
        <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
          Deploy Your MCP Today
        </h2>

        <SupplySideCTA variant='github-2' />
      </DotsSection>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/app/signup/page.tsx
================================================
import { Suspense } from 'react'

import { PageContainer } from '@/components/page-container'

import { SignupForm } from './signup-form'

export default function Page() {
  return (
    <Suspense>
      <PageContainer>
        <SignupForm />
      </PageContainer>
    </Suspense>
  )
}


================================================
FILE: apps/web/src/app/signup/signup-form.tsx
================================================
'use client'

import { sanitizeSearchParams } from '@agentic/platform-core'
import {
  isValidEmail,
  isValidPassword,
  isValidUsername
} from '@agentic/platform-validators'
import { useForm } from '@tanstack/react-form'
import { Loader2Icon } from 'lucide-react'
import { useRouter } from 'next/navigation'
import { useCallback, useState } from 'react'
import { z } from 'zod'

import {
  useNextUrl,
  useUnauthenticatedAgentic
} from '@/components/agentic-provider'
import { Button } from '@/components/ui/button'
import { Input } from '@/components/ui/input'
import { Label } from '@/components/ui/label'
import { GitHubIcon } from '@/icons/github'
import { toastError } from '@/lib/notifications'
import { cn } from '@/lib/utils'

export function SignupForm() {
  const ctx = useUnauthenticatedAgentic()
  const nextUrl = useNextUrl()
  const router = useRouter()
  const [isGitHubLoading, setIsGitHubLoading] = useState(false)

  const onAuthWithGitHub = useCallback(async () => {
    setIsGitHubLoading(true)
    try {
      const redirectUri = `${globalThis.location.origin}/auth/github/success?${sanitizeSearchParams({ next: nextUrl }).toString()}`
      const url = await ctx!.api.initAuthFlowWithGitHub({ redirectUri })

      return router.push(url)
    } catch (err: any) {
      setIsGitHubLoading(false)
      void toastError(err, { label: 'GitHub auth error' })
    }
  }, [ctx, nextUrl, router])

  const form = useForm({
    defaultValues: {
      email: '',
      username: '',
      password: '',
      repeat: ''
    },
    validators: {
      onChange: z.object({
        email: z
          .string()
          .email()
          .refine((email) => isValidEmail(email)),
        username: z.string().refine((username) => isValidUsername(username)),
        password: z.string().refine((password) => isValidPassword(password)),
        repeat: z.string().refine((password) => isValidPassword(password))
      })
    },
    onSubmit: async ({ value }) => {
      try {
        if (value.password !== value.repeat) {
          void toastError('Passwords do not match', { label: 'signup error' })
          return
        }

        const res = await ctx!.api.signUpWithPassword({
          email: value.email,
          username: value.username,
          password: value.password
        })

        console.log('signup success', res)
      } catch (err: any) {
        void toastError(err, { label: 'signup error' })
        return
      }

      return router.push(nextUrl || '/app')
    }
  })

  return (
    <section className='flex-1'>
      <div className='flex flex-col flex-1 items-center justify-center w-full max-w-xs gap-6'>
        <form
          className={cn('flex flex-col gap-6 w-full')}
          onSubmit={(e) => {
            e.preventDefault()
            void form.handleSubmit()
          }}
        >
          <div className='flex flex-col items-center gap-2 text-center'>
            <h1 className='text-2xl font-bold'>Create an account</h1>
          </div>

          <div className='grid gap-6'>
            <form.Field
              name='email'
              children={(field) => (
                <div className='grid gap-3'>
                  <Label htmlFor={field.name}>Email</Label>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='email'
                    required
                    placeholder='Email'
                    autoComplete='email'
                    autoFocus={true}
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e: any) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Field
              name='username'
              children={(field) => (
                <div className='grid gap-3'>
                  <Label htmlFor={field.name}>Username</Label>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='text'
                    required
                    placeholder='Username'
                    autoComplete='username'
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e: any) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Field
              name='password'
              children={(field) => (
                <div className='grid gap-3'>
                  <Label htmlFor={field.name}>Password</Label>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='password'
                    required
                    placeholder='Password'
                    // autoFocus={error?.type === 'invalid_password'}
                    autoComplete='new-password'
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Field
              name='repeat'
              children={(field) => (
                <div className='grid gap-3'>
                  <Label htmlFor={field.name}>Repeat password</Label>

                  <Input
                    id={field.name}
                    name={field.name}
                    type='password'
                    required
                    placeholder='Password'
                    autoComplete='new-password'
                    value={field.state.value}
                    onBlur={field.handleBlur}
                    onChange={(e) => field.handleChange(e.target.value)}
                  />
                </div>
              )}
            />

            <form.Subscribe
              selector={(state) => [
                state.canSubmit,
                state.isSubmitting,
                state.isTouched
              ]}
              children={([canSubmit, isSubmitting, isTouched]) => (
                <Button
                  type='submit'
                  disabled={!(isTouched && canSubmit && ctx)}
                  className='w-full'
                >
                  {isSubmitting && <Loader2Icon className='animate-spin' />}
                  <span>Sign up</span>
                </Button>
              )}
            />
          </div>
        </form>

        <div className='flex items-center gap-2 text-center text-sm w-full'>
          <div className='border-border border-t inset-0 flex-1' />
          <div className='text-muted-foreground'>Or continue with</div>
          <div className='border-border border-t inset-0 flex-1' />
        </div>

        <form
          className='w-full'
          onSubmit={(e) => {
            e.preventDefault()
            void onAuthWithGitHub()
          }}
        >
          <Button
            type='submit'
            variant='outline'
            className='w-full'
            disabled={isGitHubLoading || !ctx}
          >
            {isGitHubLoading && <Loader2Icon className='animate-spin' />}
            <GitHubIcon />

            <span>Sign up with GitHub</span>
          </Button>
        </form>

        <div className='text-center text-xs'>
          Already have an account?{' '}
          <a
            href={`/login?${sanitizeSearchParams({ next: nextUrl }).toString()}`}
            className='underline underline-offset-4'
          >
            Login
          </a>
        </div>
      </div>
    </section>
  )
}


================================================
FILE: apps/web/src/app/terms/page.tsx
================================================
import Link from 'next/link'

import { Markdown } from '@/components/markdown'
import { PageContainer } from '@/components/page-container'

const lastUpdatedDate = 'June 30, 2025'

export default function AboutPage() {
  return (
    <PageContainer>
      <h1 className='text-center text-balance leading-snug md:leading-none text-4xl font-semibold'>
        Terms of Service
      </h1>

      <section>
        <Markdown>
          <p>
            <em>Last updated: {lastUpdatedDate}</em>
          </p>

          <h2>1. Introduction</h2>
          <p>
            These Terms of Service (<strong>"Terms"</strong>) govern your access
            to and use of Agentic Systems, Inc.'s websites, software, and
            related services (collectively, the <strong>"Service"</strong>).
            Agentic (<strong>"Agentic," "we," "us,"</strong> or{' '}
            <strong>"our"</strong>) provides three distinct but connected
            offerings:
          </p>

          <p>
            <strong>(a) Agentic Marketplace</strong> – A curated app store of
            LLM tool products exposed via both Model Context Protocol (MCP) and
            standard HTTP&nbsp;APIs.
          </p>

          <p>
            <strong>(b) Agentic Gateway</strong> – A fully managed MCP gateway
            that enables developers to deploy and monetize their own MCP or
            OpenAPI products, whether privately or publicly.
          </p>

          <p>
            <strong>(c) Agentic Open-Source Project</strong> – The
            source-available software released under the GNU&nbsp;AGPL-3.0
            license.
          </p>

          <p>
            By creating an account, clicking "I&nbsp;agree," or otherwise using
            any part of the Service, you acknowledge that you have read,
            understood, and agree to be legally bound by these Terms. If you do
            not agree, you must not access or use the Service.
          </p>

          <h2>2. Eligibility &amp; Account Registration</h2>
          <p>
            You must be at least 18&nbsp;years old and legally capable of
            entering into contracts to use the Service. When you register an
            Agentic account you agree to (i) provide accurate, current, and
            complete information; (ii) maintain the security of your
            credentials; and (iii) promptly update your information as
            necessary. You are responsible for all activity occurring under your
            account.
          </p>

          <h2>3. Plans, Subscriptions &amp; Fees</h2>
          <p>
            Pricing for Marketplace purchases and Gateway subscriptions is
            described on the applicable order page or pricing dashboard. All
            charges are processed by Stripe and are due within the payment
            period stated at checkout. Except as required by law, payments are
            non-refundable. We may modify our pricing with at least&nbsp;30
            days' notice, which will take effect in your next billing cycle.
            Developers publishing products to the Agentic Marketplace must also
            agree to the{' '}
            <a
              href='https://stripe.com/legal/connect-account'
              target='_blank'
              rel='noopener noreferrer'
            >
              Stripe Connect Account Agreement
            </a>
            .
          </p>

          <h2>4. Marketplace-Specific Terms</h2>
          <p>
            (a) <strong>API Consumers.</strong> When you purchase access to a
            product in the Marketplace you receive a non-exclusive,
            non-transferable, revocable license to call that API subject to any
            usage limits and other terms displayed on the product page.
          </p>

          <p>
            (b) <strong>API Providers.</strong> If you list a product in the
            Marketplace you (i) represent that you have all rights necessary to
            offer the product; (ii) grant each purchaser the license described
            above; and (iii) authorize Agentic to collect payments on your
            behalf and remit amounts owed to you, less any platform fees.
          </p>

          <h2>5. Gateway-Specific Terms</h2>
          <p>
            You may deploy private or public APIs through the Gateway. You are
            solely responsible for the security, legality, and performance of
            the APIs you deploy. If you enable billing, you appoint Agentic as
            your limited payments collection agent for the purpose of accepting
            payments from end users via Stripe.
          </p>

          <h2>6. Open-Source Project</h2>
          <p>
            The Agentic open-source codebase is licensed under the{' '}
            <Link
              href='https://github.com/transitive-bullshit/agentic/blob/main/license'
              className='link'
              target='_blank'
              rel='noopener noreferrer'
            >
              GNU&nbsp;AGPL-3.0 license
            </Link>
            . Your use of the open-source project is governed solely by that
            license. Nothing in these Terms will be interpreted to limit your
            rights granted under the AGPL-3.0, nor to grant additional rights
            beyond it.
          </p>

          <h2>7. User Content</h2>
          <p>
            "<strong>User Content</strong>" means any code, text, data, or other
            materials you upload to the Service, including APIs, metadata, and
            documentation. You retain all ownership rights in your User Content.
            You hereby grant Agentic a worldwide, non-exclusive, royalty-free
            license to host, cache, reproduce, display, perform, modify (solely
            for technical purposes, e.g.&nbsp;formatting), and distribute your
            User Content as necessary to operate and improve the Service. You
            are solely responsible for your User Content and represent that you
            have all rights necessary to grant this license and that your User
            Content does not violate any law or third-party rights.
          </p>

          <h2>8. Acceptable Use Policy</h2>
          <p>
            You agree not to (i) violate applicable laws; (ii) infringe the
            intellectual-property or privacy rights of others; (iii) transmit
            malicious code; (iv) attempt to gain unauthorized access to the
            Service; (v) interfere with the integrity or performance of the
            Service; or (vi) send spam or engage in fraudulent or deceptive
            practices. We may suspend or terminate accounts that violate this
            policy.
          </p>

          <h2>9. Privacy &amp; Security</h2>
          <p>
            Our collection and use of personal information is described in our
            <Link href='/privacy'>Privacy&nbsp;Policy</Link>. We implement
            appropriate technical and organizational measures to safeguard your
            data; however, no security measure is perfect and we cannot
            guarantee absolute security.
          </p>

          <h2>10. Intellectual Property</h2>
          <p>
            The Service, including all associated software, content, and
            trademarks, is owned by Agentic or its licensors and is protected by
            intellectual-property laws. Except for the rights expressly granted
            to you in these Terms, we reserve all rights, title, and interest in
            the Service.
          </p>

          <h2>11. Suspension &amp; Termination</h2>
          <p>
            We may suspend or terminate your access to the Service at any time
            if we believe you have violated these Terms or if necessary to
            protect the Service or its users. Upon termination, your right to
            use the Service will cease immediately, but Sections&nbsp;6–16 will
            survive.
          </p>

          <h2>12. Disclaimers</h2>
          <p>
            THE SERVICE IS PROVIDED <strong>"AS&nbsp;IS"</strong> AND
            <strong>"AS&nbsp;AVAILABLE"</strong> WITHOUT WARRANTY OF ANY KIND.
            TO THE MAXIMUM EXTENT PERMITTED BY LAW, AGENTIC DISCLAIMS ALL
            WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE,
            INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
            NON-INFRINGEMENT. WE DO NOT WARRANT THAT THE SERVICE WILL BE
            UNINTERRUPTED, ERROR-FREE, OR SECURE.
          </p>

          <h2>13. Limitation of Liability</h2>
          <p>
            TO THE FULLEST EXTENT PERMITTED BY LAW, IN NO EVENT WILL AGENTIC BE
            LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR
            EXEMPLARY DAMAGES (INCLUDING LOSS OF PROFITS, GOODWILL, OR DATA)
            ARISING OUT OF OR IN CONNECTION WITH THE SERVICE, EVEN IF ADVISED OF
            THE POSSIBILITY OF SUCH DAMAGES. AGENTIC'S TOTAL LIABILITY UNDER
            THESE TERMS WILL NOT EXCEED THE GREATER OF (A)&nbsp;FEES YOU PAID TO
            AGENTIC IN THE&nbsp;12 MONTHS PRECEDING THE EVENT GIVING RISE TO THE
            CLAIM OR (B)&nbsp;USD&nbsp;100.
          </p>

          <h2>14. Indemnification</h2>
          <p>
            You will indemnify and hold harmless Agentic and its officers,
            directors, employees, and agents from and against any third-party
            claims, damages, and expenses (including reasonable attorneys' fees)
            arising out of or related to your (i) breach of these Terms, (ii)
            User Content, or (iii) violation of any law or third-party rights.
          </p>

          <h2>15. Governing Law &amp; Venue</h2>
          <p>
            These Terms are governed by the laws of the State of Delaware,
            excluding its conflict-of-laws rules. The state and federal courts
            located in Wilmington, Delaware will have exclusive jurisdiction to
            adjudicate any dispute arising out of or relating to these Terms or
            the Service, and you consent to personal jurisdiction and venue in
            those courts.
          </p>

          <h2>16. Changes to These Terms</h2>
          <p>
            We may update these Terms by posting a revised version on our
            website and providing notice via email or in-app notification at
            least&nbsp;7 days before the effective date. Continued use of the
            Service after the effective date constitutes acceptance of the
            revised Terms.
          </p>

          <h2>17. Contact</h2>
          <p>
            Questions or notices required under these Terms should be sent to
            <a href='mailto:support@agentic.so'>support@agentic.so</a>. You may
            also
            <Link href='/contact'>contact&nbsp;us</Link> through our website.
          </p>
        </Markdown>
      </section>
    </PageContainer>
  )
}


================================================
FILE: apps/web/src/components/active-link.tsx
================================================
'use client'

import cs from 'clsx'
import Link, { type LinkProps } from 'next/link'
import { usePathname } from 'next/navigation'
import * as React from 'react'

type ActiveLinkProps = LinkProps & {
  children?: React.ReactNode
  className?: string
  activeClassName?: string
  style?: React.CSSProperties

  // optional comparison function to normalize URLs before comparing
  compare?: (a?: any, b?: any) => boolean
}

/**
 * Link that will be disabled if the target `href` is the same as the current
 * route's pathname.
 */
export const ActiveLink = React.forwardRef(function ActiveLink(
  {
    children,
    href,
    style,
    className,
    activeClassName,
    onClick,
    prefetch,
    compare = (a, b) => a === b,
    ...props
  }: ActiveLinkProps,
  ref
) {
  const pathname = usePathname()
  const [disabled, setDisabled] = React.useState(false)

  React.useEffect(() => {
    const currentUrl = new URL(location.href)
    const url = new URL(href as string, currentUrl)
    const linkPathname = url.pathname
    const linkOrigin = url.origin

    setDisabled(
      compare(linkPathname, pathname) && compare(linkOrigin, currentUrl.origin)
    )
  }, [pathname, href, compare])

  const styleOverride = React.useMemo<React.CSSProperties>(
    () =>
      disabled
        ? {
            ...style,
            pointerEvents: 'none'
          }
        : (style ?? {}),
    [disabled, style]
  )

  const onClickOverride = React.useCallback(
    (event: any): void => {
      if (disabled) {
        event.preventDefault()
        return
      }

      if (onClick) {
        onClick(event)
        return
      }
    },
    [disabled, onClick]
  )

  return (
    <Link
      {...props}
      className={cs('cursor-pointer', className, disabled && activeClassName)}
      href={href}
      prefetch={disabled ? false : prefetch}
      style={styleOverride}
      onClick={onClickOverride}
      ref={ref as any}
    >
      {children}
    </Link>
  )
})


================================================
FILE: apps/web/src/components/agentic-provider.tsx
================================================
'use client'

import {
  AgenticApiClient,
  type AuthSession
} from '@agentic/platform-api-client'
import { sanitizeSearchParams } from '@agentic/platform-core'
import { usePathname, useRouter, useSearchParams } from 'next/navigation'
import {
  createContext,
  type ReactNode,
  useCallback,
  useContext,
  useEffect,
  useState
} from 'react'
import { useLocalStorage } from 'react-use'

import * as config from '@/lib/config'

export type AgenticContextType = {
  api: AgenticApiClient
  isAuthenticated: boolean
  logout: () => void
}

const AgenticContext = createContext<AgenticContextType | undefined>(undefined)

export function AgenticProvider({ children }: { children: ReactNode }) {
  const [authSession, setAuthSession] = useLocalStorage<AuthSession | null>(
    'agentic-auth-session'
  )

  const logout = useCallback(() => {
    setAuthSession(null)
  }, [setAuthSession])

  const onUpdateAuth = useCallback(
    (updatedAuthSession?: AuthSession | null) => {
      // console.log('onUpdateAuth', {
      //   authSession: structuredClone(authSession),
      //   updatedAuthSession: structuredClone(updatedAuthSession),
      //   isCurrentlyAuthenticated: agenticContext.isAuthenticated
      // })

      if (
        !!authSession !== !!updatedAuthSession ||
        authSession?.token !== updatedAuthSession?.token ||
        agenticContext.isAuthenticated !== !!updatedAuthSession
      ) {
        setAuthSession(updatedAuthSession)
      }
    },
    // eslint-disable-next-line react-hooks/exhaustive-deps
    [authSession, setAuthSession]
  )

  const [agenticContext, setAgenticContext] = useState<AgenticContextType>({
    api: new AgenticApiClient({
      apiBaseUrl: config.apiBaseUrl,
      onUpdateAuth
    }),
    isAuthenticated: !!authSession,
    logout
  })

  useEffect(() => {
    // console.log('updating session from localStorage', authSession?.token)
    if (authSession) {
      // console.log('setting auth session to truthy', {
      //   authSession: structuredClone(authSession),
      //   isAuthenticated: agenticContext.isAuthenticated,
      //   setAgenticContext: !agenticContext.isAuthenticated
      // })

      agenticContext.api.authSession = authSession
      if (!agenticContext.isAuthenticated) {
        setAgenticContext({
          ...agenticContext,
          isAuthenticated: true
        })
      }
    } else {
      // console.log('setting auth session to falsy', {
      //   authSession: structuredClone(authSession),
      //   isAuthenticated: agenticContext.isAuthenticated,
      //   setAgenticContext: !!agenticContext.isAuthenticated
      // })

      agenticContext.api.authSession = undefined

      if (agenticContext.isAuthenticated) {
        setAgenticContext({
          ...agenticContext,
          isAuthenticated: false
        })
      }
    }
  }, [agenticContext, authSession])

  return (
    <AgenticContext.Provider value={agenticContext}>
      {children}
    </AgenticContext.Provider>
  )
}

export function useAgentic(): AgenticContextType | undefined {
  const ctx = useContext(AgenticContext)
  const [isMounted, setIsMounted] = useState(false)

  useEffect(() => {
    if (!isMounted) {
      setIsMounted(true)
      return
    }
  }, [isMounted, setIsMounted])

  if (!ctx) {
    throw new Error('useAgentic must be used within an AgenticProvider')
  }

  return isMounted ? ctx : undefined
}

export function useUnauthenticatedAgentic(): AgenticContextType | undefined {
  const ctx = useAgentic()
  const nextUrl = useNextUrl() || '/app'
  const router = useRouter()

  if (ctx && ctx.isAuthenticated) {
    console.log('REQUIRES NO AUTHENTICATION: redirecting to', nextUrl)
    void router.replace(nextUrl)
    return
  }

  return ctx
}

export function useAuthenticatedAgentic(): AgenticContextType | undefined {
  const ctx = useAgentic()
  const pathname = usePathname()
  const router = useRouter()

  if (ctx && !ctx.isAuthenticated) {
    if (pathname === '/logout') {
      console.log('LOGOUT SUCCESS: redirecting to /')
      void router.replace('/')
      return
    }

    console.log('REQUIRES AUTHENTICATION: redirecting to /login', {
      next: pathname
    })

    void router.replace(
      `/login?${sanitizeSearchParams({ next: pathname }).toString()}`
    )
    return
  }

  return ctx
}

export function useNextUrl(): string | undefined {
  const searchParams = useSearchParams()
  const [isMounted, setIsMounted] = useState(false)

  useEffect(() => {
    if (!isMounted) {
      setIsMounted(true)
      return
    }
  }, [isMounted, setIsMounted])

  return isMounted ? (searchParams.get('next') ?? undefined) : undefined
}


================================================
FILE: apps/web/src/components/app-consumers-list.tsx
================================================
'use client'

import Link from 'next/link'
import useInfiniteScroll from 'react-infinite-scroll-hook'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'
import { LoadingIndicator } from '@/components/loading-indicator'
import { useInfiniteQuery } from '@/lib/query-client'

export function AppConsumersList() {
  const ctx = useAuthenticatedAgentic()
  const limit = 10
  const {
    data,
    isLoading,
    isError,
    hasNextPage,
    fetchNextPage,
    isFetchingNextPage
  } = useInfiniteQuery({
    queryKey: ['consumers', ctx?.api.authSession?.user?.id],
    queryFn: ({ pageParam = 0 }) =>
      ctx!.api
        .listConsumers({
          populate: ['project'],
          offset: pageParam,
          limit
        })
        .then(async (consumers) => {
          return {
            consumers,
            offset: pageParam,
            limit,
            nextOffset:
              consumers.length >= limit
                ? pageParam + consumers.length
                : undefined
          }
        }),
    getNextPageParam: (lastGroup) => lastGroup?.nextOffset,
    enabled: !!ctx,
    initialPageParam: 0
  })

  const [sentryRef] = useInfiniteScroll({
    loading: isLoading || isFetchingNextPage,
    hasNextPage,
    onLoadMore: fetchNextPage,
    disabled: !ctx || isError,
    rootMargin: '0px 0px 200px 0px'
  })

  const consumers = data ? data.pages.flatMap((p) => p.consumers) : []
  const numConsumers = consumers.length

  return (
    <>
      {!ctx || isLoading ? (
        <LoadingIndicator />
      ) : (
        <div className='mt-8'>
          <h2 className='text-xl font-semibold mb-4'>Your Subscriptions</h2>

          {isError ? (
            <p>Error fetching customer subscriptions</p>
          ) : !consumers.length ? (
            <p>
              No subscriptions found.{' '}
              <Link href='/marketplace' className='link'>
                Subscribe to your first project to get started.
              </Link>
            </p>
          ) : (
            <div
              className={`grid grid-cols grid-cols-1 gap-4 sm:grid-cols-${Math.min(
                2,
                numConsumers
              )} xl:grid-cols-${Math.min(3, numConsumers)}`}
            >
              {consumers.map((consumer) => (
                <Link
                  key={consumer.id}
                  className='bg-card color-card-foreground p-4 border rounded-lg hover:border-gray-400 transition-colors overflow-hidden'
                  href={`/app/consumers/${consumer.id}`}
                >
                  <h3 className='font-medium'>{consumer.project.name}</h3>

                  <p className='text-sm text-gray-500'>
                    {consumer.project.identifier}
                  </p>

                  <pre className='max-w-lg'>
                    {JSON.stringify(consumer, null, 2)}
                  </pre>
                </Link>
              ))}

              {hasNextPage && (
                <div ref={sentryRef} className=''>
                  {isLoading || (isFetchingNextPage && <LoadingIndicator />)}
                </div>
              )}
            </div>
          )}
        </div>
      )}
    </>
  )
}


================================================
FILE: apps/web/src/components/app-projects-list.tsx
================================================
'use client'

import Link from 'next/link'
import useInfiniteScroll from 'react-infinite-scroll-hook'

import { useAuthenticatedAgentic } from '@/components/agentic-provider'
import { LoadingIndicator } from '@/components/loading-indicator'
import { useInfiniteQuery } from '@/lib/query-client'

export function AppProjectsList() {
  const ctx = useAuthenticatedAgentic()
  const limit = 10
  const {
    data,
    isLoading,
    isError,
    hasNextPage,
    fetchNextPage,
    isFetchingNextPage
  } = useInfiniteQuery({
    queryKey: ['projects', ctx?.api.authSession?.user?.id],
    queryFn: ({ pageParam = 0 }) =>
      ctx!.api
        .listProjects({
          populate: ['lastPublishedDeployment'],
          offset: pageParam,
          limit
        })
        .then(async (projects) => {
          return {
            projects,
            offset: pageParam,
            limit,
            nextOffset:
              projects.length >= limit ? pageParam + projects.length : undefined
          }
        }),
    getNextPageParam: (lastGroup) => lastGroup?.nextOffset,
    enabled: !!ctx,
    initialPageParam: 0
  })

  const [sentryRef] = useInfiniteScroll({
    loading: isLoading || isFetchingNextPage,
    hasNextPage,
    onLoadMore: fetchNextPage,
    disabled: !ctx || isError,
    rootMargin: '0px 0px 200px 0px'
  })

  const projects = data ? data.pages.flatMap((p) => p.projects) : []

  return (
    <>
      {!ctx || isLoading ? (
        <LoadingIndicator />
      ) : (
        <div className='mt-8'>
          <h2 className='text-xl font-semibold mb-4'>Your Projects</h2>

          {isError ? (
            <p>Error fetching projects</p>
          ) : !projects.length ? (
            <p>
              No projects found.{' '}
              <Link
                href='https://docs.agentic.so/publishing/quickstart'
                className='link'
              >
                Create your first project to get started.
              </Link>
            </p>
          ) : (
            <div className='grid grid-cols grid-cols-1 gap-4 sm:grid-cols-2 xl:grid-cols-3'>
              {projects.map((project) => (
                <Link
                  key={project.id}
                  className='p-4 border rounded-lg hover:border-gray-400 transition-colors overflow-hidden'
                  href={`/app/projects/${project.identifier}`}
                >
                  <h3 className='font-medium'>{project.name}</h3>

                  <p className='text-sm text-gray-500'>{project.identifier}</p>

                  {project.lastPublishedDeployment && (
                    <p className='text-sm text-gray-500 mt-1'>
                      Last published:{' '}
                      {project.lastPublishedDeployment.version ||
                        project.lastPublishedDeployment.hash}
                    </p>
                  )}
                </Link>
              ))}

              {hasNextPage && (
                <div ref={sentryRef} className=''>
                  {isLoading || (isFetchingNextPage && <LoadingIndicator />)}
                </div>
              )}
            </div>
          )}
        </div>
      )}
    </>
  )
}


================================================
FILE: apps/web/src/components/bootstrap.tsx
================================================
'use client'

import { useFirstMountState } from 'react-use'

import { bootstrap } from '@/lib/bootstrap'

export function Bootstrap() {
  const isFirstMount = useFirstMountState()

  if (isFirstMount) {
    bootstrap()
  }

  // Return `null` so we can use this as a react component
  return null
}


================================================
FILE: apps/web/src/components/code-block/highlight.ts
================================================
import { toJsxRuntime } from 'hast-util-to-jsx-runtime'
import { Fragment, type JSX } from 'react'
import { jsx, jsxs } from 'react/jsx-runtime'
import { type BundledLanguage, codeToHast } from 'shiki/bundle/web'

import { cn } from '@/lib/utils'

// TODO: consider adding [twoslash](https://shiki.style/packages/twoslash)

export async function highlight({
  code,
  lang = 'ts',
  theme = 'github-dark',
  className
}: {
  code: string
  lang?: BundledLanguage
  theme?: string
  className?: string
}): Promise<JSX.Element> {
  className = cn(
    'w-full text-wrap p-2 md:p-4 text-sm rounded-sm overflow-x-auto',
    className
  )

  const hast = await codeToHast(code, {
    lang,
    theme,
    // TODO: use a custom `pre` element down below instead of this
    transformers: [
      {
        pre(node) {
          if (className) {
            this.addClassToHast(node, className)
          }
        }
      }
    ]
  })

  return toJsxRuntime(hast, {
    Fragment,
    jsx,
    jsxs
  })
}


================================================
FILE: apps/web/src/components/code-block/index.tsx
================================================
'use client'

import { CheckIcon, CopyIcon } from 'lucide-react'
import { type JSX, useCallback, useEffect, useRef, useState } from 'react'
import { type BundledLanguage } from 'shiki/bundle/web'

import { LoadingIndicator } from '@/components/loading-indicator'
import { Button } from '@/components/ui/button'
import {
  Tooltip,
  TooltipContent,
  TooltipTrigger
} from '@/components/ui/tooltip'
import { toastError } from '@/lib/notifications'
import { cn } from '@/lib/utils'

import { highlight } from './highlight'

export function CodeBlock({
  initial,
  code,
  lang,
  theme,
  className
}: {
  initial?: JSX.Element
  code: string
  lang?: BundledLanguage
  theme?: string
  className?: string
}) {
  const [nodes, setNodes] = useState(initial)
  const [isCopied, setIsCopied] = useState(false)
  const timeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null)

  useEffect(() => {
    void highlight({
      code,
      lang,
      theme
    }).then(setNodes)
  }, [code, lang, theme])

  const onCopy = useCallback(() => {
    ;(async () => {
      try {
        await navigator.clipboard.writeText(code)
        setIsCopied(true)

        if (timeoutRef.current) {
          clearTimeout(timeoutRef.current)
          timeoutRef.current = null
        }

        timeoutRef.current = setTimeout(() => {
          timeoutRef.current = null
          setIsCopied(false)
        }, 2000)
      } catch {
        setIsCopied(true)

        if (timeoutRef.current) {
          clearTimeout(timeoutRef.current)
          timeoutRef.current = null
        }
        void toastError('Error copying code to clipboard')
      }
    })()
  }, [code, timeoutRef])

  const numNewLines = code.split('\n').length

  return (
    <div
      className={cn('relative group rounded-sm w-full shadow-sm', className)}
    >
      {nodes ? (
        <>
          {nodes}

          <Tooltip>
            <TooltipTrigger asChild>
              <Button
                variant='outline'
                className={cn(
                  'absolute right-2 px-2.5! opacity-0 group-hover:opacity-100 group-hover:duration-0 transition-opacity duration-150',
                  numNewLines <= 1 ? 'top-[50%] translate-y-[-50%]' : 'top-2'
                )}
                onClick={onCopy}
              >
                {isCopied ? <CheckIcon /> : <CopyIcon />}
              </Button>
            </TooltipTrigger>

            <TooltipContent side='bottom'>
              {isCopied ? <span>Copied</span> : <span>Copy to clipboard</span>}
            </TooltipContent>
          </Tooltip>
        </>
      ) : (
        <LoadingIndicator />
      )}
    </div>
  )
}


================================================
FILE: apps/web/src/components/confetti.tsx
================================================
'use client'

import type { Simplify } from 'type-fest'
import confetti, { type Options as ConfettiBaseOptions } from 'canvas-confetti'
import { useCallback } from 'react'

import { randomInRange } from '@/lib/utils'

export type ConfettiOptions = Simplify<
  ConfettiBaseOptions & {
    duration?: number
    intervalMs?: number
  }
>

// TODO: make shoot in from the sides
export function useConfettiFireworks() {
  const fireConfetti = useCallback((options: ConfettiOptions = {}) => {
    const duration = options.duration ?? 4 * 1000
    const intervalMs = options.intervalMs ?? 250
    const animationEnd = Date.now() + duration
    const defaults: ConfettiOptions = {
      startVelocity: 30,
      spread: 360,
      ticks: 60,
      zIndex: 100,
      ...options
    }

    const interval = globalThis.window.setInterval(() => {
      const timeLeft = animationEnd - Date.now()

      if (timeLeft <= 0) {
        return globalThis.clearInterval(interval)
      }

      const particleCount = 50 * (timeLeft / duration)
      void confetti({
        particleCount,
        origin: { x: randomInRange(0.1, 0.3), y: Math.random() - 0.2 },
        ...defaults
      })

      void confetti({
        particleCount,
        origin: { x: randomInRange(0.7, 0.9), y: Math.random() - 0.2 },
        ...defaults
      })
    }, intervalMs)

    return () => {
      globalThis.clearInterval(interval)
    }
  }, [])

  return {
    fireConfetti
  }
}


================================================
FILE: apps/web/src/components/dark-mode-toggle.tsx
================================================
'use client'

import { Moon, Sun } from 'lucide-react'
import { useTheme } from 'next-themes'
import * as React from 'react'

import { Button } from '@/components/ui/button'
import {
  Tooltip,
  TooltipContent,
  TooltipTrigger
} from '@/components/ui/tooltip'
import { cn } from '@/lib/utils'

export function DarkModeToggle({ className }: { className?: string }) {
  const { setTheme, resolvedTheme } = useTheme()

  return (
    <Tooltip>
      <TooltipTrigger asChild>
        <Button
          variant='outline'
          size='icon'
          className={cn('cursor-pointer', className)}
          onClick={() => setTheme(resolvedTheme === 'dark' ? 'light' : 'dark')}
        >
          <Sun className='h-[1.2rem] w-[1.2rem] rotate-0 scale-100 transition-all dark:-rotate-90 dark:scale-0' />
          <Moon className='absolute h-[1.2rem] w-[1.2rem] rotate-90 scale-0 transition-all dark:rotate-0 dark:scale-100' />
          <span className='sr-only'>Toggle theme</span>
        </Button>
      </TooltipTrigger>

      <TooltipContent>
        <span>Toggle dark mode</span>
      </TooltipContent>
    </Tooltip>
  )
}


================================================
FILE: apps/web/src/components/demand-side-cta.tsx
================================================
import Link from 'next/link'

import { HeroButton } from '@/components/hero-button'
import { Button } from '@/components/ui/button'

export function DemandSideCTA() {
  return (
    <div className='flex justify-center items-center gap-4 sm:gap-8'>
      <HeroButton asChild className='h-full'>
        <Link href='/marketplace' className='font-mono'>
          gotoTools();
        </Link>
      </HeroButton>

      <Button variant='outline' asChild className='h-full py-[9px]'>
        <Link href='https://docs.agentic.so' className='font-mono'>
          readTheDocs();
        </Link>
      </Button>
    </div>
  )
}


================================================
FILE: apps/web/src/components/dots-section.tsx
================================================
import { cn } from '@/lib/utils'

export function DotsSection({
  children,
  className
}: {
  children: React.ReactNode
  className?: string
}) {
  return (
    <section className={cn('relative', className)}>
      <div className='absolute pointer-events-none top-[-50%] bottom-[-50%] left-[-50%] right-[-50%] bg-[url(/dots-light.png)] dark:bg-[url(/dots-dark.png)] bg-size-[1024px,256px] bg-no-repeat bg-center -z-10' />

      {children}
    </section>
  )
}


================================================
FILE: apps/web/src/components/example-agentic-configs.tsx
================================================
'use client'

import type { BundledLanguage } from 'shiki/bundle/web'
import { useLocalStorage } from 'react-use'

import { CodeBlock } from '@/components/code-block'
import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'

import { LoadingIndicator } from './loading-indicator'

const formatLabels = {
  typescript: 'TypeScript',
  json: 'JSON'
} as const
const formats = Object.keys(formatLabels) as (keyof typeof formatLabels)[]
type Format = (typeof formats)[number]

const originAdaptorLabels = {
  mcp: 'MCP',
  openapi: 'OpenAPI'
} as const
const originAdaptors = Object.keys(
  originAdaptorLabels
) as (keyof typeof originAdaptorLabels)[]
type OriginAdaptor = (typeof originAdaptors)[number]

type ExampleAgenticConfig = {
  format: Format
  originAdaptor: OriginAdaptor
}

const defaultExampleAgenticConfig: ExampleAgenticConfig = {
  format: 'typescript',
  originAdaptor: 'mcp'
}

type CodeSnippet = {
  code: string
  lang: BundledLanguage
}

export function ExampleAgenticConfigs() {
  const [config, setConfig] = useLocalStorage<ExampleAgenticConfig>(
    'example-agentic-config',
    defaultExampleAgenticConfig
  )

  if (!config) {
    return <LoadingIndicator className='w-full max-w-3xl' />
  }

  return (
    <div className='w-full max-w-3xl flex flex-col items-center border rounded-lg shadow-sm p-2 md:p-4 bg-background'>
      <ExampleAgenticConfigsContent config={config} setConfig={setConfig} />
    </div>
  )
}

function ExampleAgenticConfigsContent({
  config,
  setConfig
}: {
  config: ExampleAgenticConfig
  setConfig: (config: ExampleAgenticConfig) => void
}) {
  const codeSnippet = getCodeSnippetForExampleAgenticConfig(config)

  return (
    <Tabs
      defaultValue={config!.format}
      onValueChange={(value) =>
        setConfig({
          ...defaultExampleAgenticConfig,
          ...config,
          format: value as Format
        })
      }
      className='w-full max-w-3xl'
    >
      <TabsList>
        {formats.map((format) => (
          <TabsTrigger key={format} value={format} className='cursor-pointer'>
            {formatLabels[format]}
          </TabsTrigger>
        ))}
      </TabsList>

      <TabsContent value={config.format} className='w-full'>
        <Tabs
          defaultValue={config.originAdaptor}
          onValueChange={(value) =>
            setConfig({
              ...defaultExampleAgenticConfig,
              ...config,
              originAdaptor: value as OriginAdaptor
            })
          }
          className='w-full'
        >
          <TabsList className='w-full h-auto flex-wrap'>
            {originAdaptors.map((originAdaptor) => (
              <TabsTrigger
                key={originAdaptor}
                value={originAdaptor}
                className='cursor-pointer text-xs!'
              >
                {originAdaptorLabels[originAdaptor]}
              </TabsTrigger>
            ))}
          </TabsList>

          {originAdaptors.map((originAdaptor) => (
            <TabsContent
              key={originAdaptor}
              value={originAdaptor}
              className='w-full flex flex-col gap-2'
            >
              <div className='text-sm text-gray-500'>
                {config.format === 'typescript'
                  ? 'agentic.config.ts'
                  : 'agentic.config.json'}
              </div>

              <CodeBlock code={codeSnippet.code} lang={codeSnippet.lang} />
            </TabsContent>
          ))}
        </Tabs>
      </TabsContent>
    </Tabs>
  )
}

function getCodeSnippetForExampleAgenticConfig(
  config: ExampleAgenticConfig
): CodeSnippet {
  if (config.format === 'typescript') {
    if (config.originAdaptor === 'mcp') {
      return {
        code: `
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'mcp-example',
  origin: {
    type: 'mcp',
    // Your origin MCP server URL supporting the streamable HTTP transport
    url: '<YOUR_REMOTE_MCP_SERVER_URL>'
  }
})`.trim(),
        lang: 'typescript'
      }
    } else {
      return {
        code: `
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'openapi-example',
  origin: {
    type: 'openapi',
    // Your origin OpenAPI server base URL
    url: '<YOUR_OPENAPI_SERVER_BASE_URL>',
    // Your origin OpenAPI spec path or URL
    spec: '<YOUR_OPENAPI_SPEC_PATH_OR_URL>'
  }
})`.trim(),
        lang: 'typescript'
      }
    }
  } else if (config.format === 'json') {
    if (config.originAdaptor === 'mcp') {
      return {
        code: `
{
  "$schema": "https://agentic.so/schema.json",
  "name": "mcp-example",
  "origin": {
    "type": "mcp",
    "url": "<YOUR_REMOTE_MCP_SERVER_URL>"
  }
}`.trim(),
        lang: 'json'
      }
    } else {
      return {
        code: `
{
  "$schema": "https://agentic.so/schema.json",
  "name": "openapi-example",
  "origin": {
    "type": "openapi",
    "url": "<YOUR_OPENAPI_SERVER_BASE_URL>",
    "spec": "<YOUR_OPENAPI_SPEC_PATH_OR_URL>"
  }
}`.trim(),
        lang: 'json'
      }
    }
  }

  return {
    code: '',
    lang: 'json'
  }
}


================================================
FILE: apps/web/src/components/example-usage-section.tsx
================================================
import Link from 'next/link'

import { highlight } from '@/components/code-block/highlight'
import { ExampleUsage } from '@/components/example-usage'
import {
  defaultConfig,
  getCodeForDeveloperConfig
} from '@/lib/developer-config'
import { globalAgenticApiClient } from '@/lib/global-api'

export async function ExampleUsageSection() {
  const projectIdentifier = '@agentic/search'
  const tool = 'search'

  // TODO: use prefetching here
  const initialProject =
    await globalAgenticApiClient.getPublicProjectByIdentifier({
      projectIdentifier,
      populate: ['lastPublishedDeployment']
    })

  // TODO: this should be loaded in `ExampleUsage`
  const initialCodeSnippet = getCodeForDeveloperConfig({
    config: defaultConfig,
    project: initialProject,
    deployment: initialProject.lastPublishedDeployment!,
    identifier: projectIdentifier,
    tool
  })
  const initialCodeBlock = await highlight(initialCodeSnippet)

  return (
    <section className='flex flex-col gap-8 mb-16'>
      <h2 className='text-center text-balance leading-snug md:leading-none text-3xl font-heading'>
        Agentic tools that{' '}
        <span className='font-semibold'>work everywhere</span>
      </h2>

      <ExampleUsage
        projectIdentifier={projectIdentifier}
        project={initialProject}
        tool={tool}
        initialCodeBlock={initialCodeBlock}
      />

      <div className='flex flex-col gap-4 text-sm max-w-2xl text-center'>
        <p>
          This example uses the{' '}
          <Link
            href={`/marketplace/projects/${projectIdentifier}`}
            className='link'
          >
            {projectIdentifier}
          </Link>{' '}
          tool to provide an LLM access to the web.
        </p>

        <p>
          All Agentic tools are exposed as both{' '}
          <span className='font-semibold'>MCP servers</span> as well as simple{' '}
          <span className='font-semibold'>HTTP APIs</span>. MCP is important for
          interop and future-proofing, whereas simple HTTP POST requests make
          tool use easy to debug and simplifies usage with LLM tool calling.
        </p>
      </div>
    </section>
  )
}


================================================
FILE: apps/web/src/components/example-usage.tsx
================================================
'use client'

import type { Project } from '@agentic/platform-types'
import Link from 'next/link'
import { type JSX, useEffect, useMemo, useState } from 'react'
import { useLocalStorage } from 'react-use'

import { useAgentic } from '@/components/agentic-provider'
import { CodeBlock } from '@/components/code-block'
import { Tabs, TabsContent, TabsList, TabsTrigger } from '@/components/ui/tabs'
import {
  type CodeSnippet,
  defaultConfig,
  type DeveloperConfig,
  getCodeForDeveloperConfig,
  type HTTPTarget,
  httpTargetLabels,
  httpTargets,
  type MCPClientTarget,
  mcpClientTargetLabels,
  mcpClientTargets,
  type PyFrameworkTarget,
  pyFrameworkTargetLabels,
  pyFrameworkTargets,
  type Target,
  targetLabels,
  targets,
  type TsFrameworkTarget,
  tsFrameworkTargetLabels,
  tsFrameworkTargets
} from '@/lib/developer-config'
import { useQuery } from '@/lib/query-client'

import { LoadingIndicator } from './loading-indicator'
import { Button } from './ui/button'

export function ExampleUsage({
  projectIdentifier,
  project: initialProject,
  tool,
  apiKey,
  initialCodeBlock
}: {
  projectIdentifier: string
  project?: Project
  tool?: string
  apiKey?: string
  initialCodeBlock?: JSX.Element
}) {
  const ctx = useAgentic()
  const [isMounted, setIsMounted] = useState(false)

  useEffect(() => {
    setIsMounted(true)
  }, [])

  const [rawConfig, setConfig] = useLocalStorage<DeveloperConfig>(
    'developer-config',
    defaultConfig
  )

  const config = useMemo(
    () => (isMounted && rawConfig ? rawConfig : defaultConfig),
    [rawConfig, isMounted]
  )

  // TODO: make this configurable
  // TODO: allow to take the project and/or consumer in as props
  // TODO: need a way of fetching a project and target deployment; same as in `AgenticToolClient.fromIdentifier` (currently only supports latest)

  // Load the public project
  const {
    data: project,
    isLoading,
    isError
  } = useQuery({
    queryKey: ['public-project', projectIdentifier],
    queryFn: () =>
      ctx!.api.getPublicProjectByIdentifier({
        projectIdentifier,
        populate: ['lastPublishedDeployment']
      }),
    enabled: !!ctx,
    initialData: initialProject
  })

  // If the user is authenticated, check if they have an active subscription to
  // this project
  // TODO: use consumer for apiKey
  // const {
  //   data: consumer,
  //   isLoading: isConsumerLoading
  //   // isError: isConsumerError
  // } = useQuery({
  //   queryKey: [
  //     'project',
  //     projectIdentifier,
  //     'user',
  //     ctx?.api.authSession?.user.id
  //   ],
  //   queryFn: () =>
  //     ctx!.api.getConsumerByProjectIdentifier({
  //       projectIdentifier
  //     }),
  //   enabled: !!ctx?.isAuthenticated
  // })

  return (
    <div className='w-full max-w-3xl flex flex-col items-center border rounded-lg shadow-sm p-2 md:p-4 bg-background'>
      <ExampleUsageContent
        projectIdentifier={projectIdentifier}
        tool={tool}
        apiKey={apiKey}
        initialCodeBlock={initialCodeBlock}
        isLoading={isLoading}
        isError={isError}
        project={project}
        config={config}
        setConfig={setConfig}
      />
    </div>
  )
}

function ExampleUsageContent({
  projectIdentifier,
  tool,
  apiKey,
  initialCodeBlock,
  isLoading,
  isError,
  project,
  config,
  setConfig
}: {
  projectIdentifier: string
  tool?: string
  apiKey?: string
  initialCodeBlock?: JSX.Element
  isLoading: boolean
  isError: boolean
  project?: Project
  config?: DeveloperConfig
  setConfig: (config: DeveloperConfig) => void
}) {
  if (isLoading || !config) {
    return <LoadingIndicator />
  }

  // TODO: allow to target a specific deployment
  const deployment = project?.lastPublishedDeployment

  if (isError || !project || !deployment) {
    return (
      <div>
        Error loading project. Please refresh the page or contact{' '}
        <a href='mailto:support@agentic.so'>support@agentic.so</a>.
      </div>
    )
  }

  const codeSnippet = getCodeForDeveloperConfig({
    config,
    project,
    deployment,
    identifier: projectIdentifier,
    tool,
    apiKey
  })

  return (
    <Tabs
      value={config.target}
      onValueChange={(value) =>
        setConfig({
          ...defaultConfig,
          ...config,
          target: value as Target
        })
      }
      className='w-full'
    >
      <TabsList>
        {targets.map((target) => (
          <TabsTrigger
            key={target}
            value={target}
            className='cursor-pointer'
            disabled={target === 'http' && !tool}
          >
            {targetLabels[target]}
          </TabsTrigger>
        ))}
      </TabsList>

      <TabsContent value='mcp' className='w-full'>
        <Tabs
          value={config.mcpClientTarget}
          onValueChange={(value) =>
            setConfig({
              ...defaultConfig,
              ...config,
              mcpClientTarget: value as MCPClientTarget
            })
          }
          className='w-full'
        >
          <TabsList className='h-auto flex-wrap'>
            {mcpClientTargets.map((mcpClientTarget) => (
              <TabsTrigger
                key={mcpClientTarget}
                value={mcpClientTarget}
                className='cursor-pointer text-xs!'
              >
                {mcpClientTargetLabels[mcpClientTarget]}
              </TabsTrigger>
            ))}
          </TabsList>

          {mcpClientTargets.map((mcpClientTarget) => (
            <TabsContent
              key={mcpClientTarget}
              value={mcpClientTarget}
              className='w-full flex flex-col gap-4'
            >
              <CodeSnippetBlock
                codeSnippet={codeSnippet}
                initialCodeBlock={initialCodeBlock}
              />
            </TabsContent>
          ))}
        </Tabs>
      </TabsContent>

      <TabsContent value='typescript' className='w-full'>
        <Tabs
          value={config.tsFrameworkTarget}
          onValueChange={(value) =>
            setConfig({
              ...defaultConfig,
              ...config,
              tsFrameworkTarget: value as TsFrameworkTarget
            })
          }
          className='w-full'
        >
          <TabsList className='w-full h-auto flex-wrap'>
            {tsFrameworkTargets.map((framework) => (
              <TabsTrigger
                key={framework}
                value={framework}
                className='cursor-pointer text-xs!'
              >
                {tsFrameworkTargetLabels[framework]}
              </TabsTrigger>
            ))}
          </TabsList>

          {tsFrameworkTargets.map((framework) => (
            <TabsContent
              key={framework}
              value={framework}
              className='w-full flex flex-col gap-4'
            >
              <CodeSnippetBlock
                codeSnippet={codeSnippet}
                initialCodeBlock={initialCodeBlock}
              />
            </TabsContent>
          ))}
        </Tabs>
      </TabsContent>

      <TabsContent value='python' className='w-full'>
        <Tabs
          value={config.pyFrameworkTarget}
          onValueChange={(value) =>
            setConfig({
              ...defaultConfig,
              ...config,
              pyFrameworkTarget: value as PyFrameworkTarget
            })
          }
          className='w-full'
        >
          <TabsList className='h-auto flex-wrap'>
            {pyFrameworkTargets.map((framework) => (
              <TabsTrigger
                key={framework}
                value={framework}
                className='cursor-pointer text-xs!'
              >
                {pyFrameworkTargetLabels[framework]}
              </TabsTrigger>
            ))}
          </TabsList>

          {pyFrameworkTargets.map((framework) => (
            <TabsContent
              key={framework}
              value={framework}
              className='w-full flex flex-col gap-4'
            >
              <CodeSnippetBlock
                codeSnippet={codeSnippet}
                initialCodeBlock={initialCodeBlock}
              />
            </TabsContent>
          ))}
        </Tabs>
      </TabsContent>

      <TabsContent value='http' className='w-full'>
        <Tabs
          value={config.httpTarget}
          onValueChange={(value) =>
            setConfig({
              ...defaultConfig,
              ...config,
              httpTarget: value as HTTPTarget
            })
          }
          className='w-full'
        >
          <TabsList className='h-auto flex-wrap'>
            {httpTargets.map((httpTarget) => (
              <TabsTrigger
                key={httpTarget}
                value={httpTarget}
                className='cursor-pointer text-xs!'
              >
                {httpTargetLabels[httpTarget]}
              </TabsTrigger>
            ))}
          </TabsList>

          {httpTargets.map((httpTarget) => (
            <TabsContent
              key={httpTarget}
              value={httpTarget}
              className='w-full flex flex-col gap-4'
            >
              <CodeSnippetBlock
                codeSnippet={codeSnippet}
                initialCodeBlock={initialCodeBlock}
              />
            </TabsContent>
          ))}
        </Tabs>
      </TabsContent>
    </Tabs>
  )
}

function CodeSnippetBlock({
  codeSnippet,
  initialCodeBlock
}: {
  codeSnippet: CodeSnippet
  initialCodeBlock?: JSX.Element
}) {
  return (
    <>
      <CodeBlock
        code={codeSnippet.code}
        lang={codeSnippet.lang}
        initial={initialCodeBlock}
      />

      {codeSnippet.action && (
        <Button
          asChild
          className='group flex flex-row gap-1.5 items-center'
          variant='outline'
        >
          <Link
            href={codeSnippet.action.href}
            target='_blank'
            rel='noopener noreferrer'
          >
            {codeSnippet.action.logoImageUrl ? (
              <>
                <img
                  src={codeSnippet.action.logoImageUrl}
                  alt={codeSnippet.action.label}
                  className=''
                />
              </>
            ) : (
              <>
                <img
                  src={codeSnippet.action.logoImageUrlDark}
                  alt={codeSnippet.action.label}
                  className='w-4 h-4 hidden group-dark:block'
                />
                <img
                  src={codeSnippet.action.logoImageUrlLight}
                  alt={codeSnippet.action.label}
                  className='w-4 h-4 block group-dark:hidden'
                />
              </>
            )}

            <span>{codeSnippet.action.label}</span>
          </Link>
        </Button>
      )}
    </>
  )
}


================================================
FILE: apps/web/src/components/feature.tsx
================================================
'use client'

import type { ComponentType, ReactNode } from 'react'
import {
  motion,
  type MotionValue,
  useMotionTemplate,
  useMotionValue
} from 'motion/react'
import Link from 'next/link'

import { GridPattern } from './grid-pattern'

export type FeatureData = {
  name: string
  description: ReactNode
  icon: ComponentType<{ className?: string }>
  pattern: Omit<GridPattern, 'width' | 'height' | 'x'>
  href?: string
}

export function Feature({
  name,
  description,
  icon,
  pattern,
  href
}: FeatureData) {
  const mouseX = useMotionValue(0)
  const mouseY = useMotionValue(0)

  function onMouseMove({
    currentTarget,
    clientX,
    clientY
  }: React.MouseEvent<HTMLElement>) {
    const { left, top } = currentTarget.getBoundingClientRect()
    mouseX.set(clientX - left)
    mouseY.set(clientY - top)
  }

  const content = (
    <>
      <FeaturePattern {...pattern} mouseX={mouseX} mouseY={mouseY} />

      <div className='ring-gray-900/7.5 group-hover:ring-gray-900/10 absolute inset-0 rounded-2xl ring-1 ring-inset dark:ring-white/10 dark:group-hover:ring-white/20' />

      <div className='relative rounded-2xl p-4 flex flex-col gap-6 pt-12 text-start'>
        <FeatureIcon icon={icon} />

        <h3 className='text-gray-900 text-lg font-semibold leading-0 dark:text-white'>
          {/* <span className='absolute inset-0 rounded-2xl' /> */}
          {name}
        </h3>

        <p className='text-gray-600 dark:text-gray-400 text-[0.875rem] leading-[1.5rem]'>
          {description}
        </p>
      </div>
    </>
  )

  const className =
    'dark:bg-white/2.5 bg-gray-50 hover:shadow-gray-900/5 group relative flex rounded-2xl transition-shadow hover:shadow-md dark:hover:shadow-black/5'

  if (href) {
    return (
      <Link
        href={href}
        key={name}
        onMouseMove={onMouseMove}
        className={className}
      >
        {content}
      </Link>
    )
  } else {
    return (
      <div key={name} onMouseMove={onMouseMove} className={className}>
        {content}
      </div>
    )
  }
}

// eslint-disable-next-line @typescript-eslint/naming-convention
function FeatureIcon({ icon: Icon }: { icon: FeatureData['icon'] }) {
  return (
    <div className='dark:bg-white/7.5 bg-gray-900/5 ring-gray-900/25 group-hover:ring-gray-900/25 dark:group-hover:bg-sky-300/10 dark:group-hover:ring-sky-400 flex size-7 items-center justify-center rounded-full ring-1 backdrop-blur-[2px] transition duration-300 group-hover:bg-white/50 dark:ring-white/15'>
      <Icon className='fill-gray-700/10 stroke-gray-700 group-hover:stroke-gray-900 dark:stroke-gray-400 dark:group-hover:stroke-sky-400 dark:group-hover:fill-sky-300/10 size-5 transition-colors duration-300 dark:fill-white/10' />
    </div>
  )
}

function FeaturePattern({
  mouseX,
  mouseY,
  ...gridProps
}: FeatureData['pattern'] & {
  mouseX: MotionValue<number>
  mouseY: MotionValue<number>
}) {
  const maskImage = useMotionTemplate`radial-gradient(180px at ${mouseX}px ${mouseY}px, white, transparent)`
  const style = { maskImage, WebkitMaskImage: maskImage }

  return (
    <div className='pointer-events-none'>
      <div className='absolute inset-0 rounded-2xl transition duration-300 [mask-image:linear-gradient(white,transparent)] group-hover:opacity-50'>
        <GridPattern
          width={72}
          height={56}
          x='50%'
          className='dark:fill-white/1 dark:stroke-white/2.5 absolute inset-x-0 inset-y-[-30%] h-[160%] w-full skew-y-[-18deg] fill-black/[0.02] stroke-black/5'
          {...gridProps}
        />
      </div>

      <motion.div
        className='from-sky-100 to-sky-300 dark:from-sky-500 dark:to-sky-300 absolute inset-0 rounded-2xl bg-gradient-to-r opacity-0 transition duration-300 group-hover:opacity-50 dark:group-hover:opacity-15'
        style={style}
      />

      <motion.div
        className='absolute inset-0 rounded-2xl opacity-0 mix-blend-overlay transition duration-300 group-hover:opacity-100'
        style={style}
      >
        <GridPattern
          width={72}
          height={56}
          x='50%'
          className='dark:fill-white/2.5 absolute inset-x-0 inset-y-[-30%] h-[160%] w-full skew-y-[-18deg] fill-black/50 stroke-black/70 dark:stroke-white/10'
          {...gridProps}
        />
      </motion.div>
    </div>
  )
}


================================================
FILE: apps/web/src/components/footer/dynamic.tsx
================================================
'use client'

import { ActiveLink } from '@/components/active-link'
import { useAgentic } from '@/components/agentic-provider'

export function DynamicFooter() {
  const ctx = useAgentic()

  return (
    <>
      {ctx?.isAuthenticated ? (
        <>
          <div>
            <ActiveLink href='/app' className='link'>
              Dashboard
            </ActiveLink>
          </div>

          <div>
            <ActiveLink href='/logout' className='link'>
              Logout
            </ActiveLink>
          </div>
        </>
      ) : (
        <>
          <div>
            <ActiveLink href='/login' className='link whitespace-nowrap'>
              Log in
            </ActiveLink>
          </div>

          <div>
            <ActiveLink href='/signup' className='link whitespace-nowrap'>
              Sign up
            </ActiveLink>
          </div>
        </>
      )}
    </>
  )
}


================================================
FILE: apps/web/src/components/footer/index.tsx
================================================
import Link from 'next/link'

import { ActiveLink } from '@/components/active-link'
import { GitHubIcon } from '@/icons/github'
import { TwitterIcon } from '@/icons/twitter'
import { copyright, githubUrl, twitterUrl } from '@/lib/config'

import { DynamicFooter } from './dynamic'

export function Footer() {
  return (
    <footer className='w-full pt-12 pb-4 border-t flex flex-col items-center'>
      <div className='container px-4 sm:px-6 max-w-1200px'>
        <div className='flex flex-col sm:grid sm:grid-cols-2 md:grid-cols-4 gap-8'>
          <div className='flex flex-col sm:items-center'>
            <div className='space-y-4'>
              <h3 className='text-lg font-semibold'>Platform</h3>

              <nav className='flex flex-col space-y-2'>
                <div>
                  <ActiveLink href='/' className='link'>
                    Home
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/marketplace' className='link'>
                    MCP Marketplace
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/publishing' className='link'>
                    MCP Publishing
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/pricing' className='link'>
                    Pricing
                  </ActiveLink>
                </div>

                <DynamicFooter />
              </nav>
            </div>
          </div>

          <div className='flex flex-col sm:items-center'>
            <div className='space-y-4'>
              <h3 className='text-lg font-semibold'>Resources</h3>

              <nav className='flex flex-col space-y-2'>
                <div>
                  <Link href='https://docs.agentic.so' className='link'>
                    Docs
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/publishing'
                    className='link'
                  >
                    Publishing Docs
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/publishing/guides/existing-openapi-service'
                    className='link'
                  >
                    OpenAPI to MCP
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/publishing'
                    className='link'
                  >
                    Agentic MCP Gateway
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/openai-chat'
                    className='link'
                  >
                    Agentic + OpenAI
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/ai-sdk'
                    className='link'
                  >
                    Agentic + Vercel AI SDK
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/langchain'
                    className='link'
                  >
                    Agentic + LangChain
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/llamaindex'
                    className='link'
                  >
                    Agentic + LlamaIndex
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/genkit'
                    className='link'
                  >
                    Agentic + Firebase GenKit
                  </Link>
                </div>

                <div>
                  <Link
                    href='https://docs.agentic.so/marketplace/ts-sdks/mastra'
                    className='link'
                  >
                    Agentic + Mastra
                  </Link>
                </div>
              </nav>
            </div>
          </div>

          <div className='flex flex-col sm:items-center'>
            <div className='space-y-4'>
              <h3 className='text-lg font-semibold'>Company</h3>

              <nav className='flex flex-col space-y-2'>
                <div>
                  <ActiveLink href='/about' className='link'>
                    About
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/contact' className='link'>
                    Contact
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/privacy' className='link'>
                    Privacy Policy
                  </ActiveLink>
                </div>

                <div>
                  <ActiveLink href='/terms' className='link'>
                    Terms of Service
                  </ActiveLink>
                </div>
              </nav>
            </div>
          </div>

          <div className='flex flex-col sm:items-center gap-4'>
            <div className='space-y-4'>
              <h3 className='text-lg font-semibold'>Social</h3>

              <nav className='flex flex-col gap-4'>
                <Link
                  href={twitterUrl}
                  className='flex items-center space-x-2'
                  target='_blank'
                  rel='noopener noreferrer'
                >
                  <TwitterIcon className='h-4 w-4' />

                  <span>Twitter</span>
                </Link>

                <Link
                  href={githubUrl}
                  className='flex items-center space-x-2'
                  target='_blank'
                  rel='noopener noreferrer'
                >
                  <GitHubIcon className='h-4 w-4' />

                  <span>GitHub</span>
                </Link>
              </nav>
            </div>
          </div>
        </div>

        <div className='mt-8 pt-8 border-t border-border text-center text-sm text-muted-foreground'>
          <span>{copyright}</span>
        </div>
      </div>
    </footer>
  )
}


================================================
FILE: apps/web/src/components/github-star-counter.tsx
================================================
'use client'

import NumberFlow from '@number-flow/react'
import Link from 'next/link'
import { type ReactNode, useEffect, useState } from 'react'

import { GitHubIcon } from '@/icons/github'
import { githubUrl } from '@/lib/config'
import { cn } from '@/lib/utils'

import { Button } from './ui/button'

// TODO: fetch this dynamically
const numGitHubStars = 17_600

export function GitHubStarCounter({
  className,
  children
}: {
  className?: string
  children?: ReactNode
}) {
  const [numStars, setNumStars] = useState(0)

  useEffect(() => {
    setNumStars(numGitHubStars)
  }, [])

  return (
    <Button
      variant='outline'
      className={cn('flex items-center gap-2', className)}
      asChild
    >
      <Link href={githubUrl} target='_blank' rel='noopener'>
        <GitHubIcon />

        <NumberFlow
          value={numStars}
          format={{
            notation: 'compact',
            roundingPriority: 'morePrecision'
          }}
          suffix={children ? undefined : ' stars'}
          willChange
        />

        {children}
      </Link>
    </Button>
  )
}


================================================
FILE: apps/web/src/components/grid-pattern.tsx
================================================
import { type SVGProps, useId } from 'react'

export type GridPattern = Omit<
  SVGProps<SVGSVGElement>,
  'width' | 'height' | 'x' | 'y'
> & {
  width: number
  height: number
  x: string | number
  y: string | number
  squares: Array<[x: number, y: number]>
}

export function GridPattern({
  width,
  height,
  x,
  y,
  squares,
  ...props
}: GridPattern) {
  const patternId = useId()

  return (
    <svg aria-hidden='true' {...props}>
      <defs>
        <pattern
          id={patternId}
          width={width}
          height={height}
          patternUnits='userSpaceOnUse'
          x={x}
          y={y}
        >
          <path d={`M.5 ${height}V.5H${width}`} fill='none' />
        </pattern>
      </defs>

      <rect
        width='100%'
        height='100%'
        strokeWidth={0}
        fill={`url(#${patternId})`}
      />

      {squares && (
        <svg x={x} y={y} className='overflow-visible'>
          <title>square</title>

          {squares.map(([x, y]) => (
            <rect
              strokeWidth='0'
              key={`${x}-${y}`}
              width={width + 1}
              height={height + 1}
              x={x * width}
              y={y * height}
            />
          ))}
        </svg>
      )}
    </svg>
  )
}


================================================
FILE: apps/web/src/components/header/authenticated-header.tsx
================================================
'use client'

import { useState } from 'react'

import { ActiveLink } from '@/components/active-link'
import { useAgentic } from '@/components/agentic-provider'
import { Avatar, AvatarFallback, AvatarImage } from '@/components/ui/avatar'
import {
  DropdownMenu,
  DropdownMenuContent,
  DropdownMenuItem,
  DropdownMenuSeparator,
  DropdownMenuTrigger
} from '@/components/ui/dropdown-menu'

export function AuthenticatedHeader() {
  const ctx = useAgentic()
  const [isDropdownMenuOpen, setIsDropdownMenuOpen] = useState(false)

  if (!ctx?.isAuthenticated) {
    return null
  }

  return (
    <DropdownMenu
      open={isDropdownMenuOpen}
      onOpenChange={setIsDropdownMenuOpen}
    >
      <DropdownMenuTrigger asChild>
        <Avatar className='cursor-pointer'>
          <AvatarImage src={ctx.api.authSession!.user.image} />
          <AvatarFallback>
            {ctx.api.authSession!.user.username?.slice(0, 2).toUpperCase()}
          </AvatarFallback>
        </Avatar>
      </DropdownMenuTrigger>

      <DropdownMenuContent>
        <DropdownMenuItem asChild>
          <ActiveLink href='/app' onClick={() => setIsDropdownMenuOpen(false)}>
            Dashboard
          </ActiveLink>
        </DropdownMenuItem>

        <DropdownMenuItem asChild>
          <ActiveLink
            href='/app/projects'
            onClick={() => setIsDropdownMenuOpen(false)}
          >
            My Projects
          </ActiveLink>
        </DropdownMenuItem>

        <DropdownMenuItem asChild>
          <ActiveLink
            href='/app/consumers'
            onClick={() => setIsDropdownMenuOpen(false)}
          >
            My Subscriptions
          </ActiveLink>
        </DropdownMenuItem>

        <DropdownMenuSeparator />

        <DropdownMenuItem asChild>
          <ActiveLink
            href='/logout'
            onClick={() => setIsDropdownMenuOpen(false)}
          >
            Logout
          </ActiveLink>
        </DropdownMenuItem>
      </DropdownMenuContent>
    </DropdownMenu>
  )
}


================================================
FILE: apps/web/src/components/header/index.tsx
================================================
import Link from 'next/link'

import { ActiveLink } from '@/components/active-link'
import { DarkModeToggle } from '@/components/dark-mode-toggle'
import { Button } from '@/components/ui/button'
import { GitHubIcon } from '@/icons/github'
import { githubUrl } from '@/lib/config'
import { cn } from '@/lib/utils'

import { AuthenticatedHeader } from './authenticated-header'
import styles from './styles.module.css'
import { UnauthenticatedHeader } from './unauthenticated-header'

export function Header() {
  return (
    <header className={cn(styles.header, 'shadow-sm')}>
      <div className={styles.headerContent}>
        <ActiveLink className='select-none' href='/'>
          <img
            src='/agentic-logo-light.svg'
            alt='AGENTIC'
            className='w-[144px] dark:hidden'
          />
          <img
            src='/agentic-logo-dark.svg'
            alt='AGENTIC'
            className='w-[144px] hidden dark:block'
          />
        </ActiveLink>

        <div className='flex justify-end items-center h-full gap-4'>
          <ActiveLink
            href='/marketplace'
            className='link hidden sm:block whitespace-nowrap'
          >
            MCP Marketplace
          </ActiveLink>

          <ActiveLink href='/publishing' className='link whitespace-nowrap'>
            MCP Publishing
          </ActiveLink>

          <ActiveLink
            href='https://docs.agentic.so'
            className='link whitespace-nowrap'
          >
            Docs
          </ActiveLink>

          <div className='flex items-center h-full gap-2'>
            <UnauthenticatedHeader />

            <DarkModeToggle />

            <Button variant='outline' size='icon' asChild>
              <Link href={githubUrl} target='_blank' rel='noopener noreferrer'>
                <GitHubIcon className='w-4 h-4' />
              </Link>
            </Button>

            <AuthenticatedHeader />
          </div>
        </div>
      </div>
    </header>
  )
}


================================================
FILE: apps/web/src/components/header/styles.module.css
================================================
.header {
  position: sticky;
  top: 0;
  left: 0;
  z-index: 49;

  width: 100%;
  max-width: 100vw;
  overflow: hidden;
  height: 55px;
  min-height: 55px;

  background: hsla(0, 0%, 100%, 0.8);
  backdrop-filter: saturate(180%) blur(16px);

  display: flex;
  flex-direction: column;
  align-items: center;
  padding: 12px 12px 0;
  line-height: 1;
}

:global(.dark) .header {
  background: transparent;
  box-shadow: inset 0 -1px 0 0 rgba(0, 0, 0, 0.1);
  backdrop-filter: saturate(180%) blur(20px);
}

.headerContent {
  align-self: center;
  width: 100%;
  max-width: 1200px;
  display: flex;
  flex-direction: row;
  justify-content: space-between;
  align-items: center;
  gap: 1em;
  min-height: 32px;
}

.navHeader {
  display: flex;
  flex-direction: row;
  justify-content: space-between;
  align-items: center;
  gap: var(--gap-w-1);

  max-width: var(--max-width);
  height: 100%;
  margin: 0 auto;
}


================================================
FILE: apps/web/src/components/header/unauthenticated-header.tsx
================================================
'use client'

import { ActiveLink } from '@/components/active-link'
import { useAgentic } from '@/components/agentic-provider'
import { Button } from '@/components/ui/button'

export function UnauthenticatedHeader() {
  const ctx = useAgentic()

  if (ctx?.isAuthenticated) {
    return null
  }

  return (
    <>
      <Button asChild variant='outline'>
        <ActiveLink href='/login' className='whitespace-nowrap px-4! py-2!'>
          Log in
        </ActiveLink>
      </Button>

      <Button asChild variant='default'>
        <ActiveLink href='/signup' className='whitespace-nowrap px-4! py-2!'>
          Sign up
        </ActiveLink>
      </Button>
    </>
  )
}


================================================
FILE: apps/web/src/components/hero-button/index.tsx
================================================
import type * as React from 'react'
import type { Simplify } from 'type-fest'

import { Button, type ButtonProps } from '@/components/ui/button'
import { cn } from '@/lib/utils'

import styles from './styles.module.css'

export type HeroButtonVariant = 'orange' | 'blue' | 'purple'

export type HeroButtonProps = Simplify<
  {
    heroVariant?: HeroButtonVariant
    className?: string
    buttonClassName?: string
  } & ButtonProps
>

export function HeroButton({
  heroVariant = 'purple',
  className,
  buttonClassName,
  ...buttonProps
}: HeroButtonProps) {
  return (
    <div className={cn(styles.heroButtonWrapper, className)}>
      {heroVariant === 'blue' && (
        <span className={cn(styles.heroButtonBg, styles.heroButtonBg1)} />
      )}

      {heroVariant === 'purple' && (
        <span className={cn(styles.heroButtonBg, styles.heroButtonBg2)} />
      )}

      {heroVariant === 'orange' && (
        <span className={cn(styles.heroButtonBg, styles.heroButtonBg3)} />
      )}

      <Button
        className={cn(styles.heroButton, buttonClassName)}
        type='button'
        {...(buttonProps as any)}
      />
    </div>
  )
}


================================================
FILE: apps/web/src/components/hero-button/styles.module.css
================================================
.heroButtonWrapper {
  position: relative;
  max-width: 100%;
  z-index: 99;
}

.heroButtonBg1 {
  --start-color: #00dfd8;
  --end-color: #007cf0;
  /* animation: heroBgAnimation1 8s infinite; */
}

.heroButtonBg2 {
  --start-color: #ff0080;
  --end-color: #7928ca;
  /* animation: heroBgAnimation2 8s infinite; */
}

.heroButtonBg3 {
  --start-color: #ff4d4d;
  --end-color: #f9cb28;
  /* animation: heroBgAnimation3 8s infinite; */
}

.heroButtonBg {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
  background-image: linear-gradient(
    165deg,
    var(--start-color),
    var(--end-color)
  );
  border-radius: 5px;
  z-index: -2;
}

.heroButtonBg::before {
  position: absolute;
  content: '';
  top: 0;
  left: 0;
  right: 0;
  bottom: 0;
  z-index: -1;
  border: 12px solid transparent;
  filter: blur(24px);
  /* animation: pulse 2s ease-in-out infinite alternate; */
  background-image: linear-gradient(
    165deg,
    var(--start-color),
    var(--end-color)
  );
}

.heroButton {
  cursor: pointer;

  background-color: var(--background);
  background-clip: padding-box;
  border: 1px solid transparent;
  box-shadow: 0 4px 4px 0 #00000010;
  color: var(--foreground);
  transition-property: color, background-color, box-shadow;
  transition-duration: 0.15s;
  transition-timing-function: ease;
  padding: 20px 24px;
  border-radius: 5px;
  max-width: 100%;
  display: flex;
  justify-content: center;
  align-items: center;
  user-select: none;
  outline: none;
  white-space: nowrap;

  --lighten-color: hsla(0, 0%, 100%, 0.8);
  background-image: linear-gradient(
    to right,
    var(--lighten-color),
    var(--lighten-color)
  );
}

:global(.dark) .heroButton {
  --lighten-color: rgba(0, 0, 0, 0.75);
}

.heroButton:hover {
  --lighten-color: transparent;
  background-color: transparent;
  color: var(--background);
}

.heroButton:focus:not(:active):not(:hover) {
  border-color: var(--foreground);
}

.heroButton:active {
  --lighten-color: hsla(0, 0%, 100%, 0.5);
}

.heroButtonWrapper:has(.heroButton:disabled) {
  opacity: 0.3;
  cursor: not-allowed;
}

.heroButtonWrapper:has(.heroButton:disabled) * {
  pointer-events: none;
}

/* @keyframes heroBgAnimation1 {
  0%,
  16.667%,
  to {
    opacity: 1;
  }
  33%,
  83.333% {
    opacity: 0;
  }
}

@keyframes heroBgAnimation2 {
  0%,
  16.667%,
  66.667%,
  to {
    opacity: 0;
  }
  33.333%,
  50% {
    opacity: 1;
  }
}

@keyframes heroBgAnimation3 {
  0%,
  50%,
  to {
    opacity: 0;
  }
  66.667%,
  83.333% {
    opacity: 1;
  }
} */

/* @keyframes pulse {
  from {
    filter: blur(8px);
  }

  to {
    filter: blur(32px);
  }
} */


================================================
FILE: apps/web/src/components/hero-simulation-2.tsx
================================================
'use client'

import { Physics, useSphere } from '@react-three/cannon'
import { Environment, useTexture } from '@react-three/drei'
import { Canvas, useFrame, useThree } from '@react-three/fiber'
import {
  Bloom,
  EffectComposer,
  // N8AO,
  SMAA,
  SSAO
} from '@react-three/postprocessing'
import { useEffect, useState } from 'react'
import * as THREE from 'three'

const rfs = THREE.MathUtils.randFloatSpread
const sphereGeometry = new THREE.SphereGeometry(1, 32, 32)
const baubleMaterial = new THREE.MeshStandardMaterial({
  color: 'white',
  roughness: 0,
  envMapIntensity: 1
})

export function HeroSimulation2({ className }: { className?: string }) {
  const [hovered, setHovered] = useState(false)

  // Change cursor on hovered state
  useEffect(() => {
    if (hovered) {
      document.body.style.cursor = 'none'
    } else {
      document.body.style.cursor = 'auto'
    }
    // document.body.style.cursor = hovered
    //   ? 'none'
    //   : `url('data:image/svg+xml;base64,${btoa(
    //       '<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><circle cx="16" cy="16" r="10" fill="#E8B059"/></svg>'
    //     )}'), auto`
  }, [hovered])

  return (
    <Canvas
      shadows
      gl={{ antialias: false }}
      dpr={[1, 1.5]}
      camera={{ position: [0, 0, 20], fov: 35, near: 1, far: 40 }}
      className={className}
      onPointerOver={() => setHovered(true)}
      onPointerOut={() => setHovered(false)}
    >
      <ambientLight intensity={0.5} />

      <color attach='background' args={['#dfdfdf']} />

      <spotLight
        intensity={1}
        angle={0.2}
        penumbra={1}
        position={[30, 30, 30]}
        castShadow
        shadow-mapSize={[512, 512]}
      />

      <Physics gravity={[0, 2, 0]} iterations={10}>
        <Pointer />
        <Clump />
      </Physics>

      <Environment files='/adamsbridge.hdr' />

      <EffectComposer enableNormalPass={true} multisampling={0}>
        <SSAO />
        {/* <N8AO
          halfRes
          color='black'
          aoRadius={2}
          intensity={1}
          aoSamples={6}
          denoiseSamples={4}
        /> */}

        <Bloom mipmapBlur levels={7} intensity={0.3} />

        <SMAA />
      </EffectComposer>
    </Canvas>
  )
}

function Clump({
  mat = new THREE.Matrix4(),
  vec = new THREE.Vector3(),
  numBalls = 64
}) {
  const texture = useTexture('/mcp.png')
  const [ref, api] = useSphere(() => ({
    args: [1],
    mass: 1,
    angularDamping: 0.1,
    linearDamping: 0.65,
    position: [rfs(20), rfs(20), rfs(20)]
  }))

  useFrame((_state, _delta) => {
    for (let i = 0; i < numBalls; i++) {
      // Get current whereabouts of the instanced sphere
      ;(ref.current as any).getMatrixAt(i, mat)
      // ref.current.children[i]!.getM(i, mat)

      // Normalize the position and multiply by a negative force.
      // This is enough to drive it towards the center-point.
      api
        .at(i)
        ?.applyForce(
          vec
            .setFromMatrixPosition(mat)
            .normalize()
            .multiplyScalar(-40)
            .toArray(),
          [0, 0, 0]
        )
    }
  })

  return (
    <instancedMesh
      ref={ref}
      castShadow
      receiveShadow
      args={[sphereGeometry, baubleMaterial, numBalls]}
      material-map={texture}
    />
  )
}

function Pointer() {
  const viewport = useThree((state) => state.viewport)
  const [ref, api] = useSphere(() => ({
    type: 'Kinematic',
    args: [3],
    position: [0, 0, 0]
  }))

  useFrame((state) =>
    api.position.set(
      (state.pointer.x * viewport.width) / 2,
      (state.pointer.y * viewport.height) / 2,
      0
    )
  )

  return (
    <mesh ref={ref} scale={0.2}>
      <sphereGeometry />
      <meshBasicMaterial color={[4, 4, 4]} toneMapped={false} />
      <pointLight intensity={8} distance={10} />
    </mesh>
  )
}


================================================
FILE: apps/web/src/components/hero-simulation.tsx
================================================
'use client'

import {
  MarchingCube,
  MarchingCubes,
  MeshTransmissionMaterial,
  RenderTexture,
  Text
} from '@react-three/drei'
import { Canvas, useFrame } from '@react-three/fiber'
import { BallCollider, Physics, RigidBody } from '@react-three/rapier'
import { useRef } from 'react'
import { suspend } from 'suspend-react'
import * as THREE from 'three'

const inter = import('@pmndrs/assets/fonts/inter_regular.woff')

// https://codesandbox.io/p/sandbox/metaballs-forked-g7xjjq?file=%2Fsrc%2FApp.js

function MetaBall({
  float = false,
  strength = 0.5,
  color,
  vec = new THREE.Vector3(),
  ...props
}: {
  float?: boolean
  strength?: number
  color?: string
  vec?: THREE.Vector3
} & Parameters<typeof RigidBody>[0]) {
  const api = useRef<any>(null)

  useFrame((_state, delta) => {
    if (float) {
      delta = Math.min(delta, 0.1)
      api.current?.applyImpulse(
        vec
          //.set(-state.pointer.x, -state.pointer.y, 0)
          .copy(api.current.translation())
          .normalize()
          .multiplyScalar(delta * -0.2)
      )
    }
  })

  return (
    <RigidBody
      ref={api}
      colliders={false}
      restitution={0.6}
      linearDamping={4}
      angularDamping={4}
      {...props}
    >
      <MarchingCube
        strength={strength}
        subtract={6}
        color={new THREE.Color(color)}
      />

      <BallCollider args={[0.1]} />
    </RigidBody>
  )
}

function Pointer({ vec = new THREE.Vector3() }) {
  const ref = useRef<any>(null)

  useFrame(({ pointer, viewport }) => {
    const { width, height } = viewport.getCurrentViewport()
    vec.set((pointer.x * width) / 2, (pointer.y * height) / 2, 0)
    ref.current?.setNextKinematicTranslation(vec)
  })

  return (
    <RigidBody type='kinematicPosition' colliders={false} ref={ref}>
      <BallCollider args={[0.3]} />
    </RigidBody>
  )
}

export function HeroSimulation({ className }: { className?: string }) {
  return (
    <Canvas
      dpr={[1, 1.5]}
      orthographic
      camera={{ position: [0, 0, 5], zoom: 300 }}
      className={className}
    >
      <color attach='background' args={['blue']} />

      <ambientLight intensity={1} />

      <Physics gravity={[0, -5, 0]}>
        <MarchingCubes
          resolution={40}
          maxPolyCount={10_000}
          enableUvs={false}
          enableColors
        >
          <MeshTransmissionMaterial
            thickness={0.4}
            anisotropicBlur={0.1}
            chromaticAberration={0.1}
            vertexColors
            roughness={0}
          >
            <RenderTexture attach='buffer'>
              <color attach='background' args={[new THREE.Color(2, 2, 2)]} />

              <Text
                scale={0.25}
                fontSize={1}
                position={[0, 0, -5]}
                letterSpacing={-0.025}
                outlineWidth={0.03}
                font={(suspend(inter) as any).default}
                color='black'
              >
                MCP
              </Text>
            </RenderTexture>
          </MeshTransmissionMaterial>

          {Array.from({ length: 10 }, (_, index) => (
            <MetaBall
              float
              strength={1}
              key={'1' + index}
              color='white'
              position={[Math.random() * 0.5, Math.random() * 0.5, 0]}
            />
          ))}

          <Pointer />
        </MarchingCubes>
      </Physics>

      {/* <Environment
        files="https://dl.polyhaven.org/file/ph-assets/HDRIs/hdr/1k/industrial_workshop_foundry_1k.hdr"
        environmentIntensity={0.5}
      /> */}
    </Canvas>
  )
}


================================================
FILE: apps/web/src/components/loading-indicator/index.tsx
================================================
'use client'

// import { AnimatePresence, motion } from 'motion/react'
import dynamic from 'next/dynamic'
import { useTheme } from 'next-themes'

import { cn } from '@/lib/utils'

import loadingDark from './loading-dark.json'
import loadingLight from './loading-light.json'
import styles from './styles.module.css'

const Lottie = dynamic(() => import('react-lottie-player'), {
  ssr: false
})

export function LoadingIndicator({ className }: { className?: string }) {
  const { resolvedTheme } = useTheme()

  return (
    <Lottie
      play
      loop
      animationData={resolvedTheme === 'dark' ? loadingDark : loadingLight}
      className={cn(styles.loadingAnimation, className)}
    />

    // <AnimatePresence>
    //   {isLoading ? (
    //     <motion.div
    //       className={cn(styles.loading, fill && styles.fill, className)}
    //       transition={{ duration: 10 }}
    //       exit={{ opacity: 0, ...exit }}
    //       {...rest}
    //     >
    //       <Lottie
    //         play
    //         loop
    //         animationData={
    //           resolvedTheme === 'dark' ? loadingDark : loadingLight
    //         }
    //         className={styles.loadingAnimation}
    //       />
    //     </motion.div>
    //   ) : null}
    // </AnimatePresence>
  )
}


================================================
FILE: apps/web/src/components/loading-indicator/loading-dark.json
================================================
{
  "assets": [
    {
      "id": "comp_1",
      "layers": [
        {
          "ddd": 0,
          "ind": 0,
          "ty": 4,
          "nm": "Shape Layer 3",
          "ks": {
            "o": {
              "k": [
                {
                  "i": { "x": [0.833], "y": [0.833] },
                  "o": { "x": [0.167], "y": [0.167] },
                  "n": ["0p833_0p833_0p167_0p167"],
                  "t": 10.4,
                  "s": [100],
                  "e": [0]
                },
                { "t": 25.6 }
              ]
            },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "hasMask": true,
          "masksProperties": [
            {
              "inv": true,
              "mode": "a",
              "pt": {
                "k": [
                  {
                    "i": { "x": 0.833, "y": 0.833 },
                    "o": { "x": 0.167, "y": 0.167 },
                    "n": "0p833_0p833_0p167_0p167",
                    "t": 12,
                    "s": [
                      {
                        "i": [
                          [134.688, 0],
                          [0, -134.688],
                          [-134.688, 0],
                          [0, 134.688]
                        ],
                        "o": [
                          [-134.688, 0],
                          [0, 134.688],
                          [134.688, 0],
                          [0, -134.688]
                        ],
                        "v": [
                          [0, -244.875],
                          [-243.875, -1],
                          [0, 242.875],
                          [243.875, -1]
                        ],
                        "c": true
                      }
                    ],
                    "e": [
                      {
                        "i": [
                          [176.731, 0],
                          [0, -176.731],
                          [-176.731, 0],
                          [0, 176.731]
                        ],
                        "o": [
                          [-176.731, 0],
                          [0, 176.731],
                          [176.731, 0],
                          [0, -176.731]
                        ],
                        "v": [
                          [0, -321],
                          [-320, -1],
                          [0, 319],
                          [320, -1]
                        ],
                        "c": true
                      }
                    ]
                  },
                  { "t": 22.4 }
                ]
              },
              "o": { "k": 100 },
              "x": { "k": 0 },
              "nm": "Mask 1"
            }
          ],
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 8.8,
                        "s": [30],
                        "e": [0]
                      },
                      { "t": 22.4 }
                    ],
                    "ix": 1
                  },
                  "e": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 8.8,
                        "s": [30],
                        "e": [60]
                      },
                      { "t": 22.4 }
                    ],
                    "ix": 2
                  },
                  "o": { "k": -110, "ix": 3 },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 1,
          "ty": 4,
          "nm": "Shape Layer 2",
          "ks": {
            "o": { "k": 100 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 26, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 0,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 40,
                        "s": [360],
                        "e": [720]
                      },
                      { "t": 80 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 2,
          "ty": 4,
          "nm": "Shape Layer 1",
          "ks": {
            "o": { "k": 100 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [102, 102, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "v": [
                        [41.593, 144.622],
                        [169.506, 119.927],
                        [189.109, 279.448],
                        [324.733, 198.952],
                        [451.572, 261.435],
                        [464.308, 109.882],
                        [591.263, 63.386],
                        [489.394, -41.116],
                        [545.422, -183.975],
                        [401.99, -165.308],
                        [315.929, -299.146],
                        [228.713, -166.646],
                        [75.238, -178.354],
                        [75.296, -7.911],
                        [-76.402, 13.881],
                        [-74.277, 186.236],
                        [-211.124, 169.355],
                        [-300.932, 303.028],
                        [-390.031, 173.297],
                        [-533.818, 195.069],
                        [-486.799, 51.51],
                        [-603.444, -31.631],
                        [-472.297, -92.031],
                        [-477.325, -249.524],
                        [-333.828, -192.011],
                        [-212.105, -287.275],
                        [-181.109, -134.238],
                        [-48.486, -147.583]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 22, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 0,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 40,
                        "s": [360],
                        "e": [720]
                      },
                      { "t": 80 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 10 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 3,
          "ty": 4,
          "nm": "Shape Layer 5",
          "ks": {
            "o": { "k": 18 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 26, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": -33.6,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 6.4,
                        "s": [360],
                        "e": [720]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 46.4,
                        "s": [720],
                        "e": [1080]
                      },
                      { "t": 86.4 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": -33.6,
          "op": 90.4,
          "st": -33.6,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 4,
          "ty": 4,
          "nm": "Shape Layer 4",
          "ks": {
            "o": { "k": 18 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [102, 102, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "v": [
                        [41.593, 144.622],
                        [169.506, 119.927],
                        [189.109, 279.448],
                        [324.733, 198.952],
                        [451.572, 261.435],
                        [464.308, 109.882],
                        [591.263, 63.386],
                        [489.394, -41.116],
                        [545.422, -183.975],
                        [401.99, -165.308],
                        [315.929, -299.146],
                        [228.713, -166.646],
                        [75.238, -178.354],
                        [75.296, -7.911],
                        [-76.402, 13.881],
                        [-74.277, 186.236],
                        [-211.124, 169.355],
                        [-300.932, 303.028],
                        [-390.031, 173.297],
                        [-533.818, 195.069],
                        [-486.799, 51.51],
                        [-603.444, -31.631],
                        [-472.297, -92.031],
                        [-477.325, -249.524],
                        [-333.828, -192.011],
                        [-212.105, -287.275],
                        [-181.109, -134.238],
                        [-48.486, -147.583]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 22, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": -33.6,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 6.4,
                        "s": [360],
                        "e": [720]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 46.4,
                        "s": [720],
                        "e": [1080]
                      },
                      { "t": 86.4 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 10 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": -33.6,
          "op": 90.4,
          "st": -33.6,
          "bm": 0,
          "sr": 1
        }
      ]
    }
  ],
  "layers": [
    {
      "ddd": 0,
      "ind": 0,
      "ty": 0,
      "nm": "logo",
      "td": 1,
      "refId": "comp_1",
      "ks": {
        "o": { "k": 100 },
        "r": { "k": 0 },
        "p": { "k": [80, 80, 0] },
        "a": { "k": [700, 400, 0] },
        "s": { "k": [10.286, 10.286, 100] }
      },
      "ao": 0,
      "w": 1400,
      "h": 800,
      "ip": 0,
      "op": 100,
      "st": 0,
      "bm": 0,
      "sr": 1
    },
    {
      "ddd": 0,
      "ind": 1,
      "ty": 1,
      "nm": "Dark Gray Solid 1",
      "tt": 3,
      "ks": {
        "o": { "k": 100 },
        "r": { "k": 0 },
        "p": { "k": [80, 80, 0] },
        "a": { "k": [700, 400, 0] },
        "s": { "k": [100, 100, 100] }
      },
      "ao": 0,
      "sw": 1400,
      "sh": 800,
      "sc": "#eeeeee",
      "ip": 0,
      "op": 100,
      "st": 0,
      "bm": 0,
      "sr": 1
    }
  ],
  "v": "4.5.3",
  "ddd": 0,
  "ip": 0,
  "op": 40,
  "fr": 20,
  "w": 160,
  "h": 160
}


================================================
FILE: apps/web/src/components/loading-indicator/loading-light.json
================================================
{
  "assets": [
    {
      "id": "comp_1",
      "layers": [
        {
          "ddd": 0,
          "ind": 0,
          "ty": 4,
          "nm": "Shape Layer 3",
          "ks": {
            "o": {
              "k": [
                {
                  "i": { "x": [0.833], "y": [0.833] },
                  "o": { "x": [0.167], "y": [0.167] },
                  "n": ["0p833_0p833_0p167_0p167"],
                  "t": 10.4,
                  "s": [100],
                  "e": [0]
                },
                { "t": 25.6 }
              ]
            },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "hasMask": true,
          "masksProperties": [
            {
              "inv": true,
              "mode": "a",
              "pt": {
                "k": [
                  {
                    "i": { "x": 0.833, "y": 0.833 },
                    "o": { "x": 0.167, "y": 0.167 },
                    "n": "0p833_0p833_0p167_0p167",
                    "t": 12,
                    "s": [
                      {
                        "i": [
                          [134.688, 0],
                          [0, -134.688],
                          [-134.688, 0],
                          [0, 134.688]
                        ],
                        "o": [
                          [-134.688, 0],
                          [0, 134.688],
                          [134.688, 0],
                          [0, -134.688]
                        ],
                        "v": [
                          [0, -244.875],
                          [-243.875, -1],
                          [0, 242.875],
                          [243.875, -1]
                        ],
                        "c": true
                      }
                    ],
                    "e": [
                      {
                        "i": [
                          [176.731, 0],
                          [0, -176.731],
                          [-176.731, 0],
                          [0, 176.731]
                        ],
                        "o": [
                          [-176.731, 0],
                          [0, 176.731],
                          [176.731, 0],
                          [0, -176.731]
                        ],
                        "v": [
                          [0, -321],
                          [-320, -1],
                          [0, 319],
                          [320, -1]
                        ],
                        "c": true
                      }
                    ]
                  },
                  { "t": 22.4 }
                ]
              },
              "o": { "k": 100 },
              "x": { "k": 0 },
              "nm": "Mask 1"
            }
          ],
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 8.8,
                        "s": [30],
                        "e": [0]
                      },
                      { "t": 22.4 }
                    ],
                    "ix": 1
                  },
                  "e": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 8.8,
                        "s": [30],
                        "e": [60]
                      },
                      { "t": 22.4 }
                    ],
                    "ix": 2
                  },
                  "o": { "k": -110, "ix": 3 },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 1,
          "ty": 4,
          "nm": "Shape Layer 2",
          "ks": {
            "o": { "k": 100 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 26, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 0,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 40,
                        "s": [360],
                        "e": [720]
                      },
                      { "t": 80 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 2,
          "ty": 4,
          "nm": "Shape Layer 1",
          "ks": {
            "o": { "k": 100 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [102, 102, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "v": [
                        [41.593, 144.622],
                        [169.506, 119.927],
                        [189.109, 279.448],
                        [324.733, 198.952],
                        [451.572, 261.435],
                        [464.308, 109.882],
                        [591.263, 63.386],
                        [489.394, -41.116],
                        [545.422, -183.975],
                        [401.99, -165.308],
                        [315.929, -299.146],
                        [228.713, -166.646],
                        [75.238, -178.354],
                        [75.296, -7.911],
                        [-76.402, 13.881],
                        [-74.277, 186.236],
                        [-211.124, 169.355],
                        [-300.932, 303.028],
                        [-390.031, 173.297],
                        [-533.818, 195.069],
                        [-486.799, 51.51],
                        [-603.444, -31.631],
                        [-472.297, -92.031],
                        [-477.325, -249.524],
                        [-333.828, -192.011],
                        [-212.105, -287.275],
                        [-181.109, -134.238],
                        [-48.486, -147.583]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 22, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 0,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 40,
                        "s": [360],
                        "e": [720]
                      },
                      { "t": 80 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 10 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": 0,
          "op": 100,
          "st": 0,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 3,
          "ty": 4,
          "nm": "Shape Layer 5",
          "ks": {
            "o": { "k": 18 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [100, 100, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [-24.109, -23.866],
                        [-58.097, 2.286],
                        [-4.307, 101.702],
                        [108.95, -0.605],
                        [0, 0],
                        [36.992, -44.122],
                        [100.991, -5.514],
                        [22.177, 25.867],
                        [6.132, 116.1],
                        [-41.842, 62.08],
                        [-30.638, 10.829],
                        [-51.58, -26.549],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [24.109, 23.866],
                        [74.937, -2.949],
                        [5.422, -128.032],
                        [-88.536, 0.492],
                        [0, 0],
                        [-17.89, 21.338],
                        [-138.946, 7.586],
                        [-22.174, -25.864],
                        [-2.384, -45.141],
                        [41.572, -61.679],
                        [77.499, -27.393],
                        [92.496, 47.608],
                        [0, 0]
                      ],
                      "v": [
                        [116, 52],
                        [197.891, 144.134],
                        [328.097, 197.714],
                        [497.578, 23.032],
                        [311.536, -190.492],
                        [139.357, -79.71],
                        [-73.007, 190.878],
                        [-281.054, 311.414],
                        [-531.052, 222.093],
                        [-620.132, 10.9],
                        [-568.112, -177.098],
                        [-425.186, -291.697],
                        [-199.496, -289.608],
                        [-46, -153]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 1",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ind": 1,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [-44, -50],
                        [-152, 2],
                        [-63.813, 80.106],
                        [89, 81],
                        [84, 0],
                        [52, -59],
                        [38, -40],
                        [81, 0],
                        [-1.027, 116.034],
                        [-81, 0],
                        [-31, -36],
                        [0, 0]
                      ],
                      "o": [
                        [44, 50],
                        [105.034, -1.382],
                        [94, -118],
                        [-79.495, -72.35],
                        [-84, 0],
                        [-52, 59],
                        [-36.789, 38.725],
                        [-61.033, 0],
                        [1, -113],
                        [81, 0],
                        [31, 36],
                        [0, 0]
                      ],
                      "v": [
                        [41, 152],
                        [302, 310],
                        [554, 190],
                        [536, -217],
                        [307, -309],
                        [84, -198],
                        [-176, 130],
                        [-327, 196],
                        [-500, -3],
                        [-330, -192],
                        [-183, -127],
                        [-120, -57]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 26, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": -33.6,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 6.4,
                        "s": [360],
                        "e": [720]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 46.4,
                        "s": [720],
                        "e": [1080]
                      },
                      { "t": 86.4 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 11 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": -33.6,
          "op": 90.4,
          "st": -33.6,
          "bm": 0,
          "sr": 1
        },
        {
          "ddd": 0,
          "ind": 4,
          "ty": 4,
          "nm": "Shape Layer 4",
          "ks": {
            "o": { "k": 18 },
            "r": { "k": 0 },
            "p": { "k": [700, 400, 0] },
            "a": { "k": [0, 0, 0] },
            "s": { "k": [102, 102, 100] }
          },
          "ao": 0,
          "shapes": [
            {
              "ty": "gr",
              "it": [
                {
                  "ind": 0,
                  "ty": "sh",
                  "ks": {
                    "k": {
                      "i": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "o": [
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0],
                        [0, 0]
                      ],
                      "v": [
                        [41.593, 144.622],
                        [169.506, 119.927],
                        [189.109, 279.448],
                        [324.733, 198.952],
                        [451.572, 261.435],
                        [464.308, 109.882],
                        [591.263, 63.386],
                        [489.394, -41.116],
                        [545.422, -183.975],
                        [401.99, -165.308],
                        [315.929, -299.146],
                        [228.713, -166.646],
                        [75.238, -178.354],
                        [75.296, -7.911],
                        [-76.402, 13.881],
                        [-74.277, 186.236],
                        [-211.124, 169.355],
                        [-300.932, 303.028],
                        [-390.031, 173.297],
                        [-533.818, 195.069],
                        [-486.799, 51.51],
                        [-603.444, -31.631],
                        [-472.297, -92.031],
                        [-477.325, -249.524],
                        [-333.828, -192.011],
                        [-212.105, -287.275],
                        [-181.109, -134.238],
                        [-48.486, -147.583]
                      ],
                      "c": false
                    }
                  },
                  "nm": "Path 2",
                  "mn": "ADBE Vector Shape - Group"
                },
                {
                  "ty": "tm",
                  "s": { "k": 0, "ix": 1 },
                  "e": { "k": 22, "ix": 2 },
                  "o": {
                    "k": [
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": -33.6,
                        "s": [0],
                        "e": [360]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 6.4,
                        "s": [360],
                        "e": [720]
                      },
                      {
                        "i": { "x": [0.833], "y": [0.833] },
                        "o": { "x": [0.167], "y": [0.167] },
                        "n": ["0p833_0p833_0p167_0p167"],
                        "t": 46.4,
                        "s": [720],
                        "e": [1080]
                      },
                      { "t": 86.4 }
                    ],
                    "ix": 3
                  },
                  "m": 1,
                  "ix": 3,
                  "nm": "Trim Paths 1",
                  "mn": "ADBE Vector Filter - Trim"
                },
                {
                  "ty": "st",
                  "fillEnabled": true,
                  "c": { "k": [1, 1, 1, 1] },
                  "o": { "k": 100 },
                  "w": { "k": 10 },
                  "lc": 2,
                  "lj": 2,
                  "nm": "Stroke 1",
                  "mn": "ADBE Vector Graphic - Stroke"
                },
                {
                  "ty": "tr",
                  "p": { "k": [0, 0], "ix": 2 },
                  "a": { "k": [0, 0], "ix": 1 },
                  "s": { "k": [100, 100], "ix": 3 },
                  "r": { "k": 0, "ix": 6 },
                  "o": { "k": 100, "ix": 7 },
                  "sk": { "k": 0, "ix": 4 },
                  "sa": { "k": 0, "ix": 5 },
                  "nm": "Transform"
                }
              ],
              "nm": "Shape 1",
              "np": 4,
              "mn": "ADBE Vector Group"
            }
          ],
          "ip": -33.6,
          "op": 90.4,
          "st": -33.6,
          "bm": 0,
          "sr": 1
        }
      ]
    }
  ],
  "layers": [
    {
      "ddd": 0,
      "ind": 0,
      "ty": 0,
      "nm": "logo",
      "td": 1,
      "refId": "comp_1",
      "ks": {
        "o": { "k": 100 },
        "r": { "k": 0 },
        "p": { "k": [80, 80, 0] },
        "a": { "k": [700, 400, 0] },
        "s": { "k": [10.286, 10.286, 100] }
      },
      "ao": 0,
      "w": 1400,
      "h": 800,
      "ip": 0,
      "op": 100,
      "st": 0,
      "bm": 0,
      "sr": 1
    },
    {
      "ddd": 0,
      "ind": 1,
      "ty": 1,
      "nm": "Dark Gray Solid 1",
      "tt": 3,
      "ks": {
        "o": { "k": 100 },
        "r": { "k": 0 },
        "p": { "k": [80, 80, 0] },
        "a": { "k": [700, 400, 0] },
        "s": { "k": [100, 100, 100] }
      },
      "ao": 0,
      "sw": 1400,
      "sh": 800,
      "sc": "#232323",
      "ip": 0,
      "op": 100,
      "st": 0,
      "bm": 0,
      "sr": 1
    }
  ],
  "v": "4.5.3",
  "ddd": 0,
  "ip": 0,
  "op": 40,
  "fr": 20,
  "w": 160,
  "h": 160
}


================================================
FILE: apps/web/src/components/loading-indicator/styles.module.css
================================================
.loading {
  position: relative;
  pointer-events: none;
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  margin: 0 auto;
}

.fill {
  top: 0;
  left: 0;
  right: 0;
  bottom: 0;
}

.loadingAnimation {
  pointer-events: none;
  width: 200px;
  height: 200px;
  max-width: 50vw;
  max-height: 50vh;
}


================================================
FILE: apps/web/src/components/markdown/index.tsx
================================================
import { cn } from '@/lib/utils'

import styles from './styles.module.css'

export function Markdown({
  children,
  className
}: {
  className?: string
  children: React.ReactNode
}) {
  return (
    <div className={cn('prose dark:prose-invert', styles.markdown, className)}>
      {children}
    </div>
  )
}


================================================
FILE: apps/web/src/components/markdown/ssr-markdown.tsx
================================================
'use client'

import { markdownToHtml } from '@fisch0920/markdown-to-html'
import { useAsync } from 'react-use'

import { cn } from '@/lib/utils'

import { LoadingIndicator } from '../loading-indicator'
import styles from './styles.module.css'

// TODO: figure out how to make this server-only to not bloat the client-side bundle
export function SSRMarkdown({
  className,
  markdown
}: {
  className?: string
  markdown: string
}) {
  const { value: html, loading } = useAsync(
    async () => markdownToHtml(markdown),
    [markdown]
  )

  if (loading) {
    return (
      <div className={cn('flex justify-center items-center h-full', className)}>
        <LoadingIndicator />
      </div>
    )
  }

  return (
    <div
      className={cn('prose dark:prose-invert', styles.markdown, className)}
      dangerouslySetInnerHTML={{ __html: html! }}
    />
  )
}


================================================
FILE: apps/web/src/components/markdown/styles.module.css
================================================
.markdown {
  width: 100%;
  max-width: 100%;
  line-height: 1.6;
  display: flex;
  flex-direction: column;
  align-items: center;
}

.markdown > * {
  margin-bottom: 1em;
  width: 100%;
  max-width: 830px;
}

.markdown > :last-child {
  margin-bottom: 0;
}

.markdown > *:first-child {
  margin-top: 0 !important;
}

.markdown img {
  display: inline-block;
  max-width: 100%;
  margin: 0;
}

.markdown a:not(:has(img)) {
  display: inline-block;
  text-decoration: none;
  font-weight: inherit;
  line-height: 1.3;
  position: relative;
  transition: unset;
  opacity: 1;
  color: unset;
  padding-bottom: 0.1rem;
  border-color: var(--border);
  border-bottom-width: 0.135rem;
  background: transparent;
  background-origin: border-box;
  background-repeat: no-repeat;
  background-position: 50% 100%;
  background-size: 0 0.135rem;
}

.markdown a:hover:not(:has(img)),
.markdown a:focus:not(:has(img)) {
  color: var(--tw-prose-links);
  text-decoration: none;
  border-bottom-color: transparent;

  background-image: linear-gradient(90.68deg, #b439df 0.26%, #e5337e 102.37%);
  background-repeat: no-repeat;
  background-position: 0 100%;
  background-size: 100% 0.135rem;

  transition-property: background-position, background-size;
  transition-duration: 300ms;
}

.markdown :where(ul):not(:where([class~='not-prose'], [class~='not-prose'] *)) {
  margin-top: 1em;
}

.markdown p + ul,
.markdown p + ol,
.markdown h1 + ul,
.markdown h2 + ul,
.markdown h3 + ul,
.markdown h4 + ul,
.markdown h5 + ul,
.markdown h6 + ul,
.markdown h1 + ol,
.markdown h2 + ol,
.markdown h3 + ol,
.markdown h4 + ol,
.markdown h5 + ol,
.markdown h6 + ol {
  margin-top: 0;
}

.markdown p {
  margin-top: 0;
  margin-bottom: 1em;
}

.markdown li a {
  margin: 0;
}

.markdown li:first-child {
  margin-top: 0;
}

.markdown li:last-child {
  margin-bottom: 0;
}

.markdown h1,
.markdown h2,
.markdown h3,
.markdown h4,
.markdown h5,
.markdown h6 {
  margin-top: 1.5em;
  margin-bottom: 0.5em;
  font-weight: 600;
  line-height: 1.25;
}

.markdown h1 {
  font-size: 2em;
}

.markdown h2 {
  font-size: 1.5em;
}

.markdown h3 {
  font-size: 1.25em;
}

.markdown h4 {
  font-size: 1em;
}

.markdown h5 {
  font-size: 1em;
  font-weight: 700;
}

.markdown h6 {
  font-size: 1em;
  font-weight: 500;
}

@media (max-width: 800px) {
  .markdown img {
    display: block;
    text-align: center;
    margin: 0 auto;
  }
}


================================================
FILE: apps/web/src/components/mcp-gateway-features.tsx
================================================
'use client'

import {
  ChartNoAxesCombinedIcon,
  CheckCheckIcon,
  CreditCardIcon,
  DatabaseZapIcon,
  HistoryIcon,
  KeyRoundIcon,
  ShieldCheckIcon,
  TextSelectIcon,
  UserIcon
} from 'lucide-react'

import { Feature, type FeatureData } from './feature'

const docsPublishingUrl = 'https://docs.agentic.so/publishing'

const mcpGatewayFeatures: FeatureData[] = [
  {
    name: 'Auth',
    description: (
      <>
        Ship to production fast with Agentic's free, hosted authentication.
        Email & password, OAuth, GitHub, Google, Twitter, etc – if your origin
        API requires OAuth credentials, Agentic likely already supports it, and
        if not, we'd be happy to add it.
      </>
    ),
    icon: UserIcon,
    href: `${docsPublishingUrl}/config/auth`,
    pattern: {
      y: 16,
      squares: [
        [0, 1],
        [1, 3]
      ]
    }
  },
  {
    name: 'Stripe Billing',
    description: (
      <>
        Charge for your MCP products with a flexible, declarative pricing model
        built on top of Stripe. Agentic supports almost any combination of fixed
        and <span className='font-semibold'>usage-based billing</span> models,
        both at the MCP level, at the tool-call level, and at the custom metric
        level (e.g., tokens, image transformations, etc).
      </>
    ),
    icon: CreditCardIcon,
    href: `${docsPublishingUrl}/config/pricing`,
    pattern: {
      y: -6,
      squares: [
        [-1, 2],
        [1, 3]
      ]
    }
  },
  {
    name: 'Support both MCP and HTTP',
    description: (
      <>
        All Agentic tools are exposed as both{' '}
        <span className='font-semibold'>MCP servers</span> as well as simple{' '}
        <span className='font-semibold'>HTTP APIs</span>. MCP is important for
        interop and future-proofing, whereas simple HTTP POST requests make
        tools easy to debug and simplifies usage with LLM tool calling.
      </>
    ),
    icon: CheckCheckIcon,
    pattern: {
      y: 32,
      squares: [
        [0, 2],
        [1, 4]
      ]
    }
  },
  {
    name: 'API Keys',
    description: (
      <>
        When a customer subscribes to your product, they're given a unique API
        key. MCP URLs are appended with this API key to correlate usage with
        their subscription. Customer HTTP tool calls use the same API key as a
        standard HTTP <em>Authorization</em> header.
      </>
    ),
    icon: KeyRoundIcon,
    pattern: {
      y: 22,
      squares: [[0, 1]]
    }
  },
  {
    name: 'Rate-Limiting',
    description: (
      <>
        Agentic durable rate-limiting is built on top of Cloudflare's global
        infrastructure. Customize the default rate-limits, change them based on
        a customer's pricing plan, or create custom tool-specific overrides.
        REST assured that your origin API will be safe behind Agentic's MCP
        gateway.
      </>
    ),
    icon: ShieldCheckIcon,
    href: `${docsPublishingUrl}/config/rate-limits`,
    pattern: {
      y: 2,
      squares: [
        [-2, 3],
        [1, 4]
      ]
    }
  },
  {
    name: 'Caching',
    description: (
      <>
        Opt-in to caching with familiar <em>cache-control</em> and{' '}
        <em>stale-while-revalidate</em> options. MCP tool calls include caching
        information in their <em>_meta</em> fields, providing parity with
        standard HTTP headers. Agentic uses Cloudflare's global edge cache for
        caching, which guarantees unmatched global performance.
      </>
    ),
    icon: DatabaseZapIcon,
    href: `${docsPublishingUrl}/config/caching`,
    pattern: {
      y: 8,
      squares: [
        [0, 2],
        [-1, 1]
      ]
    }
  },
  {
    name: 'Analytics',
    description: (
      <>
        Agentic tracks all tool calls for usage-based billing and analytics at a
        fine-grained level, so you can drill in and deeply understand how your
        customers are using your product.
      </>
    ),
    icon: ChartNoAxesCombinedIcon,
    pattern: {
      y: -2,
      squares: [[-2, 2]]
    }
  },
  {
    name: 'Versioning & Instant Rollbacks',
    description: (
      <>
        Agentic uses immutable deployments, so every time you make a change to
        your product, a unique preview deployment is created. This enables
        instant rollbacks if there are problems with a deployment. Publishing
        uses <span className='font-semibold'>semver</span> (semantic
        versioning), so your customers can choose how to handle breaking
        changes.
      </>
    ),
    icon: HistoryIcon,
    pattern: {
      y: 26,
      squares: [
        [2, 4],
        [-2, 3]
      ]
    }
  },
  {
    name: "That's just the start",
    description: (
      <>Check out our docs for more details on Agentic's MCP gateway.</>
    ),
    href: `${docsPublishingUrl}/quickstart`,
    icon: TextSelectIcon,
    pattern: {
      y: 13,
      squares: [
        [0, 2],
        [-1, 4]
      ]
    }
  }
]

export function MCPGatewayFeatures() {
  return (
    <div className='xl:max-w-none'>
      <div className='not-prose grid grid-cols-1 gap-8 sm:grid-cols-2 xl:grid-cols-3'>
        {mcpGatewayFeatures.map((feature) => (
          <Feature key={feature.name} {...feature} />
        ))}
      </div>
    </div>
  )
}


================================================
FILE: apps/web/src/components/mcp-marketplace-features.tsx
================================================
'use client'

import {
  CreditCardIcon,
  FileJsonIcon,
  HistoryIcon,
  ShieldCheckIcon,
  StarIcon,
  ZapIcon
} from 'lucide-react'

import { Feature, type FeatureData } from './feature'

const mcpMarketplaceFeatures: FeatureData[] = [
  {
    name: 'Highly Curated',
    description: (
      <>
        <span className='font-semibold'>
          All Agentic tools have been hand-crafted specifically for LLM tool
          use.
        </span>{' '}
        We call this Agentic UX, and it's at the heart of why Agentic tools work
        better for LLM &amp; MCP use cases than legacy APIs.
      </>
    ),
    icon: StarIcon,
    pattern: {
      y: 16,
      squares: [
        [0, 1],
        [1, 3]
      ]
    }
  },
  {
    name: 'Production-Ready MCP Support',
    description: (
      <>
        Forget random GitHub repos and gluing local MCP servers together.
        Agentic tools are all battle-tested in production and come with real
        SLAs.
      </>
    ),
    icon: ShieldCheckIcon,
    pattern: {
      y: 22,
      squares: [[0, 1]]
    }
  },
  {
    name: 'World-Class TypeScript DX',
    description: (
      <>
        Agentic is written in TypeScript and strives for a Vercel-like DX.
        <span className='font-semibold'>One-line tool integrations</span> for
        all of the popular TS LLM SDKs (
        <span className='font-semibold'>Vercel AI SDK</span>,{' '}
        <span className='font-semibold'>OpenAI</span>,{' '}
        <span className='font-semibold'>LangChain</span>, etc).
      </>
    ),
    icon: FileJsonIcon,
    pattern: {
      y: 8,
      squares: [
        [0, 2],
        [-1, 1]
      ]
    }
  },
  {
    name: 'Stripe Billing',
    description: (
      <>
        Agentic uses Stripe for billing, and most tools are{' '}
        <span className='font-semibold'>usage-based</span>, so you'll only pay
        for what you (and your agents) actually use.
      </>
    ),
    icon: CreditCardIcon,
    pattern: {
      y: -6,
      squares: [
        [-1, 2],
        [1, 3]
      ]
    }
  },
  {
    name: 'Blazing Fast MCP Gateway',
    description: (
      <>
        Agentic's MCP gateway is powered by{' '}
        <span className='font-semibold'>Cloudflare's global edge network</span>.
        Tools come with customizable caching and rate-limits, so you can REST
        assured that your agents will always have a fast and reliable
        experience.
      </>
    ),
    icon: ZapIcon,
    pattern: {
      y: 32,
      squares: [
        [0, 2],
        [1, 4]
      ]
    }
  },
  {
    name: 'Semantic Versioning',
    description: (
      <>
        All Agentic tools are versioned using{' '}
        <span className='font-semibold'>semver</span>, so you can choose how to
        handle breaking changes.
      </>
    ),
    icon: HistoryIcon,
    pattern: {
      y: 26,
      squares: [
        [2, 4],
        [-2, 3]
      ]
    }
  }
]

export function MCPMarketplaceFeatures() {
  return (
    <div className='xl:max-w-none'>
      <div className='not-prose grid grid-cols-1 gap-8 sm:grid-cols-2 xl:grid-cols-3'>
        {mcpMarketplaceFeatures.map((feature) => (
          <Feature key={feature.name} {...feature} />
        ))}
      </div>
    </div>
  )
}


================================================
FILE: apps/web/src/components/page-container.tsx
================================================
import { cn } from '@/lib/utils'

export function PageContainer({
  background = true,
  compact = false,
  className,
  children
}: {
  background?: boolean
  compact?: boolean
  className?: string
  children: React.ReactNode
}) {
  return (
    <>
      {background && (
        <div className='absolute top-0 left-0 w-[100vw] h-[100vh] bg-top-right bg-no-repeat bg-size-[100vw_50vh] md:bg-auto -z-10 dark:bg-size-[100%_100%] dark:bg-center dark:w-[calc(max(100vw,1500px))] dark:h-[calc(max(100vh,1200px))] dark:left-[calc(min((100vw-1500px)/2,0px))] bg-[url(/bg.png)] dark:bg-[url(/bg-dark.jpg)]' />
      )}

      <div
        className={cn(
          'relative w-full flex-1 flex flex-col items-center max-w-[1200px] gap-16 z-10',
          compact ? 'pt-4' : 'pt-8',
          className
        )}
      >
        {children}
      </div>
    </>
  )
}


================================================
FILE: apps/web/src/components/posthog-provider.tsx
================================================
'use client'

import { usePathname, useSearchParams } from 'next/navigation'
import { posthog } from 'posthog-js'
import { PostHogProvider as PHProvider, usePostHog } from 'posthog-js/react'
import { Suspense, useEffect, useState } from 'react'

import { posthogHost, posthogKey } from '@/lib/config'

export function PostHogProvider({ children }: { children: React.ReactNode }) {
  useEffect(() => {
    if (posthogKey) {
      posthog.init(posthogKey, {
        api_host: posthogHost,
        person_profiles: 'identified_only', // or 'always' to create profiles for anonymous users as well
        capture_pageview: false // Disable automatic pageview capture, as we capture manually
      })
    }
  }, [])

  if (!posthogKey) {
    return children
  }

  return (
    <PHProvider client={posthog}>
      <SuspendedPostHogPageView />

      {children}
    </PHProvider>
  )
}

function PostHogPageView() {
  const pathname = usePathname()
  const searchParams = useSearchParams()
  const posthog = usePostHog()
  const [prevPathname, setPrevPathname] = useState<string | null>(null)

  // Track pageviews
  useEffect(() => {
    if (pathname && posthog) {
      let url = globalThis.window.origin + pathname
      if (searchParams.toString()) {
        url = url + '?' + searchParams.toString()
      }

      if (prevPathname && prevPathname !== pathname) {
        posthog.capture('$pageleave', { $pathname: prevPathname })
      }

      posthog.capture('$pageview', { $current_url: url })
      setPrevPathname(pathname)
    }
  }, [pathname, prevPathname, searchParams, posthog])

  return null
}

// Wrap PostHogPageView in Suspense to avoid the useSearchParams usage above
// from de-opting the whole app into client-side rendering
// See: https://nextjs.org/docs/messages/deopted-into-client-rendering
function SuspendedPostHogPageView() {
  return (
    <Suspense fallback={null}>
      <PostHogPageView />
    </Suspense>
  )
}


================================================
FILE: apps/web/src/components/project-pricing-plans/index.tsx
================================================
import {
  type Consumer,
  getPricingPlansByInterval,
  type PricingInterval,
  type Project
} from '@agentic/platform-types'
import { useLocalStorage } from 'react-use'

import { ProjectPricingPlan } from './project-pricing-plan'

export function ProjectPricingPlans({
  project,
  consumer,
  isLoadingStripeCheckoutForPlan,
  onSubscribe
}: {
  project: Project
  consumer?: Consumer
  isLoadingStripeCheckoutForPlan: string | null
  onSubscribe: (planSlug: string) => void
  className?: string
}) {
  const { defaultPricingInterval } = project
  // TODO
  const [pricingInterval, _setPricingInterval] =
    useLocalStorage<PricingInterval>(
      `pricing-interval-${project.identifier}`,
      defaultPricingInterval
    )

  const deployment = project.lastPublishedDeployment
  if (!deployment || !pricingInterval) {
    return null
  }

  // const numPricingIntervals = deployment.pricingIntervals.length
  // const hasSinglePricingInterval = numPricingIntervals === 1
  const { pricingPlans } = deployment

  const pricingPlansByInterval = Object.fromEntries(
    deployment.pricingIntervals.map((pricingInterval) => [
      pricingInterval,
      getPricingPlansByInterval({ pricingInterval, pricingPlans })
    ])
  )

  const currentPricingIntervalPlans =
    pricingPlansByInterval[pricingInterval] ?? []

  // TODO: add support for different pricing intervals and switching between them
  const numPricingPlans = currentPricingIntervalPlans.length || 1

  return (
    <div className='flex flex-col gap-4'>
      {/* {!hasSinglePricingInterval && ()} */}

      <div
        className={`grid grid-cols grid-cols-1 gap-4 sm:grid-cols-${Math.min(
          2,
          numPricingPlans
        )} xl:grid-cols-${Math.min(3, numPricingPlans)}`}
      >
        {deployment.pricingPlans.map((plan) => (
          <ProjectPricingPlan
            key={plan.slug}
            plan={plan}
            project={project}
            consumer={consumer}
            isLoadingStripeCheckoutForPlan={isLoadingStripeCheckoutForPlan}
            onSubscribe={onSubscribe}
          />
        ))}
      </div>
    </div>
  )
}


================================================
FILE: apps/web/src/components/project-pricing-plans/project-pricing-plan.tsx
================================================
import type {
  Consumer,
  // PricingInterval,
  PricingPlan,
  Project
} from '@agentic/platform-types'
import humanNumber from 'human-number'
import {
  CornerDownRightIcon,
  Loader2Icon,
  PlusIcon,
  ShieldCheckIcon,
  ShieldMinusIcon
} from 'lucide-react'
import Link from 'next/link'
import plur from 'plur'

import { Button } from '@/components/ui/button'
import {
  getRateLimitIntervalLabel,
  pricingAmountToFixedString
} from '@/lib/utils'

// const intervalToLabelMap: Record<PricingInterval, string> = {
//   day: 'daily',
//   week: 'weekly',
//   month: 'monthly',
//   year: 'yearly'
// }

export function ProjectPricingPlan({
  project,
  plan,
  consumer,
  isLoadingStripeCheckoutForPlan,
  onSubscribe
}: {
  project: Project
  plan: PricingPlan
  consumer?: Consumer
  isLoadingStripeCheckoutForPlan: string | null
  onSubscribe: (planSlug: string) => void
  className?: string
}) {
  const { defaultPricingInterval } = project
  const { lineItems } = plan
  const interval = plan.interval ?? defaultPricingInterval
  // const intervalLabel = intervalToLabelMap[interval]
  const baseLineItem = lineItems.find((lineItem) => lineItem.slug === 'base')
  const requestsLineItem = lineItems.find(
    (lineItem) => lineItem.slug === 'requests'
  )
  const isFreePlan = plan.slug === 'free'

  const deployment = project.lastPublishedDeployment
  const requestsRateLimit = plan.rateLimit ?? deployment?.defaultRateLimit

  // TODO: support custom line-items
  // const customLineItems = lineItems.find(
  //   (lineItem) => lineItem.slug !== 'base' && lineItem.slug !== 'requests'
  // )

  // TODO: support defaultAggregation
  // TODO: support trialPeriodDays
  // TODO: highlight if any tools are disabled on this pricing plan

  return (
    <div className='justify-self-center w-full grid grid-cols-1 rounded-[2rem] shadow-[inset_0_0_2px_1px_#ffffff4d] ring-1 ring-black/5 max-lg:mx-auto max-lg:w-full max-lg:max-w-md max-w-lg'>
      <div className='grid grid-cols-1 rounded-[2rem] p-2 shadow-md shadow-black/5'>
        <div className='rounded-3xl bg-card p-4 shadow-2xl ring-1 ring-black/5 flex flex-col gap-4 color-card-foreground justify-between'>
          <div className='flex flex-col gap-4'>
            <h3 className='text-center text-balance leading-snug md:leading-none text-xl font-semibold'>
              {plan.name} <span className='sr-only'>Plan</span>
            </h3>

            {plan.description && <p>{plan.description}</p>}

            <div className='flex flex-row items-center gap-2'>
              <div className='text-4xl font-semibold leading-none py-2'>
                $
                {baseLineItem
                  ? pricingAmountToFixedString(baseLineItem.amount)
                  : 0}
              </div>

              <div className='text-sm'>/ {interval}</div>
            </div>

            {requestsLineItem && !isFreePlan && (
              <div className='flex flex-col gap-2'>
                <h4 className='text-sm/6 font-medium'>Requests:</h4>

                {requestsLineItem.billingScheme === 'per_unit' ? (
                  <div className='ml-4 flex flex-row items-center gap-2'>
                    <div className='text-xl font-semibold leading-none py-2'>
                      ${pricingAmountToFixedString(requestsLineItem.unitAmount)}
                    </div>

                    <div className='text-sm'>
                      / per{' '}
                      {requestsLineItem.transformQuantity
                        ? `${requestsLineItem.transformQuantity.divideBy} ${plur('request', requestsLineItem.transformQuantity.divideBy)}`
                        : 'request'}
                    </div>
                  </div>
                ) : requestsLineItem.billingScheme === 'tiered' ? (
                  <div className='ml-4 flex flex-col gap-2'>
                    {requestsLineItem.tiers?.map((tier, index) => {
                      const isFirst = index === 0
                      const hasUnitAmount = tier.unitAmount !== undefined
                      const isFree = hasUnitAmount
                        ? // TODO: are these two mutually exclusive? check in stripe
                          tier.unitAmount === 0
                        : tier.flatAmount === 0

                      const isTierInfinite = tier.upTo === 'inf'
                      const numLabel =
                        tier.upTo === 'inf'
                          ? 'infinite requests'
                          : `${humanNumber(tier.upTo)} ${plur('request', tier.upTo)}`
                      const price = `$${pricingAmountToFixedString(
                        hasUnitAmount ? tier.unitAmount! : tier.flatAmount!
                      )}${hasUnitAmount ? ' per request' : ''}`

                      const numDesc = isFree
                        ? isFirst
                          ? isTierInfinite
                            ? `FREE for all requests per ${interval}`
                            : `FREE for the first ${numLabel} per ${interval}`
                          : isTierInfinite
                            ? `FREE for all requests after that per ${interval}`
                            : `FREE for requests up to ${numLabel} per ${interval}`
                        : isFirst
                          ? isTierInfinite
                            ? `${price} per ${interval}`
                            : `${price} for the first ${numLabel} per ${interval}`
                          : isTierInfinite
                            ? `${price} after that per ${interval}`
                            : `${price} up to ${numLabel} per ${interval}`

                      return (
                        <div
                          key={index}
                          className='flex flex-row items-center gap-2 text-sm text-secondary-foreground/80'
                        >
                          <CornerDownRightIcon className='size-4' />

                          <span>{numDesc}</span>
                        </div>
                      )
                    })}
                  </div>
                ) : (
                  <div>Unsupported pricing config. Please contact support.</div>
                )}
              </div>
            )}

            {isFreePlan && (
              <p className='text-pretty text-sm text-secondary-foreground/80'>
                Try before you buy. 100% free!
              </p>
            )}

            {requestsRateLimit?.enabled && (
              <div className='flex flex-row items-center gap-2 text-sm text-secondary-foreground/80'>
                {isFreePlan ? (
                  <ShieldMinusIcon aria-hidden className='size-4' />
                ) : (
                  <ShieldCheckIcon aria-hidden className='size-4' />
                )}

                <span>
                  {isFreePlan ? 'Limited' : 'Rate-limited'} to{' '}
                  {requestsRateLimit.limit} requests per{' '}
                  {getRateLimitIntervalLabel(requestsRateLimit.interval)}
                </span>
              </div>
            )}

            {plan.features && (
              <div className='flex flex-col gap-2'>
                <h4 className='text-sm/6 font-medium'>Features:</h4>

                <ul className='ml-4 flex flex-col gap-2 list-disc'>
                  {plan.features.map((feature, index) => (
                    <li
                      key={index}
                      className='flex flex-row items-center gap-2 text-sm text-secondary-foreground/80'
                    >
                      <PlusIcon aria-hidden className='size-4' />

                      <span>{feature}</span>
                    </li>
                  ))}
                </ul>
              </div>
            )}

            {requestsLineItem?.billingScheme === 'tiered' && (
              <p className='text-pretty text-xs/5 text-muted-foreground'>
                {requestsLineItem.tiersMode === 'graduated' ? (
                  <>
                    Requests pricing tiers use{' '}
                    <Link
                      href='https://docs.stripe.com/products-prices/pricing-models#graduated-pricing'
                      className='link'
                      target='_blank'
                      rel='noreferrer'
                    >
                      graduated pricing
                    </Link>
                    .
                  </>
                ) : (
                  <>
                    Requests pricing tiers use{' '}
                    <Link
                      href='https://docs.stripe.com/products-prices/pricing-models#volume-based-pricing'
                      className='link'
                      target='_blank'
                      rel='noreferrer'
                    >
                      volume-based pricing
                    </Link>
                    .
                  </>
                )}
              </p>
            )}
          </div>

          <Button
            onClick={() => onSubscribe(plan.slug)}
            // TODO: handle free plans correctly
            disabled={
              consumer?.plan === plan.slug || !!isLoadingStripeCheckoutForPlan
            }
          >
            {isLoadingStripeCheckoutForPlan === plan.slug && (
              <Loader2Icon className='animate-spin mr-2' />
            )}

            {consumer?.plan === plan.slug ? (
              <span>Currently subscribed to "{plan.name}"</span>
            ) : (
              <span>Subscribe to "{plan.name}"</span>
            )}
          </Button>
        </div>
      </div>
    </div>
  )
}


================================================
FILE: apps/web/src/components/public-project.tsx
================================================
import type { Project } from '@agentic/platform-types'
import { UTCDate } from '@date-fns/utc'
import { formatDistanceToNow } from 'date-fns'
import Link from 'next/link'

export function PublicProject({ project }: { project: Project }) {
  const deployment = project.lastPublishedDeployment!
  if (!deployment) return null

  return (
    <Link
      key={project.id}
      className='p-3 border rounded-lg hover:border-gray-400
      divide-y divide-gray-200 overflow-hidden bg-white shadow-sm max-w-md flex flex-col gap-3
      '
      href={`/marketplace/projects/${project.identifier}`}
    >
      <div className='pb-3 flex gap-2.5 items-center'>
        <img
          src={
            deployment.iconUrl ||
            project.user?.image ||
            '/agentic-icon-circle-light.svg'
          }
          alt={project.name}
          className='aspect-square w-8 h-8'
        />

        <div className='flex flex-col gap-1'>
          <h3 className='font-semibold text-lg text-gray-900 leading-tight'>
            {project.name}
          </h3>

          <p className='text-sm text-gray-500'>{project.identifier}</p>
        </div>
      </div>

      <div className='flex-1 flex flex-col gap-3 justify-between'>
        <p className='text-sm text-gray-700 line-clamp-4'>
          {deployment.description}
        </p>

        {project.lastPublishedDeployment && (
          <div className='text-xs text-gray-500 flex gap-3 items-center justify-between'>
            <div>{deployment.version}</div>

            <div>
              Last published{' '}
              {formatDistanceToNow(new UTCDate(deployment.createdAt), {
                addSuffix: true
              })}
            </div>
          </div>
        )}
      </div>
    </Link>
  )
}


================================================
FILE: apps/web/src/components/supply-side-cta.tsx
================================================
'use client'

import { sanitizeSearchParams } from '@agentic/platform-core'
import Link from 'next/link'

import { HeroButton, type HeroButtonVariant } from '@/components/hero-button'
import { Button } from '@/components/ui/button'
import { GitHubIcon } from '@/icons/github'
import { calendarBookingUrl, githubUrl } from '@/lib/config'

import { useAgentic } from './agentic-provider'
import { GitHubStarCounter } from './github-star-counter'

const docsPublishingQuickStartUrl =
  'https://docs.agentic.so/publishing/quickstart'

export function SupplySideCTA({
  variant = 'github',
  heroVariant = 'orange'
}: {
  variant?: 'book-call' | 'docs' | 'github' | 'github-2'
  heroVariant?: HeroButtonVariant
}) {
  const ctx = useAgentic()

  return (
    <div className='flex justify-center items-center gap-4 sm:gap-8'>
      <HeroButton asChild heroVariant={heroVariant}>
        <Link
          href={
            ctx?.isAuthenticated
              ? docsPublishingQuickStartUrl
              : `/signup?${sanitizeSearchParams({
                  next: docsPublishingQuickStartUrl
                })}`
          }
        >
          Quick Start
        </Link>
      </HeroButton>

      {variant === 'github' ? (
        <GitHubStarCounter className='h-full py-[9px]' />
      ) : variant === 'github-2' ? (
        <Button variant='outline' asChild className='h-full py-[9px]'>
          <Link href={githubUrl} target='_blank' rel='noopener'>
            <GitHubIcon />
            Star us on GitHub
          </Link>
        </Button>
      ) : variant === 'docs' ? (
        <Button variant='outline' asChild className='h-full py-[9px]'>
          <Link href='https://docs.agentic.so/publishing'>Publishing Docs</Link>
        </Button>
      ) : (
        <Button variant='outline' asChild className='h-full py-[9px]'>
          <Link href={calendarBookingUrl} target='_blank' rel='noopener'>
            Book a call with the founder 👋
          </Link>
        </Button>
      )}
    </div>
  )
}


================================================
FILE: apps/web/src/components/theme-provider.tsx
================================================
'use client'

import type React from 'react'
import { ThemeProvider as NextThemesProvider } from 'next-themes'

export function ThemeProvider({
  children,
  ...props
}: React.ComponentProps<typeof NextThemesProvider>) {
  return <NextThemesProvider {...props}>{children}</NextThemesProvider>
}


================================================
FILE: apps/web/src/components/ui/avatar.tsx
================================================
'use client'

import * as AvatarPrimitive from '@radix-ui/react-avatar'
import * as React from 'react'

import { cn } from '@/lib/utils'

function Avatar({
  className,
  ...props
}: React.ComponentProps<typeof AvatarPrimitive.Root>) {
  return (
    <AvatarPrimitive.Root
      data-slot='avatar'
      className={cn(
        'relative flex size-8 shrink-0 overflow-hidden rounded-full',
        className
      )}
      {...props}
    />
  )
}

function AvatarImage({
  className,
  ...props
}: React.ComponentProps<typeof AvatarPrimitive.Image>) {
  return (
    <AvatarPrimitive.Image
      data-slot='avatar-image'
      className={cn('aspect-square size-full', className)}
      {...props}
    />
  )
}

function AvatarFallback({
  className,
  ...props
}: React.ComponentProps<typeof AvatarPrimitive.Fallback>) {
  return (
    <AvatarPrimitive.Fallback
      data-slot='avatar-fallback'
      className={cn(
        'bg-muted flex size-full items-center justify-center rounded-full',
        className
      )}
      {...props}
    />
  )
}

export { Avatar, AvatarFallback, AvatarImage }


================================================
FILE: apps/web/src/components/ui/breadcrumb.tsx
================================================
import { Slot } from '@radix-ui/react-slot'
import { ChevronRight, MoreHorizontal } from 'lucide-react'
import * as React from 'react'

import { cn } from '@/lib/utils'

function Breadcrumb({ ...props }: React.ComponentProps<'nav'>) {
  return <nav aria-label='breadcrumb' data-slot='breadcrumb' {...props} />
}

function BreadcrumbList({ className, ...props }: React.ComponentProps<'ol'>) {
  return (
    <ol
      data-slot='breadcrumb-list'
      className={cn(
        'text-muted-foreground flex flex-wrap items-center gap-1.5 text-sm break-words sm:gap-2.5',
        className
      )}
      {...props}
    />
  )
}

function BreadcrumbItem({ className, ...props }: React.ComponentProps<'li'>) {
  return (
    <li
      data-slot='breadcrumb-item'
      className={cn('inline-flex items-center gap-1.5', className)}
      {...props}
    />
  )
}

function BreadcrumbLink({
  asChild,
  className,
  ...props
}: React.ComponentProps<'a'> & {
  asChild?: boolean
}) {
  const Comp = asChild ? Slot : 'a'

  return (
    <Comp
      data-slot='breadcrumb-link'
      className={cn('hover:text-foreground transition-colors', className)}
      {...props}
    />
  )
}

function BreadcrumbPage({ className, ...props }: React.ComponentProps<'span'>) {
  return (
    <span
      data-slot='breadcrumb-page'
      role='link'
      aria-disabled='true'
      aria-current='page'
      className={cn('text-foreground font-normal', className)}
      {...props}
    />
  )
}

function BreadcrumbSeparator({
  children,
  className,
  ...props
}: React.ComponentProps<'li'>) {
  return (
    <li
      data-slot='breadcrumb-separator'
      role='presentation'
      aria-hidden='true'
      className={cn('[&>svg]:size-3.5', className)}
      {...props}
    >
      {children ?? <ChevronRight />}
    </li>
  )
}

function BreadcrumbEllipsis({
  className,
  ...props
}: React.ComponentProps<'span'>) {
  return (
    <span
      data-slot='breadcrumb-ellipsis'
      role='presentation'
      aria-hidden='true'
      className={cn('flex size-9 items-center justify-center', className)}
      {...props}
    >
      <MoreHorizontal className='size-4' />
      <span className='sr-only'>More</span>
    </span>
  )
}

export {
  Breadcrumb,
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator
}


================================================
FILE: apps/web/src/components/ui/button.tsx
================================================
import { Slot } from '@radix-ui/react-slot'
import { cva, type VariantProps } from 'class-variance-authority'
import * as React from 'react'

import { cn } from '@/lib/utils'

const buttonVariants = cva(
  "inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-all cursor-pointer disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive",
  {
    variants: {
      variant: {
        default:
          'bg-primary text-primary-foreground shadow-xs hover:bg-primary/90',
        destructive:
          'bg-destructive text-white shadow-xs hover:bg-destructive/90 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/60',
        outline:
          'border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-background dark:border-input dark:hover:bg-accent',
        secondary:
          'bg-secondary text-secondary-foreground shadow-xs hover:bg-secondary/80',
        ghost:
          'hover:bg-accent hover:text-accent-foreground dark:hover:bg-accent/50',
        link: 'text-primary underline-offset-4 hover:underline'
      },
      size: {
        default: 'h-9 px-4 py-2 has-[>svg]:px-3',
        sm: 'h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5',
        lg: 'h-10 rounded-md px-6 has-[>svg]:px-4',
        icon: 'size-9'
      }
    },
    defaultVariants: {
      variant: 'default',
      size: 'default'
    }
  }
)

export type ButtonProps = React.ComponentProps<'button'> &
  VariantProps<typeof buttonVariants> & {
    asChild?: boolean
  }

function Button({
  className,
  variant,
  size,
  asChild = false,
  ...props
}: ButtonProps) {
  const Comp = asChild ? Slot : 'button'

  return (
    <Comp
      data-slot='button'
      className={cn(buttonVariants({ variant, size, className }))}
      {...props}
    />
  )
}

export { Button, buttonVariants }


================================================
FILE: apps/web/src/components/ui/collapsible.tsx
================================================
'use client'

import * as CollapsiblePrimitive from '@radix-ui/react-collapsible'

function Collapsible({
  ...props
}: React.ComponentProps<typeof CollapsiblePrimitive.Root>) {
  return <CollapsiblePrimitive.Root data-slot='collapsible' {...props} />
}

function CollapsibleTrigger({
  ...props
}: React.ComponentProps<typeof CollapsiblePrimitive.CollapsibleTrigger>) {
  return (
    <CollapsiblePrimitive.CollapsibleTrigger
      data-slot='collapsible-trigger'
      {...props}
    />
  )
}

function CollapsibleContent({
  ...props
}: React.ComponentProps<typeof CollapsiblePrimitive.CollapsibleContent>) {
  return (
    <CollapsiblePrimitive.CollapsibleContent
      data-slot='collapsible-content'
      {...props}
    />
  )
}

export { Collapsible, CollapsibleContent, CollapsibleTrigger }


================================================
FILE: apps/web/src/components/ui/dropdown-menu.tsx
================================================
import * as DropdownMenuPrimitive from '@radix-ui/react-dropdown-menu'
import { CheckIcon, ChevronRightIcon, CircleIcon } from 'lucide-react'
import * as React from 'react'

import { cn } from '@/lib/utils'

function DropdownMenu({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Root>) {
  return <DropdownMenuPrimitive.Root data-slot='dropdown-menu' {...props} />
}

function DropdownMenuPortal({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Portal>) {
  return (
    <DropdownMenuPrimitive.Portal data-slot='dropdown-menu-portal' {...props} />
  )
}

function DropdownMenuTrigger({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Trigger>) {
  return (
    <DropdownMenuPrimitive.Trigger
      data-slot='dropdown-menu-trigger'
      {...props}
    />
  )
}

function DropdownMenuContent({
  className,
  sideOffset = 4,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Content>) {
  return (
    <DropdownMenuPrimitive.Portal>
      <DropdownMenuPrimitive.Content
        data-slot='dropdown-menu-content'
        sideOffset={sideOffset}
        className={cn(
          'bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 max-h-(--radix-dropdown-menu-content-available-height) min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-x-hidden overflow-y-auto rounded-md border p-1 shadow-md',
          className
        )}
        {...props}
      />
    </DropdownMenuPrimitive.Portal>
  )
}

function DropdownMenuGroup({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Group>) {
  return (
    <DropdownMenuPrimitive.Group data-slot='dropdown-menu-group' {...props} />
  )
}

function DropdownMenuItem({
  className,
  inset,
  variant = 'default',
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Item> & {
  inset?: boolean
  variant?: 'default' | 'destructive'
}) {
  return (
    <DropdownMenuPrimitive.Item
      data-slot='dropdown-menu-item'
      data-inset={inset}
      data-variant={variant}
      className={cn(
        "focus:bg-accent focus:text-accent-foreground data-[variant=destructive]:text-destructive data-[variant=destructive]:focus:bg-destructive/10 dark:data-[variant=destructive]:focus:bg-destructive/20 data-[variant=destructive]:focus:text-destructive data-[variant=destructive]:*:[svg]:!text-destructive [&_svg:not([class*='text-'])]:text-muted-foreground relative flex cursor-default items-center gap-2 rounded-sm px-2 py-1.5 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:pl-8 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
        className
      )}
      {...props}
    />
  )
}

function DropdownMenuCheckboxItem({
  className,
  children,
  checked,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.CheckboxItem>) {
  return (
    <DropdownMenuPrimitive.CheckboxItem
      data-slot='dropdown-menu-checkbox-item'
      className={cn(
        "focus:bg-accent focus:text-accent-foreground relative flex cursor-default items-center gap-2 rounded-sm py-1.5 pr-2 pl-8 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
        className
      )}
      checked={checked}
      {...props}
    >
      <span className='pointer-events-none absolute left-2 flex size-3.5 items-center justify-center'>
        <DropdownMenuPrimitive.ItemIndicator>
          <CheckIcon className='size-4' />
        </DropdownMenuPrimitive.ItemIndicator>
      </span>
      {children}
    </DropdownMenuPrimitive.CheckboxItem>
  )
}

function DropdownMenuRadioGroup({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.RadioGroup>) {
  return (
    <DropdownMenuPrimitive.RadioGroup
      data-slot='dropdown-menu-radio-group'
      {...props}
    />
  )
}

function DropdownMenuRadioItem({
  className,
  children,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.RadioItem>) {
  return (
    <DropdownMenuPrimitive.RadioItem
      data-slot='dropdown-menu-radio-item'
      className={cn(
        "focus:bg-accent focus:text-accent-foreground relative flex cursor-default items-center gap-2 rounded-sm py-1.5 pr-2 pl-8 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
        className
      )}
      {...props}
    >
      <span className='pointer-events-none absolute left-2 flex size-3.5 items-center justify-center'>
        <DropdownMenuPrimitive.ItemIndicator>
          <CircleIcon className='size-2 fill-current' />
        </DropdownMenuPrimitive.ItemIndicator>
      </span>
      {children}
    </DropdownMenuPrimitive.RadioItem>
  )
}

function DropdownMenuLabel({
  className,
  inset,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Label> & {
  inset?: boolean
}) {
  return (
    <DropdownMenuPrimitive.Label
      data-slot='dropdown-menu-label'
      data-inset={inset}
      className={cn(
        'px-2 py-1.5 text-sm font-medium data-[inset]:pl-8',
        className
      )}
      {...props}
    />
  )
}

function DropdownMenuSeparator({
  className,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Separator>) {
  return (
    <DropdownMenuPrimitive.Separator
      data-slot='dropdown-menu-separator'
      className={cn('bg-border -mx-1 my-1 h-px', className)}
      {...props}
    />
  )
}

function DropdownMenuShortcut({
  className,
  ...props
}: React.ComponentProps<'span'>) {
  return (
    <span
      data-slot='dropdown-menu-shortcut'
      className={cn(
        'text-muted-foreground ml-auto text-xs tracking-widest',
        className
      )}
      {...props}
    />
  )
}

function DropdownMenuSub({
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.Sub>) {
  return <DropdownMenuPrimitive.Sub data-slot='dropdown-menu-sub' {...props} />
}

function DropdownMenuSubTrigger({
  className,
  inset,
  children,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.SubTrigger> & {
  inset?: boolean
}) {
  return (
    <DropdownMenuPrimitive.SubTrigger
      data-slot='dropdown-menu-sub-trigger'
      data-inset={inset}
      className={cn(
        'focus:bg-accent focus:text-accent-foreground data-[state=open]:bg-accent data-[state=open]:text-accent-foreground flex cursor-default items-center rounded-sm px-2 py-1.5 text-sm outline-hidden select-none data-[inset]:pl-8',
        className
      )}
      {...props}
    >
      {children}
      <ChevronRightIcon className='ml-auto size-4' />
    </DropdownMenuPrimitive.SubTrigger>
  )
}

function DropdownMenuSubContent({
  className,
  ...props
}: React.ComponentProps<typeof DropdownMenuPrimitive.SubContent>) {
  return (
    <DropdownMenuPrimitive.SubContent
      data-slot='dropdown-menu-sub-content'
      className={cn(
        'bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-hidden rounded-md border p-1 shadow-lg',
        className
      )}
      {...props}
    />
  )
}

export {
  DropdownMenu,
  DropdownMenuCheckboxItem,
  DropdownMenuContent,
  DropdownMenuGroup,
  DropdownMenuItem,
  DropdownMenuLabel,
  DropdownMenuPortal,
  DropdownMenuRadioGroup,
  DropdownMenuRadioItem,
  DropdownMenuSeparator,
  DropdownMenuShortcut,
  DropdownMenuSub,
  DropdownMenuSubContent,
  DropdownMenuSubTrigger,
  DropdownMenuTrigger
}


================================================
FILE: apps/web/src/components/ui/input.tsx
================================================
import * as React from 'react'

import { cn } from '@/lib/utils'

function Input({ className, type, ...props }: React.ComponentProps<'input'>) {
  return (
    <input
      type={type}
      data-slot='input'
      className={cn(
        'file:text-foreground placeholder:text-muted-foreground selection:bg-primary selection:text-primary-foreground dark:bg-input/30 border-input flex h-9 w-full min-w-0 rounded-md border bg-transparent px-3 py-1 text-base shadow-xs transition-[color,box-shadow] outline-none file:inline-flex file:h-7 file:border-0 file:bg-transparent file:text-sm file:font-medium disabled:pointer-events-none disabled:cursor-not-allowed disabled:opacity-50 md:text-sm',
        'focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px]',
        'aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive',
        className
      )}
      {...props}
    />
  )
}

export { Input }


================================================
FILE: apps/web/src/components/ui/label.tsx
================================================
'use client'

import * as LabelPrimitive from '@radix-ui/react-label'
import * as React from 'react'

import { cn } from '@/lib/utils'

function Label({
  className,
  ...props
}: React.ComponentProps<typeof LabelPrimitive.Root>) {
  return (
    <LabelPrimitive.Root
      data-slot='label'
      className={cn(
        'flex items-center gap-2 text-sm leading-none font-medium select-none group-data-[disabled=true]:pointer-events-none group-data-[disabled=true]:opacity-50 peer-disabled:cursor-not-allowed peer-disabled:opacity-50',
        className
      )}
      {...props}
    />
  )
}

export { Label }


================================================
FILE: apps/web/src/components/ui/tabs.tsx
================================================
'use client'

import * as TabsPrimitive from '@radix-ui/react-tabs'
import * as React from 'react'

import { cn } from '@/lib/utils'

function Tabs({
  className,
  ...props
}: React.ComponentProps<typeof TabsPrimitive.Root>) {
  return (
    <TabsPrimitive.Root
      data-slot='tabs'
      className={cn('flex flex-col gap-2', className)}
      {...props}
    />
  )
}

function TabsList({
  className,
  ...props
}: React.ComponentProps<typeof TabsPrimitive.List>) {
  return (
    <TabsPrimitive.List
      data-slot='tabs-list'
      className={cn(
        'bg-muted text-muted-foreground inline-flex h-9 w-fit items-center justify-center rounded-lg p-[3px]',
        className
      )}
      {...props}
    />
  )
}

function TabsTrigger({
  className,
  ...props
}: React.ComponentProps<typeof TabsPrimitive.Trigger>) {
  return (
    <TabsPrimitive.Trigger
      data-slot='tabs-trigger'
      className={cn(
        "data-[state=active]:bg-background dark:data-[state=active]:text-foreground focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:outline-ring dark:data-[state=active]:border-input dark:data-[state=active]:bg-input/30 text-foreground dark:text-muted-foreground inline-flex h-[calc(100%-1px)] flex-1 items-center justify-center gap-1.5 rounded-md border border-transparent px-2 py-1 text-sm font-medium whitespace-nowrap transition-[color,box-shadow] focus-visible:ring-[3px] focus-visible:outline-1 disabled:pointer-events-none disabled:opacity-50 data-[state=active]:shadow-sm [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
        className
      )}
      {...props}
    />
  )
}

function TabsContent({
  className,
  ...props
}: React.ComponentProps<typeof TabsPrimitive.Content>) {
  return (
    <TabsPrimitive.Content
      data-slot='tabs-content'
      className={cn('flex-1 outline-none', className)}
      {...props}
    />
  )
}

export { Tabs, TabsContent, TabsList, TabsTrigger }


================================================
FILE: apps/web/src/components/ui/tooltip.tsx
================================================
import * as TooltipPrimitive from '@radix-ui/react-tooltip'
import * as React from 'react'

import { cn } from '@/lib/utils'

function TooltipProvider({
  delayDuration = 0,
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Provider>) {
  return (
    <TooltipPrimitive.Provider
      data-slot='tooltip-provider'
      delayDuration={delayDuration}
      {...props}
    />
  )
}

function Tooltip({
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Root>) {
  return (
    <TooltipProvider>
      <TooltipPrimitive.Root data-slot='tooltip' {...props} />
    </TooltipProvider>
  )
}

function TooltipTrigger({
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Trigger>) {
  return <TooltipPrimitive.Trigger data-slot='tooltip-trigger' {...props} />
}

function TooltipContent({
  className,
  sideOffset = 0,
  children,
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Content>) {
  return (
    <TooltipPrimitive.Portal>
      <TooltipPrimitive.Content
        data-slot='tooltip-content'
        sideOffset={sideOffset}
        className={cn(
          'bg-primary text-primary-foreground animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 w-fit origin-(--radix-tooltip-content-transform-origin) rounded-md px-3 py-1.5 text-xs text-balance',
          className
        )}
        {...props}
      >
        {children}
        <TooltipPrimitive.Arrow className='bg-primary fill-primary z-50 size-2.5 translate-y-[calc(-50%_-_2px)] rotate-45 rounded-[2px]' />
      </TooltipPrimitive.Content>
    </TooltipPrimitive.Portal>
  )
}

export { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger }


================================================
FILE: apps/web/src/icons/github.tsx
================================================
export function GitHubIcon({ className }: { className?: string }) {
  return (
    <svg
      xmlns='http://www.w3.org/2000/svg'
      viewBox='0 0 24 24'
      fill='currentColor'
      className={className}
    >
      <path d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12' />
    </svg>
  )
}


================================================
FILE: apps/web/src/icons/twitter.tsx
================================================
export function TwitterIcon({ className }: { className?: string }) {
  return (
    <svg
      role='img'
      viewBox='0 0 24 24'
      fill='currentcolor'
      className={className}
    >
      <title>X</title>
      <path d='M18.901 1.153h3.68l-8.04 9.19L24 22.846h-7.406l-5.8-7.584-6.638 7.584H.474l8.6-9.83L0 1.154h7.594l5.243 6.932ZM17.61 20.644h2.039L6.486 3.24H4.298Z' />
    </svg>
  )
}


================================================
FILE: apps/web/src/icons/typescript.tsx
================================================
import { cn } from '@/lib/utils'

export function TypeScriptIcon({ className }: { className?: string }) {
  return (
    <svg viewBox='0 0 400 400' className={cn('w-4 h-4', className)}>
      <path fill='#007acc' d='M0 200V0h400v400H0' />
      <path
        fill='#fff'
        d='M87.7 200.7V217h52v148h36.9V217h52v-16c0-9 0-16.3-.4-16.5 0-.3-31.7-.4-70.2-.4l-70 .3v16.4l-.3-.1zM321.4 184c10.2 2.4 18 7 25 14.3 3.7 4 9.2 11 9.6 12.8 0 .6-17.3 12.3-27.8 18.8-.4.3-2-1.4-3.6-4-5.2-7.4-10.5-10.6-18.8-11.2-12-.8-20 5.5-20 16 0 3.2.6 5 1.8 7.6 2.7 5.5 7.7 8.8 23.2 15.6 28.6 12.3 41 20.4 48.5 32 8.5 13 10.4 33.4 4.7 48.7-6.4 16.7-22 28-44.3 31.7-7 1.2-23 1-30.5-.3-16-3-31.3-11-40.7-21.3-3.7-4-10.8-14.7-10.4-15.4l3.8-2.4 15-8.7 11.3-6.6 2.6 3.5c3.3 5.2 10.7 12.2 15 14.6 13 6.7 30.4 5.8 39-2 3.7-3.4 5.3-7 5.3-12 0-4.6-.7-6.7-3-10.2-3.2-4.4-9.6-8-27.6-16-20.7-8.8-29.5-14.4-37.7-23-4.7-5.2-9-13.3-11-20-1.5-5.8-2-20-.6-25.7 4.3-20 19.4-34 41-38 7-1.4 23.5-.8 30.4 1l-.2.2z'
      />
    </svg>
  )
}


================================================
FILE: apps/web/src/lib/auth-copy.ts
================================================
// TODO: probably remove this in favor of a more generalized i18n system later on

export const authCopy = {
  /**
   * Error message when email is already taken.
   */
  error_email_taken: 'There is already an account with this email.',

  /**
   * Error message when the confirmation code is incorrect.
   */
  error_invalid_code: 'Code is incorrect.',

  /**
   * Error message when the email is invalid.
   */
  error_invalid_email: 'Email is not valid.',

  /**
   * Error message when the password is incorrect.
   */
  error_invalid_password: 'Password is incorrect.',

  /**
   * Error message when the passwords do not match.
   */
  error_password_mismatch: 'Passwords do not match.',

  /**
   * Error message when the user enters a password that fails validation.
   */
  error_validation_error: 'Password does not meet requirements.',

  /**
   * Title of the register page.
   */
  register_title: 'Welcome to Agentic',

  /**
   * Description of the register page.
   */
  register_description: 'Sign in with your email',

  /**
   * Title of the login page.
   */
  login_title: 'Welcome to Agentic',

  /**
   * Description of the login page.
   */
  login_description: 'Sign in with your email',

  /**
   * Copy for the register button.
   */
  register: 'Sign Up',

  /**
   * Copy for the register link.
   */
  register_prompt: "Don't have an account?",

  /**
   * Copy for the login link.
   */
  login_prompt: 'Already have an account?',

  /**
   * Copy for the login button.
   */
  login: 'Login',

  /**
   * Copy for the forgot password link.
   */
  change_prompt: 'Forgot password?',

  /**
   * Copy for the resend code button.
   */
  code_resend: 'Resend code',

  /**
   * Copy for the "Back to" link.
   */
  code_return: 'Back to',

  /**
   * Copy for the logo.
   * @internal
   */
  logo: 'A',

  /**
   * Copy for the email input.
   */
  input_email: 'Email',

  /**
   * Copy for the password input.
   */
  input_password: 'Password',

  /**
   * Copy for the code input.
   */
  input_code: 'Code',

  /**
   * Copy for the repeat password input.
   */
  input_repeat: 'Repeat password',

  /**
   * Copy for the continue button.
   */
  button_continue: 'Continue'
}


================================================
FILE: apps/web/src/lib/bootstrap.ts
================================================
import * as config from './config'

const detail = `
- ${config.githubUrl}
- ${config.twitterUrl}
`

const banner = `
 █████╗  ██████╗ ███████╗███╗   ██╗████████╗██╗ ██████╗
██╔══██╗██╔════╝ ██╔════╝████╗  ██║╚══██╔══╝██║██╔════╝
███████║██║  ███╗█████╗  ██╔██╗ ██║   ██║   ██║██║
██╔══██║██║   ██║██╔══╝  ██║╚██╗██║   ██║   ██║██║
██║  ██║╚██████╔╝███████╗██║ ╚████║   ██║   ██║╚██████╗
╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═══╝   ╚═╝   ╚═╝ ╚═════╝

${detail}
`

export function bootstrap() {
  if (config.isServer) return

  if (config.isSafari) {
    console.log(detail)
  } else {
    console.log(banner)
  }
}


================================================
FILE: apps/web/src/lib/config.ts
================================================
/* eslint-disable no-process-env */
export const isServer = globalThis.window === undefined
export const isSafari =
  !isServer && /^((?!chrome|android).)*safari/i.test(navigator.userAgent)

export const title = 'Agentic'
export const description =
  "Agentic is the App Store for LLM tools. Publish any MCP server or OpenAPI service to Agentic's MCP gateway and instantly turn it into a paid MCP product."
export const domain =
  process.env.NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL ?? 'agentic.so'

export const author = 'Travis Fischer'
export const authorTwitterUsername = 'transitive_bs'
export const copyright = `© ${new Date().getFullYear()} Agentic. All rights reserved.`

// external urls
export const twitterUrl = `https://x.com/${authorTwitterUsername}`
export const githubUrl = 'https://github.com/transitive-bullshit/agentic'
// TODO: make an agentic-specific calendar for this
export const calendarBookingUrl = 'https://cal.com/travis-fischer/15min'
export const discordUrl = 'https://discord.agentic.so'
export const emailUrl = 'mailto:travis@agentic.so'

export const keywords = [
  'agentic',
  'agentic tools',
  'MCP',
  'Model Context Protocol',
  'MCP gateway',
  'API gateway',
  'MCP marketplace',
  'MCP API gateway',
  'MCP monetization',
  'production MCPs',
  'deploy MCPs',
  'publish MCPs',
  'ai',
  'AI tools',
  'AI agents',
  'LLM tools',
  'LLM function calling',
  'LLM tool calling',
  'MCP servers',
  'MCP server provider',
  'MCP server deployment',
  'OpenAPI to MCP',
  'OpenAPI to MCP server',
  'vercel ai sdk',
  'ai sdk tools',
  'langchain tools',
  'llamaindex tools',
  'openai tools',
  'anthropic tools',
  'gemini tools'
]

export const env =
  process.env.NEXT_PUBLIC_VERCEL_ENV ?? process.env.NODE_ENV ?? 'development'
export const isVercel = !!(
  process.env.NEXT_PUBLIC_VERCEL_ENV || process.env.VERCEL
)
export const isDev = env === 'development' && !isVercel
export const isProd = env === 'production'
export const isTest = env === 'test'

export const port = process.env.PORT || '3000'
export const prodUrl = `https://${domain}`
export const baseUrl = isDev ? `http://localhost:${port}` : prodUrl
export const vercelUrl =
  process.env.VERCEL_URL ?? process.env.NEXT_PUBLIC_VERCEL_URL
// export const webBaseUrl = isDev || !vercelUrl ? baseUrl : `https://${vercelUrl}`
export const apiBaseUrl = process.env.NEXT_PUBLIC_AGENTIC_API_BASE_URL!
export const gatewayBaseUrl = process.env.NEXT_PUBLIC_AGENTIC_GATEWAY_BASE_URL!

export const posthogKey = process.env.NEXT_PUBLIC_POSTHOG_KEY!
export const posthogHost =
  process.env.NEXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com'

export const socialImageUrl = `${baseUrl}/agentic-social-image-light.jpg`


================================================
FILE: apps/web/src/lib/default-agentic-api-client.ts
================================================
import { AgenticApiClient } from '@agentic/platform-api-client'

import { apiBaseUrl } from './config'

export const defaultAgenticApiClient = new AgenticApiClient({
  apiBaseUrl
})


================================================
FILE: apps/web/src/lib/developer-config.ts
================================================
import type { Deployment, Project } from '@agentic/platform-types'
import type { BundledLanguage } from 'shiki/bundle/web'
import type { Simplify } from 'type-fest'
import { assert, pruneUndefined } from '@agentic/platform-core'

import { gatewayBaseUrl } from './config'

export const targetLabels = {
  mcp: 'MCP',
  typescript: 'TypeScript',
  python: 'Python',
  http: 'HTTP'
} as const
export const targets = Object.keys(
  targetLabels
) as (keyof typeof targetLabels)[]
export type Target = (typeof targets)[number]

export const httpTargetLabels = {
  curl: 'cURL',
  httpie: 'HTTPie'
} as const
export const httpTargets = Object.keys(
  httpTargetLabels
) as (keyof typeof httpTargetLabels)[]
export type HTTPTarget = (typeof httpTargets)[number]

export const mcpClientTargetLabels = {
  url: 'MCP Server URL',
  'mcp-json': 'mcp.json',
  cursor: 'Cursor',
  'claude-code': 'Claude Code',
  'claude-desktop': 'Claude Desktop',
  // chatgpt: 'ChatGPT', // TODO
  raycast: 'Raycast',
  trae: 'Trae',
  windsurf: 'Windsurf',
  vscode: 'VSCode',
  cline: 'Cline',
  warp: 'Warp'
} as const
export const mcpClientTargets = Object.keys(
  mcpClientTargetLabels
) as (keyof typeof mcpClientTargetLabels)[]
export type MCPClientTarget = (typeof mcpClientTargets)[number]

export const tsFrameworkTargetLabels = {
  ai: 'Vercel AI SDK',
  'openai-chat': 'OpenAI Chat',
  'openai-responses': 'OpenAI Responses',
  langchain: 'LangChain',
  llamaindex: 'LlamaIndex',
  mastra: 'Mastra',
  'firebase-genkit': 'Firebase GenKit'

  // TODO: add https://github.com/googleapis/js-genai

  // TODO: get xsai adapter working with JSON schemas (currently only standard schemas)
  // xsai: 'xsAI'
} as const
export const tsFrameworkTargets = Object.keys(
  tsFrameworkTargetLabels
) as (keyof typeof tsFrameworkTargetLabels)[]
export type TsFrameworkTarget = (typeof tsFrameworkTargets)[number]

export const pyFrameworkTargetLabels = {
  openai: 'OpenAI',
  langchain: 'LangChain',
  llamaindex: 'LlamaIndex'
} as const
export const pyFrameworkTargets = Object.keys(
  pyFrameworkTargetLabels
) as (keyof typeof pyFrameworkTargetLabels)[]
export type PyFrameworkTarget = (typeof pyFrameworkTargets)[number]

export type DeveloperConfig = {
  target: Target
  mcpClientTarget: MCPClientTarget
  tsFrameworkTarget: TsFrameworkTarget
  pyFrameworkTarget: PyFrameworkTarget
  httpTarget: HTTPTarget
}

export const defaultConfig: DeveloperConfig = {
  target: 'typescript',
  mcpClientTarget: 'url',
  tsFrameworkTarget: 'ai',
  pyFrameworkTarget: 'openai',
  httpTarget: 'curl'
}

export type CodeSnippet = {
  code: string
  lang: BundledLanguage
  action?: {
    href: string
    label: string
    logoImageUrl?: string
    logoImageUrlDark?: string
    logoImageUrlLight?: string
  }
}

export type GetCodeForDeveloperConfigOpts = {
  config: DeveloperConfig
  project: Project
  deployment: Deployment
  identifier: string
  tool?: string
  apiKey?: string
}

type GetCodeForDeveloperConfigInnerOpts = Simplify<
  GetCodeForDeveloperConfigOpts & {
    systemPrompt: string
    prompt: string
    args: Record<string, any>
  }
>

export function getCodeForDeveloperConfig(
  opts: GetCodeForDeveloperConfigOpts
): CodeSnippet {
  const { config, tool } = opts

  const toolConfig = tool
    ? opts.deployment.toolConfigs.find((toolConfig) => toolConfig.name === tool)
    : undefined
  const toolConfigExample =
    toolConfig?.examples?.find((example) => example.featured) ??
    toolConfig?.examples?.[0]

  const innerOpts: GetCodeForDeveloperConfigInnerOpts = {
    ...opts,

    // TODO: incorporate the system message into all of the example TS and
    // Python code snippets
    systemPrompt:
      toolConfigExample?.systemPrompt ??
      'You are a helpful assistant. Be as concise as possible.',

    // TODO: generate this default on the backend based on the tool's name,
    // description, inputSchema, and outputSchema
    prompt: toolConfigExample?.prompt ?? 'What is the latest news about AI?',

    // TODO: generate this default on the backend based on the tool's input
    // schema
    // TODO: if no `args` are provided, hide the `HTTP` tab?
    args: toolConfigExample?.args ?? {
      query: 'example search query'
    }
  }

  switch (config.target) {
    case 'mcp':
      return getCodeForMCPClientConfig(innerOpts)

    case 'typescript':
      return getCodeForTSFrameworkConfig(innerOpts)

    case 'python':
      return getCodeForPythonFrameworkConfig(innerOpts)

    case 'http':
      return getCodeForHTTPConfig(innerOpts)
  }
}

export function getCodeForMCPClientConfig({
  config,
  identifier,
  project,
  apiKey
}: GetCodeForDeveloperConfigInnerOpts): CodeSnippet {
  const mcpUrl = `${gatewayBaseUrl}/${identifier}/mcp${
    apiKey ? `?apiKey=${apiKey}` : ''
  }`

  const mcpConfig = {
    mcpServers: {
      [identifier]: {
        url: mcpUrl
      }
    }
  }
  const mcpConfigCode = JSON.stringify(mcpConfig, null, 2)

  const mcpRemoteConfig = {
    mcpServers: {
      [identifier]: {
        command: 'npx',
        args: ['mcp-remote', '-y', mcpUrl]
      }
    }
  }
  const mcpRemoteConfigCode = JSON.stringify(mcpRemoteConfig, null, 2)

  switch (config.mcpClientTarget) {
    case 'url':
      return {
        code: mcpUrl,
        lang: 'bash'
      }

    case 'mcp-json':
      return {
        code: mcpConfigCode,
        lang: 'json'
      }

    case 'claude-code':
      return {
        code: `claude mcp add --transport http "${identifier}" "${mcpUrl}"`,
        lang: 'bash'
      }

    case 'cursor': {
      const config = Buffer.from(JSON.stringify({ url: mcpUrl })).toString(
        'base64'
      )
      const href = `cursor://anysphere.cursor-deeplink/mcp/install?name=${identifier}&config=${config}`

      return {
        code: mcpConfigCode,
        lang: 'json',
        action: {
          href,
          label: `Add the ${identifier} MCP server to Cursor`,
          logoImageUrlLight: '/assets/mcp-clients/cursor-icon-light.svg',
          logoImageUrlDark: '/assets/mcp-clients/cursor-icon-dark.webp'
        }
      }
    }

    case 'windsurf':
      return {
        code: mcpRemoteConfigCode,
        lang: 'json'
      }

    case 'claude-desktop':
      return {
        code: mcpRemoteConfigCode,
        lang: 'json'
      }

    case 'raycast': {
      // https://manual.raycast.com/model-context-protocol
      const customMcpConfig = pruneUndefined({
        name: identifier,
        type: 'http',
        url: mcpUrl,
        description: project.lastPublishedDeployment?.description
      })
      const customMcpConfigCode = JSON.stringify(customMcpConfig)
      const href = `raycast://mcp/install?${encodeURIComponent(customMcpConfigCode)}`

      return {
        code: mcpConfigCode,
        lang: 'json',
        action: {
          href,
          label: `Add the ${identifier} MCP server to Raycast`,
          logoImageUrlLight: '/assets/mcp-clients/raycast-icon-light.svg',
          logoImageUrlDark: '/assets/mcp-clients/raycast-icon-dark.svg'
        }
      }
    }

    case 'vscode':
      return {
        code: `
"mcp": {
  "servers": {
    "${identifier}": {
      "type": "http",
      "url": "${mcpUrl}"
    }
  }
}`.trim(),
        lang: 'json'
      }

    default:
      return {
        code: mcpConfigCode,
        lang: 'json'
      }
  }
}

export function getCodeForTSFrameworkConfig({
  config,
  identifier,
  prompt,
  systemPrompt,
  apiKey
}: GetCodeForDeveloperConfigInnerOpts): CodeSnippet {
  switch (config.tsFrameworkTarget) {
    case 'ai':
      return {
        code: `
import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'

const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

const result = await generateText({
  model: openai('gpt-4o-mini'),
  tools: createAISDKTools(searchTool),
  toolChoice: 'required',
  system: '${systemPrompt}',
  prompt: '${prompt}'
})

console.log(result.toolResults[0])
      `.trim(),
        lang: 'ts'
      }

    case 'openai-chat':
      return {
        code: `
import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

const openai = new OpenAI()
const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

// This example uses OpenAI's Chat Completions API
const res = await openai.chat.completions.create({
  model: 'gpt-4o-mini',
  tools: searchTool.functions.toolSpecs,
  tool_choice: 'required',
  messages: [
    {
      role: 'user',
      content: '${prompt}'
    }
  ]
})

const message = res.choices[0]!.message!
const toolCall = message.tool_calls![0]!.function!
const toolResult = await searchTool.callTool(toolCall.name, toolCall.arguments)

console.log(toolResult)
`.trim(),
        lang: 'ts'
      }

    case 'openai-responses':
      return {
        code: `
import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

const openai = new OpenAI()
const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

// This example uses OpenAI's newer Responses API
const res = await openai.responses.create({
  model: 'gpt-4o-mini',
  tools: searchTool.functions.responsesToolSpecs,
  tool_choice: 'required',
  input: [
    {
      role: 'user',
      content: '${prompt}'
    }
  ]
})

const toolCall = res.output[0]
assert(toolCall?.type === 'function_call')
const toolResult = await searchTool.callTool(toolCall.name, toolCall.arguments)

console.log(toolResult)
`.trim(),
        lang: 'ts'
      }

    case 'langchain':
      return {
        code: `
import { createLangChainTools } from '@agentic/langchain'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { ChatPromptTemplate } from '@langchain/core/prompts'
import { ChatOpenAI } from '@langchain/openai'
import { AgentExecutor, createToolCallingAgent } from 'langchain/agents'

const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

const tools = createLangChainTools(searchTool)
const agent = createToolCallingAgent({
  llm: new ChatOpenAI({ model: 'gpt-4o-mini' }),
  tools,
  prompt: ChatPromptTemplate.fromMessages([
    ['placeholder', '{chat_history}'],
    ['human', '{input}'],
    ['placeholder', '{agent_scratchpad}']
  ])
})

const agentExecutor = new AgentExecutor({ agent, tools })

const result = await agentExecutor.invoke({
  input: '${prompt}'
})

console.log(result.output)
        `.trim(),
        lang: 'ts'
      }

    case 'llamaindex':
      return {
        code: `
import { createLlamaIndexTools } from '@agentic/llamaindex'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@llamaindex/openai'
import { agent } from '@llamaindex/workflow'

const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

const exampleAgent = agent({
  llm: openai({ model: 'gpt-4o-mini', temperature: 0 }),
  tools: createLlamaIndexTools(searchTool)
})

const response = await exampleAgent.run(
  '${prompt}'
)

console.log(response.data.result)
        `.trim(),
        lang: 'ts'
      }

    case 'mastra':
      return {
        code: `
import { createMastraTools } from '@agentic/mastra'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@ai-sdk/openai'
import { Agent } from '@mastra/core/agent'

const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

const exampleAgent = new Agent({
  name: 'Example Agent',
  model: openai('gpt-4o-mini'),
  tools: createMastraTools(searchTool),
  instructions: '${systemPrompt}'
})

const res = await exampleAgent.generate(
  '${prompt}'
)

console.log(res.text)`.trim(),
        lang: 'ts'
      }

    case 'firebase-genkit':
      return {
        code: `
import { createGenkitTools } from '@agentic/genkit'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { genkit } from 'genkit'
import { gpt4oMini, openAI } from 'genkitx-openai'

const searchTool = await AgenticToolClient.fromIdentifier('${identifier}'${
          apiKey
            ? `, {
  apiKey: '${apiKey}'
}`
            : ''
        })

const ai = genkit({
  plugins: [openAI()]
})

const result = await ai.generate({
  model: gpt4oMini,
  tools: createGenkitTools(ai, searchTool),
  prompt: '${prompt}'
})

console.log(result)`.trim(),
        lang: 'ts'
      }
  }
}

export function getCodeForPythonFrameworkConfig({
  config,
  identifier,
  prompt,
  apiKey
}: GetCodeForDeveloperConfigInnerOpts): CodeSnippet {
  const mcpUrl = `${gatewayBaseUrl}/${identifier}/mcp${
    apiKey ? `?apiKey=${apiKey}` : ''
  }`

  switch (config.pyFrameworkTarget) {
    case 'openai':
      return {
        code: `
from openai import OpenAI

client = OpenAI()

response = client.responses.create(
    model="gpt-4.1",
    tools=[
        {
            "type": "mcp",
            "server_label": "${identifier}",
            "server_url": "${mcpUrl}",
            "require_approval": "never",
        },
    ],
    input="${prompt}",
)

print(response.output_text)
        `.trim(),
        lang: 'py'
      }

    case 'langchain':
      return {
        code: `
from langchain_mcp_adapters.client import MultiServerMCPClient
from langgraph.prebuilt import create_react_agent

client = MultiServerMCPClient(
    {
        "search": {
            "url": "${mcpUrl}",
            "transport": "streamable_http",
        }
    }
)
tools = await client.get_tools()
agent = create_react_agent(
    "anthropic:claude-3-7-sonnet-latest",
    tools
)
response = await agent.ainvoke(
    {"messages": [{"role": "user", "content": "${prompt}"}]}
)`.trim(),
        lang: 'py'
      }

    case 'llamaindex':
      return {
        code: `
from llama_index.llms.openai import OpenAI
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context

from llama_index.tools.mcp import (
    get_tools_from_mcp_url,
    aget_tools_from_mcp_url,
)

tools = await aget_tools_from_mcp_url("${mcpUrl}")

llm = OpenAI(model="gpt-4o-mini")
agent = ReActAgent(tools=tools, llm=llm)
ctx = Context(agent)
response = await agent.run("${prompt}", ctx=ctx)

print(str(response))
        `.trim(),
        lang: 'py'
      }
  }
}

export function getCodeForHTTPConfig({
  config,
  identifier,
  deployment,
  tool,
  args,
  apiKey
}: GetCodeForDeveloperConfigInnerOpts): CodeSnippet {
  tool ??= deployment.tools[0]?.name
  assert(tool, 'tool is required')
  // TODO: need a way of getting example tool args

  const url = `${gatewayBaseUrl}/${identifier}/${tool}`

  switch (config.httpTarget) {
    case 'curl': {
      const formattedArgs = JSON.stringify(args).replace("'", "\\'")

      // TODO: better formatting for the curl command
      return {
        code: `curl -X POST -H "Content-Type: application/json"${
          apiKey ? ` -H "Authorization: Bearer ${apiKey}"` : ''
        } -d '${formattedArgs}' ${url}`,
        lang: 'bash'
      }
    }

    case 'httpie': {
      const formattedArgs = Object.entries(args)
        .map(([key, value]) => `${key}=${JSON.stringify(value)}`)
        .join(' ')

      return {
        code: `http ${url}${apiKey ? ` Authorization:"Bearer ${apiKey}"` : ''}${
          formattedArgs ? ` ${formattedArgs}` : ''
        }`,
        lang: 'bash'
      }
    }
  }
}


================================================
FILE: apps/web/src/lib/global-api.ts
================================================
import 'server-only'

import { AgenticApiClient } from '@agentic/platform-api-client'

import { apiBaseUrl } from '@/lib/config'

export const globalAgenticApiClient = new AgenticApiClient({
  apiBaseUrl
})


================================================
FILE: apps/web/src/lib/notifications.ts
================================================
import { HTTPError } from 'ky'
import { toast as toastImpl } from 'sonner'

export async function toastError(
  error: any,
  ctx?: {
    label?: string
  }
) {
  let message: string | undefined
  let details: Error | undefined

  if (typeof error === 'string') {
    message = error
  } else if (error instanceof Error) {
    details = error
    message = error.message

    if (error instanceof HTTPError) {
      if (error.response) {
        try {
          message = error.response.statusText

          const body = await error.response.json()
          if (typeof body.error === 'string') {
            message = body.error
          }
        } catch {
          // TODO
        }
      }
    }
  }

  console.error(...[ctx?.label, message, details].filter(Boolean))
  toastImpl.error(message, {
    duration: 10_000
  })
}

export { toast } from 'sonner'


================================================
FILE: apps/web/src/lib/query-client.ts
================================================
import {
  type DefaultError,
  type InfiniteData,
  type QueryKey,
  useInfiniteQuery as useInfiniteQueryBase,
  useQuery as useQueryBase
} from '@tanstack/react-query'
import { HTTPError } from 'ky'

const retryStatusCodes = new Set([408, 413, 429, 500, 502, 503, 504])

// Inspired by https://github.com/sindresorhus/ky#retry
function retry(failureCount: number, error: any): boolean {
  if (error instanceof HTTPError) {
    const { status } = error.response
    if (!retryStatusCodes.has(status)) {
      return false
    }
  }

  return failureCount < 3
}

export function useQuery<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey
>(
  opts: Parameters<
    typeof useQueryBase<TQueryFnData, TError, TData, TQueryKey>
  >[0]
): ReturnType<typeof useQueryBase<TQueryFnData, TError, TData, TQueryKey>> {
  return useQueryBase<TQueryFnData, TError, TData, TQueryKey>({
    retry,
    ...opts
  })
}

export function useInfiniteQuery<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown
>(
  opts: Parameters<
    typeof useInfiniteQueryBase<
      TQueryFnData,
      TError,
      TData,
      TQueryKey,
      TPageParam
    >
  >[0]
): ReturnType<
  typeof useInfiniteQueryBase<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >
> {
  return useInfiniteQueryBase<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >({
    retry,
    ...opts
  })
}


================================================
FILE: apps/web/src/lib/utils.test.ts
================================================
import { expect, test } from 'vitest'

import { pricingAmountToFixedString } from './utils'

test('pricingAmountToFixedString', () => {
  expect(pricingAmountToFixedString(0.008)).toBe('0.00008')
  expect(pricingAmountToFixedString(200)).toBe('2.00')
  expect(pricingAmountToFixedString(52_399)).toBe('523.99')
  expect(pricingAmountToFixedString(0.0)).toBe('0')
  expect(pricingAmountToFixedString(0)).toBe('0')
  expect(pricingAmountToFixedString(0.000_000_000_000_1)).toBe('0')
  expect(pricingAmountToFixedString(0.01)).toBe('0.0001')
  expect(pricingAmountToFixedString(10)).toBe('0.10')
  expect(pricingAmountToFixedString(390)).toBe('3.90')
  expect(pricingAmountToFixedString(1)).toBe('0.01')
})


================================================
FILE: apps/web/src/lib/utils.ts
================================================
import { type ClassValue, clsx } from 'clsx'
import prettyMs from 'pretty-ms'
import { twMerge } from 'tailwind-merge'

export { default as humanNumber } from 'human-number'

export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs))
}

export function randomInRange(min: number, max: number) {
  return Math.random() * (max - min) + min
}

export function pricingAmountToFixedString(amount: number): string {
  const output = (amount / 100)
    // Cap the precision to 10 because of floating point issues
    // (could remove this constraint in the future by not dividing by 100
    // and handling the precision manually if needed)
    .toFixed(10)
    .replace(/0+$/, '')
    .replace(/\.0*$/, '.00')
    // (not a $ sign, but a substitution $1)
    .replace(/(\.\d)$/, '$10')

  if (output === '0.00') {
    return '0'
  }

  return output
}

export function getRateLimitIntervalLabel(rateLimitInterval: number): string {
  const label = prettyMs(rateLimitInterval * 1000, {
    verbose: true
  })

  if (label === '1 second') {
    return 'second'
  }

  if (label === '1 minute') {
    return 'minute'
  }

  if (label === '1 hour') {
    return 'hour'
  }

  if (label === '1 day') {
    return 'day'
  }

  if (label === '1 week') {
    return 'week'
  }

  if (label === '1 month') {
    return 'month'
  }

  if (label === '1 year') {
    return 'year'
  }

  return label
}


================================================
FILE: apps/web/src/reset.d.ts
================================================
import '@fisch0920/config/ts-reset'


================================================
FILE: apps/web/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-react",
  "compilerOptions": {
    "plugins": [
      {
        "name": "next"
      }
    ],
    "rootDir": ".",
    "baseUrl": ".",
    "paths": {
      "@/public/*": ["public/*"],
      "@/*": ["src/*"]
    }
  },
  "include": [
    "src",
    "*.config.ts",
    "next-env.d.ts",
    ".next/types/**/*.ts",
    "postcss.config.mjs"
  ],
  "exclude": ["node_modules"]
}


================================================
FILE: contributing.md
================================================
# Contributing

## Project Overview

This is a monorepo for Agentic - a platform that provides API gateway services for MCP (Model Context Protocol) and OpenAPI integrations.

### Development Prequisites

- `node >= 22`
- `pnpm >= 10.12.4`
- `apps/api` requires a postgres database (can be a local one) with connection URL stored in `DATABASE_URL`
  - You'll need to initialize the database running `pnpm drizzle-kit push` from the `apps/api` directory

### Core Architecture

The platform consists of:

- **API Service** (`apps/api/`) - Platform backend API with authentication, billing, and resource management
- **Gateway Service** (`apps/gateway/`) - Cloudflare Worker that proxies requests to origin MCP/OpenAPI services
- **Website** (`apps/web/`) - Next.js site for both the marketing site and authenticated webapp
- **E2E Tests** (`apps/e2e/`) - End-to-end test suite for HTTP and MCP gateway requests
- **Shared Packages** (`packages/`) - Common utilities, types, validators, and config
- **StdLib Packages** (`stdlib/`) - TS AI SDK adapters

The gateway accepts HTTP requests at `https://gateway.agentic.so/deploymentIdentifier/tool-name` or `https://gateway.agentic.so/deploymentIdentifier/mcp` for MCP.

### Development Commands

**Main development workflow:**

- `pnpm dev` - Start all services in development mode
- `pnpm build` - Build all packages and apps (except for the website)
- `pnpm test` - Run all tests (build, format, lint, typecheck, unit, but not e2e tests)
- `pnpm clean` - Clean all build artifacts
- `pnpm run docs` - Run the local mintlify docs server
- `pnpm release` - Bump all public packages and publish them to npm

**Individual test commands:**

- `pnpm test:format` - Check code formatting with Prettier
- `pnpm test:lint` - Run ESLint across all packages
- `pnpm test:typecheck` - Run TypeScript type checking
- `pnpm test:unit` - Run unit tests with Vitest

**Code quality:**

- `pnpm fix` - Auto-fix formatting and linting issues
- `pnpm knip` - Check for unused dependencies

**E2E testing:**

- (from the `apps/e2e` directory)
- `pnpm e2e` - Run all E2E tests
- `pnpm e2e-http` - Run HTTP edge E2E tests
- `pnpm e2e-mcp` - Run MCP edge E2E tests

### Key Database Models

The system uses Drizzle ORM with PostgreSQL. Core entities:

- **User** - Platform users
- **Team** - Organizations with members and billing
- **Project** - Namespace API products comprised of immutable Deployments
- **Deployment** - Immutable instances of MCP/OpenAPI services, including gateway and pricing config
- **Consumer** - Customer subscription tracking usage and billing

### Environment Variables

Every app has a `.env.example` file, which documents required environment variables.

To run the backend API and other apps, you'll need to set up:

- Stripe
- GitHub app with OAuth credentials
- Resend
- Sentry


================================================
FILE: docs/contact.mdx
================================================
---
title: Contact
---

Agentic is currently a solo effort by [Travis Fischer](https://x.com/transitive_bs). 👋

As with MCP itself, Agentic is an active work in progress, so please reach out if you have any questions, feedback, or feature requests.

<Columns cols={2}>
  <Card
    title='DM me on Twitter / X'
    href='https://x.com/transitive_bs'
    icon='x-twitter'
  />
  <Card
    title='Send me an email'
    href='mailto:travis@agentic.so'
    icon='envelope'
  />
  <Card
    title='Schedule a call with me'
    href='https://cal.com/travis-fischer/15min'
    icon='calendar-days'
  />
</Columns>


================================================
FILE: docs/docs.json
================================================
{
  "$schema": "https://mintlify.com/docs.json",
  "name": "Agentic",
  "theme": "maple",
  "logo": {
    "dark": "/media/agentic-logo-dark.svg",
    "light": "/media/agentic-logo-light.svg"
  },
  "favicon": "/media/favicon.svg",
  "background": {
    "image": "/media/bg.png"
  },
  "appearance": {
    "mode": "light",
    "strict": true
  },
  "colors": {
    "primary": "#0D969D",
    "light": "#13D3DC",
    "dark": "#0D969D"
  },
  "navbar": {
    "links": [
      {
        "label": "Contact",
        "href": "https://agentic.so/contact",
        "icon": "envelope"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Dashboard",
      "href": "https://agentic.so/app"
    }
  },
  "banner": {
    "content": "The new Agentic MCP Marketplace is now in public beta! 🎉",
    "dismissible": true
  },
  "navigation": {
    "tabs": [
      {
        "tab": "MCP Marketplace",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["index", "marketplace/index"]
          },
          {
            "group": "TypeScript AI SDKs",
            "pages": [
              "marketplace/ts-sdks/ai-sdk",
              "marketplace/ts-sdks/openai-chat",
              "marketplace/ts-sdks/openai-responses",
              "marketplace/ts-sdks/langchain",
              "marketplace/ts-sdks/llamaindex",
              "marketplace/ts-sdks/genkit",
              "marketplace/ts-sdks/mastra"
            ]
          },
          {
            "group": "MCP Clients",
            "pages": [
              "marketplace/mcp-clients/claude-code",
              "marketplace/mcp-clients/claude-desktop",
              "marketplace/mcp-clients/cline",
              "marketplace/mcp-clients/cursor",
              "marketplace/mcp-clients/raycast",
              "marketplace/mcp-clients/trae",
              "marketplace/mcp-clients/vscode",
              "marketplace/mcp-clients/warp",
              "marketplace/mcp-clients/windsurf"
            ]
          }
        ]
      },
      {
        "tab": "Publishing MCPs",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["publishing/index", "publishing/quickstart"]
          },
          {
            "group": "Quick Start Guides",
            "pages": [
              "publishing/guides/existing-mcp-server",
              "publishing/guides/existing-openapi-service",
              "publishing/guides/ts-xmcp",
              "publishing/guides/ts-fastmcp",
              "publishing/guides/ts-modelfetch",
              "publishing/guides/ts-mcp-hono",
              "publishing/guides/ts-openapi-hono",
              "publishing/guides/py-fastmcp"
            ]
          },
          {
            "group": "Origin Servers",
            "pages": [
              "publishing/origin/index",
              "publishing/origin/metadata",
              "publishing/origin/security"
            ]
          },

          {
            "group": "Project Config",
            "pages": [
              "publishing/config/index",
              "publishing/config/auth",
              "publishing/config/pricing",
              "publishing/config/rate-limits",
              "publishing/config/caching",
              "publishing/config/tool-config",
              "publishing/config/examples"
            ]
          }
        ]
      }
    ],
    "global": {
      "anchors": [
        {
          "anchor": "Agentic",
          "href": "https://agentic.so",
          "icon": "house"
        },
        {
          "anchor": "MCP Marketplace",
          "href": "https://agentic.so/marketplace",
          "icon": "store"
        },
        {
          "anchor": "Contact",
          "href": "https://agentic.so/contact",
          "icon": "envelope"
        },
        {
          "anchor": "GitHub",
          "href": "https://github.com/transitive-bullshit/agentic",
          "icon": "github"
        }
      ]
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/transitive_bs",
      "github": "https://github.com/transitive-bullshit/agentic"
    }
  },
  "seo": {
    "metatags": {
      "keywords": "agentic, agentic tools, MCP, Model Context Protocol, MCP gateway, API gateway, MCP marketplace, MCP API gateway, MCP monetization, production MCPs, deploy MCPs, publish MCPs, ai, AI tools, AI agents, LLM tools, LLM function calling, LLM tool calling, MCP servers, MCP server provider, MCP server deployment, OpenAPI to MCP, OpenAPI to MCP server, vercel ai sdk, ai sdk tools, langchain tools, llamaindex tools, openai tools, anthropic tools, gemini tools",
      "author": "Travis Fischer",
      "og:image": "https://agentic.so/agentic-social-image-light.jpg",
      "twitter:image": "https://agentic.so/agentic-social-image-light.jpg",
      "twitter:card": "summary_large_image",
      "twitter:creator": "@transitive_bs",
      "description": "Agentic is the App Store for LLM tools. Publish any MCP server or OpenAPI service to Agentic's MCP gateway and instantly turn it into a paid MCP product."
    }
  }
}


================================================
FILE: docs/index.mdx
================================================
---
title: Agentic Docs
description: Agentic is the App Store for LLM Tools.
---

## Choose your adventure

<Columns cols={2}>
  <Card title='MCP Marketplace Docs' href='/marketplace' icon='store'>
    For developers interested in using Agentic tools in their apps.
  </Card>
  <Card title='Publishing MCP Docs' href='/publishing' icon='upload'>
    For developers interested in publishing their own MCP server or OpenAPI
    service to Agentic.
  </Card>
</Columns>


================================================
FILE: docs/inject.js
================================================
const isServer = globalThis.window === undefined
const isSafari =
  !isServer && /^((?!chrome|android).)*safari/i.test(navigator.userAgent)

if (!isServer) {
  // Workaround for nav links not being able to point to relative paths
  for (const a of document.querySelectorAll('a[href="https://agentic.so"]')) {
    a.removeAttribute('target')
  }

  for (const a of document.querySelectorAll(
    'a[href="https://agentic.so/contact"]'
  )) {
    a.removeAttribute('target')
  }

  for (const a of document.querySelectorAll(
    'a[href="https://agentic.so/marketplace"]'
  )) {
    a.removeAttribute('target')
  }

  for (const a of document.querySelectorAll(
    'a[href="https://agentic.so/app"]'
  )) {
    a.removeAttribute('target')
  }

  // document
  //   .getElementById('https://agentic.so/contact')
  //   .querySelector('.lucide-arrow-up-right')
  //   .classList.add('hidden')
}

const detail = `
- https://github.com/transitive-bullshit/agentic
- https://x.com/transitive_bs
`

const banner = `
 █████╗  ██████╗ ███████╗███╗   ██╗████████╗██╗ ██████╗
██╔══██╗██╔════╝ ██╔════╝████╗  ██║╚══██╔══╝██║██╔════╝
███████║██║  ███╗█████╗  ██╔██╗ ██║   ██║   ██║██║
██╔══██║██║   ██║██╔══╝  ██║╚██╗██║   ██║   ██║██║
██║  ██║╚██████╔╝███████╗██║ ╚████║   ██║   ██║╚██████╗
╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═══╝   ╚═╝   ╚═╝ ╚═════╝

${detail}
`

function bootstrap() {
  if (isSafari) {
    console.log(detail)
  } else {
    console.log(banner)
  }
}

bootstrap()


================================================
FILE: docs/marketplace/index.mdx
================================================
---
title: Quick Start
description: A quick start on how to use tools from Agentic's marketplace.
---

## TypeScript AI SDKs

<Columns cols={2}>
  <Card
    title='Vercel AI SDK'
    href='/marketplace/ts-sdks/ai-sdk'
    icon={
      <svg
        xmlns="http://www.w3.org/2000/svg"
        viewBox="0 0 24 25"
        fill="none"
      >
        <path fill="#000" d="m12 2.11 12 20.783H0L12 2.11Z" />
      </svg>
    }
  >
    How to use Agentic tools with the Vercel AI SDK.
  </Card>

<Card
  title='LangChain'
  href='/marketplace/ts-sdks/langchain'
  icon={
    <svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 25' fill='none'>
      <path
        fill='#000'
        d='M6.099 6.418C2.736 6.418 0 9.147 0 12.501c0 3.353 2.736 6.082 6.099 6.082H17.9c3.363 0 6.099-2.729 6.099-6.082 0-3.354-2.736-6.083-6.099-6.083H6.1Zm-.122 1.933c.493.013 1.02.25 1.273.623.368.46.478 1.067.895 1.493.56.612 1.199 1.151 1.716 1.803.49.595.838 1.293 1.143 1.997.125.234.126.52.31.72.091.12.535.448.439.564.055.12.47.286.326.403-.194.04-.413.047-.562-.107-.054.126-.182.06-.281.043a3.745 3.745 0 0 0-.025.073c-.33.022-.576-.312-.732-.565-.311-.168-.665-.27-.982-.446-.019.29.045.649-.231.836-.014.556.843.065.922.48-.061.007-.129-.01-.178.037-.223.218-.48-.164-.738-.007-.347.174-.38.316-.81.352-.023-.036-.014-.059.006-.08.12-.14.13-.305.336-.365-.212-.033-.39.083-.569.176-.232.095-.23-.215-.588.016-.04-.032-.02-.061.002-.086.091-.111.21-.127.345-.121-.663-.369-.975.45-1.281.043-.092.024-.127.107-.185.165-.05-.055-.012-.121-.01-.186-.06-.027-.135-.04-.117-.136-.117-.04-.2.03-.286.095-.08-.06.053-.15.077-.212.07-.122.23-.025.311-.113.23-.13.552.081.816.046.203.025.454-.183.352-.39-.217-.277-.179-.64-.184-.97-.026-.193-.49-.438-.625-.646-.166-.188-.295-.405-.424-.618-.467-.901-.32-2.059-.908-2.895-.266.147-.612.077-.841-.12-.124.113-.13.26-.14.417-.296-.296-.259-.856-.022-1.186.097-.13.213-.237.343-.331.029-.021.039-.042.038-.075.117-.527.576-.739 1.07-.727Zm12.407.46c.558 0 1.081.216 1.474.609.394.392.61.914.61 1.47a2.06 2.06 0 0 1-.61 1.47l-.902.9a2.08 2.08 0 0 1-.86.517l-.016.004-.005.017a2.051 2.051 0 0 1-.474.73l-.902.9a2.074 2.074 0 0 1-1.475.608 2.077 2.077 0 0 1-1.474-3.549l.902-.899c.24-.24.534-.416.858-.514l.017-.005.006-.016a2.07 2.07 0 0 1 .475-.734l.902-.9a2.074 2.074 0 0 1 1.474-.608Zm0 .897a1.18 1.18 0 0 0-.838.346l-.902.9a1.181 1.181 0 0 0-.343.925l.006.057c.032.265.149.505.337.692.13.13.273.211.447.268a.902.902 0 0 1-.053.5.884.884 0 0 1-.194.289l-.055.055a1.964 1.964 0 0 1-.78-.479 2.06 2.06 0 0 1-.576-1.097l-.01-.057-.046.036c-.03.025-.06.052-.087.08l-.903.9a1.182 1.182 0 0 0 .84 2.018c.304 0 .607-.115.838-.346l.902-.9a1.182 1.182 0 0 0-.436-1.947.972.972 0 0 1 .276-.853 2.064 2.064 0 0 1 1.372 1.592l.01.057.046-.037c.03-.025.06-.052.088-.08l.902-.9a1.183 1.183 0 0 0-.84-2.019Zm-9.973 5.157c-.079.307-.105.832-.506.847-.033.178.123.245.265.188.141-.065.209.05.256.165.218.032.54-.072.552-.33-.325-.186-.426-.541-.566-.87Z'
      />
    </svg>
  }
>
  How to use Agentic tools with LangChain's TS SDK.
</Card>

<Card
  title='OpenAI Chat Completions'
  href='/marketplace/ts-sdks/openai-chat'
  icon={
    <svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 25 25' fill='none'>
      <path
        fill='#000'
        d='M9.762 9.697v-2.28c0-.192.071-.336.238-.432l4.543-2.64c.618-.36 1.356-.528 2.117-.528 2.854 0 4.662 2.232 4.662 4.608 0 .168 0 .36-.024.552l-4.71-2.784a.791.791 0 0 0-.856 0l-5.97 3.504Zm10.608 8.88v-5.448a.804.804 0 0 0-.428-.744l-5.97-3.504 1.95-1.128a.43.43 0 0 1 .476 0l4.543 2.64c1.308.768 2.188 2.4 2.188 3.984 0 1.824-1.07 3.504-2.759 4.2Zm-12.012-4.8-1.95-1.152c-.166-.096-.238-.24-.238-.432v-5.28c0-2.568 1.95-4.512 4.59-4.512 1 0 1.927.336 2.713.936L8.787 6.073a.804.804 0 0 0-.428.744v6.96Zm4.199 2.448L9.762 14.64v-3.36l2.795-1.584 2.794 1.584v3.36l-2.794 1.584Zm1.795 7.296c-.999 0-1.926-.336-2.711-.936l4.685-2.736a.804.804 0 0 0 .429-.744v-6.96l1.974 1.152c.166.096.238.24.238.432v5.28c0 2.568-1.974 4.512-4.615 4.512Zm-5.637-5.352-4.543-2.64c-1.308-.768-2.188-2.4-2.188-3.984 0-1.848 1.094-3.504 2.782-4.2v5.472c0 .336.143.576.429.744l5.946 3.48-1.95 1.128a.43.43 0 0 1-.476 0Zm-.261 3.936c-2.688 0-4.662-2.04-4.662-4.56 0-.192.023-.384.047-.576l4.686 2.736a.79.79 0 0 0 .856 0l5.97-3.48v2.28c0 .192-.071.336-.238.432l-4.543 2.64c-.618.36-1.356.528-2.117.528Zm5.898 2.856c2.879 0 5.28-2.064 5.828-4.8 2.664-.696 4.377-3.216 4.377-5.784 0-1.68-.714-3.312-1.998-4.488.119-.504.19-1.008.19-1.512 0-3.432-2.76-6-5.947-6-.642 0-1.26.096-1.879.312A5.935 5.935 0 0 0 10.761.96c-2.878 0-5.28 2.064-5.828 4.8C2.27 6.457.557 8.977.557 11.545c0 1.68.713 3.312 1.998 4.488a6.583 6.583 0 0 0-.19 1.512c0 3.432 2.759 6 5.946 6 .642 0 1.26-.096 1.879-.312a5.934 5.934 0 0 0 4.162 1.728Z'
      />
    </svg>
  }
>
  How to use Agentic tools with the OpenAI Chat Completions API.
</Card>

<Card
  title='OpenAI Responses'
  href='/marketplace/ts-sdks/openai-responses'
  icon={
    <svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 25 25' fill='none'>
      <path
        fill='#000'
        d='M9.762 9.697v-2.28c0-.192.071-.336.238-.432l4.543-2.64c.618-.36 1.356-.528 2.117-.528 2.854 0 4.662 2.232 4.662 4.608 0 .168 0 .36-.024.552l-4.71-2.784a.791.791 0 0 0-.856 0l-5.97 3.504Zm10.608 8.88v-5.448a.804.804 0 0 0-.428-.744l-5.97-3.504 1.95-1.128a.43.43 0 0 1 .476 0l4.543 2.64c1.308.768 2.188 2.4 2.188 3.984 0 1.824-1.07 3.504-2.759 4.2Zm-12.012-4.8-1.95-1.152c-.166-.096-.238-.24-.238-.432v-5.28c0-2.568 1.95-4.512 4.59-4.512 1 0 1.927.336 2.713.936L8.787 6.073a.804.804 0 0 0-.428.744v6.96Zm4.199 2.448L9.762 14.64v-3.36l2.795-1.584 2.794 1.584v3.36l-2.794 1.584Zm1.795 7.296c-.999 0-1.926-.336-2.711-.936l4.685-2.736a.804.804 0 0 0 .429-.744v-6.96l1.974 1.152c.166.096.238.24.238.432v5.28c0 2.568-1.974 4.512-4.615 4.512Zm-5.637-5.352-4.543-2.64c-1.308-.768-2.188-2.4-2.188-3.984 0-1.848 1.094-3.504 2.782-4.2v5.472c0 .336.143.576.429.744l5.946 3.48-1.95 1.128a.43.43 0 0 1-.476 0Zm-.261 3.936c-2.688 0-4.662-2.04-4.662-4.56 0-.192.023-.384.047-.576l4.686 2.736a.79.79 0 0 0 .856 0l5.97-3.48v2.28c0 .192-.071.336-.238.432l-4.543 2.64c-.618.36-1.356.528-2.117.528Zm5.898 2.856c2.879 0 5.28-2.064 5.828-4.8 2.664-.696 4.377-3.216 4.377-5.784 0-1.68-.714-3.312-1.998-4.488.119-.504.19-1.008.19-1.512 0-3.432-2.76-6-5.947-6-.642 0-1.26.096-1.879.312A5.935 5.935 0 0 0 10.761.96c-2.878 0-5.28 2.064-5.828 4.8C2.27 6.457.557 8.977.557 11.545c0 1.68.713 3.312 1.998 4.488a6.583 6.583 0 0 0-.19 1.512c0 3.432 2.759 6 5.946 6 .642 0 1.26-.096 1.879-.312a5.934 5.934 0 0 0 4.162 1.728Z'
      />
    </svg>
  }
>
  How to use Agentic tools with the OpenAI Responses API.
</Card>

<Card
  title='Llamaindex'
  href='/marketplace/ts-sdks/llamaindex'
  icon={
    <svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 25' fill='none'>
      <g clipPath='url(#a)'>
        <mask
          id='b'
          width={24}
          height={25}
          x={0}
          y={0}
          maskUnits='userSpaceOnUse'
          style={{
            maskType: 'luminance'
          }}
        >
          <path fill='#fff' d='M24 .5H0v24h24V.5Z' />
        </mask>
        <g mask='url(#b)'>
          <path
            fill='#000'
            d='M0 5.3C0 2.649 2.133.5 4.764.5h14.293c2.63 0 4.764 2.149 4.764 4.8v14.4c0 2.651-2.133 4.8-4.764 4.8H4.764C2.133 24.5 0 22.351 0 19.7V5.3Z'
          />
          <path
            fill='url(#c)'
            d='M14.969 16.285c-1.533.682-3.195.402-3.833.177 0 .154-.007.633-.035 1.316-.028.682-.244 1.113-.349 1.244.012.426.021 1.358-.035 1.67a1.43 1.43 0 0 1-.348.676h-.941c.083-.426.406-.7.557-.782.084-.882-.08-1.647-.174-1.92-.093.332-.32 1.102-.488 1.529a4.754 4.754 0 0 1-.522.96h-.697c-.035-.427.197-.57.348-.57.07-.13.237-.54.349-1.137.111-.597-.047-1.718-.14-2.204v-1.528c-1.115-.605-1.533-1.209-1.812-1.884-.223-.54-.163-1.363-.105-1.707-.07-.13-.273-.461-.348-.924a3.869 3.869 0 0 1 0-1.351c-.07-.071-.21-.434-.21-1.315 0-.882.256-1.34.384-1.458v-.39c-.488-.036-.976-.25-1.254-.534-.28-.284-.07-.711.104-.853.174-.142.349-.036.593-.107.244-.071.453-.142.557-.355.084-.171-.081-.877-.174-1.21.418.058.685.428.767.605V3.63c.522.249 1.463.853 1.777 2.168.25 1.053.43 3.26.488 4.23 1.336.013 3.032-.192 4.565.143 1.394.305 2.022.924 2.753.924.732 0 1.15-.426 1.673-.07.523.355.802 1.35.732 2.097-.056.597-.511.793-.732.817-.279.939 0 1.837.174 2.169v1.35c.082.12.244.484.244.996s-.162.853-.244.96c.14.796-.058 1.611-.174 1.92h-.94c.11-.285.301-.356.383-.356.167-.882.046-1.695-.035-1.99-.53-.314-.872-.866-.976-1.103.012.202-.021.761-.244 1.387-.223.625-.558.995-.697 1.102v.746h-.941c0-.455.256-.545.383-.533.163-.296.558-.747.558-1.635 0-.75-.523-1.102-.906-1.778-.182-.32-.093-.723-.035-.888Z'
          />
        </g>
      </g>
      <defs>
        <linearGradient
          id='c'
          x1={6.295}
          x2={21.492}
          y1={5.122}
          y2={17.753}
          gradientUnits='userSpaceOnUse'
        >
          <stop offset={0.062} stopColor='#F6DCD9' />
          <stop offset={0.326} stopColor='#FFA5EA' />
          <stop offset={0.589} stopColor='#45DFF8' />
          <stop offset={1} stopColor='#BC8DEB' />
        </linearGradient>
        <clipPath id='a'>
          <path fill='#fff' d='M0 .5h24v24H0z' />
        </clipPath>
      </defs>
    </svg>
  }
>
  How to use Agentic tools with Llamaindex's TS SDK.
</Card>

<Card
  title='Firebase Genkit'
  href='/marketplace/ts-sdks/genkit'
  icon={
    <svg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 25'>
      <g clipPath='url(#a)'>
        <path
          fill='#000'
          d='M19.454 8.869c-.538-.748-1.778-2.285-3.68-4.569A446.88 446.88 0 0 0 13.4 1.479l-.207-.245-.113-.133-.022-.032-.01-.005L12.57.5l-.609.488a13.343 13.343 0 0 0-3.68 4.64 11.378 11.378 0 0 0-1.044 3.176 12.34 12.34 0 0 0-.12.738 11.047 11.047 0 0 0-.633-.033l-.059-.003a7.46 7.46 0 0 0-2.28.274l-.317.089-.163.286a9.63 9.63 0 0 0-1.252 4.416 9.53 9.53 0 0 0 1.583 5.625 9.573 9.573 0 0 0 4.42 3.611l.236.095.071.025.003-.001a9.59 9.59 0 0 0 3.283.574 9.496 9.496 0 0 0 3.69-.742l.008.004.313-.145a9.63 9.63 0 0 0 3.927-3.335 9.578 9.578 0 0 0 1.641-5.042c.075-2.161-.643-4.304-2.133-6.371Zm-7.083 6.695c.328 1.244.264 2.44-.19 3.558-1.136-1.12-1.968-2.352-2.476-3.665-.543-1.404-.87-2.74-.974-3.975.48.157.922.366 1.315.622 1.132.737 1.914 1.901 2.325 3.46Zm.207 6.022c.482.368.99.712 1.513 1.028a7.904 7.904 0 0 1-2.742.251 9.185 9.185 0 0 0 1.228-1.279h.001Zm1.347-6.431c-.516-1.957-1.527-3.437-3.002-4.398a7.405 7.405 0 0 0-2.194-.95 8.732 8.732 0 0 1 .09-.713 11.556 11.556 0 0 1 .91-2.765l.003-.008c.177-.358.376-.719.61-1.105l.092-.152-.003-.001a11.672 11.672 0 0 1 1.942-2.311l.288.341c.672.796 1.304 1.548 1.878 2.237 1.291 1.549 2.966 3.583 3.612 4.48 1.277 1.771 1.893 3.579 1.83 5.375a7.973 7.973 0 0 1-3.995 6.641 15.502 15.502 0 0 1-2.539-1.599c.79-1.575.952-3.28.48-5.072h-.002Zm-2.575 5.397a7.857 7.857 0 0 1-2.09 1.856 5.514 5.514 0 0 1-.243-.093l-.065-.026a7.974 7.974 0 0 1-3.635-3.01 7.938 7.938 0 0 1-1.298-4.653 7.892 7.892 0 0 1 .882-3.379c.316-.07.638-.114.96-.131l.084-.002c.162-.003.324-.003.478 0 .227.011.454.035.677.07.073 1.513.445 3.145 1.105 4.852.637 1.644 1.694 3.162 3.144 4.515l.001.001Z'
        />
      </g>
      <defs>
        <clipPath id='a'>
          <path fill='#fff' d='M0 .5h24v24H0z' />
        </clipPath>
      </defs>
    </svg>
  }
>
  How to use Agentic tools with the Firebase Genkit SDK.
</Card>

  <Card
    title='Mastra'
    href='/marketplace/ts-sdks/mastra'
    icon={
<svg
    xmlns="http://www.w3.org/2000/svg"
    viewBox="0 0 26 26"
    fill="none"
  >
    <g clipPath="url(#a)">
      <path
        stroke="#000"
        strokeWidth={1.16}
        d="M12.987 24.466c6.357 0 11.51-5.134 11.51-11.468 0-6.333-5.153-11.467-11.51-11.467-6.356 0-11.508 5.134-11.508 11.467 0 6.334 5.152 11.468 11.508 11.468Z"
      />
      <path
        stroke="#000"
        strokeWidth={1.16}
        d="M7.527 18.438c4.495 4.478 10.582 5.673 13.597 2.67 3.014-3.004 1.814-9.07-2.68-13.548C13.949 3.082 7.862 1.887 4.848 4.89c-3.015 3.004-1.815 9.07 2.68 13.547ZM8.29 13.043h9.457M10.615 15.436l4.806-4.788M15.419 15.436l-4.806-4.788"
      />
      <path
        fill="#000"
        fillRule="evenodd"
        d="M5.112 7.952C3.115 9.287 1.952 11.082 1.952 13c0 1.918 1.163 3.712 3.16 5.047 1.995 1.333 4.777 2.172 7.874 2.172 3.098 0 5.88-.84 7.875-2.172 1.997-1.335 3.16-3.129 3.16-5.047 0-1.918-1.163-3.712-3.16-5.047-1.995-1.332-4.777-2.172-7.875-2.172-3.097 0-5.88.84-7.874 2.172Zm-.527-.783c2.17-1.451 5.142-2.333 8.401-2.333 3.26 0 6.232.882 8.402 2.333 2.168 1.448 3.581 3.5 3.581 5.83s-1.413 4.382-3.58 5.83c-2.171 1.451-5.143 2.333-8.402 2.333-3.26 0-6.232-.882-8.402-2.332-2.168-1.45-3.581-3.501-3.581-5.83 0-2.33 1.413-4.383 3.58-5.831Z"
        clipRule="evenodd"
      />
    </g>
    <defs>
      <clipPath id="a">
        <path fill="#fff" d="M0 .5h26v25H0z" />
      </clipPath>
    </defs>
  </svg>
    }
  >
    How to use Agentic tools with the Mastra SDK.
  </Card>
</Columns>

## MCP Clients

<Columns cols={2}>
  <Card
    title='Cursor'
    href='/marketplace/mcp-clients/cursor'
    icon='https://agentic.so/assets/mcp-clients/cursor-icon-light.svg'
  >
    How to use Agentic tools with Cursor.
  </Card>

<Card
  title='Claude Code'
  href='/marketplace/mcp-clients/claude-code'
  icon='https://agentic.so/assets/mcp-clients/anthropic-icon-light.svg'
>
  How to use Agentic tools with Claude Code.
</Card>

<Card
  title='Claude Desktop'
  href='/marketplace/mcp-clients/claude-desktop'
  icon='https://agentic.so/assets/mcp-clients/anthropic-icon-light.svg'
>
  How to use Agentic tools with Claude Desktop.
</Card>

<Card
  title='Cline'
  href='/marketplace/mcp-clients/cline'
  icon='https://agentic.so/assets/mcp-clients/cline-icon-light.png'
>
  How to use Agentic tools with Cline.
</Card>

<Card
  title='Raycast'
  href='/marketplace/mcp-clients/raycast'
  icon='https://agentic.so/assets/mcp-clients/raycast-icon-light.svg'
>
  How to use Agentic tools with Raycast.
</Card>

<Card
  title='Trae'
  href='/marketplace/mcp-clients/trae'
  icon='https://agentic.so/assets/mcp-clients/trae-icon-light.svg'
>
  How to use Agentic tools with Trae.
</Card>

<Card
  title='VS Code'
  href='/marketplace/mcp-clients/vscode'
  icon='https://agentic.so/assets/mcp-clients/vscode-icon-light.svg'
>
  How to use Agentic tools with VS Code.
</Card>

<Card
  title='Warp'
  href='/marketplace/mcp-clients/warp'
  icon='https://agentic.so/assets/mcp-clients/warp-icon-light.png'
>
  How to use Agentic tools with Warp.
</Card>

<Card
  title='Windsurf'
  href='/marketplace/mcp-clients/windsurf'
  icon='https://agentic.so/assets/mcp-clients/windsurf-icon-light.svg'
>
  How to use Agentic tools with Windsurf.
</Card>

</Columns>

## Python AI SDKs

_Python docs are coming soon..._

## Want to publish your own MCP tools?

Agentic makes it extremely easy to publish and monetize your own MCP tools. Regardless of whether you're starting from scratch or already have an existing API, you'll be up and running with a production-ready MCP product in minutes.

Visit the [publishing docs](/publishing) to get started.


================================================
FILE: docs/marketplace/mcp-clients/claude-code.mdx
================================================
---
title: Claude Code
description: How to use Agentic tools with Claude Code as an MCP client.
---

See [Claude Code MCP docs](https://docs.anthropic.com/en/docs/claude-code/mcp) for more info.

## Example

```sh
claude mcp add --transport http "@agentic/search" "https://gateway.agentic.so/@agentic/search/mcp"
```


================================================
FILE: docs/marketplace/mcp-clients/claude-desktop.mdx
================================================
---
title: Claude Desktop
description: How to use Agentic tools with Claude Desktop as an MCP client.
---

Claude Desktop requires you to use [mcp-remote](https://github.com/geelen/mcp-remote) because it currently only supports local `stdio` MCP servers.

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://gateway.agentic.so/@agentic/search/mcp"
      ]
    }
  }
}
```

## DXT

Agentic tools don't currently support Anthropic's [Desktop Extensions (DXT)](https://www.anthropic.com/engineering/desktop-extensions) format.


================================================
FILE: docs/marketplace/mcp-clients/cline.mdx
================================================
---
title: Cline
description: How to use Agentic tools with Cline as an MCP client.
---

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "url": "https://gateway.agentic.so/@agentic/search/mcp",
      "disabled": false
    }
  }
}
```

See the [Cline MCP docs](https://docs.cline.bot/mcp/connecting-to-a-remote-server) for more details.


================================================
FILE: docs/marketplace/mcp-clients/cursor.mdx
================================================
---
title: Cursor
description: How to use Agentic tools with Cursor as an MCP client.
---

Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`

Pasting the following configuration into your Cursor `~/.cursor/mcp.json` file is the recommended approach. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "url": "https://gateway.agentic.so/@agentic/search/mcp"
    }
  }
}
```


================================================
FILE: docs/marketplace/mcp-clients/raycast.mdx
================================================
---
title: Raycast
description: How to use Agentic tools with Raycast as an MCP client.
---

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "url": "https://gateway.agentic.so/@agentic/search/mcp"
    }
  }
}
```

## Raycast Deep Link

<Frame>
  <img
    src='https://agentic.so/assets/mcp-clients/raycast-screenshot.jpg'
    alt='Raycast Deep Link'
    className='w-full rounded-lg overflow-hidden'
  />
</Frame>

See the [Raycast MCP docs](https://manual.raycast.com/model-context-protocol) for more details.


================================================
FILE: docs/marketplace/mcp-clients/trae.mdx
================================================
---
title: Trae
description: How to use Agentic tools with Trae as an MCP client.
---

Use the Add manually feature and fill in the JSON configuration information for that MCP server.

For more details, visit the [Trae documentation](https://docs.trae.ai/ide/model-context-protocol?_lang=en).

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "url": "https://gateway.agentic.so/@agentic/search/mcp"
    }
  }
}
```


================================================
FILE: docs/marketplace/mcp-clients/vscode.mdx
================================================
---
title: VS Code
description: How to use Agentic tools with VS Code as an MCP client.
---

Add the given JSON to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.

## Example

```json
"mcp": {
  "servers": {
    "@agentic/search": {
      "type": "http",
      "url": "https://gateway.agentic.so/@agentic/search/mcp"
    }
  }
}
```


================================================
FILE: docs/marketplace/mcp-clients/warp.mdx
================================================
---
title: Warp
description: How to use Agentic tools with Warp as an MCP client.
---

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "url": "https://gateway.agentic.so/@agentic/search/mcp"
    }
  }
}
```

See the [Warp MCP docs](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server) for more details.


================================================
FILE: docs/marketplace/mcp-clients/windsurf.mdx
================================================
---
title: Windsurf
description: How to use Agentic tools with Windsurf as an MCP client.
---

Windsurf requires you to use [mcp-remote](https://github.com/geelen/mcp-remote) because [they do not support the Streamable HTTP Transport](https://docs.windsurf.com/windsurf/cascade/mcp).

## Example

```json
{
  "mcpServers": {
    "@agentic/search": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://gateway.agentic.so/@agentic/search/mcp"
      ]
    }
  }
}
```


================================================
FILE: docs/marketplace/ts-sdks/ai-sdk.mdx
================================================
---
title: Vercel AI SDK
description: How to use Agentic tools with the Vercel AI SDK.
---

<Info>
  Agentic tools currently support the Vercel AI SDK v4. Support for the v5 beta
  is coming soon.
</Info>

## Install

<CodeGroup>
```bash npm
npm install ai @agentic/ai-sdk @agentic/platform-tool-client
```

```bash pnpm
pnpm add ai @agentic/ai-sdk @agentic/platform-tool-client
```

```bash bun
bun add ai @agentic/ai-sdk @agentic/platform-tool-client
```

```bash yarn
yarn add ai @agentic/ai-sdk @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { createOpenAI } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = createOpenAI({ compatibility: 'strict' })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(searchTool),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(JSON.stringify(result.toolResults[0], null, 2))
}

await main()
```

<Expandable title="Additional dependencies">
This example also uses the [@ai-sdk/openai](https://ai-sdk.dev/providers/ai-sdk-providers/openai) provider, which adds OpenAI support to the Vercel AI SDK.

_Note that OpenAI is not necessary to use Agentic; this is just an example._

<CodeGroup>
```bash npm
npm install @ai-sdk/openai dotenv
```

```bash pnpm
pnpm add @ai-sdk/openai dotenv
```

```bash bun
bun add @ai-sdk/openai dotenv
```

```bash yarn
yarn add @ai-sdk/openai dotenv
```

</CodeGroup>
</Expandable>

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/ai-sdk

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/ai-sdk/bin/weather.ts
```

## Additional resources

- [`@agentic/ai-sdk` source](https://github.com/transitive-bullshit/agentic/blob/main/stdlib/ai-sdk/src/ai-sdk.ts)
- [Vercel AI SDK docs](https://ai-sdk.dev)


================================================
FILE: docs/marketplace/ts-sdks/genkit.mdx
================================================
---
title: Firebase Genkit
description: How to use Agentic tools with the Firebase Genkit SDK.
---

## Install

<CodeGroup>
```bash npm
npm install genkit @agentic/genkit @agentic/platform-tool-client
```

```bash pnpm
pnpm add genkit @agentic/genkit @agentic/platform-tool-client
```

```bash bun
bun add genkit @agentic/genkit @agentic/platform-tool-client
```

```bash yarn
yarn add genkit @agentic/genkit @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createGenkitTools } from '@agentic/genkit'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { genkit } from 'genkit'
import { gpt4oMini, openAI } from 'genkitx-openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const ai = genkit({
    plugins: [openAI()]
  })

  const result = await ai.generate({
    model: gpt4oMini,
    tools: createGenkitTools(ai, searchTool),
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(result)
}

await main()
```

<Expandable title="Additional dependencies">
This example also uses the [genkitx-openai](https://github.com/TheFireCo/genkit-plugins/tree/main/plugins/openai) package, which adds OpenAI support to Genkit.

_Note that OpenAI is not necessary to use Agentic; this is just an example._

<CodeGroup>
```bash npm
npm install genkitx-openai dotenv
```

```bash pnpm
pnpm add genkitx-openai dotenv
```

```bash bun
bun add genkitx-openai dotenv
```

```bash yarn
yarn add genkitx-openai dotenv
```

</CodeGroup>
</Expandable>

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/genkit

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/genkit/bin/weather.ts
```

## Additional resources

- [`@agentic/genkit` source](https://github.com/transitive-bullshit/agentic/blob/main/stdlib/genkit/src/genkit.ts)
- [Firebase Genkit docs](https://firebase.google.com/docs/genkit)


================================================
FILE: docs/marketplace/ts-sdks/langchain.mdx
================================================
---
title: LangChain
description: How to use Agentic tools with the LangChain TS SDK.
---

## Install

<CodeGroup>
```bash npm
npm install langchain @langchain/core @langchain/agents @agentic/langchain @agentic/platform-tool-client
```

```bash pnpm
pnpm add langchain @langchain/core @langchain/agents @agentic/langchain @agentic/platform-tool-client
```

```bash bun
bun add langchain @langchain/core @langchain/agents @agentic/langchain @agentic/platform-tool-client
```

```bash yarn
yarn add langchain @langchain/core @langchain/agents @agentic/langchain @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createLangChainTools } from '@agentic/langchain'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { ChatPromptTemplate } from '@langchain/core/prompts'
import { ChatOpenAI } from '@langchain/openai'
import { AgentExecutor, createToolCallingAgent } from 'langchain/agents'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const tools = createLangChainTools(searchTool)
  const agent = createToolCallingAgent({
    llm: new ChatOpenAI({ model: 'gpt-4o-mini', temperature: 0 }),
    tools,
    prompt: ChatPromptTemplate.fromMessages([
      ['system', 'You are a helpful assistant. Be as concise as possible.'],
      ['placeholder', '{chat_history}'],
      ['human', '{input}'],
      ['placeholder', '{agent_scratchpad}']
    ])
  })

  const agentExecutor = new AgentExecutor({
    agent,
    tools
    // verbose: true
  })

  const result = await agentExecutor.invoke({
    input: 'What is the weather in San Francisco?'
  })

  console.log(result.output)
}

await main()
```

<Expandable title="Additional dependencies">
This example also uses the [@langchain/openai](https://js.langchain.com/docs/integrations/platforms/openai) package, which adds OpenAI support to LangChain.

_Note that OpenAI is not necessary to use Agentic; this is just an example._

<CodeGroup>
```bash npm
npm install @langchain/openai dotenv
```

```bash pnpm
pnpm add @langchain/openai dotenv
```

```bash bun
bun add @langchain/openai dotenv
```

```bash yarn
yarn add @langchain/openai dotenv
```

</CodeGroup>
</Expandable>

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/langchain

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/langchain/bin/weather.ts
```

## Additional resources

- [`@agentic/langchain` source](https://github.com/transitive-bullshit/agentic/blob/main/stdlib/langchain/src/langchain.ts)
- [LangChain TS docs](https://js.langchain.com)


================================================
FILE: docs/marketplace/ts-sdks/llamaindex.mdx
================================================
---
title: LlamaIndex
description: How to use Agentic tools with the LlamaIndex TS SDK.
---

## Install

<CodeGroup>
```bash npm
npm install llamaindex @llamaindex/workflow @agentic/llamaindex @agentic/platform-tool-client
```

```bash pnpm
pnpm add llamaindex @llamaindex/workflow @agentic/llamaindex @agentic/platform-tool-client
```

```bash bun
bun add llamaindex @llamaindex/workflow @agentic/llamaindex @agentic/platform-tool-client
```

```bash yarn
yarn add llamaindex @llamaindex/workflow @agentic/llamaindex @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createLlamaIndexTools } from '@agentic/llamaindex'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@llamaindex/openai'
import { agent } from '@llamaindex/workflow'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const tools = createLlamaIndexTools(searchTool)
  const weatherAgent = agent({
    llm: openai({ model: 'gpt-4o-mini', temperature: 0 }),
    systemPrompt: 'You are a helpful assistant. Be as concise as possible.',
    tools
  })

  const response = await weatherAgent.run(
    'What is the weather in San Francisco?'
  )

  console.log(response.data.result)
}

await main()
```

<Expandable title="Additional dependencies">
This example also uses the [@llamaindex/openai](https://ts.llamaindex.ai/docs/llamaindex/modules/models/llms/openai) provider, which adds OpenAI support to LlamaIndex.

_Note that OpenAI is not necessary to use Agentic; this is just an example._

<CodeGroup>
```bash npm
npm install @llamaindex/openai dotenv
```

```bash pnpm
pnpm add @llamaindex/openai dotenv
```

```bash bun
bun add @llamaindex/openai dotenv
```

```bash yarn
yarn add @llamaindex/openai dotenv
```

</CodeGroup>
</Expandable>

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/llamaindex

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/llamaindex/bin/weather.ts
```

## Additional resources

- [`@agentic/llamaindex` source](https://github.com/transitive-bullshit/agentic/blob/main/stdlib/llamaindex/src/llamaindex.ts)
- [LlamaIndex TS docs](https://ts.llamaindex.ai)


================================================
FILE: docs/marketplace/ts-sdks/mastra.mdx
================================================
---
title: Mastra
description: How to use Agentic tools with the Mastra AI Agent framework.
---

## Install

<CodeGroup>
```bash npm
npm install @mastra/core @agentic/mastra @agentic/platform-tool-client
```

```bash pnpm
pnpm add @mastra/core @agentic/mastra @agentic/platform-tool-client
```

```bash bun
bun add @mastra/core @agentic/mastra @agentic/platform-tool-client
```

```bash yarn
yarn add @mastra/core @agentic/mastra @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createMastraTools } from '@agentic/mastra'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@ai-sdk/openai'
import { Agent } from '@mastra/core/agent'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const weatherAgent = new Agent({
    name: 'Weather Agent',
    instructions: 'You are a helpful assistant. Be as concise as possible.',
    model: openai('gpt-4o-mini'),
    tools: createMastraTools(searchTool)
  })

  const res = await weatherAgent.generate(
    'What is the weather in San Francisco?'
  )
  console.log(res.text)
}

await main()
```

<Expandable title="Additional dependencies">
This example also uses the [@ai-sdk/openai](https://ai-sdk.dev/providers/ai-sdk-providers/openai) provider, which adds OpenAI support to Mastra.

_Note that OpenAI is not necessary to use Agentic; this is just an example._

<CodeGroup>
```bash npm
npm install @ai-sdk/openai dotenv
```

```bash pnpm
pnpm add @ai-sdk/openai dotenv
```

```bash bun
bun add @ai-sdk/openai dotenv
```

```bash yarn
yarn add @ai-sdk/openai dotenv
```

</CodeGroup>
</Expandable>

## Running this example

You can view the full source for this example here:
https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/mastra

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/mastra/bin/weather.ts
```

## Additional resources

- [`@agentic/mastra` source](https://github.com/transitive-bullshit/agentic/blob/main/stdlib/mastra/src/mastra.ts)
- [Mastra docs](https://mastra.ai)


================================================
FILE: docs/marketplace/ts-sdks/openai-chat.mdx
================================================
---
title: OpenAI Chat Completions
description: How to use Agentic tools with the OpenAI Chat Completions API.
---

<Tip>
  There's no need for an adapter with the OpenAI SDK since all agentic tools are
  compatible with OpenAI by default.
</Tip>

## Install

<CodeGroup>
```bash npm
npm install openai @agentic/platform-tool-client
```

```bash pnpm
pnpm add openai @agentic/platform-tool-client
```

```bash bun
bun add openai @agentic/platform-tool-client
```

```bash yarn
yarn add openai @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = new OpenAI()

  const messages: OpenAI.ChatCompletionMessageParam[] = [
    {
      role: 'system',
      content: 'You are a helpful assistant. Be as concise as possible.'
    },
    { role: 'user', content: 'What is the weather in San Francisco?' }
  ]

  {
    // First call to OpenAI to invoke the tool
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs,
      tool_choice: 'required'
    })

    const message = res.choices[0]!.message!
    const toolCall = message.tool_calls![0]!.function!
    const toolResult = await searchTool.callTool(
      toolCall.name,
      toolCall.arguments
    )

    messages.push(message)
    messages.push({
      role: 'tool',
      tool_call_id: message.tool_calls![0]!.id,
      content: JSON.stringify(toolResult)
    })
  }

  {
    // Second call to OpenAI to generate a text response
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs
    })
    const message = res.choices?.[0]?.message
    console.log(message?.content)
  }
}

await main()
```

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/openai

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/openai/bin/weather.ts
```

## Additional resources

- [OpenAI Chat Completions API docs](https://platform.openai.com/docs/api-reference/chat/create)
- [OpenAI Responses vs Chat Completions](https://platform.openai.com/docs/guides/responses-vs-chat-completions)
- [Using OpenAI's Responses API with Agentic](/marketplace/ts-sdks/openai-responses)


================================================
FILE: docs/marketplace/ts-sdks/openai-responses.mdx
================================================
---
title: OpenAI Responses
description: How to use Agentic tools with the OpenAI Responses API.
---

<Tip>
  There's no need for an adapter with the OpenAI SDK since all agentic tools are
  compatible with OpenAI by default.
</Tip>

## Install

<CodeGroup>
```bash npm
npm install openai @agentic/platform-tool-client
```

```bash pnpm
pnpm add openai @agentic/platform-tool-client
```

```bash bun
bun add openai @agentic/platform-tool-client
```

```bash yarn
yarn add openai @agentic/platform-tool-client
```

</CodeGroup>

## Usage

This example uses the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { assert } from '@agentic/core'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = new OpenAI()

  const messages: OpenAI.Responses.ResponseInput = [
    {
      role: 'system',
      content: 'You are a helpful assistant. Be as concise as possible.'
    },
    { role: 'user', content: 'What is the weather in San Francisco?' }
  ]

  {
    // First call to OpenAI to invoke the tool
    const res = await openai.responses.create({
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.responsesToolSpecs,
      tool_choice: 'required',
      input: messages
    })

    const toolCall = res.output[0]
    assert(toolCall?.type === 'function_call')
    const toolResult = await searchTool.callTool(
      toolCall.name,
      toolCall.arguments
    )

    messages.push(toolCall)
    messages.push({
      type: 'function_call_output',
      call_id: toolCall.call_id,
      output: JSON.stringify(toolResult)
    })
  }

  {
    // Second call to OpenAI to generate a text response
    const res = await openai.responses.create({
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.responsesToolSpecs,
      input: messages
    })

    console.log(res.output_text)
  }
}

await main()
```

## Running this example

You can view the full source for this example here: https://github.com/transitive-bullshit/agentic/tree/main/examples/ts-sdks/openai

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

<Info>
  The
  [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search)
  tool comes with a generous free tier, but once that runs out, you'll need to
  sign up for a paid plan and add an `AGENTIC_API_KEY` to your `.env` file.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
pnpm build
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/ts-sdks/openai/bin/weather-responses.ts
```

## Additional resources

- [OpenAI Chat Completions API docs](https://platform.openai.com/docs/api-reference/chat/create)
- [OpenAI Responses vs Chat Completions](https://platform.openai.com/docs/guides/responses-vs-chat-completions)
- [Using OpenAI's Chat Completion API with Agentic](/marketplace/ts-sdks/openai-chat)


================================================
FILE: docs/package.json
================================================
{
  "name": "docs",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git"
  },
  "type": "module",
  "scripts": {
    "docs": "mint dev",
    "test": "run-s test:*",
    "test:broken-links": "mint broken-links"
  },
  "devDependencies": {
    "mint": "catalog:"
  }
}


================================================
FILE: docs/publishing/config/auth.mdx
================================================
---
title: Auth
description: Configure auth for your project.
---

Ship to production fast with Agentic's free, hosted authentication. Email & password, OAuth, GitHub, Google, Twitter, etc – if your origin API requires OAuth credentials, Agentic likely already supports it, and if not, [please let us know](/contact).

Currently, Agentic supports the following auth providers:

- Email & password
- GitHub

## How it works

Your project's users will sign into Agentic, subscribe to your project using Stripe, and then be given an API key to use with their tool calls.

Agentic's MCP gateway will then track all usage of your project based on API keys.

See [Origin Metadata](/publishing/origin/metadata) for details on how Agentic's MCP gateway passes customer auth and subscription information to your origin server.

## Alpha Features

### MCP OAuth

Agentic's MCP Gateway is designed to interop with MCP's built-in OAuth support, but this functionality is currently in alpha and not enabled publicly by default. If you're interested in using your origin server's MCP authentication support, [please reach out](/contact).

### Custom OAuth Providers

Agentic's MCP Gateway is designed to support any third-party OAuth provider (Google, Twitter / X, Slack, Airtable, Shopify, etc), but this functionality is currently in alpha and not enabled publicly by default.

If you're interested in using a different OAuth provider or want your customers to use your own OAuth client credentials or custom scopes, [please reach out](/contact).


================================================
FILE: docs/publishing/config/caching.mdx
================================================
---
title: Caching
description: Configure caching for your project's tools.
---

Opt-in to caching with familiar _cache-control_ and _stale-while-revalidate_ options. MCP tool calls include caching information in their _\_meta_ fields, providing parity with standard HTTP headers.

Agentic uses Cloudflare's global edge cache for caching, which guarantees unmatched global performance.

## Enabling Caching

You can enable caching for individual tools by setting [pure](/publishing/config/tool-config#param-pure) or [cacheControl](/publishing/config/tool-config#param-cache-control) on the tool's config. See [below](#examples) for examples.

## Cache Keys

Cache keys for tool calls are generated by normalizing the tool call's input, regardless of whether the tool call was made via `HTTP POST`, `HTTP GET`, or `MCP`.

Tool call args are hashed using a stable, deterministic JSON serialization algorithm, so tool calls with "identical" JSON inputs will have identical cache keys.

## Disabling Caching

Individual tool calls can disable caching by setting the standard `Cache-Control` header to `no-store` or `no-cache`.

<Note>
  Note that by default, caching is disabled for all tools. You must explicitly
  enable caching for each tool in your Agentic project config.
</Note>

## Examples

<Tabs>
<Tab title="Pure Tool">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

// In this example, `my-tool` is marked as pure which means its responses
// will be cached aggressively for identical requests using `cache-control`
// `public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600`
export default defineConfig({
  // ...
  toolConfigs: [
    {
      name: 'my-tool',
      pure: true
    }
  ]
})
```

</Tab>

<Tab title="Custom Cache-Control">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

// In this example, `my-tool` is using a custom `Cache-Control` header to
// cache responses for 60 seconds.
export default defineConfig({
  // ...
  toolConfigs: [
    {
      name: 'my-tool',
      cacheControl: 'public, max-age=60, s-maxage=60 stale-while-revalidate=10'
    }
  ]
})
```

</Tab>

<Tab title="Disabling Caching">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

// In this example, `my-tool` results will never be cached.
// Note that this is the default behavior for all tools unless caching is
// explicitly enabled for a tool.
export default defineConfig({
  // ...
  toolConfigs: [
    {
      name: 'my-tool',
      cacheControl: 'no-cache'
    }
  ]
})
```

</Tab>

</Tabs>


================================================
FILE: docs/publishing/config/examples.mdx
================================================
---
title: Examples
description: Example starter configs for the Agentic MCP Gateway.
---

## Minimal Examples

### Basic MCP Example

<Tabs>
<Tab title="TypeScript Config">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Basic MCP Example',
  description:
    "This example shows how to configure Agentic's MCP gateway with an origin MCP server using the Streamable HTTP transport.",
  origin: {
    type: 'mcp',
    url: 'https://agentic-basic-mcp-test.onrender.com/mcp'
  }
})
```

</Tab>

<Tab title="JSON Config">

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "Basic MCP Example",
  "description": "This example shows how to configure Agentic's MCP gateway with an origin MCP server using the Streamable HTTP transport.",
  "origin": {
    "type": "mcp",
    "url": "https://agentic-basic-mcp-test.onrender.com/mcp"
  }
}
```

</Tab>
</Tabs>

### Basic OpenAPI Example

<Tabs>
<Tab title="TypeScript Config">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Basic OpenAPI Example',
  description:
    "This example shows how to configure Agentic's MCP gateway with an origin OpenAPI server.",
  origin: {
    type: 'openapi',
    url: 'https://jsonplaceholder.typicode.com',
    spec: './jsonplaceholder.json'
  }
})
```

</Tab>

<Tab title="JSON Config">

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "Basic OpenAPI Example",
  "description": "This example shows how to configure Agentic's MCP gateway with an origin OpenAPI server.",
  "origin": {
    "type": "openapi",
    "url": "https://jsonplaceholder.typicode.com",
    "spec": "./jsonplaceholder.json"
  }
}
```

</Tab>
</Tabs>

## Pricing Examples

<Tip>
  Pricing can feel a little complicated to set up. Feel free to [reach out to
  us](/contact) once you're ready to start charging for your product, and I'd be
  happy to help you set everything up.
</Tip>

### Free Monthly Pricing Example

This example shows the free monthly pricing plan which is used by default for projects that don't specify any pricing plans.

<Tabs>
<Tab title="TypeScript Config">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Free Monthly Pricing Example',
  description:
    "This example shows the free monthly pricing plan which is used by default for projects that don't specify any pricing plans.",
  origin: {
    type: 'mcp',
    url: 'https://agentic-basic-mcp-test.onrender.com/mcp'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ],
      rateLimit: {
        enabled: true,
        interval: 60,
        limit: 1000
      }
    }
  ]
})
```

</Tab>

<Tab title="JSON Config">

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "Free Monthly Pricing Example",
  "description": "This example shows the free monthly pricing plan which is used by default for projects that don't specify any pricing plans.",
  "origin": {
    "type": "mcp",
    "url": "https://agentic-basic-mcp-test.onrender.com/mcp"
  },
  "pricingPlans": [
    {
      "name": "Free",
      "slug": "free",
      "lineItems": [
        {
          "slug": "base",
          "usageType": "licensed",
          "amount": 0
        }
      ],
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000
      }
    }
  ]
}
```

</Tab>
</Tabs>

### Usage-Based Tiered Pricing Example

This example shows a pricing setup with 2 pricing plans: a free tier with a limit of 10 requests per day, and a usage-based, tiered pricing plan where you charge a different rate per request based on the total volume of requests per month.

<Tabs>
<Tab title="TypeScript Config">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Free Monthly Pricing Example',
  description:
    'This example shows a pricing configuration with 2 pricing plans: a free tier with a limit of 10 requests per day, and a usage-based tiered pricing plan with a free tier and a standard tier.',
  origin: {
    type: 'mcp',
    url: 'https://agentic-basic-mcp-test.onrender.com/mcp'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 0
        }
      ],
      // Limit free-tier requests to 10 per day
      rateLimit: {
        interval: '1d',
        limit: 10
      }
    },
    {
      name: 'Standard',
      slug: 'standard',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          // $10.00 USD base price per month
          amount: 1000 // in cents
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          tiers: [
            {
              // Free for the first 1000 requests per month
              upTo: 1000,
              unitAmount: 0 // in cents
            },
            {
              // After 10k requests, it costs $0.001 USD per request up to
              // 50k requests per month
              upTo: 50_000,
              unitAmount: 0.1 // in cents
            },
            {
              // After 50k requests, it costs $0.0008 USD per request up to
              // 500k requests per month
              upTo: 500_000,
              unitAmount: 0.08
            },
            {
              // After 500k requests, it costs $0.0006 USD per request up to
              // 2.5M requests per month
              upTo: 2_500_000,
              unitAmount: 0.06
            },
            {
              // After 2.5M requests, it costs $0.0005 USD per request, with
              // no upper bound set
              upTo: 'inf',
              unitAmount: 0.05
            }
          ]
        }
      ],
      // Rate limit set to 100 requests per second
      rateLimit: {
        interval: '1s',
        limit: 100
      }
    }
  ]
})
```

</Tab>

<Tab title="JSON Config">

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "Usage-Based Tiered Pricing Example",
  "description": "This example shows a pricing configuration with 2 pricing plans: a free tier with a limit of 10 requests per day, and a usage-based tiered pricing plan with a free tier and a standard tier.",
  "origin": {
    "type": "mcp",
    "url": "https://agentic-basic-mcp-test.onrender.com/mcp"
  },
  "pricingPlans": [
    {
      "name": "Free",
      "slug": "free",
      "lineItems": [
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "per_unit",
          "unitAmount": 0
        }
      ],
      // Limit free-tier requests to 10 per day
      "rateLimit": {
        "interval": "1d",
        "limit": 10
      }
    },
    {
      "name": "Standard",
      "slug": "standard",
      "lineItems": [
        {
          "slug": "base",
          "usageType": "licensed",
          // $10.00 USD base price per month
          "amount": 1000 // in cents
        },
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "tiered",
          "tiersMode": "volume",
          "tiers": [
            {
              // Free for the first 1000 requests per month
              "upTo": 1000,
              "unitAmount": 0 // in cents
            },
            {
              // After 10k requests, it costs $0.001 USD per request up to
              // 50k requests per month
              "upTo": 50000,
              "unitAmount": 0.1 // in cents
            },
            {
              // After 50k requests, it costs $0.0008 USD per request up to
              // 500k requests per month
              "upTo": 500000,
              "unitAmount": 0.08
            },
            {
              // After requests, it costs $0.0006 USD per request up to
              // 2.5M requests per month
              "upTo": 2500000,
              "unitAmount": 0.06
            },
            {
              // After 2.5M requests, it costs $0.0005 USD per request, with
              // no upper bound set
              "upTo": "inf",
              "unitAmount": 0.05
            }
          ]
        }
      ],
      // Rate limit set to 100 requests per second
      "rateLimit": {
        "interval": "1s",
        "limit": 100
      }
    }
  ]
}
```

</Tab>
</Tabs>

## Config Help

<Tip>
  Configuring your project can feel a little overwhelming. Feel free to [reach
  out to us](/contact) if you're considering using Agentic's MCP Gateway, and
  I'd be happy to help walk you through setting your product up for success.
</Tip>


================================================
FILE: docs/publishing/config/index.mdx
================================================
---
title: Config Overview
description: Configuring your Agentic project.
---

Every Agentic project needs a config file (`agentic.config.ts`, `agentic.config.js`, or `agentic.config.json`) to define the project's metadata, pricing, rate-limits, and any tool-specific behavior overrides.

<Tip>
  Configuring your project can feel a little overwhelming. Feel free to [reach
  out to us](/contact) if you're considering using Agentic's MCP Gateway, and
  I'd be happy to help walk you through setting your product up for success.
</Tip>

## Fields

<ResponseField name='name' type='string' required>
Display name for your project.

Max length 1024 characters.

</ResponseField>

<ResponseField name='slug' type='string' required>
Unique project slug.

Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters.

The project's fully qualified identifier will be `@namespace/slug`, where
the `namespace` is determined by the author's `username` or team slug.

If not provided, it will be derived by slugifying `name`.

</ResponseField>

<ResponseField name='description' type='string' required>
  Short description of the project.

Should be no longer than a few lines.

</ResponseField>

<ResponseField name='version' type='string'>
Optional semantic version of the project as a [semver](https://semver.org) string.

Examples: `1.0.0`, `0.0.1`, `5.0.1`, etc.

</ResponseField>

<ResponseField name='readme' type='string'>
  Optional markdown readme documenting the project (supports GitHub-flavored markdown).

A string which may be either: a URL to a remote markdown file (eg, `https://example.com/readme.md`), a local file path (eg, `./readme.md`), or a data-uri string (eg, `data:text/markdown;base64,SGVsbG8gV29ybGQ=`).

</ResponseField>

<ResponseField name='iconUrl' type='string'>
Optional logo image to use for the project. Logos should have a square aspect ratio.

A string which may be either: a URL to a remote image (eg, `https://example.com/logo.png`), a local file path (eg, `./logo.png`), or a data-uri string (eg, `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`).

</ResponseField>

<ResponseField name='sourceUrl' type='string'>
  Optional URL to the source code of the project (eg, GitHub repo).
</ResponseField>

<ResponseField name='homepageUrl' type='string'>
  Optional URL to the product's homepage.
</ResponseField>

<ResponseField name='origin' type='object' required>
  Origin API adapter used to configure the origin API server downstream from
  Agentic's MCP gateway.

<Expandable title="properties" defaultOpen>
<Tabs>
  <Tab title="MCP origin server">
    <ResponseField name="type" type="string" required>
      The type of origin server. `mcp` in this case.
    </ResponseField>

    <ResponseField name="url" type="string" required>

Required base URL of the externally hosted origin MCP server.

This URL must be accessible from Agentic's MCP gateway and support the Streamable HTTP transport.

Must be a valid `https` URL.

</ResponseField>

  </Tab>

  <Tab title="OpenAPI origin server">
    <ResponseField name="type" type="string" required>
      The type of origin server. `openapi` in this case.
    </ResponseField>

    <ResponseField name="url" type="string" required>

Required base URL of the externally hosted origin API server.

Must be a valid `https` URL.

</ResponseField>

    <ResponseField name="spec" type="string" required>

Local file path or URL to an OpenAPI 3.x spec describing the origin API server.

May also be an embedded string containing a JSON stringified OpenAPI 3.x spec.

Note that older OpenAPI versions are not supported.

</ResponseField>
  </Tab>
</Tabs>
</Expandable>
</ResponseField>

<ResponseField name='pricingPlans' type='array'>
  List of PricingPlans configuring which Stripe subscriptions should be available for the project.

Defaults to a single free plan which is useful for developing and testing your project.

See [PricingPlan](/publishing/config/pricing#pricing-plan) for details.

</ResponseField>

<ResponseField name='pricingIntervals' type='array'>
Optional list of billing intervals to enable in pricing plans.

Defaults to a single monthly interval `['month']`.

To add support for annual pricing plans, for example, you can use:
`['month', 'year']`.

Note that for every pricing interval, you must define a corresponding set
of PricingPlans in the `pricingPlans` array. If you only have one pricing
interval (like the default `month` interval), `pricingPlans` don't need to
specify their `interval` property. Otherwise, all PricingPlans must
specify their `interval` property to differentiate between different
pricing intervals.

</ResponseField>

<ResponseField name='defaultRateLimit' type='object'>
Optional default rate limits to enforce across all pricing plans.

If not set, a default platform rate-limit of 1000 requests per minute per customer will be used.

To disable the default rate-limit, set `defaultRateLimit.enabled` to
`false`.

Note that pricing-plan-specific rate-limits override this default (via
`pricingPlans`), and tool-specific rate-limits may override both default
and pricing-plan-specific rate-limits (via `toolConfigs`).

See [Rate Limits](/publishing/config/rate-limits) for more details.

</ResponseField>

<ResponseField name='toolConfigs' type='array'>
Optional list of tool configs to override the default behavior of specific tools.

See [Tool Config](/publishing/config/tool-config) for details.

</ResponseField>

## Examples

<Card
  title='Config Examples'
  href='/publishing/config/examples'
  icon='file-lines'
>
  Example starter configs for the Agentic MCP Gateway.
</Card>

## Help

<Tip>
  Configuring your project can feel a little overwhelming. Feel free to [reach
  out to us](/contact) if you're considering using Agentic's MCP Gateway, and
  I'd be happy to help walk you through setting your product up for success.
</Tip>


================================================
FILE: docs/publishing/config/pricing.mdx
================================================
---
title: Pricing
description: Configure pricing for your product.
---

Charge for your Agentic product with a flexible, declarative pricing model built on top of [Stripe](https://stripe.com)'s subscription billing.

Agentic supports almost any combination of **fixed** and **usage-based billing** billing models, both at the MCP level, at the tool-call level, and at the custom metric level (e.g., tokens, image transformations, etc).

<Tip>
  Pricing can feel a little complicated to set up. Feel free to [reach out to
  us](/contact) once you're ready to start charging for your product, and I'd be
  happy to help you set everything up.
</Tip>

## Pricing Plan

<ResponseField name="name" type="string" required>
Display name for the pricing plan.

Examples: "Free", "Starter Monthly", "Pro Annual", etc.

</ResponseField>

<ResponseField name='slug' type='string' required>
A unique slug for the pricing plan which acts as a stable identifier across deployments.

Should be lower-kebab-cased.
Should be stable across deployments.

For all plans aside from `free`, the `slug` should include the `interval`
as a suffix so pricing plans can be uniquely differentiated from each
other across billing intervals.

Examples: `free`, `starter-monthly`, `pro-annual`, etc.

</ResponseField>

<ResponseField name='interval' type='string' default='month'>
The frequency at which this subscription is billed.

One of `day`, `week`, `month`, or `year`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-recurring-interval)

</ResponseField>

<ResponseField name='description' type='string'>
  Optional description of the pricing plan (UI-only).
</ResponseField>

<ResponseField name='features' type='array'>
  Optional list of features of the pricing plan (UI-only; array of strings).
</ResponseField>

<ResponseField name='trialPeriodDays' type='number'>
  Optional number of days for a free trial period when a customer signs up for a
  new subscription.

[Stripe docs](https://docs.stripe.com/api/subscriptions/create?api-version=2025-06-30#create_subscription-trial_period_days)

</ResponseField>

<ResponseField name='rateLimit' type='object'>
Optional rate limit to enforce for customers on this pricing plan.

You can use this to limit the number of API requests that can be made by
a customer during a given interval.

If not set, the pricing plan will inherit the default platform rate-limit
set by `defaultRateLimit` in the Agentic project config.

You can disable rate-limiting for this pricing plan by setting
`rateLimit.enabled` to `false`.

See [Rate Limits](/publishing/config/rate-limits) for more details.

</ResponseField>

<ResponseField name='lineItems' type='array' required>
List of LineItems which are included in the PricingPlan.

Note: Agentic currently supports a max of 20 LineItems per pricing plan.

See [PricingPlanLineItem](#pricing-plan-line-item) for details.

</ResponseField>

## Pricing Plan Line Item

Each Pricing Plan Line Item corresponds to one [Stripe Product](https://docs.stripe.com/api/products/object?api-version=2025-06-30), one [Stripe Price](https://docs.stripe.com/api/prices/object?api-version=2025-06-30), and possibly one [Stripe Meter](https://docs.stripe.com/api/billing/meter/object?api-version=2025-06-30) if the line-item is `metered`.

<ResponseField name='slug' type='string' required>
Slugs act as the primary key for LineItems. They should be lower-cased and
kebab-cased ("base", "requests", "image-transformations").

The `base` slug is reserved for a plan's default `licensed` line-item.

The `requests` slug is reserved for charging using `metered` billing based
on the number of request made during a given billing interval.

All other PricingPlanLineItem `slugs` are considered custom LineItems.

Should be stable across deployments, so if a slug refers to one type of
product / line-item / metric in one deployment, it should refer to the same
product / line-item / metric in future deployments, even if they are
configured differently. If you are switching between a licensed and metered
line-item across deployments, they must use different slugs.

</ResponseField>

<ResponseField name='label' type='string'>
Optional label for the line-item which will be displayed on customer bills.

If unset, the line-item's `slug` will be used as the label.

[Stripe Docs](https://docs.stripe.com/api/products/object?api-version=2025-02-24.acacia#product_object-unit_label)

</ResponseField>

<ResponseField name='usageType' type='string' required>
  The type of usage to charge for. Either `licensed` or `metered`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-recurring-usage_type)

</ResponseField>

<Tabs>
<Tab title="Licensed Line Item">
Licensed line-items are used to charge for **fixed-price services**.

<ResponseField name='usageType' type='string' required>
  The type of usage to charge for. `licensed` in this case.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-recurring-usage_type)

</ResponseField>

<ResponseField name='amount' type='number' required>
The fixed amount to charge per billing interval.

Specified in the smallest currency unit (e.g. cents for USD).

So 100 = \$1.00 USD, 1000 = \$10.00 USD, etc.

[Stripe docs](https://docs.stripe.com/api/prices/create?api-version=2025-06-30#create_price-unit_amount)

</ResponseField>
</Tab>

<Tab title="Metered Line Item">
Metered line-items are used to charge for **usage-based services**.

<ResponseField name='usageType' type='string' required>
  The type of usage to charge for. `metered` in this case.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-recurring-usage_type)

</ResponseField>

<ResponseField name='unitLabel' type='string'>
Optional label for the line-item which will be displayed on customer bills.

If unset, the line-item's `slug` will be used as the unit label.

[Stripe Docs](https://docs.stripe.com/api/products/object?api-version=2025-02-24.acacia#product_object-unit_label)

</ResponseField>

<ResponseField name='billingScheme' type='string' required>
Describes how to compute the price per period. Either `per_unit` or `tiered`.

`per_unit` indicates that the fixed amount (specified in `unitAmount`) will be charged per unit of total usage.

`tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using `tiers` and `tiersMode`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-billing_scheme)

</ResponseField>

<ResponseField name='unitAmount' type='number' required>
The fixed amount to charge per unit of usage.

Only applicable for `per_unit` billing schemes.

Specified in the smallest currency unit (e.g. cents for USD).

So 100 = \$1.00 USD, 1000 = \$10.00 USD, etc.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-unit_amount)

</ResponseField>

<ResponseField name='tiersMode' type='string'>
Defines if the tiering price should be `graduated` or `volume` based.

In `volume`-based tiering, the maximum quantity within a period
determines the per unit price.

In `graduated`-based tiering, the per-unit price changes successively
as the quantity grows.

This field requires `billingScheme` to be set to `tiered`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-tiers_mode)

</ResponseField>

<ResponseField name='tiers' type='array'>
Pricing tiers for `tiered` billing schemes.

This field requires `billingScheme` to be set to `tiered`.

One of `unitAmount` or `flatAmount` must be provided, but not both.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-tiers)

<Expandable title="properties">
<ResponseField name='upTo' type='number' required>
  The maximum quantity of usage for this tier.

Should be a number or `inf` for the maximum tier.

</ResponseField>

<ResponseField name='unitAmount' type='number'>
The fixed amount to charge per unit of usage for this pricing tier.

Specified in the smallest currency unit (e.g. cents for USD).

So 100 = \$1.00 USD, 1000 = \$10.00 USD, etc.

</ResponseField>

<ResponseField name='flatAmount' type='number'>
The fixed amount to charge per billing interval for this pricing tier.

Specified in the smallest currency unit (e.g. cents for USD).

So 100 = \$1.00 USD, 1000 = \$10.00 USD, etc.

</ResponseField>

</Expandable>

</ResponseField>

<ResponseField name='defaultAggregation' type='object' default="{ formula: 'sum' }">
Specifies how events are aggregated for the Stripe Meter.

[Stripe docs](https://docs.stripe.com/api/billing/meter/create?api-version=2025-02-24.acacia#create_billing_meter-default_aggregation)

<Expandable title="properties">
<ResponseField name='formula' type='string' default='sum' required>
Specifies how events are aggregated for a Stripe Meter.

Allowed values:

- `sum` - Sum each event's value during the period.
- `count` - Count the number of events during the period.

If not set, `sum` will be used.

  </ResponseField>

</Expandable>

</ResponseField>

<ResponseField name='transformQuantity' type='object'>
Optional transformation to apply to the reported usage or set quantity before computing the amount billed.

Cannot be combined with `tiers`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-transform_quantity)

<Expandable title="properties">
<ResponseField name='divideBy' type='number' required>
Divide usage by this number.

Must be a positive number.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-transform_quantity-divide_by)

</ResponseField>

<ResponseField name='round' type='string' required>
After division, either round the result `up` or `down`.

[Stripe docs](https://docs.stripe.com/api/prices/object?api-version=2025-02-24.acacia#price_object-transform_quantity-round)

</ResponseField>

</Expandable>

</ResponseField>

</Tab>

</Tabs>

## Example Pricing Plans

<Tabs>
<Tab title="Default Free Plan">

This example shows a free monthly pricing plan which is used by default for projects that don't specify any pricing plans.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  // ...
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ]
    }
  ]
})
```

</Tab>

<Tab title="Freemium + $4.99 Basic Plan">

This example has 2 pricing plans, the default free plan and a fixed-price $4.99 / month basic plan with a 7-day trial.

```ts agentic.config.ts
import { defaultFreePricingPlan, defineConfig } from '@agentic/platform'

export default defineConfig({
  // ...
  pricingPlans: [
    defaultFreePricingPlan,
    {
      name: 'Basic',
      slug: 'basic',
      trialPeriodDays: 7,
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 499 // $4.99 USD
        }
      ]
    }
  ]
})
```

</Tab>

<Tab title="Pay-As-You-Go">

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  // ...
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ],
      // Free but limited to 20 requests per day
      rateLimit: {
        limit: 20,
        interval: '1d'
      }
    },
    {
      name: 'Pay-As-You-Go',
      slug: 'pay-as-you-go',
      lineItems: [
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          // $0.00467 USD per request up to 999 requests per month
          // then $0.00053 USD for unlimited further requests that month
          tiers: [
            {
              upTo: 999,
              unitAmount: 0.467
            },
            {
              upTo: 'inf',
              unitAmount: 0.053
            }
          ]
        }
      ],
      // Limit to 1000 requests per day
      rateLimit: {
        limit: 1000,
        interval: '1d'
      }
    }
  ]
})
```

</Tab>

</Tabs>

## Declarative Pricing

<Info>
  Agentic takes care of creating and managing all Stripe resources for you based
  on your project's simple declarative JSON-based pricing config.

Every time you make a chance to your project's pricing and create a new deployment, Agentic will lazily upsert any related Stripe resources (products, prices, meters, subscriptions, customers, etc).

If a particular Stripe resource hasn't changed between deployments, Agentic will continue using the existing Stripe resources, which is important for customers who may have signed up for subscriptions before you made a change to your pricing.

</Info>

## Pricing Help

<Tip>
  Pricing can feel a little complicated to set up. Feel free to [reach out to
  us](/contact) once you're ready to start charging for your product, and I'd be
  happy to help you set everything up.
</Tip>


================================================
FILE: docs/publishing/config/rate-limits.mdx
================================================
---
title: Rate Limits
description: Configure rate-limits for your project.
---

Agentic's durable rate-limiting is built on top of Cloudflare's global infrastructure. Customize the default rate-limits, change them based on a customer's pricing plan, or create custom tool-specific overrides.

## Rate Limit

<ResponseField name='enabled' type='boolean' required>
  Whether or not this rate limit is enabled.
</ResponseField>

<ResponseField name="interval" type="string" required>
  The interval at which the rate limit is applied.

Either a positive integer expressed in seconds or a valid positive [ms](https://github.com/vercel/ms) string (eg, `10s`, `1m`, `8h`, `2d`, `1w`, `1y`, etc).

</ResponseField>

<ResponseField name='limit' type='number' required>
  The maximum number of API requests per interval (unitless).
</ResponseField>

<ResponseField name="mode" type="string" default="approximate">
  How to enforce the rate limit: `strict` (more precise but slower) or `approximate` (the default; faster and asynchronous but less precise).

The default rate-limiting mode is `approximate`, which means that requests
are allowed to proceed immediately, with the limit being enforced
asynchronously in the background. This is faster than `strict` mode, but it is less consistent if precise adherence to rate-limits is required.

With `strict` mode, customer requests are blocked until the current limit has
been confirmed. The downside with this approach is that it introduces
more latency to every request by default. The advantage is that it is
more precise and consistent.

</ResponseField>

## Example Rate Limits

<Tabs>
<Tab title="Default">

The default platform rate limit for `requests` is a limit of 1000 requests per minute per customer.

```ts
{
  enabled: true,
  interval: '1m',
  limit: 1000
}
```

</Tab>

<Tab title="Strict daily">

This example rate limit restricts customers to 100 requests per day. It uses `strict` mode which adds a little extra latency but guarantees that customers will never exceed the limit.

```ts
{
  enabled: true,
  interval: '1d',
  limit: 100,
  mode: 'strict'
}
```

</Tab>

<Tab title="Disabled">

This is an example of a disabled rate limit.

```ts
{
  enabled: false
}
```

</Tab>

</Tabs>


================================================
FILE: docs/publishing/config/tool-config.mdx
================================================
---
title: Tool Config
description: Configure tool-specific settings for your project.
---

`toolConfigs` is an optional array of tool configs which may be used to override the default gateway behavior for specific tools.

With `toolConfigs`, tools can be disabled, set custom rate-limits, customize reporting usage for metered billing, and they can also override behavior for different pricing plans.

For example, you may want to disable certain tools on a `free` pricing plan or remove the rate-limit for a specific tool on a `pro` pricing plan while keeping the defualt rate-limit in place for other tools.

Note that tool-specific configs override the defaults defined in pricing plans.

If a tool is defined on the origin server but not specified in `toolConfigs`, it will use the default behavior of the Agentic MCP gateway.

## Tool Config

<ResponseField name='name' type='string' required>
  The name of the tool, which acts as a unique, stable identifier for the tool
  across deployments.

Make sure the tool `name` matches the origin server's tool names, either via its MCP server or OpenAPI operationIds.

</ResponseField>

<ResponseField name='enabled' type='boolean' default='true'>
Whether this tool should be enabled for all customers (default).

If you want to hide a tool from customers but still have it present on your origin server, set this to `false` for the given tool.

</ResponseField>

<ResponseField name='pure' type='boolean' default='false'>
Whether this tool's output is deterministic and idempotent given the same input.

If `true`, tool outputs will be cached aggressively for identical requests, though origin server response headers can still override this behavior on a per-request basis.

If `false`, tool outputs will be cached according to the origin server's response headers on a per-request basis.

</ResponseField>

<ResponseField name='cacheControl' type='string'>
A custom `Cache-Control` header to use for caching this tool's responses.

If set, this field overrides `pure`.

If not set and `pure` is `true`, the gateway will default to: `public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600` (cache publicly for up to 1 year).

If not set and `pure` is `false`, the gateway will default to `no-store` which will disable caching. This is the default gateway behavior for tools (no caching).

Note that origin server response headers may also choose to disable caching on a per-request basis.

</ResponseField>

<ResponseField name='reportUsage' type='boolean' default='true'>
Whether calls to this tool should be reported as usage for the default `requests` line-item's metered billing.

Note: This is only relevant if the customer's active pricing plan includes a `requests` line-item.

</ResponseField>

<ResponseField name='rateLimit' type='object'>
Customize the default `requests`-based rate-limiting for this tool.

To disable rate-limiting for this tool, set `rateLimit.enabled` to `false`.

If not set, the default rate-limiting for the active pricing plan will be used.

See [Rate Limits](/publishing/config/rate-limits) for details.

</ResponseField>

<ResponseField name='inputSchemaAdditionalProperties' type='boolean'>
Whether to allow additional properties in the tool's input schema.

The default MCP spec allows additional properties. Set this to `false` if you want your tool to be more strict.

Note: This is only relevant if the tool has defined an `inputSchema`.

</ResponseField>

<ResponseField name='outputSchemaAdditionalProperties' type='boolean'>
Whether to allow additional properties in the tool's output schema.

The default MCP spec allows additional properties. Set this to `false` if you want your tool to be more strict.

Note: This is only relevant if the tool has defined an `outputSchema`.

</ResponseField>

<ResponseField name='pricingPlanOverrides' type='object'>
Allows you to override this tool's behavior or disable it entirely for different pricing plans.

This is a map from PricingPlan `slug` to PricingPlanToolOverride.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

// In this example, `my-tool` is disabled for the `free` pricing plan.
export default defineConfig({
  // ...
  toolConfigs: [
    {
      name: 'my-tool',
      pricingPlanOverridesMap: {
        free: {
          enabled: false
        }
      }
    }
  ]
})
```

<Expandable title="PricingPlanToolOverride">
  <ResponseField name='enabled' type='boolean'>
    Whether this tool should be enabled for the given pricing plan.

    If `undefined`, will use the tool's default enabled state.

  </ResponseField>

  <ResponseField name='reportUsage' type='boolean'>
    Whether to report default `requests` usage for metered billing for customers on a given pricing plan.

    Note: This is only relevant if the pricing plan includes a `requests` line-item.

    If `undefined`, will use the tool's default reportUsage state.

  </ResponseField>

  <ResponseField name='rateLimit' type='object'>
Customize or disable rate limits for this tool for customers on a given pricing plan.

To disable rate-limiting for this tool on a given pricing plan, set `rateLimit.enabled` to `false`.

See [Rate Limits](/publishing/config/rate-limits) for details.

  </ResponseField>

</Expandable>

</ResponseField>

## Config Help

<Tip>
  Configuring your project can feel a little overwhelming with the amount of
  options available. Feel free to [reach out to us](/contact) if you're
  considering using Agentic's MCP Gateway, and I'd be happy to help walk you
  through setting your product up for success.
</Tip>


================================================
FILE: docs/publishing/guides/existing-mcp-server.mdx
================================================
---
title: Existing MCP Server
description: This guide will show you how to publish an existing MCP server to Agentic.
---

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

## 1. Install the Agentic CLI

<CodeGroup>

```bash npm
npm i -g @agentic/cli
```

```bash pnpm
pnpm i -g @agentic/cli
```

```bash bun
bun install -g @agentic/cli
```

```bash yarn
yarn global add @agentic/cli
```

</CodeGroup>

## 2. Log in or create an account

<Tabs>
<Tab title="GitHub">

The `agentic` CLI defaults to using GitHub for authentication.

```bash
agentic login
```

</Tab>

<Tab title="Username & password">
```bash
agentic login -e <email> -p <password>
# or
agentic signup -e <email> -p <password> -u <username>
```
</Tab>

</Tabs>

## 3. Add an Agentic config to your project

<Info>
  Make sure your remote MCP server is deployed to a publicly accessible `https`
  URL and that the URL supports the Streamable HTTP transport.
</Info>

Your agentic config either be an `agentic.config.ts` file or an `agentic.config.json` file. The advantage of using a `ts` file is that you get full autocomplete and type safety.

<Tabs>
<Tab title="TypeScript">

First, install the `@agentic/platform` package as a dev dependency.

<CodeGroup>

```bash npm
npm i -save-dev @agentic/platform
```

```bash pnpm
pnpm add -D @agentic/platform
```

```bash bun
bun add -d @agentic/platform
```

</CodeGroup>

This package exports a `defineConfig` function which makes your config fully-typed and adds nice autocomplete.

Now, create an `agentic.config.ts` file in the root of your project's source.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: '<Your Project Name>',
  description: '<A brief description of your project>',
  origin: {
    type: 'mcp',
    url: '<Your Remote MCP Server URL>'
  }
})
```

</Tab>

<Tab title="JSON">

Create an `agentic.config.json` file in the root of your project's source.

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "<Your Project Name>",
  "description": "<Your Project Description>",
  "origin": {
    "type": "mcp",
    "url": "<Your Remote MCP Server URL>"
  }
}
```

</Tab>

</Tabs>

## 4. Deploy your project

From the directory where your `agentic.config.ts` or `agentic.config.json` file is located, run:

```bash
agentic deploy
```

Every time you make a change to your project, you can run `agentic deploy` which will create a new immutable preview deployment. These deployments will not affect any published products you may have until you publish them by running `agentic publish`.

<Info>
  You'll soon be able to configure a GitHub repository to automatically deploy
  your project on changes. Please [let me know](/contact) if you'd like me to
  prioritize this feature.
</Info>

<Note>
  The returned deployment will not have any information about your origin
  server, because the origin is considered hidden once deployed to Agentic's MCP
  gateway.
</Note>

<Expandable title="example output">

```json
{
  "id": "depl_kf4c3o8efh2y84dp5iwsha95",
  "createdAt": "2025-06-28 05:38:34.960754+00",
  "updatedAt": "2025-06-28 05:38:34.960754+00",
  "identifier": "@dev/search@42ad78bf",
  "hash": "42ad78bf",
  "published": false,
  "description": "Official Google Search tool. Useful for finding up-to-date news and information about any topic.",
  "readme": "",
  "userId": "user_bhlpuiioipxilpuq7xaoh1ae",
  "projectId": "proj_rxs9jorlwolc3seq8enqgrgc",
  "tools": [
    {
      "name": "search",
      "description": "Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.",
      "inputSchema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "num": {
            "type": "integer",
            "default": 5,
            "description": "Number of results to return"
          },
          "type": {
            "enum": [
              "search",
              "images",
              "videos",
              "places",
              "news",
              "shopping"
            ],
            "type": "string",
            "default": "search",
            "description": "Type of Google search to perform"
          },
          "query": {
            "type": "string",
            "description": "Search query"
          }
        },
        "required": ["query"],
        "additionalProperties": false
      },
      "outputSchema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "news": {},
          "images": {},
          "places": {},
          "videos": {},
          "results": {},
          "shopping": {},
          "answerBox": {},
          "knowledgeGraph": {}
        },
        "additionalProperties": false
      }
    }
  ],
  "toolConfigs": [
    {
      "name": "search",
      "cacheControl": "public, max-age=60, s-maxage=60 stale-while-revalidate=10"
    }
  ],
  "pricingPlans": [
    {
      "name": "Free",
      "slug": "free",
      "rateLimit": {
        "interval": 86400,
        "limit": 10,
        "mode": "approximate",
        "enabled": true
      },
      "lineItems": [
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "per_unit",
          "unitAmount": 0
        }
      ]
    },
    {
      "name": "Standard",
      "slug": "standard",
      "interval": "month",
      "rateLimit": {
        "interval": 1,
        "limit": 100,
        "mode": "approximate",
        "enabled": true
      },
      "lineItems": [
        {
          "slug": "base",
          "usageType": "licensed",
          "amount": 1000
        },
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "tiered",
          "tiersMode": "volume",
          "tiers": [
            {
              "unitAmount": 0,
              "upTo": 1000
            },
            {
              "unitAmount": 0.01,
              "upTo": 50000
            },
            {
              "unitAmount": 0.008,
              "upTo": 500000
            },
            {
              "unitAmount": 0.006,
              "upTo": 2500000
            },
            {
              "unitAmount": 0.005,
              "upTo": "inf"
            }
          ]
        }
      ]
    }
  ],
  "pricingIntervals": ["month"],
  "defaultRateLimit": {
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
    "enabled": true
  },
  "gatewayBaseUrl": "https://gateway.agentic.so/@dev/search@42ad78bf",
  "gatewayMcpUrl": "https://gateway.agentic.so/@dev/search@42ad78bf/mcp",
  "marketplaceUrl": "https://agentic.so/marketplace/projects/@dev/search",
  "adminUrl": "https://agentic.so/app/projects/@dev/search/deployments/42ad78bf"
}
```

</Expandable>

## 5. Test your deployment

The easiest way to test your deployment is to visit it in your Agentic admin dashboard. This will be the `adminUrl` in the returned deployment and should look like: `https://agentic.so/app/projects/<your-project-identifier>/deployments/<hash>`.

This page shows you all the tools available for your deployment and includes a GUI showing how to call them with various MCP clients, TS LLM SDKs, Python LLM SDKs, and simple HTTP.

<Frame caption='Example of calling an Agentic tool'>
  <img
    src='/media/example-usage.png'
    alt='Example of calling an Agentic tool'
  />
</Frame>

<Expandable title="Example of calling a tool via HTTP">

This example uses the [@agentic/search](https://agentic.so/marketplace/projects/@agentic/search) project's `search` tool. You'll need to replace the project identifier, tool name, and tool arguments with your own, but otherwise, calling your deployment's tools should be pretty straightforward.

<Tabs>
<Tab title="cURL">

```bash
curl -X POST -H "Content-Type: application/json" -d '{ "query": "example google search" }' https://gateway.agentic.com/mcp/search/search
```

</Tab>

<Tab title="HTTPie">

```bash
http https://gateway.agentic.com/mcp/search/search query='example google search'
```

</Tab>
</Tabs>
</Expandable>

## 6. Publish your deployment

Publishing your deployment will make it publicly available to all Agentic users. This will also enable other users to subscribe to your product using Stripe subscriptions.

```bash
agentic publish
```

The CLI will prompt you to confirm a `semver` version.

Now, your project will be available at `https://agentic.so/marketplace/projects/<your-project-identifier>`.

**Upon publishing, your project will be a live, publicly available product**.

You can share your product's public URL with customers, and they'll be able to subscribe to your product via Stripe. You can visit your [dashboard](https://agentic.so/app) to track customer usage and revenue.

<Tip>Congrats, you now have a live MCP product! 🎉</Tip>

## 7. (Optional) Submit your product to the public Agentic Marketplace

<Info>
**Your published product will be live and publicly accessible, but it will not be discoverable on the Agentic Marketplace's main page or search by default.**

I made this decision during the current beta in order to keep the Agentic Marketplace as high quality and curated as possible.

If you'd like to submit your product to Agentic's public MCP Marketplace, please
[get in touch](/contact).

</Info>


================================================
FILE: docs/publishing/guides/existing-openapi-service.mdx
================================================
---
title: Existing OpenAPI Service
description: This guide will show you how to publish an existing OpenAPI service to Agentic.
---

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

## 1. Install the Agentic CLI

<CodeGroup>

```bash npm
npm i -g @agentic/cli
```

```bash pnpm
pnpm i -g @agentic/cli
```

```bash bun
bun install -g @agentic/cli
```

```bash yarn
yarn global add @agentic/cli
```

</CodeGroup>

## 2. Log in or create an account

<Tabs>
<Tab title="GitHub">

The `agentic` CLI defaults to using GitHub for authentication.

```bash
agentic login
```

</Tab>

<Tab title="Username & password">
```bash
agentic login -e <email> -p <password>
# or
agentic signup -e <email> -p <password> -u <username>
```
</Tab>

</Tabs>

## 3. Add an Agentic config to your project

<Info>
  Make sure your remote OpenAPI service is deployed to a publicly accessible
  `https` URL, and that your OpenAPI spec is a valid 3.0 or 3.1 spec.
</Info>

Your agentic config either be an `agentic.config.ts` file or an `agentic.config.json` file. The advantage of using a `ts` file is that you get full autocomplete and type safety.

<Tabs>
<Tab title="TypeScript">

First, install the `@agentic/platform` package as a dev dependency.

<CodeGroup>

```bash npm
npm i -save-dev @agentic/platform
```

```bash pnpm
pnpm add -D @agentic/platform
```

```bash bun
bun add -d @agentic/platform
```

</CodeGroup>

This package exports a `defineConfig` function which makes your config fully-typed and adds nice autocomplete.

Now, create an `agentic.config.ts` file in the root of your project's source.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: '<Your Project Name>',
  description: '<A brief description of your project>',
  origin: {
    type: 'openapi',
    url: '<Your Remote OpenAPI Server Base URL>',
    spec: '<Local Path or Remote URL to your OpenAPI Spec>'
  }
})
```

</Tab>

<Tab title="JSON">

Create an `agentic.config.json` file in the root of your project's source.

```json agentic.config.json
{
  "$schema": "https://agentic.so/schema.json",
  "name": "<Your Project Name>",
  "description": "<Your Project Description>",
  "origin": {
    "type": "openapi",
    "url": "<Your Remote OpenAPI Server Base URL>",
    "spec": "<Local Path or Remote URL to your OpenAPI Spec>"
  }
}
```

</Tab>

</Tabs>

## 4. Deploy your project

From the directory where your `agentic.config.ts` or `agentic.config.json` file is located, run:

```bash
agentic deploy
```

Every time you make a change to your project, you can run `agentic deploy` which will create a new immutable preview deployment. These deployments will not affect any published products you may have until you publish them by running `agentic publish`.

<Info>
  You'll soon be able to configure a GitHub repository to automatically deploy
  your project on changes. Please [let me know](/contact) if you'd like me to
  prioritize this feature.
</Info>

<Note>
  The returned deployment will not have any information about your origin
  server, because the origin is considered hidden once deployed to Agentic's MCP
  gateway.
</Note>

<Expandable title="example output">

<Note>
  The returned deployment will not have any information about your origin
  server, because the origin is considered hidden once deployed to Agentic's MCP
  gateway.
</Note>

```json
{
  "id": "depl_kf4c3o8efh2y84dp5iwsha95",
  "createdAt": "2025-06-28 05:38:34.960754+00",
  "updatedAt": "2025-06-28 05:38:34.960754+00",
  "identifier": "@dev/search@42ad78bf",
  "hash": "42ad78bf",
  "published": false,
  "description": "Official Google Search tool. Useful for finding up-to-date news and information about any topic.",
  "readme": "",
  "userId": "user_bhlpuiioipxilpuq7xaoh1ae",
  "projectId": "proj_rxs9jorlwolc3seq8enqgrgc",
  "tools": [
    {
      "name": "search",
      "description": "Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.",
      "inputSchema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "num": {
            "type": "integer",
            "default": 5,
            "description": "Number of results to return"
          },
          "type": {
            "enum": [
              "search",
              "images",
              "videos",
              "places",
              "news",
              "shopping"
            ],
            "type": "string",
            "default": "search",
            "description": "Type of Google search to perform"
          },
          "query": {
            "type": "string",
            "description": "Search query"
          }
        },
        "required": ["query"],
        "additionalProperties": false
      },
      "outputSchema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "news": {},
          "images": {},
          "places": {},
          "videos": {},
          "results": {},
          "shopping": {},
          "answerBox": {},
          "knowledgeGraph": {}
        },
        "additionalProperties": false
      }
    }
  ],
  "toolConfigs": [
    {
      "name": "search",
      "cacheControl": "public, max-age=60, s-maxage=60 stale-while-revalidate=10"
    }
  ],
  "pricingPlans": [
    {
      "name": "Free",
      "slug": "free",
      "rateLimit": {
        "interval": 86400,
        "limit": 10,
        "mode": "approximate",
        "enabled": true
      },
      "lineItems": [
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "per_unit",
          "unitAmount": 0
        }
      ]
    },
    {
      "name": "Standard",
      "slug": "standard",
      "interval": "month",
      "rateLimit": {
        "interval": 1,
        "limit": 100,
        "mode": "approximate",
        "enabled": true
      },
      "lineItems": [
        {
          "slug": "base",
          "usageType": "licensed",
          "amount": 1000
        },
        {
          "slug": "requests",
          "usageType": "metered",
          "billingScheme": "tiered",
          "tiersMode": "volume",
          "tiers": [
            {
              "unitAmount": 0,
              "upTo": 1000
            },
            {
              "unitAmount": 0.01,
              "upTo": 50000
            },
            {
              "unitAmount": 0.008,
              "upTo": 500000
            },
            {
              "unitAmount": 0.006,
              "upTo": 2500000
            },
            {
              "unitAmount": 0.005,
              "upTo": "inf"
            }
          ]
        }
      ]
    }
  ],
  "pricingIntervals": ["month"],
  "defaultRateLimit": {
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
    "enabled": true
  },
  "gatewayBaseUrl": "https://gateway.agentic.so/@dev/search@42ad78bf",
  "gatewayMcpUrl": "https://gateway.agentic.so/@dev/search@42ad78bf/mcp",
  "marketplaceUrl": "https://agentic.so/marketplace/projects/@dev/search",
  "adminUrl": "https://agentic.so/app/projects/@dev/search/deployments/42ad78bf"
}
```

</Expandable>

## 5. Test your deployment

The easiest way to test your deployment is to visit it in your Agentic admin dashboard. This will be the `adminUrl` in the returned deployment and should look like: `https://agentic.so/app/projects/<your-project-identifier>/deployments/<hash>`.

This page shows you all the tools available for your deployment and includes a GUI showing how to call them with various MCP clients, TS LLM SDKs, Python LLM SDKs, and simple HTTP.

<Frame caption='Example of calling an Agentic tool'>
  <img
    src='/media/example-usage.png'
    alt='Example of calling an Agentic tool'
  />
</Frame>

<Expandable title="Example of calling a tool via HTTP">

This example uses the [@agentic/search](https://agentic.so/marketplace/projects/@agentic/search) project's `search` tool. You'll need to replace the project identifier, tool name, and tool arguments with your own, but otherwise, calling your deployment's tools should be pretty straightforward.

<Tabs>
<Tab title="cURL">

```bash
curl -X POST -H "Content-Type: application/json" -d '{ "query": "example google search" }' https://gateway.agentic.com/mcp/search/search
```

</Tab>

<Tab title="HTTPie">

```bash
http https://gateway.agentic.com/mcp/search/search query='example google search'
```

</Tab>
</Tabs>
</Expandable>

## 6. Publish your deployment

Publishing your deployment will make it publicly available to all Agentic users. This will also enable other users to subscribe to your product using Stripe subscriptions.

```bash
agentic publish
```

The CLI will prompt you to confirm a `semver` version.

Now, your project will be available at `https://agentic.so/marketplace/projects/<your-project-identifier>`.

**Upon publishing, your project will be a live, publicly available product**.

You can share your product's public URL with customers, and they'll be able to subscribe to your product via Stripe. You can visit your [dashboard](https://agentic.so/app) to track customer usage and revenue.

<Tip>Congrats, you now have a live MCP product! 🎉</Tip>

## 7. (Optional) Submit your product to the public Agentic Marketplace

<Info>
**Your published product will be live and publicly accessible, but it will not be discoverable on the Agentic Marketplace's main page or search by default.**

I made this decision during the current beta in order to keep the Agentic Marketplace as high quality and curated as possible.

If you'd like to submit your product to Agentic's public MCP Marketplace, please
[get in touch](/contact).

</Info>


================================================
FILE: docs/publishing/guides/py-fastmcp.mdx
================================================
---
title: Python FastMCP
description: This guide will show you how to publish an MCP server to Agentic using the Python fastmcp package.
---

[Python's FastMCP](https://gofastmcp.com) is a popular [open source](https://github.com/jlowin/fastmcp) MCP server framework for Python.

## 1. Install the `fastmcp` package

<Info>
  **Prerequisite**: Please install [Python](https://www.python.org) before
  proceeding.
</Info>

<CodeGroup>

```bash uv
uv add fastmcp
```

```bash pip
pip install fastmcp
```

</CodeGroup>

## 2. Create a FastMCP server

```py server.py
from fastmcp import FastMCP

mcp = FastMCP("Demo 🚀")

@mcp.tool
def add(a: int, b: int) -> int:
    """Add two numbers"""
    return a + b

if __name__ == "__main__":
    mcp.run(transport="http", host="127.0.0.1", port=8000, path="/mcp")
```

<Note>
  Make sure to run your server with the `transport="http"` option to use the
  Streamable HTTP transport.
</Note>

## 3. Deploy your MCP server remotely

Deploy your server publicly or use a tool like [ngrok](https://ngrok.com) to expose it to the internet.

<Warning>
  Tools like `ngrok` expose your unauthenticated server to the internet. Only
  run this command in a safe environment if you understand the risks.
</Warning>

We recommend deploying your server to a cloud provider like [render](https://render.com/docs/deploy-fastapi), [platform.sh](https://docs.platform.sh/languages/python.html), [porter](https://docs.porter.run/guides/fastapi/deploy-fastapi), or [fly.io](https://fly.io/docs/python/frameworks/fastapi/). Or one of the big boys [AWS](https://aws.amazon.com), [GCP](https://cloud.google.com), or [Azure](https://azure.microsoft.com).

## 4. Deploy your origin MCP server to Agentic

Now that you have a publicly available MCP server, you can follow the [existing MCP server guide](/publishing/guides/existing-mcp-server) to deploy it to Agentic.


================================================
FILE: docs/publishing/guides/ts-fastmcp.mdx
================================================
---
title: TypeScript FastMCP
description: This guide will show you how to publish an MCP server to Agentic using the TypeScript FastMCP package.
---

[FastMCP](https://github.com/punkpeye/fastmcp) is a popular open source TypeScript framework for building MCP servers.

## 1. Install dependencies

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

<CodeGroup>

```bash npm
npm add fastmcp zod
```

```bash pnpm
pnpm add fastmcp zod
```

```bash bun
bun add fastmcp zod
```

```bash yarn
yarn add fastmcp zod
```

</CodeGroup>

## 2. Create a FastMCP server

```ts server.ts
import { FastMCP } from 'fastmcp'
import { z } from 'zod' // Or any validation library that supports Standard Schema

const server = new FastMCP({
  name: 'Example',
  version: '0.0.1'
})

server.addTool({
  name: 'add',
  description: 'Add two numbers',
  parameters: z.object({
    a: z.number(),
    b: z.number()
  }),
  execute: async (args) => {
    return String(args.a + args.b)
  }
})

server.start({
  transportType: 'httpStream',
  httpStream: {
    port: 8080
  }
})
```

<Note>
  Make sure to run your server with the `transportType: 'httpStream'` option to
  use the Streamable HTTP transport.
</Note>

## 3. Deploy your MCP server remotely

Deploy your server publicly or use a tool like [ngrok](https://ngrok.com) to expose it to the internet.

<Warning>
  Tools like `ngrok` expose your unauthenticated server to the internet. Only
  run this command in a safe environment if you understand the risks.
</Warning>

We recommend deploying your server to a cloud provider like [Cloudflare Workers](https://workers.cloudflare.com), [Vercel](https://vercel.com/guides/hosting-backend-apis) (for instance, using the [Hono](https://vercel.com/templates/hono/hono-on-vercel) API template), [Render](https://render.com/docs/deploy-fastapi), [Porter](https://docs.porter.run/guides/nodejs/deploy-nodejs), or [Fly.io](https://fly.io/docs/python/frameworks/fastapi/). Or one of the big boys [AWS](https://aws.amazon.com), [GCP](https://cloud.google.com), or [Azure](https://azure.microsoft.com).

## 4. Deploy your origin MCP server to Agentic

Now that you have a publicly available MCP server, you can follow the [existing MCP server guide](/publishing/guides/existing-mcp-server) to deploy it to Agentic.


================================================
FILE: docs/publishing/guides/ts-mcp-hono.mdx
================================================
---
title: TypeScript Hono MCP
description: This guide will show you how to publish an MCP server to Agentic using TypeScript and Hono's MCP support.
---

[Hono](https://hono.dev) is a popular open source TypeScript framework for building HTTP servers, and [`@hono/mcp`](https://github.com/honojs/middleware/tree/main/packages/mcp) is an excellent solution for exposing MCP servers.

## 1. Install dependencies

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

<CodeGroup>

```bash npm
npm add hono @hono/node-server @hono/mcp @modelcontextprotocol/sdk zod
```

```bash pnpm
pnpm add hono @hono/node-server @hono/mcp @modelcontextprotocol/sdk zod
```

```bash bun
bun add hono @hono/node-server @hono/mcp @modelcontextprotocol/sdk zod
```

```bash yarn
yarn add hono @hono/node-server @hono/mcp @modelcontextprotocol/sdk zod
```

</CodeGroup>

## 2. Create a Hono MCP Node.js server

```ts server.ts
import { StreamableHTTPTransport } from '@hono/mcp'
import { serve } from '@hono/node-server'
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
import { Hono } from 'hono'
import { logger } from 'hono/logger'
import { z } from 'zod'

const app = new Hono()
app.use(logger())

const mcpServer = new McpServer({
  name: 'Example',
  version: '0.0.1'
})

mcpServer.registerTool(
  'add',
  {
    description: 'Add two numbers',
    inputSchema: z.object({
      a: z.number(),
      b: z.number()
    })
  },
  async (args) => {
    return {
      content: [
        {
          type: 'text',
          content: String(args.a + args.b)
        }
      ]
    }
  }
)

app.all('/mcp', async (c) => {
  const transport = new StreamableHTTPTransport()
  await mcpServer.connect(transport)
  return transport.handleRequest(c)
})

serve({ fetch: app.fetch, port: 8787 })
```

<Tip>
  Hono is really flexible, so if you'd rather deploy your server to Cloudflare
  Workers instead of using Node.js (or any other platform), just follow [Hono's
  docs](https://hono.dev/docs/getting-started/basic).
</Tip>

## 3. Deploy your MCP server remotely

Deploy your server publicly or use a tool like [ngrok](https://ngrok.com) to expose it to the internet.

<Warning>
  Tools like `ngrok` expose your unauthenticated server to the internet. Only
  run this command in a safe environment if you understand the risks.
</Warning>

We recommend deploying your server to a cloud provider like [Cloudflare Workers](https://workers.cloudflare.com), [Vercel](https://vercel.com/guides/hosting-backend-apis) (for instance, using the [Hono](https://vercel.com/templates/hono/hono-on-vercel) API template), [Render](https://render.com/docs/deploy-fastapi), [Porter](https://docs.porter.run/guides/nodejs/deploy-nodejs), or [Fly.io](https://fly.io/docs/python/frameworks/fastapi/). Or one of the big boys [AWS](https://aws.amazon.com), [GCP](https://cloud.google.com), or [Azure](https://azure.microsoft.com).

## 4. Deploy your origin MCP server to Agentic

Now that you have a publicly available MCP server, you can follow the [existing MCP server guide](/publishing/guides/existing-mcp-server) to deploy it to Agentic.


================================================
FILE: docs/publishing/guides/ts-modelfetch.mdx
================================================
---
title: TypeScript ModelFetch
description: This guide will show you how to publish an MCP server to Agentic using ModelFetch.
---

[ModelFetch](https://www.modelfetch.com) is a delightful TypeScript/JavaScript SDK for building and deploying MCP servers anywhere TypeScript/JavaScript runs - Write your MCP server once and run it anywhere without vendor lock-in.

## 1. Create a ModelFetch MCP server

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

```bash
npx -y create-modelfetch@latest
```

Follow the interactive prompts to:

1. **Choose a runtime** - Node.js, Next.js, Bun, Deno, Vercel, Cloudflare, Netlify, Fastly, Supabase, Gcore, AWS Lambda, or Azure Functions
2. **Select a language** - TypeScript or JavaScript
3. **Pick a package manager** - npm, pnpm, bun, or yarn

Then navigate to your project:

```bash
cd my-mcp-server
```

## 2. Implement your MCP server

Edit the server file to add your MCP tools, resources, and prompts:

```ts server.ts
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
import { z } from 'zod'

const server = new McpServer({
  title: 'My MCP Server',
  name: 'my-mcp-server',
  version: '1.0.0'
})

server.registerTool(
  'add',
  {
    title: 'Add Numbers',
    description: 'Add two numbers together',
    inputSchema: {
      a: z.number(),
      b: z.number()
    }
  },
  ({ a, b }) => ({
    content: [
      {
        type: 'text',
        text: `${a} + ${b} = ${a + b}`
      }
    ]
  })
)

export default server
```

<Note>
  [ModelFetch](https://www.modelfetch.com) uses the [official MCP TypeScript
  SDK](https://github.com/modelcontextprotocol/typescript-sdk) and provides
  runtime-specific handlers for different platforms.
</Note>

## 3. Deploy your MCP server remotely

ModelFetch supports multiple deployment targets. Deploy your server to any platforms that support these runtimes:

- Node.js
- Next.js
- Bun
- Deno
- Vercel
- Cloudflare
- Netlify
- Fastly
- Supabase
- Gcore
- AWS Lambda
- Azure Functions
- etc.

See the [ModelFetch documentation](https://www.modelfetch.com/docs) for more details.

<Warning>
  For development, you can use [ngrok](https://ngrok.com) to temporarily expose
  your local server. Only use this in a safe environment as it exposes your
  server to the internet.
</Warning>

## 4. Deploy your origin MCP server to Agentic

Now that you have a publicly available MCP server, you can follow the [existing MCP server guide](/publishing/guides/existing-mcp-server) to deploy it to Agentic.


================================================
FILE: docs/publishing/guides/ts-openapi-hono.mdx
================================================
---
title: TypeScript Hono OpenAPI
description: This guide will show you how to publish an OpenAPI service to Agentic using TypeScript and Hono's OpenAPI support.
---

[Hono](https://hono.dev) is a popular open source TypeScript framework for building HTTP servers, and [`@hono/zod-openapi`](https://hono.dev/examples/zod-openapi) is an excellent solution for creating an auto-generated OpenAPI spec from your Hono routes.

## 1. Install dependencies

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

<CodeGroup>

```bash npm
npm add hono @hono/node-server @hono/zod-openapi zod
```

```bash pnpm
pnpm add hono @hono/node-server @hono/zod-openapi zod
```

```bash bun
bun add hono @hono/node-server @hono/zod-openapi zod
```

```bash yarn
yarn add hono @hono/node-server @hono/zod-openapi zod
```

</CodeGroup>

## 2. Create a Hono OpenAPI Node.js server

```ts server.ts
import { serve } from '@hono/node-server'
import { createRoute, OpenAPIHono, z } from '@hono/zod-openapi'
import { logger } from 'hono/logger'

const app = new OpenAPIHono()
app.use(logger())

const echoRoute = createRoute({
  description: 'Echoes the request body',
  // The OpenAPI `operationId` will be used as the tool name in Agentic
  operationId: 'echo',
  method: 'post',
  path: '/echo',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

return app.openapi(echoRoute, async (c) => {
  return c.json(c.req.valid('json'))
})

app.doc31('/docs', {
  openapi: '3.1.0',
  info: {
    title: 'Example',
    description: 'Example description',
    version: '0.0.1'
  }
})

serve({ fetch: app.fetch, port: 8787 })
```

Note that the auto-generated OpenAPI spec will be available at `/docs` in this example.

<Tip>
  Hono is really flexible, so if you'd rather deploy your server to Cloudflare
  Workers instead of using Node.js (or any other platform), just follow [Hono's
  docs](https://hono.dev/docs/getting-started/basic).
</Tip>

## 3. Deploy your OpenAPI server remotely

Deploy your server publicly or use a tool like [ngrok](https://ngrok.com) to expose it to the internet.

<Warning>
  Tools like `ngrok` expose your unauthenticated server to the internet. Only
  run this command in a safe environment if you understand the risks.
</Warning>

We recommend deploying your server to a cloud provider like [Cloudflare Workers](https://workers.cloudflare.com), [Vercel](https://vercel.com/guides/hosting-backend-apis) (for instance, using the [Hono](https://vercel.com/templates/hono/hono-on-vercel) API template), [Render](https://render.com/docs/deploy-fastapi), [Porter](https://docs.porter.run/guides/nodejs/deploy-nodejs), or [Fly.io](https://fly.io/docs/python/frameworks/fastapi/). Or one of the big boys [AWS](https://aws.amazon.com), [GCP](https://cloud.google.com), or [Azure](https://azure.microsoft.com).

## 4. Deploy your origin OpenAPI service to Agentic

Now that you have a publicly available MCP server, you can follow the [existing OpenAPI server guide](/publishing/guides/existing-openapi-service) to deploy it to Agentic.


================================================
FILE: docs/publishing/guides/ts-xmcp.mdx
================================================
---
title: TypeScript xmcp
description: This guide will show you how to publish an MCP server to Agentic using the TypeScript xmcp package with Vercel hosting.
---

[xmcp](https://github.com/basementstudio/xmcp) is an excellent OSS TS framework for deploying MCP servers, with a familiar DX to Next.js and deployed to [Vercel](https://vercel.com).

## 1. Create an xmcp server

<Info>
  **Prerequisite**: Please install [Node.js](https://nodejs.org) before
  proceeding.
</Info>

```bash
npx create-xmcp-app@latest
```

Follow [xmcp's quickstart guide](https://xmcp.dev/docs#getting-started) for more details.

<Note>
  Make sure that the MCP server has the Streamable HTTP transport enabled (it's
  enabled by default).
</Note>

You should be able to run your MCP server locally with `xmcp dev` and see the
MCP server running at `http://localhost:3002/mcp`.

## 2. Deploy your MCP server remotely

Deploy your MCP server publicly (we recommend Vercel for xmcp):

```bash
xmcp build --vercel
```

```bash
vercel deploy --prod --prebuilt
```

## 4. Deploy your origin MCP server to Agentic

Now that you have a publicly available MCP server, you can follow the [existing MCP server guide](/publishing/guides/existing-mcp-server) to deploy it to Agentic.


================================================
FILE: docs/publishing/index.mdx
================================================
---
title: Publishing MCPs
description: Your API → Paid MCP, Instantly.
---

Run one command to turn any MCP server or OpenAPI service into a paid MCP product. With built-in support for every major LLM SDK and MCP client.

Visit the [Quick Start](/publishing/quickstart) to get started or read on for a quick overview.

## How it works

<Frame>
  <img
    src='https://agentic.so/agentic-mcp-gateway-mvp-diagram-light.png'
    alt='MCP Gateway Demo'
    className='w-full rounded-lg overflow-hidden'
  />
</Frame>

<Steps>
  <Step title='Create your MCP server or OpenAPI service'>
    Your origin server represents your product's unique value prop.

    It can be any remote MCP server or OpenAPI service. You can host your origin server anywhere, using any language or framework.

  </Step>
  <Step title="Publish your origin server to Agentic's MCP Gateway">
    Agentic's MCP Gateway acts as a public proxy between your origin
    server and your customers.

    It handles everything you'll need to start charging for your tools as a production-ready AI product. That includes auth, billing, rate-limiting, caching, usage tracking, versioning, etc. It also makes your tools instantly compatible with every major LLM SDK and MCP client.

  </Step>
  <Step title='Share your MCP product with the world! 🎉'>
    Your MCP product is now live and ready to sell. You can share its public URL
    with customers, and they'll be able to subscribe to your product via Stripe.
    We use [Stripe Connect](https://stripe.com/connect) to handle sending
    payments to your bank.
  </Step>
</Steps>

That's all there is to it!

Visit the [Quick Start](/publishing/quickstart) to get started in minutes.


================================================
FILE: docs/publishing/origin/index.mdx
================================================
---
title: Origin Servers
description: Configuring your origin MCP server or OpenAPI service with Agentic's MCP Gateway.
---

## Remote origin servers

**Agentic currently only supports remote origin servers**. If you're
interested in hosting your origin server with Agentic's infrastructure, please
[reach out to us](/contact) and we'll be happy to help you get set up.

<Tip>
  Remote origin servers are important because they allow for maximum flexibility
  with how you author and host your MCP server or OpenAPI service.

By cleanly separating between Agentic's MCP gateway and your remote origin server, Agentic supports origin servers written in any language or framework and deployed to any cloud.

</Tip>

### Remote Origin MCP Server

Agentic supports remote MCP servers hosted externally on any public network.

Your MCP server must support the Streamable HTTP transport and use a secure `https` URL.

See [Configuring your origin MCP server](/publishing/config#mcp-origin-server) for more details.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Example remote MCP server',
  origin: {
    type: 'mcp',
    url: 'https://example.com/mcp'
  }
})
```

### Remote Origin OpenAPI Service

Agentic supports remote OpenAPI services hosted externally on any public network.

Your OpenAPI service must use OpenAPI 3.x and use a secure `https` URL.

See [Configuring your origin OpenAPI service](/publishing/config#open-api-origin-server) for more details.

```ts agentic.config.ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Example remote OpenAPI service',
  origin: {
    type: 'openapi',
    url: 'https://example.com/openapi',
    spec: 'https://example.com/openapi.json'
  }
})
```

## Deploying your origin server to Agentic

<Note>
  **Agentic currently only supports remote origin servers**. If you're
  interested in hosting your origin server with Agentic's infrastructure, please
  [reach out to us](/contact) and we'll be happy to help you get set up.
</Note>


================================================
FILE: docs/publishing/origin/metadata.mdx
================================================
---
title: Origin Metadata
description: Agentic's MCP Gateway passes extra metadata to your origin server.
---

## Metadata

<Tabs>
  <Tab title='MCP Origin Server'>
Agentic's MCP Gateway will always include the following metadata in all tool calls within the `_meta.agentic` field.

```ts
export type AgenticMcpRequestMetadata = {
  agenticProxySecret: string
  sessionId: string
  isCustomerSubscriptionActive: boolean

  customerId?: string
  customerSubscriptionStatus?: string
  customerSubscriptionPlan?: string

  userId?: string
  userEmail?: string
  userUsername?: string
  userName?: string
  userCreatedAt?: string
  userUpdatedAt?: string

  deploymentId: string
  deploymentIdentifier: string
  projectId: string
  projectIdentifier: string

  ip?: string
} & (
  | {
      // If the customer has an active subscription, these fields are guaranteed
      // to be present in the metadata.
      isCustomerSubscriptionActive: true

      customerId: string
      customerSubscriptionStatus: string

      userId: string
      userEmail: string
      userUsername: string
      userCreatedAt: string
      userUpdatedAt: string
    }
  | {
      // If the customer does not have an active subscription, then the customer
      // fields may or may not be present.
      isCustomerSubscriptionActive: false
    }
)
```

</Tab>

<Tab title='OpenAPI Origin Server'>
Agentic's MCP Gateway will always include the following headers for all tool calls to your origin server.

<ResponseField name='x-agentic-proxy-secret' type='string' required>
  The secret key of your Agentic project. This is used to guarantee that HTTP
  requests are actually coming from Agentic's MCP Gateway, and not from
  third-party actors.

You can find this secret key in your Agentic project's dashboard settings.

</ResponseField>

<ResponseField name='x-agentic-customer-id' type='string'>
  The ID of the customer in Agentic's database.
</ResponseField>

<ResponseField
  name='x-agentic-is-customer-subscription-active'
  type='string'
  required
  default='false'
>
  Whether the customer has an active subscription. Will be either `true` or
  `false`.
</ResponseField>

<ResponseField
  name='x-agentic-customer-subscription-status'
  type='string'
  required
  default='incomplete'
>
  The [Stripe status](https://docs.stripe.com/api/subscriptions/object#subscription_object-status) of the customer's subscription.

Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`.

</ResponseField>

<ResponseField
  name='x-agentic-customer-subscription-plan'
  type='string'
  required
  default='free'
>
  The slug of the customer's subscription pricing plan.
</ResponseField>

<ResponseField name='x-agentic-user-id' type='string'>
  The ID of the user in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-user-email' type='string'>
  The email of the user in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-user-username' type='string'>
  The username of the user in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-user-name' type='string'>
  The name of the user in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-user-created-at' type='string'>
  The date and time the user was created in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-user-updated-at' type='string'>
  The date and time the user was last updated in Agentic's database.
</ResponseField>

<ResponseField name='x-agentic-project-id' type='string' required>
  The ID of the project in Agentic's database. (`proj_...`)
</ResponseField>

<ResponseField name='x-agentic-project-identifier' type='string' required>
  The public identifier of the target project in Agentic's database.
  (`@username/project-name`)
</ResponseField>

<ResponseField name='x-agentic-deployment-id' type='string' required>
  The ID of the target deployment in Agentic's database. (`depl_...`)
</ResponseField>

<ResponseField name='x-agentic-deployment-identifier' type='string' required>
  The public identifier of the target deployment in Agentic's database.
  (`@username/project-name@<deployment-hash>`)
</ResponseField>
</Tab>
</Tabs>

## Unauthenticated requests

If a customer doesn't provide an API key for their MCP or HTTP call, Agentic's MCP Gateway will default them to your project's `free` pricing plan with `isCustomerSubscriptionActive` set to `false`.

This means they'll be subject to your project's `free` pricing plan's [rate limits](/publishing/config/rate-limits), which is important to protect your origin server from abuse.


================================================
FILE: docs/publishing/origin/security.mdx
================================================
---
title: Origin Security
description: Agentic offers multiple ways to secure your origin server from unauthorized requests.
---

## Securing your origin server

Agentic's MCP Gateway will always pass a **proxy secret** when making tool calls to your origin server (either as [`_meta.agentic.agenticProxySecret` for MCP origin servers](/publishing/origin/metadata#mcp-origin-server) or as an [`x-agentic-proxy-secret` header for OpenAPI origin servers](/publishing/origin/metadata#open-api-origin-server)).

You can find this secret key in your Agentic project's dashboard settings.

You'll want to set this secret key in your origin server's environment variables and use it to protect against unauthorized requests.

Note that this is only necessary if your origin server is deployed externally to a public network.

### Securing an MCP origin server

This is example pseudocode for how you might protect your origin MCP server to ensure only calls from Agentic's MCP Gateway are allowed.

```ts
if (
  (_meta?.agentic as any)?.agenticProxySecret !==
  process.env.AGENTIC_PROXY_SECRET
) {
  return {
    content: [
      {
        type: 'text',
        text: 'Unauthorized'
      }
    ],
    isError: true
  }
}
```

### Securing an OpenAPI origin server

This is example pseudocode for how you might protect your origin OpenAPI service to ensure only calls from Agentic's MCP Gateway are allowed.

```ts
if (
  request.headers.get('x-agentic-proxy-secret') !==
  process.env.AGENTIC_PROXY_SECRET
) {
  return {
    status: 401,
    body: {
      error: 'Unauthorized'
    }
  }
}
```

## Restricting IP addresses

You can also protecting your origin server by restricting HTTP calls to specific IP addresses used by Agentic's MCP gateway.

This is currently a private beta feature. If you're interested in using it, please [get in touch](/contact).

## Signed HTTP requests

You can also protecting your origin OpenAPI server by requiring all HTTP requests to be signed with your project's proxy secret.

This is currently a private beta feature. If you're interested in using it, please [get in touch](/contact).

## Signed MCP requests

[MCP currently doesn't support signed requests](https://github.com/modelcontextprotocol/modelcontextprotocol/discussions/461).

If you're interested in this feature, please [get in touch](/contact).


================================================
FILE: docs/publishing/quickstart.mdx
================================================
---
title: Quick Start
description: Deploy your first MCP product to Agentic in minutes.
---

## Do you have an existing API?

<Columns cols={2}>
  <Card
    title='Existing MCP Server'
    href='/publishing/guides/existing-mcp-server'
    icon='server'
  >
    Quick start based on an existing MCP server.
  </Card>

  <Card
    title='Existing OpenAPI Service'
    href='/publishing/guides/existing-openapi-service'
    icon='cloud'
  >
    Quick start based on an existing OpenAPI service.
  </Card>
</Columns>

## Create a new project from scratch

<Tabs>
<Tab title="TypeScript">
<Columns cols={2}>
  <Card
    title='TS xmcp'
    href='/publishing/guides/ts-xmcp'
    icon={(
<svg viewBox="0 0 512 512" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M86 145.542H102.4V162.25H86V145.542ZM102.4 429.583V379.458H118.8V362.75H135.2V346.042H168V329.333H184.4V312.625H200.8V346.042H233.6V362.75H250V379.458H266.4V396.167H250V412.875H233.6V429.583H217.2V412.875H200.8V396.167H168V412.875H151.6V446.292H168V463H135.2V446.292H118.8V429.583H102.4ZM102.4 145.542V112.125H118.8V95.4167H135.2V78.7083H200.8V95.4167H233.6V112.125H250V145.542H266.4V162.25H282.8V178.958H299.2V195.667H282.8V212.375H364.8V229.083H348.4V245.792H315.6V279.208H332V295.917H348.4V312.625H364.8V346.042H381.2V362.75H397.6V379.458H364.8V396.167H348.4V412.875H332V396.167H315.6V362.75H299.2V329.333H282.8V312.625H266.4V279.208H233.6V262.5H118.8V245.792H135.2V229.083H151.6V212.375H217.2V195.667H200.8V162.25H184.4V128.833H168V112.125H151.6V128.833H118.8V145.542H102.4ZM200.8 312.625V295.917H217.2V312.625H200.8ZM217.2 295.917V279.208H233.6V295.917H217.2ZM266.4 379.458V362.75H282.8V379.458H266.4ZM266.4 145.542V128.833H282.8V145.542H266.4ZM282.8 128.833V112.125H299.2V78.7083H332V95.4167H364.8V78.7083H397.6V128.833H381.2V145.542H348.4V162.25H332V145.542H315.6V178.958H299.2V128.833H282.8ZM397.6 362.75V346.042H414V362.75H397.6ZM397.6 78.7083V62H414V78.7083H397.6Z" fill="#0D969D"></path>
</svg>
    )}
  >
    Create a new MCP server and deploy it to Agentic using xmcp and Vercel.
  </Card>

<Card title='TS ModelFetch' href='/publishing/guides/ts-modelfetch' icon='cube'>
  Create a new MCP server and deploy it to Agentic using ModelFetch SDK.
</Card>

<Card
  title='TS FastMCP Server'
  href='/publishing/guides/ts-fastmcp'
  icon='bolt'
>
  Create a new MCP server and deploy it to Agentic using the TS `fastmcp`
  package.
</Card>

<Card
  title='TS MCP Hono'
  href='/publishing/guides/ts-mcp-hono'
  icon='fire-flame-curved'
>
  Create a new MCP server and deploy it to Agentic using `hono` and `@hono/mcp`.
</Card>

  <Card
    title='TS OpenAPI Hono'
    href='/publishing/guides/ts-openapi-hono'
    icon='webhook'
  >
    Create a new OpenAPI server and deploy it to Agentic (as an MCP product!) using `hono` and `@hono/zod-openapi`.
  </Card>
</Columns>
</Tab>

<Tab title='Python'>
  <Columns cols={2}>
    <Card
      title='Python FastMCP Server'
      href='/publishing/guides/py-fastmcp'
      icon='python'
    />
  </Columns>
</Tab>

</Tabs>


================================================
FILE: eslint.config.js
================================================
import { config } from '@fisch0920/config/eslint'
import drizzle from 'eslint-plugin-drizzle'

export default [
  ...config,
  {
    ignores: [
      '**/out/**',
      '**/dist/**',
      '**/.wrangler/**',
      '**/.xmcp/**',
      'packages/types/src/openapi.d.ts',
      'apps/gateway/src/worker.d.ts',
      'packages/json-schema/test/json-schema-test-suite.ts',
      'apps/web/src/*.gen.ts',
      'legacy/**',
      'stdlib/stdlib/**'
    ]
  },
  {
    files: ['**/*.ts', '**/*.tsx'],
    rules: {
      'no-console': 'error',
      'unicorn/no-array-reduce': 'off'
    }
  },
  {
    files: [
      'packages/cli/src/**/*.ts',
      'fixtures/**/*.ts',
      '**/*.test.ts',
      'examples/**/*.ts'
    ],
    rules: {
      'no-console': 'off',
      'no-process-env': 'off',
      'unicorn/no-process-exit': 'off'
    }
  },
  {
    files: ['apps/e2e/**/*.ts', 'apps/web/src/**/*.{tsx,ts}', 'stdlib/**/*.ts'],
    rules: {
      'no-console': 'off'
    }
  },
  {
    files: ['apps/api/src/**/*.ts'],
    plugins: {
      drizzle
    },
    rules: {
      ...drizzle.configs.recommended.rules
    }
  }
]


================================================
FILE: examples/mcp-servers/context7/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Context7',
  slug: 'context7',
  description:
    'Up-to-date code docs for any prompt. LLMs rely on outdated or generic information about the libraries you use, wheres Context7 pulls up-to-date, version-specific documentation and code examples directly from the source.',
  origin: {
    type: 'mcp',
    url: 'https://mcp.context7.com/mcp'
  },
  icon: 'https://avatars.githubusercontent.com/u/74989412?s=48&v=4',
  readme:
    'https://raw.githubusercontent.com/upstash/context7/refs/heads/master/README.md',
  sourceUrl: 'https://github.com/upstash/context7',
  homepageUrl: 'https://context7.com',
  toolConfigs: [
    {
      name: 'resolve-library-id',
      cacheControl:
        'public, max-age=3600, s-maxage=3600 stale-while-revalidate=180',
      examples: [
        {
          name: 'Next.js example',
          featured: true,
          prompt:
            'Create a Next.js middleware that checks for a valid JWT in cookies and redirects unauthenticated users to `/login`. use context7',
          args: {
            libraryName: 'Next.js'
          }
        }
      ]
    },
    {
      name: 'get-library-docs',
      cacheControl:
        'public, max-age=3600, s-maxage=3600 stale-while-revalidate=180'
    }
  ]
})


================================================
FILE: examples/mcp-servers/context7/package.json
================================================
{
  "name": "@agentic/examples-mcps-context7",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "UNLICENSED",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "examples/mcp-servers/context7"
  },
  "type": "module",
  "source": "./src/worker.ts",
  "scripts": {
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*"
  }
}


================================================
FILE: examples/mcp-servers/context7/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["agentic.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: examples/mcp-servers/github/agentic.config.ts
================================================
import 'dotenv/config'

import { defineConfig } from '@agentic/platform'

if (!process.env.GITHUB_TOKEN) {
  throw new Error('GITHUB_TOKEN is not set')
}

export default defineConfig({
  name: 'GitHub',
  slug: 'github',
  description:
    'The GitHub MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with GitHub APIs, enabling advanced automation and interaction capabilities for developers and tools.',
  origin: {
    type: 'mcp',
    url: 'https://api.githubcopilot.com/mcp/',
    headers: {
      Authorization: `Bearer ${process.env.GITHUB_TOKEN}`
    }
  },
  icon: './github-mark.svg',
  readme:
    'https://raw.githubusercontent.com/github/github-mcp-server/refs/heads/main/README.md',
  sourceUrl: 'https://github.com/github/github-mcp-server',
  homepageUrl: 'https://github.com',
  toolConfigs: [
    {
      name: 'get_me',
      examples: [
        {
          featured: true,
          prompt: 'Get my github user information',
          args: {
            reason: 'github hack night!'
          }
        }
      ]
    }
  ]
})


================================================
FILE: examples/mcp-servers/github/package.json
================================================
{
  "name": "@agentic/examples-mcps-github",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "UNLICENSED",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "examples/mcp-servers/github"
  },
  "type": "module",
  "source": "./src/worker.ts",
  "scripts": {
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "dotenv": "catalog:"
  }
}


================================================
FILE: examples/mcp-servers/github/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["agentic.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: examples/mcp-servers/search/.dev.vars.example
================================================
SERPER_API_KEY=

AGENTIC_PROXY_SECRET=


================================================
FILE: examples/mcp-servers/search/agentic.config.ts
================================================
import 'dotenv/config'

import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Agentic Google Search',
  slug: 'search',
  description:
    'Google Search API built specifically for LLMs. Agents should use this tool for searching the web in order to find up-to-date news and information about any topic.',
  origin: {
    type: 'mcp',
    url: process.env.MCP_ORIGIN_URL!
  },
  icon: './google.svg',
  sourceUrl:
    'https://github.com/transitive-bullshit/agentic/tree/main/examples/mcp-servers/search',
  homepageUrl: 'https://agentic.so',
  toolConfigs: [
    {
      name: 'search',
      cacheControl: 'public, max-age=60, s-maxage=60 stale-while-revalidate=10'
    }
  ],
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 0
        }
      ],
      // Limit free-tier requests to 10 per day
      rateLimit: {
        interval: '1d',
        limit: 10
      }
    },
    {
      name: 'Standard',
      slug: 'standard',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 1000
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          tiers: [
            {
              upTo: 1000,
              unitAmount: 0
            },
            {
              upTo: 50_000,
              unitAmount: 0.1
            },
            {
              upTo: 500_000,
              unitAmount: 0.08
            },
            {
              upTo: 2_500_000,
              unitAmount: 0.06
            },
            {
              upTo: 'inf',
              unitAmount: 0.05
            }
          ]
        }
      ],
      rateLimit: {
        interval: '1s',
        limit: 100
      }
    }
  ]
})


================================================
FILE: examples/mcp-servers/search/package.json
================================================
{
  "name": "@agentic/examples-mcps-search",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "UNLICENSED",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "examples/mcp-servers/search"
  },
  "type": "module",
  "source": "./src/worker.ts",
  "scripts": {
    "dev": "wrangler dev",
    "deploy": "wrangler deploy",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@agentic/serper": "workspace:*",
    "@hono/mcp": "catalog:",
    "@modelcontextprotocol/sdk": "catalog:",
    "dotenv": "catalog:",
    "hono": "catalog:",
    "zod": "catalog:"
  },
  "devDependencies": {
    "@cloudflare/workers-types": "catalog:",
    "wrangler": "catalog:"
  }
}


================================================
FILE: examples/mcp-servers/search/src/env.ts
================================================
import { z } from 'zod'

export const envSchema = z.object({
  SERPER_API_KEY: z.string().nonempty(),
  AGENTIC_PROXY_SECRET: z.string().nonempty()
})

export type Env = z.infer<typeof envSchema>

export function parseEnv(inputEnv: Record<string, unknown>): Env {
  return envSchema.parse(inputEnv)
}


================================================
FILE: examples/mcp-servers/search/src/worker.ts
================================================
import { SerperClient } from '@agentic/serper'
import { StreamableHTTPTransport } from '@hono/mcp'
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
import { Hono } from 'hono'
import { z } from 'zod'

import { type Env, parseEnv } from './env'

let serper: SerperClient

const app = new Hono()

const mcpServer = new McpServer({
  name: 'search',
  version: '1.0.0'
})

app.all('/mcp', async (c) => {
  const transport = new StreamableHTTPTransport()
  await mcpServer.connect(transport)
  return transport.handleRequest(c)
})

export default {
  async fetch(
    request: Request,
    env: Env,
    ctx: ExecutionContext
  ): Promise<Response> {
    const parsedEnv = parseEnv(env)

    if (!serper) {
      serper = new SerperClient({ apiKey: parsedEnv.SERPER_API_KEY })

      mcpServer.registerTool(
        'search',
        {
          description:
            'Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.',
          inputSchema: z.object({
            query: z.string().describe('Search query'),
            num: z
              .number()
              .int()
              .default(5)
              .optional()
              .describe('Number of results to return'),
            type: z
              .enum([
                'search',
                'images',
                'videos',
                'places',
                'news',
                'shopping'
              ])
              .default('search')
              .optional()
              .describe('Type of Google search to perform')
          }).shape,
          outputSchema: z
            .object({
              results: z.any(),
              answerBox: z.any().optional(),
              knowledgeGraph: z.any().optional(),
              images: z.any().optional(),
              videos: z.any().optional(),
              places: z.any().optional(),
              news: z.any().optional(),
              shopping: z.any().optional()
            })
            .passthrough().shape
        },
        async (args, { _meta }) => {
          // Make sure the request is coming from Agentic
          if (
            (_meta?.agentic as any)?.agenticProxySecret !==
            parsedEnv.AGENTIC_PROXY_SECRET
          ) {
            return {
              content: [
                {
                  type: 'text',
                  text: 'Unauthorized request: must come from Agentic MCP Gateway'
                }
              ],
              isError: true
            }
          }

          const result: any = await serper!.search({
            q: args.query,
            num: args.num ?? 5,
            type: args.type ?? 'search'
          })

          // Simplify search results to optimize for LLM usage
          result.results = result.organic
          delete result.organic
          delete result.topStories
          delete result.peopleAlsoAsk
          delete result.searchParameters
          delete result.credits
          delete result.relatedSearches

          return {
            content: [],
            structuredContent: result
          }
        }
      )
    }

    return app.fetch(request, parsedEnv, ctx)
  }
} satisfies ExportedHandler<Env>


================================================
FILE: examples/mcp-servers/search/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "compilerOptions": {
    "types": ["@cloudflare/workers-types"]
  },
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/mcp-servers/search/wrangler.jsonc
================================================
/**
 * https://developers.cloudflare.com/workers/wrangler/configuration/
 */
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "agentic-mcp-search",
  "main": "src/worker.ts",
  "compatibility_date": "2025-05-25",
  "compatibility_flags": ["nodejs_compat"],
  "placement": { "mode": "smart" },
  "upload_source_maps": true,
  "observability": {
    "enabled": true,
    "head_sampling_rate": 1
  }
}


================================================
FILE: examples/mcp-servers/xmcp/.gitignore
================================================
.vercel


================================================
FILE: examples/mcp-servers/xmcp/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'XMCP Example',
  slug: 'xmcp',
  description: 'TODO',
  origin: {
    type: 'mcp',
    url: 'https://xmcp.vercel.app/mcp'
  },
  homepageUrl: 'https://xmcp.dev',
  icon: './xmcp.svg'
})


================================================
FILE: examples/mcp-servers/xmcp/package.json
================================================
{
  "name": "@agentic/examples-mcps-xmcp",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "UNLICENSED",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "examples/mcp-servers/xmcp"
  },
  "scripts": {
    "dev": "xmcp dev",
    "build": "xmcp build --vercel",
    "deploy": "vercel deploy --prod --prebuilt",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "xmcp": "^0.1.6"
  },
  "devDependencies": {
    "swc-loader": "^0.2.6"
  }
}


================================================
FILE: examples/mcp-servers/xmcp/src/tools/greet.ts
================================================
import { type InferSchema } from 'xmcp'
import { z } from 'zod'

// Define the schema for tool parameters
export const schema = {
  name: z.string().describe('The name of the user to greet')
}

// Define tool metadata
export const metadata = {
  name: 'greet',
  description: 'Greet the user',
  annotations: {
    title: 'Greet the user',
    readOnlyHint: true,
    destructiveHint: false,
    idempotentHint: true
  }
}

// Tool implementation
export default async function greet({ name }: InferSchema<typeof schema>) {
  const result = `Hello, ${name}!`

  return {
    content: [{ type: 'text', text: result }]
  }
}


================================================
FILE: examples/mcp-servers/xmcp/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "xmcp-env.d.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: examples/mcp-servers/xmcp/vercel.json
================================================
{
  "$schema": "https://openapi.vercel.sh/vercel.json",
  "buildCommand": "xmcp build --vercel"
}


================================================
FILE: examples/mcp-servers/xmcp/xmcp-env.d.ts
================================================
/// <reference types="xmcp" />

// Do not edit this file

================================================
FILE: examples/mcp-servers/xmcp/xmcp.config.ts
================================================
import type { XmcpConfig } from 'xmcp'

const config: XmcpConfig = {
  http: {
    port: 3002
  }
}

export default config


================================================
FILE: examples/ts-sdks/ai-sdk/bin/mcp-filesystem.ts
================================================
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { createMcpTools } from '@agentic/mcp'
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'
import { gracefulExit } from 'exit-hook'

async function main() {
  // Create an MCP tools provider, which will start a local MCP server process
  // and use the stdio transport to communicate with it.
  const mcpTools = await createMcpTools({
    name: 'agentic-mcp-filesystem',
    serverProcess: {
      command: 'npx',
      args: [
        '-y',
        '@modelcontextprotocol/server-filesystem',
        // Allow the MCP server to access the current working directory.
        process.cwd()
        // Feel free to add additional directories the tool should have access to.
      ]
    }
  })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(mcpTools),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What files are in the current directory?'
  })

  console.log(result.toolResults[0]?.result || JSON.stringify(result, null, 2))
}

try {
  await main()
  gracefulExit(0)
} catch (err) {
  console.error(err)
  gracefulExit(1)
}


================================================
FILE: examples/ts-sdks/ai-sdk/bin/weather-experimental-active-tools.ts
================================================
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { createOpenAI } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = createOpenAI({ compatibility: 'strict' })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(searchTool),
    experimental_activeTools: Array.from(searchTool.functions).map(
      (fn) => fn.spec.name
    ),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(JSON.stringify(result.toolResults[0], null, 2))
}

await main()


================================================
FILE: examples/ts-sdks/ai-sdk/bin/weather.ts
================================================
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(searchTool),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(JSON.stringify(result.toolResults[0], null, 2))
}

await main()


================================================
FILE: examples/ts-sdks/ai-sdk/package.json
================================================
{
  "name": "agentic-ts-examples-ai-sdk",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/ai-sdk": "workspace:*",
    "@agentic/mcp": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "@ai-sdk/openai": "catalog:",
    "ai": "catalog:",
    "exit-hook": "catalog:",
    "openai": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/ai-sdk/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/ts-sdks/genkit/bin/weather.ts
================================================
import 'dotenv/config'

import { createGenkitTools } from '@agentic/genkit'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { genkit } from 'genkit'
import { gpt4oMini, openAI } from 'genkitx-openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const ai = genkit({
    plugins: [openAI()]
  })

  const result = await ai.generate({
    model: gpt4oMini,
    tools: createGenkitTools(ai, searchTool),
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(result)
}

await main()


================================================
FILE: examples/ts-sdks/genkit/package.json
================================================
{
  "name": "agentic-examples-genkit",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/genkit": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "genkit": "catalog:",
    "genkitx-openai": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/genkit/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/ts-sdks/langchain/bin/weather.ts
================================================
import 'dotenv/config'

import { createLangChainTools } from '@agentic/langchain'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { ChatPromptTemplate } from '@langchain/core/prompts'
import { ChatOpenAI } from '@langchain/openai'
import { AgentExecutor, createToolCallingAgent } from 'langchain/agents'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const tools = createLangChainTools(searchTool)
  const agent = createToolCallingAgent({
    llm: new ChatOpenAI({ model: 'gpt-4o-mini', temperature: 0 }),
    tools,
    prompt: ChatPromptTemplate.fromMessages([
      ['system', 'You are a helpful assistant. Be as concise as possible.'],
      ['placeholder', '{chat_history}'],
      ['human', '{input}'],
      ['placeholder', '{agent_scratchpad}']
    ])
  })

  const agentExecutor = new AgentExecutor({
    agent,
    tools
    // verbose: true
  })

  const result = await agentExecutor.invoke({
    input: 'What is the weather in San Francisco?'
  })

  console.log(result.output)
}

await main()


================================================
FILE: examples/ts-sdks/langchain/package.json
================================================
{
  "name": "agentic-examples-langchain",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/langchain": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "@langchain/core": "catalog:",
    "@langchain/openai": "catalog:",
    "langchain": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/langchain/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/ts-sdks/llamaindex/bin/weather.ts
================================================
import 'dotenv/config'

import { createLlamaIndexTools } from '@agentic/llamaindex'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@llamaindex/openai'
import { agent } from '@llamaindex/workflow'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const tools = createLlamaIndexTools(searchTool)
  const weatherAgent = agent({
    llm: openai({ model: 'gpt-4o-mini', temperature: 0 }),
    systemPrompt: 'You are a helpful assistant. Be as concise as possible.',
    tools
  })

  const response = await weatherAgent.run(
    'What is the weather in San Francisco?'
  )

  console.log(response.data.result)
}

await main()


================================================
FILE: examples/ts-sdks/llamaindex/package.json
================================================
{
  "name": "agentic-examples-llamaindex",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/llamaindex": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "@llamaindex/openai": "catalog:",
    "@llamaindex/workflow": "catalog:",
    "llamaindex": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/llamaindex/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/ts-sdks/mastra/bin/weather.ts
================================================
import 'dotenv/config'

import { createMastraTools } from '@agentic/mastra'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { openai } from '@ai-sdk/openai'
import { Agent } from '@mastra/core/agent'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')

  const weatherAgent = new Agent({
    name: 'Weather Agent',
    model: openai('gpt-4o-mini'),
    tools: createMastraTools(searchTool),
    instructions: 'You are a helpful assistant. Be as concise as possible.'
  })

  const res = await weatherAgent.generate(
    'What is the weather in San Francisco?'
  )
  console.log(res.text)
}

await main()


================================================
FILE: examples/ts-sdks/mastra/package.json
================================================
{
  "name": "agentic-examples-mastra",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/mastra": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "@ai-sdk/openai": "catalog:",
    "@mastra/core": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/mastra/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: examples/ts-sdks/openai/bin/weather-responses.ts
================================================
import 'dotenv/config'

import { assert } from '@agentic/core'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = new OpenAI()

  const messages: OpenAI.Responses.ResponseInput = [
    {
      role: 'system',
      content: 'You are a helpful assistant. Be as concise as possible.'
    },
    { role: 'user', content: 'What is the weather in San Francisco?' }
  ]

  {
    // First call to OpenAI to invoke the tool
    const res = await openai.responses.create({
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.responsesToolSpecs,
      tool_choice: 'required',
      input: messages
    })

    const toolCall = res.output[0]
    assert(toolCall?.type === 'function_call')
    const toolResult = await searchTool.callTool(
      toolCall.name,
      toolCall.arguments
    )

    messages.push(toolCall)
    messages.push({
      type: 'function_call_output',
      call_id: toolCall.call_id,
      output: JSON.stringify(toolResult)
    })
  }

  {
    // Second call to OpenAI to generate a text response
    const res = await openai.responses.create({
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.responsesToolSpecs,
      input: messages
    })

    console.log(res.output_text)
  }
}

await main()


================================================
FILE: examples/ts-sdks/openai/bin/weather.ts
================================================
import 'dotenv/config'

import { AgenticToolClient } from '@agentic/platform-tool-client'
import OpenAI from 'openai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = new OpenAI()

  const messages: OpenAI.ChatCompletionMessageParam[] = [
    {
      role: 'system',
      content: 'You are a helpful assistant. Be as concise as possible.'
    },
    { role: 'user', content: 'What is the weather in San Francisco?' }
  ]

  {
    // First call to OpenAI to invoke the tool
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs,
      tool_choice: 'required'
    })

    const message = res.choices[0]!.message!
    const toolCall = message.tool_calls![0]!.function!
    const toolResult = await searchTool.callTool(
      toolCall.name,
      toolCall.arguments
    )

    messages.push(message)
    messages.push({
      role: 'tool',
      tool_call_id: message.tool_calls![0]!.id,
      content: JSON.stringify(toolResult)
    })
  }

  {
    // Second call to OpenAI to generate a text response
    const res = await openai.chat.completions.create({
      messages,
      model: 'gpt-4o-mini',
      temperature: 0,
      tools: searchTool.functions.toolSpecs
    })
    const message = res.choices?.[0]?.message
    console.log(message?.content)
  }
}

await main()


================================================
FILE: examples/ts-sdks/openai/package.json
================================================
{
  "name": "agentic-examples-openai",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "openai": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: examples/ts-sdks/openai/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: fixtures/invalid/invalid-metadata-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Invalid Metadata 0',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  icon: false as any
})


================================================
FILE: fixtures/invalid/invalid-metadata-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Metadata 1',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  readme: './not-found.md'
})


================================================
FILE: fixtures/invalid/invalid-name-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  slug: 'test-invalid-name-0',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
} as any) // invalid; missing name


================================================
FILE: fixtures/invalid/invalid-name-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'a'.repeat(1025), // invalid; too long
  slug: 'test-invalid-name-2',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/invalid-name-2/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: '', // invalid; must not be empty
  slug: 'test-invalid-name-1',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/invalid-origin-url-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-invalid-origin-url-0',
  origin: {
    type: 'raw',
    url: 'http://jsonplaceholder.typicode.com' // invalid http url (missing https)
  }
})


================================================
FILE: fixtures/invalid/invalid-origin-url-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-invalid-origin-url-1',
  origin: {
    type: 'raw',
    url: 'https://' // invalid https url
  }
})


================================================
FILE: fixtures/invalid/invalid-origin-url-2/agentic.config.json
================================================
{
  "name": "test-invalid-origin-url-2"
}


================================================
FILE: fixtures/invalid/invalid-origin-url-3/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-invalid-origin-url-3',
  origin: {
    type: 'raw',
    url: '' // invalid https url
  }
})


================================================
FILE: fixtures/invalid/invalid-slug-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Invalid Slug 0',
  slug: 'Test Invalid Slug 0',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/invalid-slug-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Invalid Slug 1',
  slug: 'Test-Invalid-Slug-1',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/invalid-slug-2/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Invalid Slug 2',
  slug: 'test_invalid_slug_2',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/invalid-slug-3/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: ' ',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
} as any) // invalid; missing slug


================================================
FILE: fixtures/invalid/invalid-slug-4/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Invalid Name 4',
  slug: '@foo/bar', // invalid; slug contains invalid characters
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/invalid/pricing-base-inconsistent/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-base-inconsistent',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ]
    },
    {
      name: 'Starter',
      slug: 'starter',
      lineItems: [
        {
          slug: 'base',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 0.467
        } as any
      ]
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-custom-inconsistent/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-custom-inconsistent',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'custom-test',
          usageType: 'licensed',
          amount: 0
        }
      ]
    },
    {
      name: 'Starter',
      slug: 'starter',
      lineItems: [
        {
          slug: 'custom-test',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 100
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-duplicate-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-duplicate-0',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingIntervals: ['month', 'year'],
  pricingPlans: [
    {
      name: 'Basic',
      slug: 'basic',
      interval: 'month',
      lineItems: [
        {
          slug: 'custom-test',
          usageType: 'licensed',
          amount: 100
        }
      ]
    },
    {
      name: 'Basic',
      slug: 'basic', // invalid duplicate slug
      interval: 'year',
      lineItems: [
        {
          slug: 'custom-test',
          usageType: 'licensed',
          amount: 70
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-duplicate-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-duplicate-1',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Basic',
      slug: 'basic',
      lineItems: [
        {
          slug: 'custom-test',
          usageType: 'licensed',
          amount: 100
        },
        {
          slug: 'custom-test',
          usageType: 'licensed',
          amount: 200
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-empty-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-empty-0',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingIntervals: [] as any, // this is invalid
  pricingPlans: [
    {
      name: 'Basic',
      slug: 'basic',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 499 // $4.99 USD
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-empty-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-empty-1',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Basic',
      slug: 'basic',
      lineItems: [] as any // this is invalid
    }
  ]
})


================================================
FILE: fixtures/invalid/pricing-empty-2/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-empty-2',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [] as any // this is invalid
})


================================================
FILE: fixtures/package.json
================================================
{
  "name": "@agentic/platform-fixtures",
  "private": true,
  "version": "0.0.1",
  "description": "Internal test fixtures for the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/fixtures"
  },
  "type": "module",
  "sideEffects": false,
  "exports": {
    "./valid/**": "./valid/*",
    "./invalid/**": "./invalid/*"
  },
  "files": [
    "valid",
    "invalid"
  ],
  "scripts": {
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*"
  },
  "devDependencies": {
    "@modelcontextprotocol/sdk": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: fixtures/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["*.config.ts", "valid/**/*.config.ts", "invalid/**/*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: fixtures/valid/basic-mcp/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Basic MCP',
  origin: {
    type: 'mcp',
    url: 'https://agentic-basic-mcp-test.onrender.com/mcp'
  }
})


================================================
FILE: fixtures/valid/basic-mcp/package.json
================================================
{
  "name": "@agentic/platform-fixtures-basic-mcp",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/fixtures/valid/basic-mcp"
  },
  "type": "module",
  "scripts": {
    "start": "tsx src/index.ts",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@modelcontextprotocol/sdk": "catalog:",
    "fastmcp": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: fixtures/valid/basic-mcp/src/env.ts
================================================
import { z } from 'zod'

export const envSchema = z.object({
  PORT: z.string().default('8080').transform(Number)
})

export type Env = z.infer<typeof envSchema>

export const env = envSchema.parse(process.env)


================================================
FILE: fixtures/valid/basic-mcp/src/index.ts
================================================
import { FastMCP } from 'fastmcp'
import { z } from 'zod'

import { env } from './env'

const server = new FastMCP({
  name: 'Agentic basic test MCP server',
  version: '0.0.1'
})

server.addTool({
  name: 'add',
  description: 'Add two numbers.',
  parameters: z.object({
    a: z.number(),
    b: z.number()
  }),
  execute: async (args) => {
    return String(args.a + args.b)
  }
})

server.addTool({
  name: 'echo',
  description: 'Echoes back the input parameters.',
  parameters: z.record(z.string(), z.any()),
  execute: async (args) => {
    return JSON.stringify(args)
  }
})

await server.start({
  transportType: 'httpStream',
  httpStream: {
    port: env.PORT
  }
})


================================================
FILE: fixtures/valid/basic-mcp/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["*.config.ts", "src"],
  "exclude": ["node_modules"]
}


================================================
FILE: fixtures/valid/basic-openapi/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Basic OpenAPI',
  slug: 'test-basic-openapi',
  origin: {
    type: 'openapi',
    url: 'https://jsonplaceholder.typicode.com',
    spec: './jsonplaceholder.json'
  },
  toolConfigs: [
    {
      name: 'get_posts',
      pure: true
    },
    {
      name: 'get_post',
      pure: true
    }
  ]
})


================================================
FILE: fixtures/valid/basic-openapi/jsonplaceholder.json
================================================
{
  "openapi": "3.1.0",
  "info": {
    "title": "JSONPlaceholder",
    "version": "1.0.0"
  },
  "paths": {
    "/posts": {
      "get": {
        "summary": "Get posts",
        "operationId": "getPosts",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Post"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create post",
        "operationId": "createPost",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["userId", "title", "body"],
                "properties": {
                  "userId": {
                    "type": "integer"
                  },
                  "title": {
                    "type": "string"
                  },
                  "body": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Post"
                }
              }
            }
          }
        }
      }
    },
    "/posts/{postId}": {
      "get": {
        "summary": "Get post",
        "operationId": "getPost",
        "parameters": [
          {
            "required": true,
            "schema": {
              "type": "integer"
            },
            "name": "postId",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Post"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Post": {
        "type": "object",
        "required": ["id", "userId", "title", "body"],
        "properties": {
          "id": {
            "type": "integer"
          },
          "userId": {
            "type": "integer"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          }
        }
      },
      "Comment": {
        "type": "object",
        "required": ["id", "postId", "name", "email", "body"],
        "properties": {
          "id": {
            "type": "integer"
          },
          "postId": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "body": {
            "type": "string"
          }
        }
      },
      "Todo": {
        "type": "object",
        "required": ["id", "userId", "title", "completed"],
        "properties": {
          "id": {
            "type": "integer"
          },
          "userId": {
            "type": "integer"
          },
          "title": {
            "type": "string"
          },
          "completed": {
            "type": "boolean"
          }
        }
      },
      "User": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "address": {
            "type": "object",
            "properties": {
              "street": {
                "type": "string"
              },
              "suite": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "zipcode": {
                "type": "string"
              },
              "geo": {
                "type": "object",
                "properties": {
                  "lat": {
                    "type": "string"
                  },
                  "lng": {
                    "type": "string"
                  }
                },
                "required": ["lat", "lng"]
              }
            },
            "required": ["street", "suite", "city", "zipcode", "geo"]
          },
          "phone": {
            "type": "string"
          },
          "website": {
            "type": "string"
          },
          "company": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "catchPhrase": {
                "type": "string"
              },
              "bs": {
                "type": "string"
              }
            },
            "required": ["name", "catchPhrase", "bs"]
          }
        },
        "required": [
          "id",
          "name",
          "username",
          "email",
          "address",
          "phone",
          "website",
          "company"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://jsonplaceholder.typicode.com"
    }
  ]
}


================================================
FILE: fixtures/valid/basic-raw-free-json/agentic.config.json
================================================
{
  "name": "test-basic-raw-free-json",
  "origin": {
    "type": "raw",
    "url": "https://jsonplaceholder.typicode.com"
  }
}


================================================
FILE: fixtures/valid/basic-raw-free-ts/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-basic-raw-free-ts',
  origin: {
    type: 'raw',
    url: 'https://jsonplaceholder.typicode.com'
  }
})


================================================
FILE: fixtures/valid/everything-openapi/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Everything OpenAPI',
  slug: 'test-everything-openapi',
  origin: {
    type: 'openapi',
    url: 'https://agentic-platform-fixtures-everything.onrender.com',
    spec: 'https://agentic-platform-fixtures-everything.onrender.com/docs'
  },
  icon: 'https://storage.agentic.so/agentic-dev-icon-circle-dark.svg',
  readme: './readme.md',
  toolConfigs: [
    {
      name: 'get_user',
      enabled: true,
      pure: true,
      // cacheControl: 'no-cache',
      reportUsage: true,
      rateLimit: { enabled: false },
      pricingPlanOverridesMap: {
        free: {
          enabled: true,
          reportUsage: true
        }
      }
    },
    {
      name: 'echo',
      examples: [
        {
          name: 'Example 1',
          prompt: 'Use the echo tool to say hello.',
          featured: true,
          args: {
            message: 'Hello, world!'
          }
        }
      ]
    },
    {
      name: 'disabled_tool',
      enabled: false
    },
    {
      name: 'disabled_for_free_plan_tool',
      pricingPlanOverridesMap: {
        free: {
          enabled: false
        }
      }
    },
    {
      name: 'pure',
      pure: true
    },
    {
      name: 'unpure_marked_pure',
      pure: true
    },
    {
      name: 'custom_cache_control_tool',
      cacheControl:
        'public, max-age=7200, s-maxage=7200, stale-while-revalidate=3600'
    },
    {
      name: 'no_cache_cache_control_tool',
      cacheControl: 'no-cache'
    },
    {
      name: 'no_store_cache_control_tool',
      cacheControl: 'no-store'
    },
    {
      name: 'custom_rate_limit_tool',
      rateLimit: {
        interval: '30s',
        limit: 2,
        mode: 'strict'
      }
    },
    {
      name: 'custom_rate_limit_approximate_tool',
      rateLimit: {
        interval: '30s',
        limit: 2,
        mode: 'approximate'
      }
    },
    {
      name: 'disabled_rate_limit_tool',
      rateLimit: { enabled: false }
    },
    {
      name: 'strict_additional_properties',
      inputSchemaAdditionalProperties: false,
      outputSchemaAdditionalProperties: false
    }
  ],
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 0
        }
      ]
    },
    {
      name: 'Starter',
      slug: 'starter',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 999 // $9.99 USD
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          // free for first 1000 requests per month
          // then $0.00053 USD for unlimited further requests that month
          tiers: [
            {
              upTo: 1000,
              unitAmount: 0
            },
            {
              upTo: 'inf',
              unitAmount: 0.053
            }
          ]
        }
      ]
    },
    {
      name: 'Pro',
      slug: 'pro',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 2999 // $29.99 USD
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          // free for first 10000 requests per month
          // then $0.00049 USD for unlimited further requests that month
          tiers: [
            {
              upTo: 10_000,
              unitAmount: 0
            },
            {
              upTo: 'inf',
              unitAmount: 0.049
            }
          ]
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/valid/everything-openapi/package.json
================================================
{
  "name": "@agentic/platform-fixtures-everything-openapi",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/fixtures/valid/everything-openapi"
  },
  "type": "module",
  "scripts": {
    "start": "tsx src/server.ts",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@hono/node-server": "catalog:",
    "@hono/zod-openapi": "catalog:",
    "hono": "catalog:",
    "restore-cursor": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: fixtures/valid/everything-openapi/readme.md
================================================
# Test Everything OpenAPI

This is testing **readme rendering**.

## Misc

- [ ] Item 1
- [ ] Item 2
- [x] Item 3

---

- _italic_
- **bold**
- [link](https://www.google.com)
- `code`

## Code

```ts
const a = 1

export function foo() {
  console.log('hello world')
}
```

## Images

![Image](https://placehold.co/600x400)


================================================
FILE: fixtures/valid/everything-openapi/src/exit-hooks.ts
================================================
import type { ServerType } from '@hono/node-server'
import restoreCursor from 'restore-cursor'

export function initExitHooks({ server }: { server: ServerType }) {
  // Gracefully restore the cursor if run from a TTY
  restoreCursor()

  process.on('SIGINT', () => {
    server.close()
    process.exit(0)
  })

  process.on('SIGTERM', () => {
    server.close((err) => {
      if (err) {
        console.error(err)
        process.exit(1)
      }
      process.exit(0)
    })
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/lib/db.ts
================================================
export const db = new Map<string, any>()


================================================
FILE: fixtures/valid/everything-openapi/src/routes/custom-cache-control-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Custom cache control tool',
  operationId: 'customCacheControlTool',
  method: 'post',
  path: '/custom-cache-control-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerCustomCacheControlTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/custom-rate-limit-approximate-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Custom rate limit tool (approximate mode)',
  operationId: 'customRateLimitApproximateTool',
  method: 'post',
  path: '/custom-rate-limit-approximate-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerCustomRateLimitApproximateTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/custom-rate-limit-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Custom rate limit tool (strict mode)',
  operationId: 'customRateLimitTool',
  method: 'post',
  path: '/custom-rate-limit-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerCustomRateLimitTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/disabled-for-free-plan-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Disabled for free plan tool',
  operationId: 'disabledForFreePlanTool',
  method: 'get',
  path: '/disabled-for-free-plan-tool',
  responses: {
    200: {
      description: 'OK',
      content: {
        'application/json': {
          schema: z.object({
            status: z.string()
          })
        }
      }
    }
  }
})

export function registerDisabledForFreePlanTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json({ status: 'ok' })
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/disabled-rate-limit-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Disabled rate limit tool',
  operationId: 'disabledRateLimitTool',
  method: 'post',
  path: '/disabled-rate-limit-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerDisabledRateLimitTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/disabled-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Disabled tool',
  operationId: 'disabledTool',
  method: 'get',
  path: '/disabled-tool',
  responses: {
    200: {
      description: 'OK',
      content: {
        'application/json': {
          schema: z.object({
            status: z.string()
          })
        }
      }
    }
  }
})

export function registerDisabledTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json({ status: 'ok' })
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/echo-headers.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Echoes the request headers',
  operationId: 'echoHeaders',
  method: 'get',
  path: '/echo-headers',
  responses: {
    200: {
      description: 'Echoed request headers',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerEchoHeaders(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    const headers = c.req.header()
    return c.json(headers) as any
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/echo.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Echoes the request body',
  operationId: 'echo',
  method: 'post',
  path: '/echo',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerEcho(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/get-user.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Gets a user',
  tags: ['users'],
  operationId: 'getUser',
  method: 'get',
  path: '/users/{userId}',
  request: {
    params: z.object({
      userId: z.string().openapi({
        param: {
          description: 'User ID',
          name: 'userId',
          in: 'path'
        }
      })
    })
  },
  responses: {
    200: {
      description: 'A user object',
      content: {
        'application/json': {
          schema: z
            .object({
              id: z.string(),
              name: z.string(),
              email: z.string()
            })
            .openapi('User')
        }
      }
    }
  }
})

export function registerGetUser(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    const { userId } = c.req.valid('param')

    return c.json({
      id: userId,
      name: 'John Doe',
      email: 'john.doe@example.com'
    })
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/health-check.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Check if the server is healthy',
  operationId: 'healthCheck',
  method: 'get',
  path: '/health', // Hint: at GET /v1/health
  responses: {
    200: {
      description: 'OK',
      content: {
        'application/json': {
          schema: z.object({
            status: z.string()
          })
        }
      }
    }
  }
})

export function registerHealthCheck(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json({ status: 'ok' })
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/no-cache-cache-control-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'No cache cache control tool',
  operationId: 'noCacheCacheControlTool',
  method: 'post',
  path: '/no-cache-cache-control-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerNoCacheCacheControlTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/no-store-cache-control-tool.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'No store cache control tool',
  operationId: 'noStoreCacheControlTool',
  method: 'post',
  path: '/no-store-cache-control-tool',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerNoStoreCacheControlTool(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/pure.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Pure tool',
  operationId: 'pure',
  method: 'post',
  path: '/pure',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  }
})

export function registerPure(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/strict-additional-properties.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Echoes the request body only allowing a single "foo" field.',
  operationId: 'strictAdditionalProperties',
  method: 'post',
  path: '/strict-additional-properties',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({
            foo: z.string()
          })
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body',
      content: {
        'application/json': {
          schema: z.object({
            foo: z.string()
          })
        }
      }
    }
  }
})

export function registerStrictAdditionalProperties(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    return c.json(c.req.valid('json'))
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/routes/unpure-marked-pure.ts
================================================
import { createRoute, type OpenAPIHono, z } from '@hono/zod-openapi'

const route = createRoute({
  description: 'Unpure tool marked pure',
  operationId: 'unpure_marked_pure',
  method: 'post',
  path: '/unpure-marked-pure',
  request: {
    body: {
      content: {
        'application/json': {
          schema: z.object({}).passthrough()
        }
      }
    }
  },
  responses: {
    200: {
      description: 'Echoed request body with current timestamp to not be pure',
      content: {
        'application/json': {
          schema: z
            .object({
              now: z.number()
            })
            .passthrough()
        }
      }
    }
  }
})

export function registerUnpureMarkedPure(app: OpenAPIHono) {
  return app.openapi(route, async (c) => {
    const now = Date.now()
    return c.json({
      now,
      ...c.req.valid('json')
    }) as any
  })
}


================================================
FILE: fixtures/valid/everything-openapi/src/server.ts
================================================
import { serve } from '@hono/node-server'
import { OpenAPIHono } from '@hono/zod-openapi'
import { logger as honoLogger } from 'hono/logger'

import { initExitHooks } from './exit-hooks'
import { registerCustomCacheControlTool } from './routes/custom-cache-control-tool'
import { registerCustomRateLimitApproximateTool } from './routes/custom-rate-limit-approximate-tool'
import { registerCustomRateLimitTool } from './routes/custom-rate-limit-tool'
import { registerDisabledForFreePlanTool } from './routes/disabled-for-free-plan-tool'
import { registerDisabledRateLimitTool } from './routes/disabled-rate-limit-tool'
import { registerDisabledTool } from './routes/disabled-tool'
import { registerEcho } from './routes/echo'
import { registerEchoHeaders } from './routes/echo-headers'
import { registerGetUser } from './routes/get-user'
import { registerHealthCheck } from './routes/health-check'
import { registerNoCacheCacheControlTool } from './routes/no-cache-cache-control-tool'
import { registerNoStoreCacheControlTool } from './routes/no-store-cache-control-tool'
import { registerPure } from './routes/pure'
import { registerStrictAdditionalProperties } from './routes/strict-additional-properties'
import { registerUnpureMarkedPure } from './routes/unpure-marked-pure'

export const app = new OpenAPIHono()

app.use(honoLogger())

registerHealthCheck(app)
registerGetUser(app)
registerDisabledTool(app)
registerDisabledForFreePlanTool(app)
registerEcho(app)
registerEchoHeaders(app)
registerPure(app)
registerUnpureMarkedPure(app)
registerCustomCacheControlTool(app)
registerCustomRateLimitApproximateTool(app)
registerNoStoreCacheControlTool(app)
registerNoCacheCacheControlTool(app)
registerCustomRateLimitTool(app)
registerDisabledRateLimitTool(app)
registerStrictAdditionalProperties(app)

app.doc31('/docs', {
  openapi: '3.1.0',
  info: {
    title: 'OpenAPI server everything',
    description:
      "OpenAPI kitchen sink server meant for testing Agentic's origin OpenAPI adapter and ToolConfig features.",
    version: '0.1.0'
  }
})

const port = process.env.PORT ? Number.parseInt(process.env.PORT) : 3081
export const server = serve({
  fetch: app.fetch,
  port
})

initExitHooks({ server })

console.log(`Server running on port ${port}`)


================================================
FILE: fixtures/valid/everything-openapi/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["*.config.ts", "src"],
  "exclude": ["node_modules"]
}


================================================
FILE: fixtures/valid/metadata-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Metadata 0',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  icon: './agentic-dev-icon-circle-dark.svg',
  readme: './readme.md'
})


================================================
FILE: fixtures/valid/metadata-0/readme.md
================================================
# Test Metadata

This is testing **readme rendering**.

## Misc

- [ ] Item 1
- [ ] Item 2
- [x] Item 3

---

- _italic_
- **bold**
- [link](https://www.google.com)
- `code`

## Code

```ts
const a = 1

export function foo() {
  console.log('hello world')
}
```

## Images

![Image](https://placehold.co/600x400)


================================================
FILE: fixtures/valid/metadata-1/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'Test Metadata 1',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  icon: 'https://agentic.so/agentic-icon-circle-light.svg',
  readme:
    'https://raw.githubusercontent.com/transitive-bullshit/agentic/refs/heads/main/readme.md'
})


================================================
FILE: fixtures/valid/metadata-2/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

const icon =
  'data:image/svg+xml;base64,<svg width="49" height="49" viewBox="0 0 49 49" fill="none" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<path d="M0.0195312 48.3594H48.0195V0.359375H0.0195312V48.3594Z" fill="url(#pattern0_2779_20)"/>
<defs>
<pattern id="pattern0_2779_20" patternContentUnits="objectBoundingBox" width="1" height="1">
<use xlink:href="#image0_2779_20" transform="scale(0.00625)"/>
</pattern>
<image id="image0_2779_20" width="160" height="160" preserveAspectRatio="none" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAACgCAYAAACLz2ctAABWPklEQVR4nO29d7wdV3X3/V17Zs45t6l32XLBxhUMBozpvRMHcAx+SSA4hBJCCgmhBBKMgfBAIEAoeSjBEAiQgCEQgk2CjQNuuOKKjW1kSba6ZElX995TZvZ6/9hl9rkSYFlH90pPsvw5vkdnZvbsmfnNb5W99trC/8oDlu3nf+HF5j/+47HmiU/6PPDz2e7P/wuS7/ro3892Hw4Z0asu/035xtd/195//8P4y3e+C7h2tvt0qEtuH/bw2e7DISPZtVc0W0B18Q+eP7lm7WnZGS86T874jX8Aytnu26Equcmy2e7DISN28fz7rYHm8qXI2p8vmvjIh/6enTtPazz1aW8H7p3t/h2Kkpt19812Hw4ZKRctWVsBtIZoPH0V5r57Gf/Sp3+n++PLHpa/451/Blwyy1085CS3Vme7D4eM5GvXbqiGWtjdk5j5K8kPV+Yu2cD4Tbee0j73bd9qPe0F75WzXvJRoDfbfT1UJJcli2e7D4eM2GNP2KQjjW618/6Gaa+ExYsxh8Gc4c3svmPNnPbXP/3Botd+dONJT30LsGa2+3soSG7WrZ/tPhwy0j39CffJ/NHddvOuBeyahGw+NBcgY8LYcZsxC9tM/ufnX6pXX3lC/o7z3gRcPNt9Ptglr1pDs92HQ0fG5mxgwdINFesXML4bdD40WjA0D0oYmb+V7MRJxtf97GHl+9/8rdaTX/JueflLPwpUs9zzg1ZyOeKw2e7DISPFxf+127bGNpZwkk5OIN0uZEOQt2BoLlholVuRVZPs3rpmrP2tv/9Qw5Qn5s9/0duBzbPd/4NRctk1Odt9OHTk2FPaevhPNilgO22y9hS0WmAKKICWQqU0dxmyBROMj1R0vvvx3+P6qx4m5/7tHwDXzfIVHHSSV/n/xgH3SVau3Ahge12ydhsKBWNACsiHYAiwhnxcGCt2M3GE0tlwzWOyv37DdxqvfNNfAF+Z3Qs4uCSXu+6c7T4cUmJXHLFFgaqyFO0ODJWQ5yACWQ6NIbCAhXxSGG3vxqywTG27bUXn/X/6xeazX/4we957zgOmZvlSDgrJ7W/+xmz34ZAS8+m/31oNZ1itoNeBsgemCSZzAFSBBg6EGDI1jEyNY+ZXTDYm8qmLPv+2huixxQtf/Kf87+gJeX7N/5ol+yJm87addngYq+PQ7kK3B7kFyYAMjIDBgVAFEAzC8NQ4Zqhk4vCKzn987kxuvvGoxrPPeB3/wxMacrnu+tnuwyEl1fEn7KSVd6ylqVUP6XWhUhCcGiZzAMyoQaiCSEZrchcm6zLxEOjcd82p9ptbv12880N/Cnx9Fi9pViWvTjxxtvtwSEk5IrulmfVkkqZai/RKqKwDnTjGQzwLZgIN/5sxiBiak7uQqs3kKuhsWb3C/uUffLH1/N8+OjvqyL/FK+7/SZLn9/2PN0P2SaoTj21LlpcqoGUFZeUAmHsWJAAu99+VCEpxvzcmdiDdKcwipb1z89DUNz7xf1pPfslK+6EPvx2YmMXLm3HJu2edOdt9OKRE7rpr0hStrgW0UuiVUFWgGrHmgGicPSgClLWKFgNiKCZ2IN0JZK7SHuox+ZN//aPGX7eOKF76228E1s3eFc6s5Nktt812Hw4pqZYtbtNotlVBrYKtwKr7mLBXynyZswcjAAMTGvJJw3B7Nya3TK5Sev/1xTPkrjsPaz3hqa8Gfjo7Vzizkuf/fels9+GQkvJVv1uSF2XEmLWgNmFA8XtKgkPvmKhA7rf7/TIVhtq7EVMxeQy0111xKhes+3p+3odeA1w6s1c385KXp5wy2304tMRWglohDCBZdSC06kGoNculKtlmNUMGW1EdE5rc0JrajVQ955zcu+4Y+zd/+bX8fR97A/DNmb/ImZPcjozMdh8OKZEdO5tU3SYNaoaz/q/65F6V+gANaldrmzAcp/i4oWDE0JoaR8ouk6ugt/bupfaPfv/8xns/PAf4wkxe40xKzs6ds92HQ0rs6NCIlJOtyIB4sCkObFamMZ3fFlQy4kZNcr8h7iOICM32LqTsMnUkdFZvnNN9659+snHe+wvgswf62mZDcjr/OyS5L5Lddfd87XVbkoMgntXC1r1MbxCpmTE4JXiQ5tSMiFPdYsTFCrsd5Chor94y3H37W/6+ee57CuBTB/wCZ1hy6XRmuw+HlrS7K3X3rmFZ4gbZkKwOPBupPd7AepA4JsEo9BRpcOAsCqJO1lGwlkZbodeDI5XOXdtb3b9+x981PvSRHv+PMWHO8PBs9+GQEtvZ/RDtdMmywIAZZMaNeBTJjhr+J9NUMQ6Q1rgfssw5MFnh/jbV2YsojfZutOqhxyid23c0edtb/q745D9MAv88Yxd8gCXXsbHZ7sOhI8MjYi76zsPLwuHOaO5SsVoGhr06BpeAb3H2IOA83gBGj0IDqKmdl4waoIW60A7QaI+jVQ+Ohe4tW0Z5059+LPvSP+0A/mNGrvkAS24XLZjtPhwykk10VvGLWx8tQ5Apbrit2YAhr4ZbAkuBcWCL+JHdoIZJbEVqtaw+gQGF3BuG2nAgtBaxFc3OBGQlehJ0b7h3oZzz6k813/D6s4ErZ+jSD5jkxTXXzHYfDhlRUzyl2njPEbIEMjXQaEKzgMINr6HAAoGVQBNYi5shnFOzI4AJoybiWLBSKAVKA5qBLRwDFi3AIlQ0ulNoXqEnQO+nq1fJ5z73ucbffeQs4JAeyso58aTZ7sMhIeWRx+TmvLf9lu10KZpgTO5mxBW5S8kPgCqBFnA0juXWUIdmYiwwxAupnRdjHDBVoTI+ubUBWkFjBKNKszeFjlr0OOjedueJ8slPfoovnn82sHE27skgJO+d9ujZ7sMhIeaS/36Ovey/nstcKARM1oRmC1q5MwiDZ2txIMyAo/18kTU4YOWhNe8mR28Zl7ol3jGxmbcLrQehBVtibEWj6qILLe1V0P2vC5/SPPfc9/KOv3oth2gqVy69/52y+uukXLJo2Hzti39S3T9R5Eshl8xNxWw1oemzoIORF25nhQPVkThsrhOfsKD9tmAM1xjHjIX3kK1x6llyN+sub4GtyNWi9NCVytQ4dD/zf189tHTpncAHZu6ODE7y7HOfme0+HPSSGfOm3n9+71m6GPIGZFnh2K+ROfsvpl1JXajNZ2GRAYfjgLcOr46T1C1DP3cJLqRTGrC5Z8EcbAOKCmxJ3quwTUu1SunshM7nPvv24h/Pvxr44YzdlAFJbh/3+Nnuw0Etxc9uemPnb/7mr8ocGvOhyASk4ZDYnJZgoOq82ip4uOpBKLACx4r3UYMvHaIL39X/u+lBWPlgd56DFpA3EVtRVB3sXMUeCd1frJ+bv/9975Ev/fOLgK0zdnMGIDkHYUr+ZDMbznrdAjhgA9U6NldaV1wp/BLbybQaKxvfuuDN7S9/5Q3d3Tsb2RGQj3jv1+QuZNKAqHr7Ml+ogQTOyzUCK60D5KZkX/VqOfbCe8a5uvZL42xMzdx5swbkFaaqyClpLLJU26D74x89ofW5z/4R8K4DdMsOiOTyuYNvZGf4+GN/L9uycSXw9gN1ju6TnvbE7CtffZ097fQLpOr+OLvx+m7v91+3KN+w4aGy+u6nyPe+c9bklVc/pE2JWQnZPDf5zZgcigYM504FY+LsNzcRyX+39I/zVuqY8DCgq3C/V8UhbctoErjGT+80NQuSeXswd6MmWUFeVmhLKJc7VVz+8z+93nz7378LHDKxNdlx082z3Yc+KcdGzdjb/+IHYivbfunLnsVeR/j3TzrPeoGMvv3tX+996hNntpfM65j5i+/JsmwiM7KU7ZuXVpu3591SqeZBtgCKuU4jttRghufA/PmwZAzmDIFpOGBoBiMGjhIXAwxg6ks2wIF0XOFOYMqPgODDL4Tk1vCpoFvC7go6Pai6UHah6kBvEjqTVJR0Kkt7NZQboPXqV38VePmg79mBklw+9tHZ7kOfmN995Un5z25/vF204FZz680jwO5BnyN76MMeYy/8zjPLBVD0djTNxh3H2S6UbWfvMwrNMchGIWtBbgy55EhjGIZGodVw7KTUqfiKU5vpkBrUdiHUQBzFBatX4+zCkJoVb4I/zuIYtQX0gm0Z2LAAU2BKS54p+RKl3AblBV8/s/GFLz0H+P6g79uBkNz8xhmz3Yc+MVde8RyzYWPTHn7YcPtFZw5xAABYfOc7Lyg3rp3LEsibMLpyITQXoJ0udDsIpUssEHGIzDKXsZIX0ChgTuGdgmD7+UyWltSp98EmBCK4FAc4BRapu7INiUc8newFp7ZbAl2BnomTmlxaV45oSVZa8hElXwzlfbsa+TcveDWHCgDtNy+Y7T5E6X7ggwvnfOrvX8roKMZWo9LIx4AtgzyHyUbn8/3vvkCbQANkBAeaJYuQoRE/LFa66Za2SnL51IVcWrjkA/FsZLwN2BAY9YizCfqEPcV6plymbhLm7oQ5NaRKUzspGTAk0ElYULxNSIahJDNCPqaUAtXFP3hu49OffTxwxSDv3YGQPHvpy2a7D1GaX/7CKxu33f4YDjsMJieHzIYNA88VM3evf5q944ZHyhxgCPIM6JSwewKk6SixKJw6VZ+VIjgnoYlPlyJJuxdn740BI9qfBxiw1JeI4Pfp4cC8XGG1etD67YJP2SLJkMGdv+NHTERcGlieIT1DppZsBMxcqO5bP8Yll7yAQwGAXHJwFHavnvDYU0c+89k3sXCxV282SeQcnOglF7+U3ZPGLnXOZIGBrAk9C50ukDmV6+dqkPn0+QZeLeMnIPkGLW77PP/XJuGXBFNRVadatgfMAebjeD4dI4YEuOJVsYHJ1BYMfw3GCqZQslHo7YDqlp8+s/znf/0gBzCUNQjJO2//y9nuA7bXXjbnla/4SNbtHs6jF8GWnWi36NkFC7uDPI/Z0T1Fr77sGbIAtAmFBUMBRRPmZI7FspCpgk+bFweskOlcUafZKw5w89UByZdl22OoLYCWsC1BoSgsVNih0MUBLUzzTGOF4PrRErdfmOTuASiVkOVCNqL0Mqhu+unJjR9e8kgO8qmdeeOHs8uAU8991vDYO8/9cOPGm5/M00+EwxR2WGxHdtHp7BrkueS73zuDTfcs0oe655pX4pyKuQUsNS7WInimSm04qR2IvlELYFhhiXc+ymS7Jmw2HZCp41IqDCnMU9ioNQuGfeN3rZk4mgCJGaDikm2GwIyA3bRtWFff/WgOdgDq6rtn7eR6yvFmzhv/4P3NCy9+OY8/FlYaxyBVhrTbO1pfOn9g9YM7bz53nl5z+QtlDmgL8knIEJjThAW5MwbV1AeI0hdkTlUu1MBaLM72K1PGIv0yjc2YBjLxLAjcj48NBiDaxAnyxzXUmQLd0LyJXrdYF6c2Q1DuAnvrLacO6v4dKMntrbfM2smba+9+V/PbF/0xpx0DR7dckR9rYLKDXXb4xuqEkwZWqCe76D+fqbdd+RhdCVJBXoFpZDC/Aa3CpUDhQxxGEoZJwKfTPguBBfSzZcp+6ThvUNmpqN9ogWFgEXCv1AkLKXWG0E4Iy0xByoCCIFacf9LyJ7r77uP4zPnzgB37d/cOnOS89Z2zcuLs0ov+uPXOd/81J6+Ck8ZcdYGuONtm507Kxz39nmz1moHlipVrNp9F2RbGBNml5CowWsBow6U7aUacRD4deOloseJU7RxgCbXq1YTx9ioyrSFq+856xlugcL/CLo/w4A0HgKtxb09LnW3apt9T9nUyTdP9s9qw/vBs544VHNQA3Llj5s+6c+szhj/4d+9mxUJ4xEKnO9p+W6+CjlIedfTAUs31yBMeo3/4qmfLCtBSySvIGgJzG84GJCSUes+yr7IB/f+ugBFcdksLFzfUsOPeTp7SZ/p7bLwGdQMHwvFku2r/vhbPgj6GmJoIQXM3gSGwu3aNNX5y1QoO4rT9PPvJVTN6wu5znrl07M//+H1mamoeTz8aGhW0xQ9JGbh/Ajs8ulOPPHJgpVvlO//xIt117zxdBYy7EJ8ZzWG05cZyCfZfOrJhnCpMwyoVDiTLcdXwy6CL2ftoRnREEkbbA4/+R8Ux4RzcDLsJ6iE5jY3X5xnCBb87iRr2ZqNkLqSptmrZn9++aH/v34GU3P789hk9YXPDvX9Q3Hz7Y3nGCS580cY9SOvV3+ZxqmUrb2K4NZi3dtERy+315/0mC0FVyHpKXuBUb9HyhSQ9AAPThUSCEDpR/4IYnNodJWG+RFLPN43lBQkhmpTdgg4NY79NnEc8kbQXY49J+5mwR32aYLAY386OCWgOzd33mzZzktOcuaW69KlPOq7xlredw5EL4YiWS0vqSm179Sxs2kHveU/9YfGtfxuIA9I99UnPlLXXnaTHAJPq2G/IwFDhJv6EygZAzOFL7SrR2nRbjHM60kB0/LsX5osxvOnbpoE3BRbAmDqaDtnVgZWjA+TZtAhthfCR3+6LpEunQpetGN23OzazkuuyFTN2suynP31xtmXjKp53vLuhwYgG9zav20ElrV3dpz39e4M4n5xwai5ve/NZNCzkgnSV3IAZLtyMNlO48dSgfqPHmjQSVON8gcXTgKLJTtNHP/ZqE6YqOd0nObHVaMOxkwTEJOrYH1vggNrWGtPBDsz8v6cmD+rFAHOmZmapLvvC5w013/GOZ5nFTVjQTDw4dT5AZeC2e+k++bnfbf7bt38yiHN2R5ecrtdd+nRZCtpRcgtZS1w6VVY49RtUbyb1yxBtOa96h4FlDsQxmyUGrKefNQHjHkhO2ycJz6SqFhdwHqX2XTU5yCZgzHGTmIInnWwKea6KHtRLYeX6K0MHgxOzefNDszvvfCRHznMPvZfc9MzA7VuobHNX+/de/X8HdU753g9eyNS2kfAwc8C0MpfRbApipaoQegmqLM7t8GwUnY7Q8i8BHvhhvL3Zh9O+TM96SX9Xdecz6u06rSvxh5cimA15YqcmzQbnWKa6B/V0zVymBjrc+kslu/g/T8hsdz7z5vfbNrmBbT24dR2dl5392ea/fPXHgzhf9/f/eJH86PvP1UVgSzBhRa2WT6nPfCYzfoEZ60ck1GeaWHGbluI805LE050+tpb8pg/ghU53CVkvJECyQNM6G69HP2P2MaF1IazAgH6fYFG48cbsoJ53mzNDixXaeUuX0ZuEoaZjFnAPuC1wzS/oHnn0tZ1XnfORQZ3PXHPtk/W+Gx8uh4Ftu9mNpiXQzB3wTEZMa4pp8ymIxDkcC+hXzX34Shls+rZk/+mgTGsGpkyY7lb4EY9xW9cgtEqdrq+1w+HHlftMxHBJc+e1OYglZ+68GTmR7Ny6TKigkdc3rsrhxnWUJt8+9VfveItZf+99AzvhVZc9Dzsl2gSZ8hlWQ8bl+mUNZ/8F8O0x8iHOE10S2GZvJ9D+r6I1SKbH/PY4LFHRe/WG1d2fkA2Zpv0rxGE5qLOyQrv+3KrAUIZs3jT+627VbEoumzfNyImynVvGpMhcBjG4Sde3bqFas0nb73v3udm6tT8c1Ln0hMcstzf+5Eky3yU1G/URlzxzgecspx75MP32WVhscDFu4D+GZBKai1+ngTB1offwhvfCctFg0/ocgd0ydQDMceGqANpwzuDAGe/2+jilBvCVwPAwOr5j4FMaBim5ju+YoVOJ0Cx8GQsDd2zH/vxe2q96+bvkzjs+PsgzVcNLH8u2O4/hcKDnAViIY18TigmFilYJsIITsgCXG9jHfNPBBnsMbaSsBHu3B0XZwwGZ7g0rdbHKQl3EILZJvxoW91GxNUHi+i5ImS1YfHAzYLZg8cycadf2iqaf3HPH/djb76XzsjPOM+2p9wz8XLfe+ER6k5m2QHc5J9sU4rwQE9gvuIlCSlyMqstuFvrn6aYSVG74RxwNm2YTBnClIIsebwK29CVI44E5zgsfT7Zp0lZg3Uz9T1oPC/dA8kabY469f19v30xKzjHHzsyZ7rxtiqwJayeofraezpm/8W7g3EGfpvfS3xvhb971GOY5kjDW2X9S+EI/4tf1NX3Gk/tT4NjPleUjboiGvd8/MRvjsZCA0u8X7baU7abtAz7c4pEaACbifm94nVr5Y20YuqNeJMcXPNIKF9ZUoA2yfMHO3umnzYyN9SAl751+2sycqLt7K+OKveVeOs9+2ntod849ICeq7Cq2/OIEhqmXaMtw4Z4s8X6jm5iw4Bxq1RttumlqNjDYNPw6keiR1kCatj0cMD3FK7UFxduC4ON8iY0oCRjDPoExRbB+6FB6kM1dsFkre1DXismlmpk4Zb5mzQS7Jug+55kfK1/wvHcdsBPdePPDmdi4mEWgHWL9RzfmmyXhF++AhDhcC1fdNKNmoxBUTiUApG9TsMWkBlxfJnMS3pGEHUP5DsX3KQmv9B2bUG0aiomndyrYikbCNRbMnLkb5dprZ2ao60FKnl87Mwt257f/PGs/73kXT7z/g+9ij6c6OMlu/MwptNsuxtz2zzUTBzzjvfAsxP6kZql5uPkd6cD+LxPFgydRx6HyaWDIlP3SLJgAYIvzdPd4/6exnZl2bN/Hgq3QUh0eg8ovHQOa5cs28qMfzsxIw4OUXH70wxk50eRrX/t9hEvzG2/YeSDPI7ffdJSOgZukow4XBmLIxZiEVfzDHlaYG4K9iRrdY8QjgDPYbtT/jqBN7L0AnD4PNjSl9bYIaN9oOiuuLyE16Utop3IqWY2gvh/ag6wC+5BjD2r7DyC3D5kZJ8Rcd8Mde/u998pXSvGf32/0HvHIHvtZZtas2zDKlk2rpAnWP0A32BFGPILqTew/A8wR520mpl78ItNAmDogSRL1HqQ+3RNWiGXYdNrvaRwwgkvqBIPoqYcDExuxEj+0qS4GKLjQUwNM3tjnwH7nGU8+zi5fsZ0BV6T4ZZJ3XvXKmTjPL5XGZZeflf3LV19v54y9H/iv/WmrOvX0Bdnk/SvIqAsaBABG54P+hz+MczwMjk1kGpDCqEQAmeBUeGC1VF0HNmPatsBwSF2CI4Ar/J4ya2r3KdT0OM3tVnXJvFWdUqIW6IAZGSXftOH+fbh9jL/nna3hj3/0k2zauQZ49b4c+2AlH/7Qh2biPHuV8unPPHv4rX/+WdatH61Oe/gN7CcAjS2W2fa2BczFB2JroqvHfcPeHmy+REfNvcnMctnLx0C9UKH24yIF3B6/J2oT/Mw7/49s2jHTwzspGFMdYXHsZwXwgegKpAsyXPTsYcv3CYCNNT9r5evuXMpnv/aM9j9++ZvMwGI4eXnqzIRh9pAjV53aes3vfiDr2tFq1RJsObXfdWDMzTcvkqo9hF/doN7gp1oG+y+ouBYwF/d800nnqUfbBz7PYGnAue8TgKvT1ozz54vhE+r5Jmm96L2h2RgP3uSNsl7XKtDDBaCDeCeEVtG1S5fs0zBc69KLrVm/ZcJa0K9/7Y+rCy64mHq62AGRvDz7rAPZ/l7FdnVk5HWvfJ/etXqVPOGJVHfcjBbFfqcN2fX3zRXRIhKYAWPSBwp9s8hGcbPL0vK409ksqMPgkYZtWcqS6oECoH5bauhROxyVB4+o66DVftUvBqjqucmV1n1OEycQt7hNN3RBIrjVguQNy+jYPnnAevkt2tu8xWZLFyE/uvTZ5l8veCnwT/vSxr5Kbv515suzNe/f8of69X99rjl8BbSa6OQ4UjT2e8zSzGmOaWcy2mKp+9A3mhESDsY8C/Xt7MERazwHu4+6bkxQxRELnqVkejtQZwdQt5P2JbQf8RpeEHV9K/3LIoZ6bTl/fA+o3KT0tB0BsJXQnoorkzwQ6T7pObm97tahkcyQoZSf+8xrzLf//Vv4wcADITm/8RsHqu29y7q1p8r/d8Yf2wqK5Suh16OqLJI39j9gunDOXLplX+W0+GRDtStwD7eFG+yPweFEfVL/E1E3GpFLHdWOAExUNdDnMQdmRPrLeQTbE3y2c99r4raHSVoq3sNNGDB48Wp87ei634GwNQOdareyXTvm7cvt653+pIV0JpfQgHzFAiYvu/SJ2YUXnsEBXJ0zlwsvPFBt7yH2SU8zzf/z3rf17rh75dCCYVg2H9263Y1hygBqsU2OD0sYC00jKNPLbBic+s3CjsGZSNRqWFAmgi4AkIT9TA206SAM4IPa4QghGJW6NnQpNZiDXRcWvlFxpUpie8YlU9jKoSyWE5Eaxn5GHNvvzy3miH25fXLdNY9gzbrlPPRwirnDcAfYf/rCK4p3nfcN4IAsLJ1nRx19INrdq8jl//3S6vtfO0saUMybB0tbsLXjMFCV5tc28Gukag0N9eV3h9haatuDSzoY1hqpVv1DT4z5MLIQyrMZ68MvgQGTdvtYkFqVBnCGmF44RZjYFMCsgdlszXxx2a5wzgT5JgepgCyml0kpiGdBWlBuh9a1P3na5Ps+9Kn+C/vlkn3gvGfJrkqypfOQYcUMQ3nFj56Sr1v7RODiB9LGvkqu69YeiHb3kPIxj19YnPvmP+m1lZaALJ8DYxmYyps7dmR/z2HGd45q8D5J/kb2Uze5p2VdcUBN2CUWxAw2F37WGU4FB5D1BZ+pATg9VghEWyBMJgrer/Ggj0WNAl378eDAotbEJIO6JLBfRy4s4WV6YFyZXqPqfKEmlMOg37/wuc0XvOhpwK+twVcedcxj7AUXvLgxD2TRGLR3kC2Ect3ulv3JVc/jQAHQzlBpjvzOu86x1156uhRQNApYNgKFIEPG3d/77lu6v+cwkzKqGWigmmBuhWTPMLzV8htiqrsmjObRF9b8CEutpipYEmCl7Cok/6AfeIFhI2Na93vmzx1GNuL4tLcdQx8lfM/9dfgywo0KqhIpe2RWyUQxDajmQXfj5pHWB97/wfI9738Z8Evr8FWHrZrPX//lu3XN+sWN0xbByDDs2oiZ495Re8VlTzPn/9N8XAG5gUrOa1476Db3EFmz/mh55x++prLueebLWjCn5W7waI40gHvvXWX+5G3DwINyRsw9m0W/8/UR9QSBrbWYA49nu1BruU8pBeeE+mEH9gvOS0w2SNRwn2qXPuyRU9ePmQrnk2S0JHPtGf+RjBg9D8wYqm5lvu6GCLH+RmaceVB427KyZFMTGKuYDOyoq/PE1Vc/ypz37gvkJS851+zYcRHT4nr2occ+ho9/7Lzehd957tAqKFatcOecmsS0gHlgb7v5xOyOnz8K+MG+PpdfJ7nc8fNBt7mHmMt+/Eq95+aHau5WOmBhw2WJqsKcJmYEdNO9D63mLFiJW8Jln0U2XV/Y7tQIiSnlCEl89osP+IYCj6EkmvpqPvUQhWO/QqYVzUq9aVIPp98GDCAewRUZmsI98li+TetUrOn9S8M5sGdxpBBIr4zrXyPYi87uMFbd6uqVQg69udARIbvyR6fkN137NT3hpOvs6adfp8uWb5Xdu4bl1luPL7/wmSeW961f2FwCw0cugjmLYGIS2i6cJQvA3jXe0quufDoHAoB61YFd9V2e8syjufQ7vxPmUucLgeGCmGs3OkS2pAFr1y3Prr/yNB4kAKujj23JD/5jYRr7DdouAkbpX0zGeECEQf7w8AupC/+knxh6oZ/50myXXNz4csv/ZiVhW6kdkXhO/+8wAhjnJ6tfqBDfX7+jEbdzJVCEFLOQ55hh8oLW1G7yskfHQHeuUjWgOz7Z5IZrHi9XX/P4cC4VMEMwchgMLR5GFq105x+/H9pt914N+0u46vKn6Je/OsqA123J7RvfOMj29jzB588/S9fc+hDN3ZK3ZlRcOdwCxz7NFvmK+ciaTdhbbnguDzLmpK96xkIztX1FsOmCOSapXZapX2AwuLh+UwwUS71IYEbCdsn36XG7FIhhJtuQB4uV/rxBTQ4IKfcxNBM67IGptp6UHmyJuOqS8SrY2xlqXLZ30YChYWRqlGJqkqI7SVl2KFuWsgA7hpsr0nOH5U2hMVaQzZsD85dAYxjGd8CObdhuF+sXZNI5UN168ynFZZc/ArjswTyfXyZ5dtnlg2yvT6pHPmaRXPLts63iFhyaB5IZpzqGLb4EAGbpAvL5m+hddsmz8rec+3Dgpn09l1537VE6vnUhY6BVHb5z47fBiTD1GC3UjonxelNwNlW0/fy+JnEEgATZtc1mcCp3iNruVHwg2UwDOrUtmMYgw2+KA1XPozOEaoIzI+oYMA+5jZmzE/MCGk1oDsNoD7od8m6bvOyC7bkbo3j05W7N4+YQtIacSTS5GybHYWIX1lYR68wDu2bLCNdf92QGDUCuv26Q7fWJlOWz+flPHmGbIENghkFy41midFZymcG8RTSObNG9df1SvfHGc4A37eu5dGz5KbLr/iG70JFH9BvwNpIYdzNDAfDpn3BQHhwMrdVf6qRMV78h3jeMq2SQ7lhpUk8G6sVntD4+tRfCX4MrQl56mxBbO0CpLZr5NkMs0yqYyrFhowGtYXdd1n+C4RmSM0JXbQWdSehOQnscep3YTVGvhgF7+21PkL/9cIHj5oFIrq8+MGlfWonJ3/0XZ2nHonPAjPlrzr19lVfuZlUKQ3MoDltOvn415fcueHX+gU9/l32IO+nhxxXy3rc9QxtugEDKcI89+EzmVFaMp0HM8wv2m8ExX5aGSgLivEzPkHEN1Wo3Lu/gN8YVM5N968bomyMSDlO/X0mdoZMMt0U1Hb1pSV6SsN3W1xcmL4V2sR6s3rOuSuh1oddxAOy0UVv1FXigAQyDveXGR+X33XsM8LMH+mx+neRy372DaqtPzNadj5ZbL39aNQTacgwoUI8qaAmt0qmZsoBFK2kdvYldt24c0w//1YeLV//JS4EH5KLbtRueW13/g+ewmHjT3KCFQOEXGwzhE+NRF1PzIT7EAj/ma+rYX3AUgiOTql7BrS0yrNNA5o+JyaYeeNNXzUynceo0cIYYYMic6Zs7PE2CPRlVv+9nBF5gSevUcGV9yYgS6ILtQrcN3S70Sqxq/+kynBpev26pXHrp6QwUgJdeOqi2+kSq8um6dcNcOwqM1Izv7KsKqh7kJTRL5+2NzKdYeQTD4z9j4vabTtEvfOIr5q0ffB3wK22EbPOW4+35f/celd05w4L2lCLz5pHxc4CzgjghCWr1asUxYwBfWIqrL9NFa+BFO87/u4EHn9QPPyHMOv0+AVhqC0bPOzlfkHQSe3Bkgn0o6b/9XxsC2Z7lFAfAsNaIWge8qsLNWirdKIrtgXSdd1L2oHS2X1wyJUSpRsCu72HX3/dY4Pxf9Uz2RXK7fnD1gILob58zlH/4r56tAE2QptMKbn5uUAOlu/hmCd3MFSpavIqh9i5seR+Tt97wqOyv3/DdxuOf8ml97FP/RSZ33EVqe8xZNMdOdJ9Xfvrv/spuufUkcxhUPY2lkzNjXAX8ouEZrR439YmCtaGYiVe/Usf+UlAEVglgAsfkw7j9Y7aL1ttDaCU4GuHffoQmOhdh5+lqPcYevaNUZ7Ymxlm6TWuggWe7YBt61lPrWM9UYLruGWjP3VZTAiWqttbWUuOZhnMk7c9uPVXO/9JcBrQGXa5vedsg2ukTueHmk1l906m2BdpI4rbBCdDKvW29HhQltDK3CF/ehKXHMNLrIPlWJu+9c9nUv/ziXeaK7/9Btvyom+Soo9fonLG22bhprt5958nVXXecRG+yMEsFW0Fu1I2eGUEKH5bI/Tq/EqZkGvqnZ/p+5R58mQdmXwaN9AMkwzFfJuxRviPOZqNmq4gf7cNR3D+ANG5Q542HMWOBOB847BOqJKi36cLvVWA8vz0ATypfo86zX7D/Kgc8TAWiKILG9pL+C27ph9V3P7Rx3fXHAgOZz5tn110/iHb6RFff+QS2b5qr83HFsqF+0AbAr8Xb7bo3sZG5tKR2Bq0RWHk8w/lqisZG2tsqevetW9Jbu+6ZXPGjWEMS4+zKbAEYlEKgyIQ8E8d8jZZbhLDhQZjl3jAMqjjYd54Bc8+GKeCgX/0GdhuWumQG4eIShyUhpdrLFT8CogkwUzbz96byv2XqEya0BmnacACfgFOzHoiSql/fjlT1R0vPiP6jlTveWL9YgEanOwxnxkrEw6A7ts7lxhsfxqAAyI03DqKdPpH1dz1OrWO/OIEn3HQzjQGlC03j9GZp3argrVFYdizF0ByKuZuodoxTTvYou97UCVo0c+Zd3hCyzI/zNfN6dfNm01dD9Y5IHo3D2skwHkxZ8lv6MQkArbhx5BhuSWkxGP7022txm//NSDIMp/1DfVGt4thqxLrFrHuhLVsDq28tOX9Pw40Wm+Q6em/XerCVHqiVZ0BbuZsqONbtUi9BEYY18fe8CXZTD7t758MHBBVyu3sgqjyKfc0bVhZvOPNR1odEIgEY0EwcuVTWAbDqQdl1G3NxwdEycwxUNGD+ChiZR7ZwJ9nuXTQnp1zIoPRvrYgDVKh6leeuBFsAXKOot0nmPOJGsP3839yr4pDrRwq8xFOONfskCSJLv6pNPVSFPTzXQJTB5gvqOr6Y1A6GURfUbvl/V/4T1HhgSmtrVrVVfWwwOivv+dqKOOG9Kv1v/vgwoT2jnuuiWkehgh3oqxnrz247vjjzrAYOrvsleX7iSfvbRp/YSy45ke33HWaHnaqMAwjqn0dQKSH+ZHL3oC3uxuXW58H5g5vDTpWOzIVOB7odF7Mqez6U4G+Y8UD0q4i7kqjJXzGOaTOT2ILBAUnswT1yrBI128K9KDFBwO8zPcwSj0sYrY7L1NtDWpao60uVAlKcndnUZCXOBHx9ej4JMkcVHQCXfKwPvwQmjR40dSJOGCmS+t0LUSX1o352w33HlMcfvxjYbw82L48/fn/b6BNz+Y9PZtf9Teazh2kUp15YC2Xp1K9kNVKNBfEMFpZPCM/fZN6eM1Dm7njrK4crPpySeVAljoYrDuMZUNwnMFxIaQrgS+cOp/M9FF+rz9TAC6CKQEwvVOttKZZDwkHqCaf7hASNMLLRwk2an/C/B6fEqFPRAVSxHc924fcquOGB+ZLfgkcOkQkVHMtn1FnbSfdDsF63bVki27YfxiAAKNu2728bUXTBknmycfUJ4N6kviwlf5NVQayPRxnPgmp8Yqb/iCVWMQ3ZJKJ+nQ7BpaLjWDLWaTE1iDIPvCzMmfCvbiFe1Qc1DHE19Ok5ftNtwSH8mhzU1JASHsnFxkTEsK9nfWOIToehznwx1Nceb6ZvfwEupet+rY8N8R1Jjqn8fQtq1apLPZtnYdLCTpuwqGfLPgfHnVRCpAKiExI3C9AC7U7NMVdesQrY7/VccnPlFfvbRhQdm7OcO+88WqfZf24jPhs93CDr1LBkjgkVDwp/IwOQjAddrAqfAC4wT/BaDcQYn+QJkPy+TakZL40BxoHjRO/E6lninJQm/ewX2VGSCw0gnMaG0/cxHqDh+MA6UC8HYTxQcoUl3v7bAfXyDJ4pDcSAM4mdOM/CMoW5CuuTY9PAdQrAaEW4F1PQukYT9a2QBtitu6lGRw/bd4TsKXk1OrilxGTlypUysXVVNIWC4Rqeh8dRNJir0gOlclF5wanhYBcG9oohDG9HBZZKgZB6rGS1bRjqQBfixmtDZkwIvcSJRqZmwQgkbxo0qGODEZgk/ZD6mMAypH+pmXxvei2nznwJBCfq+qbeDlyO81K3q5ufFvCswd7zbY5ZtwjkAs+Aoi45Nsetxu4929iJqKWTPifvdh+J4NspQbdtecivwsIDlVy3DbAI0vLFh9PetjjMn473OLK8YwO1ilj19koXMDUQwkRuyeuD+4cJ2LvtFABgahCI96jB2VNDUoPZ4B2QBJTpaQJrFriwiwmgM3U3Uhsx/ub/xuh7wugWoucq1G+j4EHo2VDVh14CYNQx8FIPpp3ApEJH3YpTTXHO25B1tW4K36fK34eG/0xY15dId7qX2+r6oP5dT9MmBeohus1b5jMAydk8OABma9YupNttkfeDLzXC1dvJYtSzXVDFCaLijQnjd/73OLSVMFV0WpVoe6VOQDj/CH6sN6hc089+adyPcA7jHm5Qj9EtNPW1hRjfdDH4YTolxm1McoxCLFAZhgBD/C1kQJdeDYdtBpijzjvu4EDa05rRwz0pqcHuf3IjK+Ef0DdOHBgilgwh3ruYH5tYENqAbPOWeXvDwL5Kng0SgLmZb3tlM0wMSuNI0dTw3+PQUgiUtrwKTNVLKMxD8IinASCqTPrZMKpF/70QV4YjD+rX+JiW9IdjYhwQ96pn4gDYp2b9RZnkvCmNqH8RQhmPPUIz1GwabVf14Z2gH8UvxRquNYzr+iYMjhELnH1srQPo9Bc0BVefoZegCf8sSPftv6S+6nCerXu7ts9jAJL3dg3OCzaj2ZhSSd8cidT+A7CKVuK9PuuCytFDxQGwCjcwveMhKGwcaKM9OB08Uqu+gPxR9QFkqdmmzwYkueFSA6OJZz+TqHnpfzjTJWXnTOuk0gjU8Gba+jpDHDBPzlFRM2/ar1AZK9X7gVWN+DCL7feoQ1gnTBeMIcOEIalvF2h/5nh6veFZTu1/NTOAXKemBtEOALbqtfa0Wp30M6C6cFY0zCt3YUMCHQOTZa1S1QMwBJNVffjFP4yY1+cBF97WAKpCYD4+DUy9xyn1py9JVWpHJsOxXxz18Bey1xAMtbqP/1Z37l66XZPEgQD88ETV9y/8Ft7iKjmvcUNpmlxnGHIL7NVnDiQACyANfYuhGOnfPYa19nJNQQyYqanmXrbss+RmgABUse7xRFXgbT5TX3PIGLIWxCgSXzsLpoIRcbZPW503HMQqaJLTh5l2s4P9Jz6g7eljLk79GknARxLO8Q/e+FhhaL7hGTJl1cBiQRWl1BGAGQBmvBrNNDEH/H7hTTTG3YjMgytNSo1Zzoa4HFcasws2Tp9H6+N/KXOFYbwytfWmgTRpN8x7ChYCSXNhdwTodgsGIDndwRVRFzFVDCNoYgfiLyxE161SpzFVyVtv3TKlcz27dcLbD1H1aqoehHoerVfHJnnIc4HFtq5ukE+z/fzYZh0D9HdXxAEwDb301RmUaQCE+GQM9YUHRyQMse2R1RzO4W9WFjRCQEEAhrh4YJ+NJzWo8PcunCMALFgvPeudleT4yHY1GPvIzuzlt74ffpUd8sAlH1RDAHljeNKKuKRbv3geJBrM+jcrjBgJSJqShKfHocyBbRv1PP4INFOr2MCCIVwRjXzcENYy/MLP3r4K7JdrbfhPDz6HuFyRbItgSxkxXPU0FRbZUN15CnV2WWzDJsclgI/emt/cZ/95CRnbcb3l0J/kHma+DxH0uFoTJdQ1aVLWqylOkxhhIMo+LRzIpYJBrUM82PWCFywZJ88qJvztC/Go8ElDUIk6dovlBG9PXGC1lTn22imw23hA2zpsEbJTInDxOXS4WNhidaGXMOQW7L/wEAOIY2GgBAghOzqdE4JQFzmfBsZU0mGuEIPrJf+OLw3EaZIpy+aQxGtqMIeXLA8vi/9fSGLYG1UJztGZ9IwXY5l706vuEzlR+7eESwohHm02B6I6c20OxJYEoHzIUVvNjUXbjDNStYEmaKNmfALzZb6mZ6XJ8KYmasEDrWFgkYFWBeMGemlyoafToMoLYEhdnGyBusBzCDgb9Wlb1IZ/X82XlAXVZdNMB2UYKUnR2xdX810LZdaCGiyqegxbvOdgvWEchtXCcYJ7ybLYmGs48+cMq1oV1C9Puvp8vC9a27wddSMgMX/QJgfYvu4Hbd9H6kGjp+ynoCPDA3Eech0ZiDcNgB5xzL0MzduFbhuhAp0AyXGJCVBnBhnihC0N1QNC8Z14F/zf3Dovdo7AlHUZaOHhGXWgaimMiltkekTrshoBgMH2CwHnYAf2JaD682UeqCkAJav3C2DsAyj9eioOI3gwNz0QUrWL70948cL1pt9jv7Tun/qXM8xhnh7ris6Y/9rB3bNQhSE8CPqZOhZdUAjVxVINrVCPUwP50MjEA4TFr5Q8H9rvsnxRzPrN62gsuFfM3csF0DZoATKnfpNCGEat+NiyoqW4obkQ3xPbH6IQcWXIhoJe8EGykLbeED/XGB/xT9RuZMHE6Zg++Sj1dEO2TBgJiUkPhrjQjYS+hfikbyPELaMr6WmjYXwqVLhREJ2poBbLROeFvsQSvsbFS0MKWbwHQnR2QpwwxBmDg7LLs2SfcxTAmNhHEXwauxGnxSionzqCgnSA5SsHsgpTzvKVg2gHALvi8HXmiIf8nLuveQwZrsPhPRlzTFjXQlGwgopgLT4XQafdlKCewsO2XpXamsFyH3KRBHghnSsNOsdaL+l3atUagBazowPwPAOaBJQS3Fup7cJIbEHNBXsDV0SoAjoJ6yDU5XdtbXOmRdPTdLDIjoEVqc8bvWCtvXWjMC4uCyYNE0UPOdiYGkk13RQy/BVnMZCuY6XAkUcMZDplzpFHDKIdAPS6KzbpEcfdLEpM5QNQXx9PRsE2QEIEyY9vKuLGh6M9RKKFPSPGGWvh4dj64Yc5EFmwo9QlbMZQi9YpT2nu397q/IW6MGHyet9YcYYLHAiRQo3xTkR4OsH+C7ZG6bY3cb+Hsdugy8LIRnjHoGbBwFqK99jVAbkkAZTUMU3V/pU+dwMT6p03D9C+lTb72Y8+LRWeES5bzqtvLSFrAUcds9el1/ZVco46ZhDt1JI1rpO589syeX+rL5mxC7qLaCLZRvIcFJfio/iwTMJ8YhM28DdTwKXb44FlcWsB++9FVgebM3+MMXXSq1APwcXzUMcKg7ORVlIQQ1zwGj8qIxkaMrq9pS74lHfSKEXpbMEWQK/2WkPcMgQBws2yvm+xPrTU9ld8McOLiAcd/WZgD9he1RnQ4aXNtb7nfsjOgpuKabU2lSrQngOc9cEJfPdl7vxJMzpnIIUlczM6ZxDtRLHHn3SjWXL0XXLXdSdL5qncP0NVkClc2a8GaBPEe3za8yommFQpEAG3eItJQGgc2EKQObKc356ZJMwCcTRBkt9iBEqpJ0ZBBF9UtYH5fJ6iyVDxLrX6RbB9H9WnxAs+0KleFahvv6nQ6blpqIE1jd+O1mGVaSQVAWqps2X6Yi/pd2AXsCOYNLh7mZo3HpQazCHfpFrQLmjHA1D6m6UHsnTlfaxYMRgAsmLFINqJYnbdv0VPOu3H5o7rTpZhYKo2eSRccM9rhC5uLV8B3aWu8HsB7kFQOwka1G1FzBUMTkYKqlhGzdZ2oCGxBekPzfTlAKoPVhtiNa04nyTMrCvQuOihy+VXaaCSO/NBS8Rn9ygVWIOoL/IXqCWEUHo9p44rf31B5wXW6wtY+79CnWoVZtGFSADUaFF1Kfxtf81KEvIJtrX7BBNSK3WFEkqc8xiIQxOsq3tm5uRTflJ98XMb9gcnQfLqi58bRDt9Yp71vIvM97/4WqOTmQ1qWN1LHq/FM6L6ifq6HXQnyBzqVKagfk1gi2CUBx0RdVDNWMZSFwTXWhXHdT+0H4ih/WBnRZWbOdCZglCRXlP1S4GS4+qONFEqxPZwCq10DJhlqDWIeBa01LadEch7fm6u+BWR/MeKX4Y1OCD+puGZPqjv8Hv0+j3L9ayz/fDXW4bgXQCeR5MCAXg9nBnkZ3Cm70wQ7Tn7T5769EsGhZVcnvr0QbUVpXzyUy8tvvnYq81NP3ycNPzFUZN/GNJ1z8NPhGkLdgIYVrIwZlxpXTAyGEpRxYKrcSLenvPqNwC0b1mtaeALjBdsS9QxX+Fnz4Xsmyyo3QKVRm3/If73FipDILmzXbOQr56hWiEYyAyqyUIygY1SW7QSV64uuKIq0BE/Zk5tYlivSvxpUH98uKEh2yauMReu3bNf6IRfn067YEtfisPW74jCHgkJAExC9pDj7tHTTv/vQWEl19NOH1RbUcz4zl088fnfMDf98HEmx71h/j4o1NF0v+KAGtwNnfImE/jJS+rSj0Jmizi1FgcpRd1vJgFmqIIUb3pFn42YGuoGomVfiJtXHKZwZkVUu0jDAy5MoROggZoWiJsArRJ0VobgxrKVAtGu2z8cZpMb4ax/B/YASpSYsh+ZH6LBls43CWaH+n/HuKb1EYaqNlGCB971f0t1SkQ1km7Ae7grqerFgnTAPPP5F/L5z/1iUFjJ5fODV8EA+vwXf5PDT359tvGWY21RgzAN8Sk+VGMgKxUmQK1gc0VwK//Em6cWtzyVu3lRrQb9HhhSbK2Oo1MSPuzJhOFTeGdCjFe9uQdeA5XCqWJ/kGL8tiGQFjGTR0vQrlfVwcbKMAgqxjGi4E5Y+esytr6GmCUufaZfHJoL2TlhxlygqaCWFXfeAqc5VN15uupGYrrWvdB40Bk/9ltpzX62bireWgGdhHzZ4t385ou/Mkic5PzmiwfZXhSFe+zjX/AV+ddb3pWN9ZtsCnHQwPpnYgWySdCuQmH8alXBXvNOSHQ2Atj8gwnZw9OzPGLMUBPHwzsnaUA3MzUAjQebFM62Ex+4lMIBT/EAaYCMuL9BpHIviXYJykzI3HE+ZhgdURNGTUKMzjs9oSpEdI6kVqUx+RRvRHunrNIatBYXnF8I3AO0g3q2NWuqxiKUajRWcOtTvWlYSEF2Q37Wi77Fl7804BrRX/7SINvrE33pb39RLv/e2WbrzceZFlTdfhCC+27x934SzBQwpljvrjgzTX24JQCIOrAsQc1mdYPhT3yVw0mSTwjeCq46V7D/TJaAr+kZMIzzheNy1Izicr1y6sZxx2JwJdAsqgbxoxsaryl5OeIQpLrj1NRgkuRG9U39TF4ewjUGw9pvOMzCZnWLXnT9i+lHS7QEbYIOKbrT4Tian76J+HwM6C7IVx22jde89lP78vwfiBzQlZIUVutvnvMP8g9/9lHTwhVq93GsoC3wMyetD57KOLBYva0uXvsEJFXJA/AHBxUVbL3AcOn0Q6B253xbwW7K8OBLRjtMjlI41StFv+0neLU7iossa72tL5DZIaphI85JwXhnVpOAu3X0Ezz+UNUh9eSnv0yqxMn94f6kKStWXWLvyTigr7YuLlg5+88OK/pQ0N1gt/uwo29y+nwlrRwpNF710s/y1a8OfF233Hz1q4Nus0+qP33L+fkl336x3PnfTzFjQjWl8fmHm2rDi1+B3QlZD1faTdV7kFojN33zQxa0JI2ZEGowCTuGITXd89Pw6jfG/tKgs2fFvnM479fPVieCLuq/MLwSSuECkqNqXUkSyUA9oDV3TNk3LyUEp30MM3gFJgGZepWbJcxuvCqOoFa3FMbJFhZZ2GRhpzqnYynoqGJv8q9I4vHGyYcBiNugeNRjf8qrzvnEfoNhL5LzqnMORLtRsh1bdtmXv+H/yPtvOS3TbUNaEOvpxFmZ/vlZA4yDTIBpKahgRRHxIIweYPB2w4Mz9W8xHSmx/2I2dbAFfRuFgVbL23wZMaYnDZQCV10zhF98WzRRhokAjIkSAYgBMS1vC/oYlOAdDouqjxWKTx03YeTf1gAKE5rigoqh+fBvv58J6juYJ1qDsrLOHlyusFBdPfKeZ7ttzuQJA4cpAKPjMQH58GjXvPUd79E1qwdfyxnIdc3qA9Fuv4wOXSRPPftTXPjJP88Wg4bRERLKx9vebbA7gAWQibpsGajn6IQM5phgGYbnEtAZ/LbwJJLQjOB+zw0MtSAPTkYDMl/QmoYHY9gWACi4wtABgOFk0+IVMU0rbLe4JYr8hRrHRGlozjXlARlGfprGz/vVesdwD0IcM3j40cb1zkZ4yWL9QHWpb4CWit0NVad+XaLBEp5LD2Q3NF/5io9y0YXf3PeH/sAkNxfNzIrp9lWv/bC57ZonyfqrT8vmC2U7UcVAcA6sBXaA9MC2nNWk+MKWYmtjPDzo4N2CB5hnBZPsk2YCK67M27Av4RtGPGLIpYnSAtNy4KOgrnZVePZrUZfVCp0PjXtbtS/O48AXzStfr0ZR0AqxlVfFhQNhUA0NX0Z3KqiL9BohxkPTYHNgwjSY4u1N62tSViWU9zsAJkf1HSKboPnU515i//wtH9jfZ/+rJLd//pYD2X4qG/QN73ibvPf13zTdDfOyhiuQOt28s8YZxzKOi/FSqwdJJy+lDyOEZKJqts6xiJ6zOlVUZNAs3ApCxdC0QHMDG0v6t9xvFD7pABfDYwgYpWa/FIABXqkqTsf8ev27+hdFK9dfMSXOCC58TKR0HnnTA7kjLo5HAsQYIba1+o3FK0P2aN0rdx8VOwH2fudghGhO3EFAt0PziKN/kb/+D/+M227ZPigA7E3y7LZbDmT7/dIwP7TPf9UH5Mvvf3+2yt++QPl4cstAus47YzF+3p56LutzB+u3PtqG1MZ6YWEsxPb8yEY+hFsxsZHYfB580uz7t+JHP8ic/UmOxpq50weTpzNgYEGowVpvV1FEa/tP1Y0j12AKSX8lZP6lMerDCL6dEMQOc2P6QBhYNLygfrasqPN4t3oPmMTuCz28H4rhxbvM337izyq4cX8f+a+TvIrxsxmSs37nw7LuF6dwzb+cnS3DZV74TRbn/Kl1b6hMgM5PrCvBDdFBoooS9gtMmNnaWC+MA1Lmi5WLzwUzDR90bnqwNb3aDUVXCtDMqUvAl9eiTmcJE5dSSV6QUMo/AlET88G9UhLAZnuoDPm4c0mdhePDA6kXH0GqiWechHGiA6aEaqmqSqWKNVCNQ7XRj0z5iE6cHjIJWdWk8aa3/jW33/btwTzwXy25uf22mThPLbff1tPX//k7szuvP7HacefDs/lC1dUIQgVHMJNQbQeZ70egAgtGQ9vURwTwGe8Zo0lQKzgCPr4WxnSlANPw6VRNz4puOXWNlX8yb4Fm3vYb8u04BnTwSxkwXgEayrul9CIkXleFUiKUrh9+3Q4JscesxE2o8XoyXobW1VAl+ZtqhT67UN1/4kY/7Aaw497UicYfaAfMdhh57hl/ww0/+dj+PeQHLnl2w35XWd13ueEnd1d/+r43mY+86eu071ugLaHyhbjDQAAW2AK6HHQOcYTNpculNzuxhaItCPW6GUI9/dKrYxNA1AATPF/n/brwS06/k1EQVa/4ZIPapa1BH1kOJPYH72xQ91khBKmdqm3gVivKwXqzoZrGsNHuq6Zd83S1b/t+V7XulwzsZtANibnjm9AumC3QPOv3Pl+e87pz9/fx7ovk5R+/eSbPl8ol5uw/Oi/7x7d9lCF1eQYA4kGWA+NgN4Ido15dVPcGvmBsh+8+JlHaGpAxqNyfZKA0cABo4lK0nfPhvF+pnQ9peuAF8AXgpfER6n4kq2YKuSt9qxZn1AbPq8RlzDgPWLVA8FnXYQJUH8OG7BavutO5vvF+OJsvANGi2Eyx41D9AmybvslhWoJsgdbzz/5m9Z6/fTMDXIr1gUheHT3gOSH7INXRx3ys2LTmBPNf//C6bJG7GQo1EyroRrCLFLtMvPp1LoGkVY/6AEmtfko/oSEMb8XsZu/54j1d6u+EALRnPyXDsV9SUkFqBkwy/cC7K7WDFGIvimB8W4GdKvw8UlR6iDqbTyVDQpp/mBsCvoxdsPWCvefbit5v3UU3iuTjqFap1jjHLpYg9I6ybIHmk553MW959x9mW7fev/9Pdd8kz7Zunelz9knvNW85t7nupw/TX1z5+HyeUPa0HhLKgA7ovWDngZ2DH59Xb7D7B23Cd1uzn1FiHepQZDJOqcxRfKYLQf0G1ev/RhvTsaL0BZelBl4fCwYCdDaE4k0A9RmkbrUenCORE4fkolMT+icxJFIzqvdsowSm82war30a+xml2gTVeh+ENnVzsh2apzz+6vx1b30NmzZsHMTz3FfJzaaBpPY/aDGwsffGD/5J40PnfKu37a7DzLBQ2cQexI2MyEawo4rJHZ+oqLOzUmOGhBHDgyl9sDEO27kHryY4I8HeC+wX6neET8iEkQRs01VwyoJeHap41sOpSxXvzNjkmMSOjHanqX+P2t15yjXIbH2evhTSKn4Uixql2q5U9zgnQ32Sjq2cwzF02LG3Zr/1mnO4d/Xq/XuKD15yc++BP/fUKSflZmIyhDv3ItW11Sve/u7GJ17/WVv1sHkdxVDvB+gGz4KHubFhVeu1nNcpaRGf1Bss/QBoqMHngeNGlzM0OhvprKWUlXLPdjXwpG+YbXooJoxFp1548gnTOFMg94HR038c/sPRle0m6teznHrGm8Z8eLuvHIdqNegujQFnW4HZCcPLj1prXnDOa9ixYYbDIP2Sy44Dz4DZ+KqXNy664Km94x/xaVm+6mr2AkQ7d+XneMmfnNb81odeE9LD8WpYcrBWMesEOwaySCO7SF9g2tKXHCDWqeDuJBTz47kUEz97B1/4nrJSEnhOy3JA4qy67J2UwUStP0+qPqeBElOP9MS4SHAuLFRtN2ykKdDS4Yswhuy2qViqrmLXqAs6Z8TZdNk4jCxZNlH+ycffZOHKfXmOB0Ly8oSHH/CT2GVH3FLcced55mv/eE73jDP+mSe+4BPAHrllE7/15g/O/cVVT7K3XnZ8u1mTmfocUdsFuRfMMOjcgOFUpYUx2+Q3tdCZgKGOry7g7Szjgabu30qI7aXgCkBMHY9+5pO0th9uGoHulfmkNsCiZ0Fsp36JAntWXvV2oZqg9nrT/BVbM20Ap7FUHaVa6wPO1EWGmIKRkRx52ZveU2y89ZsP9nkOUvJi460H/CTFxluv7/72617SWH3P1xr/+PXfLm+5/Az7uKf8mxz7qH+0yx96Ob7IWH7r1Xd1nvmaj+V3XfkPRqpYtSLGbnPQcbD3gQw7UBq0njsifj5hfOheVZYd6I1DcwnOaww980ZmElpRsmkqN4AQ+sGXghH6ST0NzUz/pFKrTIl2XVCxwZMfh7KdgE+T4yofcA/DepaqZ6nWKtVajdMrqVysr2Uhe87vfHvq9DP/bp8e4AGUvHP6mTN1ruvNy3//ZfKVL305v+6WE3XL116hqy76reKUJ1xsH/rY71SLDr8KuJmpyTvKxsIJmdw8IkMS3l8/W1Hdkq/bQdcrerSgJnl4IcwRWMlaYv2X7k6oJqGY44NfFjcgFgCVju0mf9UD+ZeBKiSHhu2Rbujff48SA6kkQeVo11VQ7obu/fTZtlrVgIv7uhXPbc+FW6q11BPLraCVknWgecSRu9rP/qOPSHvnjMb6fpXk0t45YyfrPeuZN2SVOVv//RtfyO68/tRC7BBbvvfC/NofvJDDj9oqrbHV5dat86fGt47Q8qGwYDolz1dF0S0GHVb0CEFz9cmdQkxlTwPSZFBOQGcjFIuoh1psHe6IJwl2VT18pwgSqpiGTqRfk3R/je3YuL2WBGjpRUUW9MBTC3YSepvAdvyuwcNNwi3Sc7+bCtuzVOsC82k91dXvmluQIx55Fc2RaPqUKxoi2l6QXXtTkd111zZmOAgNkGdXzUw+YJR53Mxr/+zszpc/9cXypsse1zrqCHRiiuqnty+yRhdVGS7fM4TFbA2JWL0idw9dNgg0FTncT+GcHuJI13ZDoL0JGguQoXmAYrGIzzrRaFsJGuN84hEW2NUBRukPP+/p2qdB6HS4LPxJQybWM7gr52EoHbDKTVDuSkwL/xGfqhW9ihLtVti1il2nsfhqPSCiLl2ygN66W47Irv/GC2SMbdbsPrm1Ljstv/ma0+S6zQur457yemDG7cI82zTAteIesGy5077p3LOrT3/4M5OXf/c5Q8cdRXPpI6k627DVdjLbo9sumZKyXkA52vXO03Tr0Sm6yWAbCoeBKXxcUOgHnoAL/PagfTfkC6AxhviHPi0Vwn9NB/lTFgzbw/fpqrUGWqy47NPn6wrM4WNxpBMA5tdHKXdAuZm6SF8YBUnStKjAlOikdQ7HfVBVGgsMBQCGnNVeAzr33Xlc49/e+7VsrGnzrm3m6ydhTUXvaS/5cffxz795Px/qg5K88/jnz8Z5ge5a864P/3b1mRUf2fWdz7xi6PBxho86iWzoOGCK1tRW2H03E+JrYSd4ilxnQEqLbhJsE2SFIkVIf6oSsGgdWyt3Q/sWyOdBNuJAmbBRAJ76SGE8eQSTqclNPVMK9AMP+oGW/j8gwybn7YH2HBPaKeitc38Fz3bhmJKUCXXKM996xVa2Jtzat3HGgPeTRoeGKbIFBbsyys2TdKt5HXnxsz7aPucv/gY3b27GJbcrVs3Geb3YbfquD/5+o+zdN3XhF9/anfixjB55FPn8JTCyiJZMop21TCbc4UId3g5EqLytYzZBVUC2XJHM1mQWVF4kKgPdTUj7ehiei9JCtItKeLjh6eFKrYntG9aV+CVEIbU+197YcC9M2A/OwGoeWL3V0NtAnajn2U/L2vmQCh232DVgNyvq6/rFyIwmZzCgOQz1oDmyCMt82ps2UI0sudk8++y3Ad8r/vMb+/8oH6Tks3lyL11OOvrtrcVv3Tj13c+97/477x4ZXraWobE5mOGcVtagouNqkzONbHy8zRpFesBGi80Es1yR3NZACaMKka0MdO5BiuuRxtNQbeHm8YZE1BCeSYK+vtJ6zM3WlPmmW4GJ17rHv21iw/mPVq5IU7UWunf47eKGLQI4AxNqhW63VOssul3deK9Xu264WOtqb8EMztyI5K771mJ1V4enn/OZ4oiT3w/M7jgskLNwsPUBH7Qs5GPNR3zm7vJjb/347vU/P7K9chstFfKGuGIFhGfolaOG0V9nE1bicjjtJhc/kxUgLc9eod4EvhE3tAJTt2CyJdjscaA9VDrUIx/hCZa+1ou3AUlVsCacl4IwpM9OC6306ccSp3r9vGDdDN0bwE44sGsNTrBgKigrdLNS3avobp9oaonVrfrnWBItB90FnXZOvvSk6xqPPvOdwEVsPSCzLPdZ8oOlIwCG+77bfPFr1mU/+vYn2ndf9sTdS5Ws0FhGJRCJG9wKHmlMQ8AaxVSC3aIu93QFMGTrPYMrreqTPtvQvgIZXoTKKc4eFL+AtobZcKXTYRLm50EsIEQKu2mMB4kaDSEfi1K5cEtkNRB2Ib2fOM+XvFa3qcrtWHSjs/eYsh586rW6uHJrldZZzgq2regOyIZWjDcf9YJPZCc9+cO49acOGsnN4UfNdh+my43mkR94UfMH3zivuvCTryt73cwudqSVZp+nlbawLt08eKaiYLYpVgyyDGTEurCNqmeXBITlNqR9MWZoAVaORukRWVB9rI1GBJN6FR7ZcA+ZHutTbyemoZcyqlmRNlJeBr07auaLqVd+bHfcoustuk3RsOZbyEWwOPCVEGqsaccDj1aVnfD4i+SJv/s3wBW2bzz64JDc5gdfp2T8rm1y5ivf2Fy05HJz6ZfP662/9SEsxS0+GGzyTF3RH1uDMRSaMri/ssNiKoElBhaAi7lBzO8PgOytRrILkebLwC5DpU0dSzS45NWQluOZL610T+0n9zsYKUoSh8LH8ERKTHkFdK4hluq1HnxincrdpugmxY4rWMfAtqoxqqG6aeXBuROkyjEnPO2a7MTnfkjy1r/R2z24FSkHLDL5jU/Odh9+pWhn9Jjq2u+/q3vTN8+2eTuXxWDmEIsXZIWE6RxIQ9zcohxMQ5BcMJm4Mn4LDSwWZEgwYQGazNTFzE0Jradj89/E6gj1PJEmMIQyiktMnT4lM0iAYJX8Dd5tjxBqcSsHthHpYewPkc4FUE656HqYOa6VU7Ob1QGwo2hpXRMdX9m0Y92Mwi7olKXaqUg3wyx75G1y8ks+ric+82v4VUIOZpHdN1092334tSLrt2V67x2/Uf70399S3fOjx+lID1kIZgikKXU1jYa4OUYFSC5IIS5hIQPJDcwVZLEgcwTJjctkMcbNvTUlZAXa+i2seSqqBbFhWg6AYYgmzLDD1/uL+VheTYMbYYkxxh5uvayO+4hi7FWYzheg2ga26ZMKPIXvstiNCuPeruupq2ra8XZd14HSTlh0QqFnYO4xa8wxL/yMHv2MzwOzkt38YEQmLv+P2e7DAxZtLB/jqm/9fnnj199Y7b7jaOYoZi6YIanrCDU9Cxbioi9FYEVxFflbgiwUzAKBpndlMg9C6UCxBNs8B+VE53JEEI6gzKVvXvBebcBE3eIrf1MCHYQ2YDB6K6b7KeitAR0iVkYtLexwzMeE93BLBzg66rKapyx2snLAqzJ07Oh1ZsUTv8CyU88HVh/oZzBokamLPj7bfdh32dlcVd156evLdT/8PdvesNTMB5kHNMQBMBQ4yDwLBkAWgviK8jJXkCWCDBuf7GL8cg5tKB6GbfwuVpfgVOsQTg3PAUapE1JTEAZ7cC8A1MCAgmE1WfcT0L0JbKg9Yh3DbbXoNusW9fHMF8E3ZdGJ0q06RQNdcMptLH/iVxg94iscgsALIlP/9dHZ7sODFl2z7YSqvfmP7N3//v/RWT+POcBcwbQc6IxXwTS8Ki6cXRhWSTLD3i6c49lS/JySrIu2noPNz3Sq2K0FizICzEf7WDBJxcJXP03TUKLqFYTNZN1/QLo/AjvkvFasKz602aK71BcPV79YjIWJLkyqWzSmuXjCLn78pbriOV+ToWUXAbM7o2wAIlPXzngCxMClN24fJXde+FrWXPhb2lm/gFGQUZAh45wRD0JTiKs1XjgQinGMKYsE5oknNgOmB/kQOvRKrHmMH3FpoIygLMCvhM2elc7TuF9Y3a+LYBE7QdY7H+n8G1Q+1V8tTFrYrOi4OrLsWuh00anKMaGZa3XkmJ/Z5c/5ro485N/syLLrmIW0qQMlMnHroWMD/jqRrTtP0fVXvoJ7//NMJlcfqVkXGQKGxYGx6dSwyXA1YwocCHOBxQLzwcRlWiehcTy29XtYFvkAZAvVuSiLiPOEkznCQB08jkzY86T675j2/3Up9rbh7L4pD76dFjod6FZoV1Azhg6tXKNjp1xi5z3quzp09I/4f4Dt9iYyddMFs92HgYtsWne4pXOG2Xj5mWy7+nHa29QiV2jhV1YQpMiRpvF5h44JWSow6jMBjYWsQltnYPNnu7ifNIAhrCzCBSVd7mDMGQvZK1q5crx0gRxT/ox86v3Qu8fZfWXl1ovb2IVtFqxg8/mVDh9xpx056XIdOeZiGot/DNw7W/dwpkQ6Nx7cccD9EaurmnR3nKadbS/MNl72HLP79pOYuisna/uV1qmLHmSCGclgmYGWr4olbSRfhQ6/EivLUQyumtYYymJX1AjcUB3UoRSsK7dWWrBdivankIlvuaW3gnk4OQcdn7fdth5ys5336Cu1dcRlmo9dCwxkIehDRaR9+z/Ndh9mRHrNx8433V2Pld3rn2523v6EbPdNJ9HdMteU6xCzETWTkJXIvMqNmqQrc7Wej82f6NcMaaIyjMpcrC7E2XJuCEyq0tXmK3tI1YMqJ+tejel9ArRXabZsizYOv8MWR91Ed961Nn/4DdC5E7es4P9Ikc4dB2alpINZOq3nj5ANHydTk48wU/eearpbTpTurmOkt2WJqdY1JduCNMeh6IKZgnwFWpzsV0xquEQFzVDmopUv2RYWl8GoipnCZFvJs3tM9otfCD+9TRuH/cw2Tvi56Ka1/A8G3HSRzubzZ7sPsy5T9hVNMXY53c7Rpt1ZJWKPlLK3CquLKNsLxO4eRasGRjNfJ7gUIx0yM6GmuYu82EGeb1axa5FsgzZH15Nna6XasRmYmu3rO5jl/wcfhxWz4Weq8wAAAABJRU5ErkJggg=="/>
</defs>
</svg>'

export default defineConfig({
  name: 'Test Metadata 2',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  icon
})


================================================
FILE: fixtures/valid/pricing-3-plans/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-3-plans',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      features: [
        'Unlimited images **with watermark**',
        'No backend generation',
        'No custom templates`'
      ],
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ]
    },
    {
      name: 'Starter',
      slug: 'starter',
      features: [
        'Unlimited images **without watermark**',
        'Unlimited backend generation',
        'No custom templates'
      ],
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 999 // $9.99 USD
        }
      ]
    },
    {
      name: 'Pro',
      slug: 'pro',
      features: [
        'Unlimited images **without watermark**',
        'Unlimited backend generation',
        'Unlimited custom templates'
      ],
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 2999 // $29.99 USD
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/valid/pricing-custom-0/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-custom-0',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingIntervals: ['month', 'year'],
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        }
      ]
    },
    {
      name: 'Basic Monthly',
      slug: 'basic-monthly',
      interval: 'month',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 500
        },
        {
          slug: 'custom-test',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 100
        }
      ],
      rateLimit: {
        limit: 1000,
        // TODO
        // interval: '30d' // 60 * 60 * 24 * 30 // 30 days in seconds
        interval: 60 * 60 * 24 * 30 // 30 days in seconds
      }
    },
    {
      name: 'Basic Annual',
      slug: 'basic-annual',
      interval: 'year',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 400 * 12 // 20% discount
        },
        {
          slug: 'custom-test',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 80 // 20% discount
        }
      ],
      rateLimit: {
        limit: 1500,
        interval: 60 * 60 * 24 * 30 // 30 days in seconds
      }
    }
  ]
})


================================================
FILE: fixtures/valid/pricing-freemium/agentic.config.ts
================================================
import { defaultFreePricingPlan, defineConfig } from '@agentic/platform'

export default defineConfig({
  // TODO: resolve name / slug conflicts
  name: 'test-pricing-freemium',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    defaultFreePricingPlan,
    {
      name: 'Basic',
      slug: 'basic',
      trialPeriodDays: 7,
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 499 // $4.99 USD
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/valid/pricing-monthly-annual/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-monthly-annual',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingIntervals: ['month', 'year'],
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'custom-base',
          usageType: 'licensed',
          amount: 0
        }
      ]
    },
    {
      name: 'Basic Monthly',
      slug: 'basic-monthly',
      interval: 'month',
      lineItems: [
        {
          slug: 'custom-base',
          usageType: 'licensed',
          amount: 100
        }
      ]
    },
    {
      name: 'Basic Annual',
      slug: 'basic-annual',
      interval: 'year',
      lineItems: [
        {
          slug: 'custom-base',
          usageType: 'licensed',
          amount: 70
        }
      ]
    }
  ]
})


================================================
FILE: fixtures/valid/pricing-pay-as-you-go/agentic.config.ts
================================================
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: 'test-pricing-pay-as-you-go',
  origin: {
    type: 'raw',
    url: 'https://httpbin.org'
  },
  pricingPlans: [
    {
      name: 'Free',
      slug: 'free',
      lineItems: [
        {
          slug: 'base',
          usageType: 'licensed',
          amount: 0
        },
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'per_unit',
          unitAmount: 0
          // Free but limited to 20 requests per day
        }
      ],
      rateLimit: {
        limit: 20,
        interval: 60 * 60 * 24 // 1 day in seconds
      }
    },
    {
      name: 'Pay-As-You-Go',
      slug: 'pay-as-you-go',
      lineItems: [
        {
          slug: 'requests',
          usageType: 'metered',
          billingScheme: 'tiered',
          tiersMode: 'volume',
          // $0.00467 USD per request up to 999 requests per month
          // then $0.00053 USD for unlimited further requests that month
          tiers: [
            {
              upTo: 999,
              unitAmount: 0.467
            },
            {
              upTo: 'inf',
              unitAmount: 0.053
            }
          ]
        }
      ],
      rateLimit: {
        limit: 1000,
        interval: '1d'
      }
    }
  ]
})


================================================
FILE: legacy/.editorconfig
================================================
root = true

[*]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true


================================================
FILE: legacy/.github/funding.yml
================================================
github: [transitive-bullshit]


================================================
FILE: legacy/.github/workflows/main.yml
================================================
name: CI

on: [push]

jobs:
  test:
    name: Test Node.js ${{ matrix.node-version }}
    runs-on: ubuntu-latest

    strategy:
      fail-fast: true
      matrix:
        node-version:
          - 18
          - 22
          - 23

    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'pnpm'

      - run: pnpm install --frozen-lockfile --strict-peer-dependencies
      - run: pnpm build
      - run: pnpm test


================================================
FILE: legacy/.github/workflows/release.yml
================================================
name: Release

on:
  push:
    tags:
      - 'v*'
  workflow_dispatch:

jobs:
  release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: pnpm
      - run: pnpm dlx changelogithub
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


================================================
FILE: legacy/.gitignore
================================================
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
.next/

# production
build/
dist/

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env*.local

# turbo
.turbo

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

.env

old/
out/


================================================
FILE: legacy/.husky/_/pre-commit
================================================
#!/bin/sh

if [ "$SKIP_SIMPLE_GIT_HOOKS" = "1" ]; then
    echo "[INFO] SKIP_SIMPLE_GIT_HOOKS is set to 1, skipping hook."
    exit 0
fi

if [ -f "$SIMPLE_GIT_HOOKS_RC" ]; then
    . "$SIMPLE_GIT_HOOKS_RC"
fi

npx lint-staged

================================================
FILE: legacy/.npmrc
================================================
enable-pre-post-scripts=true
package-manager-strict=false


================================================
FILE: legacy/.prettierignore
================================================
packages/openapi-to-ts/fixtures/generated


================================================
FILE: legacy/.vscode/launch.json
================================================
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "tsx",
      "type": "node",
      "request": "launch",

      // Debug current file in VSCode
      "program": "${file}",

      /*
       * Path to tsx binary
       * Assuming locally installed
       */
      "runtimeExecutable": "tsx",

      /*
       * Open terminal when debugging starts (Optional)
       * Useful to see console.logs
       */
      "console": "integratedTerminal",
      "internalConsoleOptions": "neverOpen",

      // Files to exclude from debugger (e.g. call stack)
      "skipFiles": [
        // Node.js internal core modules
        "<node_internals>/**",

        // Ignore all dependencies (optional)
        "${workspaceFolder}/node_modules/**"
      ]
    }
  ]
}


================================================
FILE: legacy/docs/intro.mdx
================================================
---
title: Intro
description: Agentic is an open source, TypeScript, AI agent standard library that works with any LLM and TS AI SDK.
---

<Frame style={{ maxWidth: 308, margin: '0 auto' }}>
  <img src='/media/agentic-header.jpg' alt='Agentic header' />
</Frame>

Agentic's standard library of TypeScript AI tools are **optimized for both TS-usage as well as LLM-based usage**, which is really important for testing and debugging.

Agentic tools work with any LLM capable of function calling and all of the major TS AI SDKs, including:

- Vercel AI SDK
- OpenAI
- LangChain
- LlamaIndex
- Mastra
- Firebase Genkit
- Dexa Dexter
- xsAI

## Features

- ✅ All tools are thoroughly tested in production
- ✅ Tools work across all leading TS AI SDKs
- ✅ Tools are hand-coded and extremely minimal
- ✅ Tools have both a good manual DX and LLM DX via the `@aiFunction` decorator
- ✅ Tools use native `fetch`
- ✅ Tools use [ky](https://github.com/sindresorhus/ky) to wrap `fetch`, so HTTP options, throttling, retries, etc are easy to customize
- ✅ Supports tools from any MCP server ([createMcpTools](/tools/mcp))
- ✅ Generate new Agentic tool clients from OpenAPI specs ([@agentic/openapi-to-ts](https://github.com/transitive-bullshit/agentic/tree/main/packages/openapi-to-ts))
- ✅ 100% open source && not trying to sell you anything 💯


================================================
FILE: legacy/docs/mint.json
================================================
{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Agentic",
  "logo": {
    "dark": "/media/agentic-logo-dark.svg",
    "light": "/media/agentic-logo-light.svg"
  },
  "favicon": "/media/favicon.svg",
  "backgroundImage": "/media/bg.png",
  "colors": {
    "primary": "#0D969D",
    "light": "#13D3DC",
    "dark": "#0D969D",
    "anchors": {
      "from": "#0D969D",
      "to": "#13D3DC"
    }
  },
  "topbarLinks": [
    {
      "name": "Twitter",
      "url": "https://x.com/transitive_bs"
    }
  ],
  "topbarCtaButton": {
    "name": "GitHub",
    "url": "https://github.com/transitive-bullshit/agentic"
  },
  "anchors": [
    {
      "name": "GitHub",
      "icon": "github",
      "url": "https://github.com/transitive-bullshit/agentic"
    }
  ],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["intro", "quickstart", "usage"]
    },
    {
      "group": "AI SDKs",
      "pages": [
        "sdks/ai-sdk",
        "sdks/mastra",
        "sdks/langchain",
        "sdks/llamaindex",
        "sdks/genkit",
        "sdks/dexter",
        "sdks/openai",
        "sdks/genaiscript",
        "sdks/xsai"
      ]
    },
    {
      "group": "Tools",
      "pages": [
        "tools/airtable",
        "tools/apollo",
        "tools/arxiv",
        "tools/bing",
        "tools/brave-search",
        "tools/calculator",
        "tools/clearbit",
        "tools/dexa",
        "tools/diffbot",
        "tools/duck-duck-go",
        "tools/e2b",
        "tools/exa",
        "tools/firecrawl",
        "tools/hacker-news",
        "tools/gravatar",
        "tools/google-custom-search",
        "tools/google-docs",
        "tools/google-drive",
        "tools/hunter",
        "tools/jina",
        "tools/leadmagic",
        "tools/midjourney",
        "tools/mcp",
        "tools/notion",
        "tools/novu",
        "tools/open-meteo",
        "tools/people-data-labs",
        "tools/perigon",
        "tools/polygon",
        "tools/predict-leads",
        "tools/proxycurl",
        "tools/reddit",
        "tools/rocketreach",
        "tools/searxng",
        "tools/serpapi",
        "tools/serper",
        "tools/slack",
        "tools/social-data",
        "tools/tavily",
        "tools/twilio",
        "tools/twitter",
        "tools/typeform",
        "tools/weather",
        "tools/wikidata",
        "tools/wikipedia",
        "tools/wolfram-alpha",
        "tools/youtube",
        "tools/zoominfo"
      ]
    }
  ],
  "footerSocials": {
    "x": "https://x.com/transitive_bs",
    "github": "https://github.com/transitive-bullshit/agentic"
  },
  "seo": {
    "indexHiddenPages": true
  },
  "modeToggle": {
    "default": "light",
    "isHidden": true
  }
}


================================================
FILE: legacy/docs/quickstart.mdx
================================================
---
title: Quick Start
---

<Info>
  **Prerequisite**: All Agentic packages are [ESM
  only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
  and require `Node.js >= 18` or an equivalent environment (Bun, Deno, CF
  workers, etc).
</Info>

<Steps>
  <Step title='Install core deps (zod)'>
    <CodeGroup>
      ```bash npm
      npm install zod
      ```

      ```bash yarn
      yarn add zod
      ```

      ```bash pnpm
      pnpm add zod
      ```
    </CodeGroup>

  </Step>

  <Step title='Install AI tools'>
    You can either install all of the AI tools via `@agentic/stdlib`, or you can install them individually via their respective packages (`@agentic/weather`, `@agentic/twitter`, etc.).

    <AccordionGroup>
      <Accordion title="Install all AI tools">
        <CodeGroup>
          ```bash npm
          npm install @agentic/stdlib
          ```

          ```bash yarn
          yarn add @agentic/stdlib
          ```

          ```bash pnpm
          pnpm add @agentic/stdlib
          ```
        </CodeGroup>
      </Accordion>

      <Accordion title="Install individual AI tools">
        Docs for individual tools are available [here](/tools).

        Here's an example of how to install the [Weather tool](/tools/weather):

        <CodeGroup>
          ```bash npm
          npm install @agentic/weather
          ```

          ```bash yarn
          yarn add @agentic/weather
          ```

          ```bash pnpm
          pnpm add @agentic/weather
          ```
        </CodeGroup>
      </Accordion>

    </AccordionGroup>

    <Note>
      There is no functional difference between using `@agentic/stdlib` versus using the individual tool packages directly. The only difference is if you want to optimize your install size.

      The default examples all use `@agentic/stdlib` for simplicity.
    </Note>

  </Step>

  <Step title='Install an AI SDK Adapter'>
    To use Agentic with one of the supported AI SDKs, you'll also need to install its corresponding adapter package.

    <AccordionGroup>
      <Accordion title="Vercel AI SDK">
        <CodeGroup>
          ```bash npm
          npm install @agentic/ai-sdk ai
          ```

          ```bash yarn
          yarn add @agentic/ai-sdk ai
          ```

          ```bash pnpm
          pnpm add @agentic/ai-sdk ai
          ```
        </CodeGroup>

        See the [AI SDK adapter docs](/sdks/ai-sdk) for usage details.
      </Accordion>

      <Accordion title="Mastra">
        <CodeGroup>
          ```bash npm
          npm install @agentic/mastra @mastra/core
          ```

          ```bash yarn
          yarn add @agentic/mastra @mastra/core
          ```

          ```bash pnpm
          pnpm add @agentic/mastra @mastra/core
          ```
        </CodeGroup>

        See the [Mastra adapter docs](/sdks/mastra) for usage details.
      </Accordion>

      <Accordion title="LangChain">
        <CodeGroup>
          ```bash npm
          npm install @agentic/langchain @langchain/core langchain
          ```

          ```bash yarn
          yarn add @agentic/langchain @langchain/core langchain
          ```

          ```bash pnpm
          pnpm add @agentic/langchain @langchain/core langchain
          ```
        </CodeGroup>

        See the [LangChain adapter docs](/sdks/langchain) for usage details.
      </Accordion>

      <Accordion title="LlamaIndex">
        <CodeGroup>
          ```bash npm
          npm install @agentic/llamaindex llamaindex
          ```

          ```bash yarn
          yarn add @agentic/llamaindex llamaindex
          ```

          ```bash pnpm
          pnpm add @agentic/llamaindex llamaindex
          ```
        </CodeGroup>

        See the [LlamaIndex adapter docs](/sdks/llamaindex) for usage details.
      </Accordion>

      <Accordion title="Firebase Genkit">
        <CodeGroup>
          ```bash npm
          npm install @agentic/genkit genkit
          ```

          ```bash yarn
          yarn add @agentic/genkit genkit
          ```

          ```bash pnpm
          pnpm add @agentic/genkit genkit
          ```
        </CodeGroup>

        See the [Genkit adapter docs](/sdks/genkit) for usage details.
      </Accordion>

      <Accordion title="Dexa Dexter">
        <CodeGroup>
          ```bash npm
          npm install @agentic/dexter @dexaai/dexter
          ```

          ```bash yarn
          yarn add @agentic/dexter @dexaai/dexter
          ```

          ```bash pnpm
          pnpm add @agentic/dexter @dexaai/dexter
          ```
        </CodeGroup>

        See the [Dexter adapter docs](/sdks/dexter) for usage details.
      </Accordion>

      <Accordion title="OpenAI SDK">
        <CodeGroup>
          ```bash npm
          npm install openai
          ```

          ```bash yarn
          yarn add openai
          ```

          ```bash pnpm
          pnpm add openai
          ```
        </CodeGroup>

        There's no need for a separate adapter with the OpenAI SDK since all agentic tools are compatible with OpenAI by default. You can use `AIFunctionSet.specs` for function calling or `AIFunctionSet.toolSpecs` for parallel tool calling.

        See the [OpenAI adapter docs](/sdks/openai) for usage details.
      </Accordion>

    </AccordionGroup>

    <Note>
      You can use Agentic without any of these AI SDKs. `@agentic/core`, `@agentic/stdlib`, and all individual tool packages are compatible with any LLM and AI SDK that supports function calling / tool use.
    </Note>

  </Step>

</Steps>


================================================
FILE: legacy/docs/scratch.md
================================================
## Client Design Philosophy

- clients should be as minimal as possible
- clients should use `ky` and `zod` where possible
- clients should have a strongly-typed TS DX
- clients should expose select methods via the `@aiFunction(...)` decorator
  - `inputSchema` zod schemas should be as minimal as possible with descriptions prompt engineered specifically for use with LLMs
- clients and AIFunctions should be composable via `AIFunctionSet`
- clients should work with all major TS AI SDKs

## TODO

- tools
  - browserbase
  - [brave search](https://brave.com/search/api/)
  - [phantombuster](https://phantombuster.com)
  - [apify](https://apify.com/store)
  - perplexity
  - valtown
  - replicate
  - huggingface
  - pull from [clay](https://www.clay.com/integrations)
  - pull from [langchain](https://github.com/langchain-ai/langchainjs/tree/main/langchain)
    - provide a converter for langchain `DynamicStructuredTool`
  - pull from [nango](https://docs.nango.dev/integrations/overview)
  - pull from [activepieces](https://github.com/activepieces/activepieces/tree/main/packages/pieces/community)
  - general openapi support ala [workgpt](https://github.com/team-openpm/workgpt)
- compound tools / chains / flows / runnables
  - market maps
- investigate [autotool](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/autotool)
- investigate [alt search engines](https://seirdy.one/posts/2021/03/10/search-engines-with-own-indexes/)
- investigate [data connectors](https://github.com/mendableai/data-connectors)
- add unit tests for individual providers


================================================
FILE: legacy/docs/sdks/genaiscript.mdx
================================================
---
title: GenAIScript
description: Builtin agentic tool support in GenAIScript.
---

- package: none necessary
- [GenAIScript docs](https://microsoft.github.io/genaiscript/guides/agentic-tools/)

## Usage

```ts
import { calculator } from '@agentic/calculator'
defTool(calculator)

$`Answer the following arithmetic question: How much is 11 + 4? then divide by 3?`
```

## Running this example

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
echo 'OPENAI_API_KEY=your-key' >> .env
npx genaiscript examples/genaiscript/calculator.genai.mts
```


================================================
FILE: legacy/docs/sdks/xsai.mdx
================================================
---
title: xsAI SDK
description: Agentic adapter for the xsAI SDK.
---

- package: `@agentic/xsai`
- exports: `function createXSAITools`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/xsai/src/xsai.ts)
- [xsAI SDK docs](https://xsai.js.org)

## Install

<CodeGroup>
```bash npm
npm install @agentic/xsai xsai @xsai/tool
```

```bash yarn
yarn add @agentic/xsai xsai @xsai/tool
```

```bash pnpm
pnpm add @agentic/xsai xsai @xsai/tool
```

</CodeGroup>

## Usage

<Note>
  Note that `createXSAITools` is `async` because `xsai`'s underlying
  `xsschema.toJsonSchema` is async.
</Note>

```ts
import 'dotenv/config'

import { WeatherClient } from '@agentic/weather'
import { createXSAITools } from '@agentic/xsai'
import { generateText } from 'xsai'

async function main() {
  const weather = new WeatherClient()

  const result = await generateText({
    apiKey: process.env.OPENAI_API_KEY!,
    baseURL: 'https://api.openai.com/v1/',
    model: 'gpt-4o-mini',
    tools: await createXSAITools(weather),
    toolChoice: 'required',
    temperature: 0,
    messages: [
      {
        role: 'system',
        content: 'You are a helpful assistant. Be as concise as possible.'
      },
      { role: 'user', content: 'What is the weather in San Francisco?' }
    ]
  })

  console.log(JSON.stringify(result, null, 2))
}

await main()
```

Note that this example snippet also requires you to install the Agentic weather tool and `dotenv`.

<CodeGroup>
```bash npm
npm install @agentic/weather dotenv
```

```bash yarn
yarn add @agentic/weather dotenv
```

```bash pnpm
pnpm add @agentic/weather dotenv
```

</CodeGroup>

## Running this example

<Info>
  You'll need a free API key from [weatherapi.com](https://www.weatherapi.com)
  to run this example. Store it in a local `.env` file as `WEATHER_API_KEY`.
</Info>

<Info>
  You'll need an [OpenAI API key](https://platform.openai.com/docs/quickstart)
  to run this example. Store it in a local `.env` file as `OPENAI_API_KEY`.
</Info>

```sh
git clone git@github.com:transitive-bullshit/agentic.git
cd agentic
pnpm install
echo 'WEATHER_API_KEY=your-key' >> .env
echo 'OPENAI_API_KEY=your-key' >> .env
npx tsx examples/xsai/bin/weather.ts
```


================================================
FILE: legacy/docs/tools/airtable.mdx
================================================
---
title: Airtable
description: Airtable is a no-code spreadsheets, CRM, and database.
---

- package: `@agentic/airtable`
- exports: `class AirtableClient`, `namespace airtable`
- env vars: `AIRTABLE_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/airtable/src/airtable-client.ts)
- [airtable api docs](https://airtable.com/developers/web/api/introduction)

## Install

<CodeGroup>
```bash npm
npm install @agentic/airtable
```

```bash yarn
yarn add @agentic/airtable
```

```bash pnpm
pnpm add @agentic/airtable
```

</CodeGroup>

## Usage

```ts
import { AirtableClient } from '@agentic/airtable'

const airtable = new AirtableClient()
const { bases } = await airtable.listBases()
console.log('bases', tables)

const baseId = bases[0]!.id
const tables = await airtable.listTables({ baseId })
console.log('tables', tables)

const tableId = tables[0]!.id
const searchResults = await airtable.searchRecords({
  baseId,
  tableId,
  searchTerm: 'Travis'
})
console.log('search results', searchResults)
```

(this is just an example of how you'd use the client)


================================================
FILE: legacy/docs/tools/apollo.mdx
================================================
---
title: Apollo
description: Apollo provides an API for B2B person and company enrichment.
---

- package: `@agentic/apollo`
- exports: `class Apollo`, `namespace apollo`
- env vars: `APOLLO_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/apollo/src/apollo-client.ts)
- [apollo api docs](https://docs.apollo.io)

## Install

<CodeGroup>
```bash npm
npm install @agentic/apollo
```

```bash yarn
yarn add @agentic/apollo
```

```bash pnpm
pnpm add @agentic/apollo
```

</CodeGroup>

## Usage

```ts
import { ApolloClient } from '@agentic/apollo'

const apollo = new ApolloClient()
const res = await apollo.enrichPerson({
  linkedin_url: 'https://linkedin.com/in/fisch2'
})
```


================================================
FILE: legacy/docs/tools/arxiv.mdx
================================================
---
title: ArXiv
description: Search for research articles.
---

- package: `@agentic/arxiv`
- exports: `class ArXivClient`, `namespace arxiv`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/arxiv/src/arxiv-client.ts)
- [arxiv api docs](https://info.arxiv.org/help/api/index.html)

## Install

<CodeGroup>
```bash npm
npm install @agentic/arxiv
```

```bash yarn
yarn add @agentic/arxiv
```

```bash pnpm
pnpm add @agentic/arxiv
```

</CodeGroup>

## Usage

```ts
import { ArXivClient } from '@agentic/arxiv'

// No API is required to use the ArXiv API
const arxiv = new ArXivClient()
const results = await arxiv.search({
  query: 'machine learning',
  maxResults: 10
})
```


================================================
FILE: legacy/docs/tools/bing.mdx
================================================
---
title: Bing
description: Bing web search API client.
---

- package: `@agentic/bing`
- exports: `class BingClient`, `namespace bing`
- env vars: `BING_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/bing/src/bing-client.ts)
- [bing web search docs](https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/bing
```

```bash yarn
yarn add @agentic/bing
```

```bash pnpm
pnpm add @agentic/bing
```

</CodeGroup>

## Usage

```ts
import { BingClient } from '@agentic/bing'

const bing = new BingClient()
const res = await bing.search('latest news')
```


================================================
FILE: legacy/docs/tools/brave-search.mdx
================================================
---
title: Brave Search
description: Brave web search and local places search.
---

- package: `@agentic/brave-search`
- exports: `class BraveSearchClient`, `namespace braveSearch`
- env vars: `BRAVE_SEARCH_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/brave-search/src/brave-search-client.ts)
- [brave search docs](https://brave.com/search/api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/brave-search
```

```bash yarn
yarn add @agentic/brave-search
```

```bash pnpm
pnpm add @agentic/brave-search
```

</CodeGroup>

## Usage

```ts
import { BraveSearchClient } from '@agentic/brave-search'

const braveSearch = new BraveSearchClient()
const res = await braveSearch.search('latest news about openai')
```


================================================
FILE: legacy/docs/tools/calculator.mdx
================================================
---
title: Calculator
description: A simple calculator tool.
---

- package: `@agentic/calculator`
- exports: `function calculator`
- env vars: _none_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/calculator/src/calculator.ts)
- [mathjs docs](https://mathjs.org)

## Install

<CodeGroup>
```bash npm
npm install @agentic/calculator
```

```bash yarn
yarn add @agentic/calculator
```

```bash pnpm
pnpm add @agentic/calculator
```

</CodeGroup>

## Usage

```ts
import { calculator } from '@agentic/calculator'

const res = await calculator({ expr: '1 + 1' })
```


================================================
FILE: legacy/docs/tools/clearbit.mdx
================================================
---
title: Clearbit
description: Resolving and enriching people and company data.
---

- package: `@agentic/clearbit`
- exports: `class ClearbitClient`, `namespace clearbit`
- env vars: `CLEARBIT_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/clearbit/src/clearbit-client.ts)
- [clearbit api docs](https://dashboard.clearbit.com/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/clearbit
```

```bash yarn
yarn add @agentic/clearbit
```

```bash pnpm
pnpm add @agentic/clearbit
```

</CodeGroup>

## Usage

```ts
import { ClearbitClient } from '@agentic/clearbit'

const clearbit = new ClearbitClient()
const res = await clearbit.companyEnrichment({ domain: 'apple.com' })
```


================================================
FILE: legacy/docs/tools/dexa.mdx
================================================
---
title: Dexa
description: Answers questions from the world's best podcasters.
---

<Warning>
  The [Dexa](https://dexa.ai) API is currently only available as a closed beta.
</Warning>

- package: `@agentic/dexa`
- exports:
  - `class DexaClient`, `namespace dexa`
  - `class ScraperClient`, `namespace scraper`
- env vars: `DEXA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/dexa/src/dexa-client.ts)

## Install

<CodeGroup>
```bash npm
npm install @agentic/dexa
```

```bash yarn
yarn add @agentic/dexa
```

```bash pnpm
pnpm add @agentic/dexa
```

</CodeGroup>

## Usage

```ts
import { DexaClient } from '@agentic/dexa'

const dexa = new DexaClient()
const res = await dexa.search('latest news')
```


================================================
FILE: legacy/docs/tools/diffbot.mdx
================================================
---
title: Diffbot
description: Diffbot API client.
---

Diffbot provides web page classification and scraping. It also provides access to a knowledge graph with the ability to perform person and company data enrichment.

- package: `@agentic/diffbot`
- exports: `class DiffbotClient`, `namespace diffbot`
- env vars: `DIFFBOT_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/diffbot/src/diffbot-client.ts)
- [diffbot api docs](https://docs.diffbot.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/diffbot
```

```bash yarn
yarn add @agentic/diffbot
```

```bash pnpm
pnpm add @agentic/diffbot
```

</CodeGroup>

## Usage

```ts
import { DiffbotClient } from '@agentic/diffbot'

const diffbot = new DiffbotClient()
const res = await diffbot.analyzeUrl('https://example.com')
```


================================================
FILE: legacy/docs/tools/duck-duck-go.mdx
================================================
---
title: DuckDuckGo
description: Search for research articles.
---

- package: `@agentic/duck-duck-go`
- exports: `class DuckDuckGoClient`, `namespace duckduckgo`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/duck-duck-go/src/duck-duck-go-client.ts)
- [Duck Duck Go api docs](https://api.duckduckgo.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/duck-duck-go
```

```bash yarn
yarn add @agentic/duck-duck-go
```

```bash pnpm
pnpm add @agentic/duck-duck-go
```

</CodeGroup>

## Usage

```ts
import { DuckDuckGoClient } from '@agentic/duck-duck-go'

// No API is required to use the DuckDuckGo API
const duckDuckGo = new DuckDuckGoClient()
const results = await duckDuckGo.search({
  query: 'latest news about AI'
})
```


================================================
FILE: legacy/docs/tools/e2b.mdx
================================================
---
title: E2B
description: Hosted Python code interpreter sandbox.
---

Hosted Python code intrepreter sandbox which is really useful for data analysis, flexible code execution, and advanced reasoning on-the-fly.

- package: `@agentic/e2b`
- exports: `function e2b`
- env vars: `E2B_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/e2b/src/e2b.ts)
- [e2b api docs](https://e2b.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/e2b @e2b/code-interpreter
```

```bash yarn
yarn add @agentic/e2b @e2b/code-interpreter
```

```bash pnpm
pnpm add @agentic/e2b @e2b/code-interpreter
```

</CodeGroup>

## Usage

```ts
import { e2b } from '@agentic/e2b'

const res = await e2b({ code: 'print("Hello, World")' })
```


================================================
FILE: legacy/docs/tools/exa.mdx
================================================
---
title: Exa
description: Web search tailored for LLMs.
---

- package: `@agentic/exa`
- exports: `class ExaClient`, `namespace exa`
- env vars: `EXA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/exa/src/exa-client.ts)
- [exa api docs](https://docs.exa.ai)

## Install

<CodeGroup>
```bash npm
npm install @agentic/exa
```

```bash yarn
yarn add @agentic/exa
```

```bash pnpm
pnpm add @agentic/exa
```

</CodeGroup>

## Usage

```ts
import { ExaClient } from '@agentic/exa'

const exa = new ExaClient()
const res = await exa.search('latest news')
```


================================================
FILE: legacy/docs/tools/firecrawl.mdx
================================================
---
title: Firecrawl
description: Website scraping and structured data extraction.
---

Turn websites into LLM-ready data. Crawl and convert any website into clean markdown or structured data.

- package: `@agentic/firecrawl`
- exports: `class FirecrawlClient`, `namespace firecrawl`
- env vars: `FIRECRAWL_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/firecrawl/src/firecrawl-client.ts)
- [firecrawl api docs](https://www.firecrawl.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/firecrawl
```

```bash yarn
yarn add @agentic/firecrawl
```

```bash pnpm
pnpm add @agentic/firecrawl
```

</CodeGroup>

## Usage

```ts
import { FirecrawlClient } from '@agentic/firecrawl'

const firecrawl = new FirecrawlClient()
const res = await firecrawl.scrapeUrl('https://example.com')
```


================================================
FILE: legacy/docs/tools/google-custom-search.mdx
================================================
---
title: Google Custom Search
description: Google Custom Search for online trends, news, current events, real-time information, or research topics.
---

- package: `@agentic/google-custom-search`
- exports: `class GoogleCustomSearchClient`, `namespace googleCustomSearch`
- env vars: `GOOGLE_API_KEY`, `GOOGLE_CSE_ID`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/google-custom-search/src/google-custom-search-client.ts)
- [google custom search docs](https://developers.google.com/custom-search/v1/overview)

## Install

<CodeGroup>
```bash npm
npm install @agentic/google-custom-search
```

```bash yarn
yarn add @agentic/google-custom-search
```

```bash pnpm
pnpm add @agentic/google-custom-search
```

</CodeGroup>

## Usage

```ts
import { GoogleCustomSearchClient } from '@agentic/google-custom-search'

const googleCustomSearch = new GoogleCustomSearchClient()
const results = await googleCustomSearch.search('latest news about openai')
```

Make sure to set the `GOOGLE_API_KEY` and `GOOGLE_CSE_ID` environment variables or pass them to the constructor using the `apiKey` and `cseId` options.


================================================
FILE: legacy/docs/tools/google-docs.mdx
================================================
---
title: Google Docs
description: Simplified Google Docs API.
---

- package: `@agentic/google-docs`
- exports: `class GoogleDocsClient`, `namespace googleDocs`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/google-docs/src/google-docs-client.ts)
- [google docs docs](https://developers.google.com/workspace/docs/api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/google-docs googleapis @google-cloud/local-auth
```

```bash yarn
yarn add @agentic/google-docs googleapis @google-cloud/local-auth
```

```bash pnpm
pnpm add @agentic/google-docs googleapis @google-cloud/local-auth
```

</CodeGroup>

## Example Usage

```ts
import { GoogleDriveClient } from '@agentic/google-drive'
import { authenticate } from '@google-cloud/local-auth'
import { google } from 'googleapis'

// (in a real app, store these auth credentials and reuse them)
const auth = await authenticate({
  scopes: ['https://www.googleapis.com/auth/documents.readonly'],
  keyfilePath: process.env.GOOGLE_CREDENTIALS_PATH
})
const docs = google.docs({ version: 'v1', auth })
const client = new GoogleDocsClient({ docs })

const document = await client.getDocument({ documentId: 'TODO' })
console.log(document)
```


================================================
FILE: legacy/docs/tools/google-drive.mdx
================================================
---
title: Google Drive
description: Simplified Google Drive API.
---

- package: `@agentic/google-drive`
- exports: `class GoogleDriveClient`, `namespace googleDrive`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/google-drive/src/google-drive-client.ts)
- [google drive docs](https://developers.google.com/workspace/drive/api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/google-drive googleapis google-auth-library
```

```bash yarn
yarn add @agentic/google-drive googleapis google-auth-library
```

```bash pnpm
pnpm add @agentic/google-drive googleapis google-auth-library
```

</CodeGroup>

## Example Usage

```ts
import { GoogleDriveClient } from '@agentic/google-drive'
import { GoogleAuth } from 'google-auth-library'
import { google } from 'googleapis'

const auth = new GoogleAuth({ scopes: 'https://www.googleapis.com/auth/drive' })
const drive = google.drive({ version: 'v3', auth })
const client = new GoogleDriveClient({ drive })

const result = await client.listFiles()

const file = result.files[0]!
const metadata = await client.getFile({ fileId: file.id })
const content = await client.exportFile({
  fileId: file.id,
  mimeType: 'application/pdf'
})
```


================================================
FILE: legacy/docs/tools/gravatar.mdx
================================================
---
title: Gravatar
description: Gravatar Profile API.
---

- package: `@agentic/gravatar`
- exports: `class GravatarClient`, `namespace gravatar`
- env vars: `GRAVATAR_API_KEY` _(optional)_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/gravatar/src/gravatar-client.ts)
- [Gravatar API docs](https://docs.gravatar.com/api/profiles/rest-api/)

## Install

<CodeGroup>
```bash npm
npm install @agentic/gravatar
```

```bash yarn
yarn add @agentic/gravatar
```

```bash pnpm
pnpm add @agentic/gravatar
```

</CodeGroup>

## Usage

```ts
import { GravatarClient } from '@agentic/gravatar'

const gravatar = new GravatarClient()
const profile = await gravatar.getProfileByIdentifier('my-email@example.com')
```


================================================
FILE: legacy/docs/tools/hacker-news.mdx
================================================
---
title: HackerNews
description: Basic client for the official Hacker News API.
---

Note that the [HN Algolia API](https://hn.algolia.com/api) seems to no longer be available, so we can't add search without quite a bit of overhead.

- package: `@agentic/hacker-news`
- exports: `class HackerNewsClient`, `namespace hackernews`
- env vars: `HACKER_NEWS_API_USER_AGENT` _(optional)_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/hacker-news/src/hacker-news-client.ts)
- [HN api docs](https://github.com/HackerNews/API)

## Install

<CodeGroup>
```bash npm
npm install @agentic/hacker-news
```

```bash yarn
yarn add @agentic/hacker-news
```

```bash pnpm
pnpm add @agentic/hacker-news
```

</CodeGroup>

## Usage

```ts
import { HackerNewsClient } from '@agentic/hacker-news'

const hn = new HackerNewsClient()
const res = await hn.searchItems({
  query: 'example query',
  tags: ['story'],
  numericFilters: ['points>100']
})
```


================================================
FILE: legacy/docs/tools/hunter.mdx
================================================
---
title: Hunter
description: Email finder, verifier, and enrichment.
---

- package: `@agentic/hunter`
- exports: `class HunterClient`, `namespace hunter`
- env vars: `HUNTER_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/hunter/src/hunter-client.ts)
- [hunter api docs](https://hunter.io/api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/hunter
```

```bash yarn
yarn add @agentic/hunter
```

```bash pnpm
pnpm add @agentic/hunter
```

</CodeGroup>

## Usage

```ts
import { HunterClient } from '@agentic/hunter'

const hunter = new HunterClient()
const res0 = await hunter.domainSearch('apple.com')
const res1 = await hunter.emailFinder({
  domain: 'transitivebullsh.it',
  first_name: 'travis',
  last_name: 'fischer'
})
```


================================================
FILE: legacy/docs/tools/jina.mdx
================================================
---
title: Jina
description: URL scraper and web search
---

LLM-friendly URL reader and search client by [Jina AI](https://jina.ai/reader) with a basic free tier.

- package: `@agentic/jina`
- exports: `class JinaClient`, `namespace jina`
- env vars: `JINA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/jina/src/jina-client.ts)
- [jina api docs](https://jina.ai/reader)

## Install

<CodeGroup>
```bash npm
npm install @agentic/jina
```

```bash yarn
yarn add @agentic/jina
```

```bash pnpm
pnpm add @agentic/jina
```

</CodeGroup>

## Usage

```ts
import { JinaClient } from '@agentic/jina'

const jina = new JinaClient()
const res0 = await jina.readUrl('https://example.com')
const res1 = await jina.search({ query: 'latest news', json: true })
```

## Notes

- Does not support "stream mode".
- Results default to markdown text format.
- To return JSON (especially useful for `search`), set `json: true` in the options.


================================================
FILE: legacy/docs/tools/leadmagic.mdx
================================================
---
title: LeadMagic
description: LeadMagic provides an API for B2B person, company, and email enrichment.
---

- package: `@agentic/leadmagic`
- exports: `class LeadMagic`, `namespace leadmagic`
- env vars: `LEADMAGIC_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/leadmagic/src/leadmagic-client.ts)
- [leadmagic api docs](https://docs.leadmagic.io)

## Install

<CodeGroup>
```bash npm
npm install @agentic/leadmagic
```

```bash yarn
yarn add @agentic/leadmagic
```

```bash pnpm
pnpm add @agentic/leadmagic
```

</CodeGroup>

## Usage

```ts
import { LeadMagicClient } from '@agentic/leadmagic'

const leadmagic = new LeadMagicClient()
const res = await leadmagic.profileSearch({
  linkedinUsername: 'fisch2'
})
```


================================================
FILE: legacy/docs/tools/mcp.mdx
================================================
---
title: MCP Tools
description: Agentic adapter for accessing tools defined by Model Context Protocol (MCP) servers.
---

- package: `@agentic/mcp`
- exports: `createMcpTools`, `class McpTools`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/mcp/src/mcp-tools.ts)
- [MCP docs](https://modelcontextprotocol.io)

## Install

<CodeGroup>
```bash npm
npm install @agentic/mcp
```

```bash yarn
yarn add @agentic/mcp
```

```bash pnpm
pnpm add @agentic/mcp
```

</CodeGroup>

## Usage

```ts
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { createMcpTools } from '@agentic/mcp'
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  // Create an MCP tools provider, which will start a local MCP server process
  // and use the stdio transport to communicate with it.
  const mcpTools = await createMcpTools({
    name: 'agentic-mcp-filesystem',
    serverProcess: {
      command: 'npx',
      args: [
        '-y',
        // This example uses a built-in example MCP server from Anthropic, which
        // provides a set of tools to access the local filesystem.
        '@modelcontextprotocol/server-filesystem',
        // Allow the MCP server to access the current working directory.
        process.cwd()
        // Feel free to add additional directories the tool should have access to.
      ]
    }
  })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(mcpTools),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What files are in the current directory?'
  })

  console.log(result.toolResults[0])
}

await main()
```

### createMcpTools

`createMcpTools` creates a new `McpTools` instance by starting or connecting to an MCP server.

You must provide either an existing `transport`, an existing `serverUrl`, or a
`serverProcess` to spawn.

All tools within the `McpTools` instance will be namespaced under the given `name`.

`createMcpTools` takes in the following options ([source](https://github.com/transitive-bullshit/agentic/blob/main/packages/mcp/src/types.ts)):

```ts
export interface McpToolsOptions {
  /**
   * Provide a name for this client which will be its namespace for all tools and prompts.
   */
  name: string

  /**
   * Provide a version number for this client (defaults to 1.0.0).
   */
  version?: string

  /**
   * If you already have an MCP transport you'd like to use, pass it here to connect to the server.
   */
  transport?: Transport

  /**
   * Start a local server process using the stdio MCP transport.
   */
  serverProcess?: StdioServerParameters

  /**
   * Connect to a remote server process using the SSE MCP transport.
   */
  serverUrl?: string

  /**
   * Return tool responses in raw MCP form instead of processing them for Genkit compatibility.
   */
  rawToolResponses?: boolean

  /**
   * An optional filter function to determine which tools should be enabled.
   *
   * By default, all tools available on the MCP server will be enabled, but you
   * can use this to filter a subset of those tools.
   */
  toolsFilter?: McpToolsFilter
}
```

### JSON Schema

Note that `McpTools` uses JSON Schemas for toll input parameters, whereas most built-in tools use Zod schemas. This is important because some AI frameworks don't support JSON Schemas as AI function parameters.

Currently, Mastra, Dexter, and xsAI don't support JSON Schema input parameters, so they won't work with `McpTools`. All of the other AI SDKs should work fine with the JSON Schema-based tools.


================================================
FILE: legacy/docs/tools/midjourney.mdx
================================================
---
title: Midjourney
description: Unofficial Midjourney API client for generative images.
---

- package: `@agentic/midjourney`
- exports: `class MidjourneyClient`, `namespace midjourney`
- env vars: `MIDJOURNEY_IMAGINE_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/midjourney/src/midjourney-client.ts)
- [imagine api docs](https://www.imagineapi.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/midjourney
```

```bash yarn
yarn add @agentic/midjourney
```

```bash pnpm
pnpm add @agentic/midjourney
```

</CodeGroup>

## Usage

```ts
import { MidjourneyClient } from '@agentic/midjourney'

const midjourney = new MidjourneyClient()
const res = await midjourney.imagine({
  prompt: 'beautiful sunset over the ocean, oil painting, monet'
})
```


================================================
FILE: legacy/docs/tools/notion.mdx
================================================
---
title: Notion
description: Notion API client.
---

The [Notion API](https://developers.notion.com/docs) provides a router for accessing pages, databases, and content.

- package: `@agentic/notion`
- exports: `class NotionClient`, `namespace notion`
- env vars: `NOTION_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/notion/src/notion-client.ts)
- [notion api docs](https://developers.notion.com/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/notion
```

```bash yarn
yarn add @agentic/notion
```

```bash pnpm
pnpm add @agentic/notion
```

</CodeGroup>

## Usage

```ts
import { NotionClient } from '@agentic/notion'

const notion = new NotionClient()
const authenticatedUser = await notion.getSelf()
```

You'll need to set up a [Notion Integration](https://developers.notion.com/docs/authorization), give it access to some pages in your Notion workspace, and then set the `NOTION_API_KEY` environment variable to the integration's token.


================================================
FILE: legacy/docs/tools/novu.mdx
================================================
---
title: Novu
description: Novu API client.
---

The [Novu API](https://novu.co) provides a router for sending notifications across different channels like Email, SMS, Chat, In-App, and Push.

- package: `@agentic/novu`
- exports: `class NovuClient`, `namespace novu`
- env vars: `NOVU_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/novu/src/novu-client.ts)
- [novu api docs](https://novu.co)

## Install

<CodeGroup>
```bash npm
npm install @agentic/novu
```

```bash yarn
yarn add @agentic/novu
```

```bash pnpm
pnpm add @agentic/novu
```

</CodeGroup>

## Usage

```ts
import { NovuClient } from '@agentic/novu'

const novu = new NovuClient()
const res = await novu.search('latest news')
```


================================================
FILE: legacy/docs/tools/open-meteo.mdx
================================================
---
title: Open Meteo
description: Open-Meteo weather API client.
---

The [Open-Meteo weather API](https://open-meteo.com) provides a free weather forecast API for open-source developers and non-commercial use.

- package: `@agentic/open-meteo`
- exports: `class OpenMeteoClient`, `namespace openmeteo`
- env vars: `OPEN_METEO_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/open-meteo/src/open-meteo-client.ts)
- [open-meteo api docs](https://open-meteo.com/en/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/open-meteo
```

```bash yarn
yarn add @agentic/open-meteo
```

```bash pnpm
pnpm add @agentic/open-meteo
```

</CodeGroup>

## Usage

```ts
import { OpenMeteoClient } from '@agentic/open-meteo'

const openMeteo = new OpenMeteoClient()
const res = await openMeteo.getForecast({
  location: {
    name: 'San Francisco'
  }
})
```


================================================
FILE: legacy/docs/tools/people-data-labs.mdx
================================================
---
title: People Data Labs
description: People & company data enrichment.
---

<Warning>
  People Data Labs tends to be more expensive than other similar data providers.
  The author recommends you stay away from them.
</Warning>

- package: `@agentic/people-data-labs`
- exports: `class PeopleDataLabsClient`, `namespace peopledatalabs`
- env vars: `PEOPLE_DATA_LABS_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/people-data-labs/src/people-data-labs-client.ts)
- [people data labs api docs](https://www.peopledatalabs.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/people-data-labs
```

```bash yarn
yarn add @agentic/people-data-labs
```

```bash pnpm
pnpm add @agentic/people-data-labs
```

</CodeGroup>

## Usage

```ts
import { PeopleDataLabsClient } from '@agentic/people-data-labs'

const pdl = new PeopleDataLabsClient()
const res = await pdl.companyLookup({
  query: {
    website: 'apple.com'
  }
})
```


================================================
FILE: legacy/docs/tools/perigon.mdx
================================================
---
title: Perigon
description: Real-time news API.
---

Real-time news API and web content data from 140,000+ sources. Structured and enriched by AI, primed for LLMs.

- search news articles
- search news stories (clusters of related news articles)
- search people, companies, topics, and journalists

- package: `@agentic/perigon`
- exports: `class PerigonClient`, `namespace perigon`
- env vars: `PERIGON_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/perigon/src/perigon-client.ts)
- [perigon api docs](https://www.goperigon.com/products/news-api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/perigon
```

```bash yarn
yarn add @agentic/perigon
```

```bash pnpm
pnpm add @agentic/perigon
```

</CodeGroup>

## Usage

```ts
import { PerigonClient } from '@agentic/perigon'

const perigon = new PerigonClient()
const res = await perigon.searchArticles({
  q: '"elon musk" AND tesla'
})
```


================================================
FILE: legacy/docs/tools/polygon.mdx
================================================
---
title: Polygon
description: Stock market and company financial data.
---

- package: `@agentic/polygon`
- exports: `class PolygonClient`, `namespace polygon`
- env vars: `POLYGON_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/polygon/src/polygon-client.ts)
- [polygon api docs](https://polygon.io/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/polygon
```

```bash yarn
yarn add @agentic/polygon
```

```bash pnpm
pnpm add @agentic/polygon
```

</CodeGroup>

## Usage

```ts
import { PolygonClient } from '@agentic/polygon'

const polygon = new PolygonClient()
const res = await polygon.tickerDetails({ ticker: 'AAPL' })
```


================================================
FILE: legacy/docs/tools/predict-leads.mdx
================================================
---
title: Predict Leads
description: Company data and events API.
---

In-depth company data, including signals like fundraising announcemnts, hiring intent, new customers signed, technologies used, product launches, location expansions, awards received, etc.

- package: `@agentic/predict-leads`
- exports: `class PredictLeadsClient`, `namespace predictleads`
- env vars: `PREDICT_LEADS_API_KEY`, `PREDICT_LEADS_API_TOKEN`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/predict-leads/src/predict-leads-client.ts)
- [precit leads api docs](https://docs.predictleads.com/v3)

## Install

<CodeGroup>
```bash npm
npm install @agentic/predict-leads
```

```bash yarn
yarn add @agentic/predict-leads
```

```bash pnpm
pnpm add @agentic/predict-leads
```

</CodeGroup>

## Usage

```ts
import { PredictLeadsClient } from '@agentic/predict-leads'

const predictLeads = new PredictLeadsClient()
const res = await predictLeads.getCompanyEvents({ domain: 'apple.com' })
```


================================================
FILE: legacy/docs/tools/proxycurl.mdx
================================================
---
title: Proxycurl
description: People and company data from LinkedIn & Crunchbase.
---

- package: `@agentic/proxycurl`
- exports: `class ProxycurlClient`, `namespace proxycurl`
- env vars: `PROXYCURL_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/proxycurl/src/proxycurl-client.ts)
- [proxycurl api docs](https://nubela.co/proxycurl)

## Install

<CodeGroup>
```bash npm
npm install @agentic/proxycurl
```

```bash yarn
yarn add @agentic/proxycurl
```

```bash pnpm
pnpm add @agentic/proxycurl
```

</CodeGroup>

## Usage

```ts
import { ProxycurlClient } from '@agentic/proxycurl'

const proxycurl = new ProxycurlClient()
const company = await proxycurl.getLinkedInCompany({
  url: 'https://linkedin.com/company/apple'
})

const person = await proxycurl.getLinkedInPerson({
  url: 'https://linkedin.com/in/fisch2'
})
```


================================================
FILE: legacy/docs/tools/reddit.mdx
================================================
---
title: Reddit
description: Basic readonly Reddit API for getting top/hot/new/rising posts from subreddits.
---

- package: `@agentic/reddit`
- exports: `class RedditClient`, `namespace reddit`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/reddit/src/reddit-client.ts)
- [reddit legacy api docs](https://old.reddit.com/dev/api)

<Note>
  This client uses Reddit's free, legacy JSON API aimed at RSS feeds, so no auth
  is required. With that being said, Reddit does impose rate limits on the API,
  so be considerate.
</Note>

## Install

<CodeGroup>
```bash npm
npm install @agentic/reddit
```

```bash yarn
yarn add @agentic/reddit
```

```bash pnpm
pnpm add @agentic/reddit
```

</CodeGroup>

## Usage

```ts
import { RedditClient } from '@agentic/reddit'

const reddit = new RedditClient()
const result = await reddit.getSubredditPosts({
  subreddit: 'AskReddit',
  type: 'hot',
  limit: 10
})
```


================================================
FILE: legacy/docs/tools/rocketreach.mdx
================================================
---
title: RocketReach
description: RocketReach provides an API for B2B person and company enrichment.
---

- package: `@agentic/rocketreach`
- exports: `class RocketReach`, `namespace rocketreach`
- env vars: `ROCKETREACH_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/rocketreach/src/rocketreach-client.ts)
- [rocketreach api docs](https://rocketreach.co/api/v2/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/rocketreach
```

```bash yarn
yarn add @agentic/rocketreach
```

```bash pnpm
pnpm add @agentic/rocketreach
```

</CodeGroup>

## Usage

```ts
import { RocketReachClient } from '@agentic/rocketreach'

const rocketreach = new RocketReachClient()
const res = await rocketreach.lookupPerson({
  linkedin_url: 'https://www.linkedin.com/in/fisch2'
})
```


================================================
FILE: legacy/docs/tools/searxng.mdx
================================================
---
title: Searxng
description: OSS meta search engine.
---

Open source meta search engine capable of searching across many different
sources and search engines.

The most important search engines are:

- `reddit` (Reddit posts)
- `google` (Google web search)
- `google news` (Google News search)
- `brave` (Brave web search)
- `arxiv` (academic papers)
- `genius` (Genius.com for song lyrics)
- `imdb` (movies and TV shows)
- `hackernews` (Hacker News)
- `wikidata` (Wikidata)
- `wolframalpha` (Wolfram Alpha)
- `youtube` (YouTube videos)
- `github` (GitHub code and repositories)

---

- package: `@agentic/searxng`
- exports: `class SearxngClient`, `namespace searxng`
- env vars: `SEARXNG_API_BASE_URL`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/searxng/src/searxng-client.ts)
- [searxng api docs](https://docs.searxng.org)

## Install

<CodeGroup>
```bash npm
npm install @agentic/searxng
```

```bash yarn
yarn add @agentic/searxng
```

```bash pnpm
pnpm add @agentic/searxng
```

</CodeGroup>

## Usage

```ts
import { SearxngClient } from '@agentic/searxng'

const searxng = new SearxngClient()
const res = await searxng.search({
  query: 'us election',
  engines: ['google', 'reddit', 'hackernews']
})
```


================================================
FILE: legacy/docs/tools/serpapi.mdx
================================================
---
title: SerpAPI
description: Lightweight wrapper around SerpAPI for Google search.
---

- package: `@agentic/serpapi`
- exports: `class SerpAPIClient`, `namespace serpapi`
- env vars: `SERPAPI_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/serpapi/src/serpapi-client.ts)
- [serpapi api docs](https://serpapi.com/search-api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/serpapi
```

```bash yarn
yarn add @agentic/serpapi
```

```bash pnpm
pnpm add @agentic/serpapi
```

</CodeGroup>

## Usage

```ts
import { SerpAPIClient } from '@agentic/serpapi'

const serpapi = new SerpAPIClient()
const res = await serpapi.search('latest news')
```


================================================
FILE: legacy/docs/tools/serper.mdx
================================================
---
title: Serper
description: Lightweight wrapper around Serper for Google search.
---

- package: `@agentic/serper`
- exports: `class SerperClient`, `namespace serper`
- env vars: `SERPER_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/serper/src/serper-client.ts)
- [serper api docs](https://serper.dev)

## Install

<CodeGroup>
```bash npm
npm install @agentic/serper
```

```bash yarn
yarn add @agentic/serper
```

```bash pnpm
pnpm add @agentic/serper
```

</CodeGroup>

## Usage

```ts
import { SerperClient } from '@agentic/serper'

const serper = new SerperClient()
const res = await serper.search('latest news')
```


================================================
FILE: legacy/docs/tools/slack.mdx
================================================
---
title: Slack
description: Minimal Slack API client for sending and receiving Slack messages.
---

- package: `@agentic/slack`
- exports: `class SlackClient`, `namespace slack`
- env vars: `SLACK_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/slack/src/slack-client.ts)
- [slack api docs](https://api.slack.com/docs)

## Install

<CodeGroup>
```bash npm
npm install @agentic/slack
```

```bash yarn
yarn add @agentic/slack
```

```bash pnpm
pnpm add @agentic/slack
```

</CodeGroup>

## Usage

```ts
import { SlackClient } from '@agentic/slack'

const slack = new SlackClient()
const res = await slack.sendMessage({
  text: 'hello',
  channel: 'general'
})
```


================================================
FILE: legacy/docs/tools/social-data.mdx
================================================
---
title: Social Data Tools
description: Unofficial Twitter / X client (readonly) which is much cheaper than the official Twitter API.
---

- package: `@agentic/social-data`
- exports: `class SocialDataClient`, `namespace socialdata`
- env vars: `SOCIAL_DATA_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/social-data/src/social-data-client.ts)
- [social data tools api docs](https://socialdata.tools)

## Install

<CodeGroup>
```bash npm
npm install @agentic/social-data
```

```bash yarn
yarn add @agentic/social-data
```

```bash pnpm
pnpm add @agentic/social-data
```

</CodeGroup>

## Usage

```ts
import { SocialDataClient } from '@agentic/social-data'

const sd = new SocialDataClient()
const res = await sd.getUserByUsername('transitive_bs')
```


================================================
FILE: legacy/docs/tools/tavily.mdx
================================================
---
title: Tavily
description: Web search API tailored for LLMs.
---

- package: `@agentic/tavily`
- exports: `class TavilyClient`, `namespace tavily`
- env vars: `TAVILY_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/tavily/src/tavily-client.ts)
- [tavily api docs](https://tavily.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/tavily
```

```bash yarn
yarn add @agentic/tavily
```

```bash pnpm
pnpm add @agentic/tavily
```

</CodeGroup>

## Usage

```ts
import { TavilyClient } from '@agentic/tavily'

const tavily = new TavilyClient()
const res = await tavily.search('latest news')
```


================================================
FILE: legacy/docs/tools/twilio.mdx
================================================
---
title: Twilio
description: Twilio conversation API to send and receive SMS messages.
---

- package: `@agentic/twilio`
- exports: `class TwilioClient`, `namespace twilio`
- env vars: `TWILIO_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/twilio/src/twilio-client.ts)
- [twilio api docs](https://www.twilio.com/docs/conversations/api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/twilio
```

```bash yarn
yarn add @agentic/twilio
```

```bash pnpm
pnpm add @agentic/twilio
```

</CodeGroup>

## Usage

```ts
import { TwilioClient } from '@agentic/twilio'

const twilio = new TwilioClient()
const res = await twilio.sendMessage({
  conversationId: 'TODO',
  text: 'Hello, world'
})
```


================================================
FILE: legacy/docs/tools/twitter.mdx
================================================
---
title: Twitter
description: Official Twitter / X API client.
---

Basic Twitter API methods for fetching users, tweets, and searching recent tweets. Includes support for plan-aware rate-limiting.

- package: `@agentic/twitter`
- exports: `class TwitterClient`, `namespace twitter`
- env vars: `TWITTER_API_KEY`, `TWITTER_API_PLAN`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/twitter/src/twitter-client.ts)
- [twitter api docs](https://docs.x.com/x-api)

## Install

<CodeGroup>
```bash npm
npm install @agentic/twitter
```

```bash yarn
yarn add @agentic/twitter
```

```bash pnpm
pnpm add @agentic/twitter
```

</CodeGroup>

## Usage

```ts
import { TwitterClient, createTwitterV2Client } from '@agentic/twitter'

// Requires Nango connection ID and callback URL environment variables
const rawClient = await createTwitterV2Client()

const twitter = new TwitterClient({ client: rawClient })
const res = await twitter.createTweet({
  text: 'hello, world'
})
```

This example uses [Nango](https://www.nango.dev) for OAuth support via the [createTwitterV2Client](https://github.com/transitive-bullshit/agentic/blob/main/packages/twitter/src/client.ts#L53) helper function, but you can pass any instance of the underlying [TwitterV2Client](https://github.com/twitterdev/twitter-api-typescript-sdk) to the `TwitterClient` constructor.

All `TwitterClient` methods are automatically throttled based on your [Twitter API plan](https://docs.x.com/x-api/fundamentals/rate-limits). You can set the twitter plan by setting the `TWITTER_API_PLAN` environment variable or by passing the `twitterApiPlan` parameter to the `TwitterClient` constructor.

This twitter client is pretty robust, taking into account my [learnings from building a Twitter bot which gained over 150k followers](https://transitivebullsh.it/chatgpt-twitter-bot-lessons).


================================================
FILE: legacy/docs/tools/typeform.mdx
================================================
---
title: Typeform
description: Readonly Typeform API client for fetching form insights and responses.
---

- package: `@agentic/typeform`
- exports: `class TypeformClient`, `namespace typeform`
- env vars: `TYPEFORM_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/typeform/src/typeform-client.ts)
- [typeform api docs](https://www.typeform.com/developers/get-started/)

## Install

<CodeGroup>
```bash npm
npm install @agentic/typeform
```

```bash yarn
yarn add @agentic/typeform
```

```bash pnpm
pnpm add @agentic/typeform
```

</CodeGroup>

## Usage

```ts
import { TypeformClient } from '@agentic/typeform'

const typeform = new TypeformClient()

const responses = await typeform.getResponsesForForm({
  formId: 'TODO'
})

const insights = await typeform.getInsightsForForm({
  formId: 'TODO'
})
```


================================================
FILE: legacy/docs/tools/weather.mdx
================================================
---
title: Weather
description: Simple Weather API client for accessing weather data based on location.
---

- package: `@agentic/weather`
- exports: `class WeatherClient`, `namespace weather`
- env vars: `WEATHER_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/weather/src/weather-client.ts)
- [weatherapi.com api docs](https://www.weatherapi.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/weather
```

```bash yarn
yarn add @agentic/weather
```

```bash pnpm
pnpm add @agentic/weather
```

</CodeGroup>

## Usage

```ts
import { WeatherClient } from '@agentic/weather'

const weather = new WeatherClient()
const res = await weather.getCurrentWeather('new york')
```


================================================
FILE: legacy/docs/tools/wikidata.mdx
================================================
---
title: Wikidata
description: Basic Wikidata client.
---

- package: `@agentic/wikidata`
- exports: `class WikidataClient`, `namespace wikidata`
- env vars: `WIKIDATA_API_USER_AGENT` _(optional)_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/wikidata/src/wikidata-client.ts)
- [wikibase api docs](https://github.com/maxlath/wikibase-sdk)

## Install

<CodeGroup>
```bash npm
npm install @agentic/wikidata
```

```bash yarn
yarn add @agentic/wikidata
```

```bash pnpm
pnpm add @agentic/wikidata
```

</CodeGroup>

## Usage

```ts
import { WikidataClient } from '@agentic/wikidata'

const wikidata = new WikidataClient()
const res = await wikidata.getEntityById('Q317521') // elon musk
```


================================================
FILE: legacy/docs/tools/wikipedia.mdx
================================================
---
title: Wikipedia
description: Wikipedia apage search and summary API.
---

- package: `@agentic/wikipedia`
- exports: `class WikipediaClient`, `namespace wikipedia`
- env vars: `WIKIPEDIA_API_USER_AGENT` _(optional)_
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/wikipedia/src/wikipedia-client.ts)
- [wikipedia api docs](https://www.mediawiki.org/wiki/API)

## Install

<CodeGroup>
```bash npm
npm install @agentic/wikipedia
```

```bash yarn
yarn add @agentic/wikipedia
```

```bash pnpm
pnpm add @agentic/wikipedia
```

</CodeGroup>

## Usage

```ts
import { WikipediaClient } from '@agentic/wikipedia'

const wikipedia = new WikipediaClient()
const res0 = await wikipedia.search({ query: 'steve jobs' })
const res1 = await wikipedia.getPageSummary({ title: 'Elon_Musk' })
```


================================================
FILE: legacy/docs/tools/wolfram-alpha.mdx
================================================
---
title: Wolfram Alpha
description: Wolfram Alpha LLM API client for answering computational, mathematical, and scientific questions.
---

- package: `@agentic/wolfram-alpha`
- exports: `class WolframAlphaClient`, `namespace wolframalpha`
- env vars: `WOLFRAM_APP_ID`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/wolfram-alpha/src/wolfram-alpha-client.ts)
- [wolfram alpha api docs](https://products.wolframalpha.com/llm-api/documentation)

## Install

<CodeGroup>
```bash npm
npm install @agentic/wolfram-alpha
```

```bash yarn
yarn add @agentic/wolfram-alpha
```

```bash pnpm
pnpm add @agentic/wolfram-alpha
```

</CodeGroup>

## Usage

```ts
import { WolframAlphaClient } from '@agentic/wolfram-alpha'

const wolframAlpha = new WolframAlphaClient()
const res = await wolframAlpha.search('latest news')
```


================================================
FILE: legacy/docs/tools/youtube.mdx
================================================
---
title: YouTube
description: YouTube data API v3 client for searching YT videos and channels.
---

- package: `@agentic/youtube`
- exports: `class YouTubeClient`, `namespace youtube`
- env vars: `YOUTUBE_API_KEY`
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/youtube/src/youtube-client.ts)
- [youtube api docs](https://developers.google.com/youtube/v3)
  - [search docs](https://developers.google.com/youtube/v3/docs/search/list)

## Install

<CodeGroup>
```bash npm
npm install @agentic/youtube
```

```bash yarn
yarn add @agentic/youtube
```

```bash pnpm
pnpm add @agentic/youtube
```

</CodeGroup>

## Usage

```ts
import { YouTubeClient } from '@agentic/youtube'

const youtube = new YouTubeClient()
const res = await youtube.searchVideos({
  query: 'cute kittens'
})
```


================================================
FILE: legacy/docs/tools/zoominfo.mdx
================================================
---
title: ZoomInfo
description: ZoomInfo provides a powerful API for B2B person and company data enrichment.
---

- package: `@agentic/zoominfo`
- exports: `class ZoomInfo`, `namespace zoominfo`
- env vars:
  - `ZOOMINFO_USERNAME` and `ZOOMINFO_PASSWORD` for basic auth
  - `ZOOMINFO_USERNAME`, `ZOOMINFO_CLIENT_ID`, and `ZOOMINFO_PRIVATE_KEY` for PKI auth
- [source](https://github.com/transitive-bullshit/agentic/blob/main/packages/zoominfo/src/zoominfo-client.ts)
- [zoominfo api docs](https://api-docs.zoominfo.com)

## Install

<CodeGroup>
```bash npm
npm install @agentic/zoominfo
```

```bash yarn
yarn add @agentic/zoominfo
```

```bash pnpm
pnpm add @agentic/zoominfo
```

</CodeGroup>

## Usage

```ts
import { ZoomInfoClient } from '@agentic/zoominfo'

const zoomInfo = new ZoomInfoClient()
const res = await zoomInfo.enrichContact({
  emailAddress: 'travis@transitivebullsh.it'
})
```


================================================
FILE: legacy/docs/usage.mdx
================================================
---
title: Usage
---

## TS Tool Usage

Agentic clients like `WeatherClient` can be used as normal TS classes:

```ts
import { WeatherClient } from '@agentic/stdlib'

// Requires `process.env.WEATHER_API_KEY` (free from weatherapi.com)
const weather = new WeatherClient()

const result = await weather.getCurrentWeather({
  q: 'San Francisco'
})
console.log(result)
```

## LLM Tool Usage

Or you can use these clients as **LLM-based tools**. Here's an example using [Vercel's AI SDK](https://github.com/vercel/ai):

```ts
// sdk-specific imports
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'
import { createAISDKTools } from '@agentic/ai-sdk'

// sdk-agnostic imports
import { WeatherClient } from '@agentic/stdlib'

const weather = new WeatherClient()

const result = await generateText({
  model: openai('gpt-4o-mini'),
  // this is the key line which uses the `@agentic/ai-sdk` adapter
  tools: createAISDKTools(weather),
  toolChoice: 'required',
  prompt: 'What is the weather in San Francisco?'
})

console.log(result.toolResults[0])
```

You can use our standard library of thoroughly tested AI functions with your favorite AI SDK – without having to write any glue code!

### Using Multiple Tools

All adapters (like `createAISDKTools`) accept a very flexible var args of `AIFunctionLike` parameters, so you can pass as many tools as you'd like.

They also expose a `.functions` property which is an `AIFunctionSet`. This combination makes it really easy to mix & match different tools together.

```ts
import { SerperClient, WikipediaClient, FirecrawlClient } from '@agentic/stdlib'
import { createAIFunction } from '@agentic/core'
import { z } from 'zod'

const googleSearch = new SerperClient()
const wikipedia = new WikipediaClient()
const firecrawl = new FirecrawlClient()

const result = await generateText({
  model: openai('gpt-4o-mini'),
  // This example uses tools from 4 different sources. You can pass as many
  // AIFunctionLike objects as you want.
  tools: createAISDKTools(
    googleSearch,
    wikipedia,
    // Pick a single function from the firecrawl client's set of AI functions
    firecrawl.functions.pick('firecrawl_search'),
    // Create a custom AI function (based off of Anthropic's think tool: https://www.anthropic.com/engineering/claude-think-tool)
    createAIFunction({
      name: 'think',
      description: `Use this tool to think about something. It will not obtain new information or change the database, but just append the thought to the log. Use it when complex reasoning or some cache memory is needed.`,
      inputSchema: z.object({
        thought: z.string().describe('A thought to think about.')
      }),
      execute: ({ thought }) => thought
    })
  ),
  prompt:
    'What year did Jurassic Park the movie come out, and what else happened that year?'
})
```

An `AIFunctionLike` can be any agentic client instance, a single `AIFunction` selected from the client's `.functions` property (which holds an `AIFunctionSet` of available AI functions), or an AI function created manually via `createAIFunction`.

`AIFunctionLike` and `AIFunctionSet` are implementation details that you likely won't have to touch directly, but they're important because of their flexibility.

## AI SDKs

<CardGroup cols={2}>
<Card title='Vercel AI SDK' href='/sdks/ai-sdk'>
  Using Agentic with the Vercel AI SDK.
</Card>

<Card title='Mastra' href='/sdks/mastra'>
  Using Agentic with Mastra.
</Card>

<Card title='LangChain' href='/sdks/langchain'>
  Using Agentic with LangChain.
</Card>

<Card title='LlamaIndex' href='/sdks/llamaindex'>
  Using Agentic with LlamaIndex.
</Card>

<Card title='Firebase Genkit' href='/sdks/genkit'>
  Using Agentic with Genkit.
</Card>

<Card title='Dexa Dexter' href='/sdks/dexter'>
  Using Agentic with Dexter.
</Card>

<Card title='OpenAI' href='/sdks/openai'>
  Using Agentic with OpenAI directly.
</Card>

<Card title='xsAI SDK' href='/sdks/xsai'>
  Using Agentic with the xsAI SDK.
</Card>
</CardGroup>


================================================
FILE: legacy/eslint.config.js
================================================
import { config } from '@fisch0920/config/eslint'

export default [
  ...config,
  {
    ignores: ['packages/openapi-to-ts/fixtures/generated/**/*']
  },
  {
    rules: {
      'unicorn/prefer-single-call': 'off'
    }
  }
]


================================================
FILE: legacy/examples/dexter/bin/code-interpreter.ts
================================================
import 'dotenv/config'

import { createDexterFunctions } from '@agentic/dexter'
import { e2b } from '@agentic/e2b'
import { ChatModel, createAIRunner } from '@dexaai/dexter'

async function main() {
  const runner = createAIRunner({
    chatModel: new ChatModel({
      params: { model: 'gpt-4o-mini', temperature: 0 },
      debug: true
    }),
    functions: createDexterFunctions(e2b)
  })

  const result = await runner(
    'Visualize a distribution of height of men based on the latest data you know. Also print the median value.'
  )
  console.log(result)
}

await main()


================================================
FILE: legacy/examples/dexter/bin/election-news.ts
================================================
import 'dotenv/config'

import { createDexterFunctions } from '@agentic/dexter'
import { PerigonClient } from '@agentic/perigon'
import { SerperClient } from '@agentic/serper'
import { ChatModel, createAIRunner } from '@dexaai/dexter'

async function main() {
  const perigon = new PerigonClient()
  const serper = new SerperClient()

  const runner = createAIRunner({
    chatModel: new ChatModel({
      params: { model: 'gpt-4o-mini', temperature: 0 }
      // debug: true
    }),
    functions: createDexterFunctions(
      perigon.functions.pick('search_news_stories'),
      serper
    ),
    systemMessage:
      'You are a helpful assistant. Be as concise as possible. Respond in markdown. Always cite your sources.'
  })

  const result = await runner(
    'Summarize the latest news stories about the upcoming US election.'
  )
  console.log(result)
}

await main()


================================================
FILE: legacy/examples/dexter/bin/weather.ts
================================================
import 'dotenv/config'

import { createDexterFunctions } from '@agentic/dexter'
import { WeatherClient } from '@agentic/weather'
import { ChatModel, createAIRunner } from '@dexaai/dexter'

async function main() {
  const weather = new WeatherClient()

  const runner = createAIRunner({
    chatModel: new ChatModel({
      params: { model: 'gpt-4o-mini', temperature: 0 }
      // debug: true
    }),
    functions: createDexterFunctions(weather),
    systemMessage: 'You are a helpful assistant. Be as concise as possible.'
  })

  const result = await runner('What is the weather in San Francisco?')
  console.log(result)
}

await main()


================================================
FILE: legacy/examples/dexter/package.json
================================================
{
  "name": "agentic-examples-dexter",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/dexter": "workspace:*",
    "@agentic/e2b": "workspace:*",
    "@agentic/perigon": "workspace:*",
    "@agentic/serper": "workspace:*",
    "@agentic/stdlib": "workspace:*",
    "@agentic/weather": "workspace:*",
    "@dexaai/dexter": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: legacy/examples/dexter/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/examples/playground/bin/scratch.ts
================================================
import 'dotenv/config'

import * as stdlib from '@agentic/stdlib'
import restoreCursor from 'restore-cursor'

/**
 * Scratch pad for testing.
 */
async function main() {
  restoreCursor()

  // const clearbit = new ClearbitClient()
  // const res = await clearbit.companyEnrichment({
  //   domain: 'https://clay.com'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const proxycurl = new ProxycurlClient()
  // const res = await proxycurl.getLinkedInPerson({
  //   linkedin_profile_url: 'https://linkedin.com/in/fisch2'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const wikipedia = new WikipediaClient()
  // const res = await wikipedia.getPageSummary({
  //   // title: 'Naruto_(TV_series)'
  //   title: 'SpaceX'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const searxng = new SearxngClient()
  // const res = await searxng.search({
  //   query: 'golden gate bridge',
  //   engines: ['reddit']
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const perigon = new PerigonClient()
  // const res = await perigon.searchArticles({
  //   q: 'AI agents AND startup',
  //   sourceGroup: 'top50tech'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const firecrawl = new FirecrawlClient()
  // const res = await firecrawl.scrapeUrl({
  //   url: 'https://www.bbc.com/news/articles/cp4475gwny1o'
  //   // url: 'https://www.theguardian.com/technology/article/2024/jun/04/openai-google-ai-risks-letter'
  //   // url: 'https://www.firecrawl.dev'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const exa = new ExaClient()
  // const res = await exa.search({
  //   query: 'OpenAI',
  //   contents: { text: true }
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const diffbot = new DiffbotClient()
  // // const res = await diffbot.analyzeUrl({
  // //   url: 'https://www.bbc.com/news/articles/cp4475gwny1o'
  // // })
  // const res = await diffbot.enhanceEntity({
  //   type: 'Person',
  //   name: 'Kevin Raheja'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const wolfram = new WolframAlphaClient()
  // const res = await wolfram.ask({
  //   input: 'population of new york city'
  // })
  // console.log(res)

  // const client = await createTwitterV2Client({
  //   scopes: ['tweet.read', 'users.read', 'offline.access']
  // })
  // const twitter = new TwitterClient({ client })
  // // const res = await twitter.findUserByUsername({ username: 'transitive_bs' })
  // const res = await twitter.searchRecentTweets({
  //   query: 'open source AI agents'
  // })
  // console.log(res)

  // const midjourney = new MidjourneyClient()
  // const res = await midjourney.imagine(
  //   'tiny lil baby kittens playing with an inquisitive AI robot, kawaii, anime'
  // )
  // console.log(JSON.stringify(res, null, 2))

  // const bing = new BingClient()
  // const res = await bing.search({
  //   q: 'world cup 2024 freestyle wrestling news'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const tavily = new TavilyClient()
  // const res = await tavily.search({
  //   query: 'when do experts predict that OpenAI will release GPT-5?',
  //   include_answer: true
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const socialData = new SocialDataClient()
  // const res = await socialData.getUserByUsername('transitive_bs')
  // console.log(JSON.stringify(res, null, 2))

  // const hunter = new HunterClient()
  // // const res = await hunter.emailVerifier({
  // //   email: 'travis@transitivebullsh.it'
  // // })
  // const res = await hunter.emailFinder({
  //   domain: 'aomni.com',
  //   first_name: 'David',
  //   last_name: 'Zhang'
  // })
  // console.log(JSON.stringify(res, null, 2))

  // const jina = new JinaClient()
  // const res = await jina.readUrl({
  //   url: 'https://news.ycombinator.com'
  //   // returnFormat: 'screenshot'
  //   // json: true
  // })
  // const res = await jina.search({
  //   query: 'trump assassination attempt',
  //   // returnFormat: 'screenshot',
  //   json: true
  // })

  // const exa = new ExaClient()
  // const res = await exa.search({
  //   query: 'OpenAI',
  //   category: 'linkedin profile'
  // })

  // const zoomInfo = new ZoomInfoClient()
  // const res = await zoomInfo.enrichContact({
  //   // emailAddress: 'travis@transitivebullsh.it'
  //   fullName: 'Kevin Raheja',
  //   companyName: 'HeyGen'
  // })
  // const res = await zoomInfo.searchContacts({
  //   fullName: 'Kevin Raheja'
  // })
  // const gravatar = new stdlib.GravatarClient()
  // const res = await gravatar.getProfileByIdentifier('email@example.com')

  const hn = new stdlib.HackerNewsClient()
  // const res = await hn.getSearchItem('43201417')
  const res = await hn.searchItems({
    query: 'OpenAI',
    tags: ['story'],
    sortBy: 'recency',
    numericFilters: ['points>1000']
  })

  console.log(JSON.stringify(res, null, 2))
}

await main()


================================================
FILE: legacy/examples/playground/package.json
================================================
{
  "name": "agentic-examples-playground",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/stdlib": "workspace:*",
    "restore-cursor": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: legacy/examples/playground/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/examples/xsai/bin/weather.ts
================================================
/* eslint-disable no-process-env */
import 'dotenv/config'

import { WeatherClient } from '@agentic/weather'
import { createXSAITools } from '@agentic/xsai'
import { generateText } from 'xsai'

async function main() {
  const weather = new WeatherClient()

  const result = await generateText({
    apiKey: process.env.OPENAI_API_KEY!,
    baseURL: 'https://api.openai.com/v1/',
    model: 'gpt-4o-mini',
    tools: await createXSAITools(weather),
    toolChoice: 'required',
    temperature: 0,
    messages: [
      {
        role: 'system',
        content: 'You are a helpful assistant. Be as concise as possible.'
      },
      { role: 'user', content: 'What is the weather in San Francisco?' }
    ]
  })

  console.log(JSON.stringify(result, null, 2))
}

await main()


================================================
FILE: legacy/examples/xsai/package.json
================================================
{
  "name": "agentic-examples-xsai",
  "type": "module",
  "private": true,
  "scripts": {
    "test": "run-s test:*",
    "test:lint": "eslint .",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/xsai": "workspace:*",
    "@agentic/weather": "workspace:*",
    "xsai": "catalog:",
    "@xsai/tool": "catalog:",
    "zod": "catalog:"
  }
}


================================================
FILE: legacy/examples/xsai/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["bin"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/license
================================================
MIT License

Copyright (c) 2025 Travis Fischer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: legacy/package.json
================================================
{
  "name": "agentic",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git"
  },
  "packageManager": "pnpm@10.12.2",
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "scripts": {
    "build": "turbo build",
    "dev": "turbo dev --continue",
    "docs": "cd docs && npx mintlify dev",
    "clean": "turbo clean",
    "fix": "run-s fix:*",
    "fix:format": "prettier --write \"**/*.{js,ts,tsx}\"",
    "test": "turbo test",
    "test:format": "prettier --check \"**/*.{js,ts,tsx}\"",
    "test:lint": "turbo test:lint",
    "test:typecheck": "turbo test:typecheck",
    "test:unit": "turbo test:unit",
    "release": "bumpp -r && pnpm publish -r",
    "pretest": "run-s build",
    "prerelease": "run-s build",
    "precommit": "lint-staged",
    "preinstall": "npx only-allow pnpm",
    "prepare": "simple-git-hooks"
  },
  "devDependencies": {
    "@fisch0920/config": "catalog:",
    "@types/node": "catalog:",
    "bumpp": "catalog:",
    "del-cli": "catalog:",
    "dotenv": "catalog:",
    "eslint": "catalog:",
    "lint-staged": "catalog:",
    "npm-run-all2": "catalog:",
    "only-allow": "catalog:",
    "prettier": "catalog:",
    "simple-git-hooks": "catalog:",
    "syncpack": "catalog:",
    "tsup": "catalog:",
    "tsx": "catalog:",
    "turbo": "catalog:",
    "typescript": "catalog:",
    "vitest": "catalog:",
    "zod": "catalog:"
  },
  "prettier": "@fisch0920/config/prettier",
  "simple-git-hooks": {
    "pre-commit": "npx lint-staged"
  },
  "lint-staged": {
    "*.{ts,tsx}": [
      "prettier --ignore-unknown --write",
      "eslint --fix"
    ]
  }
}


================================================
FILE: legacy/packages/airtable/package.json
================================================
{
  "name": "@agentic/airtable",
  "version": "7.6.9",
  "description": "Agentic SDK for Airtable.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/airtable"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/airtable/src/airtable-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

import { airtable } from './airtable'

/**
 * Airtable API client.
 *
 * @see https://airtable.com/developers/web/api/introduction
 */
export class AirtableClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('AIRTABLE_API_KEY'),
    apiBaseUrl = airtable.API_BASE_URL,
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      `AirtableClient missing required "apiKey" (defaults to "AIRTABLE_API_KEY")`
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  /**
   * Lists all of the bases that the user has access to.
   */
  @aiFunction({
    name: 'airtable_list_bases',
    description: 'Lists all accessible Airtable bases.',
    inputSchema: z.object({})
  })
  async listBases(): Promise<airtable.ListBasesResponse> {
    return this.ky.get('v0/meta/bases').json<airtable.ListBasesResponse>()
  }

  /**
   * Lists all of the tables in a base.
   */
  @aiFunction({
    name: 'airtable_list_tables',
    description: 'Lists all of the tables in a base.',
    inputSchema: airtable.ListTablesArgsSchema
  })
  async listTables<
    TDetailLevel extends airtable.TableDetailLevel = 'full'
  >(args: {
    baseId: string
    detailLevel?: TDetailLevel
  }): Promise<Array<airtable.AirtableTableToDetailLevel<TDetailLevel>>> {
    const { baseId, detailLevel = 'full' } = args

    const res = await this.ky
      .get(`/v0/meta/bases/${baseId}/tables`)
      .json<airtable.BaseSchemaResponse>()

    return res.tables.map((table) =>
      transformTableDetailLevel<TDetailLevel>({
        table,
        detailLevel: detailLevel as TDetailLevel
      })
    )
  }

  /**
   * Gets a single table's schema in a base.
   */
  @aiFunction({
    name: 'airtable_get_table',
    description: "Gets a single table's schema in a base.",
    inputSchema: airtable.DescribeTableArgsSchema
  })
  async getTable<
    TDetailLevel extends airtable.TableDetailLevel = 'full'
  >(args: {
    baseId: string
    tableId: string
    detailLevel?: TDetailLevel
  }): Promise<airtable.AirtableTableToDetailLevel<TDetailLevel>> {
    const tables = await this.listTables<TDetailLevel>(args)
    const table = tables.find((t) => t.id === args.tableId)
    assert(table, `Table ${args.tableId} not found in base ${args.baseId}`)
    return table
  }

  /**
   * Lists records from a table.
   */
  @aiFunction({
    name: 'airtable_list_records',
    description: 'Lists records from a table.',
    inputSchema: airtable.ListRecordsArgsSchema
  })
  async listRecords(
    args: airtable.ListRecordsArgs
  ): Promise<airtable.AirtableRecord[]> {
    const { baseId, tableId, ...options } = args
    return this.ky
      .get(`/v0/${baseId}/${tableId}`, {
        searchParams: sanitizeSearchParams(options)
      })
      .json<airtable.AirtableRecord[]>()
  }

  /**
   * Lists all records from a table.
   */
  @aiFunction({
    name: 'airtable_list_all_records',
    description: 'Lists all records from a table.',
    inputSchema: airtable.ListRecordsArgsSchema
  })
  async listAllRecords(
    args: airtable.ListRecordsArgs
  ): Promise<airtable.AirtableRecord[]> {
    const allRecords: airtable.AirtableRecord[] = []
    let offset = args.offset ?? 0

    do {
      const res = await this.listRecords({
        ...args,
        offset
      })
      if (!res.length) {
        break
      }

      allRecords.push(...res)
      offset += res.length
    } while (true)

    return allRecords
  }

  /**
   * Gets a single record from a table.
   */
  @aiFunction({
    name: 'airtable_get_record',
    description: 'Gets a single record from a table.',
    inputSchema: airtable.GetRecordArgsSchema
  })
  async getRecord(
    args: airtable.GetRecordArgs
  ): Promise<airtable.AirtableRecord> {
    const { baseId, tableId, recordId } = args
    return this.ky
      .get(`/v0/${baseId}/${tableId}/${recordId}`)
      .json<airtable.AirtableRecord>()
  }

  /**
   * Creates a record in a table.
   */
  @aiFunction({
    name: 'airtable_create_record',
    description: 'Creates a record in a table.',
    inputSchema: airtable.CreateRecordArgsSchema
  })
  async createRecord(
    args: airtable.CreateRecordArgs
  ): Promise<airtable.AirtableRecord> {
    const { baseId, tableId, ...body } = args
    return this.ky
      .post(`/v0/${baseId}/${tableId}`, {
        json: body
      })
      .json<airtable.AirtableRecord>()
  }

  /**
   * Updates records in a table.
   */
  @aiFunction({
    name: 'airtable_update_records',
    description: 'Updates records in a table.',
    inputSchema: airtable.UpdateRecordsArgsSchema
  })
  async updateRecords(
    args: airtable.UpdateRecordsArgs
  ): Promise<airtable.AirtableRecord[]> {
    const { baseId, tableId, ...body } = args
    return this.ky
      .patch(`/v0/${baseId}/${tableId}`, {
        json: body
      })
      .json<airtable.AirtableRecord[]>()
  }

  /**
   * Deletes records from a table.
   */
  @aiFunction({
    name: 'airtable_delete_records',
    description: 'Deletes records from a table.',
    inputSchema: airtable.DeleteRecordsArgsSchema
  })
  async deleteRecords(
    args: airtable.DeleteRecordsArgs
  ): Promise<{ id: string }[]> {
    const { baseId, tableId, recordIds } = args
    const queryString = recordIds.map((id) => `records[]=${id}`).join('&')

    const res = await this.ky
      .delete(`/v0/${baseId}/${tableId}?${queryString}`)
      .json<{ records: { id: string; deleted: boolean }[] }>()

    return res.records.map(({ id }) => ({ id }))
  }

  /**
   * Creates a table in a base.
   */
  @aiFunction({
    name: 'airtable_create_table',
    description: 'Creates a table in a base.',
    inputSchema: airtable.CreateTableArgsSchema
  })
  async createTable(args: airtable.CreateTableArgs): Promise<airtable.Table> {
    const { baseId, ...body } = args

    return this.ky
      .post(`/v0/meta/bases/${baseId}/tables`, {
        json: body
      })
      .json<airtable.Table>()
  }

  /**
   * Updates a table in a base.
   */
  @aiFunction({
    name: 'airtable_update_table',
    description: 'Updates a table in a base.',
    inputSchema: airtable.UpdateTableArgsSchema
  })
  async updateTable(args: airtable.UpdateTableArgs): Promise<airtable.Table> {
    const { baseId, tableId, ...body } = args
    return this.ky
      .patch(`/v0/meta/bases/${baseId}/tables/${tableId}`, {
        json: body
      })
      .json<airtable.Table>()
  }

  /**
   * Creates a field in a table.
   */
  @aiFunction({
    name: 'airtable_create_field',
    description: 'Creates a field in a table.',
    inputSchema: airtable.CreateFieldArgsSchema
  })
  async createField(args: airtable.CreateFieldArgs): Promise<airtable.Field> {
    const { baseId, tableId, body } = args
    return this.ky
      .post(`/v0/meta/bases/${baseId}/tables/${tableId}/fields`, {
        json: body.field
      })
      .json<airtable.Field>()
  }

  /**
   * Updates a field in a table.
   */
  @aiFunction({
    name: 'airtable_update_field',
    description: 'Updates a field in a table.',
    inputSchema: airtable.UpdateFieldArgsSchema
  })
  async updateField(args: airtable.UpdateFieldArgs): Promise<airtable.Field> {
    const { baseId, tableId, fieldId, ...body } = args
    return this.ky
      .patch(`/v0/meta/bases/${baseId}/tables/${tableId}/fields/${fieldId}`, {
        json: body
      })
      .json<airtable.Field>()
  }

  /**
   * Searches for records in a table which contain specific text.
   */
  @aiFunction({
    name: 'airtable_search_records',
    description: 'Searches for records in a table which contain specific text.',
    inputSchema: airtable.SearchRecordsArgsSchema
  })
  async searchRecords(
    args: airtable.SearchRecordsArgs
  ): Promise<airtable.AirtableRecord[]> {
    const { baseId, tableId, fieldIds, searchTerm, ...opts } = args
    // Validate and get search fields
    const searchFieldIds = await this.validateAndGetSearchFields({
      baseId,
      tableId,
      fieldIds
    })

    // Escape the search term to prevent formula injection
    const escapedSearchTerm = searchTerm.replaceAll(/["\\]/g, '\\$&')

    // Build OR(FIND("term", field1), FIND("term", field2), ...)
    const filterByFormula = `OR(${searchFieldIds
      .map((fieldId) => `FIND("${escapedSearchTerm}", {${fieldId}})`)
      .join(',')})`

    return this.listRecords({ ...opts, baseId, tableId, filterByFormula })
  }

  /**
   * Validates and gets the searchable text fields in a table.
   */
  protected async validateAndGetSearchFields({
    baseId,
    tableId,
    fieldIds
  }: {
    baseId: string
    tableId: string
    fieldIds?: string[]
  }): Promise<string[]> {
    const table = await this.getTable({ baseId, tableId })

    const searchableFieldTypes = new Set([
      'singleLineText',
      'multilineText',
      'richText',
      'email',
      'url',
      'phoneNumber'
    ])

    const searchableFieldIds = new Set(
      table.fields
        .filter((field) => searchableFieldTypes.has(field.type))
        .map((field) => field.id)
    )

    if (!searchableFieldIds.size) {
      throw new Error('No text fields available to search')
    }

    // If specific fields were requested, validate that they exist and are, in
    // fact, valid searchable text fields.
    if (fieldIds && fieldIds.length > 0) {
      // Check if any requested fields were invalid
      const invalidFieldIds = fieldIds.filter(
        (fieldId) => !searchableFieldIds.has(fieldId)
      )
      if (invalidFieldIds.length > 0) {
        throw new Error(
          `Invalid fields requested: ${invalidFieldIds.join(', ')}`
        )
      }

      return fieldIds
    }

    return Array.from(searchableFieldIds)
  }
}

function transformTableDetailLevel<
  T extends airtable.TableDetailLevel = 'full'
>({
  table,
  detailLevel
}: {
  table: airtable.Table
  detailLevel: T
}): airtable.AirtableTableToDetailLevel<T> {
  switch (detailLevel) {
    case 'tableIdentifiersOnly':
      return {
        id: table.id,
        name: table.name
      } as any

    case 'identifiersOnly':
      return {
        id: table.id,
        name: table.name,
        fields: table.fields.map((field) => ({
          id: field.id,
          name: field.name
        })),
        views: table.views.map((view) => ({
          id: view.id,
          name: view.name
        }))
      } as any

    default:
      return table as any
  }
}


================================================
FILE: legacy/packages/airtable/src/airtable.ts
================================================
import { z } from 'zod'

export namespace airtable {
  export const API_BASE_URL = 'https://api.airtable.com'

  export const BaseSchema = z.object({
    id: z.string(),
    name: z.string(),
    permissionLevel: z.string()
  })
  export type Base = z.infer<typeof BaseSchema>

  export const ListBasesResponseSchema = z.object({
    bases: z.array(BaseSchema),
    offset: z.string().optional()
  })
  export type ListBasesResponse = z.infer<typeof ListBasesResponseSchema>

  export const FieldOptionsSchema = z
    .object({
      isReversed: z.boolean().optional(),
      inverseLinkFieldId: z.string().optional(),
      linkedTableId: z.string().optional(),
      prefersSingleRecordLink: z.boolean().optional(),
      color: z.string().optional(),
      icon: z.string().optional()
    })
    .passthrough()
  export type FieldOptions = z.infer<typeof FieldOptionsSchema>

  export const FieldSchema = z
    .object({
      name: z.string(),
      description: z.string().optional()
    })
    .and(
      // Extracted from Airtable API docs
      z.union([
        z.object({ type: z.literal('autoNumber') }),
        z.object({ type: z.literal('barcode') }),
        z.object({ type: z.literal('button') }),
        z
          .object({
            options: z.object({
              color: z
                .enum([
                  'greenBright',
                  'tealBright',
                  'cyanBright',
                  'blueBright',
                  'purpleBright',
                  'pinkBright',
                  'redBright',
                  'orangeBright',
                  'yellowBright',
                  'grayBright'
                ])
                .describe('The color of the checkbox.'),
              icon: z
                .enum([
                  'check',
                  'xCheckbox',
                  'star',
                  'heart',
                  'thumbsUp',
                  'flag',
                  'dot'
                ])
                .describe('The icon name of the checkbox.')
            }),
            type: z.literal('checkbox')
          })
          .describe(
            "Bases on a free or plus plan are limited to using the `'check'` icon and `'greenBright'` color."
          ),
        z.object({ type: z.literal('createdBy') }),
        z.object({
          options: z.object({
            result: z
              .union([
                z.object({
                  options: z.object({
                    dateFormat: z.object({
                      format: z
                        .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                        .describe(
                          '`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                        ),
                      name: z.enum([
                        'local',
                        'friendly',
                        'us',
                        'european',
                        'iso'
                      ])
                    })
                  }),
                  type: z.literal('date')
                }),
                z.object({
                  options: z.object({
                    dateFormat: z.object({
                      format: z
                        .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                        .describe(
                          '`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                        ),
                      name: z.enum([
                        'local',
                        'friendly',
                        'us',
                        'european',
                        'iso'
                      ])
                    }),
                    timeFormat: z.object({
                      format: z.enum(['h:mma', 'HH:mm']),
                      name: z.enum(['12hour', '24hour'])
                    }),
                    timeZone: z.any()
                  }),
                  type: z.literal('dateTime')
                })
              ])
              .describe(
                'This will always be a `date` or `dateTime` field config.'
              )
              .optional()
          }),
          type: z.literal('createdTime')
        }),
        z.object({
          options: z.object({
            isValid: z
              .boolean()
              .describe(
                '`false` when recordLinkFieldId is null, e.g. the referenced column was deleted.'
              ),
            recordLinkFieldId: z.union([z.string(), z.null()]).optional()
          }),
          type: z.literal('count')
        }),
        z.any(),
        z.object({
          options: z.object({
            isValid: z
              .boolean()
              .describe(
                'False if this formula/field configuation has an error'
              ),
            referencedFieldIds: z
              .union([z.array(z.string()), z.null()])
              .describe('The fields to check the last modified time of'),
            result: z
              .union([
                z.object({
                  options: z.object({
                    dateFormat: z.object({
                      format: z
                        .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                        .describe(
                          '`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                        ),
                      name: z.enum([
                        'local',
                        'friendly',
                        'us',
                        'european',
                        'iso'
                      ])
                    })
                  }),
                  type: z.literal('date')
                }),
                z.object({
                  options: z.object({
                    dateFormat: z.object({
                      format: z
                        .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                        .describe(
                          '`format` is always provided when reading.\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                        ),
                      name: z.enum([
                        'local',
                        'friendly',
                        'us',
                        'european',
                        'iso'
                      ])
                    }),
                    timeFormat: z.object({
                      format: z.enum(['h:mma', 'HH:mm']),
                      name: z.enum(['12hour', '24hour'])
                    }),
                    timeZone: z.any()
                  }),
                  type: z.literal('dateTime')
                }),
                z.null()
              ])
              .describe(
                'This will always be a `date` or `dateTime` field config.'
              )
          }),
          type: z.literal('lastModifiedTime')
        }),
        z.object({ type: z.literal('lastModifiedBy') }),
        z.object({
          options: z.object({
            fieldIdInLinkedTable: z
              .union([z.string(), z.null()])
              .describe(
                'The field in the linked table that this field is looking up.'
              ),
            isValid: z
              .boolean()
              .describe(
                'Is the field currently valid (e.g. false if the linked record field has\nbeen deleted)'
              ),
            recordLinkFieldId: z
              .union([z.string(), z.null()])
              .describe('The linked record field in the current table.'),
            result: z
              .union([z.any(), z.null()])
              .describe(
                'The field type and options inside of the linked table. See other field\ntype configs on this page for the possible values. Can be null if invalid.'
              )
          }),
          type: z.literal('lookup')
        }),
        z.object({
          options: z.object({
            precision: z
              .number()
              .describe(
                'Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)'
              )
          }),
          type: z.literal('number')
        }),
        z.object({
          options: z.object({
            precision: z
              .number()
              .describe(
                'Indicates the number of digits shown to the right of the decimal point for this field. (0-8 inclusive)'
              )
          }),
          type: z.literal('percent')
        }),
        z.object({
          options: z.object({
            precision: z
              .number()
              .describe(
                'Indicates the number of digits shown to the right of the decimal point for this field. (0-7 inclusive)'
              ),
            symbol: z.string().describe('Currency symbol to use.')
          }),
          type: z.literal('currency')
        }),
        z.object({
          options: z.object({
            durationFormat: z.enum([
              'h:mm',
              'h:mm:ss',
              'h:mm:ss.S',
              'h:mm:ss.SS',
              'h:mm:ss.SSS'
            ])
          }),
          type: z.literal('duration')
        }),
        z.object({ type: z.literal('multilineText') }),
        z.object({ type: z.literal('phoneNumber') }),
        z
          .object({
            options: z.object({
              color: z
                .enum([
                  'yellowBright',
                  'orangeBright',
                  'redBright',
                  'pinkBright',
                  'purpleBright',
                  'blueBright',
                  'cyanBright',
                  'tealBright',
                  'greenBright',
                  'grayBright'
                ])
                .describe('The color of selected icons.'),
              icon: z
                .enum(['star', 'heart', 'thumbsUp', 'flag', 'dot'])
                .describe('The icon name used to display the rating.'),
              max: z
                .number()
                .describe(
                  'The maximum value for the rating, from 1 to 10 inclusive.'
                )
            }),
            type: z.literal('rating')
          })
          .describe(
            "Bases on a free or plus plan are limited to using the 'star' icon and 'yellowBright' color."
          ),
        z.object({ type: z.literal('richText') }),
        z.object({
          options: z.object({
            fieldIdInLinkedTable: z
              .string()
              .describe('The id of the field in the linked table')
              .optional(),
            isValid: z.boolean().optional(),
            recordLinkFieldId: z
              .string()
              .describe('The linked field id')
              .optional(),
            referencedFieldIds: z
              .array(z.string())
              .describe(
                'The ids of any fields referenced in the rollup formula'
              )
              .optional(),
            result: z
              .union([z.any(), z.null()])
              .describe(
                'The resulting field type and options for the rollup. See other field\ntype configs on this page for the possible values. Can be null if invalid.'
              )
              .optional()
          }),
          type: z.literal('rollup')
        }),
        z.object({ type: z.literal('singleLineText') }),
        z.object({ type: z.literal('email') }),
        z.object({ type: z.literal('url') }),
        z.object({
          options: z.object({
            choices: z.array(
              z.object({
                color: z
                  .string()
                  .describe(
                    'Optional when the select field is configured to not use colors.\n\nAllowed values: "blueLight2", "cyanLight2", "tealLight2", "greenLight2", "yellowLight2", "orangeLight2", "redLight2", "pinkLight2", "purpleLight2", "grayLight2", "blueLight1", "cyanLight1", "tealLight1", "greenLight1", "yellowLight1", "orangeLight1", "redLight1", "pinkLight1", "purpleLight1", "grayLight1", "blueBright", "cyanBright", "tealBright", "greenBright", "yellowBright", "orangeBright", "redBright", "pinkBright", "purpleBright", "grayBright", "blueDark1", "cyanDark1", "tealDark1", "greenDark1", "yellowDark1", "orangeDark1", "redDark1", "pinkDark1", "purpleDark1", "grayDark1"'
                  )
                  .optional(),
                id: z.string(),
                name: z.string()
              })
            )
          }),
          type: z.literal('externalSyncSource')
        }),
        z.object({
          options: z.object({
            prompt: z
              .array(
                z.union([
                  z.string(),
                  z.object({ field: z.object({ fieldId: z.string() }) })
                ])
              )
              .describe(
                'The prompt that is used to generate the results in the AI field, additional object\ntypes may be added in the future. Currently, this is an array of strings or objects that identify any fields interpolated into the prompt.\n\nThe prompt will not currently be provided if this field config is within another\nfields configuration (like a lookup field)'
              )
              .optional(),
            referencedFieldIds: z
              .array(z.string())
              .describe(
                'The other fields in the record that are used in the ai field\n\nThe referencedFieldIds will not currently be provided if this field config is within another\nfields configuration (like a lookup field)'
              )
              .optional()
          }),
          type: z.literal('aiText')
        }),
        z
          .object({
            options: z.object({
              linkedTableId: z
                .string()
                .describe('The ID of the table this field links to'),
              viewIdForRecordSelection: z
                .string()
                .describe(
                  'The ID of the view in the linked table\nto use when showing a list of records to select from'
                )
                .optional()
            }),
            type: z.literal('multipleRecordLinks')
          })
          .describe(
            'Creating "multipleRecordLinks" fields is supported but updating options for\nexisting "multipleRecordLinks" fields is not supported.'
          ),
        z.object({
          options: z.object({
            choices: z.array(
              z.object({
                color: z
                  .string()
                  .describe('Optional when creating an option.')
                  .optional(),
                id: z
                  .string()
                  .describe(
                    'This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)'
                  )
                  .optional(),
                name: z.string()
              })
            )
          }),
          type: z.literal('singleSelect')
        }),
        z.object({
          options: z.object({
            choices: z.array(
              z.object({
                color: z
                  .string()
                  .describe('Optional when creating an option.')
                  .optional(),
                id: z
                  .string()
                  .describe(
                    'This is not specified when creating new options, useful when specifing existing\noptions (for example: reordering options, keeping old options and adding new ones, etc)'
                  )
                  .optional(),
                name: z.string()
              })
            )
          }),
          type: z.literal('multipleSelects')
        }),
        z.object({
          options: z.record(z.any()).optional(),
          type: z.literal('singleCollaborator')
        }),
        z.object({
          options: z.record(z.any()).optional(),
          type: z.literal('multipleCollaborators')
        }),
        z.object({
          options: z.object({
            dateFormat: z.object({
              format: z
                .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                .describe(
                  'Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                )
                .optional(),
              name: z.enum(['local', 'friendly', 'us', 'european', 'iso'])
            })
          }),
          type: z.literal('date')
        }),
        z.object({
          options: z.object({
            dateFormat: z.object({
              format: z
                .enum(['l', 'LL', 'M/D/YYYY', 'D/M/YYYY', 'YYYY-MM-DD'])
                .describe(
                  'Format is optional when writing, but it must match\nthe corresponding name if provided.\n\n(`l` for local, `LL` for friendly, `M/D/YYYY` for us, `D/M/YYYY` for european, `YYYY-MM-DD` for iso)'
                )
                .optional(),
              name: z.enum(['local', 'friendly', 'us', 'european', 'iso'])
            }),
            timeFormat: z.object({
              format: z.enum(['h:mma', 'HH:mm']).optional(),
              name: z.enum(['12hour', '24hour'])
            }),
            timeZone: z.any()
          }),
          type: z.literal('dateTime')
        }),
        z.object({
          options: z.object({ isReversed: z.boolean() }).optional(),
          type: z.literal('multipleAttachments')
        })
      ])
    )
    .describe(
      'The config of a field. NB: Formula fields cannot be created with this MCP due to a limitation in the Airtable API.'
    )
  export type Field = z.infer<typeof FieldSchema> & { id: string }

  export const ViewSchema = z.object({
    id: z.string(),
    name: z.string(),
    type: z.string()
  })
  export type View = z.infer<typeof ViewSchema>

  export const TableSchema = z.object({
    id: z.string(),
    name: z.string(),
    description: z.string().optional(),
    primaryFieldId: z.string(),
    fields: z.array(FieldSchema.and(z.object({ id: z.string() }))),
    views: z.array(ViewSchema)
  })
  export type Table = z.infer<typeof TableSchema>

  export const BaseSchemaResponseSchema = z.object({
    tables: z.array(TableSchema)
  })
  export type BaseSchemaResponse = z.infer<typeof BaseSchemaResponseSchema>

  // Zod schemas for tool arguments
  export const ListRecordsArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    offset: z
      .number()
      .optional()
      .describe('Offset to start the list from. Defaults to 0.'),
    maxRecords: z
      .number()
      .optional()
      .describe('Maximum number of records to return. Defaults to 100.'),
    filterByFormula: z
      .string()
      .optional()
      .describe('Airtable formula to filter records')
  })
  export type ListRecordsArgs = z.infer<typeof ListRecordsArgsSchema>

  export const SearchRecordsArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    searchTerm: z.string().describe('Text to search for in records'),
    fieldIds: z
      .array(z.string())
      .optional()
      .describe(
        'Specific field ids to search in. If not provided, searches all text-based fields.'
      ),
    maxRecords: z
      .number()
      .optional()
      .describe('Maximum number of records to return. Defaults to 100.')
  })
  export type SearchRecordsArgs = z.infer<typeof SearchRecordsArgsSchema>

  export const TableDetailLevelSchema = z.enum([
    'tableIdentifiersOnly',
    'identifiersOnly',
    'full'
  ]).describe(`Detail level for table information:
  - tableIdentifiersOnly: table IDs and names
  - identifiersOnly: table, field, and view IDs and names
  - full: complete details including field types, descriptions, and configurations

  Note for LLMs: To optimize context window usage, request the minimum detail level needed:
  - Use 'tableIdentifiersOnly' when you only need to list or reference tables
  - Use 'identifiersOnly' when you need to work with field or view references
  - Only use 'full' when you need field types, descriptions, or other detailed configuration

  If you only need detailed information on a few tables in a base with many complex tables, it might be more efficient for you to use list_tables with tableIdentifiersOnly, then describe_table with full on the specific tables you want.`)
  export type TableDetailLevel = z.infer<typeof TableDetailLevelSchema>

  export const DescribeTableArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    detailLevel: TableDetailLevelSchema.optional().default('full')
  })
  export type DescribeTableArgs = z.infer<typeof DescribeTableArgsSchema>

  export const ListTablesArgsSchema = z.object({
    baseId: z.string(),
    detailLevel: TableDetailLevelSchema.optional().default('full')
  })
  export type ListTablesArgs = z.infer<typeof ListTablesArgsSchema>

  export const GetRecordArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    recordId: z.string()
  })
  export type GetRecordArgs = z.infer<typeof GetRecordArgsSchema>

  export const CreateRecordArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    fields: z.record(z.any())
  })
  export type CreateRecordArgs = z.infer<typeof CreateRecordArgsSchema>

  export const UpdateRecordsArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    records: z.array(
      z.object({
        id: z.string(),
        fields: z.record(z.any())
      })
    )
  })
  export type UpdateRecordsArgs = z.infer<typeof UpdateRecordsArgsSchema>

  export const DeleteRecordsArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    recordIds: z.array(z.string())
  })
  export type DeleteRecordsArgs = z.infer<typeof DeleteRecordsArgsSchema>

  export const CreateTableArgsSchema = z.object({
    baseId: z.string(),
    name: z
      .string()
      .describe('Name for the new table. Must be unique in the base.'),
    description: z.string().optional(),
    fields: z.array(FieldSchema).describe(`Table fields. Rules:
  - At least one field must be specified.
  - The primary (first) field must be one of: single line text, long text, date, phone number, email, URL, number, currency, percent, duration, formula, autonumber, barcode.`)
  })
  export type CreateTableArgs = z.infer<typeof CreateTableArgsSchema>

  export const UpdateTableArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    name: z.string().optional(),
    description: z.string().optional()
  })
  export type UpdateTableArgs = z.infer<typeof UpdateTableArgsSchema>

  export const CreateFieldArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    // This is used as a workaround for https://github.com/orgs/modelcontextprotocol/discussions/90
    body: z.object({
      field: FieldSchema
    })
  })
  export type CreateFieldArgs = z.infer<typeof CreateFieldArgsSchema>

  export const UpdateFieldArgsSchema = z.object({
    baseId: z.string(),
    tableId: z.string(),
    fieldId: z.string(),
    name: z.string().optional(),
    description: z.string().optional()
  })
  export type UpdateFieldArgs = z.infer<typeof UpdateFieldArgsSchema>

  export type FieldSet = Record<string, any>
  export type AirtableRecord = { id: string; fields: FieldSet }

  export type AirtableTableToDetailLevel<
    TDetailLevel extends TableDetailLevel | undefined = 'full'
  > = TDetailLevel extends undefined
    ? airtable.Table
    : TDetailLevel extends 'full'
      ? airtable.Table
      : TDetailLevel extends 'identifiersOnly'
        ? {
            id: string
            name: string
            fields: { id: string; name: string }[]
            views: { id: string; name: string }[]
          }
        : TDetailLevel extends 'tableIdentifiersOnly'
          ? { id: string; name: string }
          : never
}


================================================
FILE: legacy/packages/airtable/src/index.ts
================================================
export * from './airtable'
export * from './airtable-client'


================================================
FILE: legacy/packages/airtable/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/apollo/package.json
================================================
{
  "name": "@agentic/apollo",
  "version": "7.6.9",
  "description": "Agentic SDK for Apollo.io.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/apollo"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/apollo/src/apollo-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace apollo {
  export const API_BASE_URL = 'https://api.apollo.io'

  // Allow up to 5 requests per second by default.
  // https://docs.apollo.io/reference/rate-limits
  export const throttle = pThrottle({
    limit: 5,
    interval: 1000
  })

  export interface EnrichPersonOptions {
    first_name?: string
    last_name?: string
    name?: string
    email?: string
    hashed_email?: string
    organization_name?: string
    domain?: string
    id?: string
    linkedin_url?: string
    reveal_personal_emails?: boolean
    reveal_phone_number?: boolean
    webhook_url?: string
  }

  export interface EnrichPersonResponse {
    person: Person
  }

  export interface Person {
    id: string
    first_name: string
    last_name: string
    name: string
    linkedin_url: string
    title: string
    email_status: string
    photo_url: string
    twitter_url: any
    github_url: any
    facebook_url: any
    extrapolated_email_confidence: any
    headline: string
    email: string
    organization_id: string
    employment_history: EmploymentHistory[]
    state: string
    city: string
    country: string
    contact_id: string
    contact: Contact
    revealed_for_current_team: boolean
    organization: Organization
    is_likely_to_engage: boolean
    intent_strength: any
    show_intent: boolean
    departments: string[]
    subdepartments: string[]
    functions: string[]
    seniority: string
  }

  export interface EmploymentHistory {
    _id: string
    id: string
    created_at: string | null
    updated_at: string | null
    title: string
    key: string
    current: boolean
    degree: string | null
    description: string | null
    emails: any
    end_date?: string
    grade_level: string | null
    kind: string | null
    major: string | null
    organization_id?: string | null
    organization_name: string | null
    raw_address: string | null
    start_date: string
  }

  export interface Contact {
    contact_roles: any[]
    id: string
    first_name: string
    last_name: string
    name: string
    linkedin_url: string
    title: string
    contact_stage_id: string
    owner_id: any
    creator_id: string
    person_id: string
    email_needs_tickling: any
    organization_name: string
    source: string
    original_source: string
    organization_id: string
    headline: string
    photo_url: any
    present_raw_address: string
    linkedin_uid: any
    extrapolated_email_confidence: any
    salesforce_id: any
    salesforce_lead_id: any
    salesforce_contact_id: any
    salesforce_account_id: any
    crm_owner_id: any
    created_at: string
    emailer_campaign_ids: any[]
    direct_dial_status: any
    direct_dial_enrichment_failed_at: any
    email_status: string
    email_source: any
    account_id: string
    last_activity_date: any
    hubspot_vid: any
    hubspot_company_id: any
    crm_id: any
    sanitized_phone: string
    merged_crm_ids: any
    updated_at: string
    queued_for_crm_push: any
    suggested_from_rule_engine_config_id: any
    email_unsubscribed: any
    label_ids: any[]
    has_pending_email_arcgate_request: boolean
    has_email_arcgate_request: boolean
    existence_level: string
    email: string
    email_from_customer: boolean
    typed_custom_fields: TypedCustomFields
    custom_field_errors: any
    crm_record_url: any
    email_status_unavailable_reason: any
    email_true_status: string
    updated_email_true_status: boolean
    contact_rule_config_statuses: any[]
    source_display_name: string
    contact_emails: ContactEmail[]
    time_zone: string
    phone_numbers: PhoneNumber[]
    account_phone_note: any
    free_domain: boolean
    is_likely_to_engage: boolean
  }

  export type TypedCustomFields = any

  export interface ContactEmail {
    email: string
    email_md5: string
    email_sha256: string
    email_status: string
    email_source: any
    extrapolated_email_confidence: any
    position: number
    email_from_customer: any
    free_domain: boolean
  }

  export interface PhoneNumber {
    raw_number: string
    sanitized_number: string
    type: any
    position: number
    status: string
    dnc_status: any
    dnc_other_info: any
    dialer_flags?: DialerFlags
  }

  export interface DialerFlags {
    country_name: string
    country_enabled: boolean
    high_risk_calling_enabled: boolean
    potential_high_risk_number: boolean
  }

  export interface Organization {
    id: string
    name: string
    website_url: string
    blog_url: any
    angellist_url: any
    linkedin_url: string
    twitter_url: string
    facebook_url: string
    primary_phone: PrimaryPhone
    languages: any[]
    alexa_ranking: number
    phone: any
    linkedin_uid: string
    founded_year: number
    publicly_traded_symbol: any
    publicly_traded_exchange: any
    logo_url: string
    crunchbase_url: any
    primary_domain: string
    industry: string
    keywords: string[]
    estimated_num_employees: number
    industries: string[]
    secondary_industries: any[]
    snippets_loaded: boolean
    industry_tag_id: string
    industry_tag_hash: IndustryTagHash
    retail_location_count: number
    raw_address: string
    street_address: string
    city: string
    state: string
    postal_code: string
    country: string
    owned_by_organization_id: any
    seo_description: string
    short_description: string
    suborganizations: any[]
    num_suborganizations: number
    annual_revenue_printed: string
    annual_revenue: number
    total_funding: number
    total_funding_printed: string
    latest_funding_round_date: string
    latest_funding_stage: string
    funding_events: FundingEvent[]
    technology_names: string[]
    current_technologies: CurrentTechnology[]
    org_chart_root_people_ids: string[]
    org_chart_sector: string
    org_chart_removed: boolean
    org_chart_show_department_filter: boolean
  }

  export type PrimaryPhone = any

  export interface IndustryTagHash {
    'information technology & services': string
  }

  export interface FundingEvent {
    id: string
    date: string
    news_url?: string
    type: string
    investors: string
    amount: string
    currency: string
  }

  export interface CurrentTechnology {
    uid: string
    name: string
    category: string
  }
}

/**
 * Apollo.io is a B2B person and company enrichment API.
 *
 * @see https://docs.apollo.io
 */
export class ApolloClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('APOLLO_API_KEY'),
    apiBaseUrl = apollo.API_BASE_URL,
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      `ApolloClient missing required "apiKey" (defaults to "APOLLO_API_KEY")`
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, apollo.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        'x-api-key': apiKey
      }
    })
  }

  /**
   * Attempts to enrich a person with Apollo data.
   *
   * Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a 200 response, but the response will indicate that no records have been enriched.
   *
   * By default, this endpoint does not return personal emails or phone numbers. Use the reveal_personal_emails and reveal_phone_number parameters to retrieve emails and phone numbers.
   */
  @aiFunction({
    name: 'apollo_enrich_person',
    description: `Attempts to enrich a person with Apollo data.

Apollo relies on the information you pass via the endpoint's parameters to identify the correct person to enrich. If you provide more information about a person, Apollo is more likely to find a match within its database. If you only provide general information, such as a name without a domain or email address, you might receive a 200 response, but the response will indicate that no records have been enriched.

By default, this endpoint does not return personal emails or phone numbers. Use the reveal_personal_emails and reveal_phone_number parameters to retrieve emails and phone numbers.`,
    inputSchema: z.object({
      first_name: z.string().optional(),
      last_name: z.string().optional(),
      name: z.string().optional(),
      email: z.string().optional(),
      hashed_email: z.string().optional(),
      organization_name: z.string().optional(),
      domain: z.string().optional(),
      id: z.string().optional(),
      linkedin_url: z.string().optional(),
      reveal_personal_emails: z.boolean().optional(),
      reveal_phone_number: z.boolean().optional(),
      webhook_url: z.string().optional()
    })
  })
  async enrichPerson(opts: apollo.EnrichPersonOptions) {
    return this.ky
      .post('api/v1/people/match', { json: opts })
      .json<apollo.EnrichPersonResponse>()
  }
}


================================================
FILE: legacy/packages/apollo/src/index.ts
================================================
export * from './apollo-client'


================================================
FILE: legacy/packages/apollo/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/arxiv/package.json
================================================
{
  "name": "@agentic/arxiv",
  "version": "7.6.9",
  "description": "Agentic SDK for Arxiv.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/arxiv"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "fast-xml-parser": "catalog:",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/arxiv/src/arxiv-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  pruneEmpty,
  sanitizeSearchParams
} from '@agentic/core'
import { XMLParser } from 'fast-xml-parser'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

import { castArray, getProp } from './utils'

export namespace arxiv {
  export const API_BASE_URL = 'https://export.arxiv.org/api'

  export const SortType = {
    RELEVANCE: 'relevance',
    LAST_UPDATED_DATE: 'lastUpdatedDate',
    SUBMITTED_DATE: 'submittedDate'
  } as const

  export const SortOrder = {
    ASCENDING: 'ascending',
    DESCENDING: 'descending'
  } as const

  export const FilterType = {
    ALL: 'all',
    TITLE: 'title',
    AUTHOR: 'author',
    ABSTRACT: 'abstract',
    COMMENT: 'comment',
    JOURNAL_REFERENCE: 'journal_reference',
    SUBJECT_CATEGORY: 'subject_category',
    REPORT_NUMBER: 'report_number'
  } as const

  export type ValueOf<T extends NonNullable<unknown>> = T[keyof T]
  export const FilterTypeMapping: Record<ValueOf<typeof FilterType>, string> = {
    all: 'all',
    title: 'ti',
    author: 'au',
    abstract: 'abs',
    comment: 'co',
    journal_reference: 'jr',
    subject_category: 'cat',
    report_number: 'rn'
  }

  export const Separators = {
    AND: '+AND+',
    OR: '+OR+',
    ANDNOT: '+ANDNOT+'
  } as const

  export interface ArXivResponse {
    totalResults: number
    startIndex: number
    itemsPerPage: number
    entries: {
      id: string
      title: string
      summary: string
      published: string
      updated: string
      authors: { name: string; affiliation: string[] }[]
      doi: string
      comment: string
      journalReference: string
      primaryCategory: string
      categories: string[]
      links: string[]
    }[]
  }

  export const extractId = (value: string) =>
    value
      .replace('https://arxiv.org/abs/', '')
      .replace('https://arxiv.org/pdf/', '')
      .replace(/v\d$/, '')

  const EntrySchema = z.object({
    field: z.nativeEnum(FilterType).default(FilterType.ALL),
    value: z.string().min(1)
  })

  export const SearchParamsSchema = z
    .object({
      ids: z.array(z.string().min(1)).optional(),
      searchQuery: z
        .union([
          z.string(),
          z.object({
            include: z
              .array(EntrySchema)
              .nonempty()
              .describe('Filters to include results.'),
            exclude: z
              .array(EntrySchema)
              .optional()
              .describe('Filters to exclude results.')
          })
        ])
        .optional(),
      start: z.number().int().min(0).default(0),
      maxResults: z.number().int().min(1).max(100).default(5)
    })
    .describe('Sorting by date is not supported.')
  export type SearchParams = z.infer<typeof SearchParamsSchema>
}

/**
 * Lightweight wrapper around ArXiv for academic / scholarly research articles.
 *
 * @see https://arxiv.org
 */
export class ArXivClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = arxiv.API_BASE_URL,
    ky = defaultKy
  }: {
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl
    })
  }

  /**
   * Searches for research articles published on arXiv.
   */
  @aiFunction({
    name: 'arxiv_search',
    description: 'Searches for research articles published on arXiv.',
    inputSchema: arxiv.SearchParamsSchema
  })
  async search(queryOrOpts: string | arxiv.SearchParams) {
    const opts =
      typeof queryOrOpts === 'string'
        ? ({ searchQuery: queryOrOpts } as arxiv.SearchParams)
        : queryOrOpts

    if (!opts.ids?.length && !opts.searchQuery) {
      throw new Error(
        `The 'searchQuery' property must be non-empty if the 'ids' property is not provided.`
      )
    }

    const searchParams = sanitizeSearchParams({
      start: opts.start,
      max_results: opts.maxResults,
      id_list: opts.ids?.map(arxiv.extractId),
      search_query: opts.searchQuery
        ? typeof opts.searchQuery === 'string'
          ? opts.searchQuery
          : [
              opts.searchQuery.include
                .map(
                  (tag) => `${arxiv.FilterTypeMapping[tag.field]}:${tag.value}`
                )
                .join(arxiv.Separators.AND),
              (opts.searchQuery.exclude ?? [])
                .map(
                  (tag) => `${arxiv.FilterTypeMapping[tag.field]}:${tag.value}`
                )
                .join(arxiv.Separators.ANDNOT)
            ]
              .filter(Boolean)
              .join(arxiv.Separators.ANDNOT)
        : undefined,
      sortBy: arxiv.SortType.RELEVANCE,
      sortOrder: arxiv.SortOrder.DESCENDING
    })

    const responseText = await this.ky.get('query', { searchParams }).text()

    const parser = new XMLParser({
      allowBooleanAttributes: true,
      alwaysCreateTextNode: false,
      attributeNamePrefix: '@_',
      attributesGroupName: false,
      cdataPropName: '#cdata',
      ignoreAttributes: true,
      numberParseOptions: { hex: false, leadingZeros: true },
      parseAttributeValue: false,
      parseTagValue: true,
      preserveOrder: false,
      removeNSPrefix: true,
      textNodeName: '#text',
      trimValues: true,
      ignoreDeclaration: true
    })

    const parsedData = parser.parse(responseText)

    let entries: Record<string, any>[] = getProp(
      parsedData,
      ['feed', 'entry'],
      []
    )
    entries = castArray(entries)

    return {
      totalResults: Math.max(
        getProp(parsedData, ['feed', 'totalResults'], 0),
        entries.length
      ),
      startIndex: getProp(parsedData, ['feed', 'startIndex'], 0),
      itemsPerPage: getProp(parsedData, ['feed', 'itemsPerPage'], 0),
      entries: entries.map((entry) =>
        pruneEmpty({
          id: arxiv.extractId(entry.id),
          url: entry.id,
          title: entry.title,
          summary: entry.summary,
          published: entry.published,
          updated: entry.updated,
          authors: castArray(entry.author)
            .filter(Boolean)
            .map((author: any) => ({
              name: author.name,
              affiliation: castArray(author.affiliation ?? [])
            })),
          doi: entry.doi,
          comment: entry.comment,
          journalReference: entry.journal_ref,
          primaryCategory: entry.primary_category,
          categories: castArray(entry.category).filter(Boolean),
          links: castArray(entry.link).filter(Boolean)
        })
      )
    }
  }
}


================================================
FILE: legacy/packages/arxiv/src/index.ts
================================================
export * from './arxiv-client'


================================================
FILE: legacy/packages/arxiv/src/utils.ts
================================================
export function hasProp<T>(
  target: T | undefined,
  key: keyof T
): key is keyof T {
  return Boolean(target) && Object.prototype.hasOwnProperty.call(target, key)
}

export function getProp(
  target: unknown,
  paths: readonly (keyof any)[],
  defaultValue: any = undefined
) {
  let value: any = target
  if (!value) {
    return undefined
  }

  for (const key of paths) {
    if (!hasProp(value, key)) {
      return defaultValue
    }
    value = value[key]
  }
  return value
}

export function castArray<T>(arr: T) {
  const result = Array.isArray(arr) ? arr : [arr]
  return result as T extends unknown[] ? T : [T]
}


================================================
FILE: legacy/packages/arxiv/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/bing/package.json
================================================
{
  "name": "@agentic/bing",
  "version": "7.6.9",
  "description": "Agentic SDK for Bing search.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/bing"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/bing/src/bing-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  omit
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace bing {
  export const API_BASE_URL = 'https://api.bing.microsoft.com'

  export interface SearchQuery {
    q: string
    mkt?: string
    offset?: number
    count?: number
    safeSearch?: 'Off' | 'Moderate' | 'Strict'
    textDecorations?: boolean
    textFormat?: 'Raw' | 'HTML'
  }

  export interface SearchResponse {
    _type: string
    entities: Entities
    images: Images
    places: Places
    queryContext: QueryContext
    rankingResponse: RankingResponse
    relatedSearches: RelatedSearches
    videos: Videos
    webPages: WebPages
  }

  interface Entities {
    value: EntitiesValue[]
  }

  interface EntitiesValue {
    bingId: string
    contractualRules: PurpleContractualRule[]
    description: string
    entityPresentationInfo: EntityPresentationInfo
    id: string
    image: Image
    name: string
    webSearchUrl: string
  }

  interface PurpleContractualRule {
    _type: string
    license?: DeepLink
    licenseNotice?: string
    mustBeCloseToContent: boolean
    targetPropertyName: string
    text?: string
    url?: string
  }

  interface DeepLink {
    name: string
    url: string
  }

  interface EntityPresentationInfo {
    entityScenario: string
    entityTypeHints: string[]
  }

  interface Image {
    height: number
    hostPageUrl: string
    name: string
    provider: Provider[]
    sourceHeight: number
    sourceWidth: number
    thumbnailUrl: string
    width: number
  }

  interface Provider {
    _type: string
    url: string
  }

  interface Images {
    id: string
    isFamilyFriendly: boolean
    readLink: string
    value: ImagesValue[]
    webSearchUrl: string
  }

  interface ImagesValue {
    contentSize: string
    contentUrl: string
    encodingFormat: string
    height: number
    hostPageDisplayUrl: string
    hostPageUrl: string
    name: string
    thumbnail: Thumbnail
    thumbnailUrl: string
    webSearchUrl: string
    width: number
  }

  interface Thumbnail {
    height: number
    width: number
  }

  interface Places {
    value: PlacesValue[]
  }

  interface PlacesValue {
    _type: string
    address: Address
    entityPresentationInfo: EntityPresentationInfo
    id: string
    name: string
    telephone: string
    url: string
    webSearchUrl: string
  }

  interface Address {
    addressCountry: string
    addressLocality: string
    addressRegion: string
    neighborhood: string
    postalCode: string
  }

  interface QueryContext {
    askUserForLocation: boolean
    originalQuery: string
  }

  interface RankingResponse {
    mainline: Mainline
    sidebar: Mainline
  }

  interface Mainline {
    items: Item[]
  }

  interface Item {
    answerType: string
    resultIndex?: number
    value?: ItemValue
  }

  interface ItemValue {
    id: string
  }

  interface RelatedSearches {
    id: string
    value: RelatedSearchesValue[]
  }

  interface RelatedSearchesValue {
    displayText: string
    text: string
    webSearchUrl: string
  }

  interface Videos {
    id: string
    isFamilyFriendly: boolean
    readLink: string
    scenario: string
    value: VideosValue[]
    webSearchUrl: string
  }

  interface VideosValue {
    allowHttpsEmbed: boolean
    allowMobileEmbed: boolean
    contentUrl: string
    creator: Creator
    datePublished: Date
    description: string
    duration: string
    embedHtml: string
    encodingFormat: EncodingFormat
    height: number
    hostPageDisplayUrl: string
    hostPageUrl: string
    isAccessibleForFree: boolean
    isSuperfresh: boolean
    motionThumbnailUrl: string
    name: string
    publisher: Creator[]
    thumbnail: Thumbnail
    thumbnailUrl: string
    viewCount: number
    webSearchUrl: string
    width: number
  }

  interface Creator {
    name: string
  }

  enum EncodingFormat {
    Mp4 = 'mp4'
  }

  interface WebPages {
    totalEstimatedMatches: number
    value: WebPagesValue[]
    webSearchUrl: string
  }

  interface WebPagesValue {
    dateLastCrawled: Date
    deepLinks?: DeepLink[]
    displayUrl: string
    id: string
    isFamilyFriendly: boolean
    isNavigational: boolean
    language: string
    name: string
    snippet: string
    thumbnailUrl?: string
    url: string
    contractualRules?: FluffyContractualRule[]
  }

  interface FluffyContractualRule {
    _type: string
    license: DeepLink
    licenseNotice: string
    mustBeCloseToContent: boolean
    targetPropertyIndex: number
    targetPropertyName: string
  }
}

/**
 * Bing web search client.
 *
 * @see https://www.microsoft.com/en-us/bing/apis/bing-web-search-api
 */
export class BingClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('BING_API_KEY'),
    apiBaseUrl = bing.API_BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'BingClient missing required "apiKey" (defaults to "BING_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl
    })
  }

  /**
   * Searches the web using the Bing search engine to return the most relevant web pages for a given query. Can also be used to find up-to-date news and information about many topics.
   */
  @aiFunction({
    name: 'bing_web_search',
    description:
      'Searches the web using the Bing search engine to return the most relevant web pages for a given query. Can also be used to find up-to-date news and information about many topics.',
    inputSchema: z.object({
      q: z.string().describe('search query')
    })
  })
  async search(queryOrOpts: string | bing.SearchQuery) {
    const defaultQuery: Partial<bing.SearchQuery> = {
      mkt: 'en-US'
    }

    const searchParams =
      typeof queryOrOpts === 'string'
        ? {
            ...defaultQuery,
            q: queryOrOpts
          }
        : {
            ...defaultQuery,
            ...queryOrOpts
          }

    // console.log(searchParams)
    const res = await this.ky
      .get('v7.0/search', {
        headers: {
          'Ocp-Apim-Subscription-Key': this.apiKey
        },
        searchParams
      })
      .json<bing.SearchResponse>()

    return omit(res, 'rankingResponse')
  }
}


================================================
FILE: legacy/packages/bing/src/index.ts
================================================
export * from './bing-client'


================================================
FILE: legacy/packages/bing/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/brave-search/package.json
================================================
{
  "name": "@agentic/brave-search",
  "version": "7.6.9",
  "description": "Agentic SDK for the Brave search engine.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/brave-search"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/brave-search/src/brave-search-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { bravesearch } from './brave-search'

/**
 * Agentic client for the Brave search engine.
 *
 * @see https://brave.com/search/api
 */
export class BraveSearchClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('BRAVE_SEARCH_API_KEY'),
    apiBaseUrl = bravesearch.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'BraveSearchClient missing required "apiKey" (defaults to "BRAVE_SEARCH_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        'X-Subscription-Token': apiKey
      }
    })
  }

  /**
   * Brave web search.
   */
  @aiFunction({
    name: 'brave_search',
    description:
      'Performs a web search using the Brave Search API, ideal for general queries, news, articles, and online content. ' +
      'Use this for broad information gathering, recent events, or when you need diverse web sources. ' +
      'Supports pagination, content filtering, and freshness controls. ' +
      'Maximum 20 results per request, with offset for pagination. ',
    inputSchema: bravesearch.SearchParamsSchema
  })
  async search(
    queryOrParams: string | bravesearch.SearchParams
  ): Promise<bravesearch.SearchResponse> {
    const { query: q, ...params } =
      typeof queryOrParams === 'string'
        ? { query: queryOrParams }
        : queryOrParams

    return this.ky
      .get('res/v1/web/search', {
        searchParams: sanitizeSearchParams({
          ...params,
          q
        })
      })
      .json<bravesearch.SearchResponse>()
  }

  /**
   * Brave local search for businesses and places.
   */
  @aiFunction({
    name: 'brave_local_search',
    description:
      "Searches for local businesses and places using Brave's Local Search API. " +
      'Best for queries related to physical locations, businesses, restaurants, services, etc. ' +
      'Returns detailed information including:\n' +
      '- Business names and addresses\n' +
      '- Ratings and review counts\n' +
      '- Phone numbers and opening hours\n' +
      "Use this when the query implies 'near me' or mentions specific locations. " +
      'Automatically falls back to web search if no local results are found.',
    inputSchema: bravesearch.LocalSearchParamsSchema
  })
  async localSearch(
    queryOrParams: string | bravesearch.LocalSearchParams
  ): Promise<bravesearch.LocalSearchResponse | bravesearch.SearchResponse> {
    const { query: q, ...params } =
      typeof queryOrParams === 'string'
        ? { query: queryOrParams }
        : queryOrParams

    const webData = await this.ky
      .get('res/v1/web/search', {
        searchParams: sanitizeSearchParams({
          search_lang: 'en',
          result_filter: 'locations',
          ...params,
          q
        })
      })
      .json<bravesearch.SearchResponse>()

    const locationIds = webData.locations?.results
      ?.filter((r) => !!r.id)
      .map((r) => r.id)

    if (!locationIds?.length) {
      return this.search(queryOrParams)
    }

    // Get POI details and descriptions in parallel
    const [pois, descriptions] = await Promise.all([
      this.getPoisData(locationIds),
      this.getDescriptionsData(locationIds)
    ])

    const desc = descriptions.descriptions

    return Object.entries(desc).map(([id, description]) => ({
      description,
      ...pois.results.find((r) => r.id === id)!
    }))
  }

  async getPoisData(ids: string[]): Promise<bravesearch.PoiResponse> {
    return this.ky
      .get('res/v1/local/pois', {
        searchParams: sanitizeSearchParams({
          ids: ids.filter(Boolean)
        })
      })
      .json<bravesearch.PoiResponse>()
  }

  async getDescriptionsData(ids: string[]): Promise<bravesearch.Description> {
    return this.ky
      .get('res/v1/local/descriptions', {
        searchParams: sanitizeSearchParams({
          ids: ids.filter(Boolean)
        })
      })
      .json<bravesearch.Description>()
  }
}


================================================
FILE: legacy/packages/brave-search/src/brave-search.ts
================================================
import { z } from 'zod'

export namespace bravesearch {
  export const apiBaseUrl = 'https://api.search.brave.com'

  export const SearchParamsSchema = z.object({
    query: z
      .string()
      .describe('Search query (max 400 chars, 50 words)')
      .optional(),
    count: z
      .number()
      .int()
      .min(1)
      .max(20)
      .describe('Number of results (1-20, default 10)')
      .optional(),
    offset: z
      .number()
      .describe('Pagination offset (max 9, default 0)')
      .optional()
  })
  export type SearchParams = z.infer<typeof SearchParamsSchema>

  export const LocalSearchParamsSchema = z.object({
    query: z
      .string()
      .describe('Search query (max 400 chars, 50 words)')
      .optional(),
    count: z
      .number()
      .describe('Number of results (1-20, default 10)')
      .int()
      .min(1)
      .max(20)
      .optional()
  })
  export type LocalSearchParams = z.infer<typeof LocalSearchParamsSchema>

  export interface SearchResponse {
    web?: {
      results?: Array<{
        title: string
        description: string
        url: string
        language?: string
        published?: string
        rank?: number
      }>
    }
    locations?: {
      results?: Array<{
        id: string // Required by API
        title?: string
      }>
    }
  }

  export interface Location {
    id: string
    name: string
    address: {
      streetAddress?: string
      addressLocality?: string
      addressRegion?: string
      postalCode?: string
    }
    coordinates?: {
      latitude: number
      longitude: number
    }
    phone?: string
    rating?: {
      ratingValue?: number
      ratingCount?: number
    }
    openingHours?: string[]
    priceRange?: string
  }

  export interface PoiResponse {
    results: Location[]
  }

  export interface Description {
    descriptions: { [id: string]: string }
  }

  export type LocalSearchResponse = Array<Location & { description: string }>
}


================================================
FILE: legacy/packages/brave-search/src/index.ts
================================================
export * from './brave-search'
export * from './brave-search-client'


================================================
FILE: legacy/packages/brave-search/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/calculator/package.json
================================================
{
  "name": "@agentic/calculator",
  "version": "7.6.9",
  "description": "Agentic calculator tool wrapping mathjs.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/calculator"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "mathjs": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/calculator/src/calculator.ts
================================================
import { createAIFunction } from '@agentic/core'
import { evaluate } from 'mathjs'
import { z } from 'zod'

// TODO: ensure `expr` is sanitized to not run arbitrary code

export const CalculatorInputSchema = z.object({
  expr: z.string().describe('mathematical expression to evaluate')
})
export type CalculatorInput = z.infer<typeof CalculatorInputSchema>

export const calculator = createAIFunction(
  {
    name: 'calculator',
    description:
      'Computes the result of simple mathematical expressions. Handles basic arithmetic operations like addition, subtraction, multiplication, division, exponentiation, and common functions like sin, cos, abs, exp, and random. Example expressions: "1.2 * (2 + 4.5)", "12.7 cm to inch", "sin(45 deg) ^ 2"',
    inputSchema: CalculatorInputSchema
  },
  async (input: CalculatorInput) => {
    const result: number = evaluate(input.expr)
    return result
  }
)


================================================
FILE: legacy/packages/calculator/src/index.ts
================================================
export * from './calculator'


================================================
FILE: legacy/packages/calculator/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/clearbit/package.json
================================================
{
  "name": "@agentic/clearbit",
  "version": "7.6.9",
  "description": "Agentic SDK for Clearbit.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/clearbit"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/clearbit/src/clearbit-client.ts
================================================
import {
  assert,
  delay,
  getEnv,
  pruneNullOrUndefinedDeep,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'

export namespace clearbit {
  // Allow up to 600 requests per minute by default.
  // (10 requests per second)
  export const throttle = pThrottle({
    limit: 10,
    interval: 1000
  })

  export const MAX_PAGE_SIZE = 100

  export interface CompanyEnrichmentOptions {
    domain: string
    webhook_url?: string
    company_name?: string
    linkedin?: string
    twitter?: string
    facebook?: string
  }

  export type CompanyNullableProps = {
    name: string
    legalName: string
    domain: string
    domainAliases: string[]
    site: {
      phoneNumbers: string[]
      emailAddresses: string[]
    }
    category: Partial<{
      sector: string
      industryGroup: string
      industry: string
      subIndustry: string
      gicsCode: string
      sicCode: string
      sic4Codes: string[]
      naicsCode: string
      naics6Codes: string[]
      naics6Codes2022: string[]
    }>
    tags: string[]
    description: string
    foundedYear: number
    location: string
    timeZone: string
    utcOffset: number
    geo: Partial<{
      streetNumber: string
      streetName: string
      subPremise: string
      streetAddress: string
      city: string
      postalCode: string
      state: string
      stateCode: string
      country: string
      countryCode: string
      lat: number
      lng: number
    }>
    logo: string
    facebook: Partial<{
      handle: string
      likes: number
    }>
    linkedin: {
      handle: string
    }
    twitter: Partial<{
      handle: string
      id: string
      bio: string
      followers: number
      following: number
      location: string
      site: string
      avatar: string
    }>
    crunchbase: {
      handle: string
    }
    emailProvider: boolean
    type: string
    ticker: string
    identifiers: Partial<{
      usEIN: string
      usCIK: string
    }>
    phone: string
    metrics: Partial<{
      alexaUsRank: number
      alexaGlobalRank: number
      trafficRank: string
      employees: number
      employeesRange: string
      marketCap: number
      raised: number
      annualRevenue: string
      estimatedAnnualRevenue: string
      fiscalYearEnd: number
    }>
    indexedAt: string
    tech: string[]
    techCategories: string[]
    parent: {
      domain: string
    }
    ultimateParent: {
      domain: string
    }
  }

  export type EmailLookupResponse = Partial<{
    id: string
    name: Partial<Name>
    email: string
    location: string
    timeZone: string
    utcOffset: number
    geo: Partial<GeoIP>
    bio: string
    site: string
    avatar: string
    employment: Partial<EmploymentAttributes>
    facebook: {
      handle: string
    }
    github: Partial<{
      handle: string
      id: string
      avatar: string
      company: string
      blog: string
      followers: number
      following: number
    }>
    twitter: Partial<{
      handle: string
      id: string
      bio: string
      followers: number
      following: number
      statuses: number
      favorites: number
      location: string
      site: string
      avatar: string
    }>
    linkedin: {
      handle: string
    }
    googleplus: {
      handle: null
    }
    gravatar: Partial<{
      handle: string
      urls: {
        value: string
        title: string
      }[]
      avatar: string
      avatars: {
        url: string
        type: string
      }[]
    }>
    fuzzy: boolean
    emailProvider: boolean
    indexedAt: string
    phone: string
    activeAt: string
    inactiveAt: string
  }>

  export type CompanyResponse = {
    id: string
  } & Partial<CompanyNullableProps>

  export interface CompanySearchOptions {
    /**
     * See clearbit docs: https://dashboard.clearbit.com/docs?shell#discovery-api-tech-queries
     * Examples:
     * tech:google_apps
     * or:(twitter_followers:10000~ type:nonprofit)
     */
    query: string
    page?: number
    page_size?: number
    limit?: number
    sort?: string
  }

  export interface CompanySearchResponse {
    total: number
    page: number
    results: CompanyResponse[]
  }

  export interface BasicCompanyResponse {
    domain: string
    logo: string
    name: string
  }

  export interface PeopleSearchOptionsV2 {
    domains?: string[]
    names?: string[]
    roles?: string[]
    seniorities?: string[]
    titles?: string[]
    locations?: string[]
    employees_ranges?: string[]
    company_tags?: string[]
    company_tech?: string[]
    company_types?: string[]
    industries?: string[]
    revenue_ranges?: string[]
    linkedin_profile_handles?: string[]
    page?: number
    page_size?: number
    suppression?: string
  }

  // Prospector types
  export interface ProspectorResponseV2 {
    page: number
    page_size: number
    total: number
    results: PersonAttributesV2[]
  }

  export interface EmploymentAttributes {
    company?: string
    domain?: string
    linkedin?: string
    title?: string
    role?: string
    subRole?: string
    seniority?: string
    startDate?: string
    endDate?: string
    present?: boolean
    location?: string
    email?: string
    highlight?: boolean
  }

  export interface EmailAttributes {
    address: string
    type: string
  }

  export interface PhoneAttributes {
    number: string
    type: string
  }

  interface Name {
    givenName: string
    familyName: string
    fullName: string
  }

  export type PersonAttributesV2 = {
    id: string
  } & Partial<{
    name: Name
    avatar: string
    location: string
    linkedin: string
    employments: EmploymentAttributes[]
    emails: EmailAttributes[]
    phones: PhoneAttributes[]
  }>

  export type PeopleSearchOptionsV1 = {
    domain: string
    role?: string
    roles?: string[]
    seniority?: string
    seniorities?: string[]
    title?: string
    titles?: string[]
    city?: string
    cities?: string[]
    state?: string
    states?: string[]
    country?: string
    countries?: string[]
    name?: string
    query?: string
    page?: number
    page_size?: number
    suppression?: string
    email?: boolean
  }

  export interface Company {
    name: string
  }

  export interface PeopleSearchResponseV1 {
    id: string
    name: Name
    title: string
    role: string
    subRole: string
    seniority: string
    company: Company
    email: string
    verified: boolean
    phone: string
  }

  export interface ProspectorResponseV1 {
    page: number
    page_size: number
    total: number
    results: PeopleSearchResponseV1[]
  }

  export interface GeoIP {
    city: string
    state: string
    stateCode: string
    country: string
    countryCode: string
    lat?: number
    lng?: number
  }

  export interface CompanyRevealResponse {
    ip: string
    fuzzy: boolean
    domain: string
    type: string
    company?: CompanyResponse
    geoIP: GeoIP
    confidenceScore: 'very_high' | 'high' | 'medium' | 'low'
    role: string
    seniority: string
  }

  export const PersonRoles = [
    'communications',
    'customer_service',
    'education',
    'engineering',
    'finance',
    'health_professional',
    'human_resources',
    'information_technology',
    'leadership',
    'legal',
    'marketing',
    'operations',
    'product',
    'public_relations',
    'real_estate',
    'recruiting',
    'research',
    'sales'
  ]

  export const SenioritiesV2 = [
    'Executive',
    'VP',
    'Owner',
    'Partner',
    'Director',
    'Manager',
    'Senior',
    'Entry'
  ]

  export const Seniorities = ['executive', 'director', 'manager']

  export const SubIndustries = [
    'Automotive',
    'Consumer Discretionary',
    'Consumer Goods',
    'Consumer Electronics',
    'Household Appliances',
    'Photography',
    'Sporting Goods',
    'Apparel, Accessories & Luxury Goods',
    'Textiles',
    'Textiles, Apparel & Luxury Goods',
    'Consumer Services',
    'Education Services',
    'Specialized Consumer Services',
    'Casinos & Gaming',
    'Hotels, Restaurants & Leisure',
    'Leisure Facilities',
    'Restaurants',
    'Education',
    'Family Services',
    'Legal Services',
    'Advertising',
    'Broadcasting',
    'Media',
    'Movies & Entertainment',
    'Public Relations',
    'Publishing',
    'Distributors',
    'Retailing',
    'Home Improvement Retail',
    'Homefurnishing Retail',
    'Specialty Retail',
    'Consumer Staples',
    'Food Retail',
    'Beverages',
    'Agricultural Products',
    'Food',
    'Food Production',
    'Packaged Foods & Meats',
    'Tobacco',
    'Cosmetics',
    'Oil & Gas',
    'Banking & Mortgages',
    'Accounting',
    'Finance',
    'Financial Services',
    'Asset Management & Custody Banks',
    'Diversified Capital Markets',
    'Fundraising',
    'Investment Banking & Brokerage',
    'Payments',
    'Insurance',
    'Real Estate',
    'Eyewear',
    'Health & Wellness',
    'Health Care',
    'Health Care Services',
    'Biotechnology',
    'Life Sciences Tools & Services',
    'Pharmaceuticals',
    'Aerospace & Defense',
    'Capital Goods',
    'Civil Engineering',
    'Construction',
    'Construction & Engineering',
    'Mechanical Engineering',
    'Electrical',
    'Electrical Equipment',
    'Industrials & Manufacturing',
    'Industrial Machinery',
    'Machinery',
    'Trading Companies & Distributors',
    'Business Supplies',
    'Commercial Printing',
    'Corporate & Business',
    'Architecture',
    'Automation',
    'Consulting',
    'Design',
    'Human Resource & Employment Services',
    'Professional Services',
    'Research & Consulting Services',
    'Industrials',
    'Shipping & Logistics',
    'Airlines',
    'Marine',
    'Ground Transportation',
    'Transportation',
    'Semiconductors',
    'Cloud Services',
    'Internet',
    'Internet Software & Services',
    'Data Processing & Outsourced Services',
    'Graphic Design',
    'Communications',
    'Computer Networking',
    'Nanotechnology',
    'Computer Hardware',
    'Technology Hardware, Storage & Peripherals',
    'Building Materials',
    'Chemicals',
    'Commodity Chemicals',
    'Containers & Packaging',
    'Gold',
    'Metals & Mining',
    'Paper Products',
    'Integrated Telecommunication Services',
    'Wireless Telecommunication Services',
    'Renewable Energy',
    'Energy',
    'Utilities'
  ]
}

/**
 * The Clearbit API helps with resolving and enriching people and company data.
 *
 * @see https://dashboard.clearbit.com/docs
 */
export class ClearbitClient {
  protected readonly ky: KyInstance
  protected readonly apiKey: string

  constructor({
    apiKey = getEnv('CLEARBIT_API_KEY'),
    timeoutMs = 30_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'ClearbitClient missing required "apiKey" (defaults to "CLEARBIT_API_KEY")'
    )

    this.apiKey = apiKey

    const throttledKy = throttle ? throttleKy(ky, clearbit.throttle) : ky

    this.ky = throttledKy.extend({
      timeout: timeoutMs,
      headers: {
        // Authorization: `Basic ${Buffer.from(`${apiKey}:`).toString('base64')}`
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  async companyEnrichment(options: clearbit.CompanyEnrichmentOptions) {
    const res = await this.ky
      .get('https://company-stream.clearbit.com/v2/companies/find', {
        searchParams: sanitizeSearchParams(options)
      })
      .json<clearbit.CompanyResponse>()

    return pruneNullOrUndefinedDeep(res)
  }

  async companySearch(options: clearbit.CompanySearchOptions) {
    const res = await this.ky
      .get('https://discovery.clearbit.com/v1/companies/search', {
        searchParams: sanitizeSearchParams(options)
      })
      .json<clearbit.CompanySearchResponse>()

    return pruneNullOrUndefinedDeep(res)
  }

  async companyAutocomplete(name: string) {
    const res = await this.ky
      .get('https://autocomplete.clearbit.com/v1/companies/suggest', {
        searchParams: { query: name }
      })
      .json<clearbit.BasicCompanyResponse[]>()

    return pruneNullOrUndefinedDeep(res)
  }

  async prospectorPeopleV2(options: clearbit.PeopleSearchOptionsV2) {
    const res = await this.ky
      .get('https://prospector.clearbit.com/v2/people/search', {
        searchParams: sanitizeSearchParams({
          ...options,
          page_size: Math.min(
            clearbit.MAX_PAGE_SIZE,
            options.page_size || clearbit.MAX_PAGE_SIZE
          )
        })
      })
      .json<clearbit.ProspectorResponseV2>()

    return pruneNullOrUndefinedDeep(res)
  }

  async prospectorPeopleV1(options: clearbit.PeopleSearchOptionsV1) {
    const res = await this.ky
      .get('https://prospector.clearbit.com/v1/people/search', {
        searchParams: sanitizeSearchParams({
          email: false,
          ...options,
          page_size: Math.min(
            clearbit.MAX_PAGE_SIZE,
            options.page_size || clearbit.MAX_PAGE_SIZE
          )
        })
      })
      .json<clearbit.ProspectorResponseV1>()

    return pruneNullOrUndefinedDeep(res)
  }

  // TODO Status code = 202 means the response was queued.
  // Implement webhook when needed. The polling works well, in most cases we need
  // to try again once to get a 200 response.
  async emailLookup({
    email,
    maxRetries = 2
  }: {
    email: string
    maxRetries?: number
  }): Promise<clearbit.EmailLookupResponse> {
    const url = 'https://person.clearbit.com/v2/people/find'
    let response = await this.ky.get(url, {
      searchParams: { email }
    })

    if (response.status !== 202 || !maxRetries) {
      const res = await response.json<clearbit.EmailLookupResponse>()
      return pruneNullOrUndefinedDeep(res)
    }

    if (maxRetries && response.status === 202) {
      let count = 0
      let running = true
      while (running && count < maxRetries) {
        console.log(`Email Lookup was queued, retry ${count + 1}.`)
        await delay(1000)
        response = await this.ky.get(url, {
          searchParams: { email }
        })
        count++
        running = response.status === 202
      }
      const res = await response.json<clearbit.EmailLookupResponse>()
      return pruneNullOrUndefinedDeep(res)
    }

    throw new Error('clearbit email lookup error 202', { cause: response })
  }

  async nameToDomain(name: string) {
    return this.ky
      .get('https://company.clearbit.com/v1/domains/find', {
        searchParams: { name }
      })
      .json<clearbit.BasicCompanyResponse>()
      .catch((_) => undefined)
  }

  async revealCompanyFromIP(ip: string) {
    const res = await this.ky
      .get('https://reveal.clearbit.com/v1/companies/find', {
        searchParams: { ip }
      })
      .json<clearbit.CompanyRevealResponse>()
      .catch((_) => undefined)

    if (res) {
      return pruneNullOrUndefinedDeep(res)
    }
  }

  static filterEmploymentProspectorV2(
    companyName: string,
    employments?: Array<Partial<clearbit.EmploymentAttributes>>
  ) {
    if (employments && employments.length > 0) {
      // We filter by employment endDate because some people could have multiple
      // jobs at the same time.
      // Here we want to filter by people that actively works at a specific company.
      return employments
        .filter((item) => !item?.endDate)
        .some((item) =>
          item?.company?.toLowerCase().includes(companyName.toLowerCase())
        )
    }

    return false
  }
}


================================================
FILE: legacy/packages/clearbit/src/index.ts
================================================
export * from './clearbit-client'


================================================
FILE: legacy/packages/clearbit/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/diffbot/package.json
================================================
{
  "name": "@agentic/diffbot",
  "version": "7.6.9",
  "description": "Agentic SDK for Diffbot.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/diffbot"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/diffbot/src/diffbot-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace diffbot {
  export const API_BASE_URL = 'https://api.diffbot.com'
  export const KNOWLEDGE_GRAPH_API_BASE_URL = 'https://kg.diffbot.com'

  // Allow up to 5 requests per second by default.
  // https://docs.diffbot.com/reference/rate-limits
  export const throttle = pThrottle({
    limit: 5,
    interval: 1000,
    strict: true
  })

  export interface ExtractOptions {
    /** Specify optional fields to be returned from any fully-extracted pages, e.g.: &fields=querystring,links. See available fields within each API's individual documentation pages.
     * @see https://docs.diffbot.com/reference/extract-optional-fields
     */
    fields?: string[]

    /** (*Undocumented*) Pass paging=false to disable automatic concatenation of multiple-page articles. (By default, Diffbot will concatenate up to 20 pages of a single article.) */
    paging?: boolean

    /** Pass discussion=false to disable automatic extraction of comments or reviews from pages identified as articles or products. This will not affect pages identified as discussions. */
    discussion?: boolean

    /** Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000). */
    timeout?: number

    /** Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204) */
    proxy?: string

    /** Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password) */
    proxyAuth?: string

    /** `none` will instruct Extract to not use proxies, even if proxies have been enabled for this particular URL globally. */
    useProxy?: string

    /** @see https://docs.diffbot.com/reference/extract-custom-javascript */
    customJs?: string

    /** @see https://docs.diffbot.com/reference/extract-custom-headers */
    customHeaders?: Record<string, string>
  }

  export interface ExtractAnalyzeOptions extends ExtractOptions {
    /** URL of the web page to process */
    url: string

    /** By default the Analyze API will fully extract all pages that match an existing Automatic API -- articles, products or image pages. Set mode to a specific page-type (e.g., mode=article) to extract content only from that specific page-type. All other pages will simply return the default Analyze fields. */
    mode?: string

    /** Force any non-extracted pages (those with a type of "other") through a specific API. For example, to route all "other" pages through the Article API, pass &fallback=article. Pages that utilize this functionality will return a fallbackType field at the top-level of the response and a originalType field within each extracted object, both of which will indicate the fallback API used. */
    fallback?: string
  }

  export interface ExtractArticleOptions extends ExtractOptions {
    /** URL of the web page to process */
    url: string

    /** Set the maximum number of automatically-generated tags to return. By default a maximum of ten tags will be returned. */
    maxTags?: number

    /** Set the minimum relevance score of tags to return, between 0.0 and 1.0. By default only tags with a score equal to or above 0.5 will be returned. */
    tagConfidence?: number

    /** Used to request the output of the Diffbot Natural Language API in the field naturalLanguage. Example: &naturalLanguage=entities,facts,categories,sentiment. */
    naturalLanguage?: string[]
  }

  export interface ExtractResponse {
    request: DiffbotRequest
    objects: DiffbotObject[]
  }

  export type ExtractArticleResponse = ExtractResponse

  export interface ExtractAnalyzeResponse extends ExtractResponse {
    type: string
    title: string
    humanLanguage: string
  }

  export interface DiffbotObject {
    type: string
    title: string
    pageUrl: string
    diffbotUri: string
    description?: string
    date?: string
    sentiment?: number
    author?: string
    estimatedDate?: string
    publisherRegion?: string
    icon?: string
    siteName?: string
    publisherCountry?: string
    humanLanguage?: string
    authorUrl?: string
    html?: string
    text?: string
    images?: Image[]
    tags?: Tag[]
    categories?: ObjectCategory[]
    authors?: Author[]
    breadcrumb?: Breadcrumb[]
    items?: ListItem[]
    meta?: any
  }

  export interface ListItem {
    title: string
    link: string
    summary: string
    image?: string
  }

  export interface Author {
    name: string
    link: string
  }

  export interface ObjectCategory {
    score: number
    name: string
    id: string
  }

  export interface Breadcrumb {
    link: string
    name: string
  }

  export interface Image {
    url: string
    diffbotUri: string

    naturalWidth: number
    naturalHeight: number
    width: number
    height: number

    isCached?: boolean
    primary?: boolean
  }

  export interface Tag {
    score: number
    sentiment: number
    count: number
    label: string
    uri: string
    rdfTypes: string[]
  }

  export interface DiffbotRequest {
    pageUrl: string
    api: string
    version: number
  }

  export interface KnowledgeGraphSearchOptions {
    type?: 'query' | 'text' | 'queryTextFallback' | 'crawl'
    query: string
    col?: string
    from?: number
    size?: number

    // NOTE: we only support `json`, so these options are not needed
    // We can always convert from json to another format if needed.
    // format?: 'json' | 'jsonl' | 'csv' | 'xls' | 'xlsx'
    // exportspec?: string
    // exportseparator?: string
    // exportfile?: string

    filter?: string
    jsonmode?: 'extended' | 'id'
    nonCanonicalFacts?: boolean
    noDedupArticles?: boolean
    cluster?: 'all' | 'best' | 'dedupe'
    report?: boolean
  }

  export interface KnowledgeGraphEnhanceOptions {
    type: EntityType

    id?: string
    name?: string
    url?: string
    phone?: string
    email?: string
    employer?: string
    title?: string
    school?: string
    location?: string
    ip?: string
    customId?: string

    size?: number
    threshold?: number

    refresh?: boolean
    search?: boolean
    useCache?: boolean

    filter?: string
    jsonmode?: 'extended' | 'id'
    nonCanonicalFacts?: boolean
  }

  export interface KnowledgeGraphResponse {
    data: KnowledgeGraphNode[]
    version: number
    hits: number
    results: number
    kgversion: string
    diffbot_type: string
    facet?: boolean
    errors?: any[]
  }

  export interface KnowledgeGraphNode {
    score: number
    esscore?: number
    entity: KnowledgeGraphEntity
    entity_ctx: any
    errors: string[]
    callbackQuery: string
    upperBound: number
    lowerBound: number
    count: number
    value: string
    uri: string
  }

  export interface KnowledgeGraphEntity {
    id: string
    diffbotUri: string
    type?: string
    name: string
    images: Image[]
    origins: string[]
    nbOrigins?: number

    gender?: Gender
    githubUri?: string
    importance?: number
    description?: string
    homepageUri?: string
    allNames?: string[]
    skills?: Partial<BasicEntity>[]
    crawlTimestamp?: number
    summary?: string
    image?: string
    types?: string[]
    nbIncomingEdges?: number
    allUris?: string[]
    employments?: Employment[]
    locations?: Location[]
    location?: Location
    allOriginHashes?: string[]
    nameDetail?: NameDetail
  }

  export type EntityType = 'Organization' | 'Place'

  export const EnhanceEntityOptionsSchema = z.object({
    type: z.enum(['Person', 'Organization']),
    id: z
      .string()
      .optional()
      .describe('Diffbot ID of the entity to enhance if known'),
    name: z
      .union([z.string(), z.array(z.string())])
      .optional()
      .describe('Name of the entity'),
    url: z
      .union([z.string(), z.array(z.string())])
      .optional()
      .describe('Origin or homepage URL of the entity'),
    phone: z.string().optional().describe('Phone number of the entity'),
    email: z.string().optional().describe('Email of the entity'),
    employer: z
      .string()
      .optional()
      .describe("Name of the entity's employer (for Person entities)"),
    title: z
      .string()
      .optional()
      .describe('Title of the entity (for Person entities)'),
    school: z
      .string()
      .optional()
      .describe('School of the entity (for Person entities)'),
    location: z.string().optional().describe('Location of the entity'),
    ip: z.string().optional().describe('IP address of the entity'),
    customId: z.string().optional().describe('User-defined ID for correlation'),
    threshold: z.number().optional().describe('Similarity threshold'),
    refresh: z
      .boolean()
      .optional()
      .describe(
        'If set, will attempt to refresh the entity data by recrawling the source URLs.'
      ),
    search: z
      .boolean()
      .optional()
      .describe(
        'If set, will attempt to search the web for the entity and merge the results into its knowledge base.'
      ),
    size: z
      .number()
      .int()
      .max(100)
      .optional()
      .describe('Number of results to return')
  })
  export type EnhanceEntityOptions = z.infer<typeof EnhanceEntityOptionsSchema>

  export interface EnhanceEntityResponse {
    version: number
    hits: number
    kgversion: string
    request_ctx: RequestCtx
    data: EnhanceEntityResult[]
    errors: any[]
  }

  export interface RequestCtx {
    query: Query
    query_ctx: QueryCtx
  }

  export interface Query {
    type: string
    name: string[]
  }

  export interface QueryCtx {
    search: string
  }

  export interface EnhanceEntityResult {
    score: number
    esscore: number
    entity: Entity
    errors: any[]
  }

  export interface Entity {
    name: string
    type: EntityType
    id: string
    summary?: string
    description?: string
    homepageUri?: string
    twitterUri?: string
    linkedInUri?: string
    githubUri?: string
    crunchbaseUri?: string
    googlePlusUri?: string
    facebookUri?: string
    angellistUri?: string
    wikipediaUri?: string
    diffbotUri?: string
    origin?: string
    origins?: string[]
    allUris?: string[]

    // extra metadata
    nbOrigins?: number
    nbIncomingEdges?: number
    nbFollowers?: number
    nbLocations?: number
    nbEmployees?: number
    nbEmployeesMin?: number
    nbEmployeesMax?: number
    nbActiveEmployeeEdges?: number
    nbUniqueInvestors?: number
    educations?: Education[]
    nationalities?: Nationality[]
    fullName?: string
    allNames?: string[]
    skills?: Partial<BasicEntity>[]
    children?: BasicEntity[]
    height?: number
    image?: string
    images?: Image[]
    allOriginHashes?: string[]
    nameDetail?: NameDetail
    parents?: BasicEntity[]
    gender?: Gender
    importance?: number
    monthlyTraffic?: number
    monthlyTrafficGrowth?: number
    wikipediaPageviews?: number
    wikipediaPageviewsLastQuarterGrowth?: number
    wikipediaPageviewsLastYear?: number
    wikipediaPageviewsLastYearGrowth?: number
    wikipediaPageviewsLastQuarter?: number
    wikipediaPageviewsGrowth?: number
    birthPlace?: Location
    types?: string[]
    unions?: Union[]
    languages?: Language[]
    employments?: Employment[]
    birthDate?: DateTime
    religion?: Partial<BasicEntity>
    awards?: Award[]
    netWorth?: Amount
    allDescriptions?: string[]
    locations?: Location[]
    location?: Location
    interests?: Interest[]
    suppliers?: BasicEntity[]
    subsidiaries?: BasicEntity[]
    ipo?: {
      date: DateTime
      stockExchange: string
    }
    motto?: string
    logo?: string
    foundingDate?: DateTime
    totalInvestment?: Amount
    naicsClassification2017?: any[]
    naicsClassification?: any[]
    sicClassification?: any[]
    naceClassification?: any[]
    iSicClassification?: any[]
    employeeCategories?: any[]
    emailAddresses?: EmailAddress[]
    age?: number
    isPublic?: boolean
    isAcquired?: boolean
    isDissolved?: boolean
    isNonProfit?: boolean
    crawlTimestamp?: number
    founders?: BasicEntity[]
    boardMembers?: BasicEntity[]
    ceo?: BasicEntity
    investments?: Investment[]
    acquiredBy?: BasicEntity[]
    diffbotClassification?: any[]
    blogUri?: string
    descriptors?: string[]
    industries?: string[]
    partnerships?: BasicEntity[]
    categories?: Category[]
    customers?: BasicEntity[]
    technographics?: Technographic[]
    stock?: Stock
    companiesHouseIds?: string[]
    yearlyRevenues?: AnnualRevenue[]
    revenue?: Amount
    parentCompany?: BasicEntity
    legalEntities?: BasicEntity[]
  }

  export interface AnnualRevenue {
    revenue: Amount
    isCurrent: boolean
    year: number
    filingDate: DateTime
    revenueDate: DateTime
  }

  export interface Technographic {
    technology: Partial<BasicEntity>
    categories: string[]
  }

  export interface Category {
    level?: number
    isPrimary?: boolean
    name: string
    diffbotUri?: string
    targetDiffbotId?: string
    type?: string
  }

  export interface Investment {
    date: DateTime
    amount?: Amount
    isCurrent: boolean
    series: string
    investors: BasicEntity[]
  }

  export interface Amount {
    currency: string
    value: number
  }

  export interface EmailAddress {
    contactString: string
    type: string
  }

  export interface Education {
    institution: BasicEntity
    isCurrent?: boolean
    major?: BasicEntity
    degree?: BasicEntity
    from?: DateTime
    to?: DateTime
  }

  export interface DateTime {
    str: string
    precision: number
    timestamp: number
  }

  export interface Nationality {
    name: string
    type: string
  }

  export interface Image {
    url: string
    primary?: boolean
  }

  export interface NameDetail {
    firstName: string
    lastName: string
    middleName?: string[]
  }

  export interface Gender {
    normalizedValue: string
  }

  export interface Stock {
    symbol: string
    isCurrent: boolean
    exchange: string
  }

  export interface Union {
    person: BasicEntity
    from?: DateTime
    to?: DateTime
    type?: string
  }

  export interface BasicEntity {
    name: string
    summary: string
    type: string
    image?: string
    types?: string[]
    diffbotUri: string
    targetDiffbotId: string
  }

  export interface Language {
    str: string
    normalizedValue: string
  }

  export interface Employment {
    isCurrent?: boolean
    title?: string
    description?: string
    employer?: BasicEntity
    location?: Location
    categories?: Partial<BasicEntity>[]
    from?: DateTime
    to?: DateTime
  }

  export interface Location {
    isCurrent: boolean
    country?: BasicEntity
    address?: string
    city?: BasicEntity
    street?: string
    metroArea?: BasicEntity
    subregion?: BasicEntity
    surfaceForm?: string
    latitude?: number
    longitude?: number
    postalCode?: string
    region?: BasicEntity
    precision?: number
  }

  export interface Award {
    title: string
    date?: DateTime
  }

  export interface Interest {
    name: string
    type: string
  }
}

/**
 * Diffbot provides web page classification and scraping. It also provides
 * access to a knowledge graph with the ability to perform person and company
 * data enrichment.
 *
 * @see https://docs.diffbot.com
 */
export class DiffbotClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly kyKnowledgeGraph: KyInstance

  protected readonly apiKey: string
  protected readonly apiBaseUrl: string
  protected readonly apiKnowledgeGraphBaseUrl: string

  constructor({
    apiKey = getEnv('DIFFBOT_API_KEY'),
    apiBaseUrl = diffbot.API_BASE_URL,
    apiKnowledgeGraphBaseUrl = diffbot.KNOWLEDGE_GRAPH_API_BASE_URL,
    timeoutMs = 30_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    apiKnowledgeGraphBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      `DiffbotClient missing required "apiKey" (defaults to "DIFFBOT_API_KEY")`
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl
    this.apiKnowledgeGraphBaseUrl = apiKnowledgeGraphBaseUrl

    const throttledKy = throttle ? throttleKy(ky, diffbot.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs
    })

    this.kyKnowledgeGraph = throttledKy.extend({
      prefixUrl: apiKnowledgeGraphBaseUrl,
      timeout: timeoutMs
    })
  }

  /**
   * Scrapes and extracts structured data from a web page. Also classifies the web page as one of several types (article, product, discussion, job, image, video, list, event, or other).
   */
  @aiFunction({
    name: 'diffbot_analyze_url',
    description:
      'Scrapes and extracts structured data from a web page. Also classifies the web page as one of several types (article, product, discussion, job, image, video, list, event, or other).',
    inputSchema: z.object({
      url: z.string().url().describe('The URL to process.')
    })
  })
  async analyzeUrl(options: diffbot.ExtractAnalyzeOptions) {
    return this._extract<diffbot.ExtractAnalyzeResponse>('v3/analyze', options)
  }

  /**
   * Scrapes and extracts clean article text from news articles, blog posts, and other text-heavy web pages.
   */
  @aiFunction({
    name: 'diffbot_extract_article_from_url',
    description:
      'Scrapes and extracts clean article text from news articles, blog posts, and other text-heavy web pages.',
    inputSchema: z.object({
      url: z.string().url().describe('The URL to process.')
    })
  })
  async extractArticleFromUrl(options: diffbot.ExtractArticleOptions) {
    return this._extract<diffbot.ExtractArticleResponse>('v3/article', options)
  }

  /**
   * Resolves and enriches a partial person or organization entity.
   */
  @aiFunction({
    name: 'diffbot_enhance_entity',
    description:
      'Resolves and enriches a partial person or organization entity.',
    inputSchema: diffbot.EnhanceEntityOptionsSchema.omit({
      refresh: true,
      search: true,
      customId: true,
      threshold: true
    })
  })
  async enhanceEntity(
    opts: diffbot.EnhanceEntityOptions
  ): Promise<diffbot.EnhanceEntityResponse> {
    return this.kyKnowledgeGraph
      .get('kg/v3/enhance', {
        searchParams: sanitizeSearchParams({
          ...opts,
          token: this.apiKey
        })
      })
      .json<diffbot.EnhanceEntityResponse>()
  }

  async searchKnowledgeGraph(options: diffbot.KnowledgeGraphSearchOptions) {
    return this.kyKnowledgeGraph
      .get('kg/v3/dql', {
        searchParams: {
          ...options,
          token: this.apiKey
        }
      })
      .json<diffbot.KnowledgeGraphResponse>()
  }

  async enhanceKnowledgeGraph(options: diffbot.KnowledgeGraphEnhanceOptions) {
    return this.kyKnowledgeGraph
      .get('kg/v3/enhance', {
        searchParams: {
          ...options,
          token: this.apiKey
        }
      })
      .json<diffbot.KnowledgeGraphResponse>()
  }

  protected async _extract<
    T extends diffbot.ExtractResponse = diffbot.ExtractResponse
  >(endpoint: string, options: diffbot.ExtractOptions): Promise<T> {
    const { customJs, customHeaders, ...rest } = options
    const searchParams = sanitizeSearchParams({
      ...rest,
      token: this.apiKey
    })
    const headers = {
      ...Object.fromEntries(
        [['X-Forward-X-Evaluate', customJs]].filter(([, value]) => value)
      ),
      ...customHeaders
    }

    // console.log(`DiffbotClient._extract: ${endpoint}`, searchParams)

    return this.ky
      .get(endpoint, {
        searchParams,
        headers,
        retry: 1
      })
      .json<T>()
  }
}


================================================
FILE: legacy/packages/diffbot/src/index.ts
================================================
export * from './diffbot-client'


================================================
FILE: legacy/packages/diffbot/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/duck-duck-go/package.json
================================================
{
  "name": "@agentic/duck-duck-go",
  "version": "7.6.9",
  "description": "Agentic SDK for DuckDuckGo.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/duck-duck-go"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "duck-duck-scrape": "catalog:",
    "string-strip-html": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/duck-duck-go/src/duck-duck-go-client.ts
================================================
import { aiFunction, AIFunctionsProvider } from '@agentic/core'
import { SafeSearchType, search, type SearchOptions } from 'duck-duck-scrape'
import { z } from 'zod'

import { paginate } from './paginate'

export namespace duckduckgo {
  export interface DuckDuckGoSearchToolOptions {
    search?: SearchOptions
    maxResults: number
  }

  export interface DuckDuckGoSearchToolRunOptions {
    search?: SearchOptions
  }
}
/**
 * DuckDuckGo search client.
 *
 * @see https://duckduckgo.com
 */
export class DuckDuckGoClient extends AIFunctionsProvider {
  /**
   * Searches the web using DuckDuckGo for a given query.
   */
  @aiFunction({
    name: 'duck_duck_go_search',
    description: 'Searches the web using DuckDuckGo for a given query.',
    inputSchema: z.object({
      query: z.string({ description: 'Search query' }).min(1).max(128),
      maxResults: z.number().min(1).max(100).optional()
    })
  })
  async search(
    queryOrOptions:
      | string
      | { query: string; maxResults?: number; search?: SearchOptions }
  ) {
    const options =
      typeof queryOrOptions === 'string'
        ? { query: queryOrOptions }
        : queryOrOptions

    const results = await paginate({
      size: options.maxResults ?? 10,
      handler: async ({ cursor = 0 }) => {
        const { results: data, noResults: done } = await search(
          options.query,
          {
            safeSearch: SafeSearchType.MODERATE,
            ...options.search,
            offset: cursor
          },
          {
            uri_modifier: (rawUrl: string) => {
              const url = new URL(rawUrl)
              url.searchParams.delete('ss_mkt')
              return url.toString()
            }
          }
        )

        return {
          data,
          nextCursor: done ? undefined : cursor + data.length
        }
      }
    })

    const { stripHtml } = await import('string-strip-html')

    return results.map((result) => ({
      url: result.url,
      title: stripHtml(result.title).result,
      description: stripHtml(result.description).result
    }))
  }
}


================================================
FILE: legacy/packages/duck-duck-go/src/index.ts
================================================
export * from './duck-duck-go-client'


================================================
FILE: legacy/packages/duck-duck-go/src/paginate.ts
================================================
export interface PaginateInput<T, C> {
  size: number
  handler: (data: {
    cursor?: C
    limit: number
  }) => Promise<{ data: T[]; nextCursor?: C }>
}

export async function paginate<T, C = number>(
  input: PaginateInput<T, C>
): Promise<T[]> {
  const acc: T[] = []
  let cursor: C | undefined

  while (acc.length < input.size) {
    const { data, nextCursor } = await input.handler({
      cursor,
      limit: input.size - acc.length
    })
    acc.push(...data)

    if (nextCursor === undefined || data.length === 0) {
      break
    }

    cursor = nextCursor
  }

  if (acc.length > input.size) {
    acc.length = input.size
  }

  return acc
}


================================================
FILE: legacy/packages/duck-duck-go/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/e2b/package.json
================================================
{
  "name": "@agentic/e2b",
  "version": "7.6.9",
  "description": "Agentic SDK for E2B's hosted code interpreter.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/e2b"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*"
  },
  "peerDependencies": {
    "@e2b/code-interpreter": "catalog:",
    "zod": "catalog:"
  },
  "devDependencies": {
    "@e2b/code-interpreter": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: legacy/packages/e2b/src/e2b.ts
================================================
import { createAIFunction, getEnv } from '@agentic/core'
import { Sandbox } from '@e2b/code-interpreter'
import { z } from 'zod'

/**
 * E2B Python code interpreter sandbox.
 *
 * @see https://e2b.dev
 */
export const e2b = createAIFunction(
  {
    name: 'execute_python',
    description: `
Execute python code in a Jupyter notebook cell and returns any result, stdout, stderr, display_data, and error.

- code has access to the internet and can make api requests
- code has access to the filesystem and can read/write files
- coce can install any pip package (if it exists) if you need to, but the usual packages for data analysis are already preinstalled
- code uses python3
- code is executed in a secure sandbox environment, so you don't need to worry about safety
      `.trim(),
    inputSchema: z.object({
      code: z
        .string()
        .describe('Python code to execute in a single notebook cell.')
    })
  },
  async ({ code }) => {
    const sandbox = await Sandbox.create({
      apiKey: getEnv('E2B_API_KEY')
    })

    try {
      const exec = await sandbox.runCode(code, {
        onStderr: (msg) => {
          console.warn('[Code Interpreter stderr]', msg)
        },

        onStdout: (stdout) => {
          console.log('[Code Interpreter stdout]', stdout)
        }
      })

      if (exec.error) {
        console.error('[Code Interpreter error]', exec.error)
        throw new Error(exec.error.value)
      }

      return exec.results.map((result) => result.toJSON())
    } finally {
      await sandbox.kill()
    }
  }
)


================================================
FILE: legacy/packages/e2b/src/index.ts
================================================
export * from './e2b'


================================================
FILE: legacy/packages/e2b/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "compilerOptions": {
    "noImplicitAny": false
  },
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/exa/package.json
================================================
{
  "name": "@agentic/exa",
  "version": "7.6.9",
  "description": "Agentic SDK for the Exa search engine.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/exa"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/exa/src/exa-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pruneUndefined
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace exa {
  export const TextContentsOptionsSchema = z.object({
    maxCharacters: z
      .number()
      .optional()
      .describe('The maximum number of characters to return.'),
    includeHtmlTags: z
      .boolean()
      .optional()
      .describe('If true, includes HTML tags in the returned text.')
  })
  export type TextContentsOptions = z.infer<typeof TextContentsOptionsSchema>

  export const HighlightsContentsOptionsSchema = z.object({
    query: z
      .string()
      .optional()
      .describe('The query string to use for highlights search.'),
    numSentences: z
      .number()
      .optional()
      .describe('The number of sentences to return for each highlight.'),
    highlightsPerUrl: z
      .number()
      .optional()
      .describe('The number of highlights to return for each URL.')
  })
  export type HighlightsContentsOptions = z.infer<
    typeof HighlightsContentsOptionsSchema
  >

  export const ContentsOptionsSchema = z.object({
    text: z.union([TextContentsOptionsSchema, z.literal(true)]).optional(),
    highlights: z
      .union([HighlightsContentsOptionsSchema, z.literal(true)])
      .optional()
  })
  export type ContentsOptions = z.infer<typeof ContentsOptionsSchema>

  export const BaseSearchOptionsSchema = z.object({
    numResults: z
      .number()
      .optional()
      .describe('Number of search results to return.'),
    includeDomains: z
      .array(z.string())
      .optional()
      .describe('List of domains to include in the search.'),
    excludeDomains: z
      .array(z.string())
      .optional()
      .describe('List of domains to exclude from the search.'),
    startCrawlDate: z
      .string()
      .optional()
      .describe(
        'Start date for results based on crawl date (ISO 8601 format).'
      ),
    endCrawlDate: z
      .string()
      .optional()
      .describe('End date for results based on crawl date (ISO 8601 format).'),
    startPublishedDate: z
      .string()
      .optional()
      .describe(
        'Start date for results based on published date (ISO 8601 format).'
      ),
    endPublishedDate: z
      .string()
      .optional()
      .describe(
        'End date for results based on published date (ISO 8601 format).'
      ),
    category: z
      .string()
      .optional()
      .describe(
        'A data category to focus on, with higher comprehensivity and data cleanliness. Currently, the only category is company.'
      ),
    contents: ContentsOptionsSchema.optional().describe(
      'Whether to include the contents of the search results.'
    )
  })
  export type BaseSearchOptions = z.infer<typeof BaseSearchOptionsSchema>

  export const RegularSearchOptionsSchema = BaseSearchOptionsSchema.extend({
    query: z.string().describe('search query'),
    useAutoprompt: z.boolean().optional(),
    type: z.enum(['keyword', 'neural', 'magic']).optional()
  })
  export type RegularSearchOptions = z.infer<typeof RegularSearchOptionsSchema>

  export const FindSimilarOptionsSchema = BaseSearchOptionsSchema.extend({
    url: z
      .string()
      .describe('The url for which you would like to find similar links'),
    excludeSourceDomain: z
      .boolean()
      .optional()
      .describe('If true, excludes links from the base domain of the input.')
  })
  export type FindSimilarOptions = z.infer<typeof FindSimilarOptionsSchema>

  export const GetContentsOptionsSchema = ContentsOptionsSchema.extend({
    ids: z
      .array(z.string())
      .nonempty()
      .describe('Exa IDs of the documents to retrieve.')
  })
  export type GetContentsOptions = z.infer<typeof GetContentsOptionsSchema>

  /**
   * Represents a search result object.
   */
  export type SearchResult = {
    /** The title of the search result. */
    title: string | null

    /** The URL of the search result. */
    url: string

    /** The estimated creation date of the content (ISO 8601 format). */
    publishedDate?: string

    /** The author of the content, if available. */
    author?: string

    /** Similarity score between the query/url and the result. */
    score?: number

    /** The temporary Exa ID for the document. */
    id: string

    /** Text from page */
    text?: string

    /** The highlights as an array of strings. */
    highlights?: string[]

    /** The corresponding scores as an array of floats, 0 to 1 */
    highlightScores?: number[]
  }

  /**
   * Represents a search response object.
   */
  export type SearchResponse = {
    /** The list of search results. */
    results: SearchResult[]

    /** The autoprompt string, if applicable. */
    autopromptString?: string

    /** Internal ID of this request. */
    requestId?: string
  }
}

/**
 * Web search tailored for LLMs.
 *
 * @see https://docs.exa.ai
 */
export class ExaClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('EXA_API_KEY'),
    apiBaseUrl = getEnv('EXA_API_BASE_URL') ?? 'https://api.exa.ai',
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'ExaClient missing required "apiKey" (defaults to "EXA_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      headers: {
        'x-api-key': apiKey
      }
    })
  }

  /**
   * Performs an Exa search for the given query.
   */
  @aiFunction({
    name: 'exa_search',
    description: 'Search the web for the given query.',
    inputSchema: exa.RegularSearchOptionsSchema
  })
  async search(queryOrOpts: string | exa.RegularSearchOptions) {
    const json =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    return this.ky.post('search', { json }).json<exa.SearchResponse>()
  }

  /**
   * Finds similar links to the provided URL.
   */
  @aiFunction({
    name: 'exa_find_similar',
    description: 'Find similar links to the provided URL.',
    inputSchema: exa.FindSimilarOptionsSchema
  })
  async findSimilar(opts: exa.FindSimilarOptions) {
    const { excludeSourceDomain, ...rest } = opts
    const excludeDomains = (opts.excludeDomains ?? []).concat(
      excludeSourceDomain ? [new URL(opts.url).hostname] : []
    )

    return this.ky
      .post('findSimilar', {
        json: pruneUndefined({
          ...rest,
          excludeDomains: excludeDomains.length ? excludeDomains : undefined
        })
      })
      .json<exa.SearchResponse>()
  }

  /**
   * Retrieves contents of documents based on a list of Exa document IDs.
   */
  @aiFunction({
    name: 'exa_get_contents',
    description:
      'Retrieve contents of documents based on a list of Exa document IDs.',
    inputSchema: exa.GetContentsOptionsSchema
  })
  async getContents({ ids, ...opts }: exa.GetContentsOptions) {
    const documentIDs = Array.isArray(ids) ? ids : [ids]
    assert(documentIDs.length, 'Must provide at least one document ID')

    return this.ky
      .post('contents', {
        json: {
          ...opts,
          ids: documentIDs
        }
      })
      .json<exa.SearchResponse>()
  }
}


================================================
FILE: legacy/packages/exa/src/index.ts
================================================
export * from './exa-client'


================================================
FILE: legacy/packages/exa/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/firecrawl/package.json
================================================
{
  "name": "@agentic/firecrawl",
  "version": "7.6.9",
  "description": "Agentic SDK for Firecrawl.",
  "authors": [
    "Travis Fischer <travis@transitivebullsh.it>",
    "Ademílson Tonato <ademilsonft@outlook.com>"
  ],
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/firecrawl"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/firecrawl/src/firecrawl-client.test.ts
================================================
import { z } from 'zod'

import { FirecrawlClient } from './firecrawl-client'

// Initialize the client with the API key
const apiKey = 'FIRECRAWL-API-KEY'
const firecrawl = new FirecrawlClient({ apiKey })

// =============================================
// Test 1: URL Scraping
// =============================================
async function testUrlScraping() {
  console.log('🔍 Testing URL scraping...')
  try {
    const result = await firecrawl.scrapeUrl('https://mairistumpf.com')
    console.log('✅ URL scraping successful!')
    console.log('Result:', result)
  } catch (err) {
    console.error('❌ URL scraping failed:', err)
  }
}

// =============================================
// Test 2: Search
// =============================================
async function testSearch() {
  console.log('\n🔍 Testing search...')
  try {
    const result = await firecrawl.search({
      query: 'artificial intelligence news',
      limit: 5,
      lang: 'en',
      country: 'us'
    })
    console.log('✅ Search successful!')
    console.log('Results:', result.data)
    console.log('Results:', result.data.length)
  } catch (err) {
    console.error('❌ Search failed:', err)
  }
}

// =============================================
// Test 3: Crawl URL
// =============================================
async function testCrawlUrl() {
  console.log('\n🔍 Testing URL crawling...')
  try {
    const result = await firecrawl.crawlUrl({
      url: 'https://example.com',
      maxDepth: 2,
      limit: 5
    })
    console.log('✅ Crawl initiated successfully!')
    console.log('Result:', result)

    if (result.success && result.id) {
      // Test crawl status
      console.log('\n🔍 Testing crawl status...')
      const statusResult = await firecrawl.checkCrawlStatus(result.id)
      console.log('✅ Crawl status check successful!')
      console.log('Status:', statusResult)

      // Test crawl errors
      console.log('\n🔍 Testing crawl errors...')
      const errorsResult = await firecrawl.checkCrawlErrors(result.id)
      console.log('✅ Crawl errors check successful!')
      console.log('Errors:', errorsResult)

      // Test crawl cancellation
      console.log('\n🔍 Testing crawl cancellation...')
      const cancelResult = await firecrawl.cancelCrawl(result.id)
      console.log('✅ Crawl cancellation successful!')
      console.log('Result:', cancelResult)
    }
  } catch (err) {
    console.error('❌ Crawl operations failed:', err)
  }
}

// =============================================
// Test 4: Extract
// =============================================
async function testExtract() {
  console.log('\n🔍 Testing extract...')
  try {
    const result = await firecrawl.extract(['https://firecrawl.dev'], {
      prompt: 'Extract the pricing information from the website',
      schema: z.object({
        pricing: z.object({
          free: z.object({
            price: z.number(),
            features: z.array(z.string())
          }),
          pro: z.object({
            price: z.number(),
            features: z.array(z.string())
          })
        })
      }),
      enableWebSearch: false,
      ignoreSitemap: false,
      includeSubdomains: true,
      showSources: false,
      scrapeOptions: {
        formats: ['markdown'],
        onlyMainContent: true,
        blockAds: true,
        proxy: 'basic',
        location: {
          country: 'US',
          languages: ['en-US']
        }
      }
    })
    console.log('✅ Extract successful!')
    console.log('Result:', result)

    if (result.success && result.id) {
      // Test extract status
      console.log('\n🔍 Testing extract status...')
      const statusResult = await firecrawl.checkExtractStatus(result.id)
      console.log('✅ Extract status check successful!')
      console.log('Status:', statusResult)
    }
  } catch (err) {
    console.error('❌ Extract failed:', err)
  }
}

async function testExtractUntilCompletion() {
  console.log('\n🔍 Testing extract...')
  try {
    const result = await firecrawl.extract(['https://firecrawl.dev'], {
      prompt: 'Extract the pricing information from the website',
      schema: z.object({
        pricing: z.object({
          free: z.object({
            price: z.number(),
            features: z.array(z.string())
          }),
          pro: z.object({
            price: z.number(),
            features: z.array(z.string())
          })
        })
      }),
      enableWebSearch: false,
      ignoreSitemap: false,
      includeSubdomains: true,
      showSources: false,
      scrapeOptions: {
        formats: ['markdown'],
        onlyMainContent: true,
        blockAds: true,
        proxy: 'basic',
        location: {
          country: 'US',
          languages: ['en-US']
        }
      }
    })
    console.log('✅ Extract successful!')
    console.log('Result:', result)

    if (result.success && result.id) {
      // Test extract status
      console.log('\n🔍 Testing extract status...')
      let statusResult = await firecrawl.checkExtractStatus(result.id)

      while (statusResult.status === 'processing') {
        // wait 5 seconds and check again
        await new Promise((resolve) => setTimeout(resolve, 5000))
        statusResult = await firecrawl.checkExtractStatus(result.id)
      }
      console.log('✅ Extract status check successful!')
      console.log('Status:', statusResult)
    }
  } catch (err) {
    console.error('❌ Extract failed:', err)
  }
}

// =============================================
// Run all tests
// =============================================
console.log('🚀 Starting FirecrawlClient tests...\n')

// Run tests sequentially
await testUrlScraping()
await testSearch()
await testCrawlUrl()
await testExtract()
await testExtractUntilCompletion()

console.log('\n🏁 All tests completed!')


================================================
FILE: legacy/packages/firecrawl/src/firecrawl-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  throttleKy,
  zodToJsonSchema
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace firecrawl {
  export const BASE_URL = 'https://api.firecrawl.dev'

  // Allow up to 50 request per minute by default.
  export const throttle = pThrottle({
    limit: 1,
    interval: 1200,
    strict: true
  })

  /**
   * Configuration interface for FirecrawlClient.
   */
  export interface ClientConfig {
    apiKey?: string
    apiBaseUrl?: string
  }

  /**
   * Metadata for a Firecrawl document.
   */
  export interface DocumentMetadata {
    title?: string
    description?: string
    language?: string
    keywords?: string
    robots?: string
    ogTitle?: string
    ogDescription?: string
    ogUrl?: string
    ogImage?: string
    ogAudio?: string
    ogDeterminer?: string
    ogLocale?: string
    ogLocaleAlternate?: string[]
    ogSiteName?: string
    ogVideo?: string
    dctermsCreated?: string
    dcDateCreated?: string
    dcDate?: string
    dctermsType?: string
    dcType?: string
    dctermsAudience?: string
    dctermsSubject?: string
    dcSubject?: string
    dcDescription?: string
    dctermsKeywords?: string
    modifiedTime?: string
    publishedTime?: string
    articleTag?: string
    articleSection?: string
    sourceURL?: string
    statusCode?: number
    error?: string
    [key: string]: any
  }

  /**
   * Document interface for Firecrawl.
   */
  export interface Document<
    T = any,
    ActionsSchema extends ActionsResult | never = never
  > {
    url?: string
    markdown?: string
    html?: string
    rawHtml?: string
    links?: string[]
    extract?: T
    json?: T
    screenshot?: string
    metadata?: DocumentMetadata
    actions: ActionsSchema
    title?: string
    description?: string
  }

  /**
   * Parameters for scraping operations.
   * Defines the options and configurations available for scraping web content.
   */
  export interface ScrapeOptions {
    formats?: (
      | 'markdown'
      | 'html'
      | 'rawHtml'
      | 'content'
      | 'links'
      | 'screenshot'
      | 'screenshot@fullPage'
      | 'extract'
      | 'json'
    )[]
    headers?: Record<string, string>
    includeTags?: string[]
    excludeTags?: string[]
    onlyMainContent?: boolean
    waitFor?: number
    timeout?: number
    location?: {
      country?: string
      languages?: string[]
    }
    mobile?: boolean
    skipTlsVerification?: boolean
    removeBase64Images?: boolean
    blockAds?: boolean
    proxy?: 'basic' | 'stealth'
  }

  /**
   * Parameters for scraping operations.
   */
  export interface ScrapeParams<
    LLMSchema extends z.ZodSchema = any,
    ActionsSchema extends Action[] | undefined = undefined
  > {
    formats?: (
      | 'markdown'
      | 'html'
      | 'rawHtml'
      | 'content'
      | 'links'
      | 'screenshot'
      | 'screenshot@fullPage'
      | 'extract'
      | 'json'
    )[]
    headers?: Record<string, string>
    includeTags?: string[]
    excludeTags?: string[]
    onlyMainContent?: boolean
    waitFor?: number
    timeout?: number
    location?: {
      country?: string
      languages?: string[]
    }
    mobile?: boolean
    skipTlsVerification?: boolean
    removeBase64Images?: boolean
    blockAds?: boolean
    proxy?: 'basic' | 'stealth'
    extract?: {
      prompt?: string
      schema?: LLMSchema
      systemPrompt?: string
    }
    jsonOptions?: {
      prompt?: string
      schema?: LLMSchema
      systemPrompt?: string
    }
    actions?: ActionsSchema
  }

  export type Action =
    | {
        type: 'wait'
        milliseconds?: number
        selector?: string
      }
    | {
        type: 'click'
        selector: string
      }
    | {
        type: 'screenshot'
        fullPage?: boolean
      }
    | {
        type: 'write'
        text: string
      }
    | {
        type: 'press'
        key: string
      }
    | {
        type: 'scroll'
        direction?: 'up' | 'down'
        selector?: string
      }
    | {
        type: 'scrape'
      }
    | {
        type: 'executeJavascript'
        script: string
      }

  export interface ActionsResult {
    screenshots: string[]
  }

  /**
   * Response interface for scraping operations.
   */
  export interface ScrapeResponse<
    LLMResult = any,
    ActionsSchema extends ActionsResult | never = never
  > extends Document<LLMResult, ActionsSchema> {
    success: true
    warning?: string
    error?: string
  }

  /**
   * Parameters for search operations.
   */
  export interface SearchParams {
    limit?: number
    tbs?: string
    filter?: string
    lang?: string
    country?: string
    location?: string
    origin?: string
    timeout?: number
    scrapeOptions?: ScrapeParams
  }

  /**
   * Response interface for search operations.
   */
  export interface SearchResponse {
    success: boolean
    data: Document[]
    warning?: string
    error?: string
  }

  /**
   * Parameters for crawling operations.
   */
  export interface CrawlParams {
    includePaths?: string[]
    excludePaths?: string[]
    maxDepth?: number
    maxDiscoveryDepth?: number
    limit?: number
    allowBackwardLinks?: boolean
    allowExternalLinks?: boolean
    ignoreSitemap?: boolean
    scrapeOptions?: ScrapeParams
    webhook?:
      | string
      | {
          url: string
          headers?: Record<string, string>
          metadata?: Record<string, string>
          events?: ['completed', 'failed', 'page', 'started'][number][]
        }
    deduplicateSimilarURLs?: boolean
    ignoreQueryParameters?: boolean
    regexOnFullURL?: boolean
  }

  /**
   * Response interface for crawling operations.
   */
  export interface CrawlResponse {
    id?: string
    url?: string
    success: true
    error?: string
  }

  /**
   * Response interface for job status checks.
   */
  export interface CrawlStatusResponse {
    success: true
    status: 'scraping' | 'completed' | 'failed' | 'cancelled'
    completed: number
    total: number
    creditsUsed: number
    expiresAt: Date
    next?: string
    data: Document[]
  }

  /**
   * Response interface for crawl errors.
   */
  export interface CrawlErrorsResponse {
    errors: {
      id: string
      timestamp?: string
      url: string
      error: string
    }[]
    robotsBlocked: string[]
  }

  /**
   * Error response interface.
   */
  export interface ErrorResponse {
    success: false
    error: string
  }

  /**
   * Custom error class for Firecrawl.
   */
  export class FirecrawlError extends Error {
    statusCode: number
    details?: any

    constructor(message: string, statusCode: number, details?: any) {
      super(message)
      this.statusCode = statusCode
      this.details = details
    }
  }

  /**
   * Parameters for extracting information from URLs.
   */
  export interface ExtractParams<T extends z.ZodSchema = any> {
    prompt: string
    schema?: T
    enableWebSearch?: boolean
    ignoreSitemap?: boolean
    includeSubdomains?: boolean
    showSources?: boolean
    scrapeOptions?: ScrapeOptions
  }

  /**
   * Response interface for extracting information from URLs.
   * Defines the structure of the response received after extracting information from URLs.
   */
  export interface ExtractResponse<T = any> {
    success: boolean
    id?: string
    data: T
    error?: string
    warning?: string
    sources?: string[]
  }

  /**
   * Response interface for extract status operations.
   */
  export interface ExtractStatusResponse<T = any> {
    success: boolean
    status: 'processing' | 'completed' | 'failed'
    data?: T
    error?: string
    expiresAt?: string
  }

  /**
   * Parameters for LLMs.txt generation operations.
   */
  export interface GenerateLLMsTextParams {
    /**
     * Maximum number of URLs to process (1-100)
     * @default 10
     */
    maxUrls?: number
    /**
     * Whether to show the full LLMs-full.txt in the response
     * @default false
     */
    showFullText?: boolean
  }

  /**
   * Response interface for LLMs.txt generation operations.
   */
  export interface GenerateLLMsTextResponse {
    success: boolean
    id: string
  }

  /**
   * Status response interface for LLMs.txt generation operations.
   */
  export interface GenerateLLMsTextStatusResponse {
    success: boolean
    data: {
      llmstxt: string
      llmsfulltxt?: string
    }
    status: 'processing' | 'completed' | 'failed'
    error?: string
    expiresAt: string
  }
}

/**
 * Turn websites into LLM-ready data. Crawl and convert any website into clean
 * markdown or structured data.
 *
 * @see https://www.firecrawl.dev
 * @see https://github.com/mendableai/firecrawl
 */
export class FirecrawlClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('FIRECRAWL_API_KEY'),
    apiBaseUrl = getEnv('FIRECRAWL_API_BASE_URL') ?? firecrawl.BASE_URL,
    throttle = true,
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    throttle?: boolean
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'FirecrawlClient missing required "apiKey" (defaults to "FIRECRAWL_API_KEY")'
    )
    assert(
      apiBaseUrl,
      'FirecrawlClient missing required "apiBaseUrl" (defaults to "FIRECRAWL_API_BASE_URL")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, firecrawl.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        Authorization: `Bearer ${this.apiKey}`,
        'X-Origin': 'agentic',
        'X-Origin-Type': 'integration'
      }
    })
  }

  /**
   * Scrape the contents of a URL.
   */
  @aiFunction({
    name: 'firecrawl_scrape_url',
    description: 'Scrape the contents of a URL.',
    inputSchema: z.object({
      url: z.string().url().describe('The URL to scrape.')
    })
  })
  async scrapeUrl<
    T extends z.ZodSchema,
    ActionsSchema extends firecrawl.Action[] | undefined = undefined
  >(
    orlOrOpts:
      | string
      | ({ url: string } & firecrawl.ScrapeParams<T, ActionsSchema>)
  ): Promise<
    | firecrawl.ScrapeResponse<
        z.infer<T>,
        ActionsSchema extends firecrawl.Action[]
          ? firecrawl.ActionsResult
          : never
      >
    | firecrawl.ErrorResponse
  > {
    const { url, ...params } =
      typeof orlOrOpts === 'string' ? { url: orlOrOpts } : orlOrOpts
    let jsonData: any = { url, ...params }

    if (jsonData?.extract?.schema) {
      let schema = jsonData.extract.schema
      try {
        schema = zodToJsonSchema(schema)
      } catch {}
      jsonData = {
        ...jsonData,
        extract: {
          ...jsonData.extract,
          schema
        }
      }
    }

    if (jsonData?.jsonOptions?.schema) {
      let schema = jsonData.jsonOptions.schema
      try {
        schema = zodToJsonSchema(schema)
      } catch {}
      jsonData = {
        ...jsonData,
        jsonOptions: {
          ...jsonData.jsonOptions,
          schema
        }
      }
    }

    try {
      const response = await this.postRequest('v1/scrape', jsonData)
      return response
    } catch (err) {
      if (err instanceof firecrawl.FirecrawlError) {
        throw err
      }
      throw new firecrawl.FirecrawlError(
        err instanceof Error ? err.message : 'Unknown error',
        500
      )
    }
  }

  /**
   * Searches using the Firecrawl API.
   */
  @aiFunction({
    name: 'firecrawl_search',
    description: 'Searches the internet for the given query.',
    inputSchema: z.object({
      query: z.string().describe('Search query.')
    })
  })
  async search(
    queryOrOpts: string | ({ query: string } & firecrawl.SearchParams)
  ): Promise<firecrawl.SearchResponse> {
    const { query, ...params } =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    const jsonData = {
      query,
      limit: params?.limit ?? 5,
      tbs: params?.tbs,
      filter: params?.filter,
      lang: params?.lang ?? 'en',
      country: params?.country ?? 'us',
      location: params?.location,
      origin: params?.origin ?? 'api',
      timeout: params?.timeout ?? 60_000,
      scrapeOptions: params?.scrapeOptions ?? { formats: [] }
    }

    try {
      const response = await this.postRequest('v1/search', jsonData)
      if (response.success) {
        return {
          success: true,
          data: response.data as firecrawl.Document[],
          warning: response.warning
        }
      } else {
        throw new firecrawl.FirecrawlError(
          `Failed to search. Error: ${response.error}`,
          500
        )
      }
    } catch (err: any) {
      if (err.response?.data?.error) {
        throw new firecrawl.FirecrawlError(
          `Request failed with status code ${err.response.status}. Error: ${err.response.data.error} ${err.response.data.details ? ` - ${JSON.stringify(err.response.data.details)}` : ''}`,
          err.response.status
        )
      } else {
        throw new firecrawl.FirecrawlError(err.message, 500)
      }
    }
  }

  /**
   * Initiates a crawl job for a URL.
   */
  @aiFunction({
    name: 'firecrawl_crawl_url',
    description: 'Initiates a crawl job for a URL.',
    inputSchema: z.object({
      url: z.string().url().describe('The URL to crawl.')
    })
  })
  async crawlUrl(
    urlOrOpts: string | ({ url: string } & firecrawl.CrawlParams)
  ): Promise<firecrawl.CrawlResponse | firecrawl.ErrorResponse> {
    const { url, ...params } =
      typeof urlOrOpts === 'string' ? { url: urlOrOpts } : urlOrOpts
    const jsonData = { url, ...params }

    try {
      const response = await this.postRequest('v1/crawl', jsonData)
      if (response.success) {
        return response
      } else {
        throw new firecrawl.FirecrawlError(
          `Failed to start crawl job. Error: ${response.error}`,
          500
        )
      }
    } catch (err: any) {
      if (err.response?.data?.error) {
        throw new firecrawl.FirecrawlError(
          `Request failed with status code ${err.response.status}. Error: ${err.response.data.error} ${err.response.data.details ? ` - ${JSON.stringify(err.response.data.details)}` : ''}`,
          err.response.status
        )
      } else {
        throw new firecrawl.FirecrawlError(err.message, 500)
      }
    }
  }

  /**
   * Checks the status of a crawl job.
   */
  async checkCrawlStatus(
    id: string
  ): Promise<firecrawl.CrawlStatusResponse | firecrawl.ErrorResponse> {
    if (!id) {
      throw new firecrawl.FirecrawlError('No crawl ID provided', 400)
    }

    try {
      const response = await this.getRequest(`v1/crawl/${id}`)
      if (response.success) {
        return response
      } else {
        throw new firecrawl.FirecrawlError(
          `Failed to check crawl status. Error: ${response.error}`,
          500
        )
      }
    } catch (err: any) {
      throw new firecrawl.FirecrawlError(err.message, 500)
    }
  }

  /**
   * Returns information about crawl errors.
   */
  async checkCrawlErrors(
    id: string
  ): Promise<firecrawl.CrawlErrorsResponse | firecrawl.ErrorResponse> {
    try {
      const response = await this.getRequest(`v1/crawl/${id}/errors`)
      if (response.errors) {
        return response
      } else {
        throw new firecrawl.FirecrawlError(
          `Failed to check crawl errors. Error: ${response.error}`,
          500
        )
      }
    } catch (err: any) {
      throw new firecrawl.FirecrawlError(err.message, 500)
    }
  }

  /**
   * Cancels a crawl job.
   */
  async cancelCrawl(id: string): Promise<firecrawl.ErrorResponse> {
    try {
      const response = await this.deleteRequest(`v1/crawl/${id}`)
      if (response.status) {
        return response
      } else {
        throw new firecrawl.FirecrawlError(
          `Failed to cancel crawl job. Error: ${response.error}`,
          500
        )
      }
    } catch (err: any) {
      throw new firecrawl.FirecrawlError(err.message, 500)
    }
  }

  /**
   * Extracts structured data from URLs using LLMs.
   *
   * @param urls - Array of URLs to extract data from
   * @param params - Additional parameters for the extract request
   * @returns The response from the extract operation
   */
  async extract<T extends z.ZodSchema>(
    urls: string[],
    params: firecrawl.ExtractParams<T>
  ): Promise<firecrawl.ExtractResponse<z.infer<T>>> {
    const jsonData = {
      urls,
      ...params,
      schema: params.schema ? zodToJsonSchema(params.schema) : undefined
    }

    try {
      const response = await this.postRequest('v1/extract', jsonData)
      if (!response.success) {
        throw new firecrawl.FirecrawlError(
          response.error || 'Extract operation failed',
          500
        )
      }
      return response
    } catch (err) {
      if (err instanceof firecrawl.FirecrawlError) {
        throw err
      }
      throw new firecrawl.FirecrawlError(
        err instanceof Error ? err.message : 'Unknown error',
        500
      )
    }
  }

  /**
   * Checks the status of an extract operation.
   */
  async checkExtractStatus<T = any>(
    id: string
  ): Promise<firecrawl.ExtractStatusResponse<T>> {
    if (!id) {
      throw new firecrawl.FirecrawlError('No extract ID provided', 400)
    }

    try {
      const response = await this.getRequest(`v1/extract/${id}`)
      return response
    } catch (err) {
      if (err instanceof firecrawl.FirecrawlError) {
        throw err
      }
      throw new firecrawl.FirecrawlError(
        err instanceof Error ? err.message : 'Unknown error',
        500
      )
    }
  }

  /**
   * Generates LLMs.txt for a given URL.
   */
  async generateLLMsText(
    url: string,
    params?: firecrawl.GenerateLLMsTextParams
  ): Promise<
    firecrawl.GenerateLLMsTextStatusResponse | firecrawl.ErrorResponse
  > {
    const jsonData = {
      url,
      ...params
    }

    try {
      const response = await this.postRequest('v1/llmstxt', jsonData)
      return response
    } catch (err) {
      if (err instanceof firecrawl.FirecrawlError) {
        throw err
      }
      throw new firecrawl.FirecrawlError(
        err instanceof Error ? err.message : 'Unknown error',
        500
      )
    }
  }

  /**
   * Sends a POST request.
   */
  protected async postRequest(path: string, data: any): Promise<any> {
    try {
      const response = await this.ky.post(path, { json: data })
      return await response.json()
    } catch (err) {
      if (err instanceof Error) {
        const response = await (err as any).response?.json()
        if (response?.error) {
          throw new firecrawl.FirecrawlError(
            `Request failed. Error: ${response.error}`,
            (err as any).response?.status ?? 500,
            response?.details
          )
        }
      }
      throw err
    }
  }

  /**
   * Sends a GET request.
   */
  protected async getRequest(path: string): Promise<any> {
    try {
      const response = await this.ky.get(path)
      return await response.json()
    } catch (err) {
      if (err instanceof Error) {
        const response = await (err as any).response?.json()
        if (response?.error) {
          throw new firecrawl.FirecrawlError(
            `Request failed. Error: ${response.error}`,
            (err as any).response?.status ?? 500,
            response?.details
          )
        }
      }
      throw err
    }
  }

  /**
   * Sends a DELETE request.
   */
  protected async deleteRequest(path: string): Promise<any> {
    try {
      const response = await this.ky.delete(path)
      return await response.json()
    } catch (err) {
      if (err instanceof Error) {
        const response = await (err as any).response?.json()
        if (response?.error) {
          throw new firecrawl.FirecrawlError(
            `Request failed. Error: ${response.error}`,
            (err as any).response?.status ?? 500,
            response?.details
          )
        }
      }
      throw err
    }
  }
}


================================================
FILE: legacy/packages/firecrawl/src/index.ts
================================================
export * from './firecrawl-client'


================================================
FILE: legacy/packages/firecrawl/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/github/package.json
================================================
{
  "name": "@agentic/github",
  "version": "7.6.9",
  "description": "Agentic SDK for GitHub.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/github"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "octokit": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/github/src/github-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import { Octokit } from 'octokit'
import { z } from 'zod'

export namespace github {
  export interface User {
    id: number
    login: string
    name: string
    bio: string
    node_id: string
    gravatar_id: string
    type: string
    site_admin: boolean
    company: string
    blog?: string
    location?: string
    hireable?: boolean
    twitter_username?: string
    email?: string
    public_repos: number
    public_gists: number
    followers: number
    following: number
    avatar_url: string
    url: string
    html_url: string
    followers_url: string
    following_url: string
    gists_url: string
    starred_url: string
    subscriptions_url: string
    organizations_url: string
    repos_url: string
    events_url: string
    received_events_url: string
    created_at: string
    updated_at: string
  }
}

/**
 * Agentic GitHub client.
 */
export class GitHubClient extends AIFunctionsProvider {
  protected readonly apiKey: string
  protected readonly octokit: Octokit

  constructor({
    apiKey = getEnv('GITHUB_API_KEY')
  }: {
    apiKey?: string
  } = {}) {
    assert(
      apiKey,
      'GitHubClient missing required "apiKey" (defaults to "GITHUB_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.octokit = new Octokit({ auth: apiKey })
  }

  /**
   * Get a user by username.
   */
  @aiFunction({
    name: 'github_get_user_by_username',
    description: 'Get a user by username.',
    inputSchema: z.object({
      username: z.string().describe('The username of the user to get.')
    })
  })
  async getUserByUsername(
    usernameOrOpts: string | { username: string }
  ): Promise<github.User> {
    const { username } =
      typeof usernameOrOpts === 'string'
        ? { username: usernameOrOpts }
        : usernameOrOpts

    const res = await this.octokit.request(`GET /users/${username}`, {
      headers: {
        'X-GitHub-Api-Version': '2022-11-28'
      }
    })

    return res.data
  }
}


================================================
FILE: legacy/packages/github/src/index.ts
================================================
export * from './github-client'


================================================
FILE: legacy/packages/github/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/google-custom-search/package.json
================================================
{
  "name": "@agentic/google-custom-search",
  "version": "7.6.9",
  "description": "Agentic client for the Google Custom Search API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/google-custom-search"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@googleapis/customsearch": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/google-custom-search/src/google-custom-search-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import { customsearch_v1 as GoogleSearchAPI } from '@googleapis/customsearch'
import { z } from 'zod'

import { paginate } from './paginate'

export namespace googleCustomSearch {
  export const SearchParamsSchema = z.object({
    query: z.string().min(1).max(2048).describe('Search query'),
    maxResults: z.number().optional(),
    safeSearch: z
      .union([z.literal('active'), z.literal('off')])
      .optional()
      .describe('Search safety level. Defaults to "active".')
  })
  export type SearchParams = z.infer<typeof SearchParamsSchema>
}

/**
 * Agentic client for the official Google Custom Search API.
 *
 * @see https://developers.google.com/custom-search/v1/overview
 */
export class GoogleCustomSearchClient extends AIFunctionsProvider {
  protected readonly apiKey: string

  readonly cseId: string
  readonly client: GoogleSearchAPI.Customsearch

  constructor({
    apiKey = getEnv('GOOGLE_API_KEY'),
    cseId = getEnv('GOOGLE_CSE_ID')
  }: {
    /** Google API key */
    apiKey?: string

    /** Google Custom Search Engine ID */
    cseId?: string
  } = {}) {
    assert(
      apiKey,
      'GoogleCustomSearchClient missing required "apiKey" (defaults to "GOOGLE_API_KEY")'
    )
    assert(
      cseId,
      'GoogleCustomSearchClient missing required "cseId" (defaults to "GOOGLE_CSE_ID")'
    )
    super()

    this.apiKey = apiKey
    this.cseId = cseId

    this.client = new GoogleSearchAPI.Customsearch({
      auth: this.apiKey
    })
  }

  /**
   * Google Custom Search for online trends, news, current events, real-time information, or research topics.
   */
  @aiFunction({
    name: 'google_custom_search',
    description: `Google Custom Search for online trends, news, current events, real-time information, or research topics.`,
    inputSchema: googleCustomSearch.SearchParamsSchema
  })
  async search(
    queryOrParams: string | googleCustomSearch.SearchParams
  ): Promise<any> {
    const params =
      typeof queryOrParams === 'string'
        ? { query: queryOrParams }
        : queryOrParams

    const results = await paginate({
      size: params.maxResults ?? 10,
      handler: async ({ cursor = 0, limit }) => {
        const maxChunkSize = 10

        const {
          data: { items = [] }
        } = await this.client.cse.list({
          cx: this.cseId,
          q: params.query,
          start: cursor,
          num: Math.min(limit, maxChunkSize),
          safe: params.safeSearch ?? 'active'
        })

        return {
          data: items,
          nextCursor:
            items.length < maxChunkSize ? undefined : cursor + items.length
        }
      }
    })

    return results
  }
}


================================================
FILE: legacy/packages/google-custom-search/src/index.ts
================================================
export * from './google-custom-search-client'


================================================
FILE: legacy/packages/google-custom-search/src/paginate.ts
================================================
export interface PaginateInput<T, C> {
  size: number
  handler: (data: {
    cursor?: C
    limit: number
  }) => Promise<{ data: T[]; nextCursor?: C }>
}

export async function paginate<T, C = number>(
  input: PaginateInput<T, C>
): Promise<T[]> {
  const acc: T[] = []
  let cursor: C | undefined

  while (acc.length < input.size) {
    const { data, nextCursor } = await input.handler({
      cursor,
      limit: input.size - acc.length
    })
    acc.push(...data)

    if (nextCursor === undefined || data.length === 0) {
      break
    }

    cursor = nextCursor
  }

  if (acc.length > input.size) {
    acc.length = input.size
  }

  return acc
}


================================================
FILE: legacy/packages/google-custom-search/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/google-docs/package.json
================================================
{
  "name": "@agentic/google-docs",
  "version": "7.6.9",
  "description": "Agentic SDK for Google Docs.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/google-docs"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "type-fest": "catalog:"
  },
  "devDependencies": {
    "googleapis": "catalog:"
  },
  "peerDependencies": {
    "googleapis": "catalog:",
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/google-docs/src/google-docs-client.ts
================================================
import type * as google from 'googleapis'
import type { SetNonNullable, Simplify } from 'type-fest'
import {
  aiFunction,
  AIFunctionsProvider,
  pruneNullOrUndefinedDeep,
  type SetRequired
} from '@agentic/core'
import { z } from 'zod'

export namespace googleDocs {
  export type Document = Simplify<
    SetNonNullable<google.docs_v1.Schema$Document>
  >
}

/**
 * Simplified Google Docs API client.
 *
 * @see https://developers.google.com/workspace/drive/api
 *
 * @example
 * ```ts
 * import { GoogleDocsClient } from '@agentic/google-docs'
 * import { authenticate } from '@google-cloud/local-auth'
 * import { google } from 'googleapis'
 *
 * // (in a real app, store these auth credentials and reuse them)
 * const auth = await authenticate({
 *   scopes: ['https://www.googleapis.com/auth/documents.readonly'],
 *   keyfilePath: process.env.GOOGLE_CREDENTIALS_PATH
 * })
 * const docs = google.docs({ version: 'v1', auth })
 * const client = new GoogleDocsClient({ docs })
 * ```
 */
export class GoogleDocsClient extends AIFunctionsProvider {
  protected readonly docs: google.docs_v1.Docs

  constructor({ docs }: { docs: google.docs_v1.Docs }) {
    super()

    this.docs = docs
  }

  /**
   * Gets a Google Docs document by ID.
   */
  @aiFunction({
    name: 'google_docs_get_document',
    description: 'Gets a Google Docs document by ID.',
    inputSchema: z.object({
      documentId: z.string()
    })
  })
  async getDocument(
    args: Simplify<
      SetRequired<google.docs_v1.Params$Resource$Documents$Get, 'documentId'>
    >
  ): Promise<googleDocs.Document> {
    const { documentId, ...opts } = args

    const { data } = await this.docs.documents.get({
      ...opts,
      documentId
    })

    return convertDocument(data)
  }
}

function convertDocument(
  data: google.docs_v1.Schema$Document
): googleDocs.Document {
  return pruneNullOrUndefinedDeep(data)
}


================================================
FILE: legacy/packages/google-docs/src/index.ts
================================================
export * from './google-docs-client'


================================================
FILE: legacy/packages/google-docs/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/google-drive/package.json
================================================
{
  "name": "@agentic/google-drive",
  "version": "7.6.9",
  "description": "Agentic SDK for Google Drive.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/google-drive"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "type-fest": "catalog:"
  },
  "devDependencies": {
    "googleapis": "catalog:"
  },
  "peerDependencies": {
    "googleapis": "catalog:",
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/google-drive/src/google-drive-client.ts
================================================
import type * as google from 'googleapis'
import type { SetNonNullable, Simplify } from 'type-fest'
import {
  aiFunction,
  AIFunctionsProvider,
  pick,
  pruneNullOrUndefined,
  pruneNullOrUndefinedDeep
} from '@agentic/core'
import { z } from 'zod'

export namespace googleDrive {
  export type File = Simplify<
    SetNonNullable<
      Pick<
        google.drive_v3.Schema$File,
        | 'id'
        | 'name'
        | 'mimeType'
        | 'webViewLink'
        | 'webContentLink'
        | 'size'
        | 'createdTime'
        | 'modifiedTime'
        | 'parents'
      >
    >
  >

  export const fileFields: readonly (keyof File)[] = [
    'id',
    'name',
    'mimeType',
    'webViewLink',
    'webContentLink',
    'size',
    'createdTime',
    'modifiedTime',
    'parents'
  ]
  export const requestFileFields = `files(${fileFields.join(',')}),nextPageToken`

  export interface ListFilesResponse {
    files: File[]
    nextPageToken?: string
  }

  export interface DownloadResponse {
    content: string
    metadata: File
  }

  export const ListFilesParamsSchema = z.object({
    folderId: z.string().optional(),
    query: z.string().optional(),
    pageSize: z.number().optional(),
    pageToken: z.string().optional()
  })
}

/**
 * Simplified Google Drive API client.
 *
 * @see https://developers.google.com/workspace/drive/api
 *
 * @example
 * ```ts
 * import { GoogleDriveClient } from '@agentic/google-drive'
 * import { GoogleAuth } from 'google-auth-library'
 * import { google } from 'googleapis'
 *
 * const auth = new GoogleAuth({ scopes: 'https://www.googleapis.com/auth/drive' })
 * const drive = google.drive({ version: 'v3', auth })
 * const client = new GoogleDriveClient({ drive })
 * ```
 */
export class GoogleDriveClient extends AIFunctionsProvider {
  protected readonly drive: google.drive_v3.Drive

  constructor({ drive }: { drive: google.drive_v3.Drive }) {
    super()

    this.drive = drive
  }

  /**
   * Lists files and folders in a Google Drive folder.
   */
  @aiFunction({
    name: 'google_drive_list_files',
    description: 'Lists files and folders in a Google Drive folder.',
    inputSchema: googleDrive.ListFilesParamsSchema
  })
  async listFiles(
    args: {
      folderId?: string
      query?: string
    } & google.drive_v3.Params$Resource$Files$Get
  ): Promise<googleDrive.ListFilesResponse> {
    const { folderId, query, ...opts } = args
    // Build the query conditions
    const conditions = ['trashed = false'] // Always exclude trashed files

    if (folderId) {
      conditions.push(`'${folderId}' in parents`)
    }

    if (query) {
      conditions.push(`name contains '${query}'`)
    }

    // Combine all conditions with AND
    const q = conditions.join(' and ')

    const { data } = await this.drive.files.list({
      fields: googleDrive.requestFileFields,
      ...opts,
      q
    })
    const files = (data.files ?? []).map(convertFile)

    return pruneNullOrUndefined({
      files,
      nextPageToken: data.nextPageToken
    })
  }

  /**
   * Gets a file's metadata from Google Drive.
   */
  @aiFunction({
    name: 'google_drive_get_file',
    description: "Gets a file's metadata from Google Drive.",
    inputSchema: z.object({ fileId: z.string() })
  })
  async getFile(
    opts: google.drive_v3.Params$Resource$Files$Get
  ): Promise<googleDrive.File> {
    const { data } = await this.drive.files.get({
      fields: googleDrive.requestFileFields,
      ...opts
    })

    return convertFile(data)
  }

  /**
   * Exports a file from Google Drive.
   */
  @aiFunction({
    name: 'google_drive_export_file',
    description: 'Exports a file from Google Drive to a given mime-type.',
    inputSchema: z.object({
      fileId: z.string().describe('The ID of the file to export.'),
      mimeType: z
        .string()
        .describe('The MIME type of the format requested for this export.')
    })
  })
  async exportFile(
    opts: google.drive_v3.Params$Resource$Files$Export
  ): Promise<unknown> {
    return this.drive.files.export(opts)
  }

  @aiFunction({
    name: 'google_drive_create_folder',
    description: 'Creates a new folder in Google Drive.',
    inputSchema: z.object({
      name: z.string().describe('The name of the folder to create.'),
      parentId: z.string().describe('The ID of the parent folder.').optional()
    })
  })
  async createFolder(
    opts: Omit<
      google.drive_v3.Params$Resource$Files$Create,
      'media' | 'requestBody'
    > & {
      name: string
      parentId?: string
    }
  ): Promise<googleDrive.File> {
    const { data } = await this.drive.files.create({
      requestBody: {
        mimeType: 'application/vnd.google-apps.folder',
        name: opts.name,
        parents: opts.parentId ? [opts.parentId] : undefined
      },
      fields: googleDrive.requestFileFields,
      ...opts
    })

    return convertFile(data)
  }
}

function convertFile(data: google.drive_v3.Schema$File): googleDrive.File {
  return pruneNullOrUndefinedDeep(
    pick(data, ...googleDrive.fileFields)
  ) as googleDrive.File
}


================================================
FILE: legacy/packages/google-drive/src/index.ts
================================================
export * from './google-drive-client'


================================================
FILE: legacy/packages/google-drive/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/gravatar/package.json
================================================
{
  "name": "@agentic/gravatar",
  "version": "7.6.9",
  "description": "Agentic SDK for Gravatar.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/gravatar"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/gravatar/src/gravatar-client.ts
================================================
import crypto from 'node:crypto'

import {
  aiFunction,
  AIFunctionsProvider,
  getEnv,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace gravatar {
  export const API_BASE_URL = 'https://api.gravatar.com'

  // Allow up to 100 unauthenticated requests per hour by default.
  export const unauthenticatedThrottle = pThrottle({
    limit: 100,
    interval: 60 * 60 * 1000
  })

  // Allow up to 1000 authenticated requests per hour by default.
  export const authenticatedThrottle = pThrottle({
    limit: 1000,
    interval: 60 * 60 * 1000
  })

  export type GetProfileByIdentifierOptions = {
    email: string
  }

  export interface Profile {
    /** The SHA256 hash of the user’s primary email address. */
    hash: string
    /** The user’s display name that appears on their profile. */
    display_name: string
    first_name?: string
    last_name?: string
    /** The full URL to the user’s Gravatar profile. */
    profile_url: string
    /** The URL to the user’s avatar image, if set. */
    avatar_url: string
    /** Alternative text describing the user’s avatar. */
    avatar_alt_text: string
    /** The user’s geographical location. */
    location: string
    /** A short biography or description about the user found on their profile. */
    description: string
    /** The user’s current job title. */
    job_title: string
    /** The name of the company where the user is employed. */
    company: string
    /** An array of verified accounts the user has added to their profile. The number of verified accounts displayed is limited to a maximum of 4 in unauthenticated requests. */
    verified_accounts: VerifiedAccount[]
    /** A phonetic guide to pronouncing the user’s name. */
    pronunciation: string
    /** The pronouns the user prefers to use. */
    pronouns: string

    is_organization?: boolean
    links?: Link[]
    interests?: any[]
    gallery?: GalleryImage[]
    payments?: {
      links?: Link[]
      crypto_wallets?: CryptoWallet[]
    }

    /** The total number of verified accounts the user has added to their profile, including those not displayed on their profile. This property is only provided in authenticated API requests. */
    number_verified_accounts?: number

    /** The date and time (UTC) when the user last edited their profile. This property is only provided in authenticated API requests. Example: "2021-10-01T12:00:00Z" */
    last_profile_edit?: string

    /** The date the user registered their account. This property is only provided in authenticated API requests. Example: "2021-10-01" */
    registration_date?: string

    contact_info?: ContactInfo
  }

  export interface VerifiedAccount {
    service_type: string
    service_label: string
    service_icon: string
    url: string
    is_hidden: boolean
  }

  export interface Link {
    label: string
    url: string
  }

  export interface GalleryImage {
    url: string
    alt_text: string
  }

  export interface CryptoWallet {
    label: string
    address: string
  }

  export interface ContactInfo {
    home_phone: string
    work_phone: string
    cell_phone: string
    email: string
    contact_form: string
    calendar: string
  }
}

/**
 * A client for the Gravatar API.
 *
 * API key is optional.
 *
 * @see https://docs.gravatar.com/getting-started/
 */
export class GravatarClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey?: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('GRAVATAR_API_KEY'),
    apiBaseUrl = gravatar.API_BASE_URL,
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    super()

    // API key is optional
    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle
      ? throttleKy(
          ky,
          apiKey
            ? gravatar.authenticatedThrottle
            : gravatar.unauthenticatedThrottle
        )
      : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: Object.fromEntries(
        apiKey ? [['Authorization', `Bearer ${apiKey}`]] : []
      )
    })
  }

  /**
   * Get Gravatar profile by email. Returns a profile object or `undefined` if not found.
   */
  @aiFunction({
    name: 'gravatar_get_profile',
    description:
      'Get Gravatar profile by email. Returns a profile object or `undefined` if not found.',
    inputSchema: z.object({
      email: z.string()
    })
  })
  async getProfileByIdentifier(
    emailOrOpts: string | gravatar.GetProfileByIdentifierOptions
  ): Promise<gravatar.Profile | undefined> {
    const { email } =
      typeof emailOrOpts === 'string' ? { email: emailOrOpts } : emailOrOpts
    const hashedEmail = crypto
      .createHash('SHA256')
      .update(email.trim().toLowerCase(), 'utf8')
      .digest('hex')

    try {
      return await this.ky
        .get(`v3/profiles/${hashedEmail}`)
        .json<gravatar.Profile>()
    } catch (err: any) {
      if (err.response?.status === 404) {
        return
      }

      throw err
    }
  }

  async getAvatarForIdentifier(
    emailOrOpts: string | gravatar.GetProfileByIdentifierOptions
  ): Promise<string> {
    const { email } =
      typeof emailOrOpts === 'string' ? { email: emailOrOpts } : emailOrOpts
    const hashedEmail = crypto
      .createHash('SHA256')
      .update(email.trim().toLowerCase(), 'utf8')
      .digest('hex')

    return `https://gravatar.com/avatar/${hashedEmail}`
  }
}


================================================
FILE: legacy/packages/gravatar/src/index.ts
================================================
export * from './gravatar-client'


================================================
FILE: legacy/packages/gravatar/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/hacker-news/package.json
================================================
{
  "name": "@agentic/hacker-news",
  "version": "7.6.9",
  "description": "Agentic SDK for Hacker News.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/hacker-news"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/hacker-news/src/hacker-news-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace hackernews {
  export const HACKER_NEWS_API_BASE_URL = 'https://hacker-news.firebaseio.com'
  export const HACKER_NEWS_API_SEARCH_BASE_URL = 'https://hn.algolia.com'
  export const HACKER_NEWS_API_USER_AGENT =
    'Agentic (https://github.com/transitive-bullshit/agentic)'

  export type ItemType =
    | 'story'
    | 'comment'
    | 'ask'
    | 'job'
    | 'poll'
    | 'pollopt'

  export interface Item {
    id: number
    type: ItemType
    by: string
    time: number
    score: number
    title?: string
    url?: string
    text?: string
    descendants?: number
    parent?: number
    kids?: number[]
    parts?: number[]
  }

  export interface User {
    id: string
    created: number
    about: string
    karma: number
    submitted: number[]
  }

  export type SearchTag =
    | 'story'
    | 'comment'
    | 'poll'
    | 'pollopt'
    | 'show_hn'
    | 'ask_hn'
    | 'front_page'

  export type SearchNumericFilterField =
    | 'created_at_i'
    | 'points'
    | 'num_comments'
  export type SearchNumericFilterCondition = '<' | '<=' | '=' | '>=' | '>'

  export type SearchSortBy = 'relevance' | 'recency'

  export interface SearchOptions {
    /** Full-text search query */
    query?: string

    /** Filter by author's HN username */
    author?: string

    /** Filter by story id */
    story?: string

    /** Filter by type of item (story, comment, etc.) */
    tags?: Array<SearchTag>

    /** Filter by numeric range (created_at_i, points, or num_comments); (created_at_i is a timestamp in seconds) */
    numericFilters?: Array<`${SearchNumericFilterField}${SearchNumericFilterCondition}${number}`>

    /** Page number to return */
    page?: number

    /** Number of results to return per page */
    hitsPerPage?: number

    /** How to sort the results */
    sortBy?: SearchSortBy
  }

  export interface SearchItem {
    id: number
    created_at: string
    created_at_i: number
    title?: string
    url?: string
    author: string
    text: string | null
    points: number | null
    parent_id: number | null
    story_id: number | null
    type: ItemType
    children: SearchItem[]
    options?: any[]
  }

  export interface SearchUser {
    username: string
    about: string
    karma: number
  }

  export interface SearchResponse {
    hits: SearchHit[]
    page: number
    nbHits: number
    nbPages: number
    hitsPerPage: number
    query: string
    params: string
    processingTimeMS: number
    serverTimeMS: number
    processingTimingsMS?: any
  }

  export interface SearchHit {
    objectID: string
    url: string
    title: string
    author: string
    story_text?: string
    story_id?: number
    story_url?: string
    comment_text?: string
    points?: number
    num_comments?: number
    created_at: string
    created_at_i: number
    updated_at: string
    parts?: number[]
    children: number[]
    _tags: string[]
    _highlightResult: SearchHighlightResult
  }

  export interface SearchHighlightResult {
    author: Highlight
    title?: Highlight
    url?: Highlight
    comment_text?: Highlight
    story_title?: Highlight
    story_url?: Highlight
  }

  export interface Highlight {
    value: string
    matchLevel: string
    matchedWords: string[]
    fullyHighlighted?: boolean
  }

  export const searchTagSchema = z.union([
    z.literal('story'),
    z.literal('comment'),
    z.literal('poll'),
    z.literal('pollopt'),
    z.literal('show_hn'),
    z.literal('ask_hn'),
    z.literal('front_page')
  ])

  export const searchSortBySchema = z.union([
    z.literal('relevance'),
    z.literal('recency')
  ])

  export const searchOptionsSchema = z.object({
    query: z.string().optional().describe('Full-text search query'),
    author: z.string().optional().describe("Filter by author's HN username"),
    story: z.string().optional().describe('Filter by story id'),
    tags: z
      .array(hackernews.searchTagSchema)
      .optional()
      .describe(
        "Filter by type of item (story, comment, etc.). Multiple tags are AND'ed together."
      ),
    numericFilters: z
      .array(z.any())
      .optional()
      .describe(
        'Filter by numeric range (created_at_i, points, or num_comments); (created_at_i is a timestamp in seconds). Ex: numericFilters=points>100,num_comments>=1000'
      ),
    page: z.number().int().optional().describe('Page number to return'),
    hitsPerPage: z
      .number()
      .int()
      .optional()
      .describe('Number of results to return per page (defaults to 50)'),
    sortBy: hackernews.searchSortBySchema
      .optional()
      .describe('How to sort the results (defaults to relevancy)')
  })
}

/**
 * Basic client for the official Hacker News API.
 *
 * The normal API methods (`getItem`) use the official Firebase API, while the
 * search-prefixed methods use the more powerful Algolia API. The tradeoff is
 * that the official Firebase API is generally more reliable in my experience,
 * which is why we opted to support both.
 *
 * @see https://github.com/HackerNews/API
 * @see https://hn.algolia.com/api
 */
export class HackerNewsClient extends AIFunctionsProvider {
  protected readonly apiKy: KyInstance
  protected readonly apiSearchKy: KyInstance

  protected readonly apiBaseUrl: string
  protected readonly apiSearchBaseUrl: string
  protected readonly apiUserAgent: string

  constructor({
    apiBaseUrl = getEnv('HACKER_NEWS_API_BASE_URL') ??
      hackernews.HACKER_NEWS_API_BASE_URL,
    apiSearchBaseUrl = getEnv('HACKER_NEWS_API_SEARCH_BASE_URL') ??
      hackernews.HACKER_NEWS_API_SEARCH_BASE_URL,
    apiUserAgent = getEnv('HACKER_NEWS_API_USER_AGENT') ??
      hackernews.HACKER_NEWS_API_USER_AGENT,
    ky = defaultKy,
    timeoutMs = 60_000
  }: {
    apiBaseUrl?: string
    apiSearchBaseUrl?: string
    apiUserAgent?: string
    ky?: KyInstance
    timeoutMs?: number
  } = {}) {
    assert(apiBaseUrl, 'HackerNewsClient missing required "apiBaseUrl"')
    assert(
      apiSearchBaseUrl,
      'HackerNewsClient missing required "apiSearchBaseUrl"'
    )
    super()

    this.apiBaseUrl = apiBaseUrl
    this.apiSearchBaseUrl = apiSearchBaseUrl
    this.apiUserAgent = apiUserAgent

    this.apiKy = ky.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        'user-agent': apiUserAgent
      }
    })

    this.apiSearchKy = ky.extend({
      prefixUrl: apiSearchBaseUrl,
      timeout: timeoutMs,
      headers: {
        'user-agent': apiUserAgent
      }
    })
  }

  /** Fetches a HN story or comment by its ID. */
  @aiFunction({
    name: 'hacker_news_get_item',
    description: 'Fetches a HN story or comment by its ID.',
    inputSchema: z.object({ itemId: z.string() })
  })
  async getSearchItem(itemIdOrOpts: string | number | { itemId: string }) {
    const { itemId } =
      typeof itemIdOrOpts === 'string' || typeof itemIdOrOpts === 'number'
        ? { itemId: itemIdOrOpts }
        : itemIdOrOpts

    return this.apiSearchKy
      .get(`api/v1/items/${itemId}`)
      .json<hackernews.SearchItem>()
  }

  /**
   * Fetches a HN user by username.
   */
  @aiFunction({
    name: 'hacker_news_get_user',
    description: 'Fetches a HN user by username.',
    inputSchema: z.object({ username: z.string() })
  })
  async getSearchUser(usernameOrOpts: string | number | { username: string }) {
    const { username } =
      typeof usernameOrOpts === 'string' || typeof usernameOrOpts === 'number'
        ? { username: usernameOrOpts }
        : usernameOrOpts

    return this.apiSearchKy
      .get(`api/v1/users/${username}`)
      .json<hackernews.SearchUser>()
  }

  /** Searches HN for stories and comments matching the given query. */
  @aiFunction({
    name: 'hacker_news_search',
    description:
      'Searches HN for stories and comments matching the given query.',
    inputSchema: hackernews.searchOptionsSchema
  })
  async searchItems(queryOrOpts: string | hackernews.SearchOptions) {
    const {
      query,
      numericFilters,
      page,
      hitsPerPage,
      sortBy = 'relevance',
      ...opts
    } = typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    // Tags are AND'ed together; we do not support OR'ing tags via parentheses.
    const tags = [
      ...(opts.tags ?? []),
      opts.story ? `story_${opts.story}` : undefined,
      opts.author ? `author_${opts.author}` : undefined
    ].filter(Boolean)

    return this.apiSearchKy
      .get(sortBy === 'relevance' ? 'api/v1/search' : 'api/v1/search_by_date', {
        searchParams: sanitizeSearchParams(
          {
            query,
            tags,
            numericFilters,
            page,
            hitsPerPage
          },
          { csv: true }
        )
      })
      .json<hackernews.SearchResponse>()
  }

  /**
   * Fetches / searches the top stories currently on the front page of HN. This is the same as `hacker_news_search`, but with `tags: ["front_page"]` set to filter only by the current front page stories.
   */
  @aiFunction({
    name: 'hacker_news_get_top_stories',
    description:
      'Fetches / searches the top stories currently on the front page of HN. This is the same as `hacker_news_search`, but with `tags: ["front_page"]` set to filter only by the current front page stories.',
    inputSchema: hackernews.searchOptionsSchema
  })
  async getSearchTopStories(queryOrOpts: string | hackernews.SearchOptions) {
    const opts =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    return this.searchItems({
      ...opts,
      tags: ['front_page', ...(opts.tags ?? [])]
    })
  }

  async getItem(id: string | number) {
    return this.apiKy.get(`v0/item/${id}.json`).json<hackernews.Item>()
  }

  async getTopStories() {
    return this.apiKy.get('v0/topstories.json').json<number[]>()
  }

  async getNewStories() {
    return this.apiKy.get('v0/newstories.json').json<number[]>()
  }

  async getBestStories() {
    return this.apiKy.get('v0/beststories.json').json<number[]>()
  }
}


================================================
FILE: legacy/packages/hacker-news/src/index.ts
================================================
export * from './hacker-news-client'


================================================
FILE: legacy/packages/hacker-news/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/hunter/package.json
================================================
{
  "name": "@agentic/hunter",
  "version": "7.6.9",
  "description": "Agentic SDK for hunter.io email lookup.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/hunter"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/hunter/src/hunter-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pruneNullOrUndefinedDeep,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace hunter {
  export const API_BASE_URL = 'https://api.hunter.io'

  export const DepartmentSchema = z.enum([
    'executive',
    'it',
    'finance',
    'management',
    'sales',
    'legal',
    'support',
    'hr',
    'marketing',
    'communication',
    'education',
    'design',
    'health',
    'operations'
  ])
  export type Department = z.infer<typeof DepartmentSchema>

  export const SenioritySchema = z.enum(['junior', 'senior', 'executive'])
  export type Seniority = z.infer<typeof SenioritySchema>

  export const PersonFieldSchema = z.enum([
    'full_name',
    'position',
    'phone_number'
  ])
  export type PersonField = z.infer<typeof PersonFieldSchema>

  export const DomainSearchOptionsSchema = z.object({
    domain: z.string().optional().describe('domain to search for'),
    company: z.string().optional().describe('company name to search for'),
    limit: z.number().int().optional(),
    offset: z.number().int().optional(),
    type: z.enum(['personal', 'generic']).optional(),
    seniority: z.union([SenioritySchema, z.array(SenioritySchema)]).optional(),
    department: z
      .union([DepartmentSchema, z.array(DepartmentSchema)])
      .optional(),
    required_field: z
      .union([PersonFieldSchema, z.array(PersonFieldSchema)])
      .optional()
  })
  export type DomainSearchOptions = z.infer<typeof DomainSearchOptionsSchema>

  export const EmailFinderOptionsSchema = z.object({
    domain: z.string().optional().describe('domain to search for'),
    company: z.string().optional().describe('company name to search for'),
    first_name: z.string().describe("person's first name"),
    last_name: z.string().describe("person's last name"),
    max_duration: z.number().int().min(3).max(20).optional()
  })
  export type EmailFinderOptions = z.infer<typeof EmailFinderOptionsSchema>

  export const EmailVerifierOptionsSchema = z.object({
    email: z.string().describe('email address to verify')
  })
  export type EmailVerifierOptions = z.infer<typeof EmailVerifierOptionsSchema>

  export interface DomainSearchResponse {
    data: DomainSearchData
    meta: {
      results: number
      limit: number
      offset: number
      params: {
        domain?: string
        company?: string
        type?: string
        seniority?: string
        department?: string
      }
    }
    errors?: Error[]
  }

  export interface DomainSearchData {
    domain: string
    disposable: boolean
    webmail?: boolean
    accept_all?: boolean
    pattern?: string
    organization?: string
    description?: string
    industry?: string
    twitter?: string
    facebook?: string
    linkedin?: string
    instagram?: string
    youtube?: string
    technologies?: string[]
    country?: string
    state?: string
    city?: string
    postal_code?: string
    street?: string
    headcount?: string
    company_type?: string
    emails?: Email[]
    linked_domains?: string[]
  }

  export interface Email {
    value: string
    type: string
    confidence: number
    first_name?: string
    last_name?: string
    position?: string
    seniority?: string
    department?: string
    linkedin?: string
    twitter?: string
    phone_number?: string
    verification?: Verification
    sources?: Source[]
  }

  export interface Source {
    domain: string
    uri: string
    extracted_on: string
    last_seen_on: string
    still_on_page?: boolean
  }

  export interface Verification {
    date: string
    status: string
  }

  export interface EmailFinderResponse {
    data: EmailFinderData
    meta: {
      params: {
        first_name?: string
        last_name?: string
        full_name?: string
        domain?: string
        company?: string
        max_duration?: string
      }
    }
    errors?: Error[]
  }

  export interface EmailFinderData {
    first_name: string
    last_name: string
    email: string
    score: number
    domain: string
    accept_all: boolean
    position?: string
    twitter?: any
    linkedin_url?: any
    phone_number?: any
    company?: string
    sources?: Source[]
    verification?: Verification
  }

  export interface EmailVerifierResponse {
    data: EmailVerifierData
    meta: {
      params: {
        email: string
      }
    }
    errors?: Error[]
  }

  export interface EmailVerifierData {
    status:
      | 'valid'
      | 'invalid'
      | 'accept_all'
      | 'webmail'
      | 'disposable'
      | 'unknown'
    result: 'deliverable' | 'undeliverable' | 'risky'
    score: number
    email: string
    regexp: boolean
    gibberish: boolean
    disposable: boolean
    webmail: boolean
    mx_records: boolean
    smtp_server: boolean
    smtp_check: boolean
    accept_all: boolean
    block: boolean
    sources?: Source[]
    _deprecation_notice?: string
  }

  export interface Error {
    id: string
    code: number
    details: string
  }
}

/**
 * Lightweight wrapper around Hunter.io email finder, verifier, and enrichment
 * APIs.
 *
 * @see https://hunter.io/api-documentation
 */
export class HunterClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('HUNTER_API_KEY'),
    apiBaseUrl = hunter.API_BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'HunterClient missing required "apiKey" (defaults to "HUNTER_API_KEY")'
    )

    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl
    })
  }

  /**
   * Gets all the email addresses associated with a given company or domain.
   */
  @aiFunction({
    name: 'hunter_domain_search',
    description:
      'Gets all the email addresses associated with a given company or domain.',
    inputSchema: hunter.DomainSearchOptionsSchema.pick({
      domain: true,
      company: true
    })
  })
  async domainSearch(domainOrOpts: string | hunter.DomainSearchOptions) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    if (!opts.domain && !opts.company) {
      throw new Error('Either "domain" or "company" is required')
    }

    const res = await this.ky
      .get('v2/domain-search', {
        searchParams: sanitizeSearchParams(
          {
            ...opts,
            api_key: this.apiKey
          },
          { csv: true }
        )
      })
      .json<hunter.DomainSearchResponse>()

    return pruneNullOrUndefinedDeep(res)
  }

  /**
   * Finds the most likely email address from a domain name, a first name and a last name.
   */
  @aiFunction({
    name: 'hunter_email_finder',
    description:
      'Finds the most likely email address from a domain name, a first name and a last name.',
    inputSchema: hunter.EmailFinderOptionsSchema.pick({
      domain: true,
      company: true,
      first_name: true,
      last_name: true
    })
  })
  async emailFinder(opts: hunter.EmailFinderOptions) {
    if (!opts.domain && !opts.company) {
      throw new Error('Either "domain" or "company" is required')
    }

    const res = await this.ky
      .get('v2/email-finder', {
        searchParams: sanitizeSearchParams({
          ...opts,
          api_key: this.apiKey
        })
      })
      .json<hunter.EmailFinderResponse>()

    return pruneNullOrUndefinedDeep(res)
  }

  /**
   * Verifies the deliverability of an email address.
   */
  @aiFunction({
    name: 'hunter_email_verifier',
    description: 'Verifies the deliverability of an email address.',
    inputSchema: hunter.EmailVerifierOptionsSchema
  })
  async emailVerifier(emailOrOpts: string | hunter.EmailVerifierOptions) {
    const opts =
      typeof emailOrOpts === 'string' ? { email: emailOrOpts } : emailOrOpts

    const res = await this.ky
      .get('v2/email-verifier', {
        searchParams: sanitizeSearchParams({
          ...opts,
          api_key: this.apiKey
        })
      })
      .json<hunter.EmailVerifierResponse>()

    return pruneNullOrUndefinedDeep(res)
  }
}


================================================
FILE: legacy/packages/hunter/src/index.ts
================================================
export * from './hunter-client'


================================================
FILE: legacy/packages/hunter/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/jigsawstack/package.json
================================================
{
  "name": "@agentic/jigsawstack",
  "version": "7.6.9",
  "description": "Agentic adapter for the Jigsawstack AI SDK.",
  "author": "Narcisse Egonu",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/jigsawstack"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test-unit": "vitest run"
  },
  "peerDependencies": {
    "@agentic/core": "workspace:*"
  },
  "devDependencies": {
    "@agentic/core": "workspace:*",
    "@ai-sdk/openai": "catalog:",
    "ai": "catalog:"
  },
  "dependencies": {
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/jigsawstack/src/index.ts
================================================
export * from './jigsawstack-client'


================================================
FILE: legacy/packages/jigsawstack/src/integration.test.ts
================================================
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'
import { expect, test } from 'vitest'

import { createAISDKTools } from '../../ai-sdk'
import { JigsawStackClient } from './jigsawstack-client'

// Do ensure to set your JIGSAWSTACK_API_KEY environment variable.

const jigsaw = new JigsawStackClient({ timeoutMs: 30_000 })

test.skip('should run successfully and return search result', async () => {
  const { toolResults } = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(jigsaw),
    toolChoice: 'required',
    prompt: 'Tell me about "Santorini"'
  })

  // console.log(toolResults, 'toolResults')
  expect(toolResults[0]).toBeTruthy()
})

test.skip('should scrape url successfully and return result', async () => {
  const { toolResults } = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(jigsaw),
    toolChoice: 'required',
    prompt: 'Scrape https://jigsawstack.com and tell me their title'
  })

  // console.log(toolResults[0], 'toolResults')
  expect(toolResults[0]).toBeTruthy()
})

test.skip('should perform vision based OCR and return result', async () => {
  const { toolResults } = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(jigsaw),
    toolChoice: 'required',
    prompt:
      'Tell me about this image : https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z'
  })
  // console.log(toolResults[0], 'toolResults')
  expect(toolResults[0]).toBeTruthy()
})

test.skip('should perform speech to text  and return result', async () => {
  const { toolResults } = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(jigsaw),
    toolChoice: 'required',
    prompt:
      'Get the transcription from this video url : https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894Z'
  })
  // console.log(toolResults[0], 'toolResults')
  expect(toolResults[0]).toBeTruthy()
})

test('should perform text to sql and return result', async () => {
  const prompt = `
  Generate a query to get transactions that amount exceed 10000 and sort by when created. Given this schema:
    "CREATE TABLE Transactions (transaction_id INT PRIMARY KEY, user_id INT NOT NULL,total_amount DECIMAL(10, 2 NOT NULL, transaction_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,status VARCHAR(20) DEFAULT 'pending',FOREIGN KEY(user_id) REFERENCES Users(user_id))"`
  const { toolResults } = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(jigsaw),
    toolChoice: 'required',
    prompt
  })
  expect(toolResults[0]).toBeTruthy()
})


================================================
FILE: legacy/packages/jigsawstack/src/jigsawstack-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import ky, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace jigsawstack {
  export interface BaseResponse {
    success: boolean
  }

  export const API_BASE_URL = 'https://api.jigsawstack.com/v1/'

  export interface SearchParams {
    query: string
    ai_overview?: boolean
    safe_search?: 'moderate' | 'strict' | 'off'
    spell_check?: boolean
  }

  export interface SearchResponse extends BaseResponse {
    query: string
    spell_fixed: string
    is_safe: boolean
    ai_overview: string
    results: {
      title: string
      url: string
      description: string
      content: string
      is_safe: boolean
      site_name: string
      site_long_name: string
      age: string
      language: string
      favicon: string
      snippets: string[]
      related_index: []
    }[]
  }

  export interface CookieParameter {
    name: string
    value: string
    url?: string
    domain?: string
    path?: string
    secure?: boolean
    httpOnly?: boolean
    sameSite?: 'Strict' | 'Lax' | 'None'
    expires?: boolean
    priority?: string
    sameParty?: boolean
  }

  export interface ScrapeParams {
    url: string
    element_prompts: string[]
    http_headers?: object
    reject_request_pattern?: string[]
    goto_options?: {
      timeout: number
      wait_until: string
    }
    wait_for?: {
      mode: string
      value: string | number
    }
    advance_config?: {
      console: boolean
      network: boolean
      cookies: boolean
    }
    size_preset?: string
    is_mobile?: boolean
    scale?: number
    width?: number
    height?: number
    cookies?: Array<CookieParameter>
  }

  export interface ScrapeResponse extends BaseResponse {
    data: any
  }

  export interface VOCRParams {
    prompt: string | string[]
    url?: string
    file_store_key?: string
  }

  export interface VOCRResponse extends BaseResponse {
    context: string
    width: number
    height: number
    tags: string[]
    has_text: boolean
    sections: Array<any>
  }

  export interface TextToSqlParams {
    prompt: string
    sql_schema?: string
    file_store_key?: string
  }

  export interface TextToSqlResponse extends BaseResponse {
    sql: string
  }

  export interface SpeechToTextParams {
    url?: string
    file_store_key?: string
    language?: string
    translate?: boolean
    by_speaker?: boolean
    webhook_url?: string
  }

  export interface SpeechToTextResponse extends BaseResponse {
    text: string
    chunks: Array<{
      timestamp: number[]
      text: string
    }>
    status?: 'processing' | 'error'
    id?: string
  }
}

/**
 * Basic JigsawStack API wrapper.
 */
export class JigsawStackClient extends AIFunctionsProvider {
  protected readonly apiKey: string
  protected readonly ky: KyInstance
  constructor({
    apiKey = getEnv('JIGSAWSTACK_API_KEY'),
    timeoutMs = 60_000
  }: {
    apiKey?: string
    throttle?: boolean
    timeoutMs?: number
  } = {}) {
    assert(
      apiKey,
      'Please set the JIGSAWSTACK_API_KEY environment variable or pass it to the constructor as the apiKey field.'
    )
    super()
    this.apiKey = apiKey
    this.ky = ky.extend({
      prefixUrl: jigsawstack.API_BASE_URL,
      timeout: timeoutMs,
      headers: {
        'x-api-key': this.apiKey
      }
    })
  }

  /**
   * Perform web searches and retrieve high-quality results of the given query
   */
  @aiFunction({
    name: 'jigsawstack_ai_search',
    description:
      'Perform web searches and retrieve high-quality results of the given query',
    inputSchema: z.object({
      query: z.string().describe('The search query')
    })
  })
  async aiSearch(params: jigsawstack.SearchParams) {
    return this.ky
      .get('web/search', {
        searchParams: {
          ...params
        }
      })
      .json<jigsawstack.SearchResponse>()
  }

  /**
   * Scrape any website
   */
  @aiFunction({
    name: 'jigsawstack_ai_scrape',
    description: 'Scrape any website',
    inputSchema: z.object({
      url: z.string().describe('The url to scrape its content'),
      element_prompts: z
        .array(z.string())
        .describe(
          'The items to scrape (retrieve) from the given url. eg. Page title, price, etc'
        )
    })
  })
  async aiScrape(params: jigsawstack.ScrapeParams) {
    return this.ky
      .post('ai/scrape', {
        json: {
          ...params
        }
      })
      .json<jigsawstack.ScrapeResponse>()
  }

  /**
   * Recognise, describe and retrieve data within an image with great accuracy.
   */
  @aiFunction({
    name: 'jigsawstack_vocr',
    description:
      'Recognise, describe and retrieve data within an image with great accuracy.',
    inputSchema: z.object({
      url: z.string().describe('The image url to OCR'),
      prompt: z
        .string()
        .default('Describe the image in detail.')
        .describe('What you want to know  or retrieve from the image')
    })
  })
  async vocr(params: jigsawstack.VOCRParams) {
    return this.ky
      .post('vocr', {
        json: {
          ...params
        }
      })
      .json<jigsawstack.VOCRResponse>()
  }

  /**
   * Generate semantically correct SQL queries from text.
   */
  @aiFunction({
    name: 'jigsawstack_text_to_sql',
    description: 'Generate semantically correct SQL queries from text.',
    inputSchema: z.object({
      prompt: z
        .string()
        .describe('The text that will be translated to an SQL query.'),
      sql_schema: z
        .string()
        .describe('The valid sql schema where the query will be run')
    })
  })
  async textToSql(
    params: jigsawstack.TextToSqlParams
  ): Promise<jigsawstack.TextToSqlResponse> {
    return this.ky
      .post('ai/sql', {
        json: {
          ...params
        }
      })
      .json<jigsawstack.TextToSqlResponse>()
  }

  /**
   * Convert audio/video files into accurate text transcriptions instantly.
   */
  @aiFunction({
    name: 'jigsawstack_speech_to_text',
    description:
      'Convert audio/video files into accurate text transcriptions instantly.',
    inputSchema: z.object({
      url: z.string().describe('The audio or video url')
    })
  })
  async speechToText(
    params: jigsawstack.SpeechToTextParams
  ): Promise<jigsawstack.SpeechToTextResponse> {
    return this.ky
      .post('ai/transcribe', {
        json: {
          ...params
        }
      })
      .json<jigsawstack.SpeechToTextResponse>()
  }
}


================================================
FILE: legacy/packages/jigsawstack/src/tool.test.ts
================================================
import { expect, test } from 'vitest'

import { type jigsawstack, JigsawStackClient } from './jigsawstack-client'

const jigsaw = new JigsawStackClient()

test.skip('should run successfully and return the search result', async () => {
  const params: jigsawstack.SearchParams = {
    query: 'The leaning tower of pisa',
    ai_overview: true,
    spell_check: true
  }
  const result = await jigsaw.aiSearch(params)
  expect(result).toBeTruthy()
  expect(result.success).toBe(true)
})

test.skip('should run successfully and return the valid sql result', async () => {
  const params: jigsawstack.TextToSqlParams = {
    sql_schema:
      "CREATE TABLE Transactions (transaction_id INT PRIMARY KEY, user_id INT NOT NULL,total_amount DECIMAL(10, 2 NOT NULL, transaction_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,status VARCHAR(20) DEFAULT 'pending',FOREIGN KEY(user_id) REFERENCES Users(user_id))",
    prompt:
      'Generate a query to get transactions that amount exceed 10000 and sort by when created'
  }

  const result = await jigsaw.textToSql(params)
  expect(result).toBeTruthy()
  expect(result.success).toBe(true)
})

test.skip('should return result.success is true for successful vocr', async () => {
  const result = await jigsaw.vocr({
    prompt: 'Describe the image in detail',
    url: 'https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Collabo%201080x842.jpg?t=2024-03-22T09%3A22%3A48.442Z'
  })
  expect(result.success).toBe(true)
})

test('should run successfully and return the transcribe result', async () => {
  const data = await jigsaw.speechToText({
    url: 'https://rogilvkqloanxtvjfrkm.supabase.co/storage/v1/object/public/demo/Video%201737458382653833217.mp4?t=2024-03-22T09%3A50%3A49.894'
  })
  expect(data).toBeTruthy()
  expect(data.success).toBe(true)
})

test.skip('should run successfully and return scrape result', async () => {
  const params: jigsawstack.ScrapeParams = {
    url: 'https://jigsawstack.com/pricing',
    element_prompts: ['Pro Plan']
  }
  const result = await jigsaw.aiScrape(params)
  expect(result).toBeTruthy()
  expect(result.success).toBe(true)
})


================================================
FILE: legacy/packages/jigsawstack/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/jina/package.json
================================================
{
  "name": "@agentic/jina",
  "version": "7.6.9",
  "description": "Agentic SDK for Jina AI.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/jina"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/jina/src/index.ts
================================================
export * from './jina-client'


================================================
FILE: legacy/packages/jina/src/jina-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  getEnv,
  pruneNullOrUndefined,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace jina {
  export const ReaderFormatSchema = z.enum([
    'text',
    'html',
    'markdown',
    'screenshot'
  ])
  export type ReaderFormat = z.infer<typeof ReaderFormatSchema>

  export const ReaderOptionsSchema = z.object({
    url: z.string().describe('URL to read'),
    timeout: z.number().optional().describe('Optional timeout in seconds'),
    targetSelector: z
      .string()
      .optional()
      .describe(
        "Optional CSS selector to focus on a more specific part of the page. Useful when your desired content doesn't show under the default settings."
      ),
    waitForSelector: z
      .string()
      .optional()
      .describe(
        "Optional CSS selector to wait for before returning. Useful when your desired content doesn't show under the default settings."
      ),
    withGeneratedAlt: z.boolean().optional(),
    withLinksSummary: z.boolean().optional(),
    withImagesSummary: z.boolean().optional(),
    setCookie: z.string().optional(),
    proxyUrl: z.string().optional(),
    noCache: z.boolean().optional(),
    returnFormat: ReaderFormatSchema.optional(),
    json: z.boolean().optional()
  })
  export type ReaderOptions = z.infer<typeof ReaderOptionsSchema>

  export const SearchOptionsSchema = z.object({
    query: z.string().describe('Search query'),
    site: z
      .string()
      .optional()
      .describe(
        'Returns the search results only from the specified website or domain. By default it searches the entire web.'
      ),
    withGeneratedAlt: z.boolean().optional(),
    withLinksSummary: z.boolean().optional(),
    withImagesSummary: z.boolean().optional(),
    withFavicon: z.boolean().optional(),
    setCookie: z.string().optional(),
    proxyUrl: z.string().optional(),
    noCache: z.boolean().optional(),
    returnFormat: ReaderFormatSchema.exclude(['screenshot']).optional(),
    json: z.boolean().optional()
  })
  export type SearchOptions = z.infer<typeof SearchOptionsSchema>

  export interface JinaResponse {
    code: number
    status: number
    data: unknown
  }

  export interface ReaderResponse extends JinaResponse {
    data: ReaderData
  }

  export interface ReaderResponseScreenshot extends JinaResponse {
    data: {
      screenshotUrl: string
    }
  }

  export interface ReaderResponseHtml extends JinaResponse {
    data: {
      html: string
    }
  }

  export interface SearchResponse extends JinaResponse {
    data: ReaderData[]
  }

  export interface ReaderData {
    url: string
    title: string
    content: string
    description?: string
    publishedTime?: string
    favicon?: string
  }
}

/**
 * LLM-friendly URL reader and search client by Jina AI.
 *
 * - Includes a small free tier.
 * - Does not support "stream mode".
 * - Results default to markdown text format.
 * - To return JSON (especially useful for `search`), set `json: true` in the
 *   options.
 *
 * @see https://jina.ai/reader
 */
export class JinaClient extends AIFunctionsProvider {
  protected readonly kyReader: KyInstance
  protected readonly kySearch: KyInstance
  protected readonly apiKey?: string

  constructor({
    apiKey = getEnv('JINA_API_KEY'),
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    super()

    this.apiKey = apiKey

    if (apiKey) {
      ky = ky.extend({ headers: { Authorization: `Bearer ${apiKey}` } })
    }

    ky = ky.extend({ timeout: timeoutMs })

    const throttledKyReader = throttle
      ? throttleKy(
          ky,
          pThrottle({
            limit: apiKey ? 200 : 20,
            interval: 60 * 60 * 1000 // 60 minutes
          })
        )
      : ky
    this.kyReader = throttledKyReader.extend({ prefixUrl: 'https://r.jina.ai' })

    const throttledKySearch = throttle
      ? throttleKy(
          ky,
          pThrottle({
            limit: apiKey ? 40 : 5,
            interval: 60 * 60 * 1000 // 60 minutes
          })
        )
      : ky
    this.kySearch = throttledKySearch.extend({ prefixUrl: 'https://s.jina.ai' })
  }

  /**
   * Reads the contents of the given URL and returns it's main contents in a clean, LLM-friendly format.
   */
  @aiFunction({
    name: 'readUrl',
    description:
      "Reads the contents of the given URL and returns it's main contents in a clean, LLM-friendly format.",
    inputSchema: jina.ReaderOptionsSchema
  })
  async readUrl<T extends string | jina.ReaderOptions>(
    urlOrOptions: T
  ): Promise<
    T extends string
      ? string
      : T extends jina.ReaderOptions
        ? T['json'] extends true
          ? T['returnFormat'] extends 'screenshot'
            ? jina.ReaderResponseScreenshot
            : T['returnFormat'] extends 'html'
              ? jina.ReaderResponseHtml
              : jina.ReaderResponse
          : T['returnFormat'] extends 'screenshot'
            ? ArrayBuffer
            : string
        : never
  > {
    const { url, ...opts } =
      typeof urlOrOptions === 'string'
        ? { url: urlOrOptions }
        : jina.ReaderOptionsSchema.parse(pruneNullOrUndefined(urlOrOptions))
    const headers = this._getHeadersFromOptions(opts)

    const res = this.kyReader.get(url, { headers })

    if (opts.json) {
      return res.json<jina.ReaderResponse>() as any
    } else if (opts.returnFormat === 'screenshot') {
      return res.arrayBuffer() as any
    } else {
      return res.text() as any
    }
  }

  /**
   * Searches the web for the given query and returns the top-5 results including their page contents in a clean, LLM-friendly format.
   */
  @aiFunction({
    name: 'search',
    description:
      'Searches the web for the given query and returns the top-5 results including their page contents in a clean, LLM-friendly format.',
    inputSchema: jina.SearchOptionsSchema
  })
  async search<T extends string | jina.SearchOptions>(
    queryOrOptions: T
  ): Promise<
    T extends string
      ? string
      : T extends jina.SearchOptions
        ? T['json'] extends true
          ? jina.SearchResponse
          : string
        : never
  > {
    const { query, ...opts } =
      typeof queryOrOptions === 'string'
        ? { query: queryOrOptions }
        : jina.SearchOptionsSchema.parse(pruneNullOrUndefined(queryOrOptions))
    const headers = this._getHeadersFromOptions(opts)

    const res = this.kySearch.get(query, { headers })

    if (opts.json) {
      return res.json<jina.SearchResponse>() as any
    } else {
      return res.text() as any
    }
  }

  protected _getHeadersFromOptions(
    options: Record<string, string | boolean | number>
  ) {
    const { json, ...rest } = options

    const headerMap: Record<string, string> = {
      site: 'site',
      timeout: 'x-timeout',
      targetSelector: 'x-target-selector',
      waitForSelector: 'x-wait-for-selector',
      withGeneratedAlt: 'x-with-generated-alt',
      withLinksSummary: 'x-with-links-summary',
      withImagesSummary: 'x-with-images-summary',
      withFavicon: 'x-with-favicon',
      setCookie: 'x-set-cookie',
      proxyUrl: 'x-proxy-url',
      noCache: 'x-no-cache',
      returnFormat: 'x-return-format'
    }

    const headers = Object.fromEntries(
      Object.entries(rest).map(([key, value]) => [
        headerMap[key as string]!,
        String(value)
      ])
    )

    if (json) {
      headers.accept = 'application/json'
    } else if (options.returnFormat !== 'screenshot') {
      headers.accept = 'text/plain'
    }

    return headers
  }
}


================================================
FILE: legacy/packages/jina/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/leadmagic/package.json
================================================
{
  "name": "@agentic/leadmagic",
  "version": "7.6.9",
  "description": "Agentic SDK for LeadMagic.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/leadmagic"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/leadmagic/src/index.ts
================================================
export * from './leadmagic-client'


================================================
FILE: legacy/packages/leadmagic/src/leadmagic-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace leadmagic {
  export const API_BASE_URL = 'https://api.leadmagic.io'

  // Allow up to 300 requests per minute by default.
  // (5 requests per second)
  export const throttle = pThrottle({
    limit: 5,
    interval: 1000
  })

  export interface ProfileSearchOptions {
    linkedinUrl: string
  }

  export interface EnrichedPerson {
    profileUrl: string
    creditsConsumed: number
    firstName: string
    lastName: string
    fullName: string
    headline: string
    userSkills: string
    company_name: string
    company_size: string
    company_industry: string
    company_website: string
    totalTenureMonths: number
    totalTenureDays: number
    totalTenureYears: number
    connections: number
    country: string
    location: string
    about: string
    experiences: Experience[]
    highlights: any[]
  }

  export interface Experience {
    title: string
    subtitle: string
    caption: string
    subComponents: any[]
  }

  export interface EmailFinderOptions {
    first_name: string
    last_name: string
    domain: string
  }

  export interface MobileFinderOptions {
    linkedinUrl: string
  }

  export interface RoleFinderOptions {
    role: string
    domain: string
  }

  export interface CreditsResponse {
    credits: number
  }

  export interface EmailFinderResponse {
    emailAddress: string
    emailScore: number
    domain: string
    firstName: string
    lastName: string
    creditsConsumed: number
  }

  export interface MobileFinderResponse {
    profileUrl: string
    mobileNumber: string
    firstName: string
    lastName: string
    verificationScore: number
    creditsConsumed: number
  }

  export interface RoleFinderResponse {
    matches: RoleMatch[]
    creditsConsumed: number
  }

  export interface RoleMatch {
    fullName: string
    firstName: string
    lastName: string
    headline: string
    profileUrl: string
    emailAddress: string
    score: number
  }
}

/**
 * LeadMagic.io is a B2B person, company, and email enrichment API.
 *
 * @see https://docs.leadmagic.io
 */
export class LeadMagicClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('LEADMAGIC_API_KEY'),
    apiBaseUrl = leadmagic.API_BASE_URL,
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      `LeadMagicClient missing required "apiKey" (defaults to "LEADMAGIC_API_KEY")`
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, leadmagic.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        'X-API-Key': apiKey
      }
    })
  }

  /**
   * Attempts to enrich a person with LeadMagic data based on their public
   * LinkedIn URL.
   */
  @aiFunction({
    name: 'leadmagic_get_person_by_linkedin_url',
    description:
      'Attempts to enrich a person with LeadMagic data based on their LinkedIn profile URL.',
    inputSchema: z.object({
      linkedinUrl: z
        .string()
        .describe(
          'The LinkedIn profile URL of the person to enrich. For example, "https://linkedin.com/in/fisch2"'
        )
    })
  })
  async getPersonByLinkedInUrl(urlOrOpts: leadmagic.ProfileSearchOptions) {
    const opts =
      typeof urlOrOpts === 'string' ? { linkedinUrl: urlOrOpts } : urlOrOpts

    return this.ky
      .post('profile-search', {
        json: {
          profile_url: opts.linkedinUrl
        }
      })
      .json<leadmagic.EnrichedPerson>()
  }

  /**
   * Checks the remaining credits balance for your LeadMagic account.
   */
  @aiFunction({
    name: 'leadmagic_check_credits',
    description:
      'Checks the remaining credits balance for your LeadMagic account.',
    inputSchema: z.object({})
  })
  async checkCredits() {
    return this.ky.post('credits').json()
  }

  /**
   * Finds email addresses based on a person's first name, last name, and company
   * domain.
   */
  @aiFunction({
    name: 'leadmagic_email_finder',
    description:
      "Finds email addresses based on a person's first name, last name, and company domain.",
    inputSchema: z.object({
      first_name: z.string().describe('The first name of the person'),
      last_name: z.string().describe('The last name of the person'),
      domain: z
        .string()
        .describe('The company domain (e.g., "https://company.com")')
    })
  })
  async findEmailsForPerson(opts: leadmagic.EmailFinderOptions) {
    return this.ky
      .post('email-finder', {
        json: {
          first_name: opts.first_name,
          last_name: opts.last_name,
          domain: opts.domain
        }
      })
      .json<leadmagic.EmailFinderResponse>()
  }

  /**
   * Finds mobile/phone numbers based on a person's LinkedIn profile URL.
   */
  @aiFunction({
    name: 'leadmagic_mobile_finder',
    description:
      "Finds mobile/phone numbers based on a person's LinkedIn profile URL.",
    inputSchema: z.object({
      linkedinUrl: z
        .string()
        .describe(
          'The LinkedIn profile URL of the person. For example, `https://linkedin.com/in/fisch2`'
        )
    })
  })
  async findMobilePhoneNumberForPerson(
    urlOrOpts: string | leadmagic.MobileFinderOptions
  ) {
    const opts =
      typeof urlOrOpts === 'string' ? { linkedinUrl: urlOrOpts } : urlOrOpts

    return this.ky
      .post('mobile-finder', {
        json: {
          profile_url: opts.linkedinUrl
        }
      })
      .json<leadmagic.MobileFinderResponse>()
  }

  /**
   * Finds people matching specific job roles at a company based on the company
   * domain.
   */
  @aiFunction({
    name: 'leadmagic_role_finder',
    description:
      'Finds people matching specific job roles at a company based on the company domain.',
    inputSchema: z.object({
      role: z
        .string()
        .describe(
          'The job role/title to search for (e.g., "CTO", "Marketing Manager")'
        ),
      domain: z
        .string()
        .describe('The company domain (e.g., "https://company.com")')
    })
  })
  async findPeopleByRole(opts: leadmagic.RoleFinderOptions) {
    return this.ky
      .post('role-finder', {
        json: {
          role: opts.role,
          domain: opts.domain
        }
      })
      .json<leadmagic.RoleFinderResponse>()
  }
}


================================================
FILE: legacy/packages/leadmagic/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/midjourney/package.json
================================================
{
  "name": "@agentic/midjourney",
  "version": "7.6.9",
  "description": "Agentic SDK for the unofficial Midjourney API via imagineapi.dev.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/midjourney"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/midjourney/src/index.ts
================================================
export * from './midjourney-client'


================================================
FILE: legacy/packages/midjourney/src/midjourney-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  delay,
  getEnv,
  pruneNullOrUndefined,
  TimeoutError
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

// TODO: add additional methods for upscaling, variations, etc.

export namespace midjourney {
  export const API_BASE_URL = 'https://cl.imagineapi.dev'

  export type JobStatus = 'pending' | 'in-progress' | 'completed' | 'failed'

  export interface ImagineResponse {
    data: Job
  }

  export interface Job {
    id: string
    prompt: string
    status: JobStatus
    user_created: string
    date_created: string
    results?: string
    progress?: string
    url?: string
    error?: string
    upscaled_urls?: string[]
    ref?: string
    upscaled?: string[]
  }

  export interface JobOptions {
    wait?: boolean
    timeoutMs?: number
    intervalMs?: number
  }
}

/**
 * Unofficial Midjourney API client for generative images.
 *
 * @see https://www.imagineapi.dev
 */
export class MidjourneyClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('MIDJOURNEY_IMAGINE_API_KEY'),
    apiBaseUrl = midjourney.API_BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'MidjourneyClient missing required "apiKey" (defaults to "MIDJOURNEY_IMAGINE_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: `Bearer ${this.apiKey}`
      }
    })
  }

  /**
   * Creates 4 images from a prompt using the Midjourney API. Useful for generating images on the fly.
   */
  @aiFunction({
    name: 'midjourney_create_images',
    description:
      'Creates 4 images from a prompt using the Midjourney API. Useful for generating images on the fly.',
    inputSchema: z.object({
      prompt: z
        .string()
        .describe(
          'Simple, short, comma-separated list of phrases which describe the image you want to generate'
        )
    })
  })
  async imagine(
    promptOrOptions:
      | string
      | ({
          prompt: string
        } & midjourney.JobOptions)
  ): Promise<midjourney.Job> {
    const {
      wait = true,
      timeoutMs,
      intervalMs,
      ...options
    } = typeof promptOrOptions === 'string'
      ? ({ prompt: promptOrOptions } as {
          prompt: string
        } & midjourney.JobOptions)
      : promptOrOptions

    const res = await this.ky
      .post('items/images', {
        json: { ...options }
      })
      .json<midjourney.ImagineResponse>()

    const job = pruneNullOrUndefined(res.data)
    if (!wait) {
      return job
    }

    if (job.status === 'completed' || job.status === 'failed') {
      return job
    }

    return this.waitForJobById(job.id, {
      timeoutMs,
      intervalMs
    })
  }

  async getJobById(
    jobIdOrOptions:
      | string
      | ({
          jobId: string
        } & midjourney.JobOptions)
  ): Promise<midjourney.Job> {
    const {
      jobId,
      wait = true,
      timeoutMs,
      intervalMs
    } = typeof jobIdOrOptions === 'string'
      ? ({ jobId: jobIdOrOptions } as {
          jobId: string
        } & midjourney.JobOptions)
      : jobIdOrOptions

    const res = await this.ky
      .get(`items/images/${jobId}`)
      .json<midjourney.ImagineResponse>()

    const job = pruneNullOrUndefined(res.data)
    if (!wait) {
      return job
    }

    if (job.status === 'completed' || job.status === 'failed') {
      return job
    }

    return this.waitForJobById(job.id, {
      timeoutMs,
      intervalMs
    })
  }

  async waitForJobById(
    jobId: string,
    {
      timeoutMs = 5 * 60 * 1000, // 5 minutes
      intervalMs = 1000
    }: Omit<midjourney.JobOptions, 'wait'> = {}
  ): Promise<midjourney.Job> {
    const startTimeMs = Date.now()

    function checkForTimeout() {
      const elapsedTimeMs = Date.now() - startTimeMs
      if (elapsedTimeMs >= timeoutMs) {
        throw new TimeoutError(
          `MidjourneyClient timeout waiting for job "${jobId}"`
        )
      }
    }

    do {
      checkForTimeout()

      const job = await this.getJobById(jobId)
      if (job.status === 'completed' || job.status === 'failed') {
        return job
      }

      checkForTimeout()
      await delay(intervalMs)
    } while (true)
  }
}


================================================
FILE: legacy/packages/midjourney/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/notion/package.json
================================================
{
  "name": "@agentic/notion",
  "version": "7.6.9",
  "description": "Agentic SDK for Notion.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/notion"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/notion/src/index.ts
================================================
export * from './notion'
export * from './notion-client'


================================================
FILE: legacy/packages/notion/src/notion-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { notion } from './notion'

/**
 * Agentic Notion client.
 */
export class NotionClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('NOTION_API_KEY'),
    apiBaseUrl = notion.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'NotionClient missing required "apiKey" (defaults to "NOTION_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  /**
   * Get current user.
   */
  @aiFunction({
    name: 'notion_get_self',
    description: `Get current user.`,
    inputSchema: notion.GetSelfParamsSchema
  })
  async getSelf(
    _params: notion.GetSelfParams
  ): Promise<notion.GetSelfResponse> {
    return this.ky.get('/users/me').json<notion.GetSelfResponse>()
  }

  /**
   * Get user.
   */
  @aiFunction({
    name: 'notion_get_user',
    description: `Get user.`,
    inputSchema: notion.GetUserParamsSchema
  })
  async getUser(params: notion.GetUserParams): Promise<notion.GetUserResponse> {
    return this.ky
      .get(`/users/${params.user_id}`)
      .json<notion.GetUserResponse>()
  }

  /**
   * List users.
   */
  @aiFunction({
    name: 'notion_list_users',
    description: `List users.`,
    inputSchema: notion.ListUsersParamsSchema
  })
  async listUsers(
    params: notion.ListUsersParams
  ): Promise<notion.ListUsersResponse> {
    return this.ky
      .get('/users', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListUsersResponse>()
  }

  /**
   * Create page.
   */
  @aiFunction({
    name: 'notion_create_page',
    description: `Create page.`,
    inputSchema: notion.CreatePageParamsSchema
  })
  async createPage(
    params: notion.CreatePageParams
  ): Promise<notion.CreatePageResponse> {
    return this.ky
      .post('/pages', {
        json: pick(params, 'parent', 'properties')
      })
      .json<notion.CreatePageResponse>()
  }

  /**
   * Get page.
   */
  @aiFunction({
    name: 'notion_get_page',
    description: `Get page.`,
    inputSchema: notion.GetPageParamsSchema
  })
  async getPage(params: notion.GetPageParams): Promise<notion.GetPageResponse> {
    return this.ky
      .get(`/pages/${params.page_id}`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties'))
      })
      .json<notion.GetPageResponse>()
  }

  /**
   * Update page.
   */
  @aiFunction({
    name: 'notion_update_page',
    description: `Update page.`,
    inputSchema: notion.UpdatePageParamsSchema
  })
  async updatePage(
    params: notion.UpdatePageParams
  ): Promise<notion.UpdatePageResponse> {
    return this.ky
      .patch(`/pages/${params.page_id}`, {
        json: pick(params, 'properties', 'archived')
      })
      .json<notion.UpdatePageResponse>()
  }

  /**
   * Get page property.
   */
  @aiFunction({
    name: 'notion_get_page_property',
    description: `Get page property.`,
    inputSchema: notion.GetPagePropertyParamsSchema
  })
  async getPageProperty(
    params: notion.GetPagePropertyParams
  ): Promise<notion.GetPagePropertyResponse> {
    return this.ky
      .get(`/pages/${params.page_id}/properties/${params.property_id}`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.GetPagePropertyResponse>()
  }

  /**
   * Get block.
   */
  @aiFunction({
    name: 'notion_get_block',
    description: `Get block.`,
    inputSchema: notion.GetBlockParamsSchema
  })
  async getBlock(
    params: notion.GetBlockParams
  ): Promise<notion.GetBlockResponse> {
    return this.ky
      .get(`/blocks/${params.block_id}`)
      .json<notion.GetBlockResponse>()
  }

  /**
   * Delete block.
   */
  @aiFunction({
    name: 'notion_delete_block',
    description: `Delete block.`,
    inputSchema: notion.DeleteBlockParamsSchema
  })
  async deleteBlock(
    params: notion.DeleteBlockParams
  ): Promise<notion.DeleteBlockResponse> {
    return this.ky
      .delete(`/blocks/${params.block_id}`)
      .json<notion.DeleteBlockResponse>()
  }

  /**
   * Update block.
   */
  @aiFunction({
    name: 'notion_update_block',
    description: `Update block.`,
    inputSchema: notion.UpdateBlockParamsSchema
  })
  async updateBlock(
    params: notion.UpdateBlockParams
  ): Promise<notion.UpdateBlockResponse> {
    return this.ky
      .patch(`/blocks/${params.block_id}`, {
        json: pick(
          params,
          'paragraph',
          'heading_1',
          'heading_2',
          'heading_3',
          'bulleted_list_item',
          'numbered_list_item',
          'quote',
          'to_do',
          'toggle',
          'code',
          'embed',
          'image',
          'video',
          'file',
          'pdf',
          'bookmark',
          'equation',
          'divider',
          'table_of_contents',
          'breadcrumb',
          'column_list',
          'column',
          'link_to_page',
          'table_row',
          'archived'
        )
      })
      .json<notion.UpdateBlockResponse>()
  }

  /**
   * List block children.
   */
  @aiFunction({
    name: 'notion_list_block_children',
    description: `List block children.`,
    inputSchema: notion.ListBlockChildrenParamsSchema
  })
  async listBlockChildren(
    params: notion.ListBlockChildrenParams
  ): Promise<notion.ListBlockChildrenResponse> {
    return this.ky
      .get(`/blocks/${params.block_id}/children`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListBlockChildrenResponse>()
  }

  /**
   * Append block children.
   */
  @aiFunction({
    name: 'notion_append_block_children',
    description: `Append block children.`,
    inputSchema: notion.AppendBlockChildrenParamsSchema
  })
  async appendBlockChildren(
    params: notion.AppendBlockChildrenParams
  ): Promise<notion.AppendBlockChildrenResponse> {
    return this.ky
      .patch(`/blocks/${params.block_id}/children`, {
        json: pick(params, 'children')
      })
      .json<notion.AppendBlockChildrenResponse>()
  }

  /**
   * Get database.
   */
  @aiFunction({
    name: 'notion_get_database',
    description: `Get database.`,
    inputSchema: notion.GetDatabaseParamsSchema
  })
  async getDatabase(
    params: notion.GetDatabaseParams
  ): Promise<notion.GetDatabaseResponse> {
    return this.ky
      .get(`/databases/${params.database_id}`)
      .json<notion.GetDatabaseResponse>()
  }

  /**
   * Update database.
   */
  @aiFunction({
    name: 'notion_update_database',
    description: `Update database.`,
    inputSchema: notion.UpdateDatabaseParamsSchema
  })
  async updateDatabase(
    params: notion.UpdateDatabaseParams
  ): Promise<notion.UpdateDatabaseResponse> {
    return this.ky
      .patch(`/databases/${params.database_id}`, {
        json: pick(
          params,
          'title',
          'description',
          'icon',
          'cover',
          'properties',
          'is_inline',
          'archived'
        )
      })
      .json<notion.UpdateDatabaseResponse>()
  }

  /**
   * Query database.
   */
  @aiFunction({
    name: 'notion_query_database',
    description: `Query database.`,
    inputSchema: notion.QueryDatabaseParamsSchema
  })
  async queryDatabase(
    params: notion.QueryDatabaseParams
  ): Promise<notion.QueryDatabaseResponse> {
    return this.ky
      .post(`/databases/${params.database_id}/query`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties')),
        json: pick(
          params,
          'sorts',
          'filter',
          'start_cursor',
          'page_size',
          'archived'
        )
      })
      .json<notion.QueryDatabaseResponse>()
  }

  /**
   * List databases.
   */
  @aiFunction({
    name: 'notion_list_databases',
    description: `List databases.`,
    inputSchema: notion.ListDatabasesParamsSchema
  })
  async listDatabases(
    params: notion.ListDatabasesParams
  ): Promise<notion.ListDatabasesResponse> {
    return this.ky
      .get('/databases', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListDatabasesResponse>()
  }

  /**
   * Create database.
   */
  @aiFunction({
    name: 'notion_create_database',
    description: `Create database.`,
    inputSchema: notion.CreateDatabaseParamsSchema
  })
  async createDatabase(
    params: notion.CreateDatabaseParams
  ): Promise<notion.CreateDatabaseResponse> {
    return this.ky
      .post('/databases', {
        json: pick(
          params,
          'parent',
          'properties',
          'icon',
          'cover',
          'title',
          'description',
          'is_inline'
        )
      })
      .json<notion.CreateDatabaseResponse>()
  }

  /**
   * Search.
   */
  @aiFunction({
    name: 'notion_search',
    description: `Search.`,
    inputSchema: notion.SearchParamsSchema
  })
  async search(params: notion.SearchParams): Promise<notion.SearchResponse> {
    return this.ky
      .post('/search', {
        json: pick(
          params,
          'query',
          'sort',
          'filter',
          'start_cursor',
          'page_size'
        )
      })
      .json<notion.SearchResponse>()
  }

  /**
   * List comments.
   */
  @aiFunction({
    name: 'notion_list_comments',
    description: `List comments.`,
    inputSchema: notion.ListCommentsParamsSchema
  })
  async listComments(
    params: notion.ListCommentsParams
  ): Promise<notion.ListCommentsResponse> {
    return this.ky
      .get('/comments', {
        searchParams: sanitizeSearchParams(
          pick(params, 'block_id', 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListCommentsResponse>()
  }

  /**
   * Create comment.
   */
  @aiFunction({
    name: 'notion_create_comment',
    description: `Create comment.`,
    // TODO: Improve handling of union params
    inputSchema: notion.CreateCommentParamsSchema as any
  })
  async createComment(
    params: notion.CreateCommentParams
  ): Promise<notion.CreateCommentResponse> {
    return this.ky
      .post('/comments', {
        json: params
      })
      .json<notion.CreateCommentResponse>()
  }

  /**
   * OAuth token.
   */
  @aiFunction({
    name: 'notion_oauth_token',
    description: `OAuth token.`,
    inputSchema: notion.OauthTokenParamsSchema
  })
  async oauthToken(
    params: notion.OauthTokenParams
  ): Promise<notion.OauthTokenResponse> {
    return this.ky
      .post('/oauth/token', {
        json: pick(
          params,
          'grant_type',
          'code',
          'redirect_uri',
          'external_account'
        )
      })
      .json<notion.OauthTokenResponse>()
  }
}


================================================
FILE: legacy/packages/notion/src/notion.ts
================================================
import { z } from 'zod'

export namespace notion {
  export const apiBaseUrl = 'https://api.notion.so'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const UserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string(),
    type: z.enum(['person', 'bot']),
    name: z.string(),
    avatar_url: z.string()
  })
  export type UserObjectResponse = z.infer<typeof UserObjectResponseSchema>

  export const AnnotationRequestSchema = z.object({
    bold: z.boolean().optional(),
    italic: z.boolean().optional(),
    strikethrough: z.boolean().optional(),
    underline: z.boolean().optional(),
    code: z.boolean().optional(),
    color: z
      .enum([
        'default',
        'gray',
        'brown',
        'orange',
        'yellow',
        'green',
        'blue',
        'purple',
        'pink',
        'red',
        'gray_background',
        'brown_background',
        'orange_background',
        'yellow_background',
        'green_background',
        'blue_background',
        'purple_background',
        'pink_background',
        'red_background'
      ])
      .optional()
  })
  export type AnnotationRequest = z.infer<typeof AnnotationRequestSchema>

  export const DateRequestSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]).optional(),
    time_zone: z.union([z.string(), z.null()]).optional()
  })
  export type DateRequest = z.infer<typeof DateRequestSchema>

  export const PageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    archived: z.boolean(),
    url: z.string()
  })
  export type PageObjectResponse = z.infer<typeof PageObjectResponseSchema>

  export const PartialPageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string()
  })
  export type PartialPageObjectResponse = z.infer<
    typeof PartialPageObjectResponseSchema
  >

  export const PropertyItemObjectResponseSchema = z.object({
    type: z.string(),
    id: z.string()
  })
  export type PropertyItemObjectResponse = z.infer<
    typeof PropertyItemObjectResponseSchema
  >

  export const PartialBlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string()
  })
  export type PartialBlockObjectResponse = z.infer<
    typeof PartialBlockObjectResponseSchema
  >

  export const BlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string(),
    type: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    has_children: z.boolean(),
    archived: z.boolean()
  })
  export type BlockObjectResponse = z.infer<typeof BlockObjectResponseSchema>

  export const TitlePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('title'),
    title: z.record(z.any())
  })
  export type TitlePropertyResponse = z.infer<
    typeof TitlePropertyResponseSchema
  >

  export const RichTextPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rich_text'),
    rich_text: z.record(z.any())
  })
  export type RichTextPropertyResponse = z.infer<
    typeof RichTextPropertyResponseSchema
  >

  export const NumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('number'),
    number: z.object({ format: z.string() })
  })
  export type NumberPropertyResponse = z.infer<
    typeof NumberPropertyResponseSchema
  >

  export const SelectOptionSchema = z.object({
    id: z.string(),
    name: z.string(),
    color: z.string()
  })
  export type SelectOption = z.infer<typeof SelectOptionSchema>

  export const DatePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('date'),
    date: z.record(z.any())
  })
  export type DatePropertyResponse = z.infer<typeof DatePropertyResponseSchema>

  export const PeoplePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('people'),
    people: z.record(z.any())
  })
  export type PeoplePropertyResponse = z.infer<
    typeof PeoplePropertyResponseSchema
  >

  export const FilePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('files'),
    files: z.record(z.any())
  })
  export type FilePropertyResponse = z.infer<typeof FilePropertyResponseSchema>

  export const CheckboxPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('checkbox'),
    checkbox: z.record(z.any())
  })
  export type CheckboxPropertyResponse = z.infer<
    typeof CheckboxPropertyResponseSchema
  >

  export const UrlPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('url'),
    url: z.record(z.any())
  })
  export type UrlPropertyResponse = z.infer<typeof UrlPropertyResponseSchema>

  export const EmailPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('email'),
    email: z.record(z.any())
  })
  export type EmailPropertyResponse = z.infer<
    typeof EmailPropertyResponseSchema
  >

  export const PhoneNumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('phone_number'),
    phone_number: z.record(z.any())
  })
  export type PhoneNumberPropertyResponse = z.infer<
    typeof PhoneNumberPropertyResponseSchema
  >

  export const FormulaPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('formula'),
    formula: z.object({ expression: z.string() })
  })
  export type FormulaPropertyResponse = z.infer<
    typeof FormulaPropertyResponseSchema
  >

  export const RelationPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('relation'),
    relation: z.object({
      database_id: z.string(),
      synced_property_name: z.string(),
      synced_property_id: z.string()
    })
  })
  export type RelationPropertyResponse = z.infer<
    typeof RelationPropertyResponseSchema
  >

  export const RollupPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rollup'),
    rollup: z.object({
      relation_property_name: z.string(),
      relation_property_id: z.string(),
      rollup_property_name: z.string(),
      rollup_property_id: z.string(),
      function: z.string()
    })
  })
  export type RollupPropertyResponse = z.infer<
    typeof RollupPropertyResponseSchema
  >

  export const CreatedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_time'),
    created_time: z.record(z.any())
  })
  export type CreatedTimePropertyResponse = z.infer<
    typeof CreatedTimePropertyResponseSchema
  >

  export const CreatedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_by'),
    created_by: z.record(z.any())
  })
  export type CreatedByPropertyResponse = z.infer<
    typeof CreatedByPropertyResponseSchema
  >

  export const LastEditedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_time'),
    last_edited_time: z.record(z.any())
  })
  export type LastEditedTimePropertyResponse = z.infer<
    typeof LastEditedTimePropertyResponseSchema
  >

  export const LastEditedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_by'),
    last_edited_by: z.record(z.any())
  })
  export type LastEditedByPropertyResponse = z.infer<
    typeof LastEditedByPropertyResponseSchema
  >

  export const PartialUserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string()
  })
  export type PartialUserObjectResponse = z.infer<
    typeof PartialUserObjectResponseSchema
  >

  export const AnnotationResponseSchema = z.object({
    bold: z.boolean(),
    italic: z.boolean(),
    strikethrough: z.boolean(),
    underline: z.boolean(),
    code: z.boolean(),
    color: z.enum([
      'default',
      'gray',
      'brown',
      'orange',
      'yellow',
      'green',
      'blue',
      'purple',
      'pink',
      'red',
      'gray_background',
      'brown_background',
      'orange_background',
      'yellow_background',
      'green_background',
      'blue_background',
      'purple_background',
      'pink_background',
      'red_background'
    ])
  })
  export type AnnotationResponse = z.infer<typeof AnnotationResponseSchema>

  export const DateResponseSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]),
    time_zone: z.union([z.string(), z.null()])
  })
  export type DateResponse = z.infer<typeof DateResponseSchema>

  export const PropertyUpdateSchemaSchema = z.object({
    name: z.string().optional(),
    type: z.string().optional()
  })
  export type PropertyUpdateSchema = z.infer<typeof PropertyUpdateSchemaSchema>

  export const TextPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    starts_with: z.string().optional(),
    ends_with: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type TextPropertyFilter = z.infer<typeof TextPropertyFilterSchema>

  export const NumberPropertyFilterSchema = z.object({
    equals: z.number().optional(),
    does_not_equal: z.number().optional(),
    greater_than: z.number().optional(),
    less_than: z.number().optional(),
    greater_than_or_equal_to: z.number().optional(),
    less_than_or_equal_to: z.number().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type NumberPropertyFilter = z.infer<typeof NumberPropertyFilterSchema>

  export const CheckboxPropertyFilterSchema = z.object({
    equals: z.boolean().optional(),
    does_not_equal: z.boolean().optional()
  })
  export type CheckboxPropertyFilter = z.infer<
    typeof CheckboxPropertyFilterSchema
  >

  export const SelectPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type SelectPropertyFilter = z.infer<typeof SelectPropertyFilterSchema>

  export const MultiSelectPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type MultiSelectPropertyFilter = z.infer<
    typeof MultiSelectPropertyFilterSchema
  >

  export const DatePropertyFilterSchema = z.object({
    equals: z.string().optional(),
    before: z.string().optional(),
    after: z.string().optional(),
    on_or_before: z.string().optional(),
    on_or_after: z.string().optional(),
    past_week: z.any().optional(),
    past_month: z.any().optional(),
    past_year: z.any().optional(),
    next_week: z.any().optional(),
    next_month: z.any().optional(),
    next_year: z.any().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type DatePropertyFilter = z.infer<typeof DatePropertyFilterSchema>

  export const PeoplePropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type PeoplePropertyFilter = z.infer<typeof PeoplePropertyFilterSchema>

  export const FilesPropertyFilterSchema = z.object({
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type FilesPropertyFilter = z.infer<typeof FilesPropertyFilterSchema>

  export const RelationPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type RelationPropertyFilter = z.infer<
    typeof RelationPropertyFilterSchema
  >

  export const PropertySchemaSchema = z.object({
    type: z.string(),
    name: z.union([z.string(), z.null()]).optional()
  })
  export type PropertySchema = z.infer<typeof PropertySchemaSchema>

  export const SearchParametersSchema = z.object({
    query: z.string().optional(),
    sort: z
      .object({
        direction: z.enum(['ascending', 'descending']),
        timestamp: z.literal('last_edited_time')
      })
      .optional(),
    filter: z
      .object({
        value: z.enum(['page', 'database']),
        property: z.literal('object')
      })
      .optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type SearchParameters = z.infer<typeof SearchParametersSchema>

  export const PartialCommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string()
  })
  export type PartialCommentObjectResponse = z.infer<
    typeof PartialCommentObjectResponseSchema
  >

  export const OauthTokenParametersSchema = z.object({
    grant_type: z.string(),
    code: z.string(),
    redirect_uri: z.string().optional(),
    external_account: z.object({ key: z.string(), name: z.string() }).optional()
  })
  export type OauthTokenParameters = z.infer<typeof OauthTokenParametersSchema>

  export const ListUsersResponseSchema = z.object({
    results: z.array(UserObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListUsersResponse = z.infer<typeof ListUsersResponseSchema>

  export const PropertyItemListResponseSchema = z.object({
    results: z.array(PropertyItemObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type PropertyItemListResponse = z.infer<
    typeof PropertyItemListResponseSchema
  >

  export const SelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('select'),
    select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type SelectPropertyResponse = z.infer<
    typeof SelectPropertyResponseSchema
  >

  export const MultiSelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('multi_select'),
    multi_select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type MultiSelectPropertyResponse = z.infer<
    typeof MultiSelectPropertyResponseSchema
  >

  export const TextRichTextItemResponseSchema = z.object({
    type: z.literal('text'),
    text: z.object({
      content: z.string(),
      link: z.union([z.object({ url: z.string() }), z.null()])
    }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type TextRichTextItemResponse = z.infer<
    typeof TextRichTextItemResponseSchema
  >

  export const EquationRichTextItemResponseSchema = z.object({
    type: z.literal('equation'),
    equation: z.object({ expression: z.string() }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type EquationRichTextItemResponse = z.infer<
    typeof EquationRichTextItemResponseSchema
  >

  export const ListBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListBlockChildrenResponse = z.infer<
    typeof ListBlockChildrenResponseSchema
  >

  export const AppendBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type AppendBlockChildrenResponse = z.infer<
    typeof AppendBlockChildrenResponseSchema
  >

  export const QueryDatabaseResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PageObjectResponseSchema, PartialPageObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type QueryDatabaseResponse = z.infer<
    typeof QueryDatabaseResponseSchema
  >

  export const OauthTokenResponseSchema = z.object({
    access_token: z.string(),
    token_type: z.literal('bearer'),
    bot_id: z.string(),
    workspace_name: z.union([z.string(), z.null()]),
    workspace_icon: z.union([z.string(), z.null()]),
    workspace_id: z.string(),
    owner: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          UserObjectResponseSchema,
          PartialUserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    duplicated_template_id: z.union([z.string(), z.null()])
  })
  export type OauthTokenResponse = z.infer<typeof OauthTokenResponseSchema>

  export const RichTextItemRequestSchema = z.union([
    z.object({
      text: z.object({
        content: z.string(),
        link: z.union([z.object({ url: z.string() }), z.null()]).optional()
      }),
      type: z.literal('text').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      mention: z.union([
        z.object({
          user: z.union([
            z.object({ id: z.string() }),
            UserObjectResponseSchema
          ])
        }),
        z.object({ page: z.object({ id: z.string() }) }),
        z.object({ database: z.object({ id: z.string() }) }),
        z.object({ date: DateRequestSchema })
      ]),
      type: z.literal('mention').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      equation: z.object({ expression: z.string() }),
      type: z.literal('equation').optional(),
      annotations: AnnotationRequestSchema.optional()
    })
  ])
  export type RichTextItemRequest = z.infer<typeof RichTextItemRequestSchema>

  export const CreatePageParametersSchema = z.object({
    parent: z
      .record(z.any())
      .and(
        z.union([
          z.object({ type: z.literal('page_id'), page_id: z.string() }),
          z.object({ type: z.literal('database_id'), database_id: z.string() })
        ])
      ),
    properties: z.record(
      z.union([
        z.object({ title: z.array(RichTextItemRequestSchema) }),
        z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
        z.object({ number: z.union([z.number(), z.null()]) }),
        z.object({
          select: z.union([z.object({ name: z.string() }), z.null()])
        })
      ])
    )
  })
  export type CreatePageParameters = z.infer<typeof CreatePageParametersSchema>

  export const UpdatePageParametersSchema = z.object({
    properties: z
      .record(
        z.union([
          z.object({ title: z.array(RichTextItemRequestSchema) }),
          z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
          z.object({ number: z.union([z.number(), z.null()]) }),
          z.object({
            select: z.union([z.object({ name: z.string() }), z.null()])
          })
        ])
      )
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdatePageParameters = z.infer<typeof UpdatePageParametersSchema>

  export const UpdateBlockParametersSchema = z.object({
    paragraph: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_1: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_2: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_3: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    bulleted_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    numbered_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    quote: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    to_do: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        checked: z.boolean().optional(),
        color: z.string().optional()
      })
      .optional(),
    toggle: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    code: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        language: z.string().optional()
      })
      .optional(),
    embed: z.object({ url: z.string().optional() }).optional(),
    image: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    video: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    file: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    pdf: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    bookmark: z.object({ url: z.string().optional() }).optional(),
    equation: z.object({ expression: z.string().optional() }).optional(),
    divider: z.record(z.any()).optional(),
    table_of_contents: z.object({ color: z.string().optional() }).optional(),
    breadcrumb: z.record(z.any()).optional(),
    column_list: z.record(z.any()).optional(),
    column: z.record(z.any()).optional(),
    link_to_page: z
      .object({
        type: z.enum(['page_id', 'database_id']).optional(),
        page_id: z.string().optional(),
        database_id: z.string().optional()
      })
      .optional(),
    table_row: z
      .object({ cells: z.array(z.array(RichTextItemRequestSchema)).optional() })
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdateBlockParameters = z.infer<
    typeof UpdateBlockParametersSchema
  >

  export const BlockObjectRequestSchema = z.union([
    z.object({
      object: z.literal('block'),
      type: z.literal('paragraph'),
      paragraph: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_1'),
      heading_1: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_2'),
      heading_2: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_3'),
      heading_3: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bulleted_list_item'),
      bulleted_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('numbered_list_item'),
      numbered_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('to_do'),
      to_do: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        checked: z.boolean(),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('toggle'),
      toggle: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('code'),
      code: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        language: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_page'),
      child_page: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_database'),
      child_database: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('embed'),
      embed: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('image'),
      image: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('video'),
      video: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('file'),
      file: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('pdf'),
      pdf: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bookmark'),
      bookmark: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('equation'),
      equation: z.object({ expression: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('divider'),
      divider: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_of_contents'),
      table_of_contents: z.object({ color: z.string().optional() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column_list'),
      column_list: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column'),
      column: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('link_to_page'),
      link_to_page: z.union([
        z.object({ type: z.literal('page_id'), page_id: z.string() }),
        z.object({ type: z.literal('database_id'), database_id: z.string() })
      ])
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table'),
      table: z.object({
        table_width: z.number().int(),
        has_column_header: z.boolean().optional(),
        has_row_header: z.boolean().optional(),
        children: z.array(
          // TODO: Support recursive types for `BlockObjectRequestSchema`.
          z.any()
        )
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_row'),
      table_row: z.object({
        cells: z.array(z.array(RichTextItemRequestSchema))
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('synced_block'),
      synced_block: z.object({
        synced_from: z
          .union([
            z.object({ type: z.literal('block_id'), block_id: z.string() }),
            z.null()
          ])
          .optional(),
        children: z
          .array(
            // TODO: Support recursive types for `BlockObjectRequestSchema`.
            z.any()
          )
          .optional()
      })
    })
  ])
  export type BlockObjectRequest = z.infer<typeof BlockObjectRequestSchema>

  export const MentionRichTextItemResponseSchema = z.object({
    type: z.literal('mention'),
    mention: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          PartialUserObjectResponseSchema,
          UserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('date'), date: DateResponseSchema }),
      z.object({
        type: z.literal('link_preview'),
        link_preview: z.object({ url: z.string() })
      }),
      z.object({ type: z.literal('page'), page: z.object({ id: z.string() }) }),
      z.object({
        type: z.literal('database'),
        database: z.object({ id: z.string() })
      })
    ]),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type MentionRichTextItemResponse = z.infer<
    typeof MentionRichTextItemResponseSchema
  >

  export const CreateCommentParametersSchema = z.union([
    z.object({
      parent: z.object({
        page_id: z.string(),
        type: z.literal('page_id').optional()
      }),
      rich_text: z.array(RichTextItemRequestSchema)
    }),
    z.object({
      discussion_id: z.string(),
      rich_text: z.array(RichTextItemRequestSchema)
    })
  ])
  export type CreateCommentParameters = z.infer<
    typeof CreateCommentParametersSchema
  >

  export const AppendBlockChildrenParametersSchema = z.object({
    children: z.array(BlockObjectRequestSchema)
  })
  export type AppendBlockChildrenParameters = z.infer<
    typeof AppendBlockChildrenParametersSchema
  >

  export const UpdateDatabaseParametersSchema = z.object({
    title: z.array(RichTextItemRequestSchema).optional(),
    description: z.array(RichTextItemRequestSchema).optional(),
    icon: z
      .union([
        z.object({ emoji: z.string(), type: z.literal('emoji') }),
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    properties: z.record(PropertyUpdateSchemaSchema).optional(),
    is_inline: z.boolean().optional(),
    archived: z.boolean().optional()
  })
  export type UpdateDatabaseParameters = z.infer<
    typeof UpdateDatabaseParametersSchema
  >

  export const CreateDatabaseParametersSchema = z.object({
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('database_id'), database_id: z.string() })
    ]),
    properties: z.record(PropertySchemaSchema),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    title: z.array(RichTextItemRequestSchema),
    description: z.array(RichTextItemRequestSchema).optional(),
    is_inline: z.boolean().optional()
  })
  export type CreateDatabaseParameters = z.infer<
    typeof CreateDatabaseParametersSchema
  >

  export const RichTextItemResponseSchema = z.union([
    TextRichTextItemResponseSchema,
    MentionRichTextItemResponseSchema,
    EquationRichTextItemResponseSchema
  ])
  export type RichTextItemResponse = z.infer<typeof RichTextItemResponseSchema>

  export const CommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string(),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('block_id'), block_id: z.string() })
    ]),
    discussion_id: z.string(),
    rich_text: z.array(RichTextItemResponseSchema),
    created_by: PartialUserObjectResponseSchema,
    created_time: z.string(),
    last_edited_time: z.string()
  })
  export type CommentObjectResponse = z.infer<
    typeof CommentObjectResponseSchema
  >

  export const PropertyFilterSchema = z.union([
    z.object({ property: z.string(), title: TextPropertyFilterSchema }),
    z.object({ property: z.string(), rich_text: TextPropertyFilterSchema }),
    z.object({ property: z.string(), number: NumberPropertyFilterSchema }),
    z.object({ property: z.string(), checkbox: CheckboxPropertyFilterSchema }),
    z.object({ property: z.string(), select: SelectPropertyFilterSchema }),
    z.object({
      property: z.string(),
      multi_select: MultiSelectPropertyFilterSchema
    }),
    z.object({ property: z.string(), date: DatePropertyFilterSchema }),
    z.object({ property: z.string(), people: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), files: FilesPropertyFilterSchema }),
    z.object({ property: z.string(), url: TextPropertyFilterSchema }),
    z.object({ property: z.string(), email: TextPropertyFilterSchema }),
    z.object({ property: z.string(), phone_number: TextPropertyFilterSchema }),
    z.object({ property: z.string(), relation: RelationPropertyFilterSchema }),
    z.object({ property: z.string(), created_by: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), created_time: DatePropertyFilterSchema }),
    z.object({
      property: z.string(),
      last_edited_by: PeoplePropertyFilterSchema
    }),
    z.object({
      property: z.string(),
      last_edited_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      created_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      last_edited_time: DatePropertyFilterSchema
    })
  ])
  export type PropertyFilter = z.infer<typeof PropertyFilterSchema>

  export const ListCommentsResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(CommentObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListCommentsResponse = z.infer<typeof ListCommentsResponseSchema>

  export const CompoundFilterSchema = z.object({
    and: z.array(PropertyFilterSchema).optional(),
    or: z.array(PropertyFilterSchema).optional()
  })
  export type CompoundFilter = z.infer<typeof CompoundFilterSchema>

  export const QueryDatabaseParametersSchema = z.object({
    sorts: z
      .array(
        z.union([
          z.object({
            property: z.string(),
            direction: z.enum(['ascending', 'descending'])
          }),
          z.object({
            timestamp: z.enum(['created_time', 'last_edited_time']),
            direction: z.enum(['ascending', 'descending'])
          })
        ])
      )
      .optional(),
    filter: z.union([PropertyFilterSchema, CompoundFilterSchema]).optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional(),
    archived: z.boolean().optional()
  })
  export type QueryDatabaseParameters = z.infer<
    typeof QueryDatabaseParametersSchema
  >

  export const DatabasePropertyConfigResponseSchema = z.union([
    TitlePropertyResponseSchema,
    RichTextPropertyResponseSchema,
    NumberPropertyResponseSchema,
    SelectPropertyResponseSchema,
    MultiSelectPropertyResponseSchema,
    DatePropertyResponseSchema,
    PeoplePropertyResponseSchema,
    FilePropertyResponseSchema,
    CheckboxPropertyResponseSchema,
    UrlPropertyResponseSchema,
    EmailPropertyResponseSchema,
    PhoneNumberPropertyResponseSchema,
    FormulaPropertyResponseSchema,
    RelationPropertyResponseSchema,
    RollupPropertyResponseSchema,
    CreatedTimePropertyResponseSchema,
    CreatedByPropertyResponseSchema,
    LastEditedTimePropertyResponseSchema,
    LastEditedByPropertyResponseSchema
  ])
  export type DatabasePropertyConfigResponse = z.infer<
    typeof DatabasePropertyConfigResponseSchema
  >

  export const PartialDatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    properties: z.record(DatabasePropertyConfigResponseSchema)
  })
  export type PartialDatabaseObjectResponse = z.infer<
    typeof PartialDatabaseObjectResponseSchema
  >

  export const DatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    created_time: z.string(),
    created_by: PartialUserObjectResponseSchema,
    last_edited_time: z.string(),
    last_edited_by: PartialUserObjectResponseSchema,
    title: z.array(RichTextItemResponseSchema),
    description: z.array(RichTextItemResponseSchema),
    is_inline: z.boolean(),
    properties: z.record(DatabasePropertyConfigResponseSchema),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    url: z.string(),
    archived: z.boolean()
  })
  export type DatabaseObjectResponse = z.infer<
    typeof DatabaseObjectResponseSchema
  >

  export const ListDatabasesResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListDatabasesResponse = z.infer<
    typeof ListDatabasesResponseSchema
  >

  export const SearchResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PageObjectResponseSchema,
        PartialPageObjectResponseSchema,
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type SearchResponse = z.infer<typeof SearchResponseSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetSelfParamsSchema = z.object({})
  export type GetSelfParams = z.infer<typeof GetSelfParamsSchema>

  export const GetSelfResponseSchema = UserObjectResponseSchema
  export type GetSelfResponse = z.infer<typeof GetSelfResponseSchema>

  export const GetUserParamsSchema = z.object({ user_id: z.string() })
  export type GetUserParams = z.infer<typeof GetUserParamsSchema>

  export const GetUserResponseSchema = UserObjectResponseSchema
  export type GetUserResponse = z.infer<typeof GetUserResponseSchema>

  export const ListUsersParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListUsersParams = z.infer<typeof ListUsersParamsSchema>

  export const CreatePageParamsSchema = CreatePageParametersSchema
  export type CreatePageParams = z.infer<typeof CreatePageParamsSchema>

  export const CreatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type CreatePageResponse = z.infer<typeof CreatePageResponseSchema>

  export const GetPageParamsSchema = z.object({
    page_id: z.string(),
    filter_properties: z.array(z.string()).optional()
  })
  export type GetPageParams = z.infer<typeof GetPageParamsSchema>

  export const GetPageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type GetPageResponse = z.infer<typeof GetPageResponseSchema>

  export const UpdatePageParamsSchema = z
    .object({ page_id: z.string() })
    .merge(UpdatePageParametersSchema)
  export type UpdatePageParams = z.infer<typeof UpdatePageParamsSchema>

  export const UpdatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type UpdatePageResponse = z.infer<typeof UpdatePageResponseSchema>

  export const GetPagePropertyParamsSchema = z.object({
    page_id: z.string(),
    property_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type GetPagePropertyParams = z.infer<
    typeof GetPagePropertyParamsSchema
  >

  export const GetPagePropertyResponseSchema = z.union([
    PropertyItemObjectResponseSchema,
    PropertyItemListResponseSchema
  ])
  export type GetPagePropertyResponse = z.infer<
    typeof GetPagePropertyResponseSchema
  >

  export const GetBlockParamsSchema = z.object({ block_id: z.string() })
  export type GetBlockParams = z.infer<typeof GetBlockParamsSchema>

  export const GetBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type GetBlockResponse = z.infer<typeof GetBlockResponseSchema>

  export const DeleteBlockParamsSchema = z.object({ block_id: z.string() })
  export type DeleteBlockParams = z.infer<typeof DeleteBlockParamsSchema>

  export const DeleteBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type DeleteBlockResponse = z.infer<typeof DeleteBlockResponseSchema>

  export const UpdateBlockParamsSchema = z
    .object({ block_id: z.string() })
    .merge(UpdateBlockParametersSchema)
  export type UpdateBlockParams = z.infer<typeof UpdateBlockParamsSchema>

  export const UpdateBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type UpdateBlockResponse = z.infer<typeof UpdateBlockResponseSchema>

  export const ListBlockChildrenParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListBlockChildrenParams = z.infer<
    typeof ListBlockChildrenParamsSchema
  >

  export const AppendBlockChildrenParamsSchema = z
    .object({ block_id: z.string() })
    .merge(AppendBlockChildrenParametersSchema)
  export type AppendBlockChildrenParams = z.infer<
    typeof AppendBlockChildrenParamsSchema
  >

  export const GetDatabaseParamsSchema = z.object({ database_id: z.string() })
  export type GetDatabaseParams = z.infer<typeof GetDatabaseParamsSchema>

  export const GetDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type GetDatabaseResponse = z.infer<typeof GetDatabaseResponseSchema>

  export const UpdateDatabaseParamsSchema = z
    .object({ database_id: z.string() })
    .merge(UpdateDatabaseParametersSchema)
  export type UpdateDatabaseParams = z.infer<typeof UpdateDatabaseParamsSchema>

  export const UpdateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type UpdateDatabaseResponse = z.infer<
    typeof UpdateDatabaseResponseSchema
  >

  export const QueryDatabaseParamsSchema = z
    .object({
      database_id: z.string(),
      filter_properties: z.array(z.string()).optional()
    })
    .merge(QueryDatabaseParametersSchema)
  export type QueryDatabaseParams = z.infer<typeof QueryDatabaseParamsSchema>

  export const ListDatabasesParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListDatabasesParams = z.infer<typeof ListDatabasesParamsSchema>

  export const CreateDatabaseParamsSchema = CreateDatabaseParametersSchema
  export type CreateDatabaseParams = z.infer<typeof CreateDatabaseParamsSchema>

  export const CreateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type CreateDatabaseResponse = z.infer<
    typeof CreateDatabaseResponseSchema
  >

  export const SearchParamsSchema = SearchParametersSchema
  export type SearchParams = z.infer<typeof SearchParamsSchema>

  export const ListCommentsParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListCommentsParams = z.infer<typeof ListCommentsParamsSchema>

  export const CreateCommentParamsSchema = CreateCommentParametersSchema
  export type CreateCommentParams = z.infer<typeof CreateCommentParamsSchema>

  export const CreateCommentResponseSchema = z.union([
    CommentObjectResponseSchema,
    PartialCommentObjectResponseSchema
  ])
  export type CreateCommentResponse = z.infer<
    typeof CreateCommentResponseSchema
  >

  export const OauthTokenParamsSchema = OauthTokenParametersSchema
  export type OauthTokenParams = z.infer<typeof OauthTokenParamsSchema>
}


================================================
FILE: legacy/packages/notion/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/novu/package.json
================================================
{
  "name": "@agentic/novu",
  "version": "7.6.9",
  "description": "Agentic SDK for the Novu notifications API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/novu"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/novu/src/index.ts
================================================
export * from './novu-client'


================================================
FILE: legacy/packages/novu/src/novu-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace novu {
  export const API_BASE_URL = 'https://api.novu.co/v1'

  /**
   * Novu subscriber object.
   */
  export type Subscriber = {
    /**
     * Unique identifier for the subscriber. This can be any value that is meaningful to your application such as a user ID stored in your database or a unique email address.
     */
    subscriberId: string

    /**
     * Email address of the subscriber.
     */
    email?: string

    /**
     * First name of the subscriber.
     */
    firstName?: string

    /**
     * Last name of the subscriber.
     */
    lastName?: string

    /**
     * Phone number of the subscriber.
     */
    phone?: string
  }

  /**
   * Response from the Novu API when triggering an event.
   *
   * @see {@link https://docs.novu.co/api/client-libraries#trigger-event}
   */
  export type TriggerEventResponse = {
    /**
     * Data about the triggered event.
     */
    data: {
      /**
       * Whether the trigger was acknowledged or not.
       */
      acknowledged?: boolean

      /**
       * Status for trigger.
       */
      status?: string

      /**
       * Transaction id for trigger.
       */
      transactionId?: string

      /**
       * In case of an error, this field will contain the error message.
       */
      error?: Array<any>
    }
  }

  /**
   * Options for triggering an event in Novu.
   */
  export type TriggerOptions = {
    /**
     * Name of the event to trigger. This should match the name of an existing notification template in Novu.
     */
    name: string

    /**
     * Payload to use for the event. This will be used to populate any handlebars placeholders in the notification template.
     */
    payload: Record<string, unknown>

    /**
     * List of subscribers to send the notification to. Each subscriber must at least have a unique `subscriberId` to identify them in Novu and, if not already known to Novu, an `email` address or `phone` number depending on the notification template being used.
     */
    to: Subscriber[]
  }
}

/**
 * The Novu API provides a router for sending notifications across different
 * channels like Email, SMS, Chat, In-App, and Push.
 *
 * @see https://novu.co
 */
export class NovuClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('NOVU_API_KEY'),
    apiBaseUrl = novu.API_BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'NovuClient missing required "apiKey" (defaults to "NOVU_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      headers: {
        Authorization: `ApiKey ${this.apiKey}`
      }
    })
  }

  /**
   * Triggers an event in Novu.
   *
   * @see https://docs.novu.co/api-reference/events/trigger-event
   */
  @aiFunction({
    name: 'novu_trigger_event',
    description:
      'Sends a notification to a person given their novu `subscriberId` and an `email` or `phone` number. Useful for sending emails or SMS text messages to people.',
    inputSchema: z.object({
      name: z.string(),
      // TODO: make this more
      payload: z.record(z.any()),
      to: z.array(
        z.object({
          subscriberId: z.string(),
          email: z.string().optional(),
          firstName: z.string().optional(),
          lastName: z.string().optional(),
          phone: z.string().optional()
        })
      )
    })
  })
  async triggerEvent(options: novu.TriggerOptions) {
    return this.ky
      .post('events/trigger', {
        json: options
      })
      .json<novu.TriggerEventResponse>()
  }
}


================================================
FILE: legacy/packages/novu/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/open-meteo/package.json
================================================
{
  "name": "@agentic/open-meteo",
  "version": "7.6.9",
  "description": "Agentic SDK for the Open-Meteo weather API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/open-meteo"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/open-meteo/src/index.ts
================================================
export * from './open-meteo'
export * from './open-meteo-client'


================================================
FILE: legacy/packages/open-meteo/src/open-meteo-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  getEnv,
  omit,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { openmeteo } from './open-meteo'

/**
 * Agentic OpenMeteo weather client.
 *
 * Open-Meteo offers free weather forecast APIs for open-source developers
 * and non-commercial use.
 *
 * @note The API key is optional.
 *
 * @see https://open-meteo.com/en/docs
 */
export class OpenMeteoClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string | undefined
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('OPEN_METEO_API_KEY'),
    apiBaseUrl = openmeteo.apiBaseUrl,
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      ...(apiKey
        ? {
            headers: {
              Authorization: `Bearer ${apiKey}`
            }
          }
        : {})
    })
  }

  /**
   * Gets the 7-day weather variables in hourly and daily resolution for given
   * WGS84 latitude and longitude coordinates. Available worldwide.
   */
  @aiFunction({
    name: 'open_meteo_get_forecast',
    description: `Gets the 7-day weather forecast in hourly and daily resolution for given location. Available worldwide.`,
    inputSchema: openmeteo.GetV1ForecastParamsSchema
  })
  async getForecast(
    params: openmeteo.GetV1ForecastParams
  ): Promise<openmeteo.GetV1ForecastResponse> {
    const extractLocation = async (): Promise<openmeteo.Location> => {
      if ('name' in params.location) {
        const response = await this._geocode(params.location)
        return pick(response, 'latitude', 'longitude')
      }

      return params.location
    }

    const { start, end } = validateAndSetDates(params.startDate, params.endDate)

    const response = await this.ky
      .get('forecast', {
        searchParams: sanitizeSearchParams({
          ...(await extractLocation()),
          temperature_unit: params.temperatureUnit,
          start_date: toDateString(start),
          end_date: toDateString(end),
          current: [
            'temperature_2m',
            'rain',
            'relative_humidity_2m',
            'wind_speed_10m'
          ],
          daily: ['temperature_2m_max', 'temperature_2m_min', 'rain_sum'],
          hourly: ['temperature_2m', 'relative_humidity_2m', 'rain'],
          timezone: 'UTC'
        })
      })
      .json<openmeteo.GetV1ForecastResponse>()

    return omit(
      response,
      'latitude',
      'longitude',
      'elevation',
      'generationtime_ms',
      'utc_offset_seconds',
      'timezone',
      'timezone_abbreviation',
      'elevation',
      'hourly',
      'hourly_units'
    )
  }

  protected async _geocode(
    location: openmeteo.LocationSearch
  ): Promise<openmeteo.Location> {
    const { results } = await this.ky
      .get('search', {
        searchParams: sanitizeSearchParams({
          name: location.name,
          language: location.language,
          country: location.country,
          format: 'json',
          count: 1
        })
      })
      .json<any>()

    if (!results?.length) {
      throw new Error(`No results found for location "${location.name}"`)
    }

    return results[0]
  }
}

function toDateString(date: Date): string {
  return date.toISOString().split('T')[0]!
}

function validateAndSetDates(
  startDateStr: string,
  endDateStr?: string
): { start: Date; end: Date } {
  const now = new Date()
  const start = startDateStr
    ? new Date(startDateStr)
    : new Date(Date.UTC(now.getFullYear(), now.getMonth(), now.getDate()))

  if (endDateStr) {
    const end = new Date(endDateStr)
    if (end < start) {
      throw new Error(
        `The 'end_date' (${endDateStr}) has to occur on or after the 'start_date' (${startDateStr}).`
      )
    }
    return { start, end }
  } else {
    // If endDate is undefined, set it to the start date
    return { start, end: new Date(start) }
  }
}


================================================
FILE: legacy/packages/open-meteo/src/open-meteo.ts
================================================
import { z } from 'zod'

export namespace openmeteo {
  export const apiBaseUrl = 'https://api.open-meteo.com/v1'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  /** For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps. */
  export const HourlyResponseSchema = z
    .object({
      time: z.array(z.string()),
      temperature_2m: z.array(z.number()).optional(),
      relative_humidity_2m: z.array(z.number()).optional(),
      dew_point_2m: z.array(z.number()).optional(),
      apparent_temperature: z.array(z.number()).optional(),
      pressure_msl: z.array(z.number()).optional(),
      cloud_cover: z.array(z.number()).optional(),
      cloud_cover_low: z.array(z.number()).optional(),
      cloud_cover_mid: z.array(z.number()).optional(),
      cloud_cover_high: z.array(z.number()).optional(),
      wind_speed_10m: z.array(z.number()).optional(),
      wind_speed_80m: z.array(z.number()).optional(),
      wind_speed_120m: z.array(z.number()).optional(),
      wind_speed_180m: z.array(z.number()).optional(),
      wind_direction_10m: z.array(z.number()).optional(),
      wind_direction_80m: z.array(z.number()).optional(),
      wind_direction_120m: z.array(z.number()).optional(),
      wind_direction_180m: z.array(z.number()).optional(),
      wind_gusts_10m: z.array(z.number()).optional(),
      shortwave_radiation: z.array(z.number()).optional(),
      direct_radiation: z.array(z.number()).optional(),
      direct_normal_irradiance: z.array(z.number()).optional(),
      diffuse_radiation: z.array(z.number()).optional(),
      vapour_pressure_deficit: z.array(z.number()).optional(),
      evapotranspiration: z.array(z.number()).optional(),
      precipitation: z.array(z.number()).optional(),
      weather_code: z.array(z.number()).optional(),
      snow_height: z.array(z.number()).optional(),
      freezing_level_height: z.array(z.number()).optional(),
      soil_temperature_0cm: z.array(z.number()).optional(),
      soil_temperature_6cm: z.array(z.number()).optional(),
      soil_temperature_18cm: z.array(z.number()).optional(),
      soil_temperature_54cm: z.array(z.number()).optional(),
      soil_moisture_0_1cm: z.array(z.number()).optional(),
      soil_moisture_1_3cm: z.array(z.number()).optional(),
      soil_moisture_3_9cm: z.array(z.number()).optional(),
      soil_moisture_9_27cm: z.array(z.number()).optional(),
      soil_moisture_27_81cm: z.array(z.number()).optional()
    })
    .describe(
      'For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.'
    )
  export type HourlyResponse = z.infer<typeof HourlyResponseSchema>

  /** For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps. */
  export const DailyResponseSchema = z
    .object({
      time: z.array(z.string()),
      temperature_2m_max: z.array(z.number()).optional(),
      temperature_2m_min: z.array(z.number()).optional(),
      apparent_temperature_max: z.array(z.number()).optional(),
      apparent_temperature_min: z.array(z.number()).optional(),
      precipitation_sum: z.array(z.number()).optional(),
      precipitation_hours: z.array(z.number()).optional(),
      weather_code: z.array(z.number()).optional(),
      sunrise: z.array(z.number()).optional(),
      sunset: z.array(z.number()).optional(),
      wind_speed_10m_max: z.array(z.number()).optional(),
      wind_gusts_10m_max: z.array(z.number()).optional(),
      wind_direction_10m_dominant: z.array(z.number()).optional(),
      shortwave_radiation_sum: z.array(z.number()).optional(),
      uv_index_max: z.array(z.number()).optional(),
      uv_index_clear_sky_max: z.array(z.number()).optional(),
      et0_fao_evapotranspiration: z.array(z.number()).optional()
    })
    .describe(
      'For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.'
    )
  export type DailyResponse = z.infer<typeof DailyResponseSchema>

  /** Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code */
  export const CurrentWeatherSchema = z
    .object({
      time: z.string(),
      temperature: z.number(),
      wind_speed: z.number(),
      wind_direction: z.number(),
      weather_code: z.number().int()
    })
    .describe(
      'Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code'
    )
  export type CurrentWeather = z.infer<typeof CurrentWeatherSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetV1ForecastParamsSchema = z.object({
    location: z.union([
      z
        .object({
          name: z.string().min(1),
          country: z.string().optional(),
          language: z.string().default('English')
        })
        .strip(),
      z
        .object({
          latitude: z.coerce.number(),
          longitude: z.coerce.number()
        })
        .strip()
    ]),
    startDate: z
      .string()
      .date()
      .describe(
        'Start date for the weather forecast in the format YYYY-MM-DD (UTC)'
      ),
    endDate: z
      .string()
      .date()
      .describe(
        'End date for the weather forecast in the format YYYY-MM-DD (UTC)'
      )
      .optional(),
    temperatureUnit: z.enum(['celsius', 'fahrenheit']).default('fahrenheit')
  })
  export type GetV1ForecastParams = z.infer<typeof GetV1ForecastParamsSchema>

  export const GetV1ForecastResponseSchema = z.object({
    /** WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away. */
    latitude: z
      .number()
      .describe(
        'WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.'
      )
      .optional(),
    /** WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away. */
    longitude: z
      .number()
      .describe(
        'WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.'
      )
      .optional(),
    /** The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect. */
    elevation: z
      .number()
      .describe(
        'The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.'
      )
      .optional(),
    /** Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements. */
    generationtime_ms: z
      .number()
      .describe(
        'Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.'
      )
      .optional(),
    /** Applied timezone offset from the &timezone= parameter. */
    utc_offset_seconds: z
      .number()
      .int()
      .describe('Applied timezone offset from the &timezone= parameter.')
      .optional(),
    hourly: HourlyResponseSchema.optional(),
    /** For each selected weather variable, the unit will be listed here. */
    hourly_units: z
      .record(z.string())
      .describe(
        'For each selected weather variable, the unit will be listed here.'
      )
      .optional(),
    daily: DailyResponseSchema.optional(),
    /** For each selected daily weather variable, the unit will be listed here. */
    daily_units: z
      .record(z.string())
      .describe(
        'For each selected daily weather variable, the unit will be listed here.'
      )
      .optional(),
    current_weather: CurrentWeatherSchema.optional()
  })
  export type GetV1ForecastResponse = z.infer<
    typeof GetV1ForecastResponseSchema
  >

  export interface Location {
    latitude: number
    longitude: number
  }

  export interface LocationSearch {
    name: string
    country?: string
    language?: string
  }
}


================================================
FILE: legacy/packages/open-meteo/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/openapi-to-ts/bin/openapi-to-ts.ts
================================================
#!/usr/bin/env node

import { cli } from 'cleye'
import { gracefulExit } from 'exit-hook'

import { generateTSFromOpenAPI } from '../src'

async function main() {
  const args = cli(
    {
      name: 'openapi-to-ts',
      parameters: ['<openapi file path>'],
      flags: {
        debug: {
          type: Boolean,
          description: 'Enables verbose debug logging',
          alias: 'v',
          default: false
        },
        outputDir: {
          type: String,
          description: 'Path to the output directory (defaults to cwd)',
          alias: 'o'
        },
        dryRun: {
          type: Boolean,
          description: 'Disables all side effects',
          default: false
        },
        noPrettier: {
          type: Boolean,
          description: 'Disables prettier formatting',
          default: false
        },
        noEslint: {
          type: Boolean,
          description: 'Disables eslint formatting',
          default: false
        },
        noZodJsDocs: {
          type: Boolean,
          description: 'Disables js docs for zod schemas',
          default: false
        }
      }
    },
    () => {},
    process.argv
  )

  const openapiFilePath = args._[2]!

  if (!openapiFilePath) {
    console.error('Missing required argument: <openapi file path>\n')
    args.showHelp()
    gracefulExit(1)
    return
  }

  if (Object.keys(args.unknownFlags).length) {
    console.error(
      'Unknown flags:',
      Object.keys(args.unknownFlags).join(', '),
      '\n'
    )
    args.showHelp()
    gracefulExit(1)
    return
  }

  const output = await generateTSFromOpenAPI({
    openapiFilePath,
    outputDir: args.flags.outputDir || process.cwd(),
    dryRun: args.flags.dryRun,
    prettier: !args.flags.noPrettier,
    eslint: !args.flags.noEslint,
    zodSchemaJsDocs: !args.flags.noZodJsDocs
  })

  if (args.flags.dryRun) {
    console.log(output)
  }
}

try {
  await main()
  gracefulExit(0)
} catch (err) {
  console.error(err)
  gracefulExit(1)
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/firecrawl-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pick
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { firecrawl } from './firecrawl'

/**
 * Agentic Firecrawl client.
 *
 * API for interacting with Firecrawl services to perform web scraping and crawling tasks.
 */
export class FirecrawlClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('FIRECRAWL_API_KEY'),
    apiBaseUrl = firecrawl.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'FirecrawlClient missing required "apiKey" (defaults to "FIRECRAWL_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: apiKey
      }
    })
  }

  /**
   * Scrape a single URL.
   */
  @aiFunction({
    name: 'firecrawl_scrape',
    description: `Scrape a single URL.`,
    inputSchema: firecrawl.ScrapeParamsSchema,
    tags: ['Scraping']
  })
  async scrape(
    params: firecrawl.ScrapeParams
  ): Promise<firecrawl.ScrapeResponse> {
    return this.ky
      .post('/scrape', {
        json: pick(
          params,
          'url',
          'formats',
          'headers',
          'includeTags',
          'excludeTags',
          'onlyMainContent',
          'timeout',
          'waitFor'
        )
      })
      .json<firecrawl.ScrapeResponse>()
  }

  /**
   * Crawl multiple URLs based on options.
   */
  @aiFunction({
    name: 'firecrawl_crawl_urls',
    description: `Crawl multiple URLs based on options.`,
    inputSchema: firecrawl.CrawlUrlsParamsSchema,
    tags: ['Crawling']
  })
  async crawlUrls(
    params: firecrawl.CrawlUrlsParams
  ): Promise<firecrawl.CrawlUrlsResponse> {
    return this.ky
      .post('/crawl', {
        json: pick(params, 'url', 'crawlerOptions', 'pageOptions')
      })
      .json<firecrawl.CrawlUrlsResponse>()
  }

  /**
   * Search for a keyword in Google, returns top page results with markdown content for each page.
   */
  @aiFunction({
    name: 'firecrawl_search_google',
    description: `Search for a keyword in Google, returns top page results with markdown content for each page.`,
    inputSchema: firecrawl.SearchGoogleParamsSchema,
    tags: ['Search']
  })
  async searchGoogle(
    params: firecrawl.SearchGoogleParams
  ): Promise<firecrawl.SearchGoogleResponse> {
    return this.ky
      .post('/search', {
        json: pick(params, 'query', 'pageOptions', 'searchOptions')
      })
      .json<firecrawl.SearchGoogleResponse>()
  }

  /**
   * Get the status of a crawl job.
   */
  @aiFunction({
    name: 'firecrawl_get_crawl_status',
    description: `Get the status of a crawl job.`,
    inputSchema: firecrawl.GetCrawlStatusParamsSchema,
    tags: ['Crawl']
  })
  async getCrawlStatus(
    params: firecrawl.GetCrawlStatusParams
  ): Promise<firecrawl.GetCrawlStatusResponse> {
    return this.ky
      .get(`/crawl/status/${params.jobId}`)
      .json<firecrawl.GetCrawlStatusResponse>()
  }

  /**
   * Cancel a crawl job.
   */
  @aiFunction({
    name: 'firecrawl_cancel_crawl_job',
    description: `Cancel a crawl job.`,
    inputSchema: firecrawl.CancelCrawlJobParamsSchema,
    tags: ['Crawl']
  })
  async cancelCrawlJob(
    params: firecrawl.CancelCrawlJobParams
  ): Promise<firecrawl.CancelCrawlJobResponse> {
    return this.ky
      .delete(`/crawl/cancel/${params.jobId}`)
      .json<firecrawl.CancelCrawlJobResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/firecrawl.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace firecrawl {
  export const apiBaseUrl = 'https://api.firecrawl.dev/v0'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const ScrapeResponseSchema = z.object({
    success: z.boolean().optional(),
    /** Warning message to let you know of any issues. */
    warning: z
      .string()
      .describe('Warning message to let you know of any issues.')
      .optional(),
    data: z
      .object({
        /** Markdown content of the page if the `markdown` format was specified (default) */
        markdown: z
          .string()
          .describe(
            'Markdown content of the page if the `markdown` format was specified (default)'
          )
          .optional(),
        /** HTML version of the content on page if the `html` format was specified */
        html: z
          .string()
          .describe(
            'HTML version of the content on page if the `html` format was specified'
          )
          .optional(),
        /** Raw HTML content of the page if the `rawHtml` format was specified */
        rawHtml: z
          .string()
          .describe(
            'Raw HTML content of the page if the `rawHtml` format was specified'
          )
          .optional(),
        /** Links on the page if the `links` format was specified */
        links: z
          .array(z.string().url())
          .describe('Links on the page if the `links` format was specified')
          .optional(),
        /** URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified */
        screenshot: z
          .string()
          .describe(
            'URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified'
          )
          .optional(),
        metadata: z
          .object({
            title: z.string().optional(),
            description: z.string().optional(),
            language: z.string().optional(),
            sourceURL: z.string().url().optional(),
            '<any other metadata> ': z.string().optional(),
            /** The status code of the page */
            statusCode: z
              .number()
              .int()
              .describe('The status code of the page')
              .optional(),
            /** The error message of the page */
            error: z
              .string()
              .describe('The error message of the page')
              .optional()
          })
          .optional()
      })
      .optional()
  })
  export type ScrapeResponse = z.infer<typeof ScrapeResponseSchema>

  export const CrawlResponseSchema = z.object({
    success: z.boolean().optional(),
    id: z.string().optional(),
    url: z.string().url().optional()
  })
  export type CrawlResponse = z.infer<typeof CrawlResponseSchema>

  export const SearchResponseSchema = z.object({
    success: z.boolean().optional(),
    data: z.array(z.any()).optional()
  })
  export type SearchResponse = z.infer<typeof SearchResponseSchema>

  export const CrawlStatusResponseObjSchema = z.object({
    /** Markdown content of the page if the `markdown` format was specified (default) */
    markdown: z
      .string()
      .describe(
        'Markdown content of the page if the `markdown` format was specified (default)'
      )
      .optional(),
    /** HTML version of the content on page if the `html` format was specified */
    html: z
      .string()
      .describe(
        'HTML version of the content on page if the `html` format was specified'
      )
      .optional(),
    /** Raw HTML content of the page if the `rawHtml` format was specified */
    rawHtml: z
      .string()
      .describe(
        'Raw HTML content of the page if the `rawHtml` format was specified'
      )
      .optional(),
    /** Links on the page if the `links` format was specified */
    links: z
      .array(z.string().url())
      .describe('Links on the page if the `links` format was specified')
      .optional(),
    /** URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified */
    screenshot: z
      .string()
      .describe(
        'URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified'
      )
      .optional(),
    metadata: z
      .object({
        title: z.string().optional(),
        description: z.string().optional(),
        language: z.string().optional(),
        sourceURL: z.string().url().optional(),
        '<any other metadata> ': z.string().optional(),
        /** The status code of the page */
        statusCode: z
          .number()
          .int()
          .describe('The status code of the page')
          .optional(),
        /** The error message of the page */
        error: z.string().describe('The error message of the page').optional()
      })
      .optional()
  })
  export type CrawlStatusResponseObj = z.infer<
    typeof CrawlStatusResponseObjSchema
  >

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const ScrapeParamsSchema = z.object({
    /** The URL to scrape */
    url: z.string().url().describe('The URL to scrape'),
    /**
     * Specific formats to return.
     *
     *  - markdown: The page in Markdown format.
     *  - html: The page's HTML, trimmed to include only meaningful content.
     *  - rawHtml: The page's original HTML.
     *  - links: The links on the page.
     *  - screenshot: A screenshot of the top of the page.
     *  - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)
     */
    formats: z
      .array(
        z.enum([
          'markdown',
          'html',
          'rawHtml',
          'links',
          'screenshot',
          'screenshot@fullPage'
        ])
      )
      .describe(
        "Specific formats to return.\n\n - markdown: The page in Markdown format.\n - html: The page's HTML, trimmed to include only meaningful content.\n - rawHtml: The page's original HTML.\n - links: The links on the page.\n - screenshot: A screenshot of the top of the page.\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)"
      )
      .default(['markdown']),
    /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */
    headers: z
      .record(z.any())
      .describe(
        'Headers to send with the request. Can be used to send cookies, user-agent, etc.'
      )
      .optional(),
    /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */
    includeTags: z
      .array(z.string())
      .describe(
        "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
      )
      .optional(),
    /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */
    excludeTags: z
      .array(z.string())
      .describe(
        "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
      )
      .optional(),
    /** Only return the main content of the page excluding headers, navs, footers, etc. */
    onlyMainContent: z
      .boolean()
      .describe(
        'Only return the main content of the page excluding headers, navs, footers, etc.'
      )
      .default(true),
    /** Timeout in milliseconds for the request */
    timeout: z
      .number()
      .int()
      .describe('Timeout in milliseconds for the request')
      .default(30_000),
    /** Wait x amount of milliseconds for the page to load to fetch content */
    waitFor: z
      .number()
      .int()
      .describe(
        'Wait x amount of milliseconds for the page to load to fetch content'
      )
      .default(0)
  })
  export type ScrapeParams = z.infer<typeof ScrapeParamsSchema>

  export const CrawlUrlsParamsSchema = z.object({
    /** The base URL to start crawling from */
    url: z.string().url().describe('The base URL to start crawling from'),
    crawlerOptions: z
      .object({
        /** URL patterns to include */
        includes: z
          .array(z.string())
          .describe('URL patterns to include')
          .optional(),
        /** URL patterns to exclude */
        excludes: z
          .array(z.string())
          .describe('URL patterns to exclude')
          .optional(),
        /** Generate alt text for images using LLMs (must have a paid plan) */
        generateImgAltText: z
          .boolean()
          .describe(
            'Generate alt text for images using LLMs (must have a paid plan)'
          )
          .default(false),
        /** If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents. */
        returnOnlyUrls: z
          .boolean()
          .describe(
            'If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.'
          )
          .default(false),
        /** Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern. */
        maxDepth: z
          .number()
          .int()
          .describe(
            'Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.'
          )
          .optional(),
        /** The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites. */
        mode: z
          .enum(['default', 'fast'])
          .describe(
            "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites."
          )
          .default('default'),
        /** Ignore the website sitemap when crawling */
        ignoreSitemap: z
          .boolean()
          .describe('Ignore the website sitemap when crawling')
          .default(false),
        /** Maximum number of pages to crawl */
        limit: z
          .number()
          .int()
          .describe('Maximum number of pages to crawl')
          .default(10_000),
        /** Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product' */
        allowBackwardCrawling: z
          .boolean()
          .describe(
            "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'"
          )
          .default(false),
        /** Allows the crawler to follow links to external websites. */
        allowExternalContentLinks: z
          .boolean()
          .describe('Allows the crawler to follow links to external websites.')
          .default(false)
      })
      .optional(),
    pageOptions: z
      .object({
        /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */
        headers: z
          .record(z.any())
          .describe(
            'Headers to send with the request. Can be used to send cookies, user-agent, etc.'
          )
          .optional(),
        /** Include the HTML version of the content on page. Will output a html key in the response. */
        includeHtml: z
          .boolean()
          .describe(
            'Include the HTML version of the content on page. Will output a html key in the response.'
          )
          .default(false),
        /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */
        includeRawHtml: z
          .boolean()
          .describe(
            'Include the raw HTML content of the page. Will output a rawHtml key in the response.'
          )
          .default(false),
        /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */
        onlyIncludeTags: z
          .array(z.string())
          .describe(
            "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
          )
          .optional(),
        /** Only return the main content of the page excluding headers, navs, footers, etc. */
        onlyMainContent: z
          .boolean()
          .describe(
            'Only return the main content of the page excluding headers, navs, footers, etc.'
          )
          .default(false),
        /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */
        removeTags: z
          .array(z.string())
          .describe(
            "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
          )
          .optional(),
        /** Replace all relative paths with absolute paths for images and links */
        replaceAllPathsWithAbsolutePaths: z
          .boolean()
          .describe(
            'Replace all relative paths with absolute paths for images and links'
          )
          .default(false),
        /** Include a screenshot of the top of the page that you are scraping. */
        screenshot: z
          .boolean()
          .describe(
            'Include a screenshot of the top of the page that you are scraping.'
          )
          .default(false),
        /** Include a full page screenshot of the page that you are scraping. */
        fullPageScreenshot: z
          .boolean()
          .describe(
            'Include a full page screenshot of the page that you are scraping.'
          )
          .default(false),
        /** Wait x amount of milliseconds for the page to load to fetch content */
        waitFor: z
          .number()
          .int()
          .describe(
            'Wait x amount of milliseconds for the page to load to fetch content'
          )
          .default(0)
      })
      .optional()
  })
  export type CrawlUrlsParams = z.infer<typeof CrawlUrlsParamsSchema>

  export const CrawlUrlsResponseSchema = CrawlResponseSchema
  export type CrawlUrlsResponse = z.infer<typeof CrawlUrlsResponseSchema>

  export const SearchGoogleParamsSchema = z.object({
    /** The query to search for */
    query: z.string().url().describe('The query to search for'),
    pageOptions: z
      .object({
        /** Only return the main content of the page excluding headers, navs, footers, etc. */
        onlyMainContent: z
          .boolean()
          .describe(
            'Only return the main content of the page excluding headers, navs, footers, etc.'
          )
          .default(false),
        /** Fetch the content of each page. If false, defaults to a basic fast serp API. */
        fetchPageContent: z
          .boolean()
          .describe(
            'Fetch the content of each page. If false, defaults to a basic fast serp API.'
          )
          .default(true),
        /** Include the HTML version of the content on page. Will output a html key in the response. */
        includeHtml: z
          .boolean()
          .describe(
            'Include the HTML version of the content on page. Will output a html key in the response.'
          )
          .default(false),
        /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */
        includeRawHtml: z
          .boolean()
          .describe(
            'Include the raw HTML content of the page. Will output a rawHtml key in the response.'
          )
          .default(false)
      })
      .optional(),
    searchOptions: z
      .object({
        /** Maximum number of results. Max is 20 during beta. */
        limit: z
          .number()
          .int()
          .describe('Maximum number of results. Max is 20 during beta.')
          .optional()
      })
      .optional()
  })
  export type SearchGoogleParams = z.infer<typeof SearchGoogleParamsSchema>

  export const SearchGoogleResponseSchema = SearchResponseSchema
  export type SearchGoogleResponse = z.infer<typeof SearchGoogleResponseSchema>

  export const GetCrawlStatusParamsSchema = z.object({
    /** ID of the crawl job */
    jobId: z.string().describe('ID of the crawl job')
  })
  export type GetCrawlStatusParams = z.infer<typeof GetCrawlStatusParamsSchema>

  export const GetCrawlStatusResponseSchema = z.object({
    /** Status of the job (completed, active, failed, paused) */
    status: z
      .string()
      .describe('Status of the job (completed, active, failed, paused)')
      .optional(),
    /** Current page number */
    current: z.number().int().describe('Current page number').optional(),
    /** Total number of pages */
    total: z.number().int().describe('Total number of pages').optional(),
    /** Data returned from the job (null when it is in progress) */
    data: z
      .array(CrawlStatusResponseObjSchema)
      .describe('Data returned from the job (null when it is in progress)')
      .optional(),
    /** Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in `data`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array. */
    partial_data: z
      .array(CrawlStatusResponseObjSchema)
      .describe(
        'Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in `data`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.'
      )
      .optional()
  })
  export type GetCrawlStatusResponse = z.infer<
    typeof GetCrawlStatusResponseSchema
  >

  export const CancelCrawlJobParamsSchema = z.object({
    /** ID of the crawl job */
    jobId: z.string().describe('ID of the crawl job')
  })
  export type CancelCrawlJobParams = z.infer<typeof CancelCrawlJobParamsSchema>

  export const CancelCrawlJobResponseSchema = z.object({
    /** Returns cancelled. */
    status: z.string().describe('Returns cancelled.').optional()
  })
  export type CancelCrawlJobResponse = z.infer<
    typeof CancelCrawlJobResponseSchema
  >
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/github-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  aiFunction,
  AIFunctionsProvider,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { github } from './github'

/**
 * Agentic Github client.
 *
 * GitHub's v3 REST API.
 */
export class GithubClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = github.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * Get Hypermedia links to resources accessible in GitHub's REST API.
   */
  @aiFunction({
    name: 'github_meta_root',
    description: `Get Hypermedia links to resources accessible in GitHub's REST API.`,
    inputSchema: github.MetaRootParamsSchema,
    tags: ['meta']
  })
  async metaRoot(
    _params: github.MetaRootParams
  ): Promise<github.MetaRootResponse> {
    return this.ky.get('/').json<github.MetaRootResponse>()
  }

  /**
 * Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).".
 */
  @aiFunction({
    name: 'github_security_advisories_list_global_advisories',
    description: `Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the \`type\` parameter in your request, with the value \`malware\`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).".`,
    inputSchema: github.SecurityAdvisoriesListGlobalAdvisoriesParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesListGlobalAdvisories(
    params: github.SecurityAdvisoriesListGlobalAdvisoriesParams
  ): Promise<github.SecurityAdvisoriesListGlobalAdvisoriesResponse> {
    return this.ky
      .get('/advisories', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'ghsa_id',
            'type',
            'cve_id',
            'ecosystem',
            'severity',
            'cwes',
            'is_withdrawn',
            'affects',
            'published',
            'updated',
            'modified',
            'epss_percentage',
            'epss_percentile',
            'before',
            'after',
            'direction',
            'per_page',
            'sort'
          )
        )
      })
      .json<github.SecurityAdvisoriesListGlobalAdvisoriesResponse>()
  }

  /**
   * Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
   */
  @aiFunction({
    name: 'github_security_advisories_get_global_advisory',
    description: `Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.`,
    inputSchema: github.SecurityAdvisoriesGetGlobalAdvisoryParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesGetGlobalAdvisory(
    params: github.SecurityAdvisoriesGetGlobalAdvisoryParams
  ): Promise<github.SecurityAdvisoriesGetGlobalAdvisoryResponse> {
    return this.ky
      .get(`/advisories/${params.ghsa_id}`)
      .json<github.SecurityAdvisoriesGetGlobalAdvisoryResponse>()
  }

  /**
 * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_authenticated',
    description: `Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the \`installations_count\` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetAuthenticatedParamsSchema,
    tags: ['apps']
  })
  async appsGetAuthenticated(
    _params: github.AppsGetAuthenticatedParams
  ): Promise<github.AppsGetAuthenticatedResponse> {
    return this.ky.get('/app').json<github.AppsGetAuthenticatedResponse>()
  }

  /**
   * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.
   */
  @aiFunction({
    name: 'github_apps_create_from_manifest',
    description: `Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary \`code\` used to retrieve the GitHub App's \`id\`, \`pem\` (private key), and \`webhook_secret\`.`,
    inputSchema: github.AppsCreateFromManifestParamsSchema,
    tags: ['apps']
  })
  async appsCreateFromManifest(
    params: github.AppsCreateFromManifestParams
  ): Promise<github.AppsCreateFromManifestResponse> {
    return this.ky
      .post(`/app-manifests/${params.code}/conversions`)
      .json<github.AppsCreateFromManifestResponse>()
  }

  /**
 * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_webhook_config_for_app',
    description: `Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetWebhookConfigForAppParamsSchema,
    tags: ['apps']
  })
  async appsGetWebhookConfigForApp(
    _params: github.AppsGetWebhookConfigForAppParams
  ): Promise<github.AppsGetWebhookConfigForAppResponse> {
    return this.ky
      .get('/app/hook/config')
      .json<github.AppsGetWebhookConfigForAppResponse>()
  }

  /**
 * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_update_webhook_config_for_app',
    description: `Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsUpdateWebhookConfigForAppParamsSchema,
    tags: ['apps']
  })
  async appsUpdateWebhookConfigForApp(
    params: github.AppsUpdateWebhookConfigForAppParams
  ): Promise<github.AppsUpdateWebhookConfigForAppResponse> {
    return this.ky
      .patch('/app/hook/config', {
        json: pick(params, 'url', 'content_type', 'secret', 'insecure_ssl')
      })
      .json<github.AppsUpdateWebhookConfigForAppResponse>()
  }

  /**
 * Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_webhook_deliveries',
    description: `Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsListWebhookDeliveriesParamsSchema,
    tags: ['apps']
  })
  async appsListWebhookDeliveries(
    params: github.AppsListWebhookDeliveriesParams
  ): Promise<github.AppsListWebhookDeliveriesResponse> {
    return this.ky
      .get('/app/hook/deliveries', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'cursor'))
      })
      .json<github.AppsListWebhookDeliveriesResponse>()
  }

  /**
 * Returns a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_webhook_delivery',
    description: `Returns a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetWebhookDeliveryParamsSchema,
    tags: ['apps']
  })
  async appsGetWebhookDelivery(
    params: github.AppsGetWebhookDeliveryParams
  ): Promise<github.AppsGetWebhookDeliveryResponse> {
    return this.ky
      .get(`/app/hook/deliveries/${params.delivery_id}`)
      .json<github.AppsGetWebhookDeliveryResponse>()
  }

  /**
 * Redeliver a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_redeliver_webhook_delivery',
    description: `Redeliver a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsRedeliverWebhookDeliveryParamsSchema,
    tags: ['apps']
  })
  async appsRedeliverWebhookDelivery(
    params: github.AppsRedeliverWebhookDeliveryParams
  ): Promise<github.AppsRedeliverWebhookDeliveryResponse> {
    return this.ky
      .post(`/app/hook/deliveries/${params.delivery_id}/attempts`)
      .json<github.AppsRedeliverWebhookDeliveryResponse>()
  }

  /**
   * Lists all the pending installation requests for the authenticated GitHub App.
   */
  @aiFunction({
    name: 'github_apps_list_installation_requests_for_authenticated_app',
    description: `Lists all the pending installation requests for the authenticated GitHub App.`,
    inputSchema:
      github.AppsListInstallationRequestsForAuthenticatedAppParamsSchema,
    tags: ['apps']
  })
  async appsListInstallationRequestsForAuthenticatedApp(
    params: github.AppsListInstallationRequestsForAuthenticatedAppParams
  ): Promise<github.AppsListInstallationRequestsForAuthenticatedAppResponse> {
    return this.ky
      .get('/app/installation-requests', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListInstallationRequestsForAuthenticatedAppResponse>()
  }

  /**
 * The permissions the installation has are included under the `permissions` key.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_installations',
    description: `The permissions the installation has are included under the \`permissions\` key.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsListInstallationsParamsSchema,
    tags: ['apps']
  })
  async appsListInstallations(
    params: github.AppsListInstallationsParams
  ): Promise<github.AppsListInstallationsResponse> {
    return this.ky
      .get('/app/installations', {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'since', 'outdated')
        )
      })
      .json<github.AppsListInstallationsResponse>()
  }

  /**
 * Enables an authenticated GitHub App to find an installation's information using the installation id.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_installation',
    description: `Enables an authenticated GitHub App to find an installation's information using the installation id.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetInstallationParamsSchema,
    tags: ['apps']
  })
  async appsGetInstallation(
    params: github.AppsGetInstallationParams
  ): Promise<github.AppsGetInstallationResponse> {
    return this.ky
      .get(`/app/installations/${params.installation_id}`)
      .json<github.AppsGetInstallationResponse>()
  }

  /**
 * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_delete_installation',
    description: `Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsDeleteInstallationParamsSchema,
    tags: ['apps']
  })
  async appsDeleteInstallation(
    params: github.AppsDeleteInstallationParams
  ): Promise<github.AppsDeleteInstallationResponse> {
    return this.ky
      .delete(`/app/installations/${params.installation_id}`)
      .json<github.AppsDeleteInstallationResponse>()
  }

  /**
 * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_create_installation_access_token',
    description: `Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of \`401 - Unauthorized\`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

Optionally, you can use the \`repositories\` or \`repository_ids\` body parameters to specify individual repositories that the installation access token can access. If you don't use \`repositories\` or \`repository_ids\` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

Optionally, use the \`permissions\` body parameter to specify the permissions that the installation access token should have. If \`permissions\` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsCreateInstallationAccessTokenParamsSchema,
    tags: ['apps']
  })
  async appsCreateInstallationAccessToken(
    params: github.AppsCreateInstallationAccessTokenParams
  ): Promise<github.AppsCreateInstallationAccessTokenResponse> {
    return this.ky
      .post(`/app/installations/${params.installation_id}/access_tokens`, {
        json: pick(params, 'repositories', 'repository_ids', 'permissions')
      })
      .json<github.AppsCreateInstallationAccessTokenResponse>()
  }

  /**
 * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_suspend_installation',
    description: `Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsSuspendInstallationParamsSchema,
    tags: ['apps']
  })
  async appsSuspendInstallation(
    params: github.AppsSuspendInstallationParams
  ): Promise<github.AppsSuspendInstallationResponse> {
    return this.ky
      .put(`/app/installations/${params.installation_id}/suspended`)
      .json<github.AppsSuspendInstallationResponse>()
  }

  /**
 * Removes a GitHub App installation suspension.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_unsuspend_installation',
    description: `Removes a GitHub App installation suspension.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsUnsuspendInstallationParamsSchema,
    tags: ['apps']
  })
  async appsUnsuspendInstallation(
    params: github.AppsUnsuspendInstallationParams
  ): Promise<github.AppsUnsuspendInstallationResponse> {
    return this.ky
      .delete(`/app/installations/${params.installation_id}/suspended`)
      .json<github.AppsUnsuspendInstallationResponse>()
  }

  /**
 * OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
 */
  @aiFunction({
    name: 'github_apps_delete_authorization',
    description: `OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth \`access_token\` as an input parameter and the grant for the token's owner will be deleted.
Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).`,
    inputSchema: github.AppsDeleteAuthorizationParamsSchema,
    tags: ['apps']
  })
  async appsDeleteAuthorization(
    params: github.AppsDeleteAuthorizationParams
  ): Promise<github.AppsDeleteAuthorizationResponse> {
    return this.ky
      .delete(`/applications/${params.client_id}/grant`, {
        json: pick(params, 'access_token')
      })
      .json<github.AppsDeleteAuthorizationResponse>()
  }

  /**
   * OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.
   */
  @aiFunction({
    name: 'github_apps_check_token',
    description: `OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return \`404 NOT FOUND\`.`,
    inputSchema: github.AppsCheckTokenParamsSchema,
    tags: ['apps']
  })
  async appsCheckToken(
    params: github.AppsCheckTokenParams
  ): Promise<github.AppsCheckTokenResponse> {
    return this.ky
      .post(`/applications/${params.client_id}/token`, {
        json: pick(params, 'access_token')
      })
      .json<github.AppsCheckTokenResponse>()
  }

  /**
   * OAuth  or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
   */
  @aiFunction({
    name: 'github_apps_delete_token',
    description: `OAuth  or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.`,
    inputSchema: github.AppsDeleteTokenParamsSchema,
    tags: ['apps']
  })
  async appsDeleteToken(
    params: github.AppsDeleteTokenParams
  ): Promise<github.AppsDeleteTokenResponse> {
    return this.ky
      .delete(`/applications/${params.client_id}/token`, {
        json: pick(params, 'access_token')
      })
      .json<github.AppsDeleteTokenResponse>()
  }

  /**
   * OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.
   */
  @aiFunction({
    name: 'github_apps_reset_token',
    description: `OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return \`404 NOT FOUND\`.`,
    inputSchema: github.AppsResetTokenParamsSchema,
    tags: ['apps']
  })
  async appsResetToken(
    params: github.AppsResetTokenParams
  ): Promise<github.AppsResetTokenResponse> {
    return this.ky
      .patch(`/applications/${params.client_id}/token`, {
        json: pick(params, 'access_token')
      })
      .json<github.AppsResetTokenResponse>()
  }

  /**
 * Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
which repositories the token can access and which permissions are granted to the
token.

Invalid tokens will return `404 NOT FOUND`.
 */
  @aiFunction({
    name: 'github_apps_scope_token',
    description: `Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
which repositories the token can access and which permissions are granted to the
token.

Invalid tokens will return \`404 NOT FOUND\`.`,
    inputSchema: github.AppsScopeTokenParamsSchema,
    tags: ['apps']
  })
  async appsScopeToken(
    params: github.AppsScopeTokenParams
  ): Promise<github.AppsScopeTokenResponse> {
    return this.ky
      .post(`/applications/${params.client_id}/token/scoped`, {
        json: pick(
          params,
          'access_token',
          'target',
          'target_id',
          'repositories',
          'repository_ids',
          'permissions'
        )
      })
      .json<github.AppsScopeTokenResponse>()
  }

  /**
 * > [!NOTE]
> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
 */
  @aiFunction({
    name: 'github_apps_get_by_slug',
    description: `> [!NOTE]
> The \`:app_slug\` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., \`https://github.com/settings/apps/:app_slug\`).`,
    inputSchema: github.AppsGetBySlugParamsSchema,
    tags: ['apps']
  })
  async appsGetBySlug(
    params: github.AppsGetBySlugParams
  ): Promise<github.AppsGetBySlugResponse> {
    return this.ky
      .get(`/apps/${params.app_slug}`)
      .json<github.AppsGetBySlugResponse>()
  }

  /**
   * Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
   */
  @aiFunction({
    name: 'github_classroom_get_an_assignment',
    description: `Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.`,
    inputSchema: github.ClassroomGetAnAssignmentParamsSchema,
    tags: ['classroom']
  })
  async classroomGetAnAssignment(
    params: github.ClassroomGetAnAssignmentParams
  ): Promise<github.ClassroomGetAnAssignmentResponse> {
    return this.ky
      .get(`/assignments/${params.assignment_id}`)
      .json<github.ClassroomGetAnAssignmentResponse>()
  }

  /**
   * Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
   */
  @aiFunction({
    name: 'github_classroom_list_accepted_assignments_for_an_assignment',
    description: `Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.`,
    inputSchema:
      github.ClassroomListAcceptedAssignmentsForAnAssignmentParamsSchema,
    tags: ['classroom']
  })
  async classroomListAcceptedAssignmentsForAnAssignment(
    params: github.ClassroomListAcceptedAssignmentsForAnAssignmentParams
  ): Promise<github.ClassroomListAcceptedAssignmentsForAnAssignmentResponse> {
    return this.ky
      .get(`/assignments/${params.assignment_id}/accepted_assignments`, {
        searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
      })
      .json<github.ClassroomListAcceptedAssignmentsForAnAssignmentResponse>()
  }

  /**
   * Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
   */
  @aiFunction({
    name: 'github_classroom_get_assignment_grades',
    description: `Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.`,
    inputSchema: github.ClassroomGetAssignmentGradesParamsSchema,
    tags: ['classroom']
  })
  async classroomGetAssignmentGrades(
    params: github.ClassroomGetAssignmentGradesParams
  ): Promise<github.ClassroomGetAssignmentGradesResponse> {
    return this.ky
      .get(`/assignments/${params.assignment_id}/grades`)
      .json<github.ClassroomGetAssignmentGradesResponse>()
  }

  /**
   * Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
   */
  @aiFunction({
    name: 'github_classroom_list_classrooms',
    description: `Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.`,
    inputSchema: github.ClassroomListClassroomsParamsSchema,
    tags: ['classroom']
  })
  async classroomListClassrooms(
    params: github.ClassroomListClassroomsParams
  ): Promise<github.ClassroomListClassroomsResponse> {
    return this.ky
      .get('/classrooms', {
        searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
      })
      .json<github.ClassroomListClassroomsResponse>()
  }

  /**
   * Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
   */
  @aiFunction({
    name: 'github_classroom_get_a_classroom',
    description: `Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.`,
    inputSchema: github.ClassroomGetAclassroomParamsSchema,
    tags: ['classroom']
  })
  async classroomGetAClassroom(
    params: github.ClassroomGetAclassroomParams
  ): Promise<github.ClassroomGetAclassroomResponse> {
    return this.ky
      .get(`/classrooms/${params.classroom_id}`)
      .json<github.ClassroomGetAclassroomResponse>()
  }

  /**
   * Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
   */
  @aiFunction({
    name: 'github_classroom_list_assignments_for_a_classroom',
    description: `Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.`,
    inputSchema: github.ClassroomListAssignmentsForAclassroomParamsSchema,
    tags: ['classroom']
  })
  async classroomListAssignmentsForAClassroom(
    params: github.ClassroomListAssignmentsForAclassroomParams
  ): Promise<github.ClassroomListAssignmentsForAclassroomResponse> {
    return this.ky
      .get(`/classrooms/${params.classroom_id}/assignments`, {
        searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
      })
      .json<github.ClassroomListAssignmentsForAclassroomResponse>()
  }

  /**
   * Returns array of all GitHub's codes of conduct.
   */
  @aiFunction({
    name: 'github_codes_of_conduct_get_all_codes_of_conduct',
    description: `Returns array of all GitHub's codes of conduct.`,
    inputSchema: github.CodesOfConductGetAllCodesOfConductParamsSchema,
    tags: ['codes-of-conduct']
  })
  async codesOfConductGetAllCodesOfConduct(
    _params: github.CodesOfConductGetAllCodesOfConductParams
  ): Promise<github.CodesOfConductGetAllCodesOfConductResponse> {
    return this.ky
      .get('/codes_of_conduct')
      .json<github.CodesOfConductGetAllCodesOfConductResponse>()
  }

  /**
   * Returns information about the specified GitHub code of conduct.
   */
  @aiFunction({
    name: 'github_codes_of_conduct_get_conduct_code',
    description: `Returns information about the specified GitHub code of conduct.`,
    inputSchema: github.CodesOfConductGetConductCodeParamsSchema,
    tags: ['codes-of-conduct']
  })
  async codesOfConductGetConductCode(
    params: github.CodesOfConductGetConductCodeParams
  ): Promise<github.CodesOfConductGetConductCodeResponse> {
    return this.ky
      .get(`/codes_of_conduct/${params.key}`)
      .json<github.CodesOfConductGetConductCodeResponse>()
  }

  /**
   * Lists all the emojis available to use on GitHub.
   */
  @aiFunction({
    name: 'github_emojis_get',
    description: `Lists all the emojis available to use on GitHub.`,
    inputSchema: github.EmojisGetParamsSchema,
    tags: ['emojis']
  })
  async emojisGet(
    _params: github.EmojisGetParams
  ): Promise<github.EmojisGetResponse> {
    return this.ky.get('/emojis').json<github.EmojisGetResponse>()
  }

  /**
 * Lists all code security configurations available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_configurations_for_enterprise',
    description: `Lists all code security configurations available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:enterprise\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetConfigurationsForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetConfigurationsForEnterprise(
    params: github.CodeSecurityGetConfigurationsForEnterpriseParams
  ): Promise<github.CodeSecurityGetConfigurationsForEnterpriseResponse> {
    return this.ky
      .get(
        `/enterprises/${params.enterprise}/code-security/configurations`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'before', 'after')
          )
        }
      )
      .json<github.CodeSecurityGetConfigurationsForEnterpriseResponse>()
  }

  /**
 * Creates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_create_configuration_for_enterprise',
    description: `Creates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecurityCreateConfigurationForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityCreateConfigurationForEnterprise(
    params: github.CodeSecurityCreateConfigurationForEnterpriseParams
  ): Promise<github.CodeSecurityCreateConfigurationForEnterpriseResponse> {
    return this.ky
      .post(
        `/enterprises/${params.enterprise}/code-security/configurations`,
        {
          json: pick(
            params,
            'name',
            'description',
            'advanced_security',
            'dependency_graph',
            'dependency_graph_autosubmit_action',
            'dependency_graph_autosubmit_action_options',
            'dependabot_alerts',
            'dependabot_security_updates',
            'code_scanning_default_setup',
            'code_scanning_default_setup_options',
            'code_scanning_delegated_alert_dismissal',
            'secret_scanning',
            'secret_scanning_push_protection',
            'secret_scanning_validity_checks',
            'secret_scanning_non_provider_patterns',
            'secret_scanning_generic_secrets',
            'secret_scanning_delegated_alert_dismissal',
            'private_vulnerability_reporting',
            'enforcement'
          )
        }
      )
      .json<github.CodeSecurityCreateConfigurationForEnterpriseResponse>()
  }

  /**
 * Lists the default code security configurations for an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_default_configurations_for_enterprise',
    description: `Lists the default code security configurations for an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecurityGetDefaultConfigurationsForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetDefaultConfigurationsForEnterprise(
    params: github.CodeSecurityGetDefaultConfigurationsForEnterpriseParams
  ): Promise<github.CodeSecurityGetDefaultConfigurationsForEnterpriseResponse> {
    return this.ky
      .get(
        `/enterprises/${params.enterprise}/code-security/configurations/defaults`
      )
      .json<github.CodeSecurityGetDefaultConfigurationsForEnterpriseResponse>()
  }

  /**
 * Gets a code security configuration available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_single_configuration_for_enterprise',
    description: `Gets a code security configuration available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecurityGetSingleConfigurationForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetSingleConfigurationForEnterprise(
    params: github.CodeSecurityGetSingleConfigurationForEnterpriseParams
  ): Promise<github.CodeSecurityGetSingleConfigurationForEnterpriseResponse> {
    return this.ky
      .get(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}`,
        {}
      )
      .json<github.CodeSecurityGetSingleConfigurationForEnterpriseResponse>()
  }

  /**
 * Deletes a code security configuration from an enterprise.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_delete_configuration_for_enterprise',
    description: `Deletes a code security configuration from an enterprise.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecurityDeleteConfigurationForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityDeleteConfigurationForEnterprise(
    params: github.CodeSecurityDeleteConfigurationForEnterpriseParams
  ): Promise<github.CodeSecurityDeleteConfigurationForEnterpriseResponse> {
    return this.ky
      .delete(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}`,
        {}
      )
      .json<github.CodeSecurityDeleteConfigurationForEnterpriseResponse>()
  }

  /**
 * Updates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_update_enterprise_configuration',
    description: `Updates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:enterprise\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityUpdateEnterpriseConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityUpdateEnterpriseConfiguration(
    params: github.CodeSecurityUpdateEnterpriseConfigurationParams
  ): Promise<github.CodeSecurityUpdateEnterpriseConfigurationResponse> {
    return this.ky
      .patch(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}`,
        {
          json: pick(
            params,
            'name',
            'description',
            'advanced_security',
            'dependency_graph',
            'dependency_graph_autosubmit_action',
            'dependency_graph_autosubmit_action_options',
            'dependabot_alerts',
            'dependabot_security_updates',
            'code_scanning_default_setup',
            'code_scanning_default_setup_options',
            'code_scanning_delegated_alert_dismissal',
            'secret_scanning',
            'secret_scanning_push_protection',
            'secret_scanning_validity_checks',
            'secret_scanning_non_provider_patterns',
            'secret_scanning_generic_secrets',
            'secret_scanning_delegated_alert_dismissal',
            'private_vulnerability_reporting',
            'enforcement'
          )
        }
      )
      .json<github.CodeSecurityUpdateEnterpriseConfigurationResponse>()
  }

  /**
 * Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_attach_enterprise_configuration',
    description: `Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:enterprise\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityAttachEnterpriseConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityAttachEnterpriseConfiguration(
    params: github.CodeSecurityAttachEnterpriseConfigurationParams
  ): Promise<github.CodeSecurityAttachEnterpriseConfigurationResponse> {
    return this.ky
      .post(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}/attach`,
        {
          json: pick(params, 'scope')
        }
      )
      .json<github.CodeSecurityAttachEnterpriseConfigurationResponse>()
  }

  /**
 * Sets a code security configuration as a default to be applied to new repositories in your enterprise.

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_set_configuration_as_default_for_enterprise',
    description: `Sets a code security configuration as a default to be applied to new repositories in your enterprise.

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecuritySetConfigurationAsDefaultForEnterpriseParamsSchema,
    tags: ['code-security']
  })
  async codeSecuritySetConfigurationAsDefaultForEnterprise(
    params: github.CodeSecuritySetConfigurationAsDefaultForEnterpriseParams
  ): Promise<github.CodeSecuritySetConfigurationAsDefaultForEnterpriseResponse> {
    return this.ky
      .put(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}/defaults`,
        {
          json: pick(params, 'default_for_new_repos')
        }
      )
      .json<github.CodeSecuritySetConfigurationAsDefaultForEnterpriseResponse>()
  }

  /**
 * Lists the repositories associated with an enterprise code security configuration in an organization.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_repositories_for_enterprise_configuration',
    description: `Lists the repositories associated with an enterprise code security configuration in an organization.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:enterprise\` scope to use this endpoint.`,
    inputSchema:
      github.CodeSecurityGetRepositoriesForEnterpriseConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetRepositoriesForEnterpriseConfiguration(
    params: github.CodeSecurityGetRepositoriesForEnterpriseConfigurationParams
  ): Promise<github.CodeSecurityGetRepositoriesForEnterpriseConfigurationResponse> {
    return this.ky
      .get(
        `/enterprises/${params.enterprise}/code-security/configurations/${params.configuration_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'before', 'after', 'status')
          )
        }
      )
      .json<github.CodeSecurityGetRepositoriesForEnterpriseConfigurationResponse>()
  }

  /**
 * Lists Dependabot alerts for repositories that are owned by the specified enterprise.

The authenticated user must be a member of the enterprise to use this endpoint.

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_list_alerts_for_enterprise',
    description: `Lists Dependabot alerts for repositories that are owned by the specified enterprise.

The authenticated user must be a member of the enterprise to use this endpoint.

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint.`,
    inputSchema: github.DependabotListAlertsForEnterpriseParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListAlertsForEnterprise(
    params: github.DependabotListAlertsForEnterpriseParams
  ): Promise<github.DependabotListAlertsForEnterpriseResponse> {
    return this.ky
      .get(`/enterprises/${params.enterprise}/dependabot/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'severity',
            'ecosystem',
            'package',
            'epss_percentage',
            'scope',
            'sort',
            'direction',
            'before',
            'after',
            'first',
            'last',
            'per_page'
          )
        )
      })
      .json<github.DependabotListAlertsForEnterpriseResponse>()
  }

  /**
 * Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.

Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).

The authenticated user must be a member of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_secret_scanning_list_alerts_for_enterprise',
    description: `Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.

Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).

The authenticated user must be a member of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope or \`security_events\` scope to use this endpoint.`,
    inputSchema: github.SecretScanningListAlertsForEnterpriseParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningListAlertsForEnterprise(
    params: github.SecretScanningListAlertsForEnterpriseParams
  ): Promise<github.SecretScanningListAlertsForEnterpriseResponse> {
    return this.ky
      .get(`/enterprises/${params.enterprise}/secret-scanning/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'secret_type',
            'resolution',
            'sort',
            'direction',
            'per_page',
            'before',
            'after',
            'validity',
            'is_publicly_leaked',
            'is_multi_repo'
          )
        )
      })
      .json<github.SecretScanningListAlertsForEnterpriseResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_public_events',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListPublicEventsParamsSchema,
    tags: ['activity']
  })
  async activityListPublicEvents(
    params: github.ActivityListPublicEventsParams
  ): Promise<github.ActivityListPublicEventsResponse> {
    return this.ky
      .get('/events', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListPublicEventsResponse>()
  }

  /**
 * Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

*   **Timeline**: The GitHub global public timeline
*   **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
*   **Current user public**: The public timeline for the authenticated user
*   **Current user**: The private timeline for the authenticated user
*   **Current user actor**: The private timeline for activity created by the authenticated user
*   **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
*   **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

> [!NOTE]
> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
 */
  @aiFunction({
    name: 'github_activity_get_feeds',
    description: `Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

*   **Timeline**: The GitHub global public timeline
*   **User**: The public timeline for any user, using \`uri_template\`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
*   **Current user public**: The public timeline for the authenticated user
*   **Current user**: The private timeline for the authenticated user
*   **Current user actor**: The private timeline for activity created by the authenticated user
*   **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
*   **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

By default, timeline resources are returned in JSON. You can specify the \`application/atom+xml\` type in the \`Accept\` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

> [!NOTE]
> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.`,
    inputSchema: github.ActivityGetFeedsParamsSchema,
    tags: ['activity']
  })
  async activityGetFeeds(
    _params: github.ActivityGetFeedsParams
  ): Promise<github.ActivityGetFeedsResponse> {
    return this.ky.get('/feeds').json<github.ActivityGetFeedsResponse>()
  }

  /**
   * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:.
   */
  @aiFunction({
    name: 'github_gists_list',
    description: `Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:.`,
    inputSchema: github.GistsListParamsSchema,
    tags: ['gists']
  })
  async gistsList(
    params: github.GistsListParams
  ): Promise<github.GistsListResponse> {
    return this.ky
      .get('/gists', {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'per_page', 'page')
        )
      })
      .json<github.GistsListResponse>()
  }

  /**
 * Allows you to add a new gist with one or more files.

> [!NOTE]
> Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
 */
  @aiFunction({
    name: 'github_gists_create',
    description: `Allows you to add a new gist with one or more files.

> [!NOTE]
> Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.`,
    inputSchema: github.GistsCreateParamsSchema,
    tags: ['gists']
  })
  async gistsCreate(
    params: github.GistsCreateParams
  ): Promise<github.GistsCreateResponse> {
    return this.ky
      .post('/gists', {
        json: pick(params, 'description', 'files', 'public')
      })
      .json<github.GistsCreateResponse>()
  }

  /**
 * List public gists sorted by most recently updated to least recently updated.

Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
 */
  @aiFunction({
    name: 'github_gists_list_public',
    description: `List public gists sorted by most recently updated to least recently updated.

Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.`,
    inputSchema: github.GistsListPublicParamsSchema,
    tags: ['gists']
  })
  async gistsListPublic(
    params: github.GistsListPublicParams
  ): Promise<github.GistsListPublicResponse> {
    return this.ky
      .get('/gists/public', {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'per_page', 'page')
        )
      })
      .json<github.GistsListPublicResponse>()
  }

  /**
   * List the authenticated user's starred gists:.
   */
  @aiFunction({
    name: 'github_gists_list_starred',
    description: `List the authenticated user's starred gists:.`,
    inputSchema: github.GistsListStarredParamsSchema,
    tags: ['gists']
  })
  async gistsListStarred(
    params: github.GistsListStarredParams
  ): Promise<github.GistsListStarredResponse> {
    return this.ky
      .get('/gists/starred', {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'per_page', 'page')
        )
      })
      .json<github.GistsListStarredResponse>()
  }

  /**
 * Gets a specified gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_get',
    description: `Gets a specified gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsGetParamsSchema,
    tags: ['gists']
  })
  async gistsGet(
    params: github.GistsGetParams
  ): Promise<github.GistsGetResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}`)
      .json<github.GistsGetResponse>()
  }

  /**
   * Delete a gist.
   */
  @aiFunction({
    name: 'github_gists_delete',
    description: `Delete a gist.`,
    inputSchema: github.GistsDeleteParamsSchema,
    tags: ['gists']
  })
  async gistsDelete(
    params: github.GistsDeleteParams
  ): Promise<github.GistsDeleteResponse> {
    return this.ky
      .delete(`/gists/${params.gist_id}`)
      .json<github.GistsDeleteResponse>()
  }

  /**
 * Allows you to update a gist's description and to update, delete, or rename gist files. Files
from the previous version of the gist that aren't explicitly changed during an edit
are unchanged.

At least one of `description` or `files` is required.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_update',
    description: `Allows you to update a gist's description and to update, delete, or rename gist files. Files
from the previous version of the gist that aren't explicitly changed during an edit
are unchanged.

At least one of \`description\` or \`files\` is required.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsUpdateParamsSchema,
    tags: ['gists']
  })
  async gistsUpdate(
    params: github.GistsUpdateParams
  ): Promise<github.GistsUpdateResponse> {
    return this.ky
      .patch(`/gists/${params.gist_id}`, {
        json: pick(params, 'description', 'files')
      })
      .json<github.GistsUpdateResponse>()
  }

  /**
 * Lists the comments on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_list_comments',
    description: `Lists the comments on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsListCommentsParamsSchema,
    tags: ['gists']
  })
  async gistsListComments(
    params: github.GistsListCommentsParams
  ): Promise<github.GistsListCommentsResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/comments`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.GistsListCommentsResponse>()
  }

  /**
 * Creates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_create_comment',
    description: `Creates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsCreateCommentParamsSchema,
    tags: ['gists']
  })
  async gistsCreateComment(
    params: github.GistsCreateCommentParams
  ): Promise<github.GistsCreateCommentResponse> {
    return this.ky
      .post(`/gists/${params.gist_id}/comments`, {
        json: pick(params, 'body')
      })
      .json<github.GistsCreateCommentResponse>()
  }

  /**
 * Gets a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_get_comment',
    description: `Gets a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsGetCommentParamsSchema,
    tags: ['gists']
  })
  async gistsGetComment(
    params: github.GistsGetCommentParams
  ): Promise<github.GistsGetCommentResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/comments/${params.comment_id}`, {})
      .json<github.GistsGetCommentResponse>()
  }

  /**
   * Delete a gist comment.
   */
  @aiFunction({
    name: 'github_gists_delete_comment',
    description: `Delete a gist comment.`,
    inputSchema: github.GistsDeleteCommentParamsSchema,
    tags: ['gists']
  })
  async gistsDeleteComment(
    params: github.GistsDeleteCommentParams
  ): Promise<github.GistsDeleteCommentResponse> {
    return this.ky
      .delete(
        `/gists/${params.gist_id}/comments/${params.comment_id}`,
        {}
      )
      .json<github.GistsDeleteCommentResponse>()
  }

  /**
 * Updates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_update_comment',
    description: `Updates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsUpdateCommentParamsSchema,
    tags: ['gists']
  })
  async gistsUpdateComment(
    params: github.GistsUpdateCommentParams
  ): Promise<github.GistsUpdateCommentResponse> {
    return this.ky
      .patch(`/gists/${params.gist_id}/comments/${params.comment_id}`, {
        json: pick(params, 'body')
      })
      .json<github.GistsUpdateCommentResponse>()
  }

  /**
   * List gist commits.
   */
  @aiFunction({
    name: 'github_gists_list_commits',
    description: `List gist commits.`,
    inputSchema: github.GistsListCommitsParamsSchema,
    tags: ['gists']
  })
  async gistsListCommits(
    params: github.GistsListCommitsParams
  ): Promise<github.GistsListCommitsResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/commits`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.GistsListCommitsResponse>()
  }

  /**
   * List gist forks.
   */
  @aiFunction({
    name: 'github_gists_list_forks',
    description: `List gist forks.`,
    inputSchema: github.GistsListForksParamsSchema,
    tags: ['gists']
  })
  async gistsListForks(
    params: github.GistsListForksParams
  ): Promise<github.GistsListForksResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/forks`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.GistsListForksResponse>()
  }

  /**
   * Fork a gist.
   */
  @aiFunction({
    name: 'github_gists_fork',
    description: `Fork a gist.`,
    inputSchema: github.GistsForkParamsSchema,
    tags: ['gists']
  })
  async gistsFork(
    params: github.GistsForkParams
  ): Promise<github.GistsForkResponse> {
    return this.ky
      .post(`/gists/${params.gist_id}/forks`)
      .json<github.GistsForkResponse>()
  }

  /**
   * Check if a gist is starred.
   */
  @aiFunction({
    name: 'github_gists_check_is_starred',
    description: `Check if a gist is starred.`,
    inputSchema: github.GistsCheckIsStarredParamsSchema,
    tags: ['gists']
  })
  async gistsCheckIsStarred(
    params: github.GistsCheckIsStarredParams
  ): Promise<github.GistsCheckIsStarredResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/star`)
      .json<github.GistsCheckIsStarredResponse>()
  }

  /**
   * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
   */
  @aiFunction({
    name: 'github_gists_star',
    description: `Note that you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.GistsStarParamsSchema,
    tags: ['gists']
  })
  async gistsStar(
    params: github.GistsStarParams
  ): Promise<github.GistsStarResponse> {
    return this.ky
      .put(`/gists/${params.gist_id}/star`)
      .json<github.GistsStarResponse>()
  }

  /**
   * Unstar a gist.
   */
  @aiFunction({
    name: 'github_gists_unstar',
    description: `Unstar a gist.`,
    inputSchema: github.GistsUnstarParamsSchema,
    tags: ['gists']
  })
  async gistsUnstar(
    params: github.GistsUnstarParams
  ): Promise<github.GistsUnstarResponse> {
    return this.ky
      .delete(`/gists/${params.gist_id}/star`)
      .json<github.GistsUnstarResponse>()
  }

  /**
 * Gets a specified gist revision.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
 */
  @aiFunction({
    name: 'github_gists_get_revision',
    description: `Gets a specified gist revision.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.base64+json\`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.`,
    inputSchema: github.GistsGetRevisionParamsSchema,
    tags: ['gists']
  })
  async gistsGetRevision(
    params: github.GistsGetRevisionParams
  ): Promise<github.GistsGetRevisionResponse> {
    return this.ky
      .get(`/gists/${params.gist_id}/${params.sha}`, {})
      .json<github.GistsGetRevisionResponse>()
  }

  /**
   * List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).
   */
  @aiFunction({
    name: 'github_gitignore_get_all_templates',
    description: `List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).`,
    inputSchema: github.GitignoreGetAllTemplatesParamsSchema,
    tags: ['gitignore']
  })
  async gitignoreGetAllTemplates(
    _params: github.GitignoreGetAllTemplatesParams
  ): Promise<github.GitignoreGetAllTemplatesResponse> {
    return this.ky
      .get('/gitignore/templates')
      .json<github.GitignoreGetAllTemplatesResponse>()
  }

  /**
 * Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
 */
  @aiFunction({
    name: 'github_gitignore_get_template',
    description: `Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw .gitignore contents.`,
    inputSchema: github.GitignoreGetTemplateParamsSchema,
    tags: ['gitignore']
  })
  async gitignoreGetTemplate(
    params: github.GitignoreGetTemplateParams
  ): Promise<github.GitignoreGetTemplateResponse> {
    return this.ky
      .get(`/gitignore/templates/${params.name}`)
      .json<github.GitignoreGetTemplateResponse>()
  }

  /**
   * List repositories that an app installation can access.
   */
  @aiFunction({
    name: 'github_apps_list_repos_accessible_to_installation',
    description: `List repositories that an app installation can access.`,
    inputSchema: github.AppsListReposAccessibleToInstallationParamsSchema,
    tags: ['apps']
  })
  async appsListReposAccessibleToInstallation(
    params: github.AppsListReposAccessibleToInstallationParams
  ): Promise<github.AppsListReposAccessibleToInstallationResponse> {
    return this.ky
      .get('/installation/repositories', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListReposAccessibleToInstallationResponse>()
  }

  /**
 * Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.
 */
  @aiFunction({
    name: 'github_apps_revoke_installation_access_token',
    description: `Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.`,
    inputSchema: github.AppsRevokeInstallationAccessTokenParamsSchema,
    tags: ['apps']
  })
  async appsRevokeInstallationAccessToken(
    _params: github.AppsRevokeInstallationAccessTokenParams
  ): Promise<github.AppsRevokeInstallationAccessTokenResponse> {
    return this.ky
      .delete('/installation/token')
      .json<github.AppsRevokeInstallationAccessTokenResponse>()
  }

  /**
 * List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
necessarily assigned to you.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list',
    description: `List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the \`filter\` query parameter to fetch issues that are not
necessarily assigned to you.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the \`pull_request\` key. Be aware that the \`id\` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListParamsSchema,
    tags: ['issues']
  })
  async issuesList(
    params: github.IssuesListParams
  ): Promise<github.IssuesListResponse> {
    return this.ky
      .get('/issues', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'filter',
            'state',
            'labels',
            'sort',
            'direction',
            'since',
            'collab',
            'orgs',
            'owned',
            'pulls',
            'per_page',
            'page'
          )
        )
      })
      .json<github.IssuesListResponse>()
  }

  /**
   * Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).".
   */
  @aiFunction({
    name: 'github_licenses_get_all_commonly_used',
    description: `Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).".`,
    inputSchema: github.LicensesGetAllCommonlyUsedParamsSchema,
    tags: ['licenses']
  })
  async licensesGetAllCommonlyUsed(
    params: github.LicensesGetAllCommonlyUsedParams
  ): Promise<github.LicensesGetAllCommonlyUsedResponse> {
    return this.ky
      .get('/licenses', {
        searchParams: sanitizeSearchParams(
          pick(params, 'featured', 'per_page', 'page')
        )
      })
      .json<github.LicensesGetAllCommonlyUsedResponse>()
  }

  /**
   * Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).".
   */
  @aiFunction({
    name: 'github_licenses_get',
    description: `Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).".`,
    inputSchema: github.LicensesGetParamsSchema,
    tags: ['licenses']
  })
  async licensesGet(
    params: github.LicensesGetParams
  ): Promise<github.LicensesGetResponse> {
    return this.ky
      .get(`/licenses/${params.license}`)
      .json<github.LicensesGetResponse>()
  }

  /**
   * Render a Markdown document.
   */
  @aiFunction({
    name: 'github_markdown_render',
    description: `Render a Markdown document.`,
    inputSchema: github.MarkdownRenderParamsSchema,
    tags: ['markdown']
  })
  async markdownRender(
    params: github.MarkdownRenderParams
  ): Promise<github.MarkdownRenderResponse> {
    return this.ky
      .post('/markdown', {
        json: pick(params, 'text', 'mode', 'context')
      })
      .json<github.MarkdownRenderResponse>()
  }

  /**
   * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
   */
  @aiFunction({
    name: 'github_markdown_render_raw',
    description: `You must send Markdown as plain text (using a \`Content-Type\` header of \`text/plain\` or \`text/x-markdown\`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.`,
    inputSchema: github.MarkdownRenderRawParamsSchema,
    tags: ['markdown']
  })
  async markdownRenderRaw(
    _params: github.MarkdownRenderRawParams
  ): Promise<github.MarkdownRenderRawResponse> {
    return this.ky
      .post('/markdown/raw')
      .json<github.MarkdownRenderRawResponse>()
  }

  /**
 * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_subscription_plan_for_account',
    description: `Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsGetSubscriptionPlanForAccountParamsSchema,
    tags: ['apps']
  })
  async appsGetSubscriptionPlanForAccount(
    params: github.AppsGetSubscriptionPlanForAccountParams
  ): Promise<github.AppsGetSubscriptionPlanForAccountResponse> {
    return this.ky
      .get(`/marketplace_listing/accounts/${params.account_id}`)
      .json<github.AppsGetSubscriptionPlanForAccountResponse>()
  }

  /**
 * Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_plans',
    description: `Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsListPlansParamsSchema,
    tags: ['apps']
  })
  async appsListPlans(
    params: github.AppsListPlansParams
  ): Promise<github.AppsListPlansResponse> {
    return this.ky
      .get('/marketplace_listing/plans', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListPlansResponse>()
  }

  /**
 * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_accounts_for_plan',
    description: `Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsListAccountsForPlanParamsSchema,
    tags: ['apps']
  })
  async appsListAccountsForPlan(
    params: github.AppsListAccountsForPlanParams
  ): Promise<github.AppsListAccountsForPlanResponse> {
    return this.ky
      .get(`/marketplace_listing/plans/${params.plan_id}/accounts`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.AppsListAccountsForPlanResponse>()
  }

  /**
 * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_subscription_plan_for_account_stubbed',
    description: `Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsGetSubscriptionPlanForAccountStubbedParamsSchema,
    tags: ['apps']
  })
  async appsGetSubscriptionPlanForAccountStubbed(
    params: github.AppsGetSubscriptionPlanForAccountStubbedParams
  ): Promise<github.AppsGetSubscriptionPlanForAccountStubbedResponse> {
    return this.ky
      .get(`/marketplace_listing/stubbed/accounts/${params.account_id}`)
      .json<github.AppsGetSubscriptionPlanForAccountStubbedResponse>()
  }

  /**
 * Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_plans_stubbed',
    description: `Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsListPlansStubbedParamsSchema,
    tags: ['apps']
  })
  async appsListPlansStubbed(
    params: github.AppsListPlansStubbedParams
  ): Promise<github.AppsListPlansStubbedResponse> {
    return this.ky
      .get('/marketplace_listing/stubbed/plans', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListPlansStubbedResponse>()
  }

  /**
 * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_list_accounts_for_plan_stubbed',
    description: `Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.`,
    inputSchema: github.AppsListAccountsForPlanStubbedParamsSchema,
    tags: ['apps']
  })
  async appsListAccountsForPlanStubbed(
    params: github.AppsListAccountsForPlanStubbedParams
  ): Promise<github.AppsListAccountsForPlanStubbedResponse> {
    return this.ky
      .get(`/marketplace_listing/stubbed/plans/${params.plan_id}/accounts`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.AppsListAccountsForPlanStubbedResponse>()
  }

  /**
 * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."

The API's response also includes a list of GitHub's domain names.

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

> [!NOTE]
> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
 */
  @aiFunction({
    name: 'github_meta_get',
    description: `Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."

The API's response also includes a list of GitHub's domain names.

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

> [!NOTE]
> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.`,
    inputSchema: github.MetaGetParamsSchema,
    tags: ['meta']
  })
  async metaGet(
    _params: github.MetaGetParams
  ): Promise<github.MetaGetResponse> {
    return this.ky.get('/meta').json<github.MetaGetResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_public_events_for_repo_network',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListPublicEventsForRepoNetworkParamsSchema,
    tags: ['activity']
  })
  async activityListPublicEventsForRepoNetwork(
    params: github.ActivityListPublicEventsForRepoNetworkParams
  ): Promise<github.ActivityListPublicEventsForRepoNetworkResponse> {
    return this.ky
      .get(`/networks/${params.owner}/${params.repo}/events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListPublicEventsForRepoNetworkResponse>()
  }

  /**
   * List all notifications for the current user, sorted by most recently updated.
   */
  @aiFunction({
    name: 'github_activity_list_notifications_for_authenticated_user',
    description: `List all notifications for the current user, sorted by most recently updated.`,
    inputSchema:
      github.ActivityListNotificationsForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListNotificationsForAuthenticatedUser(
    params: github.ActivityListNotificationsForAuthenticatedUserParams
  ): Promise<github.ActivityListNotificationsForAuthenticatedUserResponse> {
    return this.ky
      .get('/notifications', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'all',
            'participating',
            'since',
            'before',
            'page',
            'per_page'
          )
        )
      })
      .json<github.ActivityListNotificationsForAuthenticatedUserResponse>()
  }

  /**
   * Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
   */
  @aiFunction({
    name: 'github_activity_mark_notifications_as_read',
    description: `Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a \`202 Accepted\` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter \`all=false\`.`,
    inputSchema: github.ActivityMarkNotificationsAsReadParamsSchema,
    tags: ['activity']
  })
  async activityMarkNotificationsAsRead(
    params: github.ActivityMarkNotificationsAsReadParams
  ): Promise<github.ActivityMarkNotificationsAsReadResponse> {
    return this.ky
      .put('/notifications', {
        json: pick(params, 'last_read_at', 'read')
      })
      .json<github.ActivityMarkNotificationsAsReadResponse>()
  }

  /**
   * Gets information about a notification thread.
   */
  @aiFunction({
    name: 'github_activity_get_thread',
    description: `Gets information about a notification thread.`,
    inputSchema: github.ActivityGetThreadParamsSchema,
    tags: ['activity']
  })
  async activityGetThread(
    params: github.ActivityGetThreadParams
  ): Promise<github.ActivityGetThreadResponse> {
    return this.ky
      .get(`/notifications/threads/${params.thread_id}`)
      .json<github.ActivityGetThreadResponse>()
  }

  /**
   * Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
   */
  @aiFunction({
    name: 'github_activity_mark_thread_as_done',
    description: `Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.`,
    inputSchema: github.ActivityMarkThreadAsDoneParamsSchema,
    tags: ['activity']
  })
  async activityMarkThreadAsDone(
    params: github.ActivityMarkThreadAsDoneParams
  ): Promise<github.ActivityMarkThreadAsDoneResponse> {
    return this.ky
      .delete(`/notifications/threads/${params.thread_id}`)
      .json<github.ActivityMarkThreadAsDoneResponse>()
  }

  /**
   * Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
   */
  @aiFunction({
    name: 'github_activity_mark_thread_as_read',
    description: `Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.`,
    inputSchema: github.ActivityMarkThreadAsReadParamsSchema,
    tags: ['activity']
  })
  async activityMarkThreadAsRead(
    params: github.ActivityMarkThreadAsReadParams
  ): Promise<github.ActivityMarkThreadAsReadResponse> {
    return this.ky
      .patch(`/notifications/threads/${params.thread_id}`)
      .json<github.ActivityMarkThreadAsReadResponse>()
  }

  /**
 * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.
 */
  @aiFunction({
    name: 'github_activity_get_thread_subscription_for_authenticated_user',
    description: `This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.`,
    inputSchema:
      github.ActivityGetThreadSubscriptionForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityGetThreadSubscriptionForAuthenticatedUser(
    params: github.ActivityGetThreadSubscriptionForAuthenticatedUserParams
  ): Promise<github.ActivityGetThreadSubscriptionForAuthenticatedUserResponse> {
    return this.ky
      .get(`/notifications/threads/${params.thread_id}/subscription`)
      .json<github.ActivityGetThreadSubscriptionForAuthenticatedUserResponse>()
  }

  /**
 * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.
 */
  @aiFunction({
    name: 'github_activity_set_thread_subscription',
    description: `If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.`,
    inputSchema: github.ActivitySetThreadSubscriptionParamsSchema,
    tags: ['activity']
  })
  async activitySetThreadSubscription(
    params: github.ActivitySetThreadSubscriptionParams
  ): Promise<github.ActivitySetThreadSubscriptionResponse> {
    return this.ky
      .put(`/notifications/threads/${params.thread_id}/subscription`, {
        json: pick(params, 'ignored')
      })
      .json<github.ActivitySetThreadSubscriptionResponse>()
  }

  /**
   * Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.
   */
  @aiFunction({
    name: 'github_activity_delete_thread_subscription',
    description: `Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set \`ignore\` to \`true\`.`,
    inputSchema: github.ActivityDeleteThreadSubscriptionParamsSchema,
    tags: ['activity']
  })
  async activityDeleteThreadSubscription(
    params: github.ActivityDeleteThreadSubscriptionParams
  ): Promise<github.ActivityDeleteThreadSubscriptionResponse> {
    return this.ky
      .delete(`/notifications/threads/${params.thread_id}/subscription`)
      .json<github.ActivityDeleteThreadSubscriptionResponse>()
  }

  /**
   * Get the octocat as ASCII art.
   */
  @aiFunction({
    name: 'github_meta_get_octocat',
    description: `Get the octocat as ASCII art.`,
    inputSchema: github.MetaGetOctocatParamsSchema,
    tags: ['meta']
  })
  async metaGetOctocat(
    params: github.MetaGetOctocatParams
  ): Promise<github.MetaGetOctocatResponse> {
    return this.ky
      .get('/octocat', {
        searchParams: sanitizeSearchParams(params)
      })
      .json<github.MetaGetOctocatResponse>()
  }

  /**
 * Lists all organizations, in the order that they were created.

> [!NOTE]
> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
 */
  @aiFunction({
    name: 'github_orgs_list',
    description: `Lists all organizations, in the order that they were created.

> [!NOTE]
> Pagination is powered exclusively by the \`since\` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.`,
    inputSchema: github.OrgsListParamsSchema,
    tags: ['orgs']
  })
  async orgsList(
    params: github.OrgsListParams
  ): Promise<github.OrgsListResponse> {
    return this.ky
      .get('/organizations', {
        searchParams: sanitizeSearchParams(pick(params, 'since', 'per_page'))
      })
      .json<github.OrgsListResponse>()
  }

  /**
 * Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).".
 */
  @aiFunction({
    name: 'github_billing_get_github_billing_usage_report_org',
    description: `Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).".`,
    inputSchema: github.BillingGetGithubBillingUsageReportOrgParamsSchema,
    tags: ['billing']
  })
  async billingGetGithubBillingUsageReportOrg(
    params: github.BillingGetGithubBillingUsageReportOrgParams
  ): Promise<github.BillingGetGithubBillingUsageReportOrgResponse> {
    return this.ky
      .get(`/organizations/${params.org}/settings/billing/usage`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'year', 'month', 'day', 'hour')
        )
      })
      .json<github.BillingGetGithubBillingUsageReportOrgResponse>()
  }

  /**
 * Gets information about an organization.

When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).

To see the full details about an organization, the authenticated user must be an organization owner.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.

To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
 */
  @aiFunction({
    name: 'github_orgs_get',
    description: `Gets information about an organization.

When the value of \`two_factor_requirement_enabled\` is \`true\`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).

To see the full details about an organization, the authenticated user must be an organization owner.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to see the full details about an organization.

To see information about an organization's GitHub plan, GitHub Apps need the \`Organization plan\` permission.`,
    inputSchema: github.OrgsGetParamsSchema,
    tags: ['orgs']
  })
  async orgsGet(params: github.OrgsGetParams): Promise<github.OrgsGetResponse> {
    return this.ky.get(`/orgs/${params.org}`).json<github.OrgsGetResponse>()
  }

  /**
 * Deletes an organization and all its repositories.

The organization login will be unavailable for 90 days after deletion.

Please review the Terms of Service regarding account deletion before using this endpoint:

https://docs.github.com/site-policy/github-terms/github-terms-of-service.
 */
  @aiFunction({
    name: 'github_orgs_delete',
    description: `Deletes an organization and all its repositories.

The organization login will be unavailable for 90 days after deletion.

Please review the Terms of Service regarding account deletion before using this endpoint:

https://docs.github.com/site-policy/github-terms/github-terms-of-service.`,
    inputSchema: github.OrgsDeleteParamsSchema,
    tags: ['orgs']
  })
  async orgsDelete(
    params: github.OrgsDeleteParams
  ): Promise<github.OrgsDeleteResponse> {
    return this.ky
      .delete(`/orgs/${params.org}`)
      .json<github.OrgsDeleteResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).

> [!WARNING]
> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).

Updates the organization's profile and member privileges.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_update',
    description: `> [!WARNING]
> **Closing down notice:** GitHub will replace and discontinue \`members_allowed_repository_creation_type\` in favor of more granular permissions. The new input parameters are \`members_can_create_public_repositories\`, \`members_can_create_private_repositories\` for all organizations and \`members_can_create_internal_repositories\` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).

> [!WARNING]
> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).

Updates the organization's profile and member privileges.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` or \`repo\` scope to use this endpoint.`,
    inputSchema: github.OrgsUpdateParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdate(
    params: github.OrgsUpdateParams
  ): Promise<github.OrgsUpdateResponse> {
    return this.ky
      .patch(`/orgs/${params.org}`, {
        json: pick(
          params,
          'billing_email',
          'company',
          'email',
          'twitter_username',
          'location',
          'name',
          'description',
          'has_organization_projects',
          'has_repository_projects',
          'default_repository_permission',
          'members_can_create_repositories',
          'members_can_create_internal_repositories',
          'members_can_create_private_repositories',
          'members_can_create_public_repositories',
          'members_allowed_repository_creation_type',
          'members_can_create_pages',
          'members_can_create_public_pages',
          'members_can_create_private_pages',
          'members_can_fork_private_repositories',
          'web_commit_signoff_required',
          'blog',
          'advanced_security_enabled_for_new_repositories',
          'dependabot_alerts_enabled_for_new_repositories',
          'dependabot_security_updates_enabled_for_new_repositories',
          'dependency_graph_enabled_for_new_repositories',
          'secret_scanning_enabled_for_new_repositories',
          'secret_scanning_push_protection_enabled_for_new_repositories',
          'secret_scanning_push_protection_custom_link_enabled',
          'secret_scanning_push_protection_custom_link',
          'deploy_keys_enabled_for_repositories'
        )
      })
      .json<github.OrgsUpdateResponse>()
  }

  /**
 * Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_actions_cache_usage_for_org',
    description: `Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the \`read:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetActionsCacheUsageForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetActionsCacheUsageForOrg(
    params: github.ActionsGetActionsCacheUsageForOrgParams
  ): Promise<github.ActionsGetActionsCacheUsageForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/cache/usage`)
      .json<github.ActionsGetActionsCacheUsageForOrgResponse>()
  }

  /**
 * Lists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_actions_cache_usage_by_repo_for_org',
    description: `Lists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the \`read:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetActionsCacheUsageByRepoForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetActionsCacheUsageByRepoForOrg(
    params: github.ActionsGetActionsCacheUsageByRepoForOrgParams
  ): Promise<github.ActionsGetActionsCacheUsageByRepoForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/cache/usage-by-repository`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsGetActionsCacheUsageByRepoForOrgResponse>()
  }

  /**
 * Lists all GitHub-hosted runners configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_hosted_runners_for_org',
    description: `Lists all GitHub-hosted runners configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`manage_runner:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsListHostedRunnersForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListHostedRunnersForOrg(
    params: github.ActionsListHostedRunnersForOrgParams
  ): Promise<github.ActionsListHostedRunnersForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListHostedRunnersForOrgResponse>()
  }

  /**
 * Creates a GitHub-hosted runner for an organization.
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_hosted_runner_for_org',
    description: `Creates a GitHub-hosted runner for an organization.
OAuth tokens and personal access tokens (classic) need the \`manage_runners:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsCreateHostedRunnerForOrg(
    params: github.ActionsCreateHostedRunnerForOrgParams
  ): Promise<github.ActionsCreateHostedRunnerForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/hosted-runners`, {
        json: pick(
          params,
          'name',
          'image',
          'size',
          'runner_group_id',
          'maximum_runners',
          'enable_static_ip'
        )
      })
      .json<github.ActionsCreateHostedRunnerForOrgResponse>()
  }

  /**
   * Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.
   */
  @aiFunction({
    name: 'github_actions_get_hosted_runners_github_owned_images_for_org',
    description: `Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.`,
    inputSchema:
      github.ActionsGetHostedRunnersGithubOwnedImagesForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnersGithubOwnedImagesForOrg(
    params: github.ActionsGetHostedRunnersGithubOwnedImagesForOrgParams
  ): Promise<github.ActionsGetHostedRunnersGithubOwnedImagesForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners/images/github-owned`)
      .json<github.ActionsGetHostedRunnersGithubOwnedImagesForOrgResponse>()
  }

  /**
   * Get the list of partner images available for GitHub-hosted runners for an organization.
   */
  @aiFunction({
    name: 'github_actions_get_hosted_runners_partner_images_for_org',
    description: `Get the list of partner images available for GitHub-hosted runners for an organization.`,
    inputSchema: github.ActionsGetHostedRunnersPartnerImagesForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnersPartnerImagesForOrg(
    params: github.ActionsGetHostedRunnersPartnerImagesForOrgParams
  ): Promise<github.ActionsGetHostedRunnersPartnerImagesForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners/images/partner`)
      .json<github.ActionsGetHostedRunnersPartnerImagesForOrgResponse>()
  }

  /**
   * Get the GitHub-hosted runners limits for an organization.
   */
  @aiFunction({
    name: 'github_actions_get_hosted_runners_limits_for_org',
    description: `Get the GitHub-hosted runners limits for an organization.`,
    inputSchema: github.ActionsGetHostedRunnersLimitsForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnersLimitsForOrg(
    params: github.ActionsGetHostedRunnersLimitsForOrgParams
  ): Promise<github.ActionsGetHostedRunnersLimitsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners/limits`)
      .json<github.ActionsGetHostedRunnersLimitsForOrgResponse>()
  }

  /**
   * Get the list of machine specs available for GitHub-hosted runners for an organization.
   */
  @aiFunction({
    name: 'github_actions_get_hosted_runners_machine_specs_for_org',
    description: `Get the list of machine specs available for GitHub-hosted runners for an organization.`,
    inputSchema: github.ActionsGetHostedRunnersMachineSpecsForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnersMachineSpecsForOrg(
    params: github.ActionsGetHostedRunnersMachineSpecsForOrgParams
  ): Promise<github.ActionsGetHostedRunnersMachineSpecsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners/machine-sizes`)
      .json<github.ActionsGetHostedRunnersMachineSpecsForOrgResponse>()
  }

  /**
   * Get the list of platforms available for GitHub-hosted runners for an organization.
   */
  @aiFunction({
    name: 'github_actions_get_hosted_runners_platforms_for_org',
    description: `Get the list of platforms available for GitHub-hosted runners for an organization.`,
    inputSchema: github.ActionsGetHostedRunnersPlatformsForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnersPlatformsForOrg(
    params: github.ActionsGetHostedRunnersPlatformsForOrgParams
  ): Promise<github.ActionsGetHostedRunnersPlatformsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/hosted-runners/platforms`)
      .json<github.ActionsGetHostedRunnersPlatformsForOrgResponse>()
  }

  /**
 * Gets a GitHub-hosted runner configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_hosted_runner_for_org',
    description: `Gets a GitHub-hosted runner configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`manage_runners:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetHostedRunnerForOrg(
    params: github.ActionsGetHostedRunnerForOrgParams
  ): Promise<github.ActionsGetHostedRunnerForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/hosted-runners/${params.hosted_runner_id}`,
        {}
      )
      .json<github.ActionsGetHostedRunnerForOrgResponse>()
  }

  /**
   * Deletes a GitHub-hosted runner for an organization.
   */
  @aiFunction({
    name: 'github_actions_delete_hosted_runner_for_org',
    description: `Deletes a GitHub-hosted runner for an organization.`,
    inputSchema: github.ActionsDeleteHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteHostedRunnerForOrg(
    params: github.ActionsDeleteHostedRunnerForOrgParams
  ): Promise<github.ActionsDeleteHostedRunnerForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/hosted-runners/${params.hosted_runner_id}`,
        {}
      )
      .json<github.ActionsDeleteHostedRunnerForOrgResponse>()
  }

  /**
 * Updates a GitHub-hosted runner for an organization.
OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_update_hosted_runner_for_org',
    description: `Updates a GitHub-hosted runner for an organization.
OAuth app tokens and personal access tokens (classic) need the \`manage_runners:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsUpdateHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsUpdateHostedRunnerForOrg(
    params: github.ActionsUpdateHostedRunnerForOrgParams
  ): Promise<github.ActionsUpdateHostedRunnerForOrgResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/actions/hosted-runners/${params.hosted_runner_id}`,
        {
          json: pick(
            params,
            'name',
            'runner_group_id',
            'maximum_runners',
            'enable_static_ip'
          )
        }
      )
      .json<github.ActionsUpdateHostedRunnerForOrgResponse>()
  }

  /**
 * Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_oidc_get_oidc_custom_sub_template_for_org',
    description: `Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the \`read:org\` scope to use this endpoint.`,
    inputSchema: github.OidcGetOidcCustomSubTemplateForOrgParamsSchema,
    tags: ['oidc']
  })
  async oidcGetOidcCustomSubTemplateForOrg(
    params: github.OidcGetOidcCustomSubTemplateForOrgParams
  ): Promise<github.OidcGetOidcCustomSubTemplateForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/oidc/customization/sub`)
      .json<github.OidcGetOidcCustomSubTemplateForOrgResponse>()
  }

  /**
 * Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_oidc_update_oidc_custom_sub_template_for_org',
    description: `Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.OidcUpdateOidcCustomSubTemplateForOrgParamsSchema,
    tags: ['oidc']
  })
  async oidcUpdateOidcCustomSubTemplateForOrg(
    params: github.OidcUpdateOidcCustomSubTemplateForOrgParams
  ): Promise<github.OidcUpdateOidcCustomSubTemplateForOrgResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/oidc/customization/sub`, {
        json: pick(params, 'include_claim_keys')
      })
      .json<github.OidcUpdateOidcCustomSubTemplateForOrgResponse>()
  }

  /**
 * Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_github_actions_permissions_organization',
    description: `Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsGetGithubActionsPermissionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsGetGithubActionsPermissionsOrganization(
    params: github.ActionsGetGithubActionsPermissionsOrganizationParams
  ): Promise<github.ActionsGetGithubActionsPermissionsOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/permissions`)
      .json<github.ActionsGetGithubActionsPermissionsOrganizationResponse>()
  }

  /**
 * Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_github_actions_permissions_organization',
    description: `Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetGithubActionsPermissionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsSetGithubActionsPermissionsOrganization(
    params: github.ActionsSetGithubActionsPermissionsOrganizationParams
  ): Promise<github.ActionsSetGithubActionsPermissionsOrganizationResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/permissions`, {
        json: pick(params, 'enabled_repositories', 'allowed_actions')
      })
      .json<github.ActionsSetGithubActionsPermissionsOrganizationResponse>()
  }

  /**
 * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_selected_repositories_enabled_github_actions_organization',
    description: `Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for \`enabled_repositories\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsListSelectedRepositoriesEnabledGithubActionsOrganization(
    params: github.ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams
  ): Promise<github.ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/permissions/repositories`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse>()
  }

  /**
 * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."


OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_selected_repositories_enabled_github_actions_organization',
    description: `Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for \`enabled_repositories\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."


OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsSetSelectedRepositoriesEnabledGithubActionsOrganization(
    params: github.ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationParams
  ): Promise<github.ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/permissions/repositories`, {
        json: pick(params, 'selected_repository_ids')
      })
      .json<github.ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationResponse>()
  }

  /**
 * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_enable_selected_repository_github_actions_organization',
    description: `Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for \`enabled_repositories\` must be must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsEnableSelectedRepositoryGithubActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsEnableSelectedRepositoryGithubActionsOrganization(
    params: github.ActionsEnableSelectedRepositoryGithubActionsOrganizationParams
  ): Promise<github.ActionsEnableSelectedRepositoryGithubActionsOrganizationResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/permissions/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsEnableSelectedRepositoryGithubActionsOrganizationResponse>()
  }

  /**
 * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_disable_selected_repository_github_actions_organization',
    description: `Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for \`enabled_repositories\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsDisableSelectedRepositoryGithubActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsDisableSelectedRepositoryGithubActionsOrganization(
    params: github.ActionsDisableSelectedRepositoryGithubActionsOrganizationParams
  ): Promise<github.ActionsDisableSelectedRepositoryGithubActionsOrganizationResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/permissions/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsDisableSelectedRepositoryGithubActionsOrganizationResponse>()
  }

  /**
 * Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_allowed_actions_organization',
    description: `Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetAllowedActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsGetAllowedActionsOrganization(
    params: github.ActionsGetAllowedActionsOrganizationParams
  ): Promise<github.ActionsGetAllowedActionsOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/permissions/selected-actions`)
      .json<github.ActionsGetAllowedActionsOrganizationResponse>()
  }

  /**
 * Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_allowed_actions_organization',
    description: `Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsSetAllowedActionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsSetAllowedActionsOrganization(
    params: github.ActionsSetAllowedActionsOrganizationParams
  ): Promise<github.ActionsSetAllowedActionsOrganizationResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/permissions/selected-actions`, {
        json: pick(
          params,
          'github_owned_allowed',
          'verified_allowed',
          'patterns_allowed'
        )
      })
      .json<github.ActionsSetAllowedActionsOrganizationResponse>()
  }

  /**
 * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_github_actions_default_workflow_permissions_organization',
    description: `Gets the default workflow permissions granted to the \`GITHUB_TOKEN\` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsGetGithubActionsDefaultWorkflowPermissionsOrganization(
    params: github.ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationParams
  ): Promise<github.ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/permissions/workflow`)
      .json<github.ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationResponse>()
  }

  /**
 * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_github_actions_default_workflow_permissions_organization',
    description: `Sets the default workflow permissions granted to the \`GITHUB_TOKEN\` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema,
    tags: ['actions']
  })
  async actionsSetGithubActionsDefaultWorkflowPermissionsOrganization(
    params: github.ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationParams
  ): Promise<github.ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/permissions/workflow`, {
        json: pick(
          params,
          'default_workflow_permissions',
          'can_approve_pull_request_reviews'
        )
      })
      .json<github.ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationResponse>()
  }

  /**
 * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_self_hosted_runner_groups_for_org',
    description: `Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsListSelfHostedRunnerGroupsForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListSelfHostedRunnerGroupsForOrg(
    params: github.ActionsListSelfHostedRunnerGroupsForOrgParams
  ): Promise<github.ActionsListSelfHostedRunnerGroupsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/runner-groups`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'visible_to_repository')
        )
      })
      .json<github.ActionsListSelfHostedRunnerGroupsForOrgResponse>()
  }

  /**
 * Creates a new self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_self_hosted_runner_group_for_org',
    description: `Creates a new self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateSelfHostedRunnerGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsCreateSelfHostedRunnerGroupForOrg(
    params: github.ActionsCreateSelfHostedRunnerGroupForOrgParams
  ): Promise<github.ActionsCreateSelfHostedRunnerGroupForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/runner-groups`, {
        json: pick(
          params,
          'name',
          'visibility',
          'selected_repository_ids',
          'runners',
          'allows_public_repositories',
          'restricted_to_workflows',
          'selected_workflows',
          'network_configuration_id'
        )
      })
      .json<github.ActionsCreateSelfHostedRunnerGroupForOrgResponse>()
  }

  /**
 * Gets a specific self-hosted runner group for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_self_hosted_runner_group_for_org',
    description: `Gets a specific self-hosted runner group for an organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetSelfHostedRunnerGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetSelfHostedRunnerGroupForOrg(
    params: github.ActionsGetSelfHostedRunnerGroupForOrgParams
  ): Promise<github.ActionsGetSelfHostedRunnerGroupForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}`,
        {}
      )
      .json<github.ActionsGetSelfHostedRunnerGroupForOrgResponse>()
  }

  /**
 * Deletes a self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_self_hosted_runner_group_from_org',
    description: `Deletes a self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteSelfHostedRunnerGroupFromOrgParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteSelfHostedRunnerGroupFromOrg(
    params: github.ActionsDeleteSelfHostedRunnerGroupFromOrgParams
  ): Promise<github.ActionsDeleteSelfHostedRunnerGroupFromOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}`,
        {}
      )
      .json<github.ActionsDeleteSelfHostedRunnerGroupFromOrgResponse>()
  }

  /**
 * Updates the `name` and `visibility` of a self-hosted runner group in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_update_self_hosted_runner_group_for_org',
    description: `Updates the \`name\` and \`visibility\` of a self-hosted runner group in an organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsUpdateSelfHostedRunnerGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsUpdateSelfHostedRunnerGroupForOrg(
    params: github.ActionsUpdateSelfHostedRunnerGroupForOrgParams
  ): Promise<github.ActionsUpdateSelfHostedRunnerGroupForOrgResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}`,
        {
          json: pick(
            params,
            'name',
            'visibility',
            'allows_public_repositories',
            'restricted_to_workflows',
            'selected_workflows',
            'network_configuration_id'
          )
        }
      )
      .json<github.ActionsUpdateSelfHostedRunnerGroupForOrgResponse>()
  }

  /**
 * Lists the GitHub-hosted runners in an organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_github_hosted_runners_in_group_for_org',
    description: `Lists the GitHub-hosted runners in an organization group.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsListGithubHostedRunnersInGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListGithubHostedRunnersInGroupForOrg(
    params: github.ActionsListGithubHostedRunnersInGroupForOrgParams
  ): Promise<github.ActionsListGithubHostedRunnersInGroupForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/hosted-runners`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListGithubHostedRunnersInGroupForOrgResponse>()
  }

  /**
 * Lists the repositories with access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_repo_access_to_self_hosted_runner_group_in_org',
    description: `Lists the repositories with access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoAccessToSelfHostedRunnerGroupInOrg(
    params: github.ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams
  ): Promise<github.ActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse>()
  }

  /**
 * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_repo_access_to_self_hosted_runner_group_in_org',
    description: `Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema,
    tags: ['actions']
  })
  async actionsSetRepoAccessToSelfHostedRunnerGroupInOrg(
    params: github.ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgParams
  ): Promise<github.ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/repositories`,
        {
          json: pick(params, 'selected_repository_ids')
        }
      )
      .json<github.ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgResponse>()
  }

  /**
 * Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_repo_access_to_self_hosted_runner_group_in_org',
    description: `Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have \`visibility\` set to \`selected\`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema,
    tags: ['actions']
  })
  async actionsAddRepoAccessToSelfHostedRunnerGroupInOrg(
    params: github.ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgParams
  ): Promise<github.ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgResponse>()
  }

  /**
 * Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_remove_repo_access_to_self_hosted_runner_group_in_org',
    description: `Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have \`visibility\` set to \`selected\`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveRepoAccessToSelfHostedRunnerGroupInOrg(
    params: github.ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgParams
  ): Promise<github.ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgResponse>()
  }

  /**
 * Lists self-hosted runners that are in a specific organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_self_hosted_runners_in_group_for_org',
    description: `Lists self-hosted runners that are in a specific organization group.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsListSelfHostedRunnersInGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListSelfHostedRunnersInGroupForOrg(
    params: github.ActionsListSelfHostedRunnersInGroupForOrgParams
  ): Promise<github.ActionsListSelfHostedRunnersInGroupForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/runners`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListSelfHostedRunnersInGroupForOrgResponse>()
  }

  /**
 * Replaces the list of self-hosted runners that are part of an organization runner group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_self_hosted_runners_in_group_for_org',
    description: `Replaces the list of self-hosted runners that are part of an organization runner group.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsSetSelfHostedRunnersInGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsSetSelfHostedRunnersInGroupForOrg(
    params: github.ActionsSetSelfHostedRunnersInGroupForOrgParams
  ): Promise<github.ActionsSetSelfHostedRunnersInGroupForOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/runners`,
        {
          json: pick(params, 'runners')
        }
      )
      .json<github.ActionsSetSelfHostedRunnersInGroupForOrgResponse>()
  }

  /**
 * Adds a self-hosted runner to a runner group configured in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_self_hosted_runner_to_group_for_org',
    description: `Adds a self-hosted runner to a runner group configured in an organization.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.ActionsAddSelfHostedRunnerToGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsAddSelfHostedRunnerToGroupForOrg(
    params: github.ActionsAddSelfHostedRunnerToGroupForOrgParams
  ): Promise<github.ActionsAddSelfHostedRunnerToGroupForOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/runners/${params.runner_id}`,
        {}
      )
      .json<github.ActionsAddSelfHostedRunnerToGroupForOrgResponse>()
  }

  /**
 * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_remove_self_hosted_runner_from_group_for_org',
    description: `Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsRemoveSelfHostedRunnerFromGroupForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveSelfHostedRunnerFromGroupForOrg(
    params: github.ActionsRemoveSelfHostedRunnerFromGroupForOrgParams
  ): Promise<github.ActionsRemoveSelfHostedRunnerFromGroupForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runner-groups/${params.runner_group_id}/runners/${params.runner_id}`,
        {}
      )
      .json<github.ActionsRemoveSelfHostedRunnerFromGroupForOrgResponse>()
  }

  /**
 * Lists all self-hosted runners configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_self_hosted_runners_for_org',
    description: `Lists all self-hosted runners configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListSelfHostedRunnersForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListSelfHostedRunnersForOrg(
    params: github.ActionsListSelfHostedRunnersForOrgParams
  ): Promise<github.ActionsListSelfHostedRunnersForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/runners`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'name', 'per_page', 'page')
        )
      })
      .json<github.ActionsListSelfHostedRunnersForOrgResponse>()
  }

  /**
 * Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.  If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_runner_applications_for_org',
    description: `Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.  If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListRunnerApplicationsForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListRunnerApplicationsForOrg(
    params: github.ActionsListRunnerApplicationsForOrgParams
  ): Promise<github.ActionsListRunnerApplicationsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/runners/downloads`)
      .json<github.ActionsListRunnerApplicationsForOrgResponse>()
  }

  /**
 * Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_generate_runner_jitconfig_for_org',
    description: `Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGenerateRunnerJitconfigForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGenerateRunnerJitconfigForOrg(
    params: github.ActionsGenerateRunnerJitconfigForOrgParams
  ): Promise<github.ActionsGenerateRunnerJitconfigForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/runners/generate-jitconfig`, {
        json: pick(params, 'name', 'runner_group_id', 'labels', 'work_folder')
      })
      .json<github.ActionsGenerateRunnerJitconfigForOrgResponse>()
  }

  /**
 * Returns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_registration_token_for_org',
    description: `Returns a token that you can pass to the \`config\` script. The token expires after one hour.

For example, you can replace \`TOKEN\` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\`\`\`
./config.sh --url https://github.com/octo-org --token TOKEN
\`\`\`

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateRegistrationTokenForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsCreateRegistrationTokenForOrg(
    params: github.ActionsCreateRegistrationTokenForOrgParams
  ): Promise<github.ActionsCreateRegistrationTokenForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/runners/registration-token`)
      .json<github.ActionsCreateRegistrationTokenForOrgResponse>()
  }

  /**
 * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_remove_token_for_org',
    description: `Returns a token that you can pass to the \`config\` script to remove a self-hosted runner from an organization. The token expires after one hour.

For example, you can replace \`TOKEN\` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\`\`\`
./config.sh remove --token TOKEN
\`\`\`

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateRemoveTokenForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsCreateRemoveTokenForOrg(
    params: github.ActionsCreateRemoveTokenForOrgParams
  ): Promise<github.ActionsCreateRemoveTokenForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/runners/remove-token`)
      .json<github.ActionsCreateRemoveTokenForOrgResponse>()
  }

  /**
 * Gets a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_get_self_hosted_runner_for_org',
    description: `Gets a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsGetSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsGetSelfHostedRunnerForOrg(
    params: github.ActionsGetSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsGetSelfHostedRunnerForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/runners/${params.runner_id}`, {})
      .json<github.ActionsGetSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_self_hosted_runner_from_org',
    description: `Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteSelfHostedRunnerFromOrgParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteSelfHostedRunnerFromOrg(
    params: github.ActionsDeleteSelfHostedRunnerFromOrgParams
  ): Promise<github.ActionsDeleteSelfHostedRunnerFromOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runners/${params.runner_id}`,
        {}
      )
      .json<github.ActionsDeleteSelfHostedRunnerFromOrgResponse>()
  }

  /**
 * Lists all labels for a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_labels_for_self_hosted_runner_for_org',
    description: `Lists all labels for a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListLabelsForSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsListLabelsForSelfHostedRunnerForOrg(
    params: github.ActionsListLabelsForSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsListLabelsForSelfHostedRunnerForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/runners/${params.runner_id}/labels`,
        {}
      )
      .json<github.ActionsListLabelsForSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Adds custom labels to a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_custom_labels_to_self_hosted_runner_for_org',
    description: `Adds custom labels to a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsAddCustomLabelsToSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsAddCustomLabelsToSelfHostedRunnerForOrg(
    params: github.ActionsAddCustomLabelsToSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsAddCustomLabelsToSelfHostedRunnerForOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/actions/runners/${params.runner_id}/labels`,
        {
          json: pick(params, 'labels')
        }
      )
      .json<github.ActionsAddCustomLabelsToSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_set_custom_labels_for_self_hosted_runner_for_org',
    description: `Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema:
      github.ActionsSetCustomLabelsForSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsSetCustomLabelsForSelfHostedRunnerForOrg(
    params: github.ActionsSetCustomLabelsForSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsSetCustomLabelsForSelfHostedRunnerForOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/runners/${params.runner_id}/labels`,
        {
          json: pick(params, 'labels')
        }
      )
      .json<github.ActionsSetCustomLabelsForSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Remove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_remove_all_custom_labels_from_self_hosted_runner_for_org',
    description: `Remove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema:
      github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrg(
    params: github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runners/${params.runner_id}/labels`,
        {}
      )
      .json<github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Remove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_remove_custom_label_from_self_hosted_runner_for_org',
    description: `Remove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.

This endpoint returns a \`404 Not Found\` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema:
      github.ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveCustomLabelFromSelfHostedRunnerForOrg(
    params: github.ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgParams
  ): Promise<github.ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/runners/${params.runner_id}/labels/${params.name}`,
        {}
      )
      .json<github.ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgResponse>()
  }

  /**
 * Lists all secrets available in an organization without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_org_secrets',
    description: `Lists all secrets available in an organization without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListOrgSecretsParamsSchema,
    tags: ['actions']
  })
  async actionsListOrgSecrets(
    params: github.ActionsListOrgSecretsParams
  ): Promise<github.ActionsListOrgSecretsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListOrgSecretsResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_org_public_key',
    description: `Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetOrgPublicKeyParamsSchema,
    tags: ['actions']
  })
  async actionsGetOrgPublicKey(
    params: github.ActionsGetOrgPublicKeyParams
  ): Promise<github.ActionsGetOrgPublicKeyResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/secrets/public-key`)
      .json<github.ActionsGetOrgPublicKeyResponse>()
  }

  /**
 * Gets a single organization secret without revealing its encrypted value.

The authenticated user must have collaborator access to a repository to create, update, or read secrets

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_org_secret',
    description: `Gets a single organization secret without revealing its encrypted value.

The authenticated user must have collaborator access to a repository to create, update, or read secrets

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsGetOrgSecret(
    params: github.ActionsGetOrgSecretParams
  ): Promise<github.ActionsGetOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsGetOrgSecretResponse>()
  }

  /**
 * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_or_update_org_secret',
    description: `Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateOrUpdateOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsCreateOrUpdateOrgSecret(
    params: github.ActionsCreateOrUpdateOrgSecretParams
  ): Promise<github.ActionsCreateOrUpdateOrgSecretResponse> {
    return this.ky
      .put(`/orgs/${params.org}/actions/secrets/${params.secret_name}`, {
        json: pick(
          params,
          'encrypted_value',
          'key_id',
          'visibility',
          'selected_repository_ids'
        )
      })
      .json<github.ActionsCreateOrUpdateOrgSecretResponse>()
  }

  /**
 * Deletes a secret in an organization using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_org_secret',
    description: `Deletes a secret in an organization using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteOrgSecret(
    params: github.ActionsDeleteOrgSecretParams
  ): Promise<github.ActionsDeleteOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsDeleteOrgSecretResponse>()
  }

  /**
 * Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_selected_repos_for_org_secret',
    description: `Lists all repositories that have been selected when the \`visibility\`
for repository access to a secret is set to \`selected\`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListSelectedReposForOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsListSelectedReposForOrgSecret(
    params: github.ActionsListSelectedReposForOrgSecretParams
  ): Promise<github.ActionsListSelectedReposForOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ActionsListSelectedReposForOrgSecretResponse>()
  }

  /**
 * Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_set_selected_repos_for_org_secret',
    description: `Replaces all repositories for an organization secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsSetSelectedReposForOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsSetSelectedReposForOrgSecret(
    params: github.ActionsSetSelectedReposForOrgSecretParams
  ): Promise<github.ActionsSetSelectedReposForOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}/repositories`,
        {
          json: pick(params, 'selected_repository_ids')
        }
      )
      .json<github.ActionsSetSelectedReposForOrgSecretResponse>()
  }

  /**
 * Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. For more information about setting the visibility, see [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_selected_repo_to_org_secret',
    description: `Adds a repository to an organization secret when the \`visibility\` for
repository access is set to \`selected\`. For more information about setting the visibility, see [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsAddSelectedRepoToOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsAddSelectedRepoToOrgSecret(
    params: github.ActionsAddSelectedRepoToOrgSecretParams
  ): Promise<github.ActionsAddSelectedRepoToOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsAddSelectedRepoToOrgSecretResponse>()
  }

  /**
 * Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_remove_selected_repo_from_org_secret',
    description: `Removes a repository from an organization secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsRemoveSelectedRepoFromOrgSecretParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveSelectedRepoFromOrgSecret(
    params: github.ActionsRemoveSelectedRepoFromOrgSecretParams
  ): Promise<github.ActionsRemoveSelectedRepoFromOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsRemoveSelectedRepoFromOrgSecretResponse>()
  }

  /**
 * Lists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_org_variables',
    description: `Lists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListOrgVariablesParamsSchema,
    tags: ['actions']
  })
  async actionsListOrgVariables(
    params: github.ActionsListOrgVariablesParams
  ): Promise<github.ActionsListOrgVariablesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/variables`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListOrgVariablesResponse>()
  }

  /**
 * Creates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_org_variable',
    description: `Creates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsCreateOrgVariable(
    params: github.ActionsCreateOrgVariableParams
  ): Promise<github.ActionsCreateOrgVariableResponse> {
    return this.ky
      .post(`/orgs/${params.org}/actions/variables`, {
        json: pick(
          params,
          'name',
          'value',
          'visibility',
          'selected_repository_ids'
        )
      })
      .json<github.ActionsCreateOrgVariableResponse>()
  }

  /**
 * Gets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_org_variable',
    description: `Gets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsGetOrgVariable(
    params: github.ActionsGetOrgVariableParams
  ): Promise<github.ActionsGetOrgVariableResponse> {
    return this.ky
      .get(`/orgs/${params.org}/actions/variables/${params.name}`, {})
      .json<github.ActionsGetOrgVariableResponse>()
  }

  /**
 * Deletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_org_variable',
    description: `Deletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the\`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteOrgVariable(
    params: github.ActionsDeleteOrgVariableParams
  ): Promise<github.ActionsDeleteOrgVariableResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/actions/variables/${params.name}`, {})
      .json<github.ActionsDeleteOrgVariableResponse>()
  }

  /**
 * Updates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_update_org_variable',
    description: `Updates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsUpdateOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsUpdateOrgVariable(
    params: github.ActionsUpdateOrgVariableParams
  ): Promise<github.ActionsUpdateOrgVariableResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/actions/variables/${params.name}`, {
        json: pick(
          params,
          'name',
          'value',
          'visibility',
          'selected_repository_ids'
        )
      })
      .json<github.ActionsUpdateOrgVariableResponse>()
  }

  /**
 * Lists all repositories that can access an organization variable
that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_list_selected_repos_for_org_variable',
    description: `Lists all repositories that can access an organization variable
that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsListSelectedReposForOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsListSelectedReposForOrgVariable(
    params: github.ActionsListSelectedReposForOrgVariableParams
  ): Promise<github.ActionsListSelectedReposForOrgVariableResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/actions/variables/${params.name}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ActionsListSelectedReposForOrgVariableResponse>()
  }

  /**
 * Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_set_selected_repos_for_org_variable',
    description: `Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their \`visibility\` field set to \`selected\`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsSetSelectedReposForOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsSetSelectedReposForOrgVariable(
    params: github.ActionsSetSelectedReposForOrgVariableParams
  ): Promise<github.ActionsSetSelectedReposForOrgVariableResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/variables/${params.name}/repositories`,
        {
          json: pick(params, 'selected_repository_ids')
        }
      )
      .json<github.ActionsSetSelectedReposForOrgVariableResponse>()
  }

  /**
 * Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_selected_repo_to_org_variable',
    description: `Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their \`visibility\` field set to \`selected\`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsAddSelectedRepoToOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsAddSelectedRepoToOrgVariable(
    params: github.ActionsAddSelectedRepoToOrgVariableParams
  ): Promise<github.ActionsAddSelectedRepoToOrgVariableResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/actions/variables/${params.name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsAddSelectedRepoToOrgVariableResponse>()
  }

  /**
 * Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
 */
  @aiFunction({
    name: 'github_actions_remove_selected_repo_from_org_variable',
    description: `Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their \`visibility\` field set to \`selected\`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint. If the repository is private, the \`repo\` scope is also required.`,
    inputSchema: github.ActionsRemoveSelectedRepoFromOrgVariableParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveSelectedRepoFromOrgVariable(
    params: github.ActionsRemoveSelectedRepoFromOrgVariableParams
  ): Promise<github.ActionsRemoveSelectedRepoFromOrgVariableResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/actions/variables/${params.name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.ActionsRemoveSelectedRepoFromOrgVariableResponse>()
  }

  /**
 * List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
 */
  @aiFunction({
    name: 'github_orgs_list_attestations',
    description: `List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the \`attestations:read\` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI \`attestation verify\` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).`,
    inputSchema: github.OrgsListAttestationsParamsSchema,
    tags: ['orgs']
  })
  async orgsListAttestations(
    params: github.OrgsListAttestationsParams
  ): Promise<github.OrgsListAttestationsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/attestations/${params.subject_digest}`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'before', 'after', 'predicate_type')
        )
      })
      .json<github.OrgsListAttestationsResponse>()
  }

  /**
   * List the users blocked by an organization.
   */
  @aiFunction({
    name: 'github_orgs_list_blocked_users',
    description: `List the users blocked by an organization.`,
    inputSchema: github.OrgsListBlockedUsersParamsSchema,
    tags: ['orgs']
  })
  async orgsListBlockedUsers(
    params: github.OrgsListBlockedUsersParams
  ): Promise<github.OrgsListBlockedUsersResponse> {
    return this.ky
      .get(`/orgs/${params.org}/blocks`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListBlockedUsersResponse>()
  }

  /**
   * Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
   */
  @aiFunction({
    name: 'github_orgs_check_blocked_user',
    description: `Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.`,
    inputSchema: github.OrgsCheckBlockedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsCheckBlockedUser(
    params: github.OrgsCheckBlockedUserParams
  ): Promise<github.OrgsCheckBlockedUserResponse> {
    return this.ky
      .get(`/orgs/${params.org}/blocks/${params.username}`, {})
      .json<github.OrgsCheckBlockedUserResponse>()
  }

  /**
   * Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
   */
  @aiFunction({
    name: 'github_orgs_block_user',
    description: `Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.`,
    inputSchema: github.OrgsBlockUserParamsSchema,
    tags: ['orgs']
  })
  async orgsBlockUser(
    params: github.OrgsBlockUserParams
  ): Promise<github.OrgsBlockUserResponse> {
    return this.ky
      .put(`/orgs/${params.org}/blocks/${params.username}`, {})
      .json<github.OrgsBlockUserResponse>()
  }

  /**
   * Unblocks the given user on behalf of the specified organization.
   */
  @aiFunction({
    name: 'github_orgs_unblock_user',
    description: `Unblocks the given user on behalf of the specified organization.`,
    inputSchema: github.OrgsUnblockUserParamsSchema,
    tags: ['orgs']
  })
  async orgsUnblockUser(
    params: github.OrgsUnblockUserParams
  ): Promise<github.OrgsUnblockUserResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/blocks/${params.username}`, {})
      .json<github.OrgsUnblockUserResponse>()
  }

  /**
 * Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_list_alerts_for_org',
    description: `Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` or \`repo\`s cope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningListAlertsForOrgParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningListAlertsForOrg(
    params: github.CodeScanningListAlertsForOrgParams
  ): Promise<github.CodeScanningListAlertsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/code-scanning/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'tool_name',
            'tool_guid',
            'before',
            'after',
            'page',
            'per_page',
            'direction',
            'state',
            'sort',
            'severity'
          )
        )
      })
      .json<github.CodeScanningListAlertsForOrgResponse>()
  }

  /**
 * Lists all code security configurations available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_configurations_for_org',
    description: `Lists all code security configurations available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetConfigurationsForOrgParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetConfigurationsForOrg(
    params: github.CodeSecurityGetConfigurationsForOrgParams
  ): Promise<github.CodeSecurityGetConfigurationsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/code-security/configurations`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'target_type', 'per_page', 'before', 'after')
        )
      })
      .json<github.CodeSecurityGetConfigurationsForOrgResponse>()
  }

  /**
 * Creates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_create_configuration',
    description: `Creates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityCreateConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityCreateConfiguration(
    params: github.CodeSecurityCreateConfigurationParams
  ): Promise<github.CodeSecurityCreateConfigurationResponse> {
    return this.ky
      .post(`/orgs/${params.org}/code-security/configurations`, {
        json: pick(
          params,
          'name',
          'description',
          'advanced_security',
          'dependency_graph',
          'dependency_graph_autosubmit_action',
          'dependency_graph_autosubmit_action_options',
          'dependabot_alerts',
          'dependabot_security_updates',
          'code_scanning_default_setup',
          'code_scanning_default_setup_options',
          'code_scanning_delegated_alert_dismissal',
          'secret_scanning',
          'secret_scanning_push_protection',
          'secret_scanning_delegated_bypass',
          'secret_scanning_delegated_bypass_options',
          'secret_scanning_validity_checks',
          'secret_scanning_non_provider_patterns',
          'secret_scanning_generic_secrets',
          'secret_scanning_delegated_alert_dismissal',
          'private_vulnerability_reporting',
          'enforcement'
        )
      })
      .json<github.CodeSecurityCreateConfigurationResponse>()
  }

  /**
 * Lists the default code security configurations for an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_default_configurations',
    description: `Lists the default code security configurations for an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetDefaultConfigurationsParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetDefaultConfigurations(
    params: github.CodeSecurityGetDefaultConfigurationsParams
  ): Promise<github.CodeSecurityGetDefaultConfigurationsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/code-security/configurations/defaults`)
      .json<github.CodeSecurityGetDefaultConfigurationsResponse>()
  }

  /**
 * Detach code security configuration(s) from a set of repositories.
Repositories will retain their settings but will no longer be associated with the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_detach_configuration',
    description: `Detach code security configuration(s) from a set of repositories.
Repositories will retain their settings but will no longer be associated with the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityDetachConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityDetachConfiguration(
    params: github.CodeSecurityDetachConfigurationParams
  ): Promise<github.CodeSecurityDetachConfigurationResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/code-security/configurations/detach`, {
        json: pick(params, 'selected_repository_ids')
      })
      .json<github.CodeSecurityDetachConfigurationResponse>()
  }

  /**
 * Gets a code security configuration available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_configuration',
    description: `Gets a code security configuration available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetConfiguration(
    params: github.CodeSecurityGetConfigurationParams
  ): Promise<github.CodeSecurityGetConfigurationResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}`,
        {}
      )
      .json<github.CodeSecurityGetConfigurationResponse>()
  }

  /**
 * Deletes the desired code security configuration from an organization.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_delete_configuration',
    description: `Deletes the desired code security configuration from an organization.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityDeleteConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityDeleteConfiguration(
    params: github.CodeSecurityDeleteConfigurationParams
  ): Promise<github.CodeSecurityDeleteConfigurationResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}`,
        {}
      )
      .json<github.CodeSecurityDeleteConfigurationResponse>()
  }

  /**
 * Updates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_update_configuration',
    description: `Updates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityUpdateConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityUpdateConfiguration(
    params: github.CodeSecurityUpdateConfigurationParams
  ): Promise<github.CodeSecurityUpdateConfigurationResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}`,
        {
          json: pick(
            params,
            'name',
            'description',
            'advanced_security',
            'dependency_graph',
            'dependency_graph_autosubmit_action',
            'dependency_graph_autosubmit_action_options',
            'dependabot_alerts',
            'dependabot_security_updates',
            'code_scanning_default_setup',
            'code_scanning_default_setup_options',
            'code_scanning_delegated_alert_dismissal',
            'secret_scanning',
            'secret_scanning_push_protection',
            'secret_scanning_delegated_bypass',
            'secret_scanning_delegated_bypass_options',
            'secret_scanning_validity_checks',
            'secret_scanning_non_provider_patterns',
            'secret_scanning_generic_secrets',
            'secret_scanning_delegated_alert_dismissal',
            'private_vulnerability_reporting',
            'enforcement'
          )
        }
      )
      .json<github.CodeSecurityUpdateConfigurationResponse>()
  }

  /**
 * Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_attach_configuration',
    description: `Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityAttachConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityAttachConfiguration(
    params: github.CodeSecurityAttachConfigurationParams
  ): Promise<github.CodeSecurityAttachConfigurationResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}/attach`,
        {
          json: pick(params, 'scope', 'selected_repository_ids')
        }
      )
      .json<github.CodeSecurityAttachConfigurationResponse>()
  }

  /**
 * Sets a code security configuration as a default to be applied to new repositories in your organization.

This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_set_configuration_as_default',
    description: `Sets a code security configuration as a default to be applied to new repositories in your organization.

This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecuritySetConfigurationAsDefaultParamsSchema,
    tags: ['code-security']
  })
  async codeSecuritySetConfigurationAsDefault(
    params: github.CodeSecuritySetConfigurationAsDefaultParams
  ): Promise<github.CodeSecuritySetConfigurationAsDefaultResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}/defaults`,
        {
          json: pick(params, 'default_for_new_repos')
        }
      )
      .json<github.CodeSecuritySetConfigurationAsDefaultResponse>()
  }

  /**
 * Lists the repositories associated with a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_repositories_for_configuration',
    description: `Lists the repositories associated with a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`write:org\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetRepositoriesForConfigurationParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetRepositoriesForConfiguration(
    params: github.CodeSecurityGetRepositoriesForConfigurationParams
  ): Promise<github.CodeSecurityGetRepositoriesForConfigurationResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/code-security/configurations/${params.configuration_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'before', 'after', 'status')
          )
        }
      )
      .json<github.CodeSecurityGetRepositoriesForConfigurationResponse>()
  }

  /**
 * Lists the codespaces associated to a specified organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_in_organization',
    description: `Lists the codespaces associated to a specified organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListInOrganizationParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListInOrganization(
    params: github.CodespacesListInOrganizationParams
  ): Promise<github.CodespacesListInOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/codespaces`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesListInOrganizationResponse>()
  }

  /**
 * Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_set_codespaces_access',
    description: `Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesSetCodespacesAccessParamsSchema,
    tags: ['codespaces']
  })
  async codespacesSetCodespacesAccess(
    params: github.CodespacesSetCodespacesAccessParams
  ): Promise<github.CodespacesSetCodespacesAccessResponse> {
    return this.ky
      .put(`/orgs/${params.org}/codespaces/access`, {
        json: pick(params, 'visibility', 'selected_usernames')
      })
      .json<github.CodespacesSetCodespacesAccessResponse>()
  }

  /**
 * Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_set_codespaces_access_users',
    description: `Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to \`selected_members\`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesSetCodespacesAccessUsersParamsSchema,
    tags: ['codespaces']
  })
  async codespacesSetCodespacesAccessUsers(
    params: github.CodespacesSetCodespacesAccessUsersParams
  ): Promise<github.CodespacesSetCodespacesAccessUsersResponse> {
    return this.ky
      .post(`/orgs/${params.org}/codespaces/access/selected_users`, {
        json: pick(params, 'selected_usernames')
      })
      .json<github.CodespacesSetCodespacesAccessUsersResponse>()
  }

  /**
 * Codespaces for the specified users will no longer be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_delete_codespaces_access_users',
    description: `Codespaces for the specified users will no longer be billed to the organization.

To use this endpoint, the access settings for the organization must be set to \`selected_members\`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesDeleteCodespacesAccessUsersParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteCodespacesAccessUsers(
    params: github.CodespacesDeleteCodespacesAccessUsersParams
  ): Promise<github.CodespacesDeleteCodespacesAccessUsersResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/codespaces/access/selected_users`, {
        json: pick(params, 'selected_usernames')
      })
      .json<github.CodespacesDeleteCodespacesAccessUsersResponse>()
  }

  /**
 * Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_org_secrets',
    description: `Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListOrgSecretsParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListOrgSecrets(
    params: github.CodespacesListOrgSecretsParams
  ): Promise<github.CodespacesListOrgSecretsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/codespaces/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesListOrgSecretsResponse>()
  }

  /**
 * Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_org_public_key',
    description: `Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetOrgPublicKeyParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetOrgPublicKey(
    params: github.CodespacesGetOrgPublicKeyParams
  ): Promise<github.CodespacesGetOrgPublicKeyResponse> {
    return this.ky
      .get(`/orgs/${params.org}/codespaces/secrets/public-key`)
      .json<github.CodespacesGetOrgPublicKeyResponse>()
  }

  /**
 * Gets an organization development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_org_secret',
    description: `Gets an organization development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetOrgSecret(
    params: github.CodespacesGetOrgSecretParams
  ): Promise<github.CodespacesGetOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}`,
        {}
      )
      .json<github.CodespacesGetOrgSecretResponse>()
  }

  /**
 * Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_create_or_update_org_secret',
    description: `Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesCreateOrUpdateOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCreateOrUpdateOrgSecret(
    params: github.CodespacesCreateOrUpdateOrgSecretParams
  ): Promise<github.CodespacesCreateOrUpdateOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}`,
        {
          json: pick(
            params,
            'encrypted_value',
            'key_id',
            'visibility',
            'selected_repository_ids'
          )
        }
      )
      .json<github.CodespacesCreateOrUpdateOrgSecretResponse>()
  }

  /**
 * Deletes an organization development environment secret using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_delete_org_secret',
    description: `Deletes an organization development environment secret using the secret name.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesDeleteOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteOrgSecret(
    params: github.CodespacesDeleteOrgSecretParams
  ): Promise<github.CodespacesDeleteOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}`,
        {}
      )
      .json<github.CodespacesDeleteOrgSecretResponse>()
  }

  /**
 * Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_selected_repos_for_org_secret',
    description: `Lists all repositories that have been selected when the \`visibility\`
for repository access to a secret is set to \`selected\`.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListSelectedReposForOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListSelectedReposForOrgSecret(
    params: github.CodespacesListSelectedReposForOrgSecretParams
  ): Promise<github.CodespacesListSelectedReposForOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.CodespacesListSelectedReposForOrgSecretResponse>()
  }

  /**
 * Replaces all repositories for an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_set_selected_repos_for_org_secret',
    description: `Replaces all repositories for an organization development environment secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesSetSelectedReposForOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesSetSelectedReposForOrgSecret(
    params: github.CodespacesSetSelectedReposForOrgSecretParams
  ): Promise<github.CodespacesSetSelectedReposForOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}/repositories`,
        {
          json: pick(params, 'selected_repository_ids')
        }
      )
      .json<github.CodespacesSetSelectedReposForOrgSecretResponse>()
  }

  /**
 * Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_add_selected_repo_to_org_secret',
    description: `Adds a repository to an organization development environment secret when the \`visibility\` for repository access is set to \`selected\`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesAddSelectedRepoToOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesAddSelectedRepoToOrgSecret(
    params: github.CodespacesAddSelectedRepoToOrgSecretParams
  ): Promise<github.CodespacesAddSelectedRepoToOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.CodespacesAddSelectedRepoToOrgSecretResponse>()
  }

  /**
 * Removes a repository from an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_remove_selected_repo_from_org_secret',
    description: `Removes a repository from an organization development environment secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesRemoveSelectedRepoFromOrgSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesRemoveSelectedRepoFromOrgSecret(
    params: github.CodespacesRemoveSelectedRepoFromOrgSecretParams
  ): Promise<github.CodespacesRemoveSelectedRepoFromOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/codespaces/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.CodespacesRemoveSelectedRepoFromOrgSecretResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot subscription, including seat breakdown
and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)."

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_get_copilot_organization_details',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot subscription, including seat breakdown
and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)."

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`read:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotGetCopilotOrganizationDetailsParamsSchema,
    tags: ['copilot']
  })
  async copilotGetCopilotOrganizationDetails(
    params: github.CopilotGetCopilotOrganizationDetailsParams
  ): Promise<github.CopilotGetCopilotOrganizationDetailsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/copilot/billing`)
      .json<github.CopilotGetCopilotOrganizationDetailsResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.
Only organization owners can view assigned seats.

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_list_copilot_seats',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.
Only organization owners can view assigned seats.

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in \`last_activity_at\`.
For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`read:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotListCopilotSeatsParamsSchema,
    tags: ['copilot']
  })
  async copilotListCopilotSeats(
    params: github.CopilotListCopilotSeatsParams
  ): Promise<github.CopilotListCopilotSeatsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/copilot/billing/seats`, {
        searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
      })
      .json<github.CopilotListCopilotSeatsResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for all users within each specified team.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_add_copilot_seats_for_teams',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for all users within each specified team.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`admin:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotAddCopilotSeatsForTeamsParamsSchema,
    tags: ['copilot']
  })
  async copilotAddCopilotSeatsForTeams(
    params: github.CopilotAddCopilotSeatsForTeamsParams
  ): Promise<github.CopilotAddCopilotSeatsForTeamsResponse> {
    return this.ky
      .post(`/orgs/${params.org}/copilot/billing/selected_teams`, {
        json: pick(params, 'selected_teams')
      })
      .json<github.CopilotAddCopilotSeatsForTeamsResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all members of each team specified to "pending cancellation".
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_cancel_copilot_seat_assignment_for_teams',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all members of each team specified to "pending cancellation".
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`admin:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotCancelCopilotSeatAssignmentForTeamsParamsSchema,
    tags: ['copilot']
  })
  async copilotCancelCopilotSeatAssignmentForTeams(
    params: github.CopilotCancelCopilotSeatAssignmentForTeamsParams
  ): Promise<github.CopilotCancelCopilotSeatAssignmentForTeamsResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/copilot/billing/selected_teams`, {
        json: pick(params, 'selected_teams')
      })
      .json<github.CopilotCancelCopilotSeatAssignmentForTeamsResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for each user specified.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_add_copilot_seats_for_users',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for each user specified.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`admin:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotAddCopilotSeatsForUsersParamsSchema,
    tags: ['copilot']
  })
  async copilotAddCopilotSeatsForUsers(
    params: github.CopilotAddCopilotSeatsForUsersParams
  ): Promise<github.CopilotAddCopilotSeatsForUsersResponse> {
    return this.ky
      .post(`/orgs/${params.org}/copilot/billing/selected_users`, {
        json: pick(params, 'selected_usernames')
      })
      .json<github.CopilotAddCopilotSeatsForUsersResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all users specified to "pending cancellation".
This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_cancel_copilot_seat_assignment_for_users',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all users specified to "pending cancellation".
This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`admin:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotCancelCopilotSeatAssignmentForUsersParamsSchema,
    tags: ['copilot']
  })
  async copilotCancelCopilotSeatAssignmentForUsers(
    params: github.CopilotCancelCopilotSeatAssignmentForUsersParams
  ): Promise<github.CopilotCancelCopilotSeatAssignmentForUsersResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/copilot/billing/selected_users`, {
        json: pick(params, 'selected_usernames')
      })
      .json<github.CopilotCancelCopilotSeatAssignmentForUsersResponse>()
  }

  /**
 * Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.
Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_copilot_metrics_for_organization',
    description: `Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.
Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\`, \`read:org\`, or \`read:enterprise\` scopes to use this endpoint.`,
    inputSchema: github.CopilotCopilotMetricsForOrganizationParamsSchema,
    tags: ['copilot']
  })
  async copilotCopilotMetricsForOrganization(
    params: github.CopilotCopilotMetricsForOrganizationParams
  ): Promise<github.CopilotCopilotMetricsForOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/copilot/metrics`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'until', 'page', 'per_page')
        )
      })
      .json<github.CopilotCopilotMetricsForOrganizationResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
See the response schema tab for detailed metrics definitions.

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_usage_metrics_for_org',
    description: `> [!NOTE]
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
See the response schema tab for detailed metrics definitions.

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\`, \`read:org\`, or \`read:enterprise\` scopes to use this endpoint.`,
    inputSchema: github.CopilotUsageMetricsForOrgParamsSchema,
    tags: ['copilot']
  })
  async copilotUsageMetricsForOrg(
    params: github.CopilotUsageMetricsForOrgParams
  ): Promise<github.CopilotUsageMetricsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/copilot/usage`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'until', 'page', 'per_page')
        )
      })
      .json<github.CopilotUsageMetricsForOrgResponse>()
  }

  /**
 * Lists Dependabot alerts for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_dependabot_list_alerts_for_org',
    description: `Lists Dependabot alerts for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.DependabotListAlertsForOrgParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListAlertsForOrg(
    params: github.DependabotListAlertsForOrgParams
  ): Promise<github.DependabotListAlertsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/dependabot/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'severity',
            'ecosystem',
            'package',
            'epss_percentage',
            'scope',
            'sort',
            'direction',
            'before',
            'after',
            'first',
            'last',
            'per_page'
          )
        )
      })
      .json<github.DependabotListAlertsForOrgResponse>()
  }

  /**
 * Lists all secrets available in an organization without revealing their
encrypted values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_list_org_secrets',
    description: `Lists all secrets available in an organization without revealing their
encrypted values.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotListOrgSecretsParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListOrgSecrets(
    params: github.DependabotListOrgSecretsParams
  ): Promise<github.DependabotListOrgSecretsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/dependabot/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.DependabotListOrgSecretsResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_get_org_public_key',
    description: `Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotGetOrgPublicKeyParamsSchema,
    tags: ['dependabot']
  })
  async dependabotGetOrgPublicKey(
    params: github.DependabotGetOrgPublicKeyParams
  ): Promise<github.DependabotGetOrgPublicKeyResponse> {
    return this.ky
      .get(`/orgs/${params.org}/dependabot/secrets/public-key`)
      .json<github.DependabotGetOrgPublicKeyResponse>()
  }

  /**
 * Gets a single organization secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_get_org_secret',
    description: `Gets a single organization secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotGetOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotGetOrgSecret(
    params: github.DependabotGetOrgSecretParams
  ): Promise<github.DependabotGetOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}`,
        {}
      )
      .json<github.DependabotGetOrgSecretResponse>()
  }

  /**
 * Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_create_or_update_org_secret',
    description: `Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotCreateOrUpdateOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotCreateOrUpdateOrgSecret(
    params: github.DependabotCreateOrUpdateOrgSecretParams
  ): Promise<github.DependabotCreateOrUpdateOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}`,
        {
          json: pick(
            params,
            'encrypted_value',
            'key_id',
            'visibility',
            'selected_repository_ids'
          )
        }
      )
      .json<github.DependabotCreateOrUpdateOrgSecretResponse>()
  }

  /**
 * Deletes a secret in an organization using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_delete_org_secret',
    description: `Deletes a secret in an organization using the secret name.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotDeleteOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotDeleteOrgSecret(
    params: github.DependabotDeleteOrgSecretParams
  ): Promise<github.DependabotDeleteOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}`,
        {}
      )
      .json<github.DependabotDeleteOrgSecretResponse>()
  }

  /**
 * Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_list_selected_repos_for_org_secret',
    description: `Lists all repositories that have been selected when the \`visibility\`
for repository access to a secret is set to \`selected\`.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotListSelectedReposForOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListSelectedReposForOrgSecret(
    params: github.DependabotListSelectedReposForOrgSecretParams
  ): Promise<github.DependabotListSelectedReposForOrgSecretResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.DependabotListSelectedReposForOrgSecretResponse>()
  }

  /**
 * Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_set_selected_repos_for_org_secret',
    description: `Replaces all repositories for an organization secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotSetSelectedReposForOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotSetSelectedReposForOrgSecret(
    params: github.DependabotSetSelectedReposForOrgSecretParams
  ): Promise<github.DependabotSetSelectedReposForOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}/repositories`,
        {
          json: pick(params, 'selected_repository_ids')
        }
      )
      .json<github.DependabotSetSelectedReposForOrgSecretResponse>()
  }

  /**
 * Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_add_selected_repo_to_org_secret',
    description: `Adds a repository to an organization secret when the \`visibility\` for
repository access is set to \`selected\`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotAddSelectedRepoToOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotAddSelectedRepoToOrgSecret(
    params: github.DependabotAddSelectedRepoToOrgSecretParams
  ): Promise<github.DependabotAddSelectedRepoToOrgSecretResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.DependabotAddSelectedRepoToOrgSecretResponse>()
  }

  /**
 * Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_remove_selected_repo_from_org_secret',
    description: `Removes a repository from an organization secret when the \`visibility\`
for repository access is set to \`selected\`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.DependabotRemoveSelectedRepoFromOrgSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotRemoveSelectedRepoFromOrgSecret(
    params: github.DependabotRemoveSelectedRepoFromOrgSecretParams
  ): Promise<github.DependabotRemoveSelectedRepoFromOrgSecretResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/dependabot/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.DependabotRemoveSelectedRepoFromOrgSecretResponse>()
  }

  /**
 * Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_packages_list_docker_migration_conflicting_packages_for_organization',
    description: `Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint.`,
    inputSchema:
      github.PackagesListDockerMigrationConflictingPackagesForOrganizationParamsSchema,
    tags: ['packages']
  })
  async packagesListDockerMigrationConflictingPackagesForOrganization(
    params: github.PackagesListDockerMigrationConflictingPackagesForOrganizationParams
  ): Promise<github.PackagesListDockerMigrationConflictingPackagesForOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/docker/conflicts`)
      .json<github.PackagesListDockerMigrationConflictingPackagesForOrganizationResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_public_org_events',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListPublicOrgEventsParamsSchema,
    tags: ['activity']
  })
  async activityListPublicOrgEvents(
    params: github.ActivityListPublicOrgEventsParams
  ): Promise<github.ActivityListPublicOrgEventsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListPublicOrgEventsResponse>()
  }

  /**
   * The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
   */
  @aiFunction({
    name: 'github_orgs_list_failed_invitations',
    description: `The return hash contains \`failed_at\` and \`failed_reason\` fields which represent the time at which the invitation failed and the reason for the failure.`,
    inputSchema: github.OrgsListFailedInvitationsParamsSchema,
    tags: ['orgs']
  })
  async orgsListFailedInvitations(
    params: github.OrgsListFailedInvitationsParams
  ): Promise<github.OrgsListFailedInvitationsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/failed_invitations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListFailedInvitationsResponse>()
  }

  /**
 * List webhooks for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_list_webhooks',
    description: `List webhooks for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsListWebhooksParamsSchema,
    tags: ['orgs']
  })
  async orgsListWebhooks(
    params: github.OrgsListWebhooksParams
  ): Promise<github.OrgsListWebhooksResponse> {
    return this.ky
      .get(`/orgs/${params.org}/hooks`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListWebhooksResponse>()
  }

  /**
 * Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_create_webhook',
    description: `Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsCreateWebhookParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateWebhook(
    params: github.OrgsCreateWebhookParams
  ): Promise<github.OrgsCreateWebhookResponse> {
    return this.ky
      .post(`/orgs/${params.org}/hooks`, {
        json: pick(params, 'name', 'config', 'events', 'active')
      })
      .json<github.OrgsCreateWebhookResponse>()
  }

  /**
 * Returns a webhook configured in an organization. To get only the webhook
`config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_get_webhook',
    description: `Returns a webhook configured in an organization. To get only the webhook
\`config\` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsGetWebhookParamsSchema,
    tags: ['orgs']
  })
  async orgsGetWebhook(
    params: github.OrgsGetWebhookParams
  ): Promise<github.OrgsGetWebhookResponse> {
    return this.ky
      .get(`/orgs/${params.org}/hooks/${params.hook_id}`, {})
      .json<github.OrgsGetWebhookResponse>()
  }

  /**
 * Delete a webhook for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_delete_webhook',
    description: `Delete a webhook for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsDeleteWebhookParamsSchema,
    tags: ['orgs']
  })
  async orgsDeleteWebhook(
    params: github.OrgsDeleteWebhookParams
  ): Promise<github.OrgsDeleteWebhookResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/hooks/${params.hook_id}`, {})
      .json<github.OrgsDeleteWebhookResponse>()
  }

  /**
 * Updates a webhook configured in an organization. When you update a webhook,
the `secret` will be overwritten. If you previously had a `secret` set, you must
provide the same `secret` or set a new `secret` or the secret will be removed. If
you are only updating individual webhook `config` properties, use "[Update a webhook
configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_update_webhook',
    description: `Updates a webhook configured in an organization. When you update a webhook,
the \`secret\` will be overwritten. If you previously had a \`secret\` set, you must
provide the same \`secret\` or set a new \`secret\` or the secret will be removed. If
you are only updating individual webhook \`config\` properties, use "[Update a webhook
configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsUpdateWebhookParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdateWebhook(
    params: github.OrgsUpdateWebhookParams
  ): Promise<github.OrgsUpdateWebhookResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/hooks/${params.hook_id}`, {
        json: pick(params, 'config', 'events', 'active', 'name')
      })
      .json<github.OrgsUpdateWebhookResponse>()
  }

  /**
 * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_get_webhook_config_for_org',
    description: `Returns the webhook configuration for an organization. To get more information about the webhook, including the \`active\` state and \`events\`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsGetWebhookConfigForOrgParamsSchema,
    tags: ['orgs']
  })
  async orgsGetWebhookConfigForOrg(
    params: github.OrgsGetWebhookConfigForOrgParams
  ): Promise<github.OrgsGetWebhookConfigForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/hooks/${params.hook_id}/config`, {})
      .json<github.OrgsGetWebhookConfigForOrgResponse>()
  }

  /**
 * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_update_webhook_config_for_org',
    description: `Updates the webhook configuration for an organization. To update more information about the webhook, including the \`active\` state and \`events\`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsUpdateWebhookConfigForOrgParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdateWebhookConfigForOrg(
    params: github.OrgsUpdateWebhookConfigForOrgParams
  ): Promise<github.OrgsUpdateWebhookConfigForOrgResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/hooks/${params.hook_id}/config`, {
        json: pick(params, 'url', 'content_type', 'secret', 'insecure_ssl')
      })
      .json<github.OrgsUpdateWebhookConfigForOrgResponse>()
  }

  /**
 * Returns a list of webhook deliveries for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_list_webhook_deliveries',
    description: `Returns a list of webhook deliveries for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsListWebhookDeliveriesParamsSchema,
    tags: ['orgs']
  })
  async orgsListWebhookDeliveries(
    params: github.OrgsListWebhookDeliveriesParams
  ): Promise<github.OrgsListWebhookDeliveriesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/hooks/${params.hook_id}/deliveries`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'cursor'))
      })
      .json<github.OrgsListWebhookDeliveriesResponse>()
  }

  /**
 * Returns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_get_webhook_delivery',
    description: `Returns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsGetWebhookDeliveryParamsSchema,
    tags: ['orgs']
  })
  async orgsGetWebhookDelivery(
    params: github.OrgsGetWebhookDeliveryParams
  ): Promise<github.OrgsGetWebhookDeliveryResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/hooks/${params.hook_id}/deliveries/${params.delivery_id}`,
        {}
      )
      .json<github.OrgsGetWebhookDeliveryResponse>()
  }

  /**
 * Redeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_redeliver_webhook_delivery',
    description: `Redeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsRedeliverWebhookDeliveryParamsSchema,
    tags: ['orgs']
  })
  async orgsRedeliverWebhookDelivery(
    params: github.OrgsRedeliverWebhookDeliveryParams
  ): Promise<github.OrgsRedeliverWebhookDeliveryResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/hooks/${params.hook_id}/deliveries/${params.delivery_id}/attempts`,
        {}
      )
      .json<github.OrgsRedeliverWebhookDeliveryResponse>()
  }

  /**
 * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
 */
  @aiFunction({
    name: 'github_orgs_ping_webhook',
    description: `This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need \`admin:org_hook\` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.`,
    inputSchema: github.OrgsPingWebhookParamsSchema,
    tags: ['orgs']
  })
  async orgsPingWebhook(
    params: github.OrgsPingWebhookParams
  ): Promise<github.OrgsPingWebhookResponse> {
    return this.ky
      .post(`/orgs/${params.org}/hooks/${params.hook_id}/pings`, {})
      .json<github.OrgsPingWebhookResponse>()
  }

  /**
   * Get API request count statistics for an actor broken down by route within a specified time frame.
   */
  @aiFunction({
    name: 'github_api_insights_get_route_stats_by_actor',
    description: `Get API request count statistics for an actor broken down by route within a specified time frame.`,
    inputSchema: github.ApiInsightsGetRouteStatsByActorParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetRouteStatsByActor(
    params: github.ApiInsightsGetRouteStatsByActorParams
  ): Promise<github.ApiInsightsGetRouteStatsByActorResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/route-stats/${params.actor_type}/${params.actor_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'min_timestamp',
              'max_timestamp',
              'page',
              'per_page',
              'direction',
              'sort',
              'api_route_substring'
            )
          )
        }
      )
      .json<github.ApiInsightsGetRouteStatsByActorResponse>()
  }

  /**
   * Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
   */
  @aiFunction({
    name: 'github_api_insights_get_subject_stats',
    description: `Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.`,
    inputSchema: github.ApiInsightsGetSubjectStatsParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetSubjectStats(
    params: github.ApiInsightsGetSubjectStatsParams
  ): Promise<github.ApiInsightsGetSubjectStatsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/insights/api/subject-stats`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'min_timestamp',
            'max_timestamp',
            'page',
            'per_page',
            'direction',
            'sort',
            'subject_name_substring'
          )
        )
      })
      .json<github.ApiInsightsGetSubjectStatsResponse>()
  }

  /**
   * Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
   */
  @aiFunction({
    name: 'github_api_insights_get_summary_stats',
    description: `Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.`,
    inputSchema: github.ApiInsightsGetSummaryStatsParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetSummaryStats(
    params: github.ApiInsightsGetSummaryStatsParams
  ): Promise<github.ApiInsightsGetSummaryStatsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/insights/api/summary-stats`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'min_timestamp', 'max_timestamp')
        )
      })
      .json<github.ApiInsightsGetSummaryStatsResponse>()
  }

  /**
   * Get overall statistics of API requests within the organization for a user.
   */
  @aiFunction({
    name: 'github_api_insights_get_summary_stats_by_user',
    description: `Get overall statistics of API requests within the organization for a user.`,
    inputSchema: github.ApiInsightsGetSummaryStatsByUserParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetSummaryStatsByUser(
    params: github.ApiInsightsGetSummaryStatsByUserParams
  ): Promise<github.ApiInsightsGetSummaryStatsByUserResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/summary-stats/users/${params.user_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'min_timestamp', 'max_timestamp')
          )
        }
      )
      .json<github.ApiInsightsGetSummaryStatsByUserResponse>()
  }

  /**
   * Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.
   */
  @aiFunction({
    name: 'github_api_insights_get_summary_stats_by_actor',
    description: `Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.`,
    inputSchema: github.ApiInsightsGetSummaryStatsByActorParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetSummaryStatsByActor(
    params: github.ApiInsightsGetSummaryStatsByActorParams
  ): Promise<github.ApiInsightsGetSummaryStatsByActorResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/summary-stats/${params.actor_type}/${params.actor_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'min_timestamp', 'max_timestamp')
          )
        }
      )
      .json<github.ApiInsightsGetSummaryStatsByActorResponse>()
  }

  /**
   * Get the number of API requests and rate-limited requests made within an organization over a specified time period.
   */
  @aiFunction({
    name: 'github_api_insights_get_time_stats',
    description: `Get the number of API requests and rate-limited requests made within an organization over a specified time period.`,
    inputSchema: github.ApiInsightsGetTimeStatsParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetTimeStats(
    params: github.ApiInsightsGetTimeStatsParams
  ): Promise<github.ApiInsightsGetTimeStatsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/insights/api/time-stats`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'min_timestamp', 'max_timestamp', 'timestamp_increment')
        )
      })
      .json<github.ApiInsightsGetTimeStatsResponse>()
  }

  /**
   * Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
   */
  @aiFunction({
    name: 'github_api_insights_get_time_stats_by_user',
    description: `Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.`,
    inputSchema: github.ApiInsightsGetTimeStatsByUserParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetTimeStatsByUser(
    params: github.ApiInsightsGetTimeStatsByUserParams
  ): Promise<github.ApiInsightsGetTimeStatsByUserResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/time-stats/users/${params.user_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'min_timestamp',
              'max_timestamp',
              'timestamp_increment'
            )
          )
        }
      )
      .json<github.ApiInsightsGetTimeStatsByUserResponse>()
  }

  /**
   * Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
   */
  @aiFunction({
    name: 'github_api_insights_get_time_stats_by_actor',
    description: `Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.`,
    inputSchema: github.ApiInsightsGetTimeStatsByActorParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetTimeStatsByActor(
    params: github.ApiInsightsGetTimeStatsByActorParams
  ): Promise<github.ApiInsightsGetTimeStatsByActorResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/time-stats/${params.actor_type}/${params.actor_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'min_timestamp',
              'max_timestamp',
              'timestamp_increment'
            )
          )
        }
      )
      .json<github.ApiInsightsGetTimeStatsByActorResponse>()
  }

  /**
   * Get API usage statistics within an organization for a user broken down by the type of access.
   */
  @aiFunction({
    name: 'github_api_insights_get_user_stats',
    description: `Get API usage statistics within an organization for a user broken down by the type of access.`,
    inputSchema: github.ApiInsightsGetUserStatsParamsSchema,
    tags: ['orgs']
  })
  async apiInsightsGetUserStats(
    params: github.ApiInsightsGetUserStatsParams
  ): Promise<github.ApiInsightsGetUserStatsResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/insights/api/user-stats/${params.user_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'min_timestamp',
              'max_timestamp',
              'page',
              'per_page',
              'direction',
              'sort',
              'actor_name_substring'
            )
          )
        }
      )
      .json<github.ApiInsightsGetUserStatsResponse>()
  }

  /**
 * Enables an authenticated GitHub App to find the organization's installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_org_installation',
    description: `Enables an authenticated GitHub App to find the organization's installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetOrgInstallationParamsSchema,
    tags: ['apps']
  })
  async appsGetOrgInstallation(
    params: github.AppsGetOrgInstallationParams
  ): Promise<github.AppsGetOrgInstallationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/installation`)
      .json<github.AppsGetOrgInstallationResponse>()
  }

  /**
 * Lists all GitHub Apps in an organization. The installation count includes
all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_app_installations',
    description: `Lists all GitHub Apps in an organization. The installation count includes
all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:read\` scope to use this endpoint.`,
    inputSchema: github.OrgsListAppInstallationsParamsSchema,
    tags: ['orgs']
  })
  async orgsListAppInstallations(
    params: github.OrgsListAppInstallationsParams
  ): Promise<github.OrgsListAppInstallationsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/installations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListAppInstallationsResponse>()
  }

  /**
   * Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
   */
  @aiFunction({
    name: 'github_interactions_get_restrictions_for_org',
    description: `Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.`,
    inputSchema: github.InteractionsGetRestrictionsForOrgParamsSchema,
    tags: ['interactions']
  })
  async interactionsGetRestrictionsForOrg(
    params: github.InteractionsGetRestrictionsForOrgParams
  ): Promise<github.InteractionsGetRestrictionsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/interaction-limits`)
      .json<github.InteractionsGetRestrictionsForOrgResponse>()
  }

  /**
   * Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
   */
  @aiFunction({
    name: 'github_interactions_set_restrictions_for_org',
    description: `Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.`,
    inputSchema: github.InteractionsSetRestrictionsForOrgParamsSchema,
    tags: ['interactions']
  })
  async interactionsSetRestrictionsForOrg(
    params: github.InteractionsSetRestrictionsForOrgParams
  ): Promise<github.InteractionsSetRestrictionsForOrgResponse> {
    return this.ky
      .put(`/orgs/${params.org}/interaction-limits`, {
        json: pick(params, 'limit', 'expiry')
      })
      .json<github.InteractionsSetRestrictionsForOrgResponse>()
  }

  /**
   * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
   */
  @aiFunction({
    name: 'github_interactions_remove_restrictions_for_org',
    description: `Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.`,
    inputSchema: github.InteractionsRemoveRestrictionsForOrgParamsSchema,
    tags: ['interactions']
  })
  async interactionsRemoveRestrictionsForOrg(
    params: github.InteractionsRemoveRestrictionsForOrgParams
  ): Promise<github.InteractionsRemoveRestrictionsForOrgResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/interaction-limits`)
      .json<github.InteractionsRemoveRestrictionsForOrgResponse>()
  }

  /**
 * The return hash contains a `role` field which refers to the Organization
Invitation role and will be one of the following values: `direct_member`, `admin`,
`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub
member, the `login` field in the return hash will be `null`.
 */
  @aiFunction({
    name: 'github_orgs_list_pending_invitations',
    description: `The return hash contains a \`role\` field which refers to the Organization
Invitation role and will be one of the following values: \`direct_member\`, \`admin\`,
\`billing_manager\`, or \`hiring_manager\`. If the invitee is not a GitHub
member, the \`login\` field in the return hash will be \`null\`.`,
    inputSchema: github.OrgsListPendingInvitationsParamsSchema,
    tags: ['orgs']
  })
  async orgsListPendingInvitations(
    params: github.OrgsListPendingInvitationsParams
  ): Promise<github.OrgsListPendingInvitationsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/invitations`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'role', 'invitation_source')
        )
      })
      .json<github.OrgsListPendingInvitationsResponse>()
  }

  /**
 * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".
 */
  @aiFunction({
    name: 'github_orgs_create_invitation',
    description: `Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".`,
    inputSchema: github.OrgsCreateInvitationParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateInvitation(
    params: github.OrgsCreateInvitationParams
  ): Promise<github.OrgsCreateInvitationResponse> {
    return this.ky
      .post(`/orgs/${params.org}/invitations`, {
        json: pick(params, 'invitee_id', 'email', 'role', 'team_ids')
      })
      .json<github.OrgsCreateInvitationResponse>()
  }

  /**
 * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
 */
  @aiFunction({
    name: 'github_orgs_cancel_invitation',
    description: `Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).`,
    inputSchema: github.OrgsCancelInvitationParamsSchema,
    tags: ['orgs']
  })
  async orgsCancelInvitation(
    params: github.OrgsCancelInvitationParams
  ): Promise<github.OrgsCancelInvitationResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/invitations/${params.invitation_id}`,
        {}
      )
      .json<github.OrgsCancelInvitationResponse>()
  }

  /**
   * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
   */
  @aiFunction({
    name: 'github_orgs_list_invitation_teams',
    description: `List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.`,
    inputSchema: github.OrgsListInvitationTeamsParamsSchema,
    tags: ['orgs']
  })
  async orgsListInvitationTeams(
    params: github.OrgsListInvitationTeamsParams
  ): Promise<github.OrgsListInvitationTeamsResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/invitations/${params.invitation_id}/teams`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.OrgsListInvitationTeamsResponse>()
  }

  /**
   * Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
   */
  @aiFunction({
    name: 'github_orgs_list_issue_types',
    description: `Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.`,
    inputSchema: github.OrgsListIssueTypesParamsSchema,
    tags: ['orgs']
  })
  async orgsListIssueTypes(
    params: github.OrgsListIssueTypesParams
  ): Promise<github.OrgsListIssueTypesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/issue-types`)
      .json<github.OrgsListIssueTypesResponse>()
  }

  /**
 * Create a new issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_create_issue_type',
    description: `Create a new issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsCreateIssueTypeParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateIssueType(
    params: github.OrgsCreateIssueTypeParams
  ): Promise<github.OrgsCreateIssueTypeResponse> {
    return this.ky
      .post(`/orgs/${params.org}/issue-types`, {
        json: pick(
          params,
          'name',
          'is_enabled',
          'is_private',
          'description',
          'color'
        )
      })
      .json<github.OrgsCreateIssueTypeResponse>()
  }

  /**
 * Updates an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_update_issue_type',
    description: `Updates an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsUpdateIssueTypeParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdateIssueType(
    params: github.OrgsUpdateIssueTypeParams
  ): Promise<github.OrgsUpdateIssueTypeResponse> {
    return this.ky
      .put(`/orgs/${params.org}/issue-types/${params.issue_type_id}`, {
        json: pick(
          params,
          'name',
          'is_enabled',
          'is_private',
          'description',
          'color'
        )
      })
      .json<github.OrgsUpdateIssueTypeResponse>()
  }

  /**
 * Deletes an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_delete_issue_type',
    description: `Deletes an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsDeleteIssueTypeParamsSchema,
    tags: ['orgs']
  })
  async orgsDeleteIssueType(
    params: github.OrgsDeleteIssueTypeParams
  ): Promise<github.OrgsDeleteIssueTypeResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/issue-types/${params.issue_type_id}`,
        {}
      )
      .json<github.OrgsDeleteIssueTypeResponse>()
  }

  /**
 * List issues in an organization assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_for_org',
    description: `List issues in an organization assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the \`pull_request\` key. Be aware that the \`id\` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListForOrgParamsSchema,
    tags: ['issues']
  })
  async issuesListForOrg(
    params: github.IssuesListForOrgParams
  ): Promise<github.IssuesListForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/issues`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'filter',
            'state',
            'labels',
            'type',
            'sort',
            'direction',
            'since',
            'per_page',
            'page'
          )
        )
      })
      .json<github.IssuesListForOrgResponse>()
  }

  /**
   * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
   */
  @aiFunction({
    name: 'github_orgs_list_members',
    description: `List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.`,
    inputSchema: github.OrgsListMembersParamsSchema,
    tags: ['orgs']
  })
  async orgsListMembers(
    params: github.OrgsListMembersParams
  ): Promise<github.OrgsListMembersResponse> {
    return this.ky
      .get(`/orgs/${params.org}/members`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'filter', 'role', 'per_page', 'page')
        )
      })
      .json<github.OrgsListMembersResponse>()
  }

  /**
   * Check if a user is, publicly or privately, a member of the organization.
   */
  @aiFunction({
    name: 'github_orgs_check_membership_for_user',
    description: `Check if a user is, publicly or privately, a member of the organization.`,
    inputSchema: github.OrgsCheckMembershipForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsCheckMembershipForUser(
    params: github.OrgsCheckMembershipForUserParams
  ): Promise<github.OrgsCheckMembershipForUserResponse> {
    return this.ky
      .get(`/orgs/${params.org}/members/${params.username}`, {})
      .json<github.OrgsCheckMembershipForUserResponse>()
  }

  /**
   * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
   */
  @aiFunction({
    name: 'github_orgs_remove_member',
    description: `Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.`,
    inputSchema: github.OrgsRemoveMemberParamsSchema,
    tags: ['orgs']
  })
  async orgsRemoveMember(
    params: github.OrgsRemoveMemberParams
  ): Promise<github.OrgsRemoveMemberResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/members/${params.username}`, {})
      .json<github.OrgsRemoveMemberResponse>()
  }

  /**
 * Lists the codespaces that a member of an organization has for repositories in that organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_codespaces_for_user_in_org',
    description: `Lists the codespaces that a member of an organization has for repositories in that organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetCodespacesForUserInOrgParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetCodespacesForUserInOrg(
    params: github.CodespacesGetCodespacesForUserInOrgParams
  ): Promise<github.CodespacesGetCodespacesForUserInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/members/${params.username}/codespaces`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesGetCodespacesForUserInOrgResponse>()
  }

  /**
 * Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_delete_from_organization',
    description: `Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesDeleteFromOrganizationParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteFromOrganization(
    params: github.CodespacesDeleteFromOrganizationParams
  ): Promise<github.CodespacesDeleteFromOrganizationResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/members/${params.username}/codespaces/${params.codespace_name}`,
        {}
      )
      .json<github.CodespacesDeleteFromOrganizationResponse>()
  }

  /**
 * Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_stop_in_organization',
    description: `Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.CodespacesStopInOrganizationParamsSchema,
    tags: ['codespaces']
  })
  async codespacesStopInOrganization(
    params: github.CodespacesStopInOrganizationParams
  ): Promise<github.CodespacesStopInOrganizationResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/members/${params.username}/codespaces/${params.codespace_name}/stop`,
        {}
      )
      .json<github.CodespacesStopInOrganizationResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."

Only organization owners can view Copilot seat assignment details for members of their organization.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_get_copilot_seat_details_for_user',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in \`last_activity_at\`.
For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."

Only organization owners can view Copilot seat assignment details for members of their organization.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\` or \`read:org\` scopes to use this endpoint.`,
    inputSchema: github.CopilotGetCopilotSeatDetailsForUserParamsSchema,
    tags: ['copilot']
  })
  async copilotGetCopilotSeatDetailsForUser(
    params: github.CopilotGetCopilotSeatDetailsForUserParams
  ): Promise<github.CopilotGetCopilotSeatDetailsForUserResponse> {
    return this.ky
      .get(`/orgs/${params.org}/members/${params.username}/copilot`, {})
      .json<github.CopilotGetCopilotSeatDetailsForUserResponse>()
  }

  /**
   * In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.
   */
  @aiFunction({
    name: 'github_orgs_get_membership_for_user',
    description: `In order to get a user's membership with an organization, the authenticated user must be an organization member. The \`state\` parameter in the response can be used to identify the user's membership status.`,
    inputSchema: github.OrgsGetMembershipForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsGetMembershipForUser(
    params: github.OrgsGetMembershipForUserParams
  ): Promise<github.OrgsGetMembershipForUserResponse> {
    return this.ky
      .get(`/orgs/${params.org}/memberships/${params.username}`, {})
      .json<github.OrgsGetMembershipForUserResponse>()
  }

  /**
 * Only authenticated organization owners can add a member to the organization or update the member's role.

*   If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.

*   Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.

**Rate limits**

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
 */
  @aiFunction({
    name: 'github_orgs_set_membership_for_user',
    description: `Only authenticated organization owners can add a member to the organization or update the member's role.

*   If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be \`pending\` until they accept the invitation.

*   Authenticated users can _update_ a user's membership by passing the \`role\` parameter. If the authenticated user changes a member's role to \`admin\`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to \`member\`, no email will be sent.

**Rate limits**

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.`,
    inputSchema: github.OrgsSetMembershipForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsSetMembershipForUser(
    params: github.OrgsSetMembershipForUserParams
  ): Promise<github.OrgsSetMembershipForUserResponse> {
    return this.ky
      .put(`/orgs/${params.org}/memberships/${params.username}`, {
        json: pick(params, 'role')
      })
      .json<github.OrgsSetMembershipForUserResponse>()
  }

  /**
 * In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
 */
  @aiFunction({
    name: 'github_orgs_remove_membership_for_user',
    description: `In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.`,
    inputSchema: github.OrgsRemoveMembershipForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsRemoveMembershipForUser(
    params: github.OrgsRemoveMembershipForUserParams
  ): Promise<github.OrgsRemoveMembershipForUserResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/memberships/${params.username}`, {})
      .json<github.OrgsRemoveMembershipForUserResponse>()
  }

  /**
 * Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

A list of `repositories` is only returned for export migrations.
 */
  @aiFunction({
    name: 'github_migrations_list_for_org',
    description: `Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

A list of \`repositories\` is only returned for export migrations.`,
    inputSchema: github.MigrationsListForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsListForOrg(
    params: github.MigrationsListForOrgParams
  ): Promise<github.MigrationsListForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/migrations`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'exclude')
        )
      })
      .json<github.MigrationsListForOrgResponse>()
  }

  /**
   * Initiates the generation of a migration archive.
   */
  @aiFunction({
    name: 'github_migrations_start_for_org',
    description: `Initiates the generation of a migration archive.`,
    inputSchema: github.MigrationsStartForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsStartForOrg(
    params: github.MigrationsStartForOrgParams
  ): Promise<github.MigrationsStartForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/migrations`, {
        json: pick(
          params,
          'repositories',
          'lock_repositories',
          'exclude_metadata',
          'exclude_git_data',
          'exclude_attachments',
          'exclude_releases',
          'exclude_owner_projects',
          'org_metadata_only',
          'exclude'
        )
      })
      .json<github.MigrationsStartForOrgResponse>()
  }

  /**
 * Fetches the status of a migration.

The `state` of a migration can be one of the following values:

*   `pending`, which means the migration hasn't started yet.
*   `exporting`, which means the migration is in progress.
*   `exported`, which means the migration finished successfully.
*   `failed`, which means the migration failed.
 */
  @aiFunction({
    name: 'github_migrations_get_status_for_org',
    description: `Fetches the status of a migration.

The \`state\` of a migration can be one of the following values:

*   \`pending\`, which means the migration hasn't started yet.
*   \`exporting\`, which means the migration is in progress.
*   \`exported\`, which means the migration finished successfully.
*   \`failed\`, which means the migration failed.`,
    inputSchema: github.MigrationsGetStatusForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetStatusForOrg(
    params: github.MigrationsGetStatusForOrgParams
  ): Promise<github.MigrationsGetStatusForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/migrations/${params.migration_id}`, {
        searchParams: sanitizeSearchParams(pick(params, 'exclude'))
      })
      .json<github.MigrationsGetStatusForOrgResponse>()
  }

  /**
   * Fetches the URL to a migration archive.
   */
  @aiFunction({
    name: 'github_migrations_download_archive_for_org',
    description: `Fetches the URL to a migration archive.`,
    inputSchema: github.MigrationsDownloadArchiveForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsDownloadArchiveForOrg(
    params: github.MigrationsDownloadArchiveForOrgParams
  ): Promise<github.MigrationsDownloadArchiveForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/migrations/${params.migration_id}/archive`,
        {}
      )
      .json<github.MigrationsDownloadArchiveForOrgResponse>()
  }

  /**
   * Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
   */
  @aiFunction({
    name: 'github_migrations_delete_archive_for_org',
    description: `Deletes a previous migration archive. Migration archives are automatically deleted after seven days.`,
    inputSchema: github.MigrationsDeleteArchiveForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsDeleteArchiveForOrg(
    params: github.MigrationsDeleteArchiveForOrgParams
  ): Promise<github.MigrationsDeleteArchiveForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/migrations/${params.migration_id}/archive`,
        {}
      )
      .json<github.MigrationsDeleteArchiveForOrgResponse>()
  }

  /**
   * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
   */
  @aiFunction({
    name: 'github_migrations_unlock_repo_for_org',
    description: `Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.`,
    inputSchema: github.MigrationsUnlockRepoForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsUnlockRepoForOrg(
    params: github.MigrationsUnlockRepoForOrgParams
  ): Promise<github.MigrationsUnlockRepoForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/migrations/${params.migration_id}/repos/${params.repo_name}/lock`,
        {}
      )
      .json<github.MigrationsUnlockRepoForOrgResponse>()
  }

  /**
   * List all the repositories for this organization migration.
   */
  @aiFunction({
    name: 'github_migrations_list_repos_for_org',
    description: `List all the repositories for this organization migration.`,
    inputSchema: github.MigrationsListReposForOrgParamsSchema,
    tags: ['migrations']
  })
  async migrationsListReposForOrg(
    params: github.MigrationsListReposForOrgParams
  ): Promise<github.MigrationsListReposForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/migrations/${params.migration_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.MigrationsListReposForOrgResponse>()
  }

  /**
 * Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_org_roles',
    description: `Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permissions of \`read_organization_custom_org_role\` in the organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsListOrgRolesParamsSchema,
    tags: ['orgs']
  })
  async orgsListOrgRoles(
    params: github.OrgsListOrgRolesParams
  ): Promise<github.OrgsListOrgRolesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/organization-roles`)
      .json<github.OrgsListOrgRolesResponse>()
  }

  /**
 * Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_revoke_all_org_roles_team',
    description: `Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsRevokeAllOrgRolesTeamParamsSchema,
    tags: ['orgs']
  })
  async orgsRevokeAllOrgRolesTeam(
    params: github.OrgsRevokeAllOrgRolesTeamParams
  ): Promise<github.OrgsRevokeAllOrgRolesTeamResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/organization-roles/teams/${params.team_slug}`,
        {}
      )
      .json<github.OrgsRevokeAllOrgRolesTeamResponse>()
  }

  /**
 * Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_assign_team_to_org_role',
    description: `Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsAssignTeamToOrgRoleParamsSchema,
    tags: ['orgs']
  })
  async orgsAssignTeamToOrgRole(
    params: github.OrgsAssignTeamToOrgRoleParams
  ): Promise<github.OrgsAssignTeamToOrgRoleResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/organization-roles/teams/${params.team_slug}/${params.role_id}`,
        {}
      )
      .json<github.OrgsAssignTeamToOrgRoleResponse>()
  }

  /**
 * Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_revoke_org_role_team',
    description: `Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsRevokeOrgRoleTeamParamsSchema,
    tags: ['orgs']
  })
  async orgsRevokeOrgRoleTeam(
    params: github.OrgsRevokeOrgRoleTeamParams
  ): Promise<github.OrgsRevokeOrgRoleTeamResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/organization-roles/teams/${params.team_slug}/${params.role_id}`,
        {}
      )
      .json<github.OrgsRevokeOrgRoleTeamResponse>()
  }

  /**
 * Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_revoke_all_org_roles_user',
    description: `Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsRevokeAllOrgRolesUserParamsSchema,
    tags: ['orgs']
  })
  async orgsRevokeAllOrgRolesUser(
    params: github.OrgsRevokeAllOrgRolesUserParams
  ): Promise<github.OrgsRevokeAllOrgRolesUserResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/organization-roles/users/${params.username}`,
        {}
      )
      .json<github.OrgsRevokeAllOrgRolesUserResponse>()
  }

  /**
 * Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_assign_user_to_org_role',
    description: `Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsAssignUserToOrgRoleParamsSchema,
    tags: ['orgs']
  })
  async orgsAssignUserToOrgRole(
    params: github.OrgsAssignUserToOrgRoleParams
  ): Promise<github.OrgsAssignUserToOrgRoleResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/organization-roles/users/${params.username}/${params.role_id}`,
        {}
      )
      .json<github.OrgsAssignUserToOrgRoleResponse>()
  }

  /**
 * Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_revoke_org_role_user',
    description: `Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsRevokeOrgRoleUserParamsSchema,
    tags: ['orgs']
  })
  async orgsRevokeOrgRoleUser(
    params: github.OrgsRevokeOrgRoleUserParams
  ): Promise<github.OrgsRevokeOrgRoleUserResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/organization-roles/users/${params.username}/${params.role_id}`,
        {}
      )
      .json<github.OrgsRevokeOrgRoleUserResponse>()
  }

  /**
 * Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_get_org_role',
    description: `Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permissions of \`read_organization_custom_org_role\` in the organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsGetOrgRoleParamsSchema,
    tags: ['orgs']
  })
  async orgsGetOrgRole(
    params: github.OrgsGetOrgRoleParams
  ): Promise<github.OrgsGetOrgRoleResponse> {
    return this.ky
      .get(`/orgs/${params.org}/organization-roles/${params.role_id}`, {})
      .json<github.OrgsGetOrgRoleResponse>()
  }

  /**
 * Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_org_role_teams',
    description: `Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsListOrgRoleTeamsParamsSchema,
    tags: ['orgs']
  })
  async orgsListOrgRoleTeams(
    params: github.OrgsListOrgRoleTeamsParams
  ): Promise<github.OrgsListOrgRoleTeamsResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/organization-roles/${params.role_id}/teams`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.OrgsListOrgRoleTeamsResponse>()
  }

  /**
 * Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_org_role_users',
    description: `Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.OrgsListOrgRoleUsersParamsSchema,
    tags: ['orgs']
  })
  async orgsListOrgRoleUsers(
    params: github.OrgsListOrgRoleUsersParams
  ): Promise<github.OrgsListOrgRoleUsersResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/organization-roles/${params.role_id}/users`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.OrgsListOrgRoleUsersResponse>()
  }

  /**
   * List all users who are outside collaborators of an organization.
   */
  @aiFunction({
    name: 'github_orgs_list_outside_collaborators',
    description: `List all users who are outside collaborators of an organization.`,
    inputSchema: github.OrgsListOutsideCollaboratorsParamsSchema,
    tags: ['orgs']
  })
  async orgsListOutsideCollaborators(
    params: github.OrgsListOutsideCollaboratorsParams
  ): Promise<github.OrgsListOutsideCollaboratorsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/outside_collaborators`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'filter', 'per_page', 'page')
        )
      })
      .json<github.OrgsListOutsideCollaboratorsResponse>()
  }

  /**
   * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).".
   */
  @aiFunction({
    name: 'github_orgs_convert_member_to_outside_collaborator',
    description: `When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).".`,
    inputSchema: github.OrgsConvertMemberToOutsideCollaboratorParamsSchema,
    tags: ['orgs']
  })
  async orgsConvertMemberToOutsideCollaborator(
    params: github.OrgsConvertMemberToOutsideCollaboratorParams
  ): Promise<github.OrgsConvertMemberToOutsideCollaboratorResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/outside_collaborators/${params.username}`,
        {
          json: pick(params, 'async')
        }
      )
      .json<github.OrgsConvertMemberToOutsideCollaboratorResponse>()
  }

  /**
   * Removing a user from this list will remove them from all the organization's repositories.
   */
  @aiFunction({
    name: 'github_orgs_remove_outside_collaborator',
    description: `Removing a user from this list will remove them from all the organization's repositories.`,
    inputSchema: github.OrgsRemoveOutsideCollaboratorParamsSchema,
    tags: ['orgs']
  })
  async orgsRemoveOutsideCollaborator(
    params: github.OrgsRemoveOutsideCollaboratorParams
  ): Promise<github.OrgsRemoveOutsideCollaboratorResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/outside_collaborators/${params.username}`,
        {}
      )
      .json<github.OrgsRemoveOutsideCollaboratorResponse>()
  }

  /**
 * Lists packages in an organization readable by the user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_list_packages_for_organization',
    description: `Lists packages in an organization readable by the user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesListPackagesForOrganizationParamsSchema,
    tags: ['packages']
  })
  async packagesListPackagesForOrganization(
    params: github.PackagesListPackagesForOrganizationParams
  ): Promise<github.PackagesListPackagesForOrganizationResponse> {
    return this.ky
      .get(`/orgs/${params.org}/packages`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'package_type', 'visibility', 'page', 'per_page')
        )
      })
      .json<github.PackagesListPackagesForOrganizationResponse>()
  }

  /**
 * Gets a specific package in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_for_organization',
    description: `Gets a specific package in an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesGetPackageForOrganizationParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageForOrganization(
    params: github.PackagesGetPackageForOrganizationParams
  ): Promise<github.PackagesGetPackageForOrganizationResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesGetPackageForOrganizationResponse>()
  }

  /**
 * Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_for_org',
    description: `Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesDeletePackageForOrgParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageForOrg(
    params: github.PackagesDeletePackageForOrgParams
  ): Promise<github.PackagesDeletePackageForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesDeletePackageForOrgResponse>()
  }

  /**
 * Restores an entire package in an organization.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_for_org',
    description: `Restores an entire package in an organization.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesRestorePackageForOrgParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageForOrg(
    params: github.PackagesRestorePackageForOrgParams
  ): Promise<github.PackagesRestorePackageForOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}/restore`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'token'))
        }
      )
      .json<github.PackagesRestorePackageForOrgResponse>()
  }

  /**
 * Lists package versions for a package owned by an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_all_package_versions_for_package_owned_by_org',
    description: `Lists package versions for a package owned by an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesGetAllPackageVersionsForPackageOwnedByOrgParamsSchema,
    tags: ['packages']
  })
  async packagesGetAllPackageVersionsForPackageOwnedByOrg(
    params: github.PackagesGetAllPackageVersionsForPackageOwnedByOrgParams
  ): Promise<github.PackagesGetAllPackageVersionsForPackageOwnedByOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}/versions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'page', 'per_page', 'state')
          )
        }
      )
      .json<github.PackagesGetAllPackageVersionsForPackageOwnedByOrgResponse>()
  }

  /**
 * Gets a specific package version in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_version_for_organization',
    description: `Gets a specific package version in an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesGetPackageVersionForOrganizationParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageVersionForOrganization(
    params: github.PackagesGetPackageVersionForOrganizationParams
  ): Promise<github.PackagesGetPackageVersionForOrganizationResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesGetPackageVersionForOrganizationResponse>()
  }

  /**
 * Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_version_for_org',
    description: `Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesDeletePackageVersionForOrgParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageVersionForOrg(
    params: github.PackagesDeletePackageVersionForOrgParams
  ): Promise<github.PackagesDeletePackageVersionForOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesDeletePackageVersionForOrgResponse>()
  }

  /**
 * Restores a specific package version in an organization.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_version_for_org',
    description: `Restores a specific package version in an organization.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesRestorePackageVersionForOrgParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageVersionForOrg(
    params: github.PackagesRestorePackageVersionForOrgParams
  ): Promise<github.PackagesRestorePackageVersionForOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}/restore`,
        {}
      )
      .json<github.PackagesRestorePackageVersionForOrgResponse>()
  }

  /**
 * Lists requests from organization members to access organization resources with a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_pat_grant_requests',
    description: `Lists requests from organization members to access organization resources with a fine-grained personal access token.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsListPatGrantRequestsParamsSchema,
    tags: ['orgs']
  })
  async orgsListPatGrantRequests(
    params: github.OrgsListPatGrantRequestsParams
  ): Promise<github.OrgsListPatGrantRequestsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/personal-access-token-requests`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'per_page',
            'page',
            'sort',
            'direction',
            'owner',
            'repository',
            'permission',
            'last_used_before',
            'last_used_after',
            'token_id'
          )
        )
      })
      .json<github.OrgsListPatGrantRequestsResponse>()
  }

  /**
 * Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_review_pat_grant_requests_in_bulk',
    description: `Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsReviewPatGrantRequestsInBulkParamsSchema,
    tags: ['orgs']
  })
  async orgsReviewPatGrantRequestsInBulk(
    params: github.OrgsReviewPatGrantRequestsInBulkParams
  ): Promise<github.OrgsReviewPatGrantRequestsInBulkResponse> {
    return this.ky
      .post(`/orgs/${params.org}/personal-access-token-requests`, {
        json: pick(params, 'pat_request_ids', 'action', 'reason')
      })
      .json<github.OrgsReviewPatGrantRequestsInBulkResponse>()
  }

  /**
 * Approves or denies a pending request to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_review_pat_grant_request',
    description: `Approves or denies a pending request to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsReviewPatGrantRequestParamsSchema,
    tags: ['orgs']
  })
  async orgsReviewPatGrantRequest(
    params: github.OrgsReviewPatGrantRequestParams
  ): Promise<github.OrgsReviewPatGrantRequestResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/personal-access-token-requests/${params.pat_request_id}`,
        {
          json: pick(params, 'action', 'reason')
        }
      )
      .json<github.OrgsReviewPatGrantRequestResponse>()
  }

  /**
 * Lists the repositories a fine-grained personal access token request is requesting access to.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_pat_grant_request_repositories',
    description: `Lists the repositories a fine-grained personal access token request is requesting access to.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsListPatGrantRequestRepositoriesParamsSchema,
    tags: ['orgs']
  })
  async orgsListPatGrantRequestRepositories(
    params: github.OrgsListPatGrantRequestRepositoriesParams
  ): Promise<github.OrgsListPatGrantRequestRepositoriesResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/personal-access-token-requests/${params.pat_request_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.OrgsListPatGrantRequestRepositoriesResponse>()
  }

  /**
 * Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_pat_grants',
    description: `Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsListPatGrantsParamsSchema,
    tags: ['orgs']
  })
  async orgsListPatGrants(
    params: github.OrgsListPatGrantsParams
  ): Promise<github.OrgsListPatGrantsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/personal-access-tokens`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'per_page',
            'page',
            'sort',
            'direction',
            'owner',
            'repository',
            'permission',
            'last_used_before',
            'last_used_after',
            'token_id'
          )
        )
      })
      .json<github.OrgsListPatGrantsResponse>()
  }

  /**
 * Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_update_pat_accesses',
    description: `Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsUpdatePatAccessesParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdatePatAccesses(
    params: github.OrgsUpdatePatAccessesParams
  ): Promise<github.OrgsUpdatePatAccessesResponse> {
    return this.ky
      .post(`/orgs/${params.org}/personal-access-tokens`, {
        json: pick(params, 'action', 'pat_ids')
      })
      .json<github.OrgsUpdatePatAccessesResponse>()
  }

  /**
 * Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_update_pat_access',
    description: `Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsUpdatePatAccessParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdatePatAccess(
    params: github.OrgsUpdatePatAccessParams
  ): Promise<github.OrgsUpdatePatAccessResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/personal-access-tokens/${params.pat_id}`,
        {
          json: pick(params, 'action')
        }
      )
      .json<github.OrgsUpdatePatAccessResponse>()
  }

  /**
 * Lists the repositories a fine-grained personal access token has access to.

Only GitHub Apps can use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_list_pat_grant_repositories',
    description: `Lists the repositories a fine-grained personal access token has access to.

Only GitHub Apps can use this endpoint.`,
    inputSchema: github.OrgsListPatGrantRepositoriesParamsSchema,
    tags: ['orgs']
  })
  async orgsListPatGrantRepositories(
    params: github.OrgsListPatGrantRepositoriesParams
  ): Promise<github.OrgsListPatGrantRepositoriesResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/personal-access-tokens/${params.pat_id}/repositories`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.OrgsListPatGrantRepositoriesResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all private registry configurations available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_list_org_private_registries',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all private registry configurations available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesListOrgPrivateRegistriesParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesListOrgPrivateRegistries(
    params: github.PrivateRegistriesListOrgPrivateRegistriesParams
  ): Promise<github.PrivateRegistriesListOrgPrivateRegistriesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/private-registries`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.PrivateRegistriesListOrgPrivateRegistriesResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_create_org_private_registry',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesCreateOrgPrivateRegistryParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesCreateOrgPrivateRegistry(
    params: github.PrivateRegistriesCreateOrgPrivateRegistryParams
  ): Promise<github.PrivateRegistriesCreateOrgPrivateRegistryResponse> {
    return this.ky
      .post(`/orgs/${params.org}/private-registries`, {
        json: pick(
          params,
          'registry_type',
          'username',
          'encrypted_value',
          'key_id',
          'visibility',
          'selected_repository_ids'
        )
      })
      .json<github.PrivateRegistriesCreateOrgPrivateRegistryResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_get_org_public_key',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

OAuth tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesGetOrgPublicKeyParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesGetOrgPublicKey(
    params: github.PrivateRegistriesGetOrgPublicKeyParams
  ): Promise<github.PrivateRegistriesGetOrgPublicKeyResponse> {
    return this.ky
      .get(`/orgs/${params.org}/private-registries/public-key`)
      .json<github.PrivateRegistriesGetOrgPublicKeyResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_get_org_private_registry',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesGetOrgPrivateRegistryParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesGetOrgPrivateRegistry(
    params: github.PrivateRegistriesGetOrgPrivateRegistryParams
  ): Promise<github.PrivateRegistriesGetOrgPrivateRegistryResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/private-registries/${params.secret_name}`,
        {}
      )
      .json<github.PrivateRegistriesGetOrgPrivateRegistryResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Delete a private registry configuration at the organization-level.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_delete_org_private_registry',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Delete a private registry configuration at the organization-level.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesDeleteOrgPrivateRegistryParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesDeleteOrgPrivateRegistry(
    params: github.PrivateRegistriesDeleteOrgPrivateRegistryParams
  ): Promise<github.PrivateRegistriesDeleteOrgPrivateRegistryResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/private-registries/${params.secret_name}`,
        {}
      )
      .json<github.PrivateRegistriesDeleteOrgPrivateRegistryResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is in public preview and is subject to change.

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_private_registries_update_org_private_registry',
    description: `> [!NOTE]
> This endpoint is in public preview and is subject to change.

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.PrivateRegistriesUpdateOrgPrivateRegistryParamsSchema,
    tags: ['private-registries']
  })
  async privateRegistriesUpdateOrgPrivateRegistry(
    params: github.PrivateRegistriesUpdateOrgPrivateRegistryParams
  ): Promise<github.PrivateRegistriesUpdateOrgPrivateRegistryResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/private-registries/${params.secret_name}`,
        {
          json: pick(
            params,
            'registry_type',
            'username',
            'encrypted_value',
            'key_id',
            'visibility',
            'selected_repository_ids'
          )
        }
      )
      .json<github.PrivateRegistriesUpdateOrgPrivateRegistryResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_for_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListForOrgParamsSchema,
    tags: ['projects']
  })
  async projectsListForOrg(
    params: github.ProjectsListForOrgParams
  ): Promise<github.ProjectsListForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/projects`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'state', 'per_page', 'page')
        )
      })
      .json<github.ProjectsListForOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_create_for_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsCreateForOrgParamsSchema,
    tags: ['projects']
  })
  async projectsCreateForOrg(
    params: github.ProjectsCreateForOrgParams
  ): Promise<github.ProjectsCreateForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/projects`, {
        json: pick(params, 'name', 'body')
      })
      .json<github.ProjectsCreateForOrgResponse>()
  }

  /**
 * Gets all custom properties defined for an organization.
Organization members can read these properties.
 */
  @aiFunction({
    name: 'github_orgs_get_all_custom_properties',
    description: `Gets all custom properties defined for an organization.
Organization members can read these properties.`,
    inputSchema: github.OrgsGetAllCustomPropertiesParamsSchema,
    tags: ['orgs']
  })
  async orgsGetAllCustomProperties(
    params: github.OrgsGetAllCustomPropertiesParams
  ): Promise<github.OrgsGetAllCustomPropertiesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/properties/schema`)
      .json<github.OrgsGetAllCustomPropertiesResponse>()
  }

  /**
 * Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values.
Missing optional values will fall back to default values, previous values will be overwritten.
E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
 */
  @aiFunction({
    name: 'github_orgs_create_or_update_custom_properties',
    description: `Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values.
Missing optional values will fall back to default values, previous values will be overwritten.
E.g. if a property exists with \`values_editable_by: org_and_repo_actors\` and it's updated without specifying \`values_editable_by\`, it will be updated to default value \`org_actors\`.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of \`custom_properties_org_definitions_manager\` in the organization.`,
    inputSchema: github.OrgsCreateOrUpdateCustomPropertiesParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateOrUpdateCustomProperties(
    params: github.OrgsCreateOrUpdateCustomPropertiesParams
  ): Promise<github.OrgsCreateOrUpdateCustomPropertiesResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/properties/schema`, {
        json: pick(params, 'properties')
      })
      .json<github.OrgsCreateOrUpdateCustomPropertiesResponse>()
  }

  /**
 * Gets a custom property that is defined for an organization.
Organization members can read these properties.
 */
  @aiFunction({
    name: 'github_orgs_get_custom_property',
    description: `Gets a custom property that is defined for an organization.
Organization members can read these properties.`,
    inputSchema: github.OrgsGetCustomPropertyParamsSchema,
    tags: ['orgs']
  })
  async orgsGetCustomProperty(
    params: github.OrgsGetCustomPropertyParams
  ): Promise<github.OrgsGetCustomPropertyResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/properties/schema/${params.custom_property_name}`,
        {}
      )
      .json<github.OrgsGetCustomPropertyResponse>()
  }

  /**
 * Creates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
 */
  @aiFunction({
    name: 'github_orgs_create_or_update_custom_property',
    description: `Creates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of \`custom_properties_org_definitions_manager\` in the organization.`,
    inputSchema: github.OrgsCreateOrUpdateCustomPropertyParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateOrUpdateCustomProperty(
    params: github.OrgsCreateOrUpdateCustomPropertyParams
  ): Promise<github.OrgsCreateOrUpdateCustomPropertyResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/properties/schema/${params.custom_property_name}`,
        {
          json: pick(
            params,
            'value_type',
            'required',
            'default_value',
            'description',
            'allowed_values',
            'values_editable_by'
          )
        }
      )
      .json<github.OrgsCreateOrUpdateCustomPropertyResponse>()
  }

  /**
 * Removes a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
 */
  @aiFunction({
    name: 'github_orgs_remove_custom_property',
    description: `Removes a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of \`custom_properties_org_definitions_manager\` in the organization.`,
    inputSchema: github.OrgsRemoveCustomPropertyParamsSchema,
    tags: ['orgs']
  })
  async orgsRemoveCustomProperty(
    params: github.OrgsRemoveCustomPropertyParams
  ): Promise<github.OrgsRemoveCustomPropertyResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/properties/schema/${params.custom_property_name}`,
        {}
      )
      .json<github.OrgsRemoveCustomPropertyResponse>()
  }

  /**
 * Lists organization repositories with all of their custom property values.
Organization members can read these properties.
 */
  @aiFunction({
    name: 'github_orgs_list_custom_properties_values_for_repos',
    description: `Lists organization repositories with all of their custom property values.
Organization members can read these properties.`,
    inputSchema: github.OrgsListCustomPropertiesValuesForReposParamsSchema,
    tags: ['orgs']
  })
  async orgsListCustomPropertiesValuesForRepos(
    params: github.OrgsListCustomPropertiesValuesForReposParams
  ): Promise<github.OrgsListCustomPropertiesValuesForReposResponse> {
    return this.ky
      .get(`/orgs/${params.org}/properties/values`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'repository_query')
        )
      })
      .json<github.OrgsListCustomPropertiesValuesForReposResponse>()
  }

  /**
 * Create new or update existing custom property values for repositories in a batch that belong to an organization.
Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
 */
  @aiFunction({
    name: 'github_orgs_create_or_update_custom_properties_values_for_repos',
    description: `Create new or update existing custom property values for repositories in a batch that belong to an organization.
Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of \`null\` for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:
  - An administrator for the organization.
  - A user, or a user on a team, with the fine-grained permission of \`custom_properties_org_values_editor\` in the organization.`,
    inputSchema:
      github.OrgsCreateOrUpdateCustomPropertiesValuesForReposParamsSchema,
    tags: ['orgs']
  })
  async orgsCreateOrUpdateCustomPropertiesValuesForRepos(
    params: github.OrgsCreateOrUpdateCustomPropertiesValuesForReposParams
  ): Promise<github.OrgsCreateOrUpdateCustomPropertiesValuesForReposResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/properties/values`, {
        json: pick(params, 'repository_names', 'properties')
      })
      .json<github.OrgsCreateOrUpdateCustomPropertiesValuesForReposResponse>()
  }

  /**
   * Members of an organization can choose to have their membership publicized or not.
   */
  @aiFunction({
    name: 'github_orgs_list_public_members',
    description: `Members of an organization can choose to have their membership publicized or not.`,
    inputSchema: github.OrgsListPublicMembersParamsSchema,
    tags: ['orgs']
  })
  async orgsListPublicMembers(
    params: github.OrgsListPublicMembersParams
  ): Promise<github.OrgsListPublicMembersResponse> {
    return this.ky
      .get(`/orgs/${params.org}/public_members`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListPublicMembersResponse>()
  }

  /**
   * Check if the provided user is a public member of the organization.
   */
  @aiFunction({
    name: 'github_orgs_check_public_membership_for_user',
    description: `Check if the provided user is a public member of the organization.`,
    inputSchema: github.OrgsCheckPublicMembershipForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsCheckPublicMembershipForUser(
    params: github.OrgsCheckPublicMembershipForUserParams
  ): Promise<github.OrgsCheckPublicMembershipForUserResponse> {
    return this.ky
      .get(`/orgs/${params.org}/public_members/${params.username}`, {})
      .json<github.OrgsCheckPublicMembershipForUserResponse>()
  }

  /**
 * The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
 */
  @aiFunction({
    name: 'github_orgs_set_public_membership_for_authenticated_user',
    description: `The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.OrgsSetPublicMembershipForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsSetPublicMembershipForAuthenticatedUser(
    params: github.OrgsSetPublicMembershipForAuthenticatedUserParams
  ): Promise<github.OrgsSetPublicMembershipForAuthenticatedUserResponse> {
    return this.ky
      .put(`/orgs/${params.org}/public_members/${params.username}`, {})
      .json<github.OrgsSetPublicMembershipForAuthenticatedUserResponse>()
  }

  /**
   * Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
   */
  @aiFunction({
    name: 'github_orgs_remove_public_membership_for_authenticated_user',
    description: `Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.`,
    inputSchema:
      github.OrgsRemovePublicMembershipForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsRemovePublicMembershipForAuthenticatedUser(
    params: github.OrgsRemovePublicMembershipForAuthenticatedUserParams
  ): Promise<github.OrgsRemovePublicMembershipForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/public_members/${params.username}`, {})
      .json<github.OrgsRemovePublicMembershipForAuthenticatedUserResponse>()
  }

  /**
 * Lists repositories for the specified organization.

> [!NOTE]
> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).".
 */
  @aiFunction({
    name: 'github_repos_list_for_org',
    description: `Lists repositories for the specified organization.

> [!NOTE]
> In order to see the \`security_and_analysis\` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).".`,
    inputSchema: github.ReposListForOrgParamsSchema,
    tags: ['repos']
  })
  async reposListForOrg(
    params: github.ReposListForOrgParams
  ): Promise<github.ReposListForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/repos`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'type', 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.ReposListForOrgResponse>()
  }

  /**
 * Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
 */
  @aiFunction({
    name: 'github_repos_create_in_org',
    description: `Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth app tokens and personal access tokens (classic) need the \`public_repo\` or \`repo\` scope to create a public repository, and \`repo\` scope to create a private repository.`,
    inputSchema: github.ReposCreateInOrgParamsSchema,
    tags: ['repos']
  })
  async reposCreateInOrg(
    params: github.ReposCreateInOrgParams
  ): Promise<github.ReposCreateInOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/repos`, {
        json: pick(
          params,
          'name',
          'description',
          'homepage',
          'private',
          'visibility',
          'has_issues',
          'has_projects',
          'has_wiki',
          'has_downloads',
          'is_template',
          'team_id',
          'auto_init',
          'gitignore_template',
          'license_template',
          'allow_squash_merge',
          'allow_merge_commit',
          'allow_rebase_merge',
          'allow_auto_merge',
          'delete_branch_on_merge',
          'use_squash_pr_title_as_default',
          'squash_merge_commit_title',
          'squash_merge_commit_message',
          'merge_commit_title',
          'merge_commit_message',
          'custom_properties'
        )
      })
      .json<github.ReposCreateInOrgResponse>()
  }

  /**
   * Get all the repository rulesets for an organization.
   */
  @aiFunction({
    name: 'github_repos_get_org_rulesets',
    description: `Get all the repository rulesets for an organization.`,
    inputSchema: github.ReposGetOrgRulesetsParamsSchema,
    tags: ['repos']
  })
  async reposGetOrgRulesets(
    params: github.ReposGetOrgRulesetsParams
  ): Promise<github.ReposGetOrgRulesetsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/rulesets`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'targets')
        )
      })
      .json<github.ReposGetOrgRulesetsResponse>()
  }

  /**
   * Create a repository ruleset for an organization.
   */
  @aiFunction({
    name: 'github_repos_create_org_ruleset',
    description: `Create a repository ruleset for an organization.`,
    inputSchema: github.ReposCreateOrgRulesetParamsSchema,
    tags: ['repos']
  })
  async reposCreateOrgRuleset(
    params: github.ReposCreateOrgRulesetParams
  ): Promise<github.ReposCreateOrgRulesetResponse> {
    return this.ky
      .post(`/orgs/${params.org}/rulesets`, {
        json: pick(
          params,
          'name',
          'target',
          'enforcement',
          'bypass_actors',
          'conditions',
          'rules'
        )
      })
      .json<github.ReposCreateOrgRulesetResponse>()
  }

  /**
 * Lists suites of rule evaluations at the organization level.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).".
 */
  @aiFunction({
    name: 'github_repos_get_org_rule_suites',
    description: `Lists suites of rule evaluations at the organization level.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).".`,
    inputSchema: github.ReposGetOrgRuleSuitesParamsSchema,
    tags: ['repos']
  })
  async reposGetOrgRuleSuites(
    params: github.ReposGetOrgRuleSuitesParams
  ): Promise<github.ReposGetOrgRuleSuitesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/rulesets/rule-suites`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'ref',
            'repository_name',
            'time_period',
            'actor_name',
            'rule_suite_result',
            'per_page',
            'page'
          )
        )
      })
      .json<github.ReposGetOrgRuleSuitesResponse>()
  }

  /**
 * Gets information about a suite of rule evaluations from within an organization.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).".
 */
  @aiFunction({
    name: 'github_repos_get_org_rule_suite',
    description: `Gets information about a suite of rule evaluations from within an organization.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).".`,
    inputSchema: github.ReposGetOrgRuleSuiteParamsSchema,
    tags: ['repos']
  })
  async reposGetOrgRuleSuite(
    params: github.ReposGetOrgRuleSuiteParams
  ): Promise<github.ReposGetOrgRuleSuiteResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/rulesets/rule-suites/${params.rule_suite_id}`,
        {}
      )
      .json<github.ReposGetOrgRuleSuiteResponse>()
  }

  /**
 * Get a repository ruleset for an organization.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset.
 */
  @aiFunction({
    name: 'github_repos_get_org_ruleset',
    description: `Get a repository ruleset for an organization.

**Note:** To prevent leaking sensitive information, the \`bypass_actors\` property is only returned if the user
making the API request has write access to the ruleset.`,
    inputSchema: github.ReposGetOrgRulesetParamsSchema,
    tags: ['repos']
  })
  async reposGetOrgRuleset(
    params: github.ReposGetOrgRulesetParams
  ): Promise<github.ReposGetOrgRulesetResponse> {
    return this.ky
      .get(`/orgs/${params.org}/rulesets/${params.ruleset_id}`, {})
      .json<github.ReposGetOrgRulesetResponse>()
  }

  /**
   * Update a ruleset for an organization.
   */
  @aiFunction({
    name: 'github_repos_update_org_ruleset',
    description: `Update a ruleset for an organization.`,
    inputSchema: github.ReposUpdateOrgRulesetParamsSchema,
    tags: ['repos']
  })
  async reposUpdateOrgRuleset(
    params: github.ReposUpdateOrgRulesetParams
  ): Promise<github.ReposUpdateOrgRulesetResponse> {
    return this.ky
      .put(`/orgs/${params.org}/rulesets/${params.ruleset_id}`, {
        json: pick(
          params,
          'name',
          'target',
          'enforcement',
          'bypass_actors',
          'conditions',
          'rules'
        )
      })
      .json<github.ReposUpdateOrgRulesetResponse>()
  }

  /**
   * Delete a ruleset for an organization.
   */
  @aiFunction({
    name: 'github_repos_delete_org_ruleset',
    description: `Delete a ruleset for an organization.`,
    inputSchema: github.ReposDeleteOrgRulesetParamsSchema,
    tags: ['repos']
  })
  async reposDeleteOrgRuleset(
    params: github.ReposDeleteOrgRulesetParams
  ): Promise<github.ReposDeleteOrgRulesetResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/rulesets/${params.ruleset_id}`, {})
      .json<github.ReposDeleteOrgRulesetResponse>()
  }

  /**
   * Get the history of an organization ruleset.
   */
  @aiFunction({
    name: 'github_orgs_get_org_ruleset_history',
    description: `Get the history of an organization ruleset.`,
    inputSchema: github.OrgsGetOrgRulesetHistoryParamsSchema,
    tags: ['orgs']
  })
  async orgsGetOrgRulesetHistory(
    params: github.OrgsGetOrgRulesetHistoryParams
  ): Promise<github.OrgsGetOrgRulesetHistoryResponse> {
    return this.ky
      .get(`/orgs/${params.org}/rulesets/${params.ruleset_id}/history`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsGetOrgRulesetHistoryResponse>()
  }

  /**
   * Get a version of an organization ruleset.
   */
  @aiFunction({
    name: 'github_orgs_get_org_ruleset_version',
    description: `Get a version of an organization ruleset.`,
    inputSchema: github.OrgsGetOrgRulesetVersionParamsSchema,
    tags: ['orgs']
  })
  async orgsGetOrgRulesetVersion(
    params: github.OrgsGetOrgRulesetVersionParams
  ): Promise<github.OrgsGetOrgRulesetVersionResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/rulesets/${params.ruleset_id}/history/${params.version_id}`,
        {}
      )
      .json<github.OrgsGetOrgRulesetVersionResponse>()
  }

  /**
 * Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_list_alerts_for_org',
    description: `Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningListAlertsForOrgParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningListAlertsForOrg(
    params: github.SecretScanningListAlertsForOrgParams
  ): Promise<github.SecretScanningListAlertsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/secret-scanning/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'secret_type',
            'resolution',
            'sort',
            'direction',
            'page',
            'per_page',
            'before',
            'after',
            'validity',
            'is_publicly_leaked',
            'is_multi_repo'
          )
        )
      })
      .json<github.SecretScanningListAlertsForOrgResponse>()
  }

  /**
 * Lists repository security advisories for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_security_advisories_list_org_repository_advisories',
    description: `Lists repository security advisories for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:write\` scope to use this endpoint.`,
    inputSchema:
      github.SecurityAdvisoriesListOrgRepositoryAdvisoriesParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesListOrgRepositoryAdvisories(
    params: github.SecurityAdvisoriesListOrgRepositoryAdvisoriesParams
  ): Promise<github.SecurityAdvisoriesListOrgRepositoryAdvisoriesResponse> {
    return this.ky
      .get(`/orgs/${params.org}/security-advisories`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'direction',
            'sort',
            'before',
            'after',
            'per_page',
            'state'
          )
        )
      })
      .json<github.SecurityAdvisoriesListOrgRepositoryAdvisoriesResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
 */
  @aiFunction({
    name: 'github_orgs_list_security_manager_teams',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.`,
    inputSchema: github.OrgsListSecurityManagerTeamsParamsSchema,
    tags: ['orgs']
  })
  async orgsListSecurityManagerTeams(
    params: github.OrgsListSecurityManagerTeamsParams
  ): Promise<github.OrgsListSecurityManagerTeamsResponse> {
    return this.ky
      .get(`/orgs/${params.org}/security-managers`)
      .json<github.OrgsListSecurityManagerTeamsResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
 */
  @aiFunction({
    name: 'github_orgs_add_security_manager_team',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.`,
    inputSchema: github.OrgsAddSecurityManagerTeamParamsSchema,
    tags: ['orgs']
  })
  async orgsAddSecurityManagerTeam(
    params: github.OrgsAddSecurityManagerTeamParams
  ): Promise<github.OrgsAddSecurityManagerTeamResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/security-managers/teams/${params.team_slug}`,
        {}
      )
      .json<github.OrgsAddSecurityManagerTeamResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
 */
  @aiFunction({
    name: 'github_orgs_remove_security_manager_team',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.`,
    inputSchema: github.OrgsRemoveSecurityManagerTeamParamsSchema,
    tags: ['orgs']
  })
  async orgsRemoveSecurityManagerTeam(
    params: github.OrgsRemoveSecurityManagerTeamParams
  ): Promise<github.OrgsRemoveSecurityManagerTeamResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/security-managers/teams/${params.team_slug}`,
        {}
      )
      .json<github.OrgsRemoveSecurityManagerTeamResponse>()
  }

  /**
 * Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_github_actions_billing_org',
    description: `Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.BillingGetGithubActionsBillingOrgParamsSchema,
    tags: ['billing']
  })
  async billingGetGithubActionsBillingOrg(
    params: github.BillingGetGithubActionsBillingOrgParams
  ): Promise<github.BillingGetGithubActionsBillingOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/settings/billing/actions`)
      .json<github.BillingGetGithubActionsBillingOrgResponse>()
  }

  /**
 * Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_github_packages_billing_org',
    description: `Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.BillingGetGithubPackagesBillingOrgParamsSchema,
    tags: ['billing']
  })
  async billingGetGithubPackagesBillingOrg(
    params: github.BillingGetGithubPackagesBillingOrgParams
  ): Promise<github.BillingGetGithubPackagesBillingOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/settings/billing/packages`)
      .json<github.BillingGetGithubPackagesBillingOrgResponse>()
  }

  /**
 * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_shared_storage_billing_org',
    description: `Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`admin:org\` scope to use this endpoint.`,
    inputSchema: github.BillingGetSharedStorageBillingOrgParamsSchema,
    tags: ['billing']
  })
  async billingGetSharedStorageBillingOrg(
    params: github.BillingGetSharedStorageBillingOrgParams
  ): Promise<github.BillingGetSharedStorageBillingOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/settings/billing/shared-storage`)
      .json<github.BillingGetSharedStorageBillingOrgResponse>()
  }

  /**
 * Lists all hosted compute network configurations configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_list_network_configurations_for_org',
    description: `Lists all hosted compute network configurations configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:network_configurations\` scope to use this endpoint.`,
    inputSchema:
      github.HostedComputeListNetworkConfigurationsForOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeListNetworkConfigurationsForOrg(
    params: github.HostedComputeListNetworkConfigurationsForOrgParams
  ): Promise<github.HostedComputeListNetworkConfigurationsForOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/settings/network-configurations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.HostedComputeListNetworkConfigurationsForOrgResponse>()
  }

  /**
 * Creates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_create_network_configuration_for_org',
    description: `Creates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the \`write:network_configurations\` scope to use this endpoint.`,
    inputSchema:
      github.HostedComputeCreateNetworkConfigurationForOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeCreateNetworkConfigurationForOrg(
    params: github.HostedComputeCreateNetworkConfigurationForOrgParams
  ): Promise<github.HostedComputeCreateNetworkConfigurationForOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/settings/network-configurations`, {
        json: pick(params, 'name', 'compute_service', 'network_settings_ids')
      })
      .json<github.HostedComputeCreateNetworkConfigurationForOrgResponse>()
  }

  /**
 * Gets a hosted compute network configuration configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_get_network_configuration_for_org',
    description: `Gets a hosted compute network configuration configured in an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:network_configurations\` scope to use this endpoint.`,
    inputSchema: github.HostedComputeGetNetworkConfigurationForOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeGetNetworkConfigurationForOrg(
    params: github.HostedComputeGetNetworkConfigurationForOrgParams
  ): Promise<github.HostedComputeGetNetworkConfigurationForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/settings/network-configurations/${params.network_configuration_id}`,
        {}
      )
      .json<github.HostedComputeGetNetworkConfigurationForOrgResponse>()
  }

  /**
 * Deletes a hosted compute network configuration from an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_delete_network_configuration_from_org',
    description: `Deletes a hosted compute network configuration from an organization.

OAuth app tokens and personal access tokens (classic) need the \`write:network_configurations\` scope to use this endpoint.`,
    inputSchema:
      github.HostedComputeDeleteNetworkConfigurationFromOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeDeleteNetworkConfigurationFromOrg(
    params: github.HostedComputeDeleteNetworkConfigurationFromOrgParams
  ): Promise<github.HostedComputeDeleteNetworkConfigurationFromOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/settings/network-configurations/${params.network_configuration_id}`,
        {}
      )
      .json<github.HostedComputeDeleteNetworkConfigurationFromOrgResponse>()
  }

  /**
 * Updates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_update_network_configuration_for_org',
    description: `Updates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the \`write:network_configurations\` scope to use this endpoint.`,
    inputSchema:
      github.HostedComputeUpdateNetworkConfigurationForOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeUpdateNetworkConfigurationForOrg(
    params: github.HostedComputeUpdateNetworkConfigurationForOrgParams
  ): Promise<github.HostedComputeUpdateNetworkConfigurationForOrgResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/settings/network-configurations/${params.network_configuration_id}`,
        {
          json: pick(params, 'name', 'compute_service', 'network_settings_ids')
        }
      )
      .json<github.HostedComputeUpdateNetworkConfigurationForOrgResponse>()
  }

  /**
 * Gets a hosted compute network settings resource configured for an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_hosted_compute_get_network_settings_for_org',
    description: `Gets a hosted compute network settings resource configured for an organization.

OAuth app tokens and personal access tokens (classic) need the \`read:network_configurations\` scope to use this endpoint.`,
    inputSchema: github.HostedComputeGetNetworkSettingsForOrgParamsSchema,
    tags: ['hosted-compute']
  })
  async hostedComputeGetNetworkSettingsForOrg(
    params: github.HostedComputeGetNetworkSettingsForOrgParams
  ): Promise<github.HostedComputeGetNetworkSettingsForOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/settings/network-settings/${params.network_settings_id}`,
        {}
      )
      .json<github.HostedComputeGetNetworkSettingsForOrgResponse>()
  }

  /**
 * Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.
Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_copilot_metrics_for_team',
    description: `Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.
Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\`, \`read:org\`, or \`read:enterprise\` scopes to use this endpoint.`,
    inputSchema: github.CopilotCopilotMetricsForTeamParamsSchema,
    tags: ['copilot']
  })
  async copilotCopilotMetricsForTeam(
    params: github.CopilotCopilotMetricsForTeamParams
  ): Promise<github.CopilotCopilotMetricsForTeamResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/team/${params.team_slug}/copilot/metrics`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'since', 'until', 'page', 'per_page')
          )
        }
      )
      .json<github.CopilotCopilotMetricsForTeamResponse>()
  }

  /**
 * > [!NOTE]
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
See the response schema tab for detailed metrics definitions.

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

> [!NOTE]
> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.

Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_copilot_usage_metrics_for_team',
    description: `> [!NOTE]
> This endpoint is closing down. It will be accessible throughout February 2025, but will not return any new data after February 1st.

You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
See the response schema tab for detailed metrics definitions.

The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

> [!NOTE]
> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.

Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the \`manage_billing:copilot\`, \`read:org\`, or \`read:enterprise\` scopes to use this endpoint.`,
    inputSchema: github.CopilotUsageMetricsForTeamParamsSchema,
    tags: ['copilot']
  })
  async copilotUsageMetricsForTeam(
    params: github.CopilotUsageMetricsForTeamParams
  ): Promise<github.CopilotUsageMetricsForTeamResponse> {
    return this.ky
      .get(`/orgs/${params.org}/team/${params.team_slug}/copilot/usage`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'until', 'page', 'per_page')
        )
      })
      .json<github.CopilotUsageMetricsForTeamResponse>()
  }

  /**
   * Lists all teams in an organization that are visible to the authenticated user.
   */
  @aiFunction({
    name: 'github_teams_list',
    description: `Lists all teams in an organization that are visible to the authenticated user.`,
    inputSchema: github.TeamsListParamsSchema,
    tags: ['teams']
  })
  async teamsList(
    params: github.TeamsListParams
  ): Promise<github.TeamsListResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListResponse>()
  }

  /**
 * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
 */
  @aiFunction({
    name: 'github_teams_create',
    description: `To create a team, the authenticated user must be a member or owner of \`{org}\`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of \`maintainers\`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".`,
    inputSchema: github.TeamsCreateParamsSchema,
    tags: ['teams']
  })
  async teamsCreate(
    params: github.TeamsCreateParams
  ): Promise<github.TeamsCreateResponse> {
    return this.ky
      .post(`/orgs/${params.org}/teams`, {
        json: pick(
          params,
          'name',
          'description',
          'maintainers',
          'repo_names',
          'privacy',
          'notification_setting',
          'permission',
          'parent_team_id'
        )
      })
      .json<github.TeamsCreateResponse>()
  }

  /**
 * Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.
 */
  @aiFunction({
    name: 'github_teams_get_by_name',
    description: `Gets a team using the team's \`slug\`. To create the \`slug\`, GitHub replaces special characters in the \`name\` string, changes all words to lowercase, and replaces spaces with a \`-\` separator. For example, \`"My TEam Näme"\` would become \`my-team-name\`.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}\`.`,
    inputSchema: github.TeamsGetByNameParamsSchema,
    tags: ['teams']
  })
  async teamsGetByName(
    params: github.TeamsGetByNameParams
  ): Promise<github.TeamsGetByNameResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}`, {})
      .json<github.TeamsGetByNameResponse>()
  }

  /**
 * To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.
 */
  @aiFunction({
    name: 'github_teams_delete_in_org',
    description: `To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}\`.`,
    inputSchema: github.TeamsDeleteInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteInOrg(
    params: github.TeamsDeleteInOrgParams
  ): Promise<github.TeamsDeleteInOrgResponse> {
    return this.ky
      .delete(`/orgs/${params.org}/teams/${params.team_slug}`, {})
      .json<github.TeamsDeleteInOrgResponse>()
  }

  /**
 * To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.
 */
  @aiFunction({
    name: 'github_teams_update_in_org',
    description: `To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`PATCH /organizations/{org_id}/team/{team_id}\`.`,
    inputSchema: github.TeamsUpdateInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateInOrg(
    params: github.TeamsUpdateInOrgParams
  ): Promise<github.TeamsUpdateInOrgResponse> {
    return this.ky
      .patch(`/orgs/${params.org}/teams/${params.team_slug}`, {
        json: pick(
          params,
          'name',
          'description',
          'privacy',
          'notification_setting',
          'permission',
          'parent_team_id'
        )
      })
      .json<github.TeamsUpdateInOrgResponse>()
  }

  /**
 * List all discussions on a team's page.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_discussions_in_org',
    description: `List all discussions on a team's page.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/discussions\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsListDiscussionsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListDiscussionsInOrg(
    params: github.TeamsListDiscussionsInOrgParams
  ): Promise<github.TeamsListDiscussionsInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/discussions`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'direction', 'per_page', 'page', 'pinned')
        )
      })
      .json<github.TeamsListDiscussionsInOrgResponse>()
  }

  /**
 * Creates a new discussion post on a team's page.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_create_discussion_in_org',
    description: `Creates a new discussion post on a team's page.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`POST /organizations/{org_id}/team/{team_id}/discussions\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsCreateDiscussionInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsCreateDiscussionInOrg(
    params: github.TeamsCreateDiscussionInOrgParams
  ): Promise<github.TeamsCreateDiscussionInOrgResponse> {
    return this.ky
      .post(`/orgs/${params.org}/teams/${params.team_slug}/discussions`, {
        json: pick(params, 'title', 'body', 'private')
      })
      .json<github.TeamsCreateDiscussionInOrgResponse>()
  }

  /**
 * Get a specific discussion on a team's page.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_get_discussion_in_org',
    description: `Get a specific discussion on a team's page.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsGetDiscussionInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsGetDiscussionInOrg(
    params: github.TeamsGetDiscussionInOrgParams
  ): Promise<github.TeamsGetDiscussionInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}`,
        {}
      )
      .json<github.TeamsGetDiscussionInOrgResponse>()
  }

  /**
 * Delete a discussion from a team's page.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_delete_discussion_in_org',
    description: `Delete a discussion from a team's page.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsDeleteDiscussionInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteDiscussionInOrg(
    params: github.TeamsDeleteDiscussionInOrgParams
  ): Promise<github.TeamsDeleteDiscussionInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}`,
        {}
      )
      .json<github.TeamsDeleteDiscussionInOrgResponse>()
  }

  /**
 * Edits the title and body text of a discussion post. Only the parameters you provide are updated.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_update_discussion_in_org',
    description: `Edits the title and body text of a discussion post. Only the parameters you provide are updated.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsUpdateDiscussionInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateDiscussionInOrg(
    params: github.TeamsUpdateDiscussionInOrgParams
  ): Promise<github.TeamsUpdateDiscussionInOrgResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}`,
        {
          json: pick(params, 'title', 'body')
        }
      )
      .json<github.TeamsUpdateDiscussionInOrgResponse>()
  }

  /**
 * List all comments on a team discussion.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_discussion_comments_in_org',
    description: `List all comments on a team discussion.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsListDiscussionCommentsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListDiscussionCommentsInOrg(
    params: github.TeamsListDiscussionCommentsInOrgParams
  ): Promise<github.TeamsListDiscussionCommentsInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'direction', 'per_page', 'page')
          )
        }
      )
      .json<github.TeamsListDiscussionCommentsInOrgResponse>()
  }

  /**
 * Creates a new comment on a team discussion.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_create_discussion_comment_in_org',
    description: `Creates a new comment on a team discussion.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsCreateDiscussionCommentInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsCreateDiscussionCommentInOrg(
    params: github.TeamsCreateDiscussionCommentInOrgParams
  ): Promise<github.TeamsCreateDiscussionCommentInOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.TeamsCreateDiscussionCommentInOrgResponse>()
  }

  /**
 * Get a specific comment on a team discussion.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_get_discussion_comment_in_org',
    description: `Get a specific comment on a team discussion.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsGetDiscussionCommentInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsGetDiscussionCommentInOrg(
    params: github.TeamsGetDiscussionCommentInOrgParams
  ): Promise<github.TeamsGetDiscussionCommentInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {}
      )
      .json<github.TeamsGetDiscussionCommentInOrgResponse>()
  }

  /**
 * Deletes a comment on a team discussion.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_delete_discussion_comment_in_org',
    description: `Deletes a comment on a team discussion.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsDeleteDiscussionCommentInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteDiscussionCommentInOrg(
    params: github.TeamsDeleteDiscussionCommentInOrgParams
  ): Promise<github.TeamsDeleteDiscussionCommentInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {}
      )
      .json<github.TeamsDeleteDiscussionCommentInOrgResponse>()
  }

  /**
 * Edits the body text of a discussion comment.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_update_discussion_comment_in_org',
    description: `Edits the body text of a discussion comment.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsUpdateDiscussionCommentInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateDiscussionCommentInOrg(
    params: github.TeamsUpdateDiscussionCommentInOrgParams
  ): Promise<github.TeamsUpdateDiscussionCommentInOrgResponse> {
    return this.ky
      .patch(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.TeamsUpdateDiscussionCommentInOrgResponse>()
  }

  /**
 * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_list_for_team_discussion_comment_in_org',
    description: `List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsListForTeamDiscussionCommentInOrgParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForTeamDiscussionCommentInOrg(
    params: github.ReactionsListForTeamDiscussionCommentInOrgParams
  ): Promise<github.ReactionsListForTeamDiscussionCommentInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForTeamDiscussionCommentInOrgResponse>()
  }

  /**
 * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_create_for_team_discussion_comment_in_org',
    description: `Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

A response with an HTTP \`200\` status means that you already added the reaction type to this team discussion comment.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema:
      github.ReactionsCreateForTeamDiscussionCommentInOrgParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForTeamDiscussionCommentInOrg(
    params: github.ReactionsCreateForTeamDiscussionCommentInOrgParams
  ): Promise<github.ReactionsCreateForTeamDiscussionCommentInOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForTeamDiscussionCommentInOrgResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.

Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_delete_for_team_discussion_comment',
    description: `> [!NOTE]
> You can also specify a team or organization with \`team_id\` and \`org_id\` using the route \`DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id\`.

Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsDeleteForTeamDiscussionCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForTeamDiscussionComment(
    params: github.ReactionsDeleteForTeamDiscussionCommentParams
  ): Promise<github.ReactionsDeleteForTeamDiscussionCommentResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/comments/${params.comment_number}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForTeamDiscussionCommentResponse>()
  }

  /**
 * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_list_for_team_discussion_in_org',
    description: `List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions\`.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsListForTeamDiscussionInOrgParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForTeamDiscussionInOrg(
    params: github.ReactionsListForTeamDiscussionInOrgParams
  ): Promise<github.ReactionsListForTeamDiscussionInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForTeamDiscussionInOrgResponse>()
  }

  /**
 * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

A response with an HTTP `200` status means that you already added the reaction type to this team discussion.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_create_for_team_discussion_in_org',
    description: `Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

A response with an HTTP \`200\` status means that you already added the reaction type to this team discussion.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions\`.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsCreateForTeamDiscussionInOrgParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForTeamDiscussionInOrg(
    params: github.ReactionsCreateForTeamDiscussionInOrgParams
  ): Promise<github.ReactionsCreateForTeamDiscussionInOrgResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForTeamDiscussionInOrgResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.

Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_delete_for_team_discussion',
    description: `> [!NOTE]
> You can also specify a team or organization with \`team_id\` and \`org_id\` using the route \`DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id\`.

Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsDeleteForTeamDiscussionParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForTeamDiscussion(
    params: github.ReactionsDeleteForTeamDiscussionParams
  ): Promise<github.ReactionsDeleteForTeamDiscussionResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/discussions/${params.discussion_number}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForTeamDiscussionResponse>()
  }

  /**
 * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.
 */
  @aiFunction({
    name: 'github_teams_list_pending_invitations_in_org',
    description: `The return hash contains a \`role\` field which refers to the Organization Invitation role and will be one of the following values: \`direct_member\`, \`admin\`, \`billing_manager\`, \`hiring_manager\`, or \`reinstate\`. If the invitee is not a GitHub member, the \`login\` field in the return hash will be \`null\`.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/invitations\`.`,
    inputSchema: github.TeamsListPendingInvitationsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListPendingInvitationsInOrg(
    params: github.TeamsListPendingInvitationsInOrgParams
  ): Promise<github.TeamsListPendingInvitationsInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/invitations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListPendingInvitationsInOrgResponse>()
  }

  /**
 * Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.
 */
  @aiFunction({
    name: 'github_teams_list_members_in_org',
    description: `Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.`,
    inputSchema: github.TeamsListMembersInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListMembersInOrg(
    params: github.TeamsListMembersInOrgParams
  ): Promise<github.TeamsListMembersInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/members`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'role', 'per_page', 'page')
        )
      })
      .json<github.TeamsListMembersInOrgResponse>()
  }

  /**
 * Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.

> [!NOTE]
> The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
 */
  @aiFunction({
    name: 'github_teams_get_membership_for_user_in_org',
    description: `Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/memberships/{username}\`.

> [!NOTE]
> The response contains the \`state\` of the membership and the member's \`role\`.

The \`role\` for organization owners is set to \`maintainer\`. For more information about \`maintainer\` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).`,
    inputSchema: github.TeamsGetMembershipForUserInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsGetMembershipForUserInOrg(
    params: github.TeamsGetMembershipForUserInOrgParams
  ): Promise<github.TeamsGetMembershipForUserInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/memberships/${params.username}`,
        {}
      )
      .json<github.TeamsGetMembershipForUserInOrgResponse>()
  }

  /**
 * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.
 */
  @aiFunction({
    name: 'github_teams_add_or_update_membership_for_user_in_org',
    description: `Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`PUT /organizations/{org_id}/team/{team_id}/memberships/{username}\`.`,
    inputSchema: github.TeamsAddOrUpdateMembershipForUserInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateMembershipForUserInOrg(
    params: github.TeamsAddOrUpdateMembershipForUserInOrgParams
  ): Promise<github.TeamsAddOrUpdateMembershipForUserInOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/teams/${params.team_slug}/memberships/${params.username}`,
        {
          json: pick(params, 'role')
        }
      )
      .json<github.TeamsAddOrUpdateMembershipForUserInOrgResponse>()
  }

  /**
 * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.
 */
  @aiFunction({
    name: 'github_teams_remove_membership_for_user_in_org',
    description: `To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}\`.`,
    inputSchema: github.TeamsRemoveMembershipForUserInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveMembershipForUserInOrg(
    params: github.TeamsRemoveMembershipForUserInOrgParams
  ): Promise<github.TeamsRemoveMembershipForUserInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/memberships/${params.username}`,
        {}
      )
      .json<github.TeamsRemoveMembershipForUserInOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_list_projects_in_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsListProjectsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListProjectsInOrg(
    params: github.TeamsListProjectsInOrgParams
  ): Promise<github.TeamsListProjectsInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/projects`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListProjectsInOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_check_permissions_for_project_in_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsCheckPermissionsForProjectInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsCheckPermissionsForProjectInOrg(
    params: github.TeamsCheckPermissionsForProjectInOrgParams
  ): Promise<github.TeamsCheckPermissionsForProjectInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/projects/${params.project_id}`,
        {}
      )
      .json<github.TeamsCheckPermissionsForProjectInOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_add_or_update_project_permissions_in_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsAddOrUpdateProjectPermissionsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateProjectPermissionsInOrg(
    params: github.TeamsAddOrUpdateProjectPermissionsInOrgParams
  ): Promise<github.TeamsAddOrUpdateProjectPermissionsInOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/teams/${params.team_slug}/projects/${params.project_id}`,
        {
          json: pick(params, 'permission')
        }
      )
      .json<github.TeamsAddOrUpdateProjectPermissionsInOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_remove_project_in_org',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsRemoveProjectInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveProjectInOrg(
    params: github.TeamsRemoveProjectInOrgParams
  ): Promise<github.TeamsRemoveProjectInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/projects/${params.project_id}`,
        {}
      )
      .json<github.TeamsRemoveProjectInOrgResponse>()
  }

  /**
 * Lists a team's repositories visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.
 */
  @aiFunction({
    name: 'github_teams_list_repos_in_org',
    description: `Lists a team's repositories visible to the authenticated user.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/repos\`.`,
    inputSchema: github.TeamsListReposInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListReposInOrg(
    params: github.TeamsListReposInOrgParams
  ): Promise<github.TeamsListReposInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/repos`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListReposInOrgResponse>()
  }

  /**
 * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.

If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.

If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
 */
  @aiFunction({
    name: 'github_teams_check_permissions_for_repo_in_org',
    description: `Checks whether a team has \`admin\`, \`push\`, \`maintain\`, \`triage\`, or \`pull\` permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the \`application/vnd.github.v3.repository+json\` accept header.

If a team doesn't have permission for the repository, you will receive a \`404 Not Found\` response status.

If the repository is private, you must have at least \`read\` permission for that repository, and your token must have the \`repo\` or \`admin:org\` scope. Otherwise, you will receive a \`404 Not Found\` response status.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}\`.`,
    inputSchema: github.TeamsCheckPermissionsForRepoInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsCheckPermissionsForRepoInOrg(
    params: github.TeamsCheckPermissionsForRepoInOrgParams
  ): Promise<github.TeamsCheckPermissionsForRepoInOrgResponse> {
    return this.ky
      .get(
        `/orgs/${params.org}/teams/${params.team_slug}/repos/${params.owner}/${params.repo}`,
        {}
      )
      .json<github.TeamsCheckPermissionsForRepoInOrgResponse>()
  }

  /**
 * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.

For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
 */
  @aiFunction({
    name: 'github_teams_add_or_update_repo_permissions_in_org',
    description: `To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a \`422 Unprocessable Entity\` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}\`.

For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".`,
    inputSchema: github.TeamsAddOrUpdateRepoPermissionsInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateRepoPermissionsInOrg(
    params: github.TeamsAddOrUpdateRepoPermissionsInOrgParams
  ): Promise<github.TeamsAddOrUpdateRepoPermissionsInOrgResponse> {
    return this.ky
      .put(
        `/orgs/${params.org}/teams/${params.team_slug}/repos/${params.owner}/${params.repo}`,
        {
          json: pick(params, 'permission')
        }
      )
      .json<github.TeamsAddOrUpdateRepoPermissionsInOrgResponse>()
  }

  /**
 * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
 */
  @aiFunction({
    name: 'github_teams_remove_repo_in_org',
    description: `If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}\`.`,
    inputSchema: github.TeamsRemoveRepoInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveRepoInOrg(
    params: github.TeamsRemoveRepoInOrgParams
  ): Promise<github.TeamsRemoveRepoInOrgResponse> {
    return this.ky
      .delete(
        `/orgs/${params.org}/teams/${params.team_slug}/repos/${params.owner}/${params.repo}`,
        {}
      )
      .json<github.TeamsRemoveRepoInOrgResponse>()
  }

  /**
 * Lists the child teams of the team specified by `{team_slug}`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.
 */
  @aiFunction({
    name: 'github_teams_list_child_in_org',
    description: `Lists the child teams of the team specified by \`{team_slug}\`.

> [!NOTE]
> You can also specify a team by \`org_id\` and \`team_id\` using the route \`GET /organizations/{org_id}/team/{team_id}/teams\`.`,
    inputSchema: github.TeamsListChildInOrgParamsSchema,
    tags: ['teams']
  })
  async teamsListChildInOrg(
    params: github.TeamsListChildInOrgParams
  ): Promise<github.TeamsListChildInOrgResponse> {
    return this.ky
      .get(`/orgs/${params.org}/teams/${params.team_slug}/teams`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListChildInOrgResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_orgs_enable_or_disable_security_product_on_all_org_repos',
    description: `> [!WARNING]
> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`admin:org\`, \`write:org\`, or \`repo\` scopes to use this endpoint.`,
    inputSchema:
      github.OrgsEnableOrDisableSecurityProductOnAllOrgReposParamsSchema,
    tags: ['orgs']
  })
  async orgsEnableOrDisableSecurityProductOnAllOrgRepos(
    params: github.OrgsEnableOrDisableSecurityProductOnAllOrgReposParams
  ): Promise<github.OrgsEnableOrDisableSecurityProductOnAllOrgReposResponse> {
    return this.ky
      .post(
        `/orgs/${params.org}/${params.security_product}/${params.enablement}`,
        {
          json: pick(params, 'query_suite')
        }
      )
      .json<github.OrgsEnableOrDisableSecurityProductOnAllOrgReposResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_get_card',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsGetCardParamsSchema,
    tags: ['projects']
  })
  async projectsGetCard(
    params: github.ProjectsGetCardParams
  ): Promise<github.ProjectsGetCardResponse> {
    return this.ky
      .get(`/projects/columns/cards/${params.card_id}`)
      .json<github.ProjectsGetCardResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_delete_card',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsDeleteCardParamsSchema,
    tags: ['projects']
  })
  async projectsDeleteCard(
    params: github.ProjectsDeleteCardParams
  ): Promise<github.ProjectsDeleteCardResponse> {
    return this.ky
      .delete(`/projects/columns/cards/${params.card_id}`)
      .json<github.ProjectsDeleteCardResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_update_card',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsUpdateCardParamsSchema,
    tags: ['projects']
  })
  async projectsUpdateCard(
    params: github.ProjectsUpdateCardParams
  ): Promise<github.ProjectsUpdateCardResponse> {
    return this.ky
      .patch(`/projects/columns/cards/${params.card_id}`, {
        json: pick(params, 'note', 'archived')
      })
      .json<github.ProjectsUpdateCardResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_move_card',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsMoveCardParamsSchema,
    tags: ['projects']
  })
  async projectsMoveCard(
    params: github.ProjectsMoveCardParams
  ): Promise<github.ProjectsMoveCardResponse> {
    return this.ky
      .post(`/projects/columns/cards/${params.card_id}/moves`, {
        json: pick(params, 'position', 'column_id')
      })
      .json<github.ProjectsMoveCardResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_get_column',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsGetColumnParamsSchema,
    tags: ['projects']
  })
  async projectsGetColumn(
    params: github.ProjectsGetColumnParams
  ): Promise<github.ProjectsGetColumnResponse> {
    return this.ky
      .get(`/projects/columns/${params.column_id}`)
      .json<github.ProjectsGetColumnResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_delete_column',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsDeleteColumnParamsSchema,
    tags: ['projects']
  })
  async projectsDeleteColumn(
    params: github.ProjectsDeleteColumnParams
  ): Promise<github.ProjectsDeleteColumnResponse> {
    return this.ky
      .delete(`/projects/columns/${params.column_id}`)
      .json<github.ProjectsDeleteColumnResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_update_column',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsUpdateColumnParamsSchema,
    tags: ['projects']
  })
  async projectsUpdateColumn(
    params: github.ProjectsUpdateColumnParams
  ): Promise<github.ProjectsUpdateColumnResponse> {
    return this.ky
      .patch(`/projects/columns/${params.column_id}`, {
        json: pick(params, 'name')
      })
      .json<github.ProjectsUpdateColumnResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_cards',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListCardsParamsSchema,
    tags: ['projects']
  })
  async projectsListCards(
    params: github.ProjectsListCardsParams
  ): Promise<github.ProjectsListCardsResponse> {
    return this.ky
      .get(`/projects/columns/${params.column_id}/cards`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'archived_state', 'per_page', 'page')
        )
      })
      .json<github.ProjectsListCardsResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_create_card',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    // TODO: Improve handling of union params
    inputSchema: github.ProjectsCreateCardParamsSchema as any,
    tags: ['projects']
  })
  async projectsCreateCard(
    params: github.ProjectsCreateCardParams
  ): Promise<github.ProjectsCreateCardResponse> {
    return this.ky
      .post(`/projects/columns/${params.column_id}/cards`, {
        json: params
      })
      .json<github.ProjectsCreateCardResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_move_column',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsMoveColumnParamsSchema,
    tags: ['projects']
  })
  async projectsMoveColumn(
    params: github.ProjectsMoveColumnParams
  ): Promise<github.ProjectsMoveColumnResponse> {
    return this.ky
      .post(`/projects/columns/${params.column_id}/moves`, {
        json: pick(params, 'position')
      })
      .json<github.ProjectsMoveColumnResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_get',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsGetParamsSchema,
    tags: ['projects']
  })
  async projectsGet(
    params: github.ProjectsGetParams
  ): Promise<github.ProjectsGetResponse> {
    return this.ky
      .get(`/projects/${params.project_id}`)
      .json<github.ProjectsGetResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_delete',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsDeleteParamsSchema,
    tags: ['projects']
  })
  async projectsDelete(
    params: github.ProjectsDeleteParams
  ): Promise<github.ProjectsDeleteResponse> {
    return this.ky
      .delete(`/projects/${params.project_id}`)
      .json<github.ProjectsDeleteResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_update',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsUpdateParamsSchema,
    tags: ['projects']
  })
  async projectsUpdate(
    params: github.ProjectsUpdateParams
  ): Promise<github.ProjectsUpdateResponse> {
    return this.ky
      .patch(`/projects/${params.project_id}`, {
        json: pick(
          params,
          'name',
          'body',
          'state',
          'organization_permission',
          'private'
        )
      })
      .json<github.ProjectsUpdateResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_collaborators',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListCollaboratorsParamsSchema,
    tags: ['projects']
  })
  async projectsListCollaborators(
    params: github.ProjectsListCollaboratorsParams
  ): Promise<github.ProjectsListCollaboratorsResponse> {
    return this.ky
      .get(`/projects/${params.project_id}/collaborators`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'affiliation', 'per_page', 'page')
        )
      })
      .json<github.ProjectsListCollaboratorsResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_add_collaborator',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsAddCollaboratorParamsSchema,
    tags: ['projects']
  })
  async projectsAddCollaborator(
    params: github.ProjectsAddCollaboratorParams
  ): Promise<github.ProjectsAddCollaboratorResponse> {
    return this.ky
      .put(
        `/projects/${params.project_id}/collaborators/${params.username}`,
        {
          json: pick(params, 'permission')
        }
      )
      .json<github.ProjectsAddCollaboratorResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_remove_collaborator',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsRemoveCollaboratorParamsSchema,
    tags: ['projects']
  })
  async projectsRemoveCollaborator(
    params: github.ProjectsRemoveCollaboratorParams
  ): Promise<github.ProjectsRemoveCollaboratorResponse> {
    return this.ky
      .delete(
        `/projects/${params.project_id}/collaborators/${params.username}`,
        {}
      )
      .json<github.ProjectsRemoveCollaboratorResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_get_permission_for_user',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsGetPermissionForUserParamsSchema,
    tags: ['projects']
  })
  async projectsGetPermissionForUser(
    params: github.ProjectsGetPermissionForUserParams
  ): Promise<github.ProjectsGetPermissionForUserResponse> {
    return this.ky
      .get(
        `/projects/${params.project_id}/collaborators/${params.username}/permission`,
        {}
      )
      .json<github.ProjectsGetPermissionForUserResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_columns',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListColumnsParamsSchema,
    tags: ['projects']
  })
  async projectsListColumns(
    params: github.ProjectsListColumnsParams
  ): Promise<github.ProjectsListColumnsResponse> {
    return this.ky
      .get(`/projects/${params.project_id}/columns`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ProjectsListColumnsResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_create_column',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsCreateColumnParamsSchema,
    tags: ['projects']
  })
  async projectsCreateColumn(
    params: github.ProjectsCreateColumnParams
  ): Promise<github.ProjectsCreateColumnResponse> {
    return this.ky
      .post(`/projects/${params.project_id}/columns`, {
        json: pick(params, 'name')
      })
      .json<github.ProjectsCreateColumnResponse>()
  }

  /**
 * > [!NOTE]
> Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
* The `core` object provides your rate limit status for all non-search-related resources in the REST API.
* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."

> [!NOTE]
> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
 */
  @aiFunction({
    name: 'github_rate_limit_get',
    description: `> [!NOTE]
> Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under \`resources\`, you'll see objects relating to different categories:
* The \`core\` object provides your rate limit status for all non-search-related resources in the REST API.
* The \`search\` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
* The \`code_search\` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
* The \`graphql\` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
* The \`integration_manifest\` object provides your rate limit status for the \`POST /app-manifests/{code}/conversions\` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
* The \`dependency_snapshots\` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The \`code_scanning_upload\` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
* The \`actions_runner_registration\` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
* The \`source_import\` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."

> [!NOTE]
> The \`rate\` object is closing down. If you're writing new API client code or updating existing code, you should use the \`core\` object instead of the \`rate\` object. The \`core\` object contains the same information that is present in the \`rate\` object.`,
    inputSchema: github.RateLimitGetParamsSchema,
    tags: ['rate-limit']
  })
  async rateLimitGet(
    _params: github.RateLimitGetParams
  ): Promise<github.RateLimitGetResponse> {
    return this.ky.get('/rate_limit').json<github.RateLimitGetResponse>()
  }

  /**
 * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.

> [!NOTE]
> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).".
 */
  @aiFunction({
    name: 'github_repos_get',
    description: `The \`parent\` and \`source\` objects are present when the repository is a fork. \`parent\` is the repository this repository was forked from, \`source\` is the ultimate source for the network.

> [!NOTE]
> In order to see the \`security_and_analysis\` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).".`,
    inputSchema: github.ReposGetParamsSchema,
    tags: ['repos']
  })
  async reposGet(
    params: github.ReposGetParams
  ): Promise<github.ReposGetResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}`, {})
      .json<github.ReposGetResponse>()
  }

  /**
 * Deleting a repository requires admin access.

If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a `403 Forbidden` response.

OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_delete',
    description: `Deleting a repository requires admin access.

If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a \`403 Forbidden\` response.

OAuth app tokens and personal access tokens (classic) need the \`delete_repo\` scope to use this endpoint.`,
    inputSchema: github.ReposDeleteParamsSchema,
    tags: ['repos']
  })
  async reposDelete(
    params: github.ReposDeleteParams
  ): Promise<github.ReposDeleteResponse> {
    return this.ky
      .delete(`/repos/${params.owner}/${params.repo}`, {})
      .json<github.ReposDeleteResponse>()
  }

  /**
   * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.
   */
  @aiFunction({
    name: 'github_repos_update',
    description: `**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.`,
    inputSchema: github.ReposUpdateParamsSchema,
    tags: ['repos']
  })
  async reposUpdate(
    params: github.ReposUpdateParams
  ): Promise<github.ReposUpdateResponse> {
    return this.ky
      .patch(`/repos/${params.owner}/${params.repo}`, {
        json: pick(
          params,
          'name',
          'description',
          'homepage',
          'private',
          'visibility',
          'security_and_analysis',
          'has_issues',
          'has_projects',
          'has_wiki',
          'is_template',
          'default_branch',
          'allow_squash_merge',
          'allow_merge_commit',
          'allow_rebase_merge',
          'allow_auto_merge',
          'delete_branch_on_merge',
          'allow_update_branch',
          'use_squash_pr_title_as_default',
          'squash_merge_commit_title',
          'squash_merge_commit_message',
          'merge_commit_title',
          'merge_commit_message',
          'archived',
          'allow_forking',
          'web_commit_signoff_required'
        )
      })
      .json<github.ReposUpdateResponse>()
  }

  /**
 * Lists all artifacts for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_list_artifacts_for_repo',
    description: `Lists all artifacts for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsListArtifactsForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsListArtifactsForRepo(
    params: github.ActionsListArtifactsForRepoParams
  ): Promise<github.ActionsListArtifactsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/artifacts`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'name')
        )
      })
      .json<github.ActionsListArtifactsForRepoResponse>()
  }

  /**
 * Gets a specific artifact for a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_artifact',
    description: `Gets a specific artifact for a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetArtifactParamsSchema,
    tags: ['actions']
  })
  async actionsGetArtifact(
    params: github.ActionsGetArtifactParams
  ): Promise<github.ActionsGetArtifactResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/artifacts/${params.artifact_id}`,
        {}
      )
      .json<github.ActionsGetArtifactResponse>()
  }

  /**
 * Deletes an artifact for a workflow run.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_artifact',
    description: `Deletes an artifact for a workflow run.
OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteArtifactParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteArtifact(
    params: github.ActionsDeleteArtifactParams
  ): Promise<github.ActionsDeleteArtifactResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/artifacts/${params.artifact_id}`,
        {}
      )
      .json<github.ActionsDeleteArtifactResponse>()
  }

  /**
 * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
the response header to find the URL for the download. The `:archive_format` must be `zip`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_download_artifact',
    description: `Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for \`Location:\` in
the response header to find the URL for the download. The \`:archive_format\` must be \`zip\`.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDownloadArtifactParamsSchema,
    tags: ['actions']
  })
  async actionsDownloadArtifact(
    params: github.ActionsDownloadArtifactParams
  ): Promise<github.ActionsDownloadArtifactResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/artifacts/${params.artifact_id}/${params.archive_format}`,
        {}
      )
      .json<github.ActionsDownloadArtifactResponse>()
  }

  /**
 * Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_actions_cache_usage',
    description: `Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetActionsCacheUsageParamsSchema,
    tags: ['actions']
  })
  async actionsGetActionsCacheUsage(
    params: github.ActionsGetActionsCacheUsageParams
  ): Promise<github.ActionsGetActionsCacheUsageResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/cache/usage`,
        {}
      )
      .json<github.ActionsGetActionsCacheUsageResponse>()
  }

  /**
 * Lists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_actions_cache_list',
    description: `Lists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetActionsCacheListParamsSchema,
    tags: ['actions']
  })
  async actionsGetActionsCacheList(
    params: github.ActionsGetActionsCacheListParams
  ): Promise<github.ActionsGetActionsCacheListResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/caches`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'ref', 'key', 'sort', 'direction')
        )
      })
      .json<github.ActionsGetActionsCacheListResponse>()
  }

  /**
 * Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_actions_cache_by_key',
    description: `Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteActionsCacheByKeyParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteActionsCacheByKey(
    params: github.ActionsDeleteActionsCacheByKeyParams
  ): Promise<github.ActionsDeleteActionsCacheByKeyResponse> {
    return this.ky
      .delete(`/repos/${params.owner}/${params.repo}/actions/caches`, {
        searchParams: sanitizeSearchParams(pick(params, 'key', 'ref'))
      })
      .json<github.ActionsDeleteActionsCacheByKeyResponse>()
  }

  /**
 * Deletes a GitHub Actions cache for a repository, using a cache ID.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_actions_cache_by_id',
    description: `Deletes a GitHub Actions cache for a repository, using a cache ID.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteActionsCacheByIdParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteActionsCacheById(
    params: github.ActionsDeleteActionsCacheByIdParams
  ): Promise<github.ActionsDeleteActionsCacheByIdResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/caches/${params.cache_id}`,
        {}
      )
      .json<github.ActionsDeleteActionsCacheByIdResponse>()
  }

  /**
 * Gets a specific job in a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_job_for_workflow_run',
    description: `Gets a specific job in a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetJobForWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsGetJobForWorkflowRun(
    params: github.ActionsGetJobForWorkflowRunParams
  ): Promise<github.ActionsGetJobForWorkflowRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/jobs/${params.job_id}`,
        {}
      )
      .json<github.ActionsGetJobForWorkflowRunResponse>()
  }

  /**
 * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for `Location:` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_download_job_logs_for_workflow_run',
    description: `Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for \`Location:\` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDownloadJobLogsForWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsDownloadJobLogsForWorkflowRun(
    params: github.ActionsDownloadJobLogsForWorkflowRunParams
  ): Promise<github.ActionsDownloadJobLogsForWorkflowRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/jobs/${params.job_id}/logs`,
        {}
      )
      .json<github.ActionsDownloadJobLogsForWorkflowRunResponse>()
  }

  /**
 * Re-run a job and its dependent jobs in a workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_re_run_job_for_workflow_run',
    description: `Re-run a job and its dependent jobs in a workflow run.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsReRunJobForWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsReRunJobForWorkflowRun(
    params: github.ActionsReRunJobForWorkflowRunParams
  ): Promise<github.ActionsReRunJobForWorkflowRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/jobs/${params.job_id}/rerun`,
        {
          json: pick(params, 'enable_debug_logging')
        }
      )
      .json<github.ActionsReRunJobForWorkflowRunResponse>()
  }

  /**
 * Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_custom_oidc_sub_claim_for_repo',
    description: `Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetCustomOidcSubClaimForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsGetCustomOidcSubClaimForRepo(
    params: github.ActionsGetCustomOidcSubClaimForRepoParams
  ): Promise<github.ActionsGetCustomOidcSubClaimForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/oidc/customization/sub`,
        {}
      )
      .json<github.ActionsGetCustomOidcSubClaimForRepoResponse>()
  }

  /**
 * Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_custom_oidc_sub_claim_for_repo',
    description: `Sets the customization template and \`opt-in\` or \`opt-out\` flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsSetCustomOidcSubClaimForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsSetCustomOidcSubClaimForRepo(
    params: github.ActionsSetCustomOidcSubClaimForRepoParams
  ): Promise<github.ActionsSetCustomOidcSubClaimForRepoResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/oidc/customization/sub`,
        {
          json: pick(params, 'use_default', 'include_claim_keys')
        }
      )
      .json<github.ActionsSetCustomOidcSubClaimForRepoResponse>()
  }

  /**
 * Lists all organization secrets shared with a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_repo_organization_secrets',
    description: `Lists all organization secrets shared with a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListRepoOrganizationSecretsParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoOrganizationSecrets(
    params: github.ActionsListRepoOrganizationSecretsParams
  ): Promise<github.ActionsListRepoOrganizationSecretsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/organization-secrets`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListRepoOrganizationSecretsResponse>()
  }

  /**
 * Lists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_repo_organization_variables',
    description: `Lists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListRepoOrganizationVariablesParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoOrganizationVariables(
    params: github.ActionsListRepoOrganizationVariablesParams
  ): Promise<github.ActionsListRepoOrganizationVariablesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/organization-variables`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListRepoOrganizationVariablesResponse>()
  }

  /**
 * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_github_actions_permissions_repository',
    description: `Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsGetGithubActionsPermissionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsGetGithubActionsPermissionsRepository(
    params: github.ActionsGetGithubActionsPermissionsRepositoryParams
  ): Promise<github.ActionsGetGithubActionsPermissionsRepositoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/permissions`,
        {}
      )
      .json<github.ActionsGetGithubActionsPermissionsRepositoryResponse>()
  }

  /**
 * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_github_actions_permissions_repository',
    description: `Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetGithubActionsPermissionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsSetGithubActionsPermissionsRepository(
    params: github.ActionsSetGithubActionsPermissionsRepositoryParams
  ): Promise<github.ActionsSetGithubActionsPermissionsRepositoryResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/actions/permissions`, {
        json: pick(params, 'enabled', 'allowed_actions')
      })
      .json<github.ActionsSetGithubActionsPermissionsRepositoryResponse>()
  }

  /**
 * Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_workflow_access_to_repository',
    description: `Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetWorkflowAccessToRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflowAccessToRepository(
    params: github.ActionsGetWorkflowAccessToRepositoryParams
  ): Promise<github.ActionsGetWorkflowAccessToRepositoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/permissions/access`,
        {}
      )
      .json<github.ActionsGetWorkflowAccessToRepositoryResponse>()
  }

  /**
 * Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_workflow_access_to_repository',
    description: `Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsSetWorkflowAccessToRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsSetWorkflowAccessToRepository(
    params: github.ActionsSetWorkflowAccessToRepositoryParams
  ): Promise<github.ActionsSetWorkflowAccessToRepositoryResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/permissions/access`,
        {
          json: pick(params, 'access_level')
        }
      )
      .json<github.ActionsSetWorkflowAccessToRepositoryResponse>()
  }

  /**
 * Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_allowed_actions_repository',
    description: `Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetAllowedActionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsGetAllowedActionsRepository(
    params: github.ActionsGetAllowedActionsRepositoryParams
  ): Promise<github.ActionsGetAllowedActionsRepositoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/permissions/selected-actions`,
        {}
      )
      .json<github.ActionsGetAllowedActionsRepositoryResponse>()
  }

  /**
 * Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_allowed_actions_repository',
    description: `Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for \`allowed_actions\` must be configured to \`selected\`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsSetAllowedActionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsSetAllowedActionsRepository(
    params: github.ActionsSetAllowedActionsRepositoryParams
  ): Promise<github.ActionsSetAllowedActionsRepositoryResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/permissions/selected-actions`,
        {
          json: pick(
            params,
            'github_owned_allowed',
            'verified_allowed',
            'patterns_allowed'
          )
        }
      )
      .json<github.ActionsSetAllowedActionsRepositoryResponse>()
  }

  /**
 * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_github_actions_default_workflow_permissions_repository',
    description: `Gets the default workflow permissions granted to the \`GITHUB_TOKEN\` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsGetGithubActionsDefaultWorkflowPermissionsRepository(
    params: github.ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryParams
  ): Promise<github.ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/permissions/workflow`,
        {}
      )
      .json<github.ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryResponse>()
  }

  /**
 * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_github_actions_default_workflow_permissions_repository',
    description: `Sets the default workflow permissions granted to the \`GITHUB_TOKEN\` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema,
    tags: ['actions']
  })
  async actionsSetGithubActionsDefaultWorkflowPermissionsRepository(
    params: github.ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryParams
  ): Promise<github.ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/permissions/workflow`,
        {
          json: pick(
            params,
            'default_workflow_permissions',
            'can_approve_pull_request_reviews'
          )
        }
      )
      .json<github.ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryResponse>()
  }

  /**
 * Lists all self-hosted runners configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_self_hosted_runners_for_repo',
    description: `Lists all self-hosted runners configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListSelfHostedRunnersForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsListSelfHostedRunnersForRepo(
    params: github.ActionsListSelfHostedRunnersForRepoParams
  ): Promise<github.ActionsListSelfHostedRunnersForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/runners`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'name', 'per_page', 'page')
        )
      })
      .json<github.ActionsListSelfHostedRunnersForRepoResponse>()
  }

  /**
 * Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_runner_applications_for_repo',
    description: `Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListRunnerApplicationsForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsListRunnerApplicationsForRepo(
    params: github.ActionsListRunnerApplicationsForRepoParams
  ): Promise<github.ActionsListRunnerApplicationsForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runners/downloads`,
        {}
      )
      .json<github.ActionsListRunnerApplicationsForRepoResponse>()
  }

  /**
 * Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_generate_runner_jitconfig_for_repo',
    description: `Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need the\`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGenerateRunnerJitconfigForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsGenerateRunnerJitconfigForRepo(
    params: github.ActionsGenerateRunnerJitconfigForRepoParams
  ): Promise<github.ActionsGenerateRunnerJitconfigForRepoResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runners/generate-jitconfig`,
        {
          json: pick(params, 'name', 'runner_group_id', 'labels', 'work_folder')
        }
      )
      .json<github.ActionsGenerateRunnerJitconfigForRepoResponse>()
  }

  /**
 * Returns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_registration_token_for_repo',
    description: `Returns a token that you can pass to the \`config\` script. The token expires after one hour.

For example, you can replace \`TOKEN\` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\`\`\`
./config.sh --url https://github.com/octo-org --token TOKEN
\`\`\`

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateRegistrationTokenForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsCreateRegistrationTokenForRepo(
    params: github.ActionsCreateRegistrationTokenForRepoParams
  ): Promise<github.ActionsCreateRegistrationTokenForRepoResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runners/registration-token`,
        {}
      )
      .json<github.ActionsCreateRegistrationTokenForRepoResponse>()
  }

  /**
 * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_remove_token_for_repo',
    description: `Returns a token that you can pass to the \`config\` script to remove a self-hosted runner from an repository. The token expires after one hour.

For example, you can replace \`TOKEN\` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\`\`\`
./config.sh remove --token TOKEN
\`\`\`

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateRemoveTokenForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsCreateRemoveTokenForRepo(
    params: github.ActionsCreateRemoveTokenForRepoParams
  ): Promise<github.ActionsCreateRemoveTokenForRepoResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runners/remove-token`,
        {}
      )
      .json<github.ActionsCreateRemoveTokenForRepoResponse>()
  }

  /**
 * Gets a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_self_hosted_runner_for_repo',
    description: `Gets a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsGetSelfHostedRunnerForRepo(
    params: github.ActionsGetSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsGetSelfHostedRunnerForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}`,
        {}
      )
      .json<github.ActionsGetSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_self_hosted_runner_from_repo',
    description: `Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteSelfHostedRunnerFromRepoParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteSelfHostedRunnerFromRepo(
    params: github.ActionsDeleteSelfHostedRunnerFromRepoParams
  ): Promise<github.ActionsDeleteSelfHostedRunnerFromRepoResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}`,
        {}
      )
      .json<github.ActionsDeleteSelfHostedRunnerFromRepoResponse>()
  }

  /**
 * Lists all labels for a self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_labels_for_self_hosted_runner_for_repo',
    description: `Lists all labels for a self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListLabelsForSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsListLabelsForSelfHostedRunnerForRepo(
    params: github.ActionsListLabelsForSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsListLabelsForSelfHostedRunnerForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}/labels`,
        {}
      )
      .json<github.ActionsListLabelsForSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Adds custom labels to a self-hosted runner configured in a repository.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_add_custom_labels_to_self_hosted_runner_for_repo',
    description: `Adds custom labels to a self-hosted runner configured in a repository.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsAddCustomLabelsToSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsAddCustomLabelsToSelfHostedRunnerForRepo(
    params: github.ActionsAddCustomLabelsToSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsAddCustomLabelsToSelfHostedRunnerForRepoResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}/labels`,
        {
          json: pick(params, 'labels')
        }
      )
      .json<github.ActionsAddCustomLabelsToSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_set_custom_labels_for_self_hosted_runner_for_repo',
    description: `Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsSetCustomLabelsForSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsSetCustomLabelsForSelfHostedRunnerForRepo(
    params: github.ActionsSetCustomLabelsForSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsSetCustomLabelsForSelfHostedRunnerForRepoResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}/labels`,
        {
          json: pick(params, 'labels')
        }
      )
      .json<github.ActionsSetCustomLabelsForSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Remove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_remove_all_custom_labels_from_self_hosted_runner_for_repo',
    description: `Remove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepo(
    params: github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}/labels`,
        {}
      )
      .json<github.ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Remove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_remove_custom_label_from_self_hosted_runner_for_repo',
    description: `Remove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.

This endpoint returns a \`404 Not Found\` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema:
      github.ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsRemoveCustomLabelFromSelfHostedRunnerForRepo(
    params: github.ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoParams
  ): Promise<github.ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/runners/${params.runner_id}/labels/${params.name}`,
        {}
      )
      .json<github.ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse>()
  }

  /**
 * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
 */
  @aiFunction({
    name: 'github_actions_list_workflow_runs_for_repo',
    description: `Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: \`actor\`, \`branch\`, \`check_suite_id\`, \`created\`, \`event\`, \`head_sha\`, \`status\`.`,
    inputSchema: github.ActionsListWorkflowRunsForRepoParamsSchema,
    tags: ['actions']
  })
  async actionsListWorkflowRunsForRepo(
    params: github.ActionsListWorkflowRunsForRepoParams
  ): Promise<github.ActionsListWorkflowRunsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/runs`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'actor',
            'branch',
            'event',
            'status',
            'per_page',
            'page',
            'created',
            'exclude_pull_requests',
            'check_suite_id',
            'head_sha'
          )
        )
      })
      .json<github.ActionsListWorkflowRunsForRepoResponse>()
  }

  /**
 * Gets a specific workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_workflow_run',
    description: `Gets a specific workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflowRun(
    params: github.ActionsGetWorkflowRunParams
  ): Promise<github.ActionsGetWorkflowRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'exclude_pull_requests')
          )
        }
      )
      .json<github.ActionsGetWorkflowRunResponse>()
  }

  /**
 * Deletes a specific workflow run.

Anyone with write access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_workflow_run',
    description: `Deletes a specific workflow run.

Anyone with write access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteWorkflowRun(
    params: github.ActionsDeleteWorkflowRunParams
  ): Promise<github.ActionsDeleteWorkflowRunResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}`,
        {}
      )
      .json<github.ActionsDeleteWorkflowRunResponse>()
  }

  /**
 * Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_reviews_for_run',
    description: `Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetReviewsForRunParamsSchema,
    tags: ['actions']
  })
  async actionsGetReviewsForRun(
    params: github.ActionsGetReviewsForRunParams
  ): Promise<github.ActionsGetReviewsForRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/approvals`,
        {}
      )
      .json<github.ActionsGetReviewsForRunResponse>()
  }

  /**
 * Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_approve_workflow_run',
    description: `Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsApproveWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsApproveWorkflowRun(
    params: github.ActionsApproveWorkflowRunParams
  ): Promise<github.ActionsApproveWorkflowRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/approve`,
        {}
      )
      .json<github.ActionsApproveWorkflowRunResponse>()
  }

  /**
 * Lists artifacts for a workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_list_workflow_run_artifacts',
    description: `Lists artifacts for a workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsListWorkflowRunArtifactsParamsSchema,
    tags: ['actions']
  })
  async actionsListWorkflowRunArtifacts(
    params: github.ActionsListWorkflowRunArtifactsParams
  ): Promise<github.ActionsListWorkflowRunArtifactsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/artifacts`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'page', 'name')
          )
        }
      )
      .json<github.ActionsListWorkflowRunArtifactsResponse>()
  }

  /**
 * Gets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_workflow_run_attempt',
    description: `Gets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetWorkflowRunAttemptParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflowRunAttempt(
    params: github.ActionsGetWorkflowRunAttemptParams
  ): Promise<github.ActionsGetWorkflowRunAttemptResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/attempts/${params.attempt_number}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'exclude_pull_requests')
          )
        }
      )
      .json<github.ActionsGetWorkflowRunAttemptResponse>()
  }

  /**
 * Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint  with a private repository.
 */
  @aiFunction({
    name: 'github_actions_list_jobs_for_workflow_run_attempt',
    description: `Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint  with a private repository.`,
    inputSchema: github.ActionsListJobsForWorkflowRunAttemptParamsSchema,
    tags: ['actions']
  })
  async actionsListJobsForWorkflowRunAttempt(
    params: github.ActionsListJobsForWorkflowRunAttemptParams
  ): Promise<github.ActionsListJobsForWorkflowRunAttemptResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/attempts/${params.attempt_number}/jobs`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListJobsForWorkflowRunAttemptResponse>()
  }

  /**
 * Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for `Location:` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_download_workflow_run_attempt_logs',
    description: `Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for \`Location:\` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDownloadWorkflowRunAttemptLogsParamsSchema,
    tags: ['actions']
  })
  async actionsDownloadWorkflowRunAttemptLogs(
    params: github.ActionsDownloadWorkflowRunAttemptLogsParams
  ): Promise<github.ActionsDownloadWorkflowRunAttemptLogsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/attempts/${params.attempt_number}/logs`,
        {}
      )
      .json<github.ActionsDownloadWorkflowRunAttemptLogsResponse>()
  }

  /**
 * Cancels a workflow run using its `id`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_cancel_workflow_run',
    description: `Cancels a workflow run using its \`id\`.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCancelWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsCancelWorkflowRun(
    params: github.ActionsCancelWorkflowRunParams
  ): Promise<github.ActionsCancelWorkflowRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/cancel`,
        {}
      )
      .json<github.ActionsCancelWorkflowRunResponse>()
  }

  /**
 * Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

> [!NOTE]
> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_review_custom_gates_for_run',
    description: `Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

> [!NOTE]
> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [\`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments\`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    // TODO: Improve handling of union params
    inputSchema: github.ActionsReviewCustomGatesForRunParamsSchema as any,
    tags: ['actions']
  })
  async actionsReviewCustomGatesForRun(
    params: github.ActionsReviewCustomGatesForRunParams
  ): Promise<github.ActionsReviewCustomGatesForRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/deployment_protection_rule`,
        {
          json: params
        }
      )
      .json<github.ActionsReviewCustomGatesForRunResponse>()
  }

  /**
 * Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_force_cancel_workflow_run',
    description: `Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an \`always()\` condition on a job.
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [\`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel\`](/rest/actions/workflow-runs#cancel-a-workflow-run).

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsForceCancelWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsForceCancelWorkflowRun(
    params: github.ActionsForceCancelWorkflowRunParams
  ): Promise<github.ActionsForceCancelWorkflowRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/force-cancel`,
        {}
      )
      .json<github.ActionsForceCancelWorkflowRunResponse>()
  }

  /**
 * Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_list_jobs_for_workflow_run',
    description: `Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsListJobsForWorkflowRunParamsSchema,
    tags: ['actions']
  })
  async actionsListJobsForWorkflowRun(
    params: github.ActionsListJobsForWorkflowRunParams
  ): Promise<github.ActionsListJobsForWorkflowRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/jobs`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'filter', 'per_page', 'page')
          )
        }
      )
      .json<github.ActionsListJobsForWorkflowRunResponse>()
  }

  /**
 * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
`Location:` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_download_workflow_run_logs',
    description: `Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
\`Location:\` in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDownloadWorkflowRunLogsParamsSchema,
    tags: ['actions']
  })
  async actionsDownloadWorkflowRunLogs(
    params: github.ActionsDownloadWorkflowRunLogsParams
  ): Promise<github.ActionsDownloadWorkflowRunLogsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/logs`,
        {}
      )
      .json<github.ActionsDownloadWorkflowRunLogsResponse>()
  }

  /**
 * Deletes all logs for a workflow run.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_workflow_run_logs',
    description: `Deletes all logs for a workflow run.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteWorkflowRunLogsParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteWorkflowRunLogs(
    params: github.ActionsDeleteWorkflowRunLogsParams
  ): Promise<github.ActionsDeleteWorkflowRunLogsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/logs`,
        {}
      )
      .json<github.ActionsDeleteWorkflowRunLogsResponse>()
  }

  /**
 * Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_pending_deployments_for_run',
    description: `Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetPendingDeploymentsForRunParamsSchema,
    tags: ['actions']
  })
  async actionsGetPendingDeploymentsForRun(
    params: github.ActionsGetPendingDeploymentsForRunParams
  ): Promise<github.ActionsGetPendingDeploymentsForRunResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/pending_deployments`,
        {}
      )
      .json<github.ActionsGetPendingDeploymentsForRunResponse>()
  }

  /**
 * Approve or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_review_pending_deployments_for_run',
    description: `Approve or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsReviewPendingDeploymentsForRunParamsSchema,
    tags: ['actions']
  })
  async actionsReviewPendingDeploymentsForRun(
    params: github.ActionsReviewPendingDeploymentsForRunParams
  ): Promise<github.ActionsReviewPendingDeploymentsForRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/pending_deployments`,
        {
          json: pick(params, 'environment_ids', 'state', 'comment')
        }
      )
      .json<github.ActionsReviewPendingDeploymentsForRunResponse>()
  }

  /**
 * Re-runs your workflow run using its `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_re_run_workflow',
    description: `Re-runs your workflow run using its \`id\`.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsReRunWorkflowParamsSchema,
    tags: ['actions']
  })
  async actionsReRunWorkflow(
    params: github.ActionsReRunWorkflowParams
  ): Promise<github.ActionsReRunWorkflowResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/rerun`,
        {
          json: pick(params, 'enable_debug_logging')
        }
      )
      .json<github.ActionsReRunWorkflowResponse>()
  }

  /**
 * Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_re_run_workflow_failed_jobs',
    description: `Re-run all of the failed jobs and their dependent jobs in a workflow run using the \`id\` of the workflow run.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsReRunWorkflowFailedJobsParamsSchema,
    tags: ['actions']
  })
  async actionsReRunWorkflowFailedJobs(
    params: github.ActionsReRunWorkflowFailedJobsParams
  ): Promise<github.ActionsReRunWorkflowFailedJobsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/rerun-failed-jobs`,
        {
          json: pick(params, 'enable_debug_logging')
        }
      )
      .json<github.ActionsReRunWorkflowFailedJobsResponse>()
  }

  /**
 * > [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_workflow_run_usage',
    description: `> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetWorkflowRunUsageParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflowRunUsage(
    params: github.ActionsGetWorkflowRunUsageParams
  ): Promise<github.ActionsGetWorkflowRunUsageResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/runs/${params.run_id}/timing`,
        {}
      )
      .json<github.ActionsGetWorkflowRunUsageResponse>()
  }

  /**
 * Lists all secrets available in a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_repo_secrets',
    description: `Lists all secrets available in a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListRepoSecretsParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoSecrets(
    params: github.ActionsListRepoSecretsParams
  ): Promise<github.ActionsListRepoSecretsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListRepoSecretsResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_repo_public_key',
    description: `Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetRepoPublicKeyParamsSchema,
    tags: ['actions']
  })
  async actionsGetRepoPublicKey(
    params: github.ActionsGetRepoPublicKeyParams
  ): Promise<github.ActionsGetRepoPublicKeyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/secrets/public-key`,
        {}
      )
      .json<github.ActionsGetRepoPublicKeyResponse>()
  }

  /**
 * Gets a single repository secret without revealing its encrypted value.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_repo_secret',
    description: `Gets a single repository secret without revealing its encrypted value.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetRepoSecretParamsSchema,
    tags: ['actions']
  })
  async actionsGetRepoSecret(
    params: github.ActionsGetRepoSecretParams
  ): Promise<github.ActionsGetRepoSecretResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsGetRepoSecretResponse>()
  }

  /**
 * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_or_update_repo_secret',
    description: `Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateOrUpdateRepoSecretParamsSchema,
    tags: ['actions']
  })
  async actionsCreateOrUpdateRepoSecret(
    params: github.ActionsCreateOrUpdateRepoSecretParams
  ): Promise<github.ActionsCreateOrUpdateRepoSecretResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/secrets/${params.secret_name}`,
        {
          json: pick(params, 'encrypted_value', 'key_id')
        }
      )
      .json<github.ActionsCreateOrUpdateRepoSecretResponse>()
  }

  /**
 * Deletes a secret in a repository using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_repo_secret',
    description: `Deletes a secret in a repository using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteRepoSecretParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteRepoSecret(
    params: github.ActionsDeleteRepoSecretParams
  ): Promise<github.ActionsDeleteRepoSecretResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsDeleteRepoSecretResponse>()
  }

  /**
 * Lists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_repo_variables',
    description: `Lists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListRepoVariablesParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoVariables(
    params: github.ActionsListRepoVariablesParams
  ): Promise<github.ActionsListRepoVariablesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/variables`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListRepoVariablesResponse>()
  }

  /**
 * Creates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_repo_variable',
    description: `Creates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateRepoVariableParamsSchema,
    tags: ['actions']
  })
  async actionsCreateRepoVariable(
    params: github.ActionsCreateRepoVariableParams
  ): Promise<github.ActionsCreateRepoVariableResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/actions/variables`, {
        json: pick(params, 'name', 'value')
      })
      .json<github.ActionsCreateRepoVariableResponse>()
  }

  /**
 * Gets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_repo_variable',
    description: `Gets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetRepoVariableParamsSchema,
    tags: ['actions']
  })
  async actionsGetRepoVariable(
    params: github.ActionsGetRepoVariableParams
  ): Promise<github.ActionsGetRepoVariableResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/variables/${params.name}`,
        {}
      )
      .json<github.ActionsGetRepoVariableResponse>()
  }

  /**
 * Deletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_repo_variable',
    description: `Deletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteRepoVariableParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteRepoVariable(
    params: github.ActionsDeleteRepoVariableParams
  ): Promise<github.ActionsDeleteRepoVariableResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/actions/variables/${params.name}`,
        {}
      )
      .json<github.ActionsDeleteRepoVariableResponse>()
  }

  /**
 * Updates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_update_repo_variable',
    description: `Updates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsUpdateRepoVariableParamsSchema,
    tags: ['actions']
  })
  async actionsUpdateRepoVariable(
    params: github.ActionsUpdateRepoVariableParams
  ): Promise<github.ActionsUpdateRepoVariableResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/actions/variables/${params.name}`,
        {
          json: pick(params, 'name', 'value')
        }
      )
      .json<github.ActionsUpdateRepoVariableResponse>()
  }

  /**
 * Lists the workflows in a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_list_repo_workflows',
    description: `Lists the workflows in a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsListRepoWorkflowsParamsSchema,
    tags: ['actions']
  })
  async actionsListRepoWorkflows(
    params: github.ActionsListRepoWorkflowsParams
  ): Promise<github.ActionsListRepoWorkflowsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/actions/workflows`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActionsListRepoWorkflowsResponse>()
  }

  /**
 * Gets a specific workflow. You can replace `workflow_id` with the workflow
file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_workflow',
    description: `Gets a specific workflow. You can replace \`workflow_id\` with the workflow
file name. For example, you could use \`main.yaml\`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetWorkflowParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflow(
    params: github.ActionsGetWorkflowParams
  ): Promise<github.ActionsGetWorkflowResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}`,
        {}
      )
      .json<github.ActionsGetWorkflowResponse>()
  }

  /**
 * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_disable_workflow',
    description: `Disables a workflow and sets the \`state\` of the workflow to \`disabled_manually\`. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDisableWorkflowParamsSchema,
    tags: ['actions']
  })
  async actionsDisableWorkflow(
    params: github.ActionsDisableWorkflowParams
  ): Promise<github.ActionsDisableWorkflowResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}/disable`,
        {}
      )
      .json<github.ActionsDisableWorkflowResponse>()
  }

  /**
 * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_workflow_dispatch',
    description: `You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`.

You must configure your GitHub Actions workflow to run when the [\`workflow_dispatch\` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The \`inputs\` are configured in the workflow file. For more information about how to configure the \`workflow_dispatch\` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateWorkflowDispatchParamsSchema,
    tags: ['actions']
  })
  async actionsCreateWorkflowDispatch(
    params: github.ActionsCreateWorkflowDispatchParams
  ): Promise<github.ActionsCreateWorkflowDispatchResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}/dispatches`,
        {
          json: pick(params, 'ref', 'inputs')
        }
      )
      .json<github.ActionsCreateWorkflowDispatchResponse>()
  }

  /**
 * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_enable_workflow',
    description: `Enables a workflow and sets the \`state\` of the workflow to \`active\`. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsEnableWorkflowParamsSchema,
    tags: ['actions']
  })
  async actionsEnableWorkflow(
    params: github.ActionsEnableWorkflowParams
  ): Promise<github.ActionsEnableWorkflowResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}/enable`,
        {}
      )
      .json<github.ActionsEnableWorkflowResponse>()
  }

  /**
 * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
 */
  @aiFunction({
    name: 'github_actions_list_workflow_runs',
    description: `List all workflow runs for a workflow. You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: \`actor\`, \`branch\`, \`check_suite_id\`, \`created\`, \`event\`, \`head_sha\`, \`status\`.`,
    inputSchema: github.ActionsListWorkflowRunsParamsSchema,
    tags: ['actions']
  })
  async actionsListWorkflowRuns(
    params: github.ActionsListWorkflowRunsParams
  ): Promise<github.ActionsListWorkflowRunsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}/runs`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'actor',
              'branch',
              'event',
              'status',
              'per_page',
              'page',
              'created',
              'exclude_pull_requests',
              'check_suite_id',
              'head_sha'
            )
          )
        }
      )
      .json<github.ActionsListWorkflowRunsResponse>()
  }

  /**
 * > [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_actions_get_workflow_usage',
    description: `> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

You can replace \`workflow_id\` with the workflow file name. For example, you could use \`main.yaml\`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ActionsGetWorkflowUsageParamsSchema,
    tags: ['actions']
  })
  async actionsGetWorkflowUsage(
    params: github.ActionsGetWorkflowUsageParams
  ): Promise<github.ActionsGetWorkflowUsageResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/actions/workflows/${params.workflow_id}/timing`,
        {}
      )
      .json<github.ActionsGetWorkflowUsageResponse>()
  }

  /**
 * Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

For more information about viewing repository activity,
see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).".
 */
  @aiFunction({
    name: 'github_repos_list_activities',
    description: `Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

For more information about viewing repository activity,
see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).".`,
    inputSchema: github.ReposListActivitiesParamsSchema,
    tags: ['repos']
  })
  async reposListActivities(
    params: github.ReposListActivitiesParams
  ): Promise<github.ReposListActivitiesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/activity`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'direction',
            'per_page',
            'before',
            'after',
            'ref',
            'actor',
            'time_period',
            'activity_type'
          )
        )
      })
      .json<github.ReposListActivitiesResponse>()
  }

  /**
   * Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.
   */
  @aiFunction({
    name: 'github_issues_list_assignees',
    description: `Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.`,
    inputSchema: github.IssuesListAssigneesParamsSchema,
    tags: ['issues']
  })
  async issuesListAssignees(
    params: github.IssuesListAssigneesParams
  ): Promise<github.IssuesListAssigneesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/assignees`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.IssuesListAssigneesResponse>()
  }

  /**
 * Checks if a user has permission to be assigned to an issue in this repository.

If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.

Otherwise a `404` status code is returned.
 */
  @aiFunction({
    name: 'github_issues_check_user_can_be_assigned',
    description: `Checks if a user has permission to be assigned to an issue in this repository.

If the \`assignee\` can be assigned to issues in the repository, a \`204\` header with no content is returned.

Otherwise a \`404\` status code is returned.`,
    inputSchema: github.IssuesCheckUserCanBeAssignedParamsSchema,
    tags: ['issues']
  })
  async issuesCheckUserCanBeAssigned(
    params: github.IssuesCheckUserCanBeAssignedParams
  ): Promise<github.IssuesCheckUserCanBeAssignedResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/assignees/${params.assignee}`,
        {}
      )
      .json<github.IssuesCheckUserCanBeAssignedResponse>()
  }

  /**
 * Store an artifact attestation and associate it with a repository.

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.

Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
 */
  @aiFunction({
    name: 'github_repos_create_attestation',
    description: `Store an artifact attestation and associate it with a repository.

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the \`attestations:write\` permission is required.

Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).`,
    inputSchema: github.ReposCreateAttestationParamsSchema,
    tags: ['repos']
  })
  async reposCreateAttestation(
    params: github.ReposCreateAttestationParams
  ): Promise<github.ReposCreateAttestationResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/attestations`, {
        json: pick(params, 'bundle')
      })
      .json<github.ReposCreateAttestationResponse>()
  }

  /**
 * List a collection of artifact attestations with a given subject digest that are associated with a repository.

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
 */
  @aiFunction({
    name: 'github_repos_list_attestations',
    description: `List a collection of artifact attestations with a given subject digest that are associated with a repository.

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the \`attestations:read\` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI \`attestation verify\` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).`,
    inputSchema: github.ReposListAttestationsParamsSchema,
    tags: ['repos']
  })
  async reposListAttestations(
    params: github.ReposListAttestationsParams
  ): Promise<github.ReposListAttestationsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/attestations/${params.subject_digest}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'before', 'after', 'predicate_type')
          )
        }
      )
      .json<github.ReposListAttestationsResponse>()
  }

  /**
 * Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_list_autolinks',
    description: `Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.`,
    inputSchema: github.ReposListAutolinksParamsSchema,
    tags: ['repos']
  })
  async reposListAutolinks(
    params: github.ReposListAutolinksParams
  ): Promise<github.ReposListAutolinksResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/autolinks`, {})
      .json<github.ReposListAutolinksResponse>()
  }

  /**
   * Users with admin access to the repository can create an autolink.
   */
  @aiFunction({
    name: 'github_repos_create_autolink',
    description: `Users with admin access to the repository can create an autolink.`,
    inputSchema: github.ReposCreateAutolinkParamsSchema,
    tags: ['repos']
  })
  async reposCreateAutolink(
    params: github.ReposCreateAutolinkParams
  ): Promise<github.ReposCreateAutolinkResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/autolinks`, {
        json: pick(params, 'key_prefix', 'url_template', 'is_alphanumeric')
      })
      .json<github.ReposCreateAutolinkResponse>()
  }

  /**
 * This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_get_autolink',
    description: `This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.`,
    inputSchema: github.ReposGetAutolinkParamsSchema,
    tags: ['repos']
  })
  async reposGetAutolink(
    params: github.ReposGetAutolinkParams
  ): Promise<github.ReposGetAutolinkResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/autolinks/${params.autolink_id}`,
        {}
      )
      .json<github.ReposGetAutolinkResponse>()
  }

  /**
 * This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_delete_autolink',
    description: `This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.`,
    inputSchema: github.ReposDeleteAutolinkParamsSchema,
    tags: ['repos']
  })
  async reposDeleteAutolink(
    params: github.ReposDeleteAutolinkParams
  ): Promise<github.ReposDeleteAutolinkResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/autolinks/${params.autolink_id}`,
        {}
      )
      .json<github.ReposDeleteAutolinkResponse>()
  }

  /**
   * Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
   */
  @aiFunction({
    name: 'github_repos_check_automated_security_fixes',
    description: `Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".`,
    inputSchema: github.ReposCheckAutomatedSecurityFixesParamsSchema,
    tags: ['repos']
  })
  async reposCheckAutomatedSecurityFixes(
    params: github.ReposCheckAutomatedSecurityFixesParams
  ): Promise<github.ReposCheckAutomatedSecurityFixesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/automated-security-fixes`,
        {}
      )
      .json<github.ReposCheckAutomatedSecurityFixesResponse>()
  }

  /**
   * Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
   */
  @aiFunction({
    name: 'github_repos_enable_automated_security_fixes',
    description: `Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".`,
    inputSchema: github.ReposEnableAutomatedSecurityFixesParamsSchema,
    tags: ['repos']
  })
  async reposEnableAutomatedSecurityFixes(
    params: github.ReposEnableAutomatedSecurityFixesParams
  ): Promise<github.ReposEnableAutomatedSecurityFixesResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/automated-security-fixes`,
        {}
      )
      .json<github.ReposEnableAutomatedSecurityFixesResponse>()
  }

  /**
   * Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
   */
  @aiFunction({
    name: 'github_repos_disable_automated_security_fixes',
    description: `Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".`,
    inputSchema: github.ReposDisableAutomatedSecurityFixesParamsSchema,
    tags: ['repos']
  })
  async reposDisableAutomatedSecurityFixes(
    params: github.ReposDisableAutomatedSecurityFixesParams
  ): Promise<github.ReposDisableAutomatedSecurityFixesResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/automated-security-fixes`,
        {}
      )
      .json<github.ReposDisableAutomatedSecurityFixesResponse>()
  }

  /**
   * List branches.
   */
  @aiFunction({
    name: 'github_repos_list_branches',
    description: `List branches.`,
    inputSchema: github.ReposListBranchesParamsSchema,
    tags: ['repos']
  })
  async reposListBranches(
    params: github.ReposListBranchesParams
  ): Promise<github.ReposListBranchesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/branches`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'protected', 'per_page', 'page')
        )
      })
      .json<github.ReposListBranchesResponse>()
  }

  /**
   * Get a branch.
   */
  @aiFunction({
    name: 'github_repos_get_branch',
    description: `Get a branch.`,
    inputSchema: github.ReposGetBranchParamsSchema,
    tags: ['repos']
  })
  async reposGetBranch(
    params: github.ReposGetBranchParams
  ): Promise<github.ReposGetBranchResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}`,
        {}
      )
      .json<github.ReposGetBranchResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_get_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposGetBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposGetBranchProtection(
    params: github.ReposGetBranchProtectionParams
  ): Promise<github.ReposGetBranchProtectionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection`,
        {}
      )
      .json<github.ReposGetBranchProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values.

> [!NOTE]
> The list of users, apps, and teams in total is limited to 100 items.
 */
  @aiFunction({
    name: 'github_repos_update_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

> [!NOTE]
> Passing new arrays of \`users\` and \`teams\` replaces their previous values.

> [!NOTE]
> The list of users, apps, and teams in total is limited to 100 items.`,
    inputSchema: github.ReposUpdateBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposUpdateBranchProtection(
    params: github.ReposUpdateBranchProtectionParams
  ): Promise<github.ReposUpdateBranchProtectionResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection`,
        {
          json: pick(
            params,
            'required_status_checks',
            'enforce_admins',
            'required_pull_request_reviews',
            'restrictions',
            'required_linear_history',
            'allow_force_pushes',
            'allow_deletions',
            'block_creations',
            'required_conversation_resolution',
            'lock_branch',
            'allow_fork_syncing'
          )
        }
      )
      .json<github.ReposUpdateBranchProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_delete_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposDeleteBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposDeleteBranchProtection(
    params: github.ReposDeleteBranchProtectionParams
  ): Promise<github.ReposDeleteBranchProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection`,
        {}
      )
      .json<github.ReposDeleteBranchProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_get_admin_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposGetAdminBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposGetAdminBranchProtection(
    params: github.ReposGetAdminBranchProtectionParams
  ): Promise<github.ReposGetAdminBranchProtectionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/enforce_admins`,
        {}
      )
      .json<github.ReposGetAdminBranchProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
 */
  @aiFunction({
    name: 'github_repos_set_admin_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.`,
    inputSchema: github.ReposSetAdminBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposSetAdminBranchProtection(
    params: github.ReposSetAdminBranchProtectionParams
  ): Promise<github.ReposSetAdminBranchProtectionResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/enforce_admins`,
        {}
      )
      .json<github.ReposSetAdminBranchProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
 */
  @aiFunction({
    name: 'github_repos_delete_admin_branch_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.`,
    inputSchema: github.ReposDeleteAdminBranchProtectionParamsSchema,
    tags: ['repos']
  })
  async reposDeleteAdminBranchProtection(
    params: github.ReposDeleteAdminBranchProtectionParams
  ): Promise<github.ReposDeleteAdminBranchProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/enforce_admins`,
        {}
      )
      .json<github.ReposDeleteAdminBranchProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_get_pull_request_review_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposGetPullRequestReviewProtectionParamsSchema,
    tags: ['repos']
  })
  async reposGetPullRequestReviewProtection(
    params: github.ReposGetPullRequestReviewProtectionParams
  ): Promise<github.ReposGetPullRequestReviewProtectionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_pull_request_reviews`,
        {}
      )
      .json<github.ReposGetPullRequestReviewProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_delete_pull_request_review_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposDeletePullRequestReviewProtectionParamsSchema,
    tags: ['repos']
  })
  async reposDeletePullRequestReviewProtection(
    params: github.ReposDeletePullRequestReviewProtectionParams
  ): Promise<github.ReposDeletePullRequestReviewProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_pull_request_reviews`,
        {}
      )
      .json<github.ReposDeletePullRequestReviewProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values.
 */
  @aiFunction({
    name: 'github_repos_update_pull_request_review_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

> [!NOTE]
> Passing new arrays of \`users\` and \`teams\` replaces their previous values.`,
    inputSchema: github.ReposUpdatePullRequestReviewProtectionParamsSchema,
    tags: ['repos']
  })
  async reposUpdatePullRequestReviewProtection(
    params: github.ReposUpdatePullRequestReviewProtectionParams
  ): Promise<github.ReposUpdatePullRequestReviewProtectionResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_pull_request_reviews`,
        {
          json: pick(
            params,
            'dismissal_restrictions',
            'dismiss_stale_reviews',
            'require_code_owner_reviews',
            'required_approving_review_count',
            'require_last_push_approval',
            'bypass_pull_request_allowances'
          )
        }
      )
      .json<github.ReposUpdatePullRequestReviewProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.

> [!NOTE]
> You must enable branch protection to require signed commits.
 */
  @aiFunction({
    name: 'github_repos_get_commit_signature_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of \`true\` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.

> [!NOTE]
> You must enable branch protection to require signed commits.`,
    inputSchema: github.ReposGetCommitSignatureProtectionParamsSchema,
    tags: ['repos']
  })
  async reposGetCommitSignatureProtection(
    params: github.ReposGetCommitSignatureProtectionParams
  ): Promise<github.ReposGetCommitSignatureProtectionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_signatures`,
        {}
      )
      .json<github.ReposGetCommitSignatureProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
 */
  @aiFunction({
    name: 'github_repos_create_commit_signature_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.`,
    inputSchema: github.ReposCreateCommitSignatureProtectionParamsSchema,
    tags: ['repos']
  })
  async reposCreateCommitSignatureProtection(
    params: github.ReposCreateCommitSignatureProtectionParams
  ): Promise<github.ReposCreateCommitSignatureProtectionResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_signatures`,
        {}
      )
      .json<github.ReposCreateCommitSignatureProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
 */
  @aiFunction({
    name: 'github_repos_delete_commit_signature_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.`,
    inputSchema: github.ReposDeleteCommitSignatureProtectionParamsSchema,
    tags: ['repos']
  })
  async reposDeleteCommitSignatureProtection(
    params: github.ReposDeleteCommitSignatureProtectionParams
  ): Promise<github.ReposDeleteCommitSignatureProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_signatures`,
        {}
      )
      .json<github.ReposDeleteCommitSignatureProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_get_status_checks_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposGetStatusChecksProtectionParamsSchema,
    tags: ['repos']
  })
  async reposGetStatusChecksProtection(
    params: github.ReposGetStatusChecksProtectionParams
  ): Promise<github.ReposGetStatusChecksProtectionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks`,
        {}
      )
      .json<github.ReposGetStatusChecksProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_remove_status_check_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposRemoveStatusCheckProtectionParamsSchema,
    tags: ['repos']
  })
  async reposRemoveStatusCheckProtection(
    params: github.ReposRemoveStatusCheckProtectionParams
  ): Promise<github.ReposRemoveStatusCheckProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks`,
        {}
      )
      .json<github.ReposRemoveStatusCheckProtectionResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
 */
  @aiFunction({
    name: 'github_repos_update_status_check_protection',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.`,
    inputSchema: github.ReposUpdateStatusCheckProtectionParamsSchema,
    tags: ['repos']
  })
  async reposUpdateStatusCheckProtection(
    params: github.ReposUpdateStatusCheckProtectionParams
  ): Promise<github.ReposUpdateStatusCheckProtectionResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks`,
        {
          json: pick(params, 'strict', 'contexts', 'checks')
        }
      )
      .json<github.ReposUpdateStatusCheckProtectionResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_get_all_status_check_contexts',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    inputSchema: github.ReposGetAllStatusCheckContextsParamsSchema,
    tags: ['repos']
  })
  async reposGetAllStatusCheckContexts(
    params: github.ReposGetAllStatusCheckContextsParams
  ): Promise<github.ReposGetAllStatusCheckContextsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks/contexts`,
        {}
      )
      .json<github.ReposGetAllStatusCheckContextsResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_add_status_check_contexts',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposAddStatusCheckContextsParamsSchema as any,
    tags: ['repos']
  })
  async reposAddStatusCheckContexts(
    params: github.ReposAddStatusCheckContextsParams
  ): Promise<github.ReposAddStatusCheckContextsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks/contexts`,
        {
          json: params
        }
      )
      .json<github.ReposAddStatusCheckContextsResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_set_status_check_contexts',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposSetStatusCheckContextsParamsSchema as any,
    tags: ['repos']
  })
  async reposSetStatusCheckContexts(
    params: github.ReposSetStatusCheckContextsParams
  ): Promise<github.ReposSetStatusCheckContextsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks/contexts`,
        {
          json: params
        }
      )
      .json<github.ReposSetStatusCheckContextsResponse>()
  }

  /**
   * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
   */
  @aiFunction({
    name: 'github_repos_remove_status_check_contexts',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposRemoveStatusCheckContextsParamsSchema as any,
    tags: ['repos']
  })
  async reposRemoveStatusCheckContexts(
    params: github.ReposRemoveStatusCheckContextsParams
  ): Promise<github.ReposRemoveStatusCheckContextsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/required_status_checks/contexts`,
        {
          json: params
        }
      )
      .json<github.ReposRemoveStatusCheckContextsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists who has access to this protected branch.

> [!NOTE]
> Users, apps, and teams `restrictions` are only available for organization-owned repositories.
 */
  @aiFunction({
    name: 'github_repos_get_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists who has access to this protected branch.

> [!NOTE]
> Users, apps, and teams \`restrictions\` are only available for organization-owned repositories.`,
    inputSchema: github.ReposGetAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposGetAccessRestrictions(
    params: github.ReposGetAccessRestrictionsParams
  ): Promise<github.ReposGetAccessRestrictionsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions`,
        {}
      )
      .json<github.ReposGetAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch.
 */
  @aiFunction({
    name: 'github_repos_delete_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch.`,
    inputSchema: github.ReposDeleteAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposDeleteAccessRestrictions(
    params: github.ReposDeleteAccessRestrictionsParams
  ): Promise<github.ReposDeleteAccessRestrictionsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions`,
        {}
      )
      .json<github.ReposDeleteAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
 */
  @aiFunction({
    name: 'github_repos_get_apps_with_access_to_protected_branch',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.`,
    inputSchema: github.ReposGetAppsWithAccessToProtectedBranchParamsSchema,
    tags: ['repos']
  })
  async reposGetAppsWithAccessToProtectedBranch(
    params: github.ReposGetAppsWithAccessToProtectedBranchParams
  ): Promise<github.ReposGetAppsWithAccessToProtectedBranchResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/apps`,
        {}
      )
      .json<github.ReposGetAppsWithAccessToProtectedBranchResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
 */
  @aiFunction({
    name: 'github_repos_add_app_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.`,
    inputSchema: github.ReposAddAppAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposAddAppAccessRestrictions(
    params: github.ReposAddAppAccessRestrictionsParams
  ): Promise<github.ReposAddAppAccessRestrictionsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/apps`,
        {
          json: pick(params, 'apps')
        }
      )
      .json<github.ReposAddAppAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
 */
  @aiFunction({
    name: 'github_repos_set_app_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.`,
    inputSchema: github.ReposSetAppAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposSetAppAccessRestrictions(
    params: github.ReposSetAppAccessRestrictionsParams
  ): Promise<github.ReposSetAppAccessRestrictionsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/apps`,
        {
          json: pick(params, 'apps')
        }
      )
      .json<github.ReposSetAppAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
 */
  @aiFunction({
    name: 'github_repos_remove_app_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.`,
    inputSchema: github.ReposRemoveAppAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposRemoveAppAccessRestrictions(
    params: github.ReposRemoveAppAccessRestrictionsParams
  ): Promise<github.ReposRemoveAppAccessRestrictionsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/apps`,
        {
          json: pick(params, 'apps')
        }
      )
      .json<github.ReposRemoveAppAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams.
 */
  @aiFunction({
    name: 'github_repos_get_teams_with_access_to_protected_branch',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams.`,
    inputSchema: github.ReposGetTeamsWithAccessToProtectedBranchParamsSchema,
    tags: ['repos']
  })
  async reposGetTeamsWithAccessToProtectedBranch(
    params: github.ReposGetTeamsWithAccessToProtectedBranchParams
  ): Promise<github.ReposGetTeamsWithAccessToProtectedBranchResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/teams`,
        {}
      )
      .json<github.ReposGetTeamsWithAccessToProtectedBranchResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams.
 */
  @aiFunction({
    name: 'github_repos_add_team_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposAddTeamAccessRestrictionsParamsSchema as any,
    tags: ['repos']
  })
  async reposAddTeamAccessRestrictions(
    params: github.ReposAddTeamAccessRestrictionsParams
  ): Promise<github.ReposAddTeamAccessRestrictionsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/teams`,
        {
          json: params
        }
      )
      .json<github.ReposAddTeamAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
 */
  @aiFunction({
    name: 'github_repos_set_team_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposSetTeamAccessRestrictionsParamsSchema as any,
    tags: ['repos']
  })
  async reposSetTeamAccessRestrictions(
    params: github.ReposSetTeamAccessRestrictionsParams
  ): Promise<github.ReposSetTeamAccessRestrictionsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/teams`,
        {
          json: params
        }
      )
      .json<github.ReposSetTeamAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams.
 */
  @aiFunction({
    name: 'github_repos_remove_team_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposRemoveTeamAccessRestrictionsParamsSchema as any,
    tags: ['repos']
  })
  async reposRemoveTeamAccessRestrictions(
    params: github.ReposRemoveTeamAccessRestrictionsParams
  ): Promise<github.ReposRemoveTeamAccessRestrictionsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/teams`,
        {
          json: params
        }
      )
      .json<github.ReposRemoveTeamAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the people who have push access to this branch.
 */
  @aiFunction({
    name: 'github_repos_get_users_with_access_to_protected_branch',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the people who have push access to this branch.`,
    inputSchema: github.ReposGetUsersWithAccessToProtectedBranchParamsSchema,
    tags: ['repos']
  })
  async reposGetUsersWithAccessToProtectedBranch(
    params: github.ReposGetUsersWithAccessToProtectedBranchParams
  ): Promise<github.ReposGetUsersWithAccessToProtectedBranchResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/users`,
        {}
      )
      .json<github.ReposGetUsersWithAccessToProtectedBranchResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified people push access for this branch.

| Type    | Description                                                                                                                   |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.
 */
  @aiFunction({
    name: 'github_repos_add_user_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified people push access for this branch.

| Type    | Description                                                                                                                   |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| \`array\` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.`,
    inputSchema: github.ReposAddUserAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposAddUserAccessRestrictions(
    params: github.ReposAddUserAccessRestrictionsParams
  ): Promise<github.ReposAddUserAccessRestrictionsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/users`,
        {
          json: pick(params, 'users')
        }
      )
      .json<github.ReposAddUserAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

| Type    | Description                                                                                                                   |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.
 */
  @aiFunction({
    name: 'github_repos_set_user_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

| Type    | Description                                                                                                                   |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| \`array\` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.`,
    inputSchema: github.ReposSetUserAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposSetUserAccessRestrictions(
    params: github.ReposSetUserAccessRestrictionsParams
  ): Promise<github.ReposSetUserAccessRestrictionsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/users`,
        {
          json: pick(params, 'users')
        }
      )
      .json<github.ReposSetUserAccessRestrictionsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

| Type    | Description                                                                                                                                   |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.
 */
  @aiFunction({
    name: 'github_repos_remove_user_access_restrictions',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

| Type    | Description                                                                                                                                   |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| \`array\` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |.`,
    inputSchema: github.ReposRemoveUserAccessRestrictionsParamsSchema,
    tags: ['repos']
  })
  async reposRemoveUserAccessRestrictions(
    params: github.ReposRemoveUserAccessRestrictionsParams
  ): Promise<github.ReposRemoveUserAccessRestrictionsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/protection/restrictions/users`,
        {
          json: pick(params, 'users')
        }
      )
      .json<github.ReposRemoveUserAccessRestrictionsResponse>()
  }

  /**
 * Renames a branch in a repository.

> [!NOTE]
> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
 */
  @aiFunction({
    name: 'github_repos_rename_branch',
    description: `Renames a branch in a repository.

> [!NOTE]
> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

In order to rename the default branch, fine-grained access tokens also need the \`administration:write\` repository permission.`,
    inputSchema: github.ReposRenameBranchParamsSchema,
    tags: ['repos']
  })
  async reposRenameBranch(
    params: github.ReposRenameBranchParams
  ): Promise<github.ReposRenameBranchResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/branches/${params.branch}/rename`,
        {
          json: pick(params, 'new_name')
        }
      )
      .json<github.ReposRenameBranchResponse>()
  }

  /**
 * Creates a new check run for a specific commit in a repository.

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
 */
  @aiFunction({
    name: 'github_checks_create',
    description: `Creates a new check run for a specific commit in a repository.

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array.`,
    // TODO: Improve handling of union params
    inputSchema: github.ChecksCreateParamsSchema as any,
    tags: ['checks']
  })
  async checksCreate(
    params: github.ChecksCreateParams
  ): Promise<github.ChecksCreateResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/check-runs`, {
        json: params
      })
      .json<github.ChecksCreateResponse>()
  }

  /**
 * Gets a single check run using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_get',
    description: `Gets a single check run using its \`id\`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksGetParamsSchema,
    tags: ['checks']
  })
  async checksGet(
    params: github.ChecksGetParams
  ): Promise<github.ChecksGetResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/check-runs/${params.check_run_id}`,
        {}
      )
      .json<github.ChecksGetResponse>()
  }

  /**
 * Updates a check run for a specific commit in a repository.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth apps and personal access tokens (classic) cannot use this endpoint.
 */
  @aiFunction({
    name: 'github_checks_update',
    description: `Updates a check run for a specific commit in a repository.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array.

OAuth apps and personal access tokens (classic) cannot use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.ChecksUpdateParamsSchema as any,
    tags: ['checks']
  })
  async checksUpdate(
    params: github.ChecksUpdateParams
  ): Promise<github.ChecksUpdateResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/check-runs/${params.check_run_id}`,
        {
          json: params
        }
      )
      .json<github.ChecksUpdateResponse>()
  }

  /**
 * Lists annotations for a check run using the annotation `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_list_annotations',
    description: `Lists annotations for a check run using the annotation \`id\`.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksListAnnotationsParamsSchema,
    tags: ['checks']
  })
  async checksListAnnotations(
    params: github.ChecksListAnnotationsParams
  ): Promise<github.ChecksListAnnotationsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/check-runs/${params.check_run_id}/annotations`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ChecksListAnnotationsResponse>()
  }

  /**
 * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.

For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".

OAuth apps and personal access tokens (classic) cannot use this endpoint.
 */
  @aiFunction({
    name: 'github_checks_rerequest_run',
    description: `Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [\`check_run\` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action \`rerequested\`. When a check run is \`rerequested\`, its \`status\` is reset to \`queued\` and the \`conclusion\` is cleared.

For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".

OAuth apps and personal access tokens (classic) cannot use this endpoint.`,
    inputSchema: github.ChecksRerequestRunParamsSchema,
    tags: ['checks']
  })
  async checksRerequestRun(
    params: github.ChecksRerequestRunParams
  ): Promise<github.ChecksRerequestRunResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/check-runs/${params.check_run_id}/rerequest`,
        {}
      )
      .json<github.ChecksRerequestRunResponse>()
  }

  /**
 * Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth apps and personal access tokens (classic) cannot use this endpoint.
 */
  @aiFunction({
    name: 'github_checks_create_suite',
    description: `Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array and a \`null\` value for \`head_branch\`.

OAuth apps and personal access tokens (classic) cannot use this endpoint.`,
    inputSchema: github.ChecksCreateSuiteParamsSchema,
    tags: ['checks']
  })
  async checksCreateSuite(
    params: github.ChecksCreateSuiteParams
  ): Promise<github.ChecksCreateSuiteResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/check-suites`, {
        json: pick(params, 'head_sha')
      })
      .json<github.ChecksCreateSuiteResponse>()
  }

  /**
 * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
You must have admin permissions in the repository to set preferences for check suites.
 */
  @aiFunction({
    name: 'github_checks_set_suites_preferences',
    description: `Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
You must have admin permissions in the repository to set preferences for check suites.`,
    inputSchema: github.ChecksSetSuitesPreferencesParamsSchema,
    tags: ['checks']
  })
  async checksSetSuitesPreferences(
    params: github.ChecksSetSuitesPreferencesParams
  ): Promise<github.ChecksSetSuitesPreferencesResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/check-suites/preferences`,
        {
          json: pick(params, 'auto_trigger_checks')
        }
      )
      .json<github.ChecksSetSuitesPreferencesResponse>()
  }

  /**
 * Gets a single check suite using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_get_suite',
    description: `Gets a single check suite using its \`id\`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array and a \`null\` value for \`head_branch\`.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksGetSuiteParamsSchema,
    tags: ['checks']
  })
  async checksGetSuite(
    params: github.ChecksGetSuiteParams
  ): Promise<github.ChecksGetSuiteResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/check-suites/${params.check_suite_id}`,
        {}
      )
      .json<github.ChecksGetSuiteResponse>()
  }

  /**
 * Lists check runs for a check suite using its `id`.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_list_for_suite',
    description: `Lists check runs for a check suite using its \`id\`.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksListForSuiteParamsSchema,
    tags: ['checks']
  })
  async checksListForSuite(
    params: github.ChecksListForSuiteParams
  ): Promise<github.ChecksListForSuiteResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/check-suites/${params.check_suite_id}/check-runs`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'check_name', 'status', 'filter', 'per_page', 'page')
          )
        }
      )
      .json<github.ChecksListForSuiteResponse>()
  }

  /**
 * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.

OAuth apps and personal access tokens (classic) cannot use this endpoint.
 */
  @aiFunction({
    name: 'github_checks_rerequest_suite',
    description: `Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [\`check_suite\` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action \`rerequested\`. When a check suite is \`rerequested\`, its \`status\` is reset to \`queued\` and the \`conclusion\` is cleared.

OAuth apps and personal access tokens (classic) cannot use this endpoint.`,
    inputSchema: github.ChecksRerequestSuiteParamsSchema,
    tags: ['checks']
  })
  async checksRerequestSuite(
    params: github.ChecksRerequestSuiteParams
  ): Promise<github.ChecksRerequestSuiteResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/check-suites/${params.check_suite_id}/rerequest`,
        {}
      )
      .json<github.ChecksRerequestSuiteResponse>()
  }

  /**
 * Lists code scanning alerts.

The response includes a `most_recent_instance` object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used `ref` in the request).

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_list_alerts_for_repo',
    description: `Lists code scanning alerts.

The response includes a \`most_recent_instance\` object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used \`ref\` in the request).

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningListAlertsForRepoParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningListAlertsForRepo(
    params: github.CodeScanningListAlertsForRepoParams
  ): Promise<github.CodeScanningListAlertsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/code-scanning/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'tool_name',
            'tool_guid',
            'page',
            'per_page',
            'ref',
            'pr',
            'direction',
            'before',
            'after',
            'sort',
            'state',
            'severity'
          )
        )
      })
      .json<github.CodeScanningListAlertsForRepoResponse>()
  }

  /**
 * Gets a single code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_alert',
    description: `Gets a single code scanning alert.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetAlertParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetAlert(
    params: github.CodeScanningGetAlertParams
  ): Promise<github.CodeScanningGetAlertResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}`,
        {}
      )
      .json<github.CodeScanningGetAlertResponse>()
  }

  /**
 * Updates the status of a single code scanning alert.
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_update_alert',
    description: `Updates the status of a single code scanning alert.
OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningUpdateAlertParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningUpdateAlert(
    params: github.CodeScanningUpdateAlertParams
  ): Promise<github.CodeScanningUpdateAlertResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}`,
        {
          json: pick(
            params,
            'state',
            'dismissed_reason',
            'dismissed_comment',
            'create_request'
          )
        }
      )
      .json<github.CodeScanningUpdateAlertResponse>()
  }

  /**
 * Gets the status and description of an autofix for a code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_autofix',
    description: `Gets the status and description of an autofix for a code scanning alert.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetAutofixParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetAutofix(
    params: github.CodeScanningGetAutofixParams
  ): Promise<github.CodeScanningGetAutofixResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}/autofix`,
        {}
      )
      .json<github.CodeScanningGetAutofixResponse>()
  }

  /**
 * Creates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_create_autofix',
    description: `Creates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningCreateAutofixParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningCreateAutofix(
    params: github.CodeScanningCreateAutofixParams
  ): Promise<github.CodeScanningCreateAutofixResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}/autofix`,
        {}
      )
      .json<github.CodeScanningCreateAutofixResponse>()
  }

  /**
 * Commits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_commit_autofix',
    description: `Commits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningCommitAutofixParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningCommitAutofix(
    params: github.CodeScanningCommitAutofixParams
  ): Promise<github.CodeScanningCommitAutofixResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}/autofix/commits`,
        {
          json: pick(params, 'target_ref', 'message')
        }
      )
      .json<github.CodeScanningCommitAutofixResponse>()
  }

  /**
 * Lists all instances of the specified code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_list_alert_instances',
    description: `Lists all instances of the specified code scanning alert.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningListAlertInstancesParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningListAlertInstances(
    params: github.CodeScanningListAlertInstancesParams
  ): Promise<github.CodeScanningListAlertInstancesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/alerts/${params.alert_number}/instances`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'page', 'per_page', 'ref', 'pr')
          )
        }
      )
      .json<github.CodeScanningListAlertInstancesResponse>()
  }

  /**
 * Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the `page` and `per_page` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The `rules_count` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

> [!WARNING]
> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_list_recent_analyses',
    description: `Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the \`page\` and \`per_page\` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The \`rules_count\` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and \`0\` is returned in this field.

> [!WARNING]
> **Closing down notice:** The \`tool_name\` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the \`tool\` field.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningListRecentAnalysesParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningListRecentAnalyses(
    params: github.CodeScanningListRecentAnalysesParams
  ): Promise<github.CodeScanningListRecentAnalysesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/analyses`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'tool_name',
              'tool_guid',
              'page',
              'per_page',
              'pr',
              'ref',
              'sarif_id',
              'direction',
              'sort'
            )
          )
        }
      )
      .json<github.CodeScanningListRecentAnalysesResponse>()
  }

  /**
 * Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The `rules_count` field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_analysis',
    description: `Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The \`rules_count\` field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and \`0\` is returned in this field.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/sarif+json\`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the \`github/alertNumber\` and \`github/alertUrl\` properties.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetAnalysisParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetAnalysis(
    params: github.CodeScanningGetAnalysisParams
  ): Promise<github.CodeScanningGetAnalysisResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/analyses/${params.analysis_id}`,
        {}
      )
      .json<github.CodeScanningGetAnalysisResponse>()
  }

  /**
 * Deletes a specified code scanning analysis from a repository.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

```
"deletable": true
```

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* `ref`
* `tool`
* `category`

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

```
Analysis specified is not deletable.
```

The response from a successful `DELETE` operation provides you with
two alternative URLs for deleting the next analysis in the set:
`next_analysis_url` and `confirm_delete_url`.
Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
in the 200 response is `null`.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find an analysis that's identified as deletable.
Each set of analyses always has one that's identified as deletable.
Having found the deletable analysis for one of the two sets,
delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
Then repeat the process for the second set.
The procedure therefore consists of a nested loop:

**Outer loop**:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

  **Inner loop**:
  * Delete the identified analysis.
  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_delete_analysis',
    description: `Deletes a specified code scanning analysis from a repository.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

\`\`\`
"deletable": true
\`\`\`

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* \`ref\`
* \`tool\`
* \`category\`

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

\`\`\`
Analysis specified is not deletable.
\`\`\`

The response from a successful \`DELETE\` operation provides you with
two alternative URLs for deleting the next analysis in the set:
\`next_analysis_url\` and \`confirm_delete_url\`.
Use the \`next_analysis_url\` URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the \`confirm_delete_url\` URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of \`next_analysis_url\` and \`confirm_delete_url\`
in the 200 response is \`null\`.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find an analysis that's identified as deletable.
Each set of analyses always has one that's identified as deletable.
Having found the deletable analysis for one of the two sets,
delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
Then repeat the process for the second set.
The procedure therefore consists of a nested loop:

**Outer loop**:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

  **Inner loop**:
  * Delete the identified analysis.
  * Parse the response for the value of \`confirm_delete_url\` and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the \`confirm_delete_url\` value. Alternatively, you could use the \`next_analysis_url\` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningDeleteAnalysisParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningDeleteAnalysis(
    params: github.CodeScanningDeleteAnalysisParams
  ): Promise<github.CodeScanningDeleteAnalysisResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/code-scanning/analyses/${params.analysis_id}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'confirm_delete'))
        }
      )
      .json<github.CodeScanningDeleteAnalysisResponse>()
  }

  /**
 * Lists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_list_codeql_databases',
    description: `Lists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningListCodeqlDatabasesParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningListCodeqlDatabases(
    params: github.CodeScanningListCodeqlDatabasesParams
  ): Promise<github.CodeScanningListCodeqlDatabasesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/databases`,
        {}
      )
      .json<github.CodeScanningListCodeqlDatabasesResponse>()
  }

  /**
 * Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the `Accept` header of the request
to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure
your HTTP client is configured to follow redirects or use the `Location` header
to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_codeql_database',
    description: `Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the \`Accept\` header of the request
to [\`application/zip\`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure
your HTTP client is configured to follow redirects or use the \`Location\` header
to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetCodeqlDatabaseParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetCodeqlDatabase(
    params: github.CodeScanningGetCodeqlDatabaseParams
  ): Promise<github.CodeScanningGetCodeqlDatabaseResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/databases/${params.language}`,
        {}
      )
      .json<github.CodeScanningGetCodeqlDatabaseResponse>()
  }

  /**
 * Deletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_delete_codeql_database',
    description: `Deletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningDeleteCodeqlDatabaseParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningDeleteCodeqlDatabase(
    params: github.CodeScanningDeleteCodeqlDatabaseParams
  ): Promise<github.CodeScanningDeleteCodeqlDatabaseResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/databases/${params.language}`,
        {}
      )
      .json<github.CodeScanningDeleteCodeqlDatabaseResponse>()
  }

  /**
 * Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).

Use the `owner` and `repo` parameters in the URL to specify the controller repository that
will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_scanning_create_variant_analysis',
    description: `Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).

Use the \`owner\` and \`repo\` parameters in the URL to specify the controller repository that
will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.CodeScanningCreateVariantAnalysisParamsSchema as any,
    tags: ['code-scanning']
  })
  async codeScanningCreateVariantAnalysis(
    params: github.CodeScanningCreateVariantAnalysisParams
  ): Promise<github.CodeScanningCreateVariantAnalysisResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/variant-analyses`,
        {
          json: params
        }
      )
      .json<github.CodeScanningCreateVariantAnalysisResponse>()
  }

  /**
 * Gets the summary of a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_variant_analysis',
    description: `Gets the summary of a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetVariantAnalysisParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetVariantAnalysis(
    params: github.CodeScanningGetVariantAnalysisParams
  ): Promise<github.CodeScanningGetVariantAnalysisResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/variant-analyses/${params.codeql_variant_analysis_id}`,
        {}
      )
      .json<github.CodeScanningGetVariantAnalysisResponse>()
  }

  /**
 * Gets the analysis status of a repository in a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_variant_analysis_repo_task',
    description: `Gets the analysis status of a repository in a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetVariantAnalysisRepoTaskParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetVariantAnalysisRepoTask(
    params: github.CodeScanningGetVariantAnalysisRepoTaskParams
  ): Promise<github.CodeScanningGetVariantAnalysisRepoTaskResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/codeql/variant-analyses/${params.codeql_variant_analysis_id}/repos/${params.repo_owner}/${params.repo_name}`,
        {}
      )
      .json<github.CodeScanningGetVariantAnalysisRepoTaskResponse>()
  }

  /**
 * Gets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_default_setup',
    description: `Gets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetDefaultSetupParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetDefaultSetup(
    params: github.CodeScanningGetDefaultSetupParams
  ): Promise<github.CodeScanningGetDefaultSetupResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/default-setup`,
        {}
      )
      .json<github.CodeScanningGetDefaultSetupResponse>()
  }

  /**
 * Updates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_update_default_setup',
    description: `Updates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningUpdateDefaultSetupParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningUpdateDefaultSetup(
    params: github.CodeScanningUpdateDefaultSetupParams
  ): Promise<github.CodeScanningUpdateDefaultSetupResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/code-scanning/default-setup`,
        {
          json: pick(
            params,
            'state',
            'runner_type',
            'runner_label',
            'query_suite',
            'languages'
          )
        }
      )
      .json<github.CodeScanningUpdateDefaultSetupResponse>()
  }

  /**
 * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."

There are two places where you can upload code scanning results.
 - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
 - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."

You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:

```
gzip -c analysis-data.sarif | base64 -w0
```

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."


| **SARIF data**                   | **Maximum values** | **Additional limits**                                                            |
|----------------------------------|:------------------:|----------------------------------------------------------------------------------|
| Runs per file                    |         20         |                                                                                  |
| Results per run                  |       25,000       | Only the top 5,000 results will be included, prioritized by severity.            |
| Rules per run                    |       25,000       |                                                                                  |
| Tool extensions per run          |        100         |                                                                                  |
| Thread Flow Locations per result |       10,000       | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result	             |       1,000        | Only 100 locations will be included.                                             |
| Tags per rule	                   |         20         | Only 10 tags will be included.                                                   |


The `202 Accepted` response includes an `id` value.
You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
 */
  @aiFunction({
    name: 'github_code_scanning_upload_sarif',
    description: `Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."

There are two places where you can upload code scanning results.
 - If you upload to a pull request, for example \`--ref refs/pull/42/merge\` or \`--ref refs/pull/42/head\`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
 - If you upload to a branch, for example \`--ref refs/heads/my-branch\`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."

You must compress the SARIF-formatted analysis data that you want to upload, using \`gzip\`, and then encode it as a Base64 format string. For example:

\`\`\`
gzip -c analysis-data.sarif | base64 -w0
\`\`\`

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."


| **SARIF data**                   | **Maximum values** | **Additional limits**                                                            |
|----------------------------------|:------------------:|----------------------------------------------------------------------------------|
| Runs per file                    |         20         |                                                                                  |
| Results per run                  |       25,000       | Only the top 5,000 results will be included, prioritized by severity.            |
| Rules per run                    |       25,000       |                                                                                  |
| Tool extensions per run          |        100         |                                                                                  |
| Thread Flow Locations per result |       10,000       | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result	             |       1,000        | Only 100 locations will be included.                                             |
| Tags per rule	                   |         20         | Only 10 tags will be included.                                                   |


The \`202 Accepted\` response includes an \`id\` value.
You can use this ID to check the status of the upload by using it in the \`/sarifs/{sarif_id}\` endpoint.
For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.`,
    inputSchema: github.CodeScanningUploadSarifParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningUploadSarif(
    params: github.CodeScanningUploadSarifParams
  ): Promise<github.CodeScanningUploadSarifResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/code-scanning/sarifs`,
        {
          json: pick(
            params,
            'commit_sha',
            'ref',
            'sarif',
            'checkout_uri',
            'started_at',
            'tool_name',
            'validate'
          )
        }
      )
      .json<github.CodeScanningUploadSarifResponse>()
  }

  /**
 * Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
 */
  @aiFunction({
    name: 'github_code_scanning_get_sarif',
    description: `Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint with private or public repositories, or the \`public_repo\` scope to use this endpoint with only public repositories.`,
    inputSchema: github.CodeScanningGetSarifParamsSchema,
    tags: ['code-scanning']
  })
  async codeScanningGetSarif(
    params: github.CodeScanningGetSarifParams
  ): Promise<github.CodeScanningGetSarifResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-scanning/sarifs/${params.sarif_id}`,
        {}
      )
      .json<github.CodeScanningGetSarifResponse>()
  }

  /**
 * Get the code security configuration that manages a repository's code security settings.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_code_security_get_configuration_for_repository',
    description: `Get the code security configuration that manages a repository's code security settings.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.CodeSecurityGetConfigurationForRepositoryParamsSchema,
    tags: ['code-security']
  })
  async codeSecurityGetConfigurationForRepository(
    params: github.CodeSecurityGetConfigurationForRepositoryParams
  ): Promise<github.CodeSecurityGetConfigurationForRepositoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/code-security-configuration`,
        {}
      )
      .json<github.CodeSecurityGetConfigurationForRepositoryResponse>()
  }

  /**
 * List any syntax errors that are detected in the CODEOWNERS
file.

For more information about the correct CODEOWNERS syntax,
see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).".
 */
  @aiFunction({
    name: 'github_repos_codeowners_errors',
    description: `List any syntax errors that are detected in the CODEOWNERS
file.

For more information about the correct CODEOWNERS syntax,
see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).".`,
    inputSchema: github.ReposCodeownersErrorsParamsSchema,
    tags: ['repos']
  })
  async reposCodeownersErrors(
    params: github.ReposCodeownersErrorsParams
  ): Promise<github.ReposCodeownersErrorsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/codeowners/errors`, {
        searchParams: sanitizeSearchParams(pick(params, 'ref'))
      })
      .json<github.ReposCodeownersErrorsResponse>()
  }

  /**
 * Lists the codespaces associated to a specified repository and the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_in_repository_for_authenticated_user',
    description: `Lists the codespaces associated to a specified repository and the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesListInRepositoryForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListInRepositoryForAuthenticatedUser(
    params: github.CodespacesListInRepositoryForAuthenticatedUserParams
  ): Promise<github.CodespacesListInRepositoryForAuthenticatedUserResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/codespaces`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesListInRepositoryForAuthenticatedUserResponse>()
  }

  /**
 * Creates a codespace owned by the authenticated user in the specified repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_create_with_repo_for_authenticated_user',
    description: `Creates a codespace owned by the authenticated user in the specified repository.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesCreateWithRepoForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCreateWithRepoForAuthenticatedUser(
    params: github.CodespacesCreateWithRepoForAuthenticatedUserParams
  ): Promise<github.CodespacesCreateWithRepoForAuthenticatedUserResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/codespaces`, {
        json: pick(
          params,
          'ref',
          'location',
          'geo',
          'client_ip',
          'machine',
          'devcontainer_path',
          'multi_repo_permissions_opt_out',
          'working_directory',
          'idle_timeout_minutes',
          'display_name',
          'retention_period_minutes'
        )
      })
      .json<github.CodespacesCreateWithRepoForAuthenticatedUserResponse>()
  }

  /**
 * Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
specify launchpoint configurations for codespaces created within the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_devcontainers_in_repository_for_authenticated_user',
    description: `Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
specify launchpoint configurations for codespaces created within the repository.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesListDevcontainersInRepositoryForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListDevcontainersInRepositoryForAuthenticatedUser(
    params: github.CodespacesListDevcontainersInRepositoryForAuthenticatedUserParams
  ): Promise<github.CodespacesListDevcontainersInRepositoryForAuthenticatedUserResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/codespaces/devcontainers`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.CodespacesListDevcontainersInRepositoryForAuthenticatedUserResponse>()
  }

  /**
 * List the machine types available for a given repository based on its configuration.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_repo_machines_for_authenticated_user',
    description: `List the machine types available for a given repository based on its configuration.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesRepoMachinesForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesRepoMachinesForAuthenticatedUser(
    params: github.CodespacesRepoMachinesForAuthenticatedUserParams
  ): Promise<github.CodespacesRepoMachinesForAuthenticatedUserResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/codespaces/machines`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'location', 'client_ip', 'ref')
        )
      })
      .json<github.CodespacesRepoMachinesForAuthenticatedUserResponse>()
  }

  /**
 * Gets the default attributes for codespaces created by the user with the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_pre_flight_with_repo_for_authenticated_user',
    description: `Gets the default attributes for codespaces created by the user with the repository.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesPreFlightWithRepoForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesPreFlightWithRepoForAuthenticatedUser(
    params: github.CodespacesPreFlightWithRepoForAuthenticatedUserParams
  ): Promise<github.CodespacesPreFlightWithRepoForAuthenticatedUserResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/codespaces/new`, {
        searchParams: sanitizeSearchParams(pick(params, 'ref', 'client_ip'))
      })
      .json<github.CodespacesPreFlightWithRepoForAuthenticatedUserResponse>()
  }

  /**
 * Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_check_permissions_for_devcontainer',
    description: `Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesCheckPermissionsForDevcontainerParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCheckPermissionsForDevcontainer(
    params: github.CodespacesCheckPermissionsForDevcontainerParams
  ): Promise<github.CodespacesCheckPermissionsForDevcontainerResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/codespaces/permissions_check`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'ref', 'devcontainer_path')
          )
        }
      )
      .json<github.CodespacesCheckPermissionsForDevcontainerResponse>()
  }

  /**
 * Lists all development environment secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_repo_secrets',
    description: `Lists all development environment secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListRepoSecretsParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListRepoSecrets(
    params: github.CodespacesListRepoSecretsParams
  ): Promise<github.CodespacesListRepoSecretsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/codespaces/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesListRepoSecretsResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_repo_public_key',
    description: `Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

If the repository is private, OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetRepoPublicKeyParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetRepoPublicKey(
    params: github.CodespacesGetRepoPublicKeyParams
  ): Promise<github.CodespacesGetRepoPublicKeyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/codespaces/secrets/public-key`,
        {}
      )
      .json<github.CodespacesGetRepoPublicKeyResponse>()
  }

  /**
 * Gets a single repository development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_repo_secret',
    description: `Gets a single repository development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetRepoSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetRepoSecret(
    params: github.CodespacesGetRepoSecretParams
  ): Promise<github.CodespacesGetRepoSecretResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/codespaces/secrets/${params.secret_name}`,
        {}
      )
      .json<github.CodespacesGetRepoSecretResponse>()
  }

  /**
 * Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.
 */
  @aiFunction({
    name: 'github_codespaces_create_or_update_repo_secret',
    description: `Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint. The associated user must be a repository admin.`,
    inputSchema: github.CodespacesCreateOrUpdateRepoSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCreateOrUpdateRepoSecret(
    params: github.CodespacesCreateOrUpdateRepoSecretParams
  ): Promise<github.CodespacesCreateOrUpdateRepoSecretResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/codespaces/secrets/${params.secret_name}`,
        {
          json: pick(params, 'encrypted_value', 'key_id')
        }
      )
      .json<github.CodespacesCreateOrUpdateRepoSecretResponse>()
  }

  /**
 * Deletes a development environment secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.
 */
  @aiFunction({
    name: 'github_codespaces_delete_repo_secret',
    description: `Deletes a development environment secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint. The associated user must be a repository admin.`,
    inputSchema: github.CodespacesDeleteRepoSecretParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteRepoSecret(
    params: github.CodespacesDeleteRepoSecretParams
  ): Promise<github.CodespacesDeleteRepoSecretResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/codespaces/secrets/${params.secret_name}`,
        {}
      )
      .json<github.CodespacesDeleteRepoSecretResponse>()
  }

  /**
 * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_list_collaborators',
    description: `For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:org\` and \`repo\` scopes to use this endpoint.`,
    inputSchema: github.ReposListCollaboratorsParamsSchema,
    tags: ['repos']
  })
  async reposListCollaborators(
    params: github.ReposListCollaboratorsParams
  ): Promise<github.ReposListCollaboratorsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/collaborators`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'affiliation', 'permission', 'per_page', 'page')
        )
      })
      .json<github.ReposListCollaboratorsResponse>()
  }

  /**
 * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_check_collaborator',
    description: `For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:org\` and \`repo\` scopes to use this endpoint.`,
    inputSchema: github.ReposCheckCollaboratorParamsSchema,
    tags: ['repos']
  })
  async reposCheckCollaborator(
    params: github.ReposCheckCollaboratorParams
  ): Promise<github.ReposCheckCollaboratorResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/collaborators/${params.username}`,
        {}
      )
      .json<github.ReposCheckCollaboratorResponse>()
  }

  /**
 * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."

For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

```
Cannot assign {member} permission of {role name}
```

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).

**Updating an existing collaborator's permission level**

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.

**Rate limits**

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
 */
  @aiFunction({
    name: 'github_repos_add_collaborator',
    description: `This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."

For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\`\`\`
Cannot assign {member} permission of {role name}
\`\`\`

Note that, if you choose not to pass any parameters, you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).

**Updating an existing collaborator's permission level**

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different \`permission\` parameter. The response will be a \`204\`, with no other indication that the permission level changed.

**Rate limits**

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.`,
    inputSchema: github.ReposAddCollaboratorParamsSchema,
    tags: ['repos']
  })
  async reposAddCollaborator(
    params: github.ReposAddCollaboratorParams
  ): Promise<github.ReposAddCollaboratorResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/collaborators/${params.username}`,
        {
          json: pick(params, 'permission')
        }
      )
      .json<github.ReposAddCollaboratorResponse>()
  }

  /**
 * Removes a collaborator from a repository.

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

This endpoint also:
- Cancels any outstanding invitations
- Unasigns the user from any issues
- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
- Unstars the repository
- Updates access permissions to packages

Removing a user as a collaborator has the following effects on forks:
 - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
 - If the user had their own fork of the repository, the fork will be deleted.
 - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.

> [!NOTE]
> A user can still have access to the repository through organization permissions like base repository permissions.

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)".
 */
  @aiFunction({
    name: 'github_repos_remove_collaborator',
    description: `Removes a collaborator from a repository.

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

This endpoint also:
- Cancels any outstanding invitations
- Unasigns the user from any issues
- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
- Unstars the repository
- Updates access permissions to packages

Removing a user as a collaborator has the following effects on forks:
 - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
 - If the user had their own fork of the repository, the fork will be deleted.
 - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.

> [!NOTE]
> A user can still have access to the repository through organization permissions like base repository permissions.

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)".`,
    inputSchema: github.ReposRemoveCollaboratorParamsSchema,
    tags: ['repos']
  })
  async reposRemoveCollaborator(
    params: github.ReposRemoveCollaboratorParams
  ): Promise<github.ReposRemoveCollaboratorResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/collaborators/${params.username}`,
        {}
      )
      .json<github.ReposRemoveCollaboratorResponse>()
  }

  /**
 * Checks the repository permission of a collaborator. The possible repository
permissions are `admin`, `write`, `read`, and `none`.

*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the
`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the
collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The
`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.
 */
  @aiFunction({
    name: 'github_repos_get_collaborator_permission_level',
    description: `Checks the repository permission of a collaborator. The possible repository
permissions are \`admin\`, \`write\`, \`read\`, and \`none\`.

*Note*: The \`permission\` attribute provides the legacy base roles of \`admin\`, \`write\`, \`read\`, and \`none\`, where the
\`maintain\` role is mapped to \`write\` and the \`triage\` role is mapped to \`read\`. To determine the role assigned to the
collaborator, see the \`role_name\` attribute, which will provide the full role name, including custom roles. The
\`permissions\` hash can also be used to determine which base level of access the collaborator has to the repository.`,
    inputSchema: github.ReposGetCollaboratorPermissionLevelParamsSchema,
    tags: ['repos']
  })
  async reposGetCollaboratorPermissionLevel(
    params: github.ReposGetCollaboratorPermissionLevelParams
  ): Promise<github.ReposGetCollaboratorPermissionLevelResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/collaborators/${params.username}/permission`,
        {}
      )
      .json<github.ReposGetCollaboratorPermissionLevelResponse>()
  }

  /**
 * Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_repos_list_commit_comments_for_repo',
    description: `Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.ReposListCommitCommentsForRepoParamsSchema,
    tags: ['repos']
  })
  async reposListCommitCommentsForRepo(
    params: github.ReposListCommitCommentsForRepoParams
  ): Promise<github.ReposListCommitCommentsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/comments`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListCommitCommentsForRepoResponse>()
  }

  /**
 * Gets a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_repos_get_commit_comment',
    description: `Gets a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.ReposGetCommitCommentParamsSchema,
    tags: ['repos']
  })
  async reposGetCommitComment(
    params: github.ReposGetCommitCommentParams
  ): Promise<github.ReposGetCommitCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}`,
        {}
      )
      .json<github.ReposGetCommitCommentResponse>()
  }

  /**
   * Delete a commit comment.
   */
  @aiFunction({
    name: 'github_repos_delete_commit_comment',
    description: `Delete a commit comment.`,
    inputSchema: github.ReposDeleteCommitCommentParamsSchema,
    tags: ['repos']
  })
  async reposDeleteCommitComment(
    params: github.ReposDeleteCommitCommentParams
  ): Promise<github.ReposDeleteCommitCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}`,
        {}
      )
      .json<github.ReposDeleteCommitCommentResponse>()
  }

  /**
 * Updates the contents of a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_repos_update_commit_comment',
    description: `Updates the contents of a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.ReposUpdateCommitCommentParamsSchema,
    tags: ['repos']
  })
  async reposUpdateCommitComment(
    params: github.ReposUpdateCommitCommentParams
  ): Promise<github.ReposUpdateCommitCommentResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.ReposUpdateCommitCommentResponse>()
  }

  /**
   * List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
   */
  @aiFunction({
    name: 'github_reactions_list_for_commit_comment',
    description: `List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).`,
    inputSchema: github.ReactionsListForCommitCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForCommitComment(
    params: github.ReactionsListForCommitCommentParams
  ): Promise<github.ReactionsListForCommitCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForCommitCommentResponse>()
  }

  /**
   * Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.
   */
  @aiFunction({
    name: 'github_reactions_create_for_commit_comment',
    description: `Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP \`200\` status means that you already added the reaction type to this commit comment.`,
    inputSchema: github.ReactionsCreateForCommitCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForCommitComment(
    params: github.ReactionsCreateForCommitCommentParams
  ): Promise<github.ReactionsCreateForCommitCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForCommitCommentResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
 */
  @aiFunction({
    name: 'github_reactions_delete_for_commit_comment',
    description: `> [!NOTE]
> You can also specify a repository by \`repository_id\` using the route \`DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id\`.

Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).`,
    inputSchema: github.ReactionsDeleteForCommitCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForCommitComment(
    params: github.ReactionsDeleteForCommitCommentParams
  ): Promise<github.ReactionsDeleteForCommitCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/comments/${params.comment_id}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForCommitCommentResponse>()
  }

  /**
 * **Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_repos_list_commits',
    description: `**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.ReposListCommitsParamsSchema,
    tags: ['repos']
  })
  async reposListCommits(
    params: github.ReposListCommitsParams
  ): Promise<github.ReposListCommitsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/commits`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'sha',
            'path',
            'author',
            'committer',
            'since',
            'until',
            'per_page',
            'page'
          )
        )
      })
      .json<github.ReposListCommitsResponse>()
  }

  /**
 * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
 */
  @aiFunction({
    name: 'github_repos_list_branches_for_head_commit',
    description: `Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.`,
    inputSchema: github.ReposListBranchesForHeadCommitParamsSchema,
    tags: ['repos']
  })
  async reposListBranchesForHeadCommit(
    params: github.ReposListBranchesForHeadCommitParams
  ): Promise<github.ReposListBranchesForHeadCommitResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.commit_sha}/branches-where-head`,
        {}
      )
      .json<github.ReposListBranchesForHeadCommitResponse>()
  }

  /**
 * Lists the comments for a specified commit.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_repos_list_comments_for_commit',
    description: `Lists the comments for a specified commit.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.ReposListCommentsForCommitParamsSchema,
    tags: ['repos']
  })
  async reposListCommentsForCommit(
    params: github.ReposListCommentsForCommitParams
  ): Promise<github.ReposListCommentsForCommitResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.commit_sha}/comments`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListCommentsForCommitResponse>()
  }

  /**
 * Create a comment for a commit using its `:commit_sha`.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_repos_create_commit_comment',
    description: `Create a comment for a commit using its \`:commit_sha\`.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.ReposCreateCommitCommentParamsSchema,
    tags: ['repos']
  })
  async reposCreateCommitComment(
    params: github.ReposCreateCommitCommentParams
  ): Promise<github.ReposCreateCommitCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/commits/${params.commit_sha}/comments`,
        {
          json: pick(params, 'body', 'path', 'position', 'line')
        }
      )
      .json<github.ReposCreateCommitCommentResponse>()
  }

  /**
 * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.
 */
  @aiFunction({
    name: 'github_repos_list_pull_requests_associated_with_commit',
    description: `Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.

To list the open or merged pull requests associated with a branch, you can set the \`commit_sha\` parameter to the branch name.`,
    inputSchema: github.ReposListPullRequestsAssociatedWithCommitParamsSchema,
    tags: ['repos']
  })
  async reposListPullRequestsAssociatedWithCommit(
    params: github.ReposListPullRequestsAssociatedWithCommitParams
  ): Promise<github.ReposListPullRequestsAssociatedWithCommitResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.commit_sha}/pulls`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListPullRequestsAssociatedWithCommitResponse>()
  }

  /**
 * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.

> [!NOTE]
> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.

- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_repos_get_commit',
    description: `Returns the contents of a single commit reference. You must have \`read\` access for the repository to use this endpoint.

> [!NOTE]
> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.

- **\`application/vnd.github.diff\`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
- **\`application/vnd.github.patch\`**: Returns the patch of the commit. Diffs with binary data will have no \`patch\` property. Larger diffs may time out and return a 5xx status code.
- **\`application/vnd.github.sha\`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.ReposGetCommitParamsSchema,
    tags: ['repos']
  })
  async reposGetCommit(
    params: github.ReposGetCommitParams
  ): Promise<github.ReposGetCommitResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.ref}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ReposGetCommitResponse>()
  }

  /**
 * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_list_for_ref',
    description: `Lists check runs for a commit ref. The \`ref\` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array.

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the \`check_suite_id\` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksListForRefParamsSchema,
    tags: ['checks']
  })
  async checksListForRef(
    params: github.ChecksListForRefParams
  ): Promise<github.ChecksListForRefResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.ref}/check-runs`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'check_name',
              'status',
              'filter',
              'per_page',
              'page',
              'app_id'
            )
          )
        }
      )
      .json<github.ChecksListForRefResponse>()
  }

  /**
 * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
 */
  @aiFunction({
    name: 'github_checks_list_suites_for_ref',
    description: `Lists check suites for a commit \`ref\`. The \`ref\` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty \`pull_requests\` array and a \`null\` value for \`head_branch\`.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint on a private repository.`,
    inputSchema: github.ChecksListSuitesForRefParamsSchema,
    tags: ['checks']
  })
  async checksListSuitesForRef(
    params: github.ChecksListSuitesForRefParams
  ): Promise<github.ChecksListSuitesForRefResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.ref}/check-suites`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'app_id', 'check_name', 'per_page', 'page')
          )
        }
      )
      .json<github.ChecksListSuitesForRefResponse>()
  }

  /**
 * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.


Additionally, a combined `state` is returned. The `state` is one of:

*   **failure** if any of the contexts report as `error` or `failure`
*   **pending** if there are no statuses or a context is `pending`
*   **success** if the latest status for all contexts is `success`.
 */
  @aiFunction({
    name: 'github_repos_get_combined_status_for_ref',
    description: `Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.


Additionally, a combined \`state\` is returned. The \`state\` is one of:

*   **failure** if any of the contexts report as \`error\` or \`failure\`
*   **pending** if there are no statuses or a context is \`pending\`
*   **success** if the latest status for all contexts is \`success\`.`,
    inputSchema: github.ReposGetCombinedStatusForRefParamsSchema,
    tags: ['repos']
  })
  async reposGetCombinedStatusForRef(
    params: github.ReposGetCombinedStatusForRefParams
  ): Promise<github.ReposGetCombinedStatusForRefResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.ref}/status`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposGetCombinedStatusForRefResponse>()
  }

  /**
 * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.
 */
  @aiFunction({
    name: 'github_repos_list_commit_statuses_for_ref',
    description: `Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: \`GET /repos/:owner/:repo/statuses/:ref\`.`,
    inputSchema: github.ReposListCommitStatusesForRefParamsSchema,
    tags: ['repos']
  })
  async reposListCommitStatusesForRef(
    params: github.ReposListCommitStatusesForRefParams
  ): Promise<github.ReposListCommitStatusesForRefResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/commits/${params.ref}/statuses`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListCommitStatusesForRefResponse>()
  }

  /**
 * Returns all community profile metrics for a repository. The repository cannot be a fork.

The returned metrics include an overall health score, the repository description, the presence of documentation, the
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
README, and CONTRIBUTING files.

The `health_percentage` score is defined as a percentage of how many of
the recommended community health files are present. For more information, see
"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."

`content_reports_enabled` is only returned for organization-owned repositories.
 */
  @aiFunction({
    name: 'github_repos_get_community_profile_metrics',
    description: `Returns all community profile metrics for a repository. The repository cannot be a fork.

The returned metrics include an overall health score, the repository description, the presence of documentation, the
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
README, and CONTRIBUTING files.

The \`health_percentage\` score is defined as a percentage of how many of
the recommended community health files are present. For more information, see
"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."

\`content_reports_enabled\` is only returned for organization-owned repositories.`,
    inputSchema: github.ReposGetCommunityProfileMetricsParamsSchema,
    tags: ['repos']
  })
  async reposGetCommunityProfileMetrics(
    params: github.ReposGetCommunityProfileMetricsParams
  ): Promise<github.ReposGetCommunityProfileMetricsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/community/profile`, {})
      .json<github.ReposGetCommunityProfileMetricsResponse>()
  }

  /**
 * Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."

This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.diff`**: Returns the diff of the commit.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.

When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

**Working with large comparisons**

To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:

- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.

For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_repos_compare_commits',
    description: `Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."

This endpoint is equivalent to running the \`git log BASE..HEAD\` command, but it returns commits in a different order. The \`git log BASE..HEAD\` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.diff\`**: Returns the diff of the commit.
- **\`application/vnd.github.patch\`**: Returns the patch of the commit. Diffs with binary data will have no \`patch\` property.

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a \`renamed\` status have a \`previous_filename\` field showing the previous filename of the file, and files with a \`modified\` status have a \`patch\` field showing the changes made to the file.

When calling this endpoint without any paging parameter (\`per_page\` or \`page\`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

**Working with large comparisons**

To process a response with a large number of commits, use a query parameter (\`per_page\` or \`page\`) to paginate the results. When using pagination:

- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.

For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."

**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The \`verification\` object includes the following fields:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.ReposCompareCommitsParamsSchema,
    tags: ['repos']
  })
  async reposCompareCommits(
    params: github.ReposCompareCommitsParams
  ): Promise<github.ReposCompareCommitsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/compare/${params.basehead}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ReposCompareCommitsResponse>()
  }

  /**
 * Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.

**Notes**:

- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve
more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- If the requested file's size is:
  - 1 MB or smaller: All features of this endpoint are supported.
  - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
  - Greater than 100 MB: This endpoint is not supported.
 */
  @aiFunction({
    name: 'github_repos_get_content',
    description: `Gets the contents of a file or directory in a repository. Specify the file path or directory with the \`path\` parameter. If you omit the \`path\` parameter, you will receive the contents of the repository's root directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw file contents for files and symlinks.
- **\`application/vnd.github.html+json\`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
- **\`application/vnd.github.object+json\`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an \`entries\` attribute containing the array of objects.

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule, the \`submodule_git_url\` field identifies the location of the submodule repository, and the \`sha\` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (\`git_url\` and \`_links["git"]\`) and the github.com URLs (\`html_url\` and \`_links["html"]\`) will have null values.

**Notes**:

- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve
more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- If the requested file's size is:
  - 1 MB or smaller: All features of this endpoint are supported.
  - Between 1-100 MB: Only the \`raw\` or \`object\` custom media types are supported. Both will work as normal, except that when using the \`object\` media type, the \`content\` field will be an empty
string and the \`encoding\` field will be \`"none"\`. To get the contents of these larger files, use the \`raw\` media type.
  - Greater than 100 MB: This endpoint is not supported.`,
    inputSchema: github.ReposGetContentParamsSchema,
    tags: ['repos']
  })
  async reposGetContent(
    params: github.ReposGetContentParams
  ): Promise<github.ReposGetContentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/contents/${params.path}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'ref'))
        }
      )
      .json<github.ReposGetContentResponse>()
  }

  /**
 * Creates a new file or replaces an existing file in a repository.

> [!NOTE]
> If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
 */
  @aiFunction({
    name: 'github_repos_create_or_update_file_contents',
    description: `Creates a new file or replaces an existing file in a repository.

> [!NOTE]
> If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint. The \`workflow\` scope is also required in order to modify files in the \`.github/workflows\` directory.`,
    inputSchema: github.ReposCreateOrUpdateFileContentsParamsSchema,
    tags: ['repos']
  })
  async reposCreateOrUpdateFileContents(
    params: github.ReposCreateOrUpdateFileContentsParams
  ): Promise<github.ReposCreateOrUpdateFileContentsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/contents/${params.path}`,
        {
          json: pick(
            params,
            'message',
            'content',
            'sha',
            'branch',
            'committer',
            'author'
          )
        }
      )
      .json<github.ReposCreateOrUpdateFileContentsResponse>()
  }

  /**
 * Deletes a file in a repository.

You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.

The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.

You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.

> [!NOTE]
> If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
 */
  @aiFunction({
    name: 'github_repos_delete_file',
    description: `Deletes a file in a repository.

You can provide an additional \`committer\` parameter, which is an object containing information about the committer. Or, you can provide an \`author\` parameter, which is an object containing information about the author.

The \`author\` section is optional and is filled in with the \`committer\` information if omitted. If the \`committer\` information is omitted, the authenticated user's information is used.

You must provide values for both \`name\` and \`email\`, whether you choose to use \`author\` or \`committer\`. Otherwise, you'll receive a \`422\` status code.

> [!NOTE]
> If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.`,
    inputSchema: github.ReposDeleteFileParamsSchema,
    tags: ['repos']
  })
  async reposDeleteFile(
    params: github.ReposDeleteFileParams
  ): Promise<github.ReposDeleteFileResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/contents/${params.path}`,
        {
          json: pick(params, 'message', 'sha', 'branch', 'committer', 'author')
        }
      )
      .json<github.ReposDeleteFileResponse>()
  }

  /**
 * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
 */
  @aiFunction({
    name: 'github_repos_list_contributors',
    description: `Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.`,
    inputSchema: github.ReposListContributorsParamsSchema,
    tags: ['repos']
  })
  async reposListContributors(
    params: github.ReposListContributorsParams
  ): Promise<github.ReposListContributorsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/contributors`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'anon', 'per_page', 'page')
        )
      })
      .json<github.ReposListContributorsResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
   */
  @aiFunction({
    name: 'github_dependabot_list_alerts_for_repo',
    description: `OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.DependabotListAlertsForRepoParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListAlertsForRepo(
    params: github.DependabotListAlertsForRepoParams
  ): Promise<github.DependabotListAlertsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/dependabot/alerts`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'severity',
            'ecosystem',
            'package',
            'manifest',
            'epss_percentage',
            'scope',
            'sort',
            'direction',
            'page',
            'per_page',
            'before',
            'after',
            'first',
            'last'
          )
        )
      })
      .json<github.DependabotListAlertsForRepoResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
   */
  @aiFunction({
    name: 'github_dependabot_get_alert',
    description: `OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.DependabotGetAlertParamsSchema,
    tags: ['dependabot']
  })
  async dependabotGetAlert(
    params: github.DependabotGetAlertParams
  ): Promise<github.DependabotGetAlertResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/dependabot/alerts/${params.alert_number}`,
        {}
      )
      .json<github.DependabotGetAlertResponse>()
  }

  /**
 * The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_dependabot_update_alert',
    description: `The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."

OAuth app tokens and personal access tokens (classic) need the \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.DependabotUpdateAlertParamsSchema,
    tags: ['dependabot']
  })
  async dependabotUpdateAlert(
    params: github.DependabotUpdateAlertParams
  ): Promise<github.DependabotUpdateAlertResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/dependabot/alerts/${params.alert_number}`,
        {
          json: pick(params, 'state', 'dismissed_reason', 'dismissed_comment')
        }
      )
      .json<github.DependabotUpdateAlertResponse>()
  }

  /**
 * Lists all secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_list_repo_secrets',
    description: `Lists all secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.DependabotListRepoSecretsParamsSchema,
    tags: ['dependabot']
  })
  async dependabotListRepoSecrets(
    params: github.DependabotListRepoSecretsParams
  ): Promise<github.DependabotListRepoSecretsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/dependabot/secrets`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.DependabotListRepoSecretsResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets. Anyone with read access
to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
 */
  @aiFunction({
    name: 'github_dependabot_get_repo_public_key',
    description: `Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets. Anyone with read access
to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint if the repository is private.`,
    inputSchema: github.DependabotGetRepoPublicKeyParamsSchema,
    tags: ['dependabot']
  })
  async dependabotGetRepoPublicKey(
    params: github.DependabotGetRepoPublicKeyParams
  ): Promise<github.DependabotGetRepoPublicKeyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/dependabot/secrets/public-key`,
        {}
      )
      .json<github.DependabotGetRepoPublicKeyResponse>()
  }

  /**
 * Gets a single repository secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_get_repo_secret',
    description: `Gets a single repository secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.DependabotGetRepoSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotGetRepoSecret(
    params: github.DependabotGetRepoSecretParams
  ): Promise<github.DependabotGetRepoSecretResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/dependabot/secrets/${params.secret_name}`,
        {}
      )
      .json<github.DependabotGetRepoSecretResponse>()
  }

  /**
 * Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_create_or_update_repo_secret',
    description: `Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.DependabotCreateOrUpdateRepoSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotCreateOrUpdateRepoSecret(
    params: github.DependabotCreateOrUpdateRepoSecretParams
  ): Promise<github.DependabotCreateOrUpdateRepoSecretResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/dependabot/secrets/${params.secret_name}`,
        {
          json: pick(params, 'encrypted_value', 'key_id')
        }
      )
      .json<github.DependabotCreateOrUpdateRepoSecretResponse>()
  }

  /**
 * Deletes a secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependabot_delete_repo_secret',
    description: `Deletes a secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.DependabotDeleteRepoSecretParamsSchema,
    tags: ['dependabot']
  })
  async dependabotDeleteRepoSecret(
    params: github.DependabotDeleteRepoSecretParams
  ): Promise<github.DependabotDeleteRepoSecretResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/dependabot/secrets/${params.secret_name}`,
        {}
      )
      .json<github.DependabotDeleteRepoSecretResponse>()
  }

  /**
   * Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
   */
  @aiFunction({
    name: 'github_dependency_graph_diff_range',
    description: `Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.`,
    inputSchema: github.DependencyGraphDiffRangeParamsSchema,
    tags: ['dependency-graph']
  })
  async dependencyGraphDiffRange(
    params: github.DependencyGraphDiffRangeParams
  ): Promise<github.DependencyGraphDiffRangeResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/dependency-graph/compare/${params.basehead}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'name'))
        }
      )
      .json<github.DependencyGraphDiffRangeResponse>()
  }

  /**
   * Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
   */
  @aiFunction({
    name: 'github_dependency_graph_export_sbom',
    description: `Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.`,
    inputSchema: github.DependencyGraphExportSbomParamsSchema,
    tags: ['dependency-graph']
  })
  async dependencyGraphExportSbom(
    params: github.DependencyGraphExportSbomParams
  ): Promise<github.DependencyGraphExportSbomResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/dependency-graph/sbom`,
        {}
      )
      .json<github.DependencyGraphExportSbomResponse>()
  }

  /**
 * Create a new snapshot of a repository's dependencies.

The authenticated user must have access to the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_dependency_graph_create_repository_snapshot',
    description: `Create a new snapshot of a repository's dependencies.

The authenticated user must have access to the repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.DependencyGraphCreateRepositorySnapshotParamsSchema,
    tags: ['dependency-graph']
  })
  async dependencyGraphCreateRepositorySnapshot(
    params: github.DependencyGraphCreateRepositorySnapshotParams
  ): Promise<github.DependencyGraphCreateRepositorySnapshotResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/dependency-graph/snapshots`,
        {
          json: pick(
            params,
            'version',
            'job',
            'sha',
            'ref',
            'detector',
            'metadata',
            'manifests',
            'scanned'
          )
        }
      )
      .json<github.DependencyGraphCreateRepositorySnapshotResponse>()
  }

  /**
   * Simple filtering of deployments is available via query parameters:.
   */
  @aiFunction({
    name: 'github_repos_list_deployments',
    description: `Simple filtering of deployments is available via query parameters:.`,
    inputSchema: github.ReposListDeploymentsParamsSchema,
    tags: ['repos']
  })
  async reposListDeployments(
    params: github.ReposListDeploymentsParams
  ): Promise<github.ReposListDeploymentsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/deployments`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sha', 'ref', 'task', 'environment', 'per_page', 'page')
        )
      })
      .json<github.ReposListDeploymentsResponse>()
  }

  /**
 * Deployments offer a few configurable parameters with certain defaults.

The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
before we merge a pull request.

The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter
makes it easier to track which environments have requested deployments. The default environment is `production`.

The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.

By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.

The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might
be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
*   Auto-merge option is enabled in the repository
*   Topic branch does not include the latest changes on the base branch, which is `master` in the response example
*   There are no merge conflicts

If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.

Merge conflict response:

This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't
be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.

Failed commit status checks:

This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_deployment',
    description: `Deployments offer a few configurable parameters with certain defaults.

The \`ref\` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them
before we merge a pull request.

The \`environment\` parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as \`production\`, \`staging\`, and \`qa\`. This parameter
makes it easier to track which environments have requested deployments. The default environment is \`production\`.

The \`auto_merge\` parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.

By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a \`success\`
state. The \`required_contexts\` parameter allows you to specify a subset of contexts that must be \`success\`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

The \`payload\` parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.

The \`task\` parameter is used by the deployment system to allow different execution paths. In the web world this might
be \`deploy:migrations\` to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
*   Auto-merge option is enabled in the repository
*   Topic branch does not include the latest changes on the base branch, which is \`master\` in the response example
*   There are no merge conflicts

If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.

Merge conflict response:

This error happens when the \`auto_merge\` option is enabled and when the default branch (in this case \`master\`), can't
be merged into the branch that's being deployed (in this case \`topic-branch\`), due to merge conflicts.

Failed commit status checks:

This error happens when the \`required_contexts\` parameter indicates that one or more contexts need to have a \`success\`
status for the commit to be deployed, but one or more of the required contexts do not have a state of \`success\`.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repo_deployment\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposCreateDeployment(
    params: github.ReposCreateDeploymentParams
  ): Promise<github.ReposCreateDeploymentResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/deployments`, {
        json: pick(
          params,
          'ref',
          'task',
          'auto_merge',
          'required_contexts',
          'payload',
          'environment',
          'description',
          'transient_environment',
          'production_environment'
        )
      })
      .json<github.ReposCreateDeploymentResponse>()
  }

  /**
   * Get a deployment.
   */
  @aiFunction({
    name: 'github_repos_get_deployment',
    description: `Get a deployment.`,
    inputSchema: github.ReposGetDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposGetDeployment(
    params: github.ReposGetDeploymentParams
  ): Promise<github.ReposGetDeploymentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/deployments/${params.deployment_id}`,
        {}
      )
      .json<github.ReposGetDeploymentResponse>()
  }

  /**
 * If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

To set a deployment as inactive, you must:

*   Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
*   Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_delete_deployment',
    description: `If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

To set a deployment as inactive, you must:

*   Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
*   Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repo_deployment\` scope to use this endpoint.`,
    inputSchema: github.ReposDeleteDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposDeleteDeployment(
    params: github.ReposDeleteDeploymentParams
  ): Promise<github.ReposDeleteDeploymentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/deployments/${params.deployment_id}`,
        {}
      )
      .json<github.ReposDeleteDeploymentResponse>()
  }

  /**
   * Users with pull access can view deployment statuses for a deployment:.
   */
  @aiFunction({
    name: 'github_repos_list_deployment_statuses',
    description: `Users with pull access can view deployment statuses for a deployment:.`,
    inputSchema: github.ReposListDeploymentStatusesParamsSchema,
    tags: ['repos']
  })
  async reposListDeploymentStatuses(
    params: github.ReposListDeploymentStatusesParams
  ): Promise<github.ReposListDeploymentStatusesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/deployments/${params.deployment_id}/statuses`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListDeploymentStatusesResponse>()
  }

  /**
 * Users with `push` access can create deployment statuses for a given deployment.

OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_deployment_status',
    description: `Users with \`push\` access can create deployment statuses for a given deployment.

OAuth app tokens and personal access tokens (classic) need the \`repo_deployment\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateDeploymentStatusParamsSchema,
    tags: ['repos']
  })
  async reposCreateDeploymentStatus(
    params: github.ReposCreateDeploymentStatusParams
  ): Promise<github.ReposCreateDeploymentStatusResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/deployments/${params.deployment_id}/statuses`,
        {
          json: pick(
            params,
            'state',
            'target_url',
            'log_url',
            'description',
            'environment',
            'environment_url',
            'auto_inactive'
          )
        }
      )
      .json<github.ReposCreateDeploymentStatusResponse>()
  }

  /**
   * Users with pull access can view a deployment status for a deployment:.
   */
  @aiFunction({
    name: 'github_repos_get_deployment_status',
    description: `Users with pull access can view a deployment status for a deployment:.`,
    inputSchema: github.ReposGetDeploymentStatusParamsSchema,
    tags: ['repos']
  })
  async reposGetDeploymentStatus(
    params: github.ReposGetDeploymentStatusParams
  ): Promise<github.ReposGetDeploymentStatusResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/deployments/${params.deployment_id}/statuses/${params.status_id}`,
        {}
      )
      .json<github.ReposGetDeploymentStatusResponse>()
  }

  /**
 * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."

The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.

This input example shows how you can use the `client_payload` as a test to debug your workflow.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_dispatch_event',
    description: `You can use this endpoint to trigger a webhook event called \`repository_dispatch\` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the \`repository_dispatch\` event occurs. For an example \`repository_dispatch\` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."

The \`client_payload\` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the \`client_payload\` can include a message that a user would like to send using a GitHub Actions workflow. Or the \`client_payload\` can be used as a test to debug your workflow.

This input example shows how you can use the \`client_payload\` as a test to debug your workflow.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateDispatchEventParamsSchema,
    tags: ['repos']
  })
  async reposCreateDispatchEvent(
    params: github.ReposCreateDispatchEventParams
  ): Promise<github.ReposCreateDispatchEventResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/dispatches`, {
        json: pick(params, 'event_type', 'client_payload')
      })
      .json<github.ReposCreateDispatchEventResponse>()
  }

  /**
 * Lists the environments for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_get_all_environments',
    description: `Lists the environments for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposGetAllEnvironmentsParamsSchema,
    tags: ['repos']
  })
  async reposGetAllEnvironments(
    params: github.ReposGetAllEnvironmentsParams
  ): Promise<github.ReposGetAllEnvironmentsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/environments`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposGetAllEnvironmentsResponse>()
  }

  /**
 * > [!NOTE]
> To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_get_environment',
    description: `> [!NOTE]
> To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposGetEnvironmentParamsSchema,
    tags: ['repos']
  })
  async reposGetEnvironment(
    params: github.ReposGetEnvironmentParams
  ): Promise<github.ReposGetEnvironmentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}`,
        {}
      )
      .json<github.ReposGetEnvironmentResponse>()
  }

  /**
 * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."

> [!NOTE]
> To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."

> [!NOTE]
> To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_or_update_environment',
    description: `Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."

> [!NOTE]
> To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."

> [!NOTE]
> To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateOrUpdateEnvironmentParamsSchema,
    tags: ['repos']
  })
  async reposCreateOrUpdateEnvironment(
    params: github.ReposCreateOrUpdateEnvironmentParams
  ): Promise<github.ReposCreateOrUpdateEnvironmentResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}`,
        {
          json: pick(
            params,
            'wait_timer',
            'prevent_self_review',
            'reviewers',
            'deployment_branch_policy'
          )
        }
      )
      .json<github.ReposCreateOrUpdateEnvironmentResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
   */
  @aiFunction({
    name: 'github_repos_delete_an_environment',
    description: `OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposDeleteAnEnvironmentParamsSchema,
    tags: ['repos']
  })
  async reposDeleteAnEnvironment(
    params: github.ReposDeleteAnEnvironmentParams
  ): Promise<github.ReposDeleteAnEnvironmentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}`,
        {}
      )
      .json<github.ReposDeleteAnEnvironmentResponse>()
  }

  /**
 * Lists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_list_deployment_branch_policies',
    description: `Lists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposListDeploymentBranchPoliciesParamsSchema,
    tags: ['repos']
  })
  async reposListDeploymentBranchPolicies(
    params: github.ReposListDeploymentBranchPoliciesParams
  ): Promise<github.ReposListDeploymentBranchPoliciesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment-branch-policies`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListDeploymentBranchPoliciesResponse>()
  }

  /**
 * Creates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_deployment_branch_policy',
    description: `Creates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateDeploymentBranchPolicyParamsSchema,
    tags: ['repos']
  })
  async reposCreateDeploymentBranchPolicy(
    params: github.ReposCreateDeploymentBranchPolicyParams
  ): Promise<github.ReposCreateDeploymentBranchPolicyResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment-branch-policies`,
        {
          json: pick(params, 'name', 'type')
        }
      )
      .json<github.ReposCreateDeploymentBranchPolicyResponse>()
  }

  /**
 * Gets a deployment branch or tag policy for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_get_deployment_branch_policy',
    description: `Gets a deployment branch or tag policy for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposGetDeploymentBranchPolicyParamsSchema,
    tags: ['repos']
  })
  async reposGetDeploymentBranchPolicy(
    params: github.ReposGetDeploymentBranchPolicyParams
  ): Promise<github.ReposGetDeploymentBranchPolicyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment-branch-policies/${params.branch_policy_id}`,
        {}
      )
      .json<github.ReposGetDeploymentBranchPolicyResponse>()
  }

  /**
 * Updates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_update_deployment_branch_policy',
    description: `Updates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposUpdateDeploymentBranchPolicyParamsSchema,
    tags: ['repos']
  })
  async reposUpdateDeploymentBranchPolicy(
    params: github.ReposUpdateDeploymentBranchPolicyParams
  ): Promise<github.ReposUpdateDeploymentBranchPolicyResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment-branch-policies/${params.branch_policy_id}`,
        {
          json: pick(params, 'name')
        }
      )
      .json<github.ReposUpdateDeploymentBranchPolicyResponse>()
  }

  /**
 * Deletes a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_delete_deployment_branch_policy',
    description: `Deletes a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposDeleteDeploymentBranchPolicyParamsSchema,
    tags: ['repos']
  })
  async reposDeleteDeploymentBranchPolicy(
    params: github.ReposDeleteDeploymentBranchPolicyParams
  ): Promise<github.ReposDeleteDeploymentBranchPolicyResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment-branch-policies/${params.branch_policy_id}`,
        {}
      )
      .json<github.ReposDeleteDeploymentBranchPolicyResponse>()
  }

  /**
 * Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_get_all_deployment_protection_rules',
    description: `Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see the [documentation for the \`GET /apps/{app_slug}\` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposGetAllDeploymentProtectionRulesParamsSchema,
    tags: ['repos']
  })
  async reposGetAllDeploymentProtectionRules(
    params: github.ReposGetAllDeploymentProtectionRulesParams
  ): Promise<github.ReposGetAllDeploymentProtectionRulesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment_protection_rules`,
        {}
      )
      .json<github.ReposGetAllDeploymentProtectionRulesResponse>()
  }

  /**
 * Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_deployment_protection_rule',
    description: `Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the \`GET /apps/{app_slug}\` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposCreateDeploymentProtectionRuleParamsSchema,
    tags: ['repos']
  })
  async reposCreateDeploymentProtectionRule(
    params: github.ReposCreateDeploymentProtectionRuleParams
  ): Promise<github.ReposCreateDeploymentProtectionRuleResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment_protection_rules`,
        {
          json: pick(params, 'integration_id')
        }
      )
      .json<github.ReposCreateDeploymentProtectionRuleResponse>()
  }

  /**
 * Gets all custom deployment protection rule integrations that are available for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_list_custom_deployment_rule_integrations',
    description: `Gets all custom deployment protection rule integrations that are available for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposListCustomDeploymentRuleIntegrationsParamsSchema,
    tags: ['repos']
  })
  async reposListCustomDeploymentRuleIntegrations(
    params: github.ReposListCustomDeploymentRuleIntegrationsParams
  ): Promise<github.ReposListCustomDeploymentRuleIntegrationsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment_protection_rules/apps`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.ReposListCustomDeploymentRuleIntegrationsResponse>()
  }

  /**
 * Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_get_custom_deployment_protection_rule',
    description: `Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see [\`GET /apps/{app_slug}\`](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposGetCustomDeploymentProtectionRuleParamsSchema,
    tags: ['repos']
  })
  async reposGetCustomDeploymentProtectionRule(
    params: github.ReposGetCustomDeploymentProtectionRuleParams
  ): Promise<github.ReposGetCustomDeploymentProtectionRuleResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment_protection_rules/${params.protection_rule_id}`,
        {}
      )
      .json<github.ReposGetCustomDeploymentProtectionRuleResponse>()
  }

  /**
 * Disables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_disable_deployment_protection_rule',
    description: `Disables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposDisableDeploymentProtectionRuleParamsSchema,
    tags: ['repos']
  })
  async reposDisableDeploymentProtectionRule(
    params: github.ReposDisableDeploymentProtectionRuleParams
  ): Promise<github.ReposDisableDeploymentProtectionRuleResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/deployment_protection_rules/${params.protection_rule_id}`,
        {}
      )
      .json<github.ReposDisableDeploymentProtectionRuleResponse>()
  }

  /**
 * Lists all secrets available in an environment without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_environment_secrets',
    description: `Lists all secrets available in an environment without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListEnvironmentSecretsParamsSchema,
    tags: ['actions']
  })
  async actionsListEnvironmentSecrets(
    params: github.ActionsListEnvironmentSecretsParams
  ): Promise<github.ActionsListEnvironmentSecretsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/secrets`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListEnvironmentSecretsResponse>()
  }

  /**
 * Get the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_environment_public_key',
    description: `Get the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetEnvironmentPublicKeyParamsSchema,
    tags: ['actions']
  })
  async actionsGetEnvironmentPublicKey(
    params: github.ActionsGetEnvironmentPublicKeyParams
  ): Promise<github.ActionsGetEnvironmentPublicKeyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/secrets/public-key`,
        {}
      )
      .json<github.ActionsGetEnvironmentPublicKeyResponse>()
  }

  /**
 * Gets a single environment secret without revealing its encrypted value.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_environment_secret',
    description: `Gets a single environment secret without revealing its encrypted value.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetEnvironmentSecretParamsSchema,
    tags: ['actions']
  })
  async actionsGetEnvironmentSecret(
    params: github.ActionsGetEnvironmentSecretParams
  ): Promise<github.ActionsGetEnvironmentSecretResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsGetEnvironmentSecretResponse>()
  }

  /**
 * Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_or_update_environment_secret',
    description: `Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateOrUpdateEnvironmentSecretParamsSchema,
    tags: ['actions']
  })
  async actionsCreateOrUpdateEnvironmentSecret(
    params: github.ActionsCreateOrUpdateEnvironmentSecretParams
  ): Promise<github.ActionsCreateOrUpdateEnvironmentSecretResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/secrets/${params.secret_name}`,
        {
          json: pick(params, 'encrypted_value', 'key_id')
        }
      )
      .json<github.ActionsCreateOrUpdateEnvironmentSecretResponse>()
  }

  /**
 * Deletes a secret in an environment using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_environment_secret',
    description: `Deletes a secret in an environment using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteEnvironmentSecretParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteEnvironmentSecret(
    params: github.ActionsDeleteEnvironmentSecretParams
  ): Promise<github.ActionsDeleteEnvironmentSecretResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/secrets/${params.secret_name}`,
        {}
      )
      .json<github.ActionsDeleteEnvironmentSecretResponse>()
  }

  /**
 * Lists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_list_environment_variables',
    description: `Lists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsListEnvironmentVariablesParamsSchema,
    tags: ['actions']
  })
  async actionsListEnvironmentVariables(
    params: github.ActionsListEnvironmentVariablesParams
  ): Promise<github.ActionsListEnvironmentVariablesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/variables`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ActionsListEnvironmentVariablesResponse>()
  }

  /**
 * Create an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_create_environment_variable',
    description: `Create an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsCreateEnvironmentVariableParamsSchema,
    tags: ['actions']
  })
  async actionsCreateEnvironmentVariable(
    params: github.ActionsCreateEnvironmentVariableParams
  ): Promise<github.ActionsCreateEnvironmentVariableResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/variables`,
        {
          json: pick(params, 'name', 'value')
        }
      )
      .json<github.ActionsCreateEnvironmentVariableResponse>()
  }

  /**
 * Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_get_environment_variable',
    description: `Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsGetEnvironmentVariableParamsSchema,
    tags: ['actions']
  })
  async actionsGetEnvironmentVariable(
    params: github.ActionsGetEnvironmentVariableParams
  ): Promise<github.ActionsGetEnvironmentVariableResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/variables/${params.name}`,
        {}
      )
      .json<github.ActionsGetEnvironmentVariableResponse>()
  }

  /**
 * Deletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_delete_environment_variable',
    description: `Deletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsDeleteEnvironmentVariableParamsSchema,
    tags: ['actions']
  })
  async actionsDeleteEnvironmentVariable(
    params: github.ActionsDeleteEnvironmentVariableParams
  ): Promise<github.ActionsDeleteEnvironmentVariableResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/variables/${params.name}`,
        {}
      )
      .json<github.ActionsDeleteEnvironmentVariableResponse>()
  }

  /**
 * Updates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_actions_update_environment_variable',
    description: `Updates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ActionsUpdateEnvironmentVariableParamsSchema,
    tags: ['actions']
  })
  async actionsUpdateEnvironmentVariable(
    params: github.ActionsUpdateEnvironmentVariableParams
  ): Promise<github.ActionsUpdateEnvironmentVariableResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/environments/${params.environment_name}/variables/${params.name}`,
        {
          json: pick(params, 'name', 'value')
        }
      )
      .json<github.ActionsUpdateEnvironmentVariableResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_repo_events',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListRepoEventsParamsSchema,
    tags: ['activity']
  })
  async activityListRepoEvents(
    params: github.ActivityListRepoEventsParams
  ): Promise<github.ActivityListRepoEventsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListRepoEventsResponse>()
  }

  /**
   * List forks.
   */
  @aiFunction({
    name: 'github_repos_list_forks',
    description: `List forks.`,
    inputSchema: github.ReposListForksParamsSchema,
    tags: ['repos']
  })
  async reposListForks(
    params: github.ReposListForksParams
  ): Promise<github.ReposListForksResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/forks`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'per_page', 'page')
        )
      })
      .json<github.ReposListForksResponse>()
  }

  /**
 * Create a fork for the authenticated user.

> [!NOTE]
> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).

> [!NOTE]
> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
 */
  @aiFunction({
    name: 'github_repos_create_fork',
    description: `Create a fork for the authenticated user.

> [!NOTE]
> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).

> [!NOTE]
> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.`,
    inputSchema: github.ReposCreateForkParamsSchema,
    tags: ['repos']
  })
  async reposCreateFork(
    params: github.ReposCreateForkParams
  ): Promise<github.ReposCreateForkResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/forks`, {
        json: pick(params, 'organization', 'name', 'default_branch_only')
      })
      .json<github.ReposCreateForkResponse>()
  }

  /**
   * Create a blob.
   */
  @aiFunction({
    name: 'github_git_create_blob',
    description: `Create a blob.`,
    inputSchema: github.GitCreateBlobParamsSchema,
    tags: ['git']
  })
  async gitCreateBlob(
    params: github.GitCreateBlobParams
  ): Promise<github.GitCreateBlobResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/git/blobs`, {
        json: pick(params, 'content', 'encoding')
      })
      .json<github.GitCreateBlobResponse>()
  }

  /**
 * The `content` in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw blob data.
- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.

**Note** This endpoint supports blobs up to 100 megabytes in size.
 */
  @aiFunction({
    name: 'github_git_get_blob',
    description: `The \`content\` in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw blob data.
- **\`application/vnd.github+json\`**: Returns a JSON representation of the blob with \`content\` as a base64 encoded string. This is the default if no media type is specified.

**Note** This endpoint supports blobs up to 100 megabytes in size.`,
    inputSchema: github.GitGetBlobParamsSchema,
    tags: ['git']
  })
  async gitGetBlob(
    params: github.GitGetBlobParams
  ): Promise<github.GitGetBlobResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/blobs/${params.file_sha}`,
        {}
      )
      .json<github.GitGetBlobResponse>()
  }

  /**
 * Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_git_create_commit',
    description: `Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.GitCreateCommitParamsSchema,
    tags: ['git']
  })
  async gitCreateCommit(
    params: github.GitCreateCommitParams
  ): Promise<github.GitCreateCommitResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/git/commits`, {
        json: pick(
          params,
          'message',
          'tree',
          'parents',
          'author',
          'committer',
          'signature'
        )
      })
      .json<github.GitCreateCommitResponse>()
  }

  /**
 * Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_git_get_commit',
    description: `Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)."

**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.GitGetCommitParamsSchema,
    tags: ['git']
  })
  async gitGetCommit(
    params: github.GitGetCommitParams
  ): Promise<github.GitGetCommitResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/commits/${params.commit_sha}`,
        {}
      )
      .json<github.GitGetCommitResponse>()
  }

  /**
 * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.

When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.
 */
  @aiFunction({
    name: 'github_git_list_matching_refs',
    description: `Returns an array of references from your Git database that match the supplied name. The \`:ref\` in the URL must be formatted as \`heads/<branch name>\` for branches and \`tags/<tag name>\` for tags. If the \`:ref\` doesn't exist in the repository, but existing refs start with \`:ref\`, they will be returned as an array.

When you use this endpoint without providing a \`:ref\`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just \`heads\` and \`tags\`.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

If you request matching references for a branch named \`feature\` but the branch \`feature\` doesn't exist, the response can still include other matching head refs that start with the word \`feature\`, such as \`featureA\` and \`featureB\`.`,
    inputSchema: github.GitListMatchingRefsParamsSchema,
    tags: ['git']
  })
  async gitListMatchingRefs(
    params: github.GitListMatchingRefsParams
  ): Promise<github.GitListMatchingRefsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/matching-refs/${params.ref}`,
        {}
      )
      .json<github.GitListMatchingRefsResponse>()
  }

  /**
 * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
 */
  @aiFunction({
    name: 'github_git_get_ref',
    description: `Returns a single reference from your Git database. The \`:ref\` in the URL must be formatted as \`heads/<branch name>\` for branches and \`tags/<tag name>\` for tags. If the \`:ref\` doesn't match an existing ref, a \`404\` is returned.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".`,
    inputSchema: github.GitGetRefParamsSchema,
    tags: ['git']
  })
  async gitGetRef(
    params: github.GitGetRefParams
  ): Promise<github.GitGetRefResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/ref/${params.ref}`,
        {}
      )
      .json<github.GitGetRefResponse>()
  }

  /**
   * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
   */
  @aiFunction({
    name: 'github_git_create_ref',
    description: `Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.`,
    inputSchema: github.GitCreateRefParamsSchema,
    tags: ['git']
  })
  async gitCreateRef(
    params: github.GitCreateRefParams
  ): Promise<github.GitCreateRefResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/git/refs`, {
        json: pick(params, 'ref', 'sha')
      })
      .json<github.GitCreateRefResponse>()
  }

  /**
   * Deletes the provided reference.
   */
  @aiFunction({
    name: 'github_git_delete_ref',
    description: `Deletes the provided reference.`,
    inputSchema: github.GitDeleteRefParamsSchema,
    tags: ['git']
  })
  async gitDeleteRef(
    params: github.GitDeleteRefParams
  ): Promise<github.GitDeleteRefResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/git/refs/${params.ref}`,
        {}
      )
      .json<github.GitDeleteRefResponse>()
  }

  /**
   * Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
   */
  @aiFunction({
    name: 'github_git_update_ref',
    description: `Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.`,
    inputSchema: github.GitUpdateRefParamsSchema,
    tags: ['git']
  })
  async gitUpdateRef(
    params: github.GitUpdateRefParams
  ): Promise<github.GitUpdateRefResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/git/refs/${params.ref}`,
        {
          json: pick(params, 'sha', 'force')
        }
      )
      .json<github.GitUpdateRefResponse>()
  }

  /**
 * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_git_create_tag',
    description: `Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the \`refs/tags/[tag]\` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.

**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.GitCreateTagParamsSchema,
    tags: ['git']
  })
  async gitCreateTag(
    params: github.GitCreateTagParams
  ): Promise<github.GitCreateTagResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/git/tags`, {
        json: pick(params, 'tag', 'message', 'object', 'type', 'tagger')
      })
      .json<github.GitCreateTagResponse>()
  }

  /**
 * **Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |.
 */
  @aiFunction({
    name: 'github_git_get_tag',
    description: `**Signature verification object**

The response will include a \`verification\` object that describes the result of verifying the commit's signature. The following fields are included in the \`verification\` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| \`verified\` | \`boolean\` | Indicates whether GitHub considers the signature in this commit to be verified. |
| \`reason\` | \`string\` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| \`signature\` | \`string\` | The signature that was extracted from the commit. |
| \`payload\` | \`string\` | The value that was signed. |
| \`verified_at\` | \`string\` | The date the signature was verified by GitHub. |

These are the possible values for \`reason\` in the \`verification\` object:

| Value | Description |
| ----- | ----------- |
| \`expired_key\` | The key that made the signature is expired. |
| \`not_signing_key\` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| \`gpgverify_error\` | There was an error communicating with the signature verification service. |
| \`gpgverify_unavailable\` | The signature verification service is currently unavailable. |
| \`unsigned\` | The object does not include a signature. |
| \`unknown_signature_type\` | A non-PGP signature was found in the commit. |
| \`no_user\` | No user was associated with the \`committer\` email address in the commit. |
| \`unverified_email\` | The \`committer\` email address in the commit was associated with a user, but the email address is not verified on their account. |
| \`bad_email\` | The \`committer\` email address in the commit is not included in the identities of the PGP key that made the signature. |
| \`unknown_key\` | The key that made the signature has not been registered with any user's account. |
| \`malformed_signature\` | There was an error parsing the signature. |
| \`invalid\` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| \`valid\` | None of the above errors applied, so the signature is considered to be verified. |.`,
    inputSchema: github.GitGetTagParamsSchema,
    tags: ['git']
  })
  async gitGetTag(
    params: github.GitGetTagParams
  ): Promise<github.GitGetTagResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/tags/${params.tag_sha}`,
        {}
      )
      .json<github.GitGetTagResponse>()
  }

  /**
 * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."

Returns an error if you try to delete a file that does not exist.
 */
  @aiFunction({
    name: 'github_git_create_tree',
    description: `The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."

Returns an error if you try to delete a file that does not exist.`,
    inputSchema: github.GitCreateTreeParamsSchema,
    tags: ['git']
  })
  async gitCreateTree(
    params: github.GitCreateTreeParams
  ): Promise<github.GitCreateTreeResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/git/trees`, {
        json: pick(params, 'tree', 'base_tree')
      })
      .json<github.GitCreateTreeResponse>()
  }

  /**
 * Returns a single tree using the SHA1 value or ref name for that tree.

If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

> [!NOTE]
> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
 */
  @aiFunction({
    name: 'github_git_get_tree',
    description: `Returns a single tree using the SHA1 value or ref name for that tree.

If \`truncated\` is \`true\` in the response then the number of items in the \`tree\` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

> [!NOTE]
> The limit for the \`tree\` array is 100,000 entries with a maximum size of 7 MB when using the \`recursive\` parameter.`,
    inputSchema: github.GitGetTreeParamsSchema,
    tags: ['git']
  })
  async gitGetTree(
    params: github.GitGetTreeParams
  ): Promise<github.GitGetTreeResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/git/trees/${params.tree_sha}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'recursive'))
        }
      )
      .json<github.GitGetTreeResponse>()
  }

  /**
   * Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
   */
  @aiFunction({
    name: 'github_repos_list_webhooks',
    description: `Lists webhooks for a repository. \`last response\` may return null if there have not been any deliveries within 30 days.`,
    inputSchema: github.ReposListWebhooksParamsSchema,
    tags: ['repos']
  })
  async reposListWebhooks(
    params: github.ReposListWebhooksParams
  ): Promise<github.ReposListWebhooksResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/hooks`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListWebhooksResponse>()
  }

  /**
 * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
share the same `config` as long as those webhooks do not have any `events` that overlap.
 */
  @aiFunction({
    name: 'github_repos_create_webhook',
    description: `Repositories can have multiple webhooks installed. Each webhook should have a unique \`config\`. Multiple webhooks can
share the same \`config\` as long as those webhooks do not have any \`events\` that overlap.`,
    inputSchema: github.ReposCreateWebhookParamsSchema,
    tags: ['repos']
  })
  async reposCreateWebhook(
    params: github.ReposCreateWebhookParams
  ): Promise<github.ReposCreateWebhookResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/hooks`, {
        json: pick(params, 'name', 'config', 'events', 'active')
      })
      .json<github.ReposCreateWebhookResponse>()
  }

  /**
   * Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).".
   */
  @aiFunction({
    name: 'github_repos_get_webhook',
    description: `Returns a webhook configured in a repository. To get only the webhook \`config\` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).".`,
    inputSchema: github.ReposGetWebhookParamsSchema,
    tags: ['repos']
  })
  async reposGetWebhook(
    params: github.ReposGetWebhookParams
  ): Promise<github.ReposGetWebhookResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}`,
        {}
      )
      .json<github.ReposGetWebhookResponse>()
  }

  /**
 * Delete a webhook for an organization.

The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.
 */
  @aiFunction({
    name: 'github_repos_delete_webhook',
    description: `Delete a webhook for an organization.

The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.`,
    inputSchema: github.ReposDeleteWebhookParamsSchema,
    tags: ['repos']
  })
  async reposDeleteWebhook(
    params: github.ReposDeleteWebhookParams
  ): Promise<github.ReposDeleteWebhookResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}`,
        {}
      )
      .json<github.ReposDeleteWebhookResponse>()
  }

  /**
   * Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).".
   */
  @aiFunction({
    name: 'github_repos_update_webhook',
    description: `Updates a webhook configured in a repository. If you previously had a \`secret\` set, you must provide the same \`secret\` or set a new \`secret\` or the secret will be removed. If you are only updating individual webhook \`config\` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).".`,
    inputSchema: github.ReposUpdateWebhookParamsSchema,
    tags: ['repos']
  })
  async reposUpdateWebhook(
    params: github.ReposUpdateWebhookParams
  ): Promise<github.ReposUpdateWebhookResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}`,
        {
          json: pick(
            params,
            'config',
            'events',
            'add_events',
            'remove_events',
            'active'
          )
        }
      )
      .json<github.ReposUpdateWebhookResponse>()
  }

  /**
 * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_webhook_config_for_repo',
    description: `Returns the webhook configuration for a repository. To get more information about the webhook, including the \`active\` state and \`events\`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the \`read:repo_hook\` or \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposGetWebhookConfigForRepoParamsSchema,
    tags: ['repos']
  })
  async reposGetWebhookConfigForRepo(
    params: github.ReposGetWebhookConfigForRepoParams
  ): Promise<github.ReposGetWebhookConfigForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/config`,
        {}
      )
      .json<github.ReposGetWebhookConfigForRepoResponse>()
  }

  /**
 * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_update_webhook_config_for_repo',
    description: `Updates the webhook configuration for a repository. To update more information about the webhook, including the \`active\` state and \`events\`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the \`write:repo_hook\` or \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposUpdateWebhookConfigForRepoParamsSchema,
    tags: ['repos']
  })
  async reposUpdateWebhookConfigForRepo(
    params: github.ReposUpdateWebhookConfigForRepoParams
  ): Promise<github.ReposUpdateWebhookConfigForRepoResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/config`,
        {
          json: pick(params, 'url', 'content_type', 'secret', 'insecure_ssl')
        }
      )
      .json<github.ReposUpdateWebhookConfigForRepoResponse>()
  }

  /**
   * Returns a list of webhook deliveries for a webhook configured in a repository.
   */
  @aiFunction({
    name: 'github_repos_list_webhook_deliveries',
    description: `Returns a list of webhook deliveries for a webhook configured in a repository.`,
    inputSchema: github.ReposListWebhookDeliveriesParamsSchema,
    tags: ['repos']
  })
  async reposListWebhookDeliveries(
    params: github.ReposListWebhookDeliveriesParams
  ): Promise<github.ReposListWebhookDeliveriesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/deliveries`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'cursor'))
        }
      )
      .json<github.ReposListWebhookDeliveriesResponse>()
  }

  /**
   * Returns a delivery for a webhook configured in a repository.
   */
  @aiFunction({
    name: 'github_repos_get_webhook_delivery',
    description: `Returns a delivery for a webhook configured in a repository.`,
    inputSchema: github.ReposGetWebhookDeliveryParamsSchema,
    tags: ['repos']
  })
  async reposGetWebhookDelivery(
    params: github.ReposGetWebhookDeliveryParams
  ): Promise<github.ReposGetWebhookDeliveryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/deliveries/${params.delivery_id}`,
        {}
      )
      .json<github.ReposGetWebhookDeliveryResponse>()
  }

  /**
   * Redeliver a webhook delivery for a webhook configured in a repository.
   */
  @aiFunction({
    name: 'github_repos_redeliver_webhook_delivery',
    description: `Redeliver a webhook delivery for a webhook configured in a repository.`,
    inputSchema: github.ReposRedeliverWebhookDeliveryParamsSchema,
    tags: ['repos']
  })
  async reposRedeliverWebhookDelivery(
    params: github.ReposRedeliverWebhookDeliveryParams
  ): Promise<github.ReposRedeliverWebhookDeliveryResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/deliveries/${params.delivery_id}/attempts`,
        {}
      )
      .json<github.ReposRedeliverWebhookDeliveryResponse>()
  }

  /**
   * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
   */
  @aiFunction({
    name: 'github_repos_ping_webhook',
    description: `This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.`,
    inputSchema: github.ReposPingWebhookParamsSchema,
    tags: ['repos']
  })
  async reposPingWebhook(
    params: github.ReposPingWebhookParams
  ): Promise<github.ReposPingWebhookResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/pings`,
        {}
      )
      .json<github.ReposPingWebhookResponse>()
  }

  /**
 * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.

> [!NOTE]
> Previously `/repos/:owner/:repo/hooks/:hook_id/test`.
 */
  @aiFunction({
    name: 'github_repos_test_push_webhook',
    description: `This will trigger the hook with the latest push to the current repository if the hook is subscribed to \`push\` events. If the hook is not subscribed to \`push\` events, the server will respond with 204 but no test POST will be generated.

> [!NOTE]
> Previously \`/repos/:owner/:repo/hooks/:hook_id/test\`.`,
    inputSchema: github.ReposTestPushWebhookParamsSchema,
    tags: ['repos']
  })
  async reposTestPushWebhook(
    params: github.ReposTestPushWebhookParams
  ): Promise<github.ReposTestPushWebhookResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/hooks/${params.hook_id}/tests`,
        {}
      )
      .json<github.ReposTestPushWebhookResponse>()
  }

  /**
 * View the progress of an import.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).

**Import status**

This section includes details about the possible values of the `status` field of the Import Progress response.

An import that does not have errors will progress through these steps:

*   `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
*   `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
*   `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
*   `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
*   `complete` - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the `status` field:

*   `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
*   `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
*   `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
*   `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
*   `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.

**The project_choices field**

When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

**Git LFS related fields**

This section includes details about Git LFS related fields that may be present in the Import Progress response.

*   `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
*   `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
*   `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
*   `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
 */
  @aiFunction({
    name: 'github_migrations_get_import_status',
    description: `View the progress of an import.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).

**Import status**

This section includes details about the possible values of the \`status\` field of the Import Progress response.

An import that does not have errors will progress through these steps:

*   \`detecting\` - the "detection" step of the import is in progress because the request did not include a \`vcs\` parameter. The import is identifying the type of source control present at the URL.
*   \`importing\` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include \`commit_count\` (the total number of raw commits that will be imported) and \`percent\` (0 - 100, the current progress through the import).
*   \`mapping\` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
*   \`pushing\` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include \`push_percent\`, which is the percent value reported by \`git push\` when it is "Writing objects".
*   \`complete\` - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the \`status\` field:

*   \`auth_failed\` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
*   \`error\` - the import encountered an error. The import progress response will include the \`failed_step\` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
*   \`detection_needs_auth\` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
*   \`detection_found_nothing\` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
*   \`detection_found_multiple\` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a \`project_choices\` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.

**The project_choices field**

When multiple projects are found at the provided URL, the response hash will include a \`project_choices\` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

**Git LFS related fields**

This section includes details about Git LFS related fields that may be present in the Import Progress response.

*   \`use_lfs\` - describes whether the import has been opted in or out of using Git LFS. The value can be \`opt_in\`, \`opt_out\`, or \`undecided\` if no action has been taken.
*   \`has_large_files\` - the boolean value describing whether files larger than 100MB were found during the \`importing\` step.
*   \`large_files_size\` - the total size in gigabytes of files larger than 100MB found in the originating repository.
*   \`large_files_count\` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.`,
    inputSchema: github.MigrationsGetImportStatusParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetImportStatus(
    params: github.MigrationsGetImportStatusParams
  ): Promise<github.MigrationsGetImportStatusResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/import`, {})
      .json<github.MigrationsGetImportStatusResponse>()
  }

  /**
 * Start a source import to a GitHub repository using GitHub Importer.
Importing into a GitHub repository with GitHub Actions enabled is not supported and will
return a status `422 Unprocessable Entity` response.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_start_import',
    description: `Start a source import to a GitHub repository using GitHub Importer.
Importing into a GitHub repository with GitHub Actions enabled is not supported and will
return a status \`422 Unprocessable Entity\` response.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsStartImportParamsSchema,
    tags: ['migrations']
  })
  async migrationsStartImport(
    params: github.MigrationsStartImportParams
  ): Promise<github.MigrationsStartImportResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/import`, {
        json: pick(
          params,
          'vcs_url',
          'vcs',
          'vcs_username',
          'vcs_password',
          'tfvc_project'
        )
      })
      .json<github.MigrationsStartImportResponse>()
  }

  /**
 * Stop an import for a repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_cancel_import',
    description: `Stop an import for a repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsCancelImportParamsSchema,
    tags: ['migrations']
  })
  async migrationsCancelImport(
    params: github.MigrationsCancelImportParams
  ): Promise<github.MigrationsCancelImportResponse> {
    return this.ky
      .delete(`/repos/${params.owner}/${params.repo}/import`, {})
      .json<github.MigrationsCancelImportResponse>()
  }

  /**
 * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
You can select the project to import by providing one of the objects in the `project_choices` array in the update request.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_update_import',
    description: `An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status \`detection_found_multiple\` and the Import Progress response will include a \`project_choices\` array.
You can select the project to import by providing one of the objects in the \`project_choices\` array in the update request.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsUpdateImportParamsSchema,
    tags: ['migrations']
  })
  async migrationsUpdateImport(
    params: github.MigrationsUpdateImportParams
  ): Promise<github.MigrationsUpdateImportResponse> {
    return this.ky
      .patch(`/repos/${params.owner}/${params.repo}/import`, {
        json: pick(
          params,
          'vcs_username',
          'vcs_password',
          'vcs',
          'tfvc_project'
        )
      })
      .json<github.MigrationsUpdateImportResponse>()
  }

  /**
 * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.

This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_get_commit_authors',
    description: `Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username \`hubot\` into something like \`hubot <hubot@12341234-abab-fefe-8787-fedcba987654>\`.

This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsGetCommitAuthorsParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetCommitAuthors(
    params: github.MigrationsGetCommitAuthorsParams
  ): Promise<github.MigrationsGetCommitAuthorsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/import/authors`, {
        searchParams: sanitizeSearchParams(pick(params, 'since'))
      })
      .json<github.MigrationsGetCommitAuthorsResponse>()
  }

  /**
 * Update an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_map_commit_author',
    description: `Update an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsMapCommitAuthorParamsSchema,
    tags: ['migrations']
  })
  async migrationsMapCommitAuthor(
    params: github.MigrationsMapCommitAuthorParams
  ): Promise<github.MigrationsMapCommitAuthorResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/import/authors/${params.author_id}`,
        {
          json: pick(params, 'email', 'name')
        }
      )
      .json<github.MigrationsMapCommitAuthorResponse>()
  }

  /**
 * List files larger than 100MB found during the import

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_get_large_files',
    description: `List files larger than 100MB found during the import

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsGetLargeFilesParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetLargeFiles(
    params: github.MigrationsGetLargeFilesParams
  ): Promise<github.MigrationsGetLargeFilesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/import/large_files`, {})
      .json<github.MigrationsGetLargeFilesResponse>()
  }

  /**
 * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).

You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
 */
  @aiFunction({
    name: 'github_migrations_set_lfs_preference',
    description: `You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).

You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).`,
    inputSchema: github.MigrationsSetLfsPreferenceParamsSchema,
    tags: ['migrations']
  })
  async migrationsSetLfsPreference(
    params: github.MigrationsSetLfsPreferenceParams
  ): Promise<github.MigrationsSetLfsPreferenceResponse> {
    return this.ky
      .patch(`/repos/${params.owner}/${params.repo}/import/lfs`, {
        json: pick(params, 'use_lfs')
      })
      .json<github.MigrationsSetLfsPreferenceResponse>()
  }

  /**
 * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_repo_installation',
    description: `Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetRepoInstallationParamsSchema,
    tags: ['apps']
  })
  async appsGetRepoInstallation(
    params: github.AppsGetRepoInstallationParams
  ): Promise<github.AppsGetRepoInstallationResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/installation`, {})
      .json<github.AppsGetRepoInstallationResponse>()
  }

  /**
   * Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
   */
  @aiFunction({
    name: 'github_interactions_get_restrictions_for_repo',
    description: `Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.`,
    inputSchema: github.InteractionsGetRestrictionsForRepoParamsSchema,
    tags: ['interactions']
  })
  async interactionsGetRestrictionsForRepo(
    params: github.InteractionsGetRestrictionsForRepoParams
  ): Promise<github.InteractionsGetRestrictionsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/interaction-limits`, {})
      .json<github.InteractionsGetRestrictionsForRepoResponse>()
  }

  /**
   * Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
   */
  @aiFunction({
    name: 'github_interactions_set_restrictions_for_repo',
    description: `Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a \`409 Conflict\` response and will not be able to use this endpoint to change the interaction limit for a single repository.`,
    inputSchema: github.InteractionsSetRestrictionsForRepoParamsSchema,
    tags: ['interactions']
  })
  async interactionsSetRestrictionsForRepo(
    params: github.InteractionsSetRestrictionsForRepoParams
  ): Promise<github.InteractionsSetRestrictionsForRepoResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/interaction-limits`, {
        json: pick(params, 'limit', 'expiry')
      })
      .json<github.InteractionsSetRestrictionsForRepoResponse>()
  }

  /**
   * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
   */
  @aiFunction({
    name: 'github_interactions_remove_restrictions_for_repo',
    description: `Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a \`409 Conflict\` response and will not be able to use this endpoint to change the interaction limit for a single repository.`,
    inputSchema: github.InteractionsRemoveRestrictionsForRepoParamsSchema,
    tags: ['interactions']
  })
  async interactionsRemoveRestrictionsForRepo(
    params: github.InteractionsRemoveRestrictionsForRepoParams
  ): Promise<github.InteractionsRemoveRestrictionsForRepoResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/interaction-limits`,
        {}
      )
      .json<github.InteractionsRemoveRestrictionsForRepoResponse>()
  }

  /**
   * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
   */
  @aiFunction({
    name: 'github_repos_list_invitations',
    description: `When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.`,
    inputSchema: github.ReposListInvitationsParamsSchema,
    tags: ['repos']
  })
  async reposListInvitations(
    params: github.ReposListInvitationsParams
  ): Promise<github.ReposListInvitationsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/invitations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListInvitationsResponse>()
  }

  /**
   * Delete a repository invitation.
   */
  @aiFunction({
    name: 'github_repos_delete_invitation',
    description: `Delete a repository invitation.`,
    inputSchema: github.ReposDeleteInvitationParamsSchema,
    tags: ['repos']
  })
  async reposDeleteInvitation(
    params: github.ReposDeleteInvitationParams
  ): Promise<github.ReposDeleteInvitationResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/invitations/${params.invitation_id}`,
        {}
      )
      .json<github.ReposDeleteInvitationResponse>()
  }

  /**
   * Update a repository invitation.
   */
  @aiFunction({
    name: 'github_repos_update_invitation',
    description: `Update a repository invitation.`,
    inputSchema: github.ReposUpdateInvitationParamsSchema,
    tags: ['repos']
  })
  async reposUpdateInvitation(
    params: github.ReposUpdateInvitationParams
  ): Promise<github.ReposUpdateInvitationResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/invitations/${params.invitation_id}`,
        {
          json: pick(params, 'permissions')
        }
      )
      .json<github.ReposUpdateInvitationResponse>()
  }

  /**
 * List issues in a repository. Only open issues will be listed.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_for_repo',
    description: `List issues in a repository. Only open issues will be listed.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the \`pull_request\` key. Be aware that the \`id\` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListForRepoParamsSchema,
    tags: ['issues']
  })
  async issuesListForRepo(
    params: github.IssuesListForRepoParams
  ): Promise<github.IssuesListForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/issues`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'milestone',
            'state',
            'assignee',
            'type',
            'creator',
            'mentioned',
            'labels',
            'sort',
            'direction',
            'since',
            'per_page',
            'page'
          )
        )
      })
      .json<github.IssuesListForRepoResponse>()
  }

  /**
 * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_create',
    description: `Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a \`410 Gone\` status.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesCreateParamsSchema,
    tags: ['issues']
  })
  async issuesCreate(
    params: github.IssuesCreateParams
  ): Promise<github.IssuesCreateResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/issues`, {
        json: pick(
          params,
          'title',
          'body',
          'assignee',
          'milestone',
          'labels',
          'assignees',
          'type'
        )
      })
      .json<github.IssuesCreateResponse>()
  }

  /**
 * You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_comments_for_repo',
    description: `You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListCommentsForRepoParamsSchema,
    tags: ['issues']
  })
  async issuesListCommentsForRepo(
    params: github.IssuesListCommentsForRepoParams
  ): Promise<github.IssuesListCommentsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/issues/comments`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'since', 'per_page', 'page')
        )
      })
      .json<github.IssuesListCommentsForRepoResponse>()
  }

  /**
 * You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_get_comment',
    description: `You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesGetCommentParamsSchema,
    tags: ['issues']
  })
  async issuesGetComment(
    params: github.IssuesGetCommentParams
  ): Promise<github.IssuesGetCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}`,
        {}
      )
      .json<github.IssuesGetCommentResponse>()
  }

  /**
   * You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
   */
  @aiFunction({
    name: 'github_issues_delete_comment',
    description: `You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.`,
    inputSchema: github.IssuesDeleteCommentParamsSchema,
    tags: ['issues']
  })
  async issuesDeleteComment(
    params: github.IssuesDeleteCommentParams
  ): Promise<github.IssuesDeleteCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}`,
        {}
      )
      .json<github.IssuesDeleteCommentResponse>()
  }

  /**
 * You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_update_comment',
    description: `You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesUpdateCommentParamsSchema,
    tags: ['issues']
  })
  async issuesUpdateComment(
    params: github.IssuesUpdateCommentParams
  ): Promise<github.IssuesUpdateCommentResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.IssuesUpdateCommentResponse>()
  }

  /**
   * List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
   */
  @aiFunction({
    name: 'github_reactions_list_for_issue_comment',
    description: `List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).`,
    inputSchema: github.ReactionsListForIssueCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForIssueComment(
    params: github.ReactionsListForIssueCommentParams
  ): Promise<github.ReactionsListForIssueCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForIssueCommentResponse>()
  }

  /**
   * Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.
   */
  @aiFunction({
    name: 'github_reactions_create_for_issue_comment',
    description: `Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP \`200\` status means that you already added the reaction type to this issue comment.`,
    inputSchema: github.ReactionsCreateForIssueCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForIssueComment(
    params: github.ReactionsCreateForIssueCommentParams
  ): Promise<github.ReactionsCreateForIssueCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForIssueCommentResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
 */
  @aiFunction({
    name: 'github_reactions_delete_for_issue_comment',
    description: `> [!NOTE]
> You can also specify a repository by \`repository_id\` using the route \`DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id\`.

Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).`,
    inputSchema: github.ReactionsDeleteForIssueCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForIssueComment(
    params: github.ReactionsDeleteForIssueCommentParams
  ): Promise<github.ReactionsDeleteForIssueCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/comments/${params.comment_id}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForIssueCommentResponse>()
  }

  /**
   * Lists events for a repository.
   */
  @aiFunction({
    name: 'github_issues_list_events_for_repo',
    description: `Lists events for a repository.`,
    inputSchema: github.IssuesListEventsForRepoParamsSchema,
    tags: ['issues']
  })
  async issuesListEventsForRepo(
    params: github.IssuesListEventsForRepoParams
  ): Promise<github.IssuesListEventsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/issues/events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.IssuesListEventsForRepoResponse>()
  }

  /**
   * Gets a single event by the event id.
   */
  @aiFunction({
    name: 'github_issues_get_event',
    description: `Gets a single event by the event id.`,
    inputSchema: github.IssuesGetEventParamsSchema,
    tags: ['issues']
  })
  async issuesGetEvent(
    params: github.IssuesGetEventParams
  ): Promise<github.IssuesGetEventResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/events/${params.event_id}`,
        {}
      )
      .json<github.IssuesGetEventResponse>()
  }

  /**
 * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_get',
    description: `The API returns a [\`301 Moved Permanently\` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a \`404 Not Found\` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a \`410 Gone\` status. To receive webhook events for transferred and deleted issues, subscribe
to the [\`issues\`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the \`pull_request\` key. Be aware that the \`id\` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesGetParamsSchema,
    tags: ['issues']
  })
  async issuesGet(
    params: github.IssuesGetParams
  ): Promise<github.IssuesGetResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}`,
        {}
      )
      .json<github.IssuesGetResponse>()
  }

  /**
 * Issue owners and users with push access or Triage role can edit an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_update',
    description: `Issue owners and users with push access or Triage role can edit an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesUpdateParamsSchema,
    tags: ['issues']
  })
  async issuesUpdate(
    params: github.IssuesUpdateParams
  ): Promise<github.IssuesUpdateResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}`,
        {
          json: pick(
            params,
            'title',
            'body',
            'assignee',
            'state',
            'state_reason',
            'milestone',
            'labels',
            'assignees',
            'type'
          )
        }
      )
      .json<github.IssuesUpdateResponse>()
  }

  /**
   * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
   */
  @aiFunction({
    name: 'github_issues_add_assignees',
    description: `Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.`,
    inputSchema: github.IssuesAddAssigneesParamsSchema,
    tags: ['issues']
  })
  async issuesAddAssignees(
    params: github.IssuesAddAssigneesParams
  ): Promise<github.IssuesAddAssigneesResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/assignees`,
        {
          json: pick(params, 'assignees')
        }
      )
      .json<github.IssuesAddAssigneesResponse>()
  }

  /**
   * Removes one or more assignees from an issue.
   */
  @aiFunction({
    name: 'github_issues_remove_assignees',
    description: `Removes one or more assignees from an issue.`,
    inputSchema: github.IssuesRemoveAssigneesParamsSchema,
    tags: ['issues']
  })
  async issuesRemoveAssignees(
    params: github.IssuesRemoveAssigneesParams
  ): Promise<github.IssuesRemoveAssigneesResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/assignees`,
        {
          json: pick(params, 'assignees')
        }
      )
      .json<github.IssuesRemoveAssigneesResponse>()
  }

  /**
 * Checks if a user has permission to be assigned to a specific issue.

If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.

Otherwise a `404` status code is returned.
 */
  @aiFunction({
    name: 'github_issues_check_user_can_be_assigned_to_issue',
    description: `Checks if a user has permission to be assigned to a specific issue.

If the \`assignee\` can be assigned to this issue, a \`204\` status code with no content is returned.

Otherwise a \`404\` status code is returned.`,
    inputSchema: github.IssuesCheckUserCanBeAssignedToIssueParamsSchema,
    tags: ['issues']
  })
  async issuesCheckUserCanBeAssignedToIssue(
    params: github.IssuesCheckUserCanBeAssignedToIssueParams
  ): Promise<github.IssuesCheckUserCanBeAssignedToIssueResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/assignees/${params.assignee}`,
        {}
      )
      .json<github.IssuesCheckUserCanBeAssignedToIssueResponse>()
  }

  /**
 * You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_comments',
    description: `You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListCommentsParamsSchema,
    tags: ['issues']
  })
  async issuesListComments(
    params: github.IssuesListCommentsParams
  ): Promise<github.IssuesListCommentsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/comments`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'since', 'per_page', 'page')
          )
        }
      )
      .json<github.IssuesListCommentsResponse>()
  }

  /**
 * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_create_comment',
    description: `You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesCreateCommentParamsSchema,
    tags: ['issues']
  })
  async issuesCreateComment(
    params: github.IssuesCreateCommentParams
  ): Promise<github.IssuesCreateCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/comments`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.IssuesCreateCommentResponse>()
  }

  /**
   * Lists all events for an issue.
   */
  @aiFunction({
    name: 'github_issues_list_events',
    description: `Lists all events for an issue.`,
    inputSchema: github.IssuesListEventsParamsSchema,
    tags: ['issues']
  })
  async issuesListEvents(
    params: github.IssuesListEventsParams
  ): Promise<github.IssuesListEventsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/events`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.IssuesListEventsResponse>()
  }

  /**
   * Lists all labels for an issue.
   */
  @aiFunction({
    name: 'github_issues_list_labels_on_issue',
    description: `Lists all labels for an issue.`,
    inputSchema: github.IssuesListLabelsOnIssueParamsSchema,
    tags: ['issues']
  })
  async issuesListLabelsOnIssue(
    params: github.IssuesListLabelsOnIssueParams
  ): Promise<github.IssuesListLabelsOnIssueResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/labels`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.IssuesListLabelsOnIssueResponse>()
  }

  /**
   * Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. .
   */
  @aiFunction({
    name: 'github_issues_add_labels',
    description: `Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. .`,
    // TODO: Improve handling of union params
    inputSchema: github.IssuesAddLabelsParamsSchema as any,
    tags: ['issues']
  })
  async issuesAddLabels(
    params: github.IssuesAddLabelsParams
  ): Promise<github.IssuesAddLabelsResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/labels`,
        {
          json: params
        }
      )
      .json<github.IssuesAddLabelsResponse>()
  }

  /**
   * Removes any previous labels and sets the new labels for an issue.
   */
  @aiFunction({
    name: 'github_issues_set_labels',
    description: `Removes any previous labels and sets the new labels for an issue.`,
    // TODO: Improve handling of union params
    inputSchema: github.IssuesSetLabelsParamsSchema as any,
    tags: ['issues']
  })
  async issuesSetLabels(
    params: github.IssuesSetLabelsParams
  ): Promise<github.IssuesSetLabelsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/labels`,
        {
          json: params
        }
      )
      .json<github.IssuesSetLabelsResponse>()
  }

  /**
   * Removes all labels from an issue.
   */
  @aiFunction({
    name: 'github_issues_remove_all_labels',
    description: `Removes all labels from an issue.`,
    inputSchema: github.IssuesRemoveAllLabelsParamsSchema,
    tags: ['issues']
  })
  async issuesRemoveAllLabels(
    params: github.IssuesRemoveAllLabelsParams
  ): Promise<github.IssuesRemoveAllLabelsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/labels`,
        {}
      )
      .json<github.IssuesRemoveAllLabelsResponse>()
  }

  /**
   * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.
   */
  @aiFunction({
    name: 'github_issues_remove_label',
    description: `Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a \`404 Not Found\` status if the label does not exist.`,
    inputSchema: github.IssuesRemoveLabelParamsSchema,
    tags: ['issues']
  })
  async issuesRemoveLabel(
    params: github.IssuesRemoveLabelParams
  ): Promise<github.IssuesRemoveLabelResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/labels/${params.name}`,
        {}
      )
      .json<github.IssuesRemoveLabelResponse>()
  }

  /**
 * Users with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
 */
  @aiFunction({
    name: 'github_issues_lock',
    description: `Users with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.IssuesLockParamsSchema,
    tags: ['issues']
  })
  async issuesLock(
    params: github.IssuesLockParams
  ): Promise<github.IssuesLockResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/lock`,
        {
          json: pick(params, 'lock_reason')
        }
      )
      .json<github.IssuesLockResponse>()
  }

  /**
   * Users with push access can unlock an issue's conversation.
   */
  @aiFunction({
    name: 'github_issues_unlock',
    description: `Users with push access can unlock an issue's conversation.`,
    inputSchema: github.IssuesUnlockParamsSchema,
    tags: ['issues']
  })
  async issuesUnlock(
    params: github.IssuesUnlockParams
  ): Promise<github.IssuesUnlockResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/lock`,
        {}
      )
      .json<github.IssuesUnlockResponse>()
  }

  /**
   * List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
   */
  @aiFunction({
    name: 'github_reactions_list_for_issue',
    description: `List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).`,
    inputSchema: github.ReactionsListForIssueParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForIssue(
    params: github.ReactionsListForIssueParams
  ): Promise<github.ReactionsListForIssueResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForIssueResponse>()
  }

  /**
   * Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.
   */
  @aiFunction({
    name: 'github_reactions_create_for_issue',
    description: `Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP \`200\` status means that you already added the reaction type to this issue.`,
    inputSchema: github.ReactionsCreateForIssueParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForIssue(
    params: github.ReactionsCreateForIssueParams
  ): Promise<github.ReactionsCreateForIssueResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForIssueResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.

Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
 */
  @aiFunction({
    name: 'github_reactions_delete_for_issue',
    description: `> [!NOTE]
> You can also specify a repository by \`repository_id\` using the route \`DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id\`.

Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).`,
    inputSchema: github.ReactionsDeleteForIssueParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForIssue(
    params: github.ReactionsDeleteForIssueParams
  ): Promise<github.ReactionsDeleteForIssueResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForIssueResponse>()
  }

  /**
 * You can use the REST API to remove a sub-issue from an issue.
Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_remove_sub_issue',
    description: `You can use the REST API to remove a sub-issue from an issue.
Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass a specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesRemoveSubIssueParamsSchema,
    tags: ['issues']
  })
  async issuesRemoveSubIssue(
    params: github.IssuesRemoveSubIssueParams
  ): Promise<github.IssuesRemoveSubIssueResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/sub_issue`,
        {
          json: pick(params, 'sub_issue_id')
        }
      )
      .json<github.IssuesRemoveSubIssueResponse>()
  }

  /**
 * You can use the REST API to list the sub-issues on an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_sub_issues',
    description: `You can use the REST API to list the sub-issues on an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListSubIssuesParamsSchema,
    tags: ['issues']
  })
  async issuesListSubIssues(
    params: github.IssuesListSubIssuesParams
  ): Promise<github.IssuesListSubIssuesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/sub_issues`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.IssuesListSubIssuesResponse>()
  }

  /**
 * You can use the REST API to add sub-issues to issues.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_add_sub_issue',
    description: `You can use the REST API to add sub-issues to issues.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesAddSubIssueParamsSchema,
    tags: ['issues']
  })
  async issuesAddSubIssue(
    params: github.IssuesAddSubIssueParams
  ): Promise<github.IssuesAddSubIssueResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/sub_issues`,
        {
          json: pick(params, 'sub_issue_id', 'replace_parent')
        }
      )
      .json<github.IssuesAddSubIssueResponse>()
  }

  /**
   * You can use the REST API to reprioritize a sub-issue to a different position in the parent list.
   */
  @aiFunction({
    name: 'github_issues_reprioritize_sub_issue',
    description: `You can use the REST API to reprioritize a sub-issue to a different position in the parent list.`,
    inputSchema: github.IssuesReprioritizeSubIssueParamsSchema,
    tags: ['issues']
  })
  async issuesReprioritizeSubIssue(
    params: github.IssuesReprioritizeSubIssueParams
  ): Promise<github.IssuesReprioritizeSubIssueResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/sub_issues/priority`,
        {
          json: pick(params, 'sub_issue_id', 'after_id', 'before_id')
        }
      )
      .json<github.IssuesReprioritizeSubIssueResponse>()
  }

  /**
   * List all timeline events for an issue.
   */
  @aiFunction({
    name: 'github_issues_list_events_for_timeline',
    description: `List all timeline events for an issue.`,
    inputSchema: github.IssuesListEventsForTimelineParamsSchema,
    tags: ['issues']
  })
  async issuesListEventsForTimeline(
    params: github.IssuesListEventsForTimelineParams
  ): Promise<github.IssuesListEventsForTimelineResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/issues/${params.issue_number}/timeline`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.IssuesListEventsForTimelineResponse>()
  }

  /**
   * List deploy keys.
   */
  @aiFunction({
    name: 'github_repos_list_deploy_keys',
    description: `List deploy keys.`,
    inputSchema: github.ReposListDeployKeysParamsSchema,
    tags: ['repos']
  })
  async reposListDeployKeys(
    params: github.ReposListDeployKeysParams
  ): Promise<github.ReposListDeployKeysResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/keys`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListDeployKeysResponse>()
  }

  /**
   * You can create a read-only deploy key.
   */
  @aiFunction({
    name: 'github_repos_create_deploy_key',
    description: `You can create a read-only deploy key.`,
    inputSchema: github.ReposCreateDeployKeyParamsSchema,
    tags: ['repos']
  })
  async reposCreateDeployKey(
    params: github.ReposCreateDeployKeyParams
  ): Promise<github.ReposCreateDeployKeyResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/keys`, {
        json: pick(params, 'title', 'key', 'read_only')
      })
      .json<github.ReposCreateDeployKeyResponse>()
  }

  /**
   * Get a deploy key.
   */
  @aiFunction({
    name: 'github_repos_get_deploy_key',
    description: `Get a deploy key.`,
    inputSchema: github.ReposGetDeployKeyParamsSchema,
    tags: ['repos']
  })
  async reposGetDeployKey(
    params: github.ReposGetDeployKeyParams
  ): Promise<github.ReposGetDeployKeyResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/keys/${params.key_id}`,
        {}
      )
      .json<github.ReposGetDeployKeyResponse>()
  }

  /**
   * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
   */
  @aiFunction({
    name: 'github_repos_delete_deploy_key',
    description: `Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.`,
    inputSchema: github.ReposDeleteDeployKeyParamsSchema,
    tags: ['repos']
  })
  async reposDeleteDeployKey(
    params: github.ReposDeleteDeployKeyParams
  ): Promise<github.ReposDeleteDeployKeyResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/keys/${params.key_id}`,
        {}
      )
      .json<github.ReposDeleteDeployKeyResponse>()
  }

  /**
   * Lists all labels for a repository.
   */
  @aiFunction({
    name: 'github_issues_list_labels_for_repo',
    description: `Lists all labels for a repository.`,
    inputSchema: github.IssuesListLabelsForRepoParamsSchema,
    tags: ['issues']
  })
  async issuesListLabelsForRepo(
    params: github.IssuesListLabelsForRepoParams
  ): Promise<github.IssuesListLabelsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/labels`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.IssuesListLabelsForRepoResponse>()
  }

  /**
   * Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).
   */
  @aiFunction({
    name: 'github_issues_create_label',
    description: `Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).`,
    inputSchema: github.IssuesCreateLabelParamsSchema,
    tags: ['issues']
  })
  async issuesCreateLabel(
    params: github.IssuesCreateLabelParams
  ): Promise<github.IssuesCreateLabelResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/labels`, {
        json: pick(params, 'name', 'color', 'description')
      })
      .json<github.IssuesCreateLabelResponse>()
  }

  /**
   * Gets a label using the given name.
   */
  @aiFunction({
    name: 'github_issues_get_label',
    description: `Gets a label using the given name.`,
    inputSchema: github.IssuesGetLabelParamsSchema,
    tags: ['issues']
  })
  async issuesGetLabel(
    params: github.IssuesGetLabelParams
  ): Promise<github.IssuesGetLabelResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/labels/${params.name}`,
        {}
      )
      .json<github.IssuesGetLabelResponse>()
  }

  /**
   * Deletes a label using the given label name.
   */
  @aiFunction({
    name: 'github_issues_delete_label',
    description: `Deletes a label using the given label name.`,
    inputSchema: github.IssuesDeleteLabelParamsSchema,
    tags: ['issues']
  })
  async issuesDeleteLabel(
    params: github.IssuesDeleteLabelParams
  ): Promise<github.IssuesDeleteLabelResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/labels/${params.name}`,
        {}
      )
      .json<github.IssuesDeleteLabelResponse>()
  }

  /**
   * Updates a label using the given label name.
   */
  @aiFunction({
    name: 'github_issues_update_label',
    description: `Updates a label using the given label name.`,
    inputSchema: github.IssuesUpdateLabelParamsSchema,
    tags: ['issues']
  })
  async issuesUpdateLabel(
    params: github.IssuesUpdateLabelParams
  ): Promise<github.IssuesUpdateLabelResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/labels/${params.name}`,
        {
          json: pick(params, 'new_name', 'color', 'description')
        }
      )
      .json<github.IssuesUpdateLabelResponse>()
  }

  /**
   * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
   */
  @aiFunction({
    name: 'github_repos_list_languages',
    description: `Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.`,
    inputSchema: github.ReposListLanguagesParamsSchema,
    tags: ['repos']
  })
  async reposListLanguages(
    params: github.ReposListLanguagesParams
  ): Promise<github.ReposListLanguagesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/languages`, {})
      .json<github.ReposListLanguagesResponse>()
  }

  /**
 * This method returns the contents of the repository's license file, if one is detected.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
 */
  @aiFunction({
    name: 'github_licenses_get_for_repo',
    description: `This method returns the contents of the repository's license file, if one is detected.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw contents of the license.
- **\`application/vnd.github.html+json\`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).`,
    inputSchema: github.LicensesGetForRepoParamsSchema,
    tags: ['licenses']
  })
  async licensesGetForRepo(
    params: github.LicensesGetForRepoParams
  ): Promise<github.LicensesGetForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/license`, {
        searchParams: sanitizeSearchParams(pick(params, 'ref'))
      })
      .json<github.LicensesGetForRepoResponse>()
  }

  /**
   * Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
   */
  @aiFunction({
    name: 'github_repos_merge_upstream',
    description: `Sync a branch of a forked repository to keep it up-to-date with the upstream repository.`,
    inputSchema: github.ReposMergeUpstreamParamsSchema,
    tags: ['repos']
  })
  async reposMergeUpstream(
    params: github.ReposMergeUpstreamParams
  ): Promise<github.ReposMergeUpstreamResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/merge-upstream`, {
        json: pick(params, 'branch')
      })
      .json<github.ReposMergeUpstreamResponse>()
  }

  /**
   * Merge a branch.
   */
  @aiFunction({
    name: 'github_repos_merge',
    description: `Merge a branch.`,
    inputSchema: github.ReposMergeParamsSchema,
    tags: ['repos']
  })
  async reposMerge(
    params: github.ReposMergeParams
  ): Promise<github.ReposMergeResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/merges`, {
        json: pick(params, 'base', 'head', 'commit_message')
      })
      .json<github.ReposMergeResponse>()
  }

  /**
   * Lists milestones for a repository.
   */
  @aiFunction({
    name: 'github_issues_list_milestones',
    description: `Lists milestones for a repository.`,
    inputSchema: github.IssuesListMilestonesParamsSchema,
    tags: ['issues']
  })
  async issuesListMilestones(
    params: github.IssuesListMilestonesParams
  ): Promise<github.IssuesListMilestonesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/milestones`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'state', 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.IssuesListMilestonesResponse>()
  }

  /**
   * Creates a milestone.
   */
  @aiFunction({
    name: 'github_issues_create_milestone',
    description: `Creates a milestone.`,
    inputSchema: github.IssuesCreateMilestoneParamsSchema,
    tags: ['issues']
  })
  async issuesCreateMilestone(
    params: github.IssuesCreateMilestoneParams
  ): Promise<github.IssuesCreateMilestoneResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/milestones`, {
        json: pick(params, 'title', 'state', 'description', 'due_on')
      })
      .json<github.IssuesCreateMilestoneResponse>()
  }

  /**
   * Gets a milestone using the given milestone number.
   */
  @aiFunction({
    name: 'github_issues_get_milestone',
    description: `Gets a milestone using the given milestone number.`,
    inputSchema: github.IssuesGetMilestoneParamsSchema,
    tags: ['issues']
  })
  async issuesGetMilestone(
    params: github.IssuesGetMilestoneParams
  ): Promise<github.IssuesGetMilestoneResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/milestones/${params.milestone_number}`,
        {}
      )
      .json<github.IssuesGetMilestoneResponse>()
  }

  /**
   * Deletes a milestone using the given milestone number.
   */
  @aiFunction({
    name: 'github_issues_delete_milestone',
    description: `Deletes a milestone using the given milestone number.`,
    inputSchema: github.IssuesDeleteMilestoneParamsSchema,
    tags: ['issues']
  })
  async issuesDeleteMilestone(
    params: github.IssuesDeleteMilestoneParams
  ): Promise<github.IssuesDeleteMilestoneResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/milestones/${params.milestone_number}`,
        {}
      )
      .json<github.IssuesDeleteMilestoneResponse>()
  }

  /**
   * Update a milestone.
   */
  @aiFunction({
    name: 'github_issues_update_milestone',
    description: `Update a milestone.`,
    inputSchema: github.IssuesUpdateMilestoneParamsSchema,
    tags: ['issues']
  })
  async issuesUpdateMilestone(
    params: github.IssuesUpdateMilestoneParams
  ): Promise<github.IssuesUpdateMilestoneResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/milestones/${params.milestone_number}`,
        {
          json: pick(params, 'title', 'state', 'description', 'due_on')
        }
      )
      .json<github.IssuesUpdateMilestoneResponse>()
  }

  /**
   * Lists labels for issues in a milestone.
   */
  @aiFunction({
    name: 'github_issues_list_labels_for_milestone',
    description: `Lists labels for issues in a milestone.`,
    inputSchema: github.IssuesListLabelsForMilestoneParamsSchema,
    tags: ['issues']
  })
  async issuesListLabelsForMilestone(
    params: github.IssuesListLabelsForMilestoneParams
  ): Promise<github.IssuesListLabelsForMilestoneResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/milestones/${params.milestone_number}/labels`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.IssuesListLabelsForMilestoneResponse>()
  }

  /**
   * Lists all notifications for the current user in the specified repository.
   */
  @aiFunction({
    name: 'github_activity_list_repo_notifications_for_authenticated_user',
    description: `Lists all notifications for the current user in the specified repository.`,
    inputSchema:
      github.ActivityListRepoNotificationsForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListRepoNotificationsForAuthenticatedUser(
    params: github.ActivityListRepoNotificationsForAuthenticatedUserParams
  ): Promise<github.ActivityListRepoNotificationsForAuthenticatedUserResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/notifications`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'all',
            'participating',
            'since',
            'before',
            'per_page',
            'page'
          )
        )
      })
      .json<github.ActivityListRepoNotificationsForAuthenticatedUserResponse>()
  }

  /**
   * Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
   */
  @aiFunction({
    name: 'github_activity_mark_repo_notifications_as_read',
    description: `Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a \`202 Accepted\` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter \`all=false\`.`,
    inputSchema: github.ActivityMarkRepoNotificationsAsReadParamsSchema,
    tags: ['activity']
  })
  async activityMarkRepoNotificationsAsRead(
    params: github.ActivityMarkRepoNotificationsAsReadParams
  ): Promise<github.ActivityMarkRepoNotificationsAsReadResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/notifications`, {
        json: pick(params, 'last_read_at')
      })
      .json<github.ActivityMarkRepoNotificationsAsReadResponse>()
  }

  /**
 * Gets information about a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_pages',
    description: `Gets information about a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposGetPagesParamsSchema,
    tags: ['repos']
  })
  async reposGetPages(
    params: github.ReposGetPagesParams
  ): Promise<github.ReposGetPagesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/pages`, {})
      .json<github.ReposGetPagesResponse>()
  }

  /**
 * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_pages_site',
    description: `Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposCreatePagesSiteParamsSchema as any,
    tags: ['repos']
  })
  async reposCreatePagesSite(
    params: github.ReposCreatePagesSiteParams
  ): Promise<github.ReposCreatePagesSiteResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/pages`, {
        json: params
      })
      .json<github.ReposCreatePagesSiteResponse>()
  }

  /**
 * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_update_information_about_pages_site',
    description: `Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.ReposUpdateInformationAboutPagesSiteParamsSchema as any,
    tags: ['repos']
  })
  async reposUpdateInformationAboutPagesSite(
    params: github.ReposUpdateInformationAboutPagesSiteParams
  ): Promise<github.ReposUpdateInformationAboutPagesSiteResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/pages`, {
        json: params
      })
      .json<github.ReposUpdateInformationAboutPagesSiteResponse>()
  }

  /**
 * Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_delete_pages_site',
    description: `Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposDeletePagesSiteParamsSchema,
    tags: ['repos']
  })
  async reposDeletePagesSite(
    params: github.ReposDeletePagesSiteParams
  ): Promise<github.ReposDeletePagesSiteResponse> {
    return this.ky
      .delete(`/repos/${params.owner}/${params.repo}/pages`, {})
      .json<github.ReposDeletePagesSiteResponse>()
  }

  /**
 * Lists builts of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_list_pages_builds',
    description: `Lists builts of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposListPagesBuildsParamsSchema,
    tags: ['repos']
  })
  async reposListPagesBuilds(
    params: github.ReposListPagesBuildsParams
  ): Promise<github.ReposListPagesBuildsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/pages/builds`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListPagesBuildsResponse>()
  }

  /**
 * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
 */
  @aiFunction({
    name: 'github_repos_request_pages_build',
    description: `You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.`,
    inputSchema: github.ReposRequestPagesBuildParamsSchema,
    tags: ['repos']
  })
  async reposRequestPagesBuild(
    params: github.ReposRequestPagesBuildParams
  ): Promise<github.ReposRequestPagesBuildResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/pages/builds`, {})
      .json<github.ReposRequestPagesBuildResponse>()
  }

  /**
 * Gets information about the single most recent build of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_latest_pages_build',
    description: `Gets information about the single most recent build of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposGetLatestPagesBuildParamsSchema,
    tags: ['repos']
  })
  async reposGetLatestPagesBuild(
    params: github.ReposGetLatestPagesBuildParams
  ): Promise<github.ReposGetLatestPagesBuildResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pages/builds/latest`,
        {}
      )
      .json<github.ReposGetLatestPagesBuildResponse>()
  }

  /**
 * Gets information about a GitHub Pages build.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_pages_build',
    description: `Gets information about a GitHub Pages build.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposGetPagesBuildParamsSchema,
    tags: ['repos']
  })
  async reposGetPagesBuild(
    params: github.ReposGetPagesBuildParams
  ): Promise<github.ReposGetPagesBuildResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pages/builds/${params.build_id}`,
        {}
      )
      .json<github.ReposGetPagesBuildResponse>()
  }

  /**
 * Create a GitHub Pages deployment for a repository.

The authenticated user must have write permission to the repository.
 */
  @aiFunction({
    name: 'github_repos_create_pages_deployment',
    description: `Create a GitHub Pages deployment for a repository.

The authenticated user must have write permission to the repository.`,
    inputSchema: github.ReposCreatePagesDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposCreatePagesDeployment(
    params: github.ReposCreatePagesDeploymentParams
  ): Promise<github.ReposCreatePagesDeploymentResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/pages/deployments`, {
        json: pick(
          params,
          'artifact_id',
          'artifact_url',
          'environment',
          'pages_build_version',
          'oidc_token'
        )
      })
      .json<github.ReposCreatePagesDeploymentResponse>()
  }

  /**
 * Gets the current status of a GitHub Pages deployment.

The authenticated user must have read permission for the GitHub Pages site.
 */
  @aiFunction({
    name: 'github_repos_get_pages_deployment',
    description: `Gets the current status of a GitHub Pages deployment.

The authenticated user must have read permission for the GitHub Pages site.`,
    inputSchema: github.ReposGetPagesDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposGetPagesDeployment(
    params: github.ReposGetPagesDeploymentParams
  ): Promise<github.ReposGetPagesDeploymentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pages/deployments/${params.pages_deployment_id}`,
        {}
      )
      .json<github.ReposGetPagesDeploymentResponse>()
  }

  /**
 * Cancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site.
 */
  @aiFunction({
    name: 'github_repos_cancel_pages_deployment',
    description: `Cancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site.`,
    inputSchema: github.ReposCancelPagesDeploymentParamsSchema,
    tags: ['repos']
  })
  async reposCancelPagesDeployment(
    params: github.ReposCancelPagesDeploymentParams
  ): Promise<github.ReposCancelPagesDeploymentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pages/deployments/${params.pages_deployment_id}/cancel`,
        {}
      )
      .json<github.ReposCancelPagesDeploymentResponse>()
  }

  /**
 * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.

The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_pages_health_check',
    description: `Gets a health check of the DNS settings for the \`CNAME\` record configured for a repository's GitHub Pages.

The first request to this endpoint returns a \`202 Accepted\` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a \`200 OK\` status with the health check results in the response.

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.ReposGetPagesHealthCheckParamsSchema,
    tags: ['repos']
  })
  async reposGetPagesHealthCheck(
    params: github.ReposGetPagesHealthCheckParams
  ): Promise<github.ReposGetPagesHealthCheckResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/pages/health`, {})
      .json<github.ReposGetPagesHealthCheckResponse>()
  }

  /**
   * Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
   */
  @aiFunction({
    name: 'github_repos_check_private_vulnerability_reporting',
    description: `Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".`,
    inputSchema: github.ReposCheckPrivateVulnerabilityReportingParamsSchema,
    tags: ['repos']
  })
  async reposCheckPrivateVulnerabilityReporting(
    params: github.ReposCheckPrivateVulnerabilityReportingParams
  ): Promise<github.ReposCheckPrivateVulnerabilityReportingResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/private-vulnerability-reporting`,
        {}
      )
      .json<github.ReposCheckPrivateVulnerabilityReportingResponse>()
  }

  /**
   * Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).".
   */
  @aiFunction({
    name: 'github_repos_enable_private_vulnerability_reporting',
    description: `Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).".`,
    inputSchema: github.ReposEnablePrivateVulnerabilityReportingParamsSchema,
    tags: ['repos']
  })
  async reposEnablePrivateVulnerabilityReporting(
    params: github.ReposEnablePrivateVulnerabilityReportingParams
  ): Promise<github.ReposEnablePrivateVulnerabilityReportingResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/private-vulnerability-reporting`,
        {}
      )
      .json<github.ReposEnablePrivateVulnerabilityReportingResponse>()
  }

  /**
   * Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)".
   */
  @aiFunction({
    name: 'github_repos_disable_private_vulnerability_reporting',
    description: `Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)".`,
    inputSchema: github.ReposDisablePrivateVulnerabilityReportingParamsSchema,
    tags: ['repos']
  })
  async reposDisablePrivateVulnerabilityReporting(
    params: github.ReposDisablePrivateVulnerabilityReportingParams
  ): Promise<github.ReposDisablePrivateVulnerabilityReportingResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/private-vulnerability-reporting`,
        {}
      )
      .json<github.ReposDisablePrivateVulnerabilityReportingResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_for_repo',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListForRepoParamsSchema,
    tags: ['projects']
  })
  async projectsListForRepo(
    params: github.ProjectsListForRepoParams
  ): Promise<github.ProjectsListForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/projects`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'state', 'per_page', 'page')
        )
      })
      .json<github.ProjectsListForRepoResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_create_for_repo',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsCreateForRepoParamsSchema,
    tags: ['projects']
  })
  async projectsCreateForRepo(
    params: github.ProjectsCreateForRepoParams
  ): Promise<github.ProjectsCreateForRepoResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/projects`, {
        json: pick(params, 'name', 'body')
      })
      .json<github.ProjectsCreateForRepoResponse>()
  }

  /**
 * Gets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_get_custom_properties_values',
    description: `Gets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint.`,
    inputSchema: github.ReposGetCustomPropertiesValuesParamsSchema,
    tags: ['repos']
  })
  async reposGetCustomPropertiesValues(
    params: github.ReposGetCustomPropertiesValuesParams
  ): Promise<github.ReposGetCustomPropertiesValuesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/properties/values`, {})
      .json<github.ReposGetCustomPropertiesValuesResponse>()
  }

  /**
 * Create new or update existing custom property values for a repository.
Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
 */
  @aiFunction({
    name: 'github_repos_create_or_update_custom_properties_values',
    description: `Create new or update existing custom property values for a repository.
Using a value of \`null\` for a custom property will remove or 'unset' the property value from the repository.

Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.`,
    inputSchema: github.ReposCreateOrUpdateCustomPropertiesValuesParamsSchema,
    tags: ['repos']
  })
  async reposCreateOrUpdateCustomPropertiesValues(
    params: github.ReposCreateOrUpdateCustomPropertiesValuesParams
  ): Promise<github.ReposCreateOrUpdateCustomPropertiesValuesResponse> {
    return this.ky
      .patch(`/repos/${params.owner}/${params.repo}/properties/values`, {
        json: pick(params, 'properties')
      })
      .json<github.ReposCreateOrUpdateCustomPropertiesValuesResponse>()
  }

  /**
 * Lists pull requests in a specified repository.

Draft pull requests are available in public repositories with GitHub
Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
plans, and in public and private repositories with GitHub Team and GitHub Enterprise
Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
in the GitHub Help documentation.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list',
    description: `Lists pull requests in a specified repository.

Draft pull requests are available in public repositories with GitHub
Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
plans, and in public and private repositories with GitHub Team and GitHub Enterprise
Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
in the GitHub Help documentation.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListParamsSchema,
    tags: ['pulls']
  })
  async pullsList(
    params: github.PullsListParams
  ): Promise<github.PullsListResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/pulls`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'state',
            'head',
            'base',
            'sort',
            'direction',
            'per_page',
            'page'
          )
        )
      })
      .json<github.PullsListResponse>()
  }

  /**
 * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_create',
    description: `Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsCreateParamsSchema,
    tags: ['pulls']
  })
  async pullsCreate(
    params: github.PullsCreateParams
  ): Promise<github.PullsCreateResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/pulls`, {
        json: pick(
          params,
          'title',
          'head',
          'head_repo',
          'base',
          'body',
          'maintainer_can_modify',
          'draft',
          'issue'
        )
      })
      .json<github.PullsCreateResponse>()
  }

  /**
 * Lists review comments for all pull requests in a repository. By default,
review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_review_comments_for_repo',
    description: `Lists review comments for all pull requests in a repository. By default,
review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListReviewCommentsForRepoParamsSchema,
    tags: ['pulls']
  })
  async pullsListReviewCommentsForRepo(
    params: github.PullsListReviewCommentsForRepoParams
  ): Promise<github.PullsListReviewCommentsForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/pulls/comments`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'since', 'per_page', 'page')
        )
      })
      .json<github.PullsListReviewCommentsForRepoResponse>()
  }

  /**
 * Provides details for a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_get_review_comment',
    description: `Provides details for a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsGetReviewCommentParamsSchema,
    tags: ['pulls']
  })
  async pullsGetReviewComment(
    params: github.PullsGetReviewCommentParams
  ): Promise<github.PullsGetReviewCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}`,
        {}
      )
      .json<github.PullsGetReviewCommentResponse>()
  }

  /**
   * Deletes a review comment.
   */
  @aiFunction({
    name: 'github_pulls_delete_review_comment',
    description: `Deletes a review comment.`,
    inputSchema: github.PullsDeleteReviewCommentParamsSchema,
    tags: ['pulls']
  })
  async pullsDeleteReviewComment(
    params: github.PullsDeleteReviewCommentParams
  ): Promise<github.PullsDeleteReviewCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}`,
        {}
      )
      .json<github.PullsDeleteReviewCommentResponse>()
  }

  /**
 * Edits the content of a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_update_review_comment',
    description: `Edits the content of a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsUpdateReviewCommentParamsSchema,
    tags: ['pulls']
  })
  async pullsUpdateReviewComment(
    params: github.PullsUpdateReviewCommentParams
  ): Promise<github.PullsUpdateReviewCommentResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.PullsUpdateReviewCommentResponse>()
  }

  /**
   * List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
   */
  @aiFunction({
    name: 'github_reactions_list_for_pull_request_review_comment',
    description: `List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).`,
    inputSchema: github.ReactionsListForPullRequestReviewCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForPullRequestReviewComment(
    params: github.ReactionsListForPullRequestReviewCommentParams
  ): Promise<github.ReactionsListForPullRequestReviewCommentResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForPullRequestReviewCommentResponse>()
  }

  /**
   * Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.
   */
  @aiFunction({
    name: 'github_reactions_create_for_pull_request_review_comment',
    description: `Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP \`200\` status means that you already added the reaction type to this pull request review comment.`,
    inputSchema: github.ReactionsCreateForPullRequestReviewCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForPullRequestReviewComment(
    params: github.ReactionsCreateForPullRequestReviewCommentParams
  ): Promise<github.ReactionsCreateForPullRequestReviewCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForPullRequestReviewCommentResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`

Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
 */
  @aiFunction({
    name: 'github_reactions_delete_for_pull_request_comment',
    description: `> [!NOTE]
> You can also specify a repository by \`repository_id\` using the route \`DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.\`

Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).`,
    inputSchema: github.ReactionsDeleteForPullRequestCommentParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForPullRequestComment(
    params: github.ReactionsDeleteForPullRequestCommentParams
  ): Promise<github.ReactionsDeleteForPullRequestCommentResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/pulls/comments/${params.comment_id}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForPullRequestCommentResponse>()
  }

  /**
 * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.

The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:

*   If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
*   If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
*   If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.

Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
 */
  @aiFunction({
    name: 'github_pulls_get',
    description: `Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the \`mergeable\` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

The value of the \`mergeable\` attribute can be \`true\`, \`false\`, or \`null\`. If the value is \`null\`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-\`null\` value for the \`mergeable\` attribute in the response. If \`mergeable\` is \`true\`, then \`merge_commit_sha\` will be the SHA of the _test_ merge commit.

The value of the \`merge_commit_sha\` attribute changes depending on the state of the pull request. Before merging a pull request, the \`merge_commit_sha\` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the \`merge_commit_sha\` attribute changes depending on how you merged the pull request:

*   If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), \`merge_commit_sha\` represents the SHA of the merge commit.
*   If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), \`merge_commit_sha\` represents the SHA of the squashed commit on the base branch.
*   If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), \`merge_commit_sha\` represents the commit that the base branch was updated to.

Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.
- **\`application/vnd.github.diff\`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.`,
    inputSchema: github.PullsGetParamsSchema,
    tags: ['pulls']
  })
  async pullsGet(
    params: github.PullsGetParams
  ): Promise<github.PullsGetResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}`,
        {}
      )
      .json<github.PullsGetResponse>()
  }

  /**
 * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_update',
    description: `Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsUpdateParamsSchema,
    tags: ['pulls']
  })
  async pullsUpdate(
    params: github.PullsUpdateParams
  ): Promise<github.PullsUpdateResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}`,
        {
          json: pick(
            params,
            'title',
            'body',
            'state',
            'base',
            'maintainer_can_modify'
          )
        }
      )
      .json<github.PullsUpdateResponse>()
  }

  /**
 * Creates a codespace owned by the authenticated user for the specified pull request.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_create_with_pr_for_authenticated_user',
    description: `Creates a codespace owned by the authenticated user for the specified pull request.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesCreateWithPrForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCreateWithPrForAuthenticatedUser(
    params: github.CodespacesCreateWithPrForAuthenticatedUserParams
  ): Promise<github.CodespacesCreateWithPrForAuthenticatedUserResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/codespaces`,
        {
          json: pick(
            params,
            'location',
            'geo',
            'client_ip',
            'machine',
            'devcontainer_path',
            'multi_repo_permissions_opt_out',
            'working_directory',
            'idle_timeout_minutes',
            'display_name',
            'retention_period_minutes'
          )
        }
      )
      .json<github.CodespacesCreateWithPrForAuthenticatedUserResponse>()
  }

  /**
 * Lists all review comments for a specified pull request. By default, review comments
are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_review_comments',
    description: `Lists all review comments for a specified pull request. By default, review comments
are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListReviewCommentsParamsSchema,
    tags: ['pulls']
  })
  async pullsListReviewComments(
    params: github.PullsListReviewCommentsParams
  ): Promise<github.PullsListReviewCommentsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/comments`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'sort', 'direction', 'since', 'per_page', 'page')
          )
        }
      )
      .json<github.PullsListReviewCommentsResponse>()
  }

  /**
 * Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."

If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.

The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_create_review_comment',
    description: `Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."

If your comment applies to more than one line in the pull request diff, you should use the parameters \`line\`, \`side\`, and optionally \`start_line\` and \`start_side\` in your request.

The \`position\` parameter is closing down. If you use \`position\`, the \`line\`, \`side\`, \`start_line\`, and \`start_side\` parameters are not required.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsCreateReviewCommentParamsSchema,
    tags: ['pulls']
  })
  async pullsCreateReviewComment(
    params: github.PullsCreateReviewCommentParams
  ): Promise<github.PullsCreateReviewCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/comments`,
        {
          json: pick(
            params,
            'body',
            'commit_id',
            'path',
            'position',
            'side',
            'line',
            'start_line',
            'start_side',
            'in_reply_to',
            'subject_type'
          )
        }
      )
      .json<github.PullsCreateReviewCommentResponse>()
  }

  /**
 * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_create_reply_for_review_comment',
    description: `Creates a reply to a review comment for a pull request. For the \`comment_id\`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsCreateReplyForReviewCommentParamsSchema,
    tags: ['pulls']
  })
  async pullsCreateReplyForReviewComment(
    params: github.PullsCreateReplyForReviewCommentParams
  ): Promise<github.PullsCreateReplyForReviewCommentResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/comments/${params.comment_id}/replies`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.PullsCreateReplyForReviewCommentResponse>()
  }

  /**
 * Lists a maximum of 250 commits for a pull request. To receive a complete
commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_commits',
    description: `Lists a maximum of 250 commits for a pull request. To receive a complete
commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListCommitsParamsSchema,
    tags: ['pulls']
  })
  async pullsListCommits(
    params: github.PullsListCommitsParams
  ): Promise<github.PullsListCommitsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/commits`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.PullsListCommitsResponse>()
  }

  /**
 * Lists the files in a specified pull request.

> [!NOTE]
> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_files',
    description: `Lists the files in a specified pull request.

> [!NOTE]
> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListFilesParamsSchema,
    tags: ['pulls']
  })
  async pullsListFiles(
    params: github.PullsListFilesParams
  ): Promise<github.PullsListFilesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/files`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.PullsListFilesResponse>()
  }

  /**
   * Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
   */
  @aiFunction({
    name: 'github_pulls_check_if_merged',
    description: `Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.`,
    inputSchema: github.PullsCheckIfMergedParamsSchema,
    tags: ['pulls']
  })
  async pullsCheckIfMerged(
    params: github.PullsCheckIfMergedParams
  ): Promise<github.PullsCheckIfMergedResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/merge`,
        {}
      )
      .json<github.PullsCheckIfMergedResponse>()
  }

  /**
 * Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".
 */
  @aiFunction({
    name: 'github_pulls_merge',
    description: `Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".`,
    inputSchema: github.PullsMergeParamsSchema,
    tags: ['pulls']
  })
  async pullsMerge(
    params: github.PullsMergeParams
  ): Promise<github.PullsMergeResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/merge`,
        {
          json: pick(
            params,
            'commit_title',
            'commit_message',
            'sha',
            'merge_method'
          )
        }
      )
      .json<github.PullsMergeResponse>()
  }

  /**
   * Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.
   */
  @aiFunction({
    name: 'github_pulls_list_requested_reviewers',
    description: `Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.`,
    inputSchema: github.PullsListRequestedReviewersParamsSchema,
    tags: ['pulls']
  })
  async pullsListRequestedReviewers(
    params: github.PullsListRequestedReviewersParams
  ): Promise<github.PullsListRequestedReviewersResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/requested_reviewers`,
        {}
      )
      .json<github.PullsListRequestedReviewersResponse>()
  }

  /**
 * Requests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".
 */
  @aiFunction({
    name: 'github_pulls_request_reviewers',
    description: `Requests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".`,
    // TODO: Improve handling of union params
    inputSchema: github.PullsRequestReviewersParamsSchema as any,
    tags: ['pulls']
  })
  async pullsRequestReviewers(
    params: github.PullsRequestReviewersParams
  ): Promise<github.PullsRequestReviewersResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/requested_reviewers`,
        {
          json: params
        }
      )
      .json<github.PullsRequestReviewersResponse>()
  }

  /**
   * Removes review requests from a pull request for a given set of users and/or teams.
   */
  @aiFunction({
    name: 'github_pulls_remove_requested_reviewers',
    description: `Removes review requests from a pull request for a given set of users and/or teams.`,
    inputSchema: github.PullsRemoveRequestedReviewersParamsSchema,
    tags: ['pulls']
  })
  async pullsRemoveRequestedReviewers(
    params: github.PullsRemoveRequestedReviewersParams
  ): Promise<github.PullsRemoveRequestedReviewersResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/requested_reviewers`,
        {
          json: pick(params, 'reviewers', 'team_reviewers')
        }
      )
      .json<github.PullsRemoveRequestedReviewersResponse>()
  }

  /**
 * Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_reviews',
    description: `Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListReviewsParamsSchema,
    tags: ['pulls']
  })
  async pullsListReviews(
    params: github.PullsListReviewsParams
  ): Promise<github.PullsListReviewsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.PullsListReviewsResponse>()
  }

  /**
 * Creates a review on a specified pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."

> [!NOTE]
> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.

The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_create_review',
    description: `Creates a review on a specified pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Pull request reviews created in the \`PENDING\` state are not submitted and therefore do not include the \`submitted_at\` property in the response. To create a pending review for a pull request, leave the \`event\` parameter blank. For more information about submitting a \`PENDING\` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."

> [!NOTE]
> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the \`application/vnd.github.v3.diff\` media type to the \`Accept\` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.

The \`position\` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsCreateReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsCreateReview(
    params: github.PullsCreateReviewParams
  ): Promise<github.PullsCreateReviewResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews`,
        {
          json: pick(params, 'commit_id', 'body', 'event', 'comments')
        }
      )
      .json<github.PullsCreateReviewResponse>()
  }

  /**
 * Retrieves a pull request review by its ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_get_review',
    description: `Retrieves a pull request review by its ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsGetReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsGetReview(
    params: github.PullsGetReviewParams
  ): Promise<github.PullsGetReviewResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}`,
        {}
      )
      .json<github.PullsGetReviewResponse>()
  }

  /**
 * Updates the contents of a specified review summary comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_update_review',
    description: `Updates the contents of a specified review summary comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsUpdateReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsUpdateReview(
    params: github.PullsUpdateReviewParams
  ): Promise<github.PullsUpdateReviewResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.PullsUpdateReviewResponse>()
  }

  /**
 * Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_delete_pending_review',
    description: `Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsDeletePendingReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsDeletePendingReview(
    params: github.PullsDeletePendingReviewParams
  ): Promise<github.PullsDeletePendingReviewResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}`,
        {}
      )
      .json<github.PullsDeletePendingReviewResponse>()
  }

  /**
 * Lists comments for a specific pull request review.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_list_comments_for_review',
    description: `Lists comments for a specific pull request review.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsListCommentsForReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsListCommentsForReview(
    params: github.PullsListCommentsForReviewParams
  ): Promise<github.PullsListCommentsForReviewResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}/comments`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.PullsListCommentsForReviewResponse>()
  }

  /**
 * Dismisses a specified review on a pull request.

> [!NOTE]
> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_dismiss_review',
    description: `Dismisses a specified review on a pull request.

> [!NOTE]
> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsDismissReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsDismissReview(
    params: github.PullsDismissReviewParams
  ): Promise<github.PullsDismissReviewResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}/dismissals`,
        {
          json: pick(params, 'message', 'event')
        }
      )
      .json<github.PullsDismissReviewResponse>()
  }

  /**
 * Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_pulls_submit_review',
    description: `Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github-commitcomment.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github-commitcomment.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github-commitcomment.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github-commitcomment.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.PullsSubmitReviewParamsSchema,
    tags: ['pulls']
  })
  async pullsSubmitReview(
    params: github.PullsSubmitReviewParams
  ): Promise<github.PullsSubmitReviewResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/reviews/${params.review_id}/events`,
        {
          json: pick(params, 'body', 'event')
        }
      )
      .json<github.PullsSubmitReviewResponse>()
  }

  /**
 * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.
 */
  @aiFunction({
    name: 'github_pulls_update_branch',
    description: `Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.`,
    inputSchema: github.PullsUpdateBranchParamsSchema,
    tags: ['pulls']
  })
  async pullsUpdateBranch(
    params: github.PullsUpdateBranchParams
  ): Promise<github.PullsUpdateBranchResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/pulls/${params.pull_number}/update-branch`,
        {
          json: pick(params, 'expected_head_sha')
        }
      )
      .json<github.PullsUpdateBranchResponse>()
  }

  /**
 * Gets the preferred README for a repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
 */
  @aiFunction({
    name: 'github_repos_get_readme',
    description: `Gets the preferred README for a repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **\`application/vnd.github.html+json\`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).`,
    inputSchema: github.ReposGetReadmeParamsSchema,
    tags: ['repos']
  })
  async reposGetReadme(
    params: github.ReposGetReadmeParams
  ): Promise<github.ReposGetReadmeResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/readme`, {
        searchParams: sanitizeSearchParams(pick(params, 'ref'))
      })
      .json<github.ReposGetReadmeResponse>()
  }

  /**
 * Gets the README from a repository directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
 */
  @aiFunction({
    name: 'github_repos_get_readme_in_directory',
    description: `Gets the README from a repository directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **\`application/vnd.github.html+json\`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).`,
    inputSchema: github.ReposGetReadmeInDirectoryParamsSchema,
    tags: ['repos']
  })
  async reposGetReadmeInDirectory(
    params: github.ReposGetReadmeInDirectoryParams
  ): Promise<github.ReposGetReadmeInDirectoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/readme/${params.dir}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'ref'))
        }
      )
      .json<github.ReposGetReadmeInDirectoryResponse>()
  }

  /**
 * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
 */
  @aiFunction({
    name: 'github_repos_list_releases',
    description: `This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.`,
    inputSchema: github.ReposListReleasesParamsSchema,
    tags: ['repos']
  })
  async reposListReleases(
    params: github.ReposListReleasesParams
  ): Promise<github.ReposListReleasesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/releases`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListReleasesResponse>()
  }

  /**
 * Users with push access to the repository can create a release.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".
 */
  @aiFunction({
    name: 'github_repos_create_release',
    description: `Users with push access to the repository can create a release.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).".`,
    inputSchema: github.ReposCreateReleaseParamsSchema,
    tags: ['repos']
  })
  async reposCreateRelease(
    params: github.ReposCreateReleaseParams
  ): Promise<github.ReposCreateReleaseResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/releases`, {
        json: pick(
          params,
          'tag_name',
          'target_commitish',
          'name',
          'body',
          'draft',
          'prerelease',
          'discussion_category_name',
          'generate_release_notes',
          'make_latest'
        )
      })
      .json<github.ReposCreateReleaseResponse>()
  }

  /**
 * To download the asset's binary content:

- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.
- Alternatively, set the `Accept` header of the request to
  [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
  The API will either redirect the client to the location, or stream it directly if possible.
  API clients should handle both a `200` or `302` response.
 */
  @aiFunction({
    name: 'github_repos_get_release_asset',
    description: `To download the asset's binary content:

- If within a browser, fetch the location specified in the \`browser_download_url\` key provided in the response.
- Alternatively, set the \`Accept\` header of the request to
  [\`application/octet-stream\`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
  The API will either redirect the client to the location, or stream it directly if possible.
  API clients should handle both a \`200\` or \`302\` response.`,
    inputSchema: github.ReposGetReleaseAssetParamsSchema,
    tags: ['repos']
  })
  async reposGetReleaseAsset(
    params: github.ReposGetReleaseAssetParams
  ): Promise<github.ReposGetReleaseAssetResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/releases/assets/${params.asset_id}`,
        {}
      )
      .json<github.ReposGetReleaseAssetResponse>()
  }

  /**
   * Delete a release asset.
   */
  @aiFunction({
    name: 'github_repos_delete_release_asset',
    description: `Delete a release asset.`,
    inputSchema: github.ReposDeleteReleaseAssetParamsSchema,
    tags: ['repos']
  })
  async reposDeleteReleaseAsset(
    params: github.ReposDeleteReleaseAssetParams
  ): Promise<github.ReposDeleteReleaseAssetResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/releases/assets/${params.asset_id}`,
        {}
      )
      .json<github.ReposDeleteReleaseAssetResponse>()
  }

  /**
   * Users with push access to the repository can edit a release asset.
   */
  @aiFunction({
    name: 'github_repos_update_release_asset',
    description: `Users with push access to the repository can edit a release asset.`,
    inputSchema: github.ReposUpdateReleaseAssetParamsSchema,
    tags: ['repos']
  })
  async reposUpdateReleaseAsset(
    params: github.ReposUpdateReleaseAssetParams
  ): Promise<github.ReposUpdateReleaseAssetResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/releases/assets/${params.asset_id}`,
        {
          json: pick(params, 'name', 'label', 'state')
        }
      )
      .json<github.ReposUpdateReleaseAssetResponse>()
  }

  /**
   * Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
   */
  @aiFunction({
    name: 'github_repos_generate_release_notes',
    description: `Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.`,
    inputSchema: github.ReposGenerateReleaseNotesParamsSchema,
    tags: ['repos']
  })
  async reposGenerateReleaseNotes(
    params: github.ReposGenerateReleaseNotesParams
  ): Promise<github.ReposGenerateReleaseNotesResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/releases/generate-notes`,
        {
          json: pick(
            params,
            'tag_name',
            'target_commitish',
            'previous_tag_name',
            'configuration_file_path'
          )
        }
      )
      .json<github.ReposGenerateReleaseNotesResponse>()
  }

  /**
 * View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
 */
  @aiFunction({
    name: 'github_repos_get_latest_release',
    description: `View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the \`created_at\` attribute. The \`created_at\` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.`,
    inputSchema: github.ReposGetLatestReleaseParamsSchema,
    tags: ['repos']
  })
  async reposGetLatestRelease(
    params: github.ReposGetLatestReleaseParams
  ): Promise<github.ReposGetLatestReleaseResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/releases/latest`, {})
      .json<github.ReposGetLatestReleaseResponse>()
  }

  /**
   * Get a published release with the specified tag.
   */
  @aiFunction({
    name: 'github_repos_get_release_by_tag',
    description: `Get a published release with the specified tag.`,
    inputSchema: github.ReposGetReleaseByTagParamsSchema,
    tags: ['repos']
  })
  async reposGetReleaseByTag(
    params: github.ReposGetReleaseByTagParams
  ): Promise<github.ReposGetReleaseByTagResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/releases/tags/${params.tag}`,
        {}
      )
      .json<github.ReposGetReleaseByTagResponse>()
  }

  /**
 * Gets a public release with the specified release ID.

> [!NOTE]
> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).".
 */
  @aiFunction({
    name: 'github_repos_get_release',
    description: `Gets a public release with the specified release ID.

> [!NOTE]
> This returns an \`upload_url\` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).".`,
    inputSchema: github.ReposGetReleaseParamsSchema,
    tags: ['repos']
  })
  async reposGetRelease(
    params: github.ReposGetReleaseParams
  ): Promise<github.ReposGetReleaseResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}`,
        {}
      )
      .json<github.ReposGetReleaseResponse>()
  }

  /**
   * Users with push access to the repository can delete a release.
   */
  @aiFunction({
    name: 'github_repos_delete_release',
    description: `Users with push access to the repository can delete a release.`,
    inputSchema: github.ReposDeleteReleaseParamsSchema,
    tags: ['repos']
  })
  async reposDeleteRelease(
    params: github.ReposDeleteReleaseParams
  ): Promise<github.ReposDeleteReleaseResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}`,
        {}
      )
      .json<github.ReposDeleteReleaseResponse>()
  }

  /**
   * Users with push access to the repository can edit a release.
   */
  @aiFunction({
    name: 'github_repos_update_release',
    description: `Users with push access to the repository can edit a release.`,
    inputSchema: github.ReposUpdateReleaseParamsSchema,
    tags: ['repos']
  })
  async reposUpdateRelease(
    params: github.ReposUpdateReleaseParams
  ): Promise<github.ReposUpdateReleaseResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}`,
        {
          json: pick(
            params,
            'tag_name',
            'target_commitish',
            'name',
            'body',
            'draft',
            'prerelease',
            'make_latest',
            'discussion_category_name'
          )
        }
      )
      .json<github.ReposUpdateReleaseResponse>()
  }

  /**
   * List release assets.
   */
  @aiFunction({
    name: 'github_repos_list_release_assets',
    description: `List release assets.`,
    inputSchema: github.ReposListReleaseAssetsParamsSchema,
    tags: ['repos']
  })
  async reposListReleaseAssets(
    params: github.ReposListReleaseAssetsParams
  ): Promise<github.ReposListReleaseAssetsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}/assets`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposListReleaseAssetsResponse>()
  }

  /**
 * This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.

You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.

Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:

`application/zip`

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.

**Notes:**
*   GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
*   To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
*   If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
 */
  @aiFunction({
    name: 'github_repos_upload_release_asset',
    description: `This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the \`upload_url\` returned in
the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.

You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.

Most libraries will set the required \`Content-Length\` header automatically. Use the required \`Content-Type\` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:

\`application/zip\`

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a \`502 Bad Gateway\` status. This may leave an empty asset with a state of \`starter\`. It can be safely deleted.

**Notes:**
*   GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
*   To find the \`release_id\` query the [\`GET /repos/{owner}/{repo}/releases/latest\` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
*   If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.`,
    inputSchema: github.ReposUploadReleaseAssetParamsSchema,
    tags: ['repos']
  })
  async reposUploadReleaseAsset(
    params: github.ReposUploadReleaseAssetParams
  ): Promise<github.ReposUploadReleaseAssetResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}/assets`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'name', 'label'))
        }
      )
      .json<github.ReposUploadReleaseAssetResponse>()
  }

  /**
   * List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
   */
  @aiFunction({
    name: 'github_reactions_list_for_release',
    description: `List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).`,
    inputSchema: github.ReactionsListForReleaseParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForRelease(
    params: github.ReactionsListForReleaseParams
  ): Promise<github.ReactionsListForReleaseResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForReleaseResponse>()
  }

  /**
   * Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.
   */
  @aiFunction({
    name: 'github_reactions_create_for_release',
    description: `Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a \`Status: 200 OK\` means that you already added the reaction type to this release.`,
    inputSchema: github.ReactionsCreateForReleaseParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForRelease(
    params: github.ReactionsCreateForReleaseParams
  ): Promise<github.ReactionsCreateForReleaseResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForReleaseResponse>()
  }

  /**
 * > [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.

Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
 */
  @aiFunction({
    name: 'github_reactions_delete_for_release',
    description: `> [!NOTE]
> You can also specify a repository by \`repository_id\` using the route \`DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id\`.

Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).`,
    inputSchema: github.ReactionsDeleteForReleaseParamsSchema,
    tags: ['reactions']
  })
  async reactionsDeleteForRelease(
    params: github.ReactionsDeleteForReleaseParams
  ): Promise<github.ReactionsDeleteForReleaseResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/releases/${params.release_id}/reactions/${params.reaction_id}`,
        {}
      )
      .json<github.ReactionsDeleteForReleaseResponse>()
  }

  /**
 * Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
enforcement statuses are not returned.
 */
  @aiFunction({
    name: 'github_repos_get_branch_rules',
    description: `Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
enforcement statuses are not returned.`,
    inputSchema: github.ReposGetBranchRulesParamsSchema,
    tags: ['repos']
  })
  async reposGetBranchRules(
    params: github.ReposGetBranchRulesParams
  ): Promise<github.ReposGetBranchRulesResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/rules/branches/${params.branch}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposGetBranchRulesResponse>()
  }

  /**
   * Get all the rulesets for a repository.
   */
  @aiFunction({
    name: 'github_repos_get_repo_rulesets',
    description: `Get all the rulesets for a repository.`,
    inputSchema: github.ReposGetRepoRulesetsParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRulesets(
    params: github.ReposGetRepoRulesetsParams
  ): Promise<github.ReposGetRepoRulesetsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/rulesets`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'includes_parents', 'targets')
        )
      })
      .json<github.ReposGetRepoRulesetsResponse>()
  }

  /**
   * Create a ruleset for a repository.
   */
  @aiFunction({
    name: 'github_repos_create_repo_ruleset',
    description: `Create a ruleset for a repository.`,
    inputSchema: github.ReposCreateRepoRulesetParamsSchema,
    tags: ['repos']
  })
  async reposCreateRepoRuleset(
    params: github.ReposCreateRepoRulesetParams
  ): Promise<github.ReposCreateRepoRulesetResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/rulesets`, {
        json: pick(
          params,
          'name',
          'target',
          'enforcement',
          'bypass_actors',
          'conditions',
          'rules'
        )
      })
      .json<github.ReposCreateRepoRulesetResponse>()
  }

  /**
 * Lists suites of rule evaluations at the repository level.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).".
 */
  @aiFunction({
    name: 'github_repos_get_repo_rule_suites',
    description: `Lists suites of rule evaluations at the repository level.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).".`,
    inputSchema: github.ReposGetRepoRuleSuitesParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRuleSuites(
    params: github.ReposGetRepoRuleSuitesParams
  ): Promise<github.ReposGetRepoRuleSuitesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/rulesets/rule-suites`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'ref',
            'time_period',
            'actor_name',
            'rule_suite_result',
            'per_page',
            'page'
          )
        )
      })
      .json<github.ReposGetRepoRuleSuitesResponse>()
  }

  /**
 * Gets information about a suite of rule evaluations from within a repository.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).".
 */
  @aiFunction({
    name: 'github_repos_get_repo_rule_suite',
    description: `Gets information about a suite of rule evaluations from within a repository.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).".`,
    inputSchema: github.ReposGetRepoRuleSuiteParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRuleSuite(
    params: github.ReposGetRepoRuleSuiteParams
  ): Promise<github.ReposGetRepoRuleSuiteResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/rulesets/rule-suites/${params.rule_suite_id}`,
        {}
      )
      .json<github.ReposGetRepoRuleSuiteResponse>()
  }

  /**
 * Get a ruleset for a repository.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset.
 */
  @aiFunction({
    name: 'github_repos_get_repo_ruleset',
    description: `Get a ruleset for a repository.

**Note:** To prevent leaking sensitive information, the \`bypass_actors\` property is only returned if the user
making the API request has write access to the ruleset.`,
    inputSchema: github.ReposGetRepoRulesetParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRuleset(
    params: github.ReposGetRepoRulesetParams
  ): Promise<github.ReposGetRepoRulesetResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/rulesets/${params.ruleset_id}`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'includes_parents'))
        }
      )
      .json<github.ReposGetRepoRulesetResponse>()
  }

  /**
   * Update a ruleset for a repository.
   */
  @aiFunction({
    name: 'github_repos_update_repo_ruleset',
    description: `Update a ruleset for a repository.`,
    inputSchema: github.ReposUpdateRepoRulesetParamsSchema,
    tags: ['repos']
  })
  async reposUpdateRepoRuleset(
    params: github.ReposUpdateRepoRulesetParams
  ): Promise<github.ReposUpdateRepoRulesetResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/rulesets/${params.ruleset_id}`,
        {
          json: pick(
            params,
            'name',
            'target',
            'enforcement',
            'bypass_actors',
            'conditions',
            'rules'
          )
        }
      )
      .json<github.ReposUpdateRepoRulesetResponse>()
  }

  /**
   * Delete a ruleset for a repository.
   */
  @aiFunction({
    name: 'github_repos_delete_repo_ruleset',
    description: `Delete a ruleset for a repository.`,
    inputSchema: github.ReposDeleteRepoRulesetParamsSchema,
    tags: ['repos']
  })
  async reposDeleteRepoRuleset(
    params: github.ReposDeleteRepoRulesetParams
  ): Promise<github.ReposDeleteRepoRulesetResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/rulesets/${params.ruleset_id}`,
        {}
      )
      .json<github.ReposDeleteRepoRulesetResponse>()
  }

  /**
   * Get the history of a repository ruleset.
   */
  @aiFunction({
    name: 'github_repos_get_repo_ruleset_history',
    description: `Get the history of a repository ruleset.`,
    inputSchema: github.ReposGetRepoRulesetHistoryParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRulesetHistory(
    params: github.ReposGetRepoRulesetHistoryParams
  ): Promise<github.ReposGetRepoRulesetHistoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/rulesets/${params.ruleset_id}/history`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
        }
      )
      .json<github.ReposGetRepoRulesetHistoryResponse>()
  }

  /**
   * Get a version of a repository ruleset.
   */
  @aiFunction({
    name: 'github_repos_get_repo_ruleset_version',
    description: `Get a version of a repository ruleset.`,
    inputSchema: github.ReposGetRepoRulesetVersionParamsSchema,
    tags: ['repos']
  })
  async reposGetRepoRulesetVersion(
    params: github.ReposGetRepoRulesetVersionParams
  ): Promise<github.ReposGetRepoRulesetVersionResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/rulesets/${params.ruleset_id}/history/${params.version_id}`,
        {}
      )
      .json<github.ReposGetRepoRulesetVersionResponse>()
  }

  /**
 * Lists secret scanning alerts for an eligible repository, from newest to oldest.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_list_alerts_for_repo',
    description: `Lists secret scanning alerts for an eligible repository, from newest to oldest.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningListAlertsForRepoParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningListAlertsForRepo(
    params: github.SecretScanningListAlertsForRepoParams
  ): Promise<github.SecretScanningListAlertsForRepoResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/secret-scanning/alerts`,
        {
          searchParams: sanitizeSearchParams(
            pick(
              params,
              'state',
              'secret_type',
              'resolution',
              'sort',
              'direction',
              'page',
              'per_page',
              'before',
              'after',
              'validity',
              'is_publicly_leaked',
              'is_multi_repo'
            )
          )
        }
      )
      .json<github.SecretScanningListAlertsForRepoResponse>()
  }

  /**
 * Gets a single secret scanning alert detected in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_get_alert',
    description: `Gets a single secret scanning alert detected in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningGetAlertParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningGetAlert(
    params: github.SecretScanningGetAlertParams
  ): Promise<github.SecretScanningGetAlertResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/secret-scanning/alerts/${params.alert_number}`,
        {}
      )
      .json<github.SecretScanningGetAlertResponse>()
  }

  /**
 * Updates the status of a secret scanning alert in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_update_alert',
    description: `Updates the status of a secret scanning alert in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningUpdateAlertParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningUpdateAlert(
    params: github.SecretScanningUpdateAlertParams
  ): Promise<github.SecretScanningUpdateAlertResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/secret-scanning/alerts/${params.alert_number}`,
        {
          json: pick(params, 'state', 'resolution', 'resolution_comment')
        }
      )
      .json<github.SecretScanningUpdateAlertResponse>()
  }

  /**
 * Lists all locations for a given secret scanning alert for an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_list_locations_for_alert',
    description: `Lists all locations for a given secret scanning alert for an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningListLocationsForAlertParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningListLocationsForAlert(
    params: github.SecretScanningListLocationsForAlertParams
  ): Promise<github.SecretScanningListLocationsForAlertResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/secret-scanning/alerts/${params.alert_number}/locations`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
        }
      )
      .json<github.SecretScanningListLocationsForAlertResponse>()
  }

  /**
 * Creates a bypass for a previously push protected secret.

The authenticated user must be the original author of the committed secret.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_secret_scanning_create_push_protection_bypass',
    description: `Creates a bypass for a previously push protected secret.

The authenticated user must be the original author of the committed secret.

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.SecretScanningCreatePushProtectionBypassParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningCreatePushProtectionBypass(
    params: github.SecretScanningCreatePushProtectionBypassParams
  ): Promise<github.SecretScanningCreatePushProtectionBypassResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/secret-scanning/push-protection-bypasses`,
        {
          json: pick(params, 'reason', 'placeholder_id')
        }
      )
      .json<github.SecretScanningCreatePushProtectionBypassResponse>()
  }

  /**
 * Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
 */
  @aiFunction({
    name: 'github_secret_scanning_get_scan_history',
    description: `Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`security_events\` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the \`public_repo\` scope instead.`,
    inputSchema: github.SecretScanningGetScanHistoryParamsSchema,
    tags: ['secret-scanning']
  })
  async secretScanningGetScanHistory(
    params: github.SecretScanningGetScanHistoryParams
  ): Promise<github.SecretScanningGetScanHistoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/secret-scanning/scan-history`,
        {}
      )
      .json<github.SecretScanningGetScanHistoryResponse>()
  }

  /**
 * Lists security advisories in a repository.

The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
 */
  @aiFunction({
    name: 'github_security_advisories_list_repository_advisories',
    description: `Lists security advisories in a repository.

The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:read\` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.`,
    inputSchema: github.SecurityAdvisoriesListRepositoryAdvisoriesParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesListRepositoryAdvisories(
    params: github.SecurityAdvisoriesListRepositoryAdvisoriesParams
  ): Promise<github.SecurityAdvisoriesListRepositoryAdvisoriesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/security-advisories`, {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'direction',
            'sort',
            'before',
            'after',
            'per_page',
            'state'
          )
        )
      })
      .json<github.SecurityAdvisoriesListRepositoryAdvisoriesResponse>()
  }

  /**
 * Creates a new repository security advisory.

In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_security_advisories_create_repository_advisory',
    description: `Creates a new repository security advisory.

In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:write\` scope to use this endpoint.`,
    inputSchema: github.SecurityAdvisoriesCreateRepositoryAdvisoryParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesCreateRepositoryAdvisory(
    params: github.SecurityAdvisoriesCreateRepositoryAdvisoryParams
  ): Promise<github.SecurityAdvisoriesCreateRepositoryAdvisoryResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/security-advisories`, {
        json: pick(
          params,
          'summary',
          'description',
          'cve_id',
          'vulnerabilities',
          'cwe_ids',
          'credits',
          'severity',
          'cvss_vector_string',
          'start_private_fork'
        )
      })
      .json<github.SecurityAdvisoriesCreateRepositoryAdvisoryResponse>()
  }

  /**
 * Report a security vulnerability to the maintainers of the repository.
See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.
 */
  @aiFunction({
    name: 'github_security_advisories_create_private_vulnerability_report',
    description: `Report a security vulnerability to the maintainers of the repository.
See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.`,
    inputSchema:
      github.SecurityAdvisoriesCreatePrivateVulnerabilityReportParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesCreatePrivateVulnerabilityReport(
    params: github.SecurityAdvisoriesCreatePrivateVulnerabilityReportParams
  ): Promise<github.SecurityAdvisoriesCreatePrivateVulnerabilityReportResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/security-advisories/reports`,
        {
          json: pick(
            params,
            'summary',
            'description',
            'vulnerabilities',
            'cwe_ids',
            'severity',
            'cvss_vector_string',
            'start_private_fork'
          )
        }
      )
      .json<github.SecurityAdvisoriesCreatePrivateVulnerabilityReportResponse>()
  }

  /**
 * Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

Anyone can access any published security advisory on a public repository.

The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
collaborator on the security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
 */
  @aiFunction({
    name: 'github_security_advisories_get_repository_advisory',
    description: `Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

Anyone can access any published security advisory on a public repository.

The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
collaborator on the security advisory.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:read\` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.`,
    inputSchema: github.SecurityAdvisoriesGetRepositoryAdvisoryParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesGetRepositoryAdvisory(
    params: github.SecurityAdvisoriesGetRepositoryAdvisoryParams
  ): Promise<github.SecurityAdvisoriesGetRepositoryAdvisoryResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/security-advisories/${params.ghsa_id}`,
        {}
      )
      .json<github.SecurityAdvisoriesGetRepositoryAdvisoryResponse>()
  }

  /**
 * Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
or a collaborator on the repository security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_security_advisories_update_repository_advisory',
    description: `Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
or a collaborator on the repository security advisory.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:write\` scope to use this endpoint.`,
    inputSchema: github.SecurityAdvisoriesUpdateRepositoryAdvisoryParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesUpdateRepositoryAdvisory(
    params: github.SecurityAdvisoriesUpdateRepositoryAdvisoryParams
  ): Promise<github.SecurityAdvisoriesUpdateRepositoryAdvisoryResponse> {
    return this.ky
      .patch(
        `/repos/${params.owner}/${params.repo}/security-advisories/${params.ghsa_id}`,
        {
          json: pick(
            params,
            'summary',
            'description',
            'cve_id',
            'vulnerabilities',
            'cwe_ids',
            'credits',
            'severity',
            'cvss_vector_string',
            'state',
            'collaborating_users',
            'collaborating_teams'
          )
        }
      )
      .json<github.SecurityAdvisoriesUpdateRepositoryAdvisoryResponse>()
  }

  /**
 * If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_security_advisories_create_repository_advisory_cve_request',
    description: `If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the \`repo\` or \`repository_advisories:write\` scope to use this endpoint.`,
    inputSchema:
      github.SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesCreateRepositoryAdvisoryCveRequest(
    params: github.SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestParams
  ): Promise<github.SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/security-advisories/${params.ghsa_id}/cve`,
        {}
      )
      .json<github.SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestResponse>()
  }

  /**
 * Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.

> [!NOTE]
> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
 */
  @aiFunction({
    name: 'github_security_advisories_create_fork',
    description: `Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.

> [!NOTE]
> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.`,
    inputSchema: github.SecurityAdvisoriesCreateForkParamsSchema,
    tags: ['security-advisories']
  })
  async securityAdvisoriesCreateFork(
    params: github.SecurityAdvisoriesCreateForkParams
  ): Promise<github.SecurityAdvisoriesCreateForkResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/security-advisories/${params.ghsa_id}/forks`,
        {}
      )
      .json<github.SecurityAdvisoriesCreateForkResponse>()
  }

  /**
 * Lists the people that have starred the repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
 */
  @aiFunction({
    name: 'github_activity_list_stargazers_for_repo',
    description: `Lists the people that have starred the repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.star+json\`**: Includes a timestamp of when the star was created.`,
    inputSchema: github.ActivityListStargazersForRepoParamsSchema,
    tags: ['activity']
  })
  async activityListStargazersForRepo(
    params: github.ActivityListStargazersForRepoParams
  ): Promise<github.ActivityListStargazersForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/stargazers`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListStargazersForRepoResponse>()
  }

  /**
 * Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

> [!NOTE]
> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
 */
  @aiFunction({
    name: 'github_repos_get_code_frequency_stats',
    description: `Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

> [!NOTE]
> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.`,
    inputSchema: github.ReposGetCodeFrequencyStatsParamsSchema,
    tags: ['repos']
  })
  async reposGetCodeFrequencyStats(
    params: github.ReposGetCodeFrequencyStatsParams
  ): Promise<github.ReposGetCodeFrequencyStatsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/stats/code_frequency`,
        {}
      )
      .json<github.ReposGetCodeFrequencyStatsResponse>()
  }

  /**
   * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.
   */
  @aiFunction({
    name: 'github_repos_get_commit_activity_stats',
    description: `Returns the last year of commit activity grouped by week. The \`days\` array is a group of commits per day, starting on \`Sunday\`.`,
    inputSchema: github.ReposGetCommitActivityStatsParamsSchema,
    tags: ['repos']
  })
  async reposGetCommitActivityStats(
    params: github.ReposGetCommitActivityStatsParams
  ): Promise<github.ReposGetCommitActivityStatsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/stats/commit_activity`,
        {}
      )
      .json<github.ReposGetCommitActivityStatsResponse>()
  }

  /**
 *
Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:

*   `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
*   `a` - Number of additions
*   `d` - Number of deletions
*   `c` - Number of commits

> [!NOTE]
> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
 */
  @aiFunction({
    name: 'github_repos_get_contributors_stats',
    description: `
Returns the \`total\` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (\`weeks\` array) with the following information:

*   \`w\` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
*   \`a\` - Number of additions
*   \`d\` - Number of deletions
*   \`c\` - Number of commits

> [!NOTE]
> This endpoint will return \`0\` values for all addition and deletion counts in repositories with 10,000 or more commits.`,
    inputSchema: github.ReposGetContributorsStatsParamsSchema,
    tags: ['repos']
  })
  async reposGetContributorsStats(
    params: github.ReposGetContributorsStatsParams
  ): Promise<github.ReposGetContributorsStatsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/stats/contributors`, {})
      .json<github.ReposGetContributorsStatsResponse>()
  }

  /**
 * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.

The array order is oldest week (index 0) to most recent week.

The most recent week is seven days ago at UTC midnight to today at UTC midnight.
 */
  @aiFunction({
    name: 'github_repos_get_participation_stats',
    description: `Returns the total commit counts for the \`owner\` and total commit counts in \`all\`. \`all\` is everyone combined, including the \`owner\` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract \`owner\` from \`all\`.

The array order is oldest week (index 0) to most recent week.

The most recent week is seven days ago at UTC midnight to today at UTC midnight.`,
    inputSchema: github.ReposGetParticipationStatsParamsSchema,
    tags: ['repos']
  })
  async reposGetParticipationStats(
    params: github.ReposGetParticipationStatsParams
  ): Promise<github.ReposGetParticipationStatsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/stats/participation`,
        {}
      )
      .json<github.ReposGetParticipationStatsResponse>()
  }

  /**
 * Each array contains the day number, hour number, and number of commits:

*   `0-6`: Sunday - Saturday
*   `0-23`: Hour of day
*   Number of commits

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
 */
  @aiFunction({
    name: 'github_repos_get_punch_card_stats',
    description: `Each array contains the day number, hour number, and number of commits:

*   \`0-6\`: Sunday - Saturday
*   \`0-23\`: Hour of day
*   Number of commits

For example, \`[2, 14, 25]\` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.`,
    inputSchema: github.ReposGetPunchCardStatsParamsSchema,
    tags: ['repos']
  })
  async reposGetPunchCardStats(
    params: github.ReposGetPunchCardStatsParams
  ): Promise<github.ReposGetPunchCardStatsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/stats/punch_card`, {})
      .json<github.ReposGetPunchCardStatsResponse>()
  }

  /**
 * Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.
 */
  @aiFunction({
    name: 'github_repos_create_commit_status',
    description: `Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per \`sha\` and \`context\` within a repository. Attempts to create more than 1000 statuses will result in a validation error.`,
    inputSchema: github.ReposCreateCommitStatusParamsSchema,
    tags: ['repos']
  })
  async reposCreateCommitStatus(
    params: github.ReposCreateCommitStatusParams
  ): Promise<github.ReposCreateCommitStatusResponse> {
    return this.ky
      .post(
        `/repos/${params.owner}/${params.repo}/statuses/${params.sha}`,
        {
          json: pick(params, 'state', 'target_url', 'description', 'context')
        }
      )
      .json<github.ReposCreateCommitStatusResponse>()
  }

  /**
   * Lists the people watching the specified repository.
   */
  @aiFunction({
    name: 'github_activity_list_watchers_for_repo',
    description: `Lists the people watching the specified repository.`,
    inputSchema: github.ActivityListWatchersForRepoParamsSchema,
    tags: ['activity']
  })
  async activityListWatchersForRepo(
    params: github.ActivityListWatchersForRepoParams
  ): Promise<github.ActivityListWatchersForRepoResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/subscribers`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListWatchersForRepoResponse>()
  }

  /**
   * Gets information about whether the authenticated user is subscribed to the repository.
   */
  @aiFunction({
    name: 'github_activity_get_repo_subscription',
    description: `Gets information about whether the authenticated user is subscribed to the repository.`,
    inputSchema: github.ActivityGetRepoSubscriptionParamsSchema,
    tags: ['activity']
  })
  async activityGetRepoSubscription(
    params: github.ActivityGetRepoSubscriptionParams
  ): Promise<github.ActivityGetRepoSubscriptionResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/subscription`, {})
      .json<github.ActivityGetRepoSubscriptionResponse>()
  }

  /**
   * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.
   */
  @aiFunction({
    name: 'github_activity_set_repo_subscription',
    description: `If you would like to watch a repository, set \`subscribed\` to \`true\`. If you would like to ignore notifications made within a repository, set \`ignored\` to \`true\`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.`,
    inputSchema: github.ActivitySetRepoSubscriptionParamsSchema,
    tags: ['activity']
  })
  async activitySetRepoSubscription(
    params: github.ActivitySetRepoSubscriptionParams
  ): Promise<github.ActivitySetRepoSubscriptionResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/subscription`, {
        json: pick(params, 'subscribed', 'ignored')
      })
      .json<github.ActivitySetRepoSubscriptionResponse>()
  }

  /**
   * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).
   */
  @aiFunction({
    name: 'github_activity_delete_repo_subscription',
    description: `This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).`,
    inputSchema: github.ActivityDeleteRepoSubscriptionParamsSchema,
    tags: ['activity']
  })
  async activityDeleteRepoSubscription(
    params: github.ActivityDeleteRepoSubscriptionParams
  ): Promise<github.ActivityDeleteRepoSubscriptionResponse> {
    return this.ky
      .delete(`/repos/${params.owner}/${params.repo}/subscription`, {})
      .json<github.ActivityDeleteRepoSubscriptionResponse>()
  }

  /**
   * List repository tags.
   */
  @aiFunction({
    name: 'github_repos_list_tags',
    description: `List repository tags.`,
    inputSchema: github.ReposListTagsParamsSchema,
    tags: ['repos']
  })
  async reposListTags(
    params: github.ReposListTagsParams
  ): Promise<github.ReposListTagsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/tags`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListTagsResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead.

This returns the tag protection states of a repository.

This information is only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_list_tag_protection',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead.

This returns the tag protection states of a repository.

This information is only available to repository administrators.`,
    inputSchema: github.ReposListTagProtectionParamsSchema,
    tags: ['repos']
  })
  async reposListTagProtection(
    params: github.ReposListTagProtectionParams
  ): Promise<github.ReposListTagProtectionResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/tags/protection`, {})
      .json<github.ReposListTagProtectionResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead.

This creates a tag protection state for a repository.
This endpoint is only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_create_tag_protection',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead.

This creates a tag protection state for a repository.
This endpoint is only available to repository administrators.`,
    inputSchema: github.ReposCreateTagProtectionParamsSchema,
    tags: ['repos']
  })
  async reposCreateTagProtection(
    params: github.ReposCreateTagProtectionParams
  ): Promise<github.ReposCreateTagProtectionResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/tags/protection`, {
        json: pick(params, 'pattern')
      })
      .json<github.ReposCreateTagProtectionResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead.

This deletes a tag protection state for a repository.
This endpoint is only available to repository administrators.
 */
  @aiFunction({
    name: 'github_repos_delete_tag_protection',
    description: `> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead.

This deletes a tag protection state for a repository.
This endpoint is only available to repository administrators.`,
    inputSchema: github.ReposDeleteTagProtectionParamsSchema,
    tags: ['repos']
  })
  async reposDeleteTagProtection(
    params: github.ReposDeleteTagProtectionParams
  ): Promise<github.ReposDeleteTagProtectionResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/tags/protection/${params.tag_protection_id}`,
        {}
      )
      .json<github.ReposDeleteTagProtectionResponse>()
  }

  /**
 * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.

> [!NOTE]
> For private repositories, these links are temporary and expire after five minutes.
 */
  @aiFunction({
    name: 'github_repos_download_tarball_archive',
    description: `Gets a redirect URL to download a tar archive for a repository. If you omit \`:ref\`, the repository’s default branch (usually
\`main\`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the \`Location\` header to make a second \`GET\` request.

> [!NOTE]
> For private repositories, these links are temporary and expire after five minutes.`,
    inputSchema: github.ReposDownloadTarballArchiveParamsSchema,
    tags: ['repos']
  })
  async reposDownloadTarballArchive(
    params: github.ReposDownloadTarballArchiveParams
  ): Promise<github.ReposDownloadTarballArchiveResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/tarball/${params.ref}`,
        {}
      )
      .json<github.ReposDownloadTarballArchiveResponse>()
  }

  /**
 * Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

For a public repository, a team is listed only if that team added the public repository explicitly.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
 */
  @aiFunction({
    name: 'github_repos_list_teams',
    description: `Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

For a public repository, a team is listed only if that team added the public repository explicitly.

OAuth app tokens and personal access tokens (classic) need the \`public_repo\` or \`repo\` scope to use this endpoint with a public repository, and \`repo\` scope to use this endpoint with a private repository.`,
    inputSchema: github.ReposListTeamsParamsSchema,
    tags: ['repos']
  })
  async reposListTeams(
    params: github.ReposListTeamsParams
  ): Promise<github.ReposListTeamsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/teams`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListTeamsResponse>()
  }

  /**
   * Get all repository topics.
   */
  @aiFunction({
    name: 'github_repos_get_all_topics',
    description: `Get all repository topics.`,
    inputSchema: github.ReposGetAllTopicsParamsSchema,
    tags: ['repos']
  })
  async reposGetAllTopics(
    params: github.ReposGetAllTopicsParams
  ): Promise<github.ReposGetAllTopicsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/topics`, {
        searchParams: sanitizeSearchParams(pick(params, 'page', 'per_page'))
      })
      .json<github.ReposGetAllTopicsResponse>()
  }

  /**
   * Replace all repository topics.
   */
  @aiFunction({
    name: 'github_repos_replace_all_topics',
    description: `Replace all repository topics.`,
    inputSchema: github.ReposReplaceAllTopicsParamsSchema,
    tags: ['repos']
  })
  async reposReplaceAllTopics(
    params: github.ReposReplaceAllTopicsParams
  ): Promise<github.ReposReplaceAllTopicsResponse> {
    return this.ky
      .put(`/repos/${params.owner}/${params.repo}/topics`, {
        json: pick(params, 'names')
      })
      .json<github.ReposReplaceAllTopicsResponse>()
  }

  /**
   * Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
   */
  @aiFunction({
    name: 'github_repos_get_clones',
    description: `Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.`,
    inputSchema: github.ReposGetClonesParamsSchema,
    tags: ['repos']
  })
  async reposGetClones(
    params: github.ReposGetClonesParams
  ): Promise<github.ReposGetClonesResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/traffic/clones`, {
        searchParams: sanitizeSearchParams(pick(params, 'per'))
      })
      .json<github.ReposGetClonesResponse>()
  }

  /**
   * Get the top 10 popular contents over the last 14 days.
   */
  @aiFunction({
    name: 'github_repos_get_top_paths',
    description: `Get the top 10 popular contents over the last 14 days.`,
    inputSchema: github.ReposGetTopPathsParamsSchema,
    tags: ['repos']
  })
  async reposGetTopPaths(
    params: github.ReposGetTopPathsParams
  ): Promise<github.ReposGetTopPathsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/traffic/popular/paths`,
        {}
      )
      .json<github.ReposGetTopPathsResponse>()
  }

  /**
   * Get the top 10 referrers over the last 14 days.
   */
  @aiFunction({
    name: 'github_repos_get_top_referrers',
    description: `Get the top 10 referrers over the last 14 days.`,
    inputSchema: github.ReposGetTopReferrersParamsSchema,
    tags: ['repos']
  })
  async reposGetTopReferrers(
    params: github.ReposGetTopReferrersParams
  ): Promise<github.ReposGetTopReferrersResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/traffic/popular/referrers`,
        {}
      )
      .json<github.ReposGetTopReferrersResponse>()
  }

  /**
   * Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
   */
  @aiFunction({
    name: 'github_repos_get_views',
    description: `Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.`,
    inputSchema: github.ReposGetViewsParamsSchema,
    tags: ['repos']
  })
  async reposGetViews(
    params: github.ReposGetViewsParams
  ): Promise<github.ReposGetViewsResponse> {
    return this.ky
      .get(`/repos/${params.owner}/${params.repo}/traffic/views`, {
        searchParams: sanitizeSearchParams(pick(params, 'per'))
      })
      .json<github.ReposGetViewsResponse>()
  }

  /**
   * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
   */
  @aiFunction({
    name: 'github_repos_transfer',
    description: `A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original \`owner\`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).`,
    inputSchema: github.ReposTransferParamsSchema,
    tags: ['repos']
  })
  async reposTransfer(
    params: github.ReposTransferParams
  ): Promise<github.ReposTransferResponse> {
    return this.ky
      .post(`/repos/${params.owner}/${params.repo}/transfer`, {
        json: pick(params, 'new_owner', 'new_name', 'team_ids')
      })
      .json<github.ReposTransferResponse>()
  }

  /**
   * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
   */
  @aiFunction({
    name: 'github_repos_check_vulnerability_alerts',
    description: `Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".`,
    inputSchema: github.ReposCheckVulnerabilityAlertsParamsSchema,
    tags: ['repos']
  })
  async reposCheckVulnerabilityAlerts(
    params: github.ReposCheckVulnerabilityAlertsParams
  ): Promise<github.ReposCheckVulnerabilityAlertsResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/vulnerability-alerts`,
        {}
      )
      .json<github.ReposCheckVulnerabilityAlertsResponse>()
  }

  /**
   * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
   */
  @aiFunction({
    name: 'github_repos_enable_vulnerability_alerts',
    description: `Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".`,
    inputSchema: github.ReposEnableVulnerabilityAlertsParamsSchema,
    tags: ['repos']
  })
  async reposEnableVulnerabilityAlerts(
    params: github.ReposEnableVulnerabilityAlertsParams
  ): Promise<github.ReposEnableVulnerabilityAlertsResponse> {
    return this.ky
      .put(
        `/repos/${params.owner}/${params.repo}/vulnerability-alerts`,
        {}
      )
      .json<github.ReposEnableVulnerabilityAlertsResponse>()
  }

  /**
 * Disables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
 */
  @aiFunction({
    name: 'github_repos_disable_vulnerability_alerts',
    description: `Disables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".`,
    inputSchema: github.ReposDisableVulnerabilityAlertsParamsSchema,
    tags: ['repos']
  })
  async reposDisableVulnerabilityAlerts(
    params: github.ReposDisableVulnerabilityAlertsParams
  ): Promise<github.ReposDisableVulnerabilityAlertsResponse> {
    return this.ky
      .delete(
        `/repos/${params.owner}/${params.repo}/vulnerability-alerts`,
        {}
      )
      .json<github.ReposDisableVulnerabilityAlertsResponse>()
  }

  /**
 * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.

> [!NOTE]
> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
 */
  @aiFunction({
    name: 'github_repos_download_zipball_archive',
    description: `Gets a redirect URL to download a zip archive for a repository. If you omit \`:ref\`, the repository’s default branch (usually
\`main\`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the \`Location\` header to make a second \`GET\` request.

> [!NOTE]
> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.`,
    inputSchema: github.ReposDownloadZipballArchiveParamsSchema,
    tags: ['repos']
  })
  async reposDownloadZipballArchive(
    params: github.ReposDownloadZipballArchiveParams
  ): Promise<github.ReposDownloadZipballArchiveResponse> {
    return this.ky
      .get(
        `/repos/${params.owner}/${params.repo}/zipball/${params.ref}`,
        {}
      )
      .json<github.ReposDownloadZipballArchiveResponse>()
  }

  /**
 * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
 */
  @aiFunction({
    name: 'github_repos_create_using_template',
    description: `Creates a new repository using a repository template. Use the \`template_owner\` and \`template_repo\` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the \`is_template\` key is \`true\`.

OAuth app tokens and personal access tokens (classic) need the \`public_repo\` or \`repo\` scope to create a public repository, and \`repo\` scope to create a private repository.`,
    inputSchema: github.ReposCreateUsingTemplateParamsSchema,
    tags: ['repos']
  })
  async reposCreateUsingTemplate(
    params: github.ReposCreateUsingTemplateParams
  ): Promise<github.ReposCreateUsingTemplateResponse> {
    return this.ky
      .post(
        `/repos/${params.template_owner}/${params.template_repo}/generate`,
        {
          json: pick(
            params,
            'owner',
            'name',
            'description',
            'include_all_branches',
            'private'
          )
        }
      )
      .json<github.ReposCreateUsingTemplateResponse>()
  }

  /**
 * Lists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
 */
  @aiFunction({
    name: 'github_repos_list_public',
    description: `Lists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the \`since\` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.`,
    inputSchema: github.ReposListPublicParamsSchema,
    tags: ['repos']
  })
  async reposListPublic(
    params: github.ReposListPublicParams
  ): Promise<github.ReposListPublicResponse> {
    return this.ky
      .get('/repositories', {
        searchParams: sanitizeSearchParams(params)
      })
      .json<github.ReposListPublicResponse>()
  }

  /**
 * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:

`q=addClass+in:file+language:js+repo:jquery/jquery`

This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.

Considerations for code search:

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

*   Only the _default branch_ is considered. In most cases, this will be the `master` branch.
*   Only files smaller than 384 KB are searchable.
*   You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.

This endpoint requires you to authenticate and limits you to 10 requests per minute.
 */
  @aiFunction({
    name: 'github_search_code',
    description: `Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the \`text-match\` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the definition of the \`addClass\` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:

\`q=addClass+in:file+language:js+repo:jquery/jquery\`

This query searches for the keyword \`addClass\` within a file's contents. The query limits the search to files where the language is JavaScript in the \`jquery/jquery\` repository.

Considerations for code search:

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

*   Only the _default branch_ is considered. In most cases, this will be the \`master\` branch.
*   Only files smaller than 384 KB are searchable.
*   You must always include at least one search term when searching source code. For example, searching for [\`language:go\`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [\`amazing
language:go\`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.

This endpoint requires you to authenticate and limits you to 10 requests per minute.`,
    inputSchema: github.SearchCodeParamsSchema,
    tags: ['search']
  })
  async searchCode(
    params: github.SearchCodeParams
  ): Promise<github.SearchCodeResponse> {
    return this.ky
      .get('/search/code', {
        searchParams: sanitizeSearchParams(
          pick(params, 'q', 'sort', 'order', 'per_page', 'page')
        )
      })
      .json<github.SearchCodeResponse>()
  }

  /**
 * Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:

`q=repo:octocat/Spoon-Knife+css`.
 */
  @aiFunction({
    name: 'github_search_commits',
    description: `Find commits via various criteria on the default branch (usually \`main\`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for commits, you can get text match metadata for the **message** field when you provide the \`text-match\` media type. For more details about how to receive highlighted search results, see [Text match
metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:

\`q=repo:octocat/Spoon-Knife+css\`.`,
    inputSchema: github.SearchCommitsParamsSchema,
    tags: ['search']
  })
  async searchCommits(
    params: github.SearchCommitsParams
  ): Promise<github.SearchCommitsResponse> {
    return this.ky
      .get('/search/commits', {
        searchParams: sanitizeSearchParams(
          pick(params, 'q', 'sort', 'order', 'per_page', 'page')
        )
      })
      .json<github.SearchCommitsResponse>()
  }

  /**
 * > [!WARNING]
> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.
> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).
 */
  @aiFunction({
    name: 'github_search_issues_and_pull_requests',
    description: `> [!WARNING]
> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.
> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).`,
    inputSchema: github.SearchIssuesAndPullRequestsParamsSchema,
    tags: ['search']
  })
  async searchIssuesAndPullRequests(
    params: github.SearchIssuesAndPullRequestsParams
  ): Promise<github.SearchIssuesAndPullRequestsResponse> {
    return this.ky
      .get('/search/issues', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'q',
            'sort',
            'order',
            'per_page',
            'page',
            'advanced_search'
          )
        )
      })
      .json<github.SearchIssuesAndPullRequestsResponse>()
  }

  /**
 * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:

`q=bug+defect+enhancement&repository_id=64778136`

The labels that best match the query appear first in the search results.
 */
  @aiFunction({
    name: 'github_search_labels',
    description: `Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the \`text-match\` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find labels in the \`linguist\` repository that match \`bug\`, \`defect\`, or \`enhancement\`. Your query might look like this:

\`q=bug+defect+enhancement&repository_id=64778136\`

The labels that best match the query appear first in the search results.`,
    inputSchema: github.SearchLabelsParamsSchema,
    tags: ['search']
  })
  async searchLabels(
    params: github.SearchLabelsParams
  ): Promise<github.SearchLabelsResponse> {
    return this.ky
      .get('/search/labels', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'repository_id',
            'q',
            'sort',
            'order',
            'per_page',
            'page'
          )
        )
      })
      .json<github.SearchLabelsResponse>()
  }

  /**
 * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

`q=tetris+language:assembly&sort=stars&order=desc`

This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
 */
  @aiFunction({
    name: 'github_search_repos',
    description: `Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the \`text-match\` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\`q=tetris+language:assembly&sort=stars&order=desc\`

This query searches for repositories with the word \`tetris\` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.`,
    inputSchema: github.SearchReposParamsSchema,
    tags: ['search']
  })
  async searchRepos(
    params: github.SearchReposParams
  ): Promise<github.SearchReposResponse> {
    return this.ky
      .get('/search/repositories', {
        searchParams: sanitizeSearchParams(
          pick(params, 'q', 'sort', 'order', 'per_page', 'page')
        )
      })
      .json<github.SearchReposResponse>()
  }

  /**
 * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

`q=ruby+is:featured`

This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
 */
  @aiFunction({
    name: 'github_search_topics',
    description: `Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the \`text-match\` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\`q=ruby+is:featured\`

This query searches for topics with the keyword \`ruby\` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.`,
    inputSchema: github.SearchTopicsParamsSchema,
    tags: ['search']
  })
  async searchTopics(
    params: github.SearchTopicsParams
  ): Promise<github.SearchTopicsResponse> {
    return this.ky
      .get('/search/topics', {
        searchParams: sanitizeSearchParams(
          pick(params, 'q', 'per_page', 'page')
        )
      })
      .json<github.SearchTopicsResponse>()
  }

  /**
 * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you're looking for a list of popular users, you might try this query:

`q=tom+repos:%3E42+followers:%3E1000`

This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).".
 */
  @aiFunction({
    name: 'github_search_users',
    description: `Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the \`text-match\` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you're looking for a list of popular users, you might try this query:

\`q=tom+repos:%3E42+followers:%3E1000\`

This query searches for users with the name \`tom\`. The results are restricted to users with more than 42 repositories and over 1,000 followers.

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).".`,
    inputSchema: github.SearchUsersParamsSchema,
    tags: ['search']
  })
  async searchUsers(
    params: github.SearchUsersParams
  ): Promise<github.SearchUsersResponse> {
    return this.ky
      .get('/search/users', {
        searchParams: sanitizeSearchParams(
          pick(params, 'q', 'sort', 'order', 'per_page', 'page')
        )
      })
      .json<github.SearchUsersResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.
 */
  @aiFunction({
    name: 'github_teams_get_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.`,
    inputSchema: github.TeamsGetLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsGetLegacy(
    params: github.TeamsGetLegacyParams
  ): Promise<github.TeamsGetLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}`)
      .json<github.TeamsGetLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.
 */
  @aiFunction({
    name: 'github_teams_delete_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.`,
    inputSchema: github.TeamsDeleteLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteLegacy(
    params: github.TeamsDeleteLegacyParams
  ): Promise<github.TeamsDeleteLegacyResponse> {
    return this.ky
      .delete(`/teams/${params.team_id}`)
      .json<github.TeamsDeleteLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> With nested teams, the `privacy` for parent teams cannot be `secret`.
 */
  @aiFunction({
    name: 'github_teams_update_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> With nested teams, the \`privacy\` for parent teams cannot be \`secret\`.`,
    inputSchema: github.TeamsUpdateLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateLegacy(
    params: github.TeamsUpdateLegacyParams
  ): Promise<github.TeamsUpdateLegacyResponse> {
    return this.ky
      .patch(`/teams/${params.team_id}`, {
        json: pick(
          params,
          'name',
          'description',
          'privacy',
          'notification_setting',
          'permission',
          'parent_team_id'
        )
      })
      .json<github.TeamsUpdateLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.

List all discussions on a team's page.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_discussions_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List discussions\`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.

List all discussions on a team's page.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsListDiscussionsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListDiscussionsLegacy(
    params: github.TeamsListDiscussionsLegacyParams
  ): Promise<github.TeamsListDiscussionsLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/discussions`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'direction', 'per_page', 'page')
        )
      })
      .json<github.TeamsListDiscussionsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.

Creates a new discussion post on a team's page.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_create_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`Create a discussion\`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.

Creates a new discussion post on a team's page.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsCreateDiscussionLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsCreateDiscussionLegacy(
    params: github.TeamsCreateDiscussionLegacyParams
  ): Promise<github.TeamsCreateDiscussionLegacyResponse> {
    return this.ky
      .post(`/teams/${params.team_id}/discussions`, {
        json: pick(params, 'title', 'body', 'private')
      })
      .json<github.TeamsCreateDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.

Get a specific discussion on a team's page.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_get_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.

Get a specific discussion on a team's page.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsGetDiscussionLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsGetDiscussionLegacy(
    params: github.TeamsGetDiscussionLegacyParams
  ): Promise<github.TeamsGetDiscussionLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/discussions/${params.discussion_number}`,
        {}
      )
      .json<github.TeamsGetDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.

Delete a discussion from a team's page.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_delete_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`Delete a discussion\`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.

Delete a discussion from a team's page.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsDeleteDiscussionLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteDiscussionLegacy(
    params: github.TeamsDeleteDiscussionLegacyParams
  ): Promise<github.TeamsDeleteDiscussionLegacyResponse> {
    return this.ky
      .delete(
        `/teams/${params.team_id}/discussions/${params.discussion_number}`,
        {}
      )
      .json<github.TeamsDeleteDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.

Edits the title and body text of a discussion post. Only the parameters you provide are updated.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_update_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.

Edits the title and body text of a discussion post. Only the parameters you provide are updated.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsUpdateDiscussionLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateDiscussionLegacy(
    params: github.TeamsUpdateDiscussionLegacyParams
  ): Promise<github.TeamsUpdateDiscussionLegacyResponse> {
    return this.ky
      .patch(
        `/teams/${params.team_id}/discussions/${params.discussion_number}`,
        {
          json: pick(params, 'title', 'body')
        }
      )
      .json<github.TeamsUpdateDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.

List all comments on a team discussion.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_discussion_comments_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.

List all comments on a team discussion.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsListDiscussionCommentsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListDiscussionCommentsLegacy(
    params: github.TeamsListDiscussionCommentsLegacyParams
  ): Promise<github.TeamsListDiscussionCommentsLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'direction', 'per_page', 'page')
          )
        }
      )
      .json<github.TeamsListDiscussionCommentsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.

Creates a new comment on a team discussion.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_create_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.

Creates a new comment on a team discussion.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsCreateDiscussionCommentLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsCreateDiscussionCommentLegacy(
    params: github.TeamsCreateDiscussionCommentLegacyParams
  ): Promise<github.TeamsCreateDiscussionCommentLegacyResponse> {
    return this.ky
      .post(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.TeamsCreateDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.

Get a specific comment on a team discussion.

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_get_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.

Get a specific comment on a team discussion.

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsGetDiscussionCommentLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsGetDiscussionCommentLegacy(
    params: github.TeamsGetDiscussionCommentLegacyParams
  ): Promise<github.TeamsGetDiscussionCommentLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {}
      )
      .json<github.TeamsGetDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.

Deletes a comment on a team discussion.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_delete_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.

Deletes a comment on a team discussion.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsDeleteDiscussionCommentLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsDeleteDiscussionCommentLegacy(
    params: github.TeamsDeleteDiscussionCommentLegacyParams
  ): Promise<github.TeamsDeleteDiscussionCommentLegacyResponse> {
    return this.ky
      .delete(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {}
      )
      .json<github.TeamsDeleteDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.

Edits the body text of a discussion comment.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_teams_update_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.

Edits the body text of a discussion comment.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.TeamsUpdateDiscussionCommentLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsUpdateDiscussionCommentLegacy(
    params: github.TeamsUpdateDiscussionCommentLegacyParams
  ): Promise<github.TeamsUpdateDiscussionCommentLegacyResponse> {
    return this.ky
      .patch(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments/${params.comment_number}`,
        {
          json: pick(params, 'body')
        }
      )
      .json<github.TeamsUpdateDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.

List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_list_for_team_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List reactions for a team discussion comment\`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.

List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsListForTeamDiscussionCommentLegacyParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForTeamDiscussionCommentLegacy(
    params: github.ReactionsListForTeamDiscussionCommentLegacyParams
  ): Promise<github.ReactionsListForTeamDiscussionCommentLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments/${params.comment_number}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForTeamDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.

Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_create_for_team_discussion_comment_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.

Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).

A response with an HTTP \`200\` status means that you already added the reaction type to this team discussion comment.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema:
      github.ReactionsCreateForTeamDiscussionCommentLegacyParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForTeamDiscussionCommentLegacy(
    params: github.ReactionsCreateForTeamDiscussionCommentLegacyParams
  ): Promise<github.ReactionsCreateForTeamDiscussionCommentLegacyResponse> {
    return this.ky
      .post(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/comments/${params.comment_number}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForTeamDiscussionCommentLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.

List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_list_for_team_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List reactions for a team discussion\`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.

List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

OAuth app tokens and personal access tokens (classic) need the \`read:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsListForTeamDiscussionLegacyParamsSchema,
    tags: ['reactions']
  })
  async reactionsListForTeamDiscussionLegacy(
    params: github.ReactionsListForTeamDiscussionLegacyParams
  ): Promise<github.ReactionsListForTeamDiscussionLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/reactions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'content', 'per_page', 'page')
          )
        }
      )
      .json<github.ReactionsListForTeamDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.

Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

A response with an HTTP `200` status means that you already added the reaction type to this team discussion.

OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_reactions_create_for_team_discussion_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`Create reaction for a team discussion\`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.

Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).

A response with an HTTP \`200\` status means that you already added the reaction type to this team discussion.

OAuth app tokens and personal access tokens (classic) need the \`write:discussion\` scope to use this endpoint.`,
    inputSchema: github.ReactionsCreateForTeamDiscussionLegacyParamsSchema,
    tags: ['reactions']
  })
  async reactionsCreateForTeamDiscussionLegacy(
    params: github.ReactionsCreateForTeamDiscussionLegacyParams
  ): Promise<github.ReactionsCreateForTeamDiscussionLegacyResponse> {
    return this.ky
      .post(
        `/teams/${params.team_id}/discussions/${params.discussion_number}/reactions`,
        {
          json: pick(params, 'content')
        }
      )
      .json<github.ReactionsCreateForTeamDiscussionLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.

The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
 */
  @aiFunction({
    name: 'github_teams_list_pending_invitations_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List pending team invitations\`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.

The return hash contains a \`role\` field which refers to the Organization Invitation role and will be one of the following values: \`direct_member\`, \`admin\`, \`billing_manager\`, \`hiring_manager\`, or \`reinstate\`. If the invitee is not a GitHub member, the \`login\` field in the return hash will be \`null\`.`,
    inputSchema: github.TeamsListPendingInvitationsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListPendingInvitationsLegacy(
    params: github.TeamsListPendingInvitationsLegacyParams
  ): Promise<github.TeamsListPendingInvitationsLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/invitations`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListPendingInvitationsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.

Team members will include the members of child teams.
 */
  @aiFunction({
    name: 'github_teams_list_members_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List team members\`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.

Team members will include the members of child teams.`,
    inputSchema: github.TeamsListMembersLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListMembersLegacy(
    params: github.TeamsListMembersLegacyParams
  ): Promise<github.TeamsListMembersLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/members`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'role', 'per_page', 'page')
        )
      })
      .json<github.TeamsListMembersLegacyResponse>()
  }

  /**
 * The "Get team member" endpoint (described below) is closing down.

We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.
 */
  @aiFunction({
    name: 'github_teams_get_member_legacy',
    description: `The "Get team member" endpoint (described below) is closing down.

We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.`,
    inputSchema: github.TeamsGetMemberLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsGetMemberLegacy(
    params: github.TeamsGetMemberLegacyParams
  ): Promise<github.TeamsGetMemberLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/members/${params.username}`, {})
      .json<github.TeamsGetMemberLegacyResponse>()
  }

  /**
 * The "Add team member" endpoint (described below) is closing down.

We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
 */
  @aiFunction({
    name: 'github_teams_add_member_legacy',
    description: `The "Add team member" endpoint (described below) is closing down.

We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

Note that you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.TeamsAddMemberLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsAddMemberLegacy(
    params: github.TeamsAddMemberLegacyParams
  ): Promise<github.TeamsAddMemberLegacyResponse> {
    return this.ky
      .put(`/teams/${params.team_id}/members/${params.username}`, {})
      .json<github.TeamsAddMemberLegacyResponse>()
  }

  /**
 * The "Remove team member" endpoint (described below) is closing down.

We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).".
 */
  @aiFunction({
    name: 'github_teams_remove_member_legacy',
    description: `The "Remove team member" endpoint (described below) is closing down.

We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).".`,
    inputSchema: github.TeamsRemoveMemberLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveMemberLegacy(
    params: github.TeamsRemoveMemberLegacyParams
  ): Promise<github.TeamsRemoveMemberLegacyResponse> {
    return this.ky
      .delete(`/teams/${params.team_id}/members/${params.username}`, {})
      .json<github.TeamsRemoveMemberLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:**
The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
 */
  @aiFunction({
    name: 'github_teams_get_membership_for_user_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:**
The response contains the \`state\` of the membership and the member's \`role\`.

The \`role\` for organization owners is set to \`maintainer\`. For more information about \`maintainer\` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).`,
    inputSchema: github.TeamsGetMembershipForUserLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsGetMembershipForUserLegacy(
    params: github.TeamsGetMembershipForUserLegacyParams
  ): Promise<github.TeamsGetMembershipForUserLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/memberships/${params.username}`, {})
      .json<github.TeamsGetMembershipForUserLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
 */
  @aiFunction({
    name: 'github_teams_add_or_update_membership_for_user_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.`,
    inputSchema: github.TeamsAddOrUpdateMembershipForUserLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateMembershipForUserLegacy(
    params: github.TeamsAddOrUpdateMembershipForUserLegacyParams
  ): Promise<github.TeamsAddOrUpdateMembershipForUserLegacyResponse> {
    return this.ky
      .put(`/teams/${params.team_id}/memberships/${params.username}`, {
        json: pick(params, 'role')
      })
      .json<github.TeamsAddOrUpdateMembershipForUserLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).".
 */
  @aiFunction({
    name: 'github_teams_remove_membership_for_user_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).".`,
    inputSchema: github.TeamsRemoveMembershipForUserLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveMembershipForUserLegacy(
    params: github.TeamsRemoveMembershipForUserLegacyParams
  ): Promise<github.TeamsRemoveMembershipForUserLegacyResponse> {
    return this.ky
      .delete(
        `/teams/${params.team_id}/memberships/${params.username}`,
        {}
      )
      .json<github.TeamsRemoveMembershipForUserLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_list_projects_legacy',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsListProjectsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListProjectsLegacy(
    params: github.TeamsListProjectsLegacyParams
  ): Promise<github.TeamsListProjectsLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/projects`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListProjectsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_check_permissions_for_project_legacy',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsCheckPermissionsForProjectLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsCheckPermissionsForProjectLegacy(
    params: github.TeamsCheckPermissionsForProjectLegacyParams
  ): Promise<github.TeamsCheckPermissionsForProjectLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/projects/${params.project_id}`, {})
      .json<github.TeamsCheckPermissionsForProjectLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_add_or_update_project_permissions_legacy',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsAddOrUpdateProjectPermissionsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateProjectPermissionsLegacy(
    params: github.TeamsAddOrUpdateProjectPermissionsLegacyParams
  ): Promise<github.TeamsAddOrUpdateProjectPermissionsLegacyResponse> {
    return this.ky
      .put(`/teams/${params.team_id}/projects/${params.project_id}`, {
        json: pick(params, 'permission')
      })
      .json<github.TeamsAddOrUpdateProjectPermissionsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_teams_remove_project_legacy',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.TeamsRemoveProjectLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveProjectLegacy(
    params: github.TeamsRemoveProjectLegacyParams
  ): Promise<github.TeamsRemoveProjectLegacyResponse> {
    return this.ky
      .delete(
        `/teams/${params.team_id}/projects/${params.project_id}`,
        {}
      )
      .json<github.TeamsRemoveProjectLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_repos_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.`,
    inputSchema: github.TeamsListReposLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListReposLegacy(
    params: github.TeamsListReposLegacyParams
  ): Promise<github.TeamsListReposLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/repos`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListReposLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.

> [!NOTE]
> Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:.
 */
  @aiFunction({
    name: 'github_teams_check_permissions_for_repo_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.

> [!NOTE]
> Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the \`Accept\` header:.`,
    inputSchema: github.TeamsCheckPermissionsForRepoLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsCheckPermissionsForRepoLegacy(
    params: github.TeamsCheckPermissionsForRepoLegacyParams
  ): Promise<github.TeamsCheckPermissionsForRepoLegacyResponse> {
    return this.ky
      .get(
        `/teams/${params.team_id}/repos/${params.owner}/${params.repo}`,
        {}
      )
      .json<github.TeamsCheckPermissionsForRepoLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
 */
  @aiFunction({
    name: 'github_teams_add_or_update_repo_permissions_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a \`422 Unprocessable Entity\` status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.TeamsAddOrUpdateRepoPermissionsLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsAddOrUpdateRepoPermissionsLegacy(
    params: github.TeamsAddOrUpdateRepoPermissionsLegacyParams
  ): Promise<github.TeamsAddOrUpdateRepoPermissionsLegacyResponse> {
    return this.ky
      .put(
        `/teams/${params.team_id}/repos/${params.owner}/${params.repo}`,
        {
          json: pick(params, 'permission')
        }
      )
      .json<github.TeamsAddOrUpdateRepoPermissionsLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
 */
  @aiFunction({
    name: 'github_teams_remove_repo_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.`,
    inputSchema: github.TeamsRemoveRepoLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsRemoveRepoLegacy(
    params: github.TeamsRemoveRepoLegacyParams
  ): Promise<github.TeamsRemoveRepoLegacyResponse> {
    return this.ky
      .delete(
        `/teams/${params.team_id}/repos/${params.owner}/${params.repo}`,
        {}
      )
      .json<github.TeamsRemoveRepoLegacyResponse>()
  }

  /**
 * > [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.
 */
  @aiFunction({
    name: 'github_teams_list_child_legacy',
    description: `> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [\`List child teams\`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.`,
    inputSchema: github.TeamsListChildLegacyParamsSchema,
    tags: ['teams']
  })
  async teamsListChildLegacy(
    params: github.TeamsListChildLegacyParams
  ): Promise<github.TeamsListChildLegacyResponse> {
    return this.ky
      .get(`/teams/${params.team_id}/teams`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListChildLegacyResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
   */
  @aiFunction({
    name: 'github_users_get_authenticated',
    description: `OAuth app tokens and personal access tokens (classic) need the \`user\` scope in order for the response to include private profile information.`,
    inputSchema: github.UsersGetAuthenticatedParamsSchema,
    tags: ['users']
  })
  async usersGetAuthenticated(
    _params: github.UsersGetAuthenticatedParams
  ): Promise<github.UsersGetAuthenticatedResponse> {
    return this.ky.get('/user').json<github.UsersGetAuthenticatedResponse>()
  }

  /**
   * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
   */
  @aiFunction({
    name: 'github_users_update_authenticated',
    description: `**Note:** If your email is set to private and you send an \`email\` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.`,
    inputSchema: github.UsersUpdateAuthenticatedParamsSchema,
    tags: ['users']
  })
  async usersUpdateAuthenticated(
    params: github.UsersUpdateAuthenticatedParams
  ): Promise<github.UsersUpdateAuthenticatedResponse> {
    return this.ky
      .patch('/user', {
        json: pick(
          params,
          'name',
          'email',
          'blog',
          'twitter_username',
          'company',
          'location',
          'hireable',
          'bio'
        )
      })
      .json<github.UsersUpdateAuthenticatedResponse>()
  }

  /**
   * List the users you've blocked on your personal account.
   */
  @aiFunction({
    name: 'github_users_list_blocked_by_authenticated_user',
    description: `List the users you've blocked on your personal account.`,
    inputSchema: github.UsersListBlockedByAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListBlockedByAuthenticatedUser(
    params: github.UsersListBlockedByAuthenticatedUserParams
  ): Promise<github.UsersListBlockedByAuthenticatedUserResponse> {
    return this.ky
      .get('/user/blocks', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListBlockedByAuthenticatedUserResponse>()
  }

  /**
   * Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
   */
  @aiFunction({
    name: 'github_users_check_blocked',
    description: `Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.`,
    inputSchema: github.UsersCheckBlockedParamsSchema,
    tags: ['users']
  })
  async usersCheckBlocked(
    params: github.UsersCheckBlockedParams
  ): Promise<github.UsersCheckBlockedResponse> {
    return this.ky
      .get(`/user/blocks/${params.username}`)
      .json<github.UsersCheckBlockedResponse>()
  }

  /**
   * Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
   */
  @aiFunction({
    name: 'github_users_block',
    description: `Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.`,
    inputSchema: github.UsersBlockParamsSchema,
    tags: ['users']
  })
  async usersBlock(
    params: github.UsersBlockParams
  ): Promise<github.UsersBlockResponse> {
    return this.ky
      .put(`/user/blocks/${params.username}`)
      .json<github.UsersBlockResponse>()
  }

  /**
   * Unblocks the given user and returns a 204.
   */
  @aiFunction({
    name: 'github_users_unblock',
    description: `Unblocks the given user and returns a 204.`,
    inputSchema: github.UsersUnblockParamsSchema,
    tags: ['users']
  })
  async usersUnblock(
    params: github.UsersUnblockParams
  ): Promise<github.UsersUnblockResponse> {
    return this.ky
      .delete(`/user/blocks/${params.username}`)
      .json<github.UsersUnblockResponse>()
  }

  /**
 * Lists the authenticated user's codespaces.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_for_authenticated_user',
    description: `Lists the authenticated user's codespaces.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListForAuthenticatedUser(
    params: github.CodespacesListForAuthenticatedUserParams
  ): Promise<github.CodespacesListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/codespaces', {
        searchParams: sanitizeSearchParams(
          pick(params, 'per_page', 'page', 'repository_id')
        )
      })
      .json<github.CodespacesListForAuthenticatedUserResponse>()
  }

  /**
 * Creates a new codespace, owned by the authenticated user.

This endpoint requires either a `repository_id` OR a `pull_request` but not both.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_create_for_authenticated_user',
    description: `Creates a new codespace, owned by the authenticated user.

This endpoint requires either a \`repository_id\` OR a \`pull_request\` but not both.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.CodespacesCreateForAuthenticatedUserParamsSchema as any,
    tags: ['codespaces']
  })
  async codespacesCreateForAuthenticatedUser(
    params: github.CodespacesCreateForAuthenticatedUserParams
  ): Promise<github.CodespacesCreateForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/codespaces', {
        json: params
      })
      .json<github.CodespacesCreateForAuthenticatedUserResponse>()
  }

  /**
 * Lists all development environment secrets available for a user's codespaces without revealing their
encrypted values.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_secrets_for_authenticated_user',
    description: `Lists all development environment secrets available for a user's codespaces without revealing their
encrypted values.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema: github.CodespacesListSecretsForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListSecretsForAuthenticatedUser(
    params: github.CodespacesListSecretsForAuthenticatedUserParams
  ): Promise<github.CodespacesListSecretsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/codespaces/secrets', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.CodespacesListSecretsForAuthenticatedUserResponse>()
  }

  /**
 * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_public_key_for_authenticated_user',
    description: `Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetPublicKeyForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetPublicKeyForAuthenticatedUser(
    _params: github.CodespacesGetPublicKeyForAuthenticatedUserParams
  ): Promise<github.CodespacesGetPublicKeyForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/codespaces/secrets/public-key')
      .json<github.CodespacesGetPublicKeyForAuthenticatedUserResponse>()
  }

  /**
 * Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_secret_for_authenticated_user',
    description: `Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetSecretForAuthenticatedUser(
    params: github.CodespacesGetSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesGetSecretForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/codespaces/secrets/${params.secret_name}`)
      .json<github.CodespacesGetSecretForAuthenticatedUserResponse>()
  }

  /**
 * Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_create_or_update_secret_for_authenticated_user',
    description: `Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesCreateOrUpdateSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCreateOrUpdateSecretForAuthenticatedUser(
    params: github.CodespacesCreateOrUpdateSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesCreateOrUpdateSecretForAuthenticatedUserResponse> {
    return this.ky
      .put(`/user/codespaces/secrets/${params.secret_name}`, {
        json: pick(
          params,
          'encrypted_value',
          'key_id',
          'selected_repository_ids'
        )
      })
      .json<github.CodespacesCreateOrUpdateSecretForAuthenticatedUserResponse>()
  }

  /**
 * Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_delete_secret_for_authenticated_user',
    description: `Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema: github.CodespacesDeleteSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteSecretForAuthenticatedUser(
    params: github.CodespacesDeleteSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesDeleteSecretForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/codespaces/secrets/${params.secret_name}`)
      .json<github.CodespacesDeleteSecretForAuthenticatedUserResponse>()
  }

  /**
 * List the repositories that have been granted the ability to use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_list_repositories_for_secret_for_authenticated_user',
    description: `List the repositories that have been granted the ability to use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesListRepositoriesForSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesListRepositoriesForSecretForAuthenticatedUser(
    params: github.CodespacesListRepositoriesForSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesListRepositoriesForSecretForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/codespaces/secrets/${params.secret_name}/repositories`)
      .json<github.CodespacesListRepositoriesForSecretForAuthenticatedUserResponse>()
  }

  /**
 * Select the repositories that will use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_set_repositories_for_secret_for_authenticated_user',
    description: `Select the repositories that will use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesSetRepositoriesForSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesSetRepositoriesForSecretForAuthenticatedUser(
    params: github.CodespacesSetRepositoriesForSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesSetRepositoriesForSecretForAuthenticatedUserResponse> {
    return this.ky
      .put(`/user/codespaces/secrets/${params.secret_name}/repositories`, {
        json: pick(params, 'selected_repository_ids')
      })
      .json<github.CodespacesSetRepositoriesForSecretForAuthenticatedUserResponse>()
  }

  /**
 * Adds a repository to the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_add_repository_for_secret_for_authenticated_user',
    description: `Adds a repository to the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesAddRepositoryForSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesAddRepositoryForSecretForAuthenticatedUser(
    params: github.CodespacesAddRepositoryForSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesAddRepositoryForSecretForAuthenticatedUserResponse> {
    return this.ky
      .put(
        `/user/codespaces/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.CodespacesAddRepositoryForSecretForAuthenticatedUserResponse>()
  }

  /**
 * Removes a repository from the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_remove_repository_for_secret_for_authenticated_user',
    description: `Removes a repository from the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` or \`codespace:secrets\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesRemoveRepositoryForSecretForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesRemoveRepositoryForSecretForAuthenticatedUser(
    params: github.CodespacesRemoveRepositoryForSecretForAuthenticatedUserParams
  ): Promise<github.CodespacesRemoveRepositoryForSecretForAuthenticatedUserResponse> {
    return this.ky
      .delete(
        `/user/codespaces/secrets/${params.secret_name}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.CodespacesRemoveRepositoryForSecretForAuthenticatedUserResponse>()
  }

  /**
 * Gets information about a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_for_authenticated_user',
    description: `Gets information about a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesGetForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetForAuthenticatedUser(
    params: github.CodespacesGetForAuthenticatedUserParams
  ): Promise<github.CodespacesGetForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/codespaces/${params.codespace_name}`)
      .json<github.CodespacesGetForAuthenticatedUserResponse>()
  }

  /**
 * Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_delete_for_authenticated_user',
    description: `Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesDeleteForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesDeleteForAuthenticatedUser(
    params: github.CodespacesDeleteForAuthenticatedUserParams
  ): Promise<github.CodespacesDeleteForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/codespaces/${params.codespace_name}`)
      .json<github.CodespacesDeleteForAuthenticatedUserResponse>()
  }

  /**
 * Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_update_for_authenticated_user',
    description: `Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesUpdateForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesUpdateForAuthenticatedUser(
    params: github.CodespacesUpdateForAuthenticatedUserParams
  ): Promise<github.CodespacesUpdateForAuthenticatedUserResponse> {
    return this.ky
      .patch(`/user/codespaces/${params.codespace_name}`, {
        json: pick(params, 'machine', 'display_name', 'recent_folders')
      })
      .json<github.CodespacesUpdateForAuthenticatedUserResponse>()
  }

  /**
 * Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_export_for_authenticated_user',
    description: `Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesExportForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesExportForAuthenticatedUser(
    params: github.CodespacesExportForAuthenticatedUserParams
  ): Promise<github.CodespacesExportForAuthenticatedUserResponse> {
    return this.ky
      .post(`/user/codespaces/${params.codespace_name}/exports`)
      .json<github.CodespacesExportForAuthenticatedUserResponse>()
  }

  /**
 * Gets information about an export of a codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_get_export_details_for_authenticated_user',
    description: `Gets information about an export of a codespace.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesGetExportDetailsForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesGetExportDetailsForAuthenticatedUser(
    params: github.CodespacesGetExportDetailsForAuthenticatedUserParams
  ): Promise<github.CodespacesGetExportDetailsForAuthenticatedUserResponse> {
    return this.ky
      .get(
        `/user/codespaces/${params.codespace_name}/exports/${params.export_id}`,
        {}
      )
      .json<github.CodespacesGetExportDetailsForAuthenticatedUserResponse>()
  }

  /**
 * List the machine types a codespace can transition to use.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_codespace_machines_for_authenticated_user',
    description: `List the machine types a codespace can transition to use.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema:
      github.CodespacesCodespaceMachinesForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesCodespaceMachinesForAuthenticatedUser(
    params: github.CodespacesCodespaceMachinesForAuthenticatedUserParams
  ): Promise<github.CodespacesCodespaceMachinesForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/codespaces/${params.codespace_name}/machines`)
      .json<github.CodespacesCodespaceMachinesForAuthenticatedUserResponse>()
  }

  /**
 * Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_publish_for_authenticated_user',
    description: `Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesPublishForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesPublishForAuthenticatedUser(
    params: github.CodespacesPublishForAuthenticatedUserParams
  ): Promise<github.CodespacesPublishForAuthenticatedUserResponse> {
    return this.ky
      .post(`/user/codespaces/${params.codespace_name}/publish`, {
        json: pick(params, 'name', 'private')
      })
      .json<github.CodespacesPublishForAuthenticatedUserResponse>()
  }

  /**
 * Starts a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_start_for_authenticated_user',
    description: `Starts a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesStartForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesStartForAuthenticatedUser(
    params: github.CodespacesStartForAuthenticatedUserParams
  ): Promise<github.CodespacesStartForAuthenticatedUserResponse> {
    return this.ky
      .post(`/user/codespaces/${params.codespace_name}/start`)
      .json<github.CodespacesStartForAuthenticatedUserResponse>()
  }

  /**
 * Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_codespaces_stop_for_authenticated_user',
    description: `Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the \`codespace\` scope to use this endpoint.`,
    inputSchema: github.CodespacesStopForAuthenticatedUserParamsSchema,
    tags: ['codespaces']
  })
  async codespacesStopForAuthenticatedUser(
    params: github.CodespacesStopForAuthenticatedUserParams
  ): Promise<github.CodespacesStopForAuthenticatedUserResponse> {
    return this.ky
      .post(`/user/codespaces/${params.codespace_name}/stop`)
      .json<github.CodespacesStopForAuthenticatedUserResponse>()
  }

  /**
 * Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_packages_list_docker_migration_conflicting_packages_for_authenticated_user',
    description: `Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint.`,
    inputSchema:
      github.PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesListDockerMigrationConflictingPackagesForAuthenticatedUser(
    _params: github.PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserParams
  ): Promise<github.PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/docker/conflicts')
      .json<github.PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserResponse>()
  }

  /**
   * Sets the visibility for your primary email addresses.
   */
  @aiFunction({
    name: 'github_users_set_primary_email_visibility_for_authenticated_user',
    description: `Sets the visibility for your primary email addresses.`,
    inputSchema:
      github.UsersSetPrimaryEmailVisibilityForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersSetPrimaryEmailVisibilityForAuthenticatedUser(
    params: github.UsersSetPrimaryEmailVisibilityForAuthenticatedUserParams
  ): Promise<github.UsersSetPrimaryEmailVisibilityForAuthenticatedUserResponse> {
    return this.ky
      .patch('/user/email/visibility', {
        json: params
      })
      .json<github.UsersSetPrimaryEmailVisibilityForAuthenticatedUserResponse>()
  }

  /**
 * Lists all of your email addresses, and specifies which one is visible
to the public.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_list_emails_for_authenticated_user',
    description: `Lists all of your email addresses, and specifies which one is visible
to the public.

OAuth app tokens and personal access tokens (classic) need the \`user:email\` scope to use this endpoint.`,
    inputSchema: github.UsersListEmailsForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListEmailsForAuthenticatedUser(
    params: github.UsersListEmailsForAuthenticatedUserParams
  ): Promise<github.UsersListEmailsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/emails', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListEmailsForAuthenticatedUserResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
   */
  @aiFunction({
    name: 'github_users_add_email_for_authenticated_user',
    description: `OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.UsersAddEmailForAuthenticatedUserParamsSchema as any,
    tags: ['users']
  })
  async usersAddEmailForAuthenticatedUser(
    params: github.UsersAddEmailForAuthenticatedUserParams
  ): Promise<github.UsersAddEmailForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/emails', {
        json: params
      })
      .json<github.UsersAddEmailForAuthenticatedUserResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
   */
  @aiFunction({
    name: 'github_users_delete_email_for_authenticated_user',
    description: `OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    // TODO: Improve handling of union params
    inputSchema: github.UsersDeleteEmailForAuthenticatedUserParamsSchema as any,
    tags: ['users']
  })
  async usersDeleteEmailForAuthenticatedUser(
    params: github.UsersDeleteEmailForAuthenticatedUserParams
  ): Promise<github.UsersDeleteEmailForAuthenticatedUserResponse> {
    return this.ky
      .delete('/user/emails', {
        json: params
      })
      .json<github.UsersDeleteEmailForAuthenticatedUserResponse>()
  }

  /**
   * Lists the people following the authenticated user.
   */
  @aiFunction({
    name: 'github_users_list_followers_for_authenticated_user',
    description: `Lists the people following the authenticated user.`,
    inputSchema: github.UsersListFollowersForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListFollowersForAuthenticatedUser(
    params: github.UsersListFollowersForAuthenticatedUserParams
  ): Promise<github.UsersListFollowersForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/followers', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListFollowersForAuthenticatedUserResponse>()
  }

  /**
   * Lists the people who the authenticated user follows.
   */
  @aiFunction({
    name: 'github_users_list_followed_by_authenticated_user',
    description: `Lists the people who the authenticated user follows.`,
    inputSchema: github.UsersListFollowedByAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListFollowedByAuthenticatedUser(
    params: github.UsersListFollowedByAuthenticatedUserParams
  ): Promise<github.UsersListFollowedByAuthenticatedUserResponse> {
    return this.ky
      .get('/user/following', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListFollowedByAuthenticatedUserResponse>()
  }

  /**
   * Check if a person is followed by the authenticated user.
   */
  @aiFunction({
    name: 'github_users_check_person_is_followed_by_authenticated',
    description: `Check if a person is followed by the authenticated user.`,
    inputSchema: github.UsersCheckPersonIsFollowedByAuthenticatedParamsSchema,
    tags: ['users']
  })
  async usersCheckPersonIsFollowedByAuthenticated(
    params: github.UsersCheckPersonIsFollowedByAuthenticatedParams
  ): Promise<github.UsersCheckPersonIsFollowedByAuthenticatedResponse> {
    return this.ky
      .get(`/user/following/${params.username}`)
      .json<github.UsersCheckPersonIsFollowedByAuthenticatedResponse>()
  }

  /**
 * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_follow',
    description: `Note that you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

OAuth app tokens and personal access tokens (classic) need the \`user:follow\` scope to use this endpoint.`,
    inputSchema: github.UsersFollowParamsSchema,
    tags: ['users']
  })
  async usersFollow(
    params: github.UsersFollowParams
  ): Promise<github.UsersFollowResponse> {
    return this.ky
      .put(`/user/following/${params.username}`)
      .json<github.UsersFollowResponse>()
  }

  /**
   * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
   */
  @aiFunction({
    name: 'github_users_unfollow',
    description: `OAuth app tokens and personal access tokens (classic) need the \`user:follow\` scope to use this endpoint.`,
    inputSchema: github.UsersUnfollowParamsSchema,
    tags: ['users']
  })
  async usersUnfollow(
    params: github.UsersUnfollowParams
  ): Promise<github.UsersUnfollowResponse> {
    return this.ky
      .delete(`/user/following/${params.username}`)
      .json<github.UsersUnfollowResponse>()
  }

  /**
 * Lists the current user's GPG keys.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_list_gpg_keys_for_authenticated_user',
    description: `Lists the current user's GPG keys.

OAuth app tokens and personal access tokens (classic) need the \`read:gpg_key\` scope to use this endpoint.`,
    inputSchema: github.UsersListGpgKeysForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListGpgKeysForAuthenticatedUser(
    params: github.UsersListGpgKeysForAuthenticatedUserParams
  ): Promise<github.UsersListGpgKeysForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/gpg_keys', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListGpgKeysForAuthenticatedUserResponse>()
  }

  /**
 * Adds a GPG key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_create_gpg_key_for_authenticated_user',
    description: `Adds a GPG key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`write:gpg_key\` scope to use this endpoint.`,
    inputSchema: github.UsersCreateGpgKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersCreateGpgKeyForAuthenticatedUser(
    params: github.UsersCreateGpgKeyForAuthenticatedUserParams
  ): Promise<github.UsersCreateGpgKeyForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/gpg_keys', {
        json: pick(params, 'name', 'armored_public_key')
      })
      .json<github.UsersCreateGpgKeyForAuthenticatedUserResponse>()
  }

  /**
 * View extended details for a single GPG key.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_get_gpg_key_for_authenticated_user',
    description: `View extended details for a single GPG key.

OAuth app tokens and personal access tokens (classic) need the \`read:gpg_key\` scope to use this endpoint.`,
    inputSchema: github.UsersGetGpgKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersGetGpgKeyForAuthenticatedUser(
    params: github.UsersGetGpgKeyForAuthenticatedUserParams
  ): Promise<github.UsersGetGpgKeyForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/gpg_keys/${params.gpg_key_id}`)
      .json<github.UsersGetGpgKeyForAuthenticatedUserResponse>()
  }

  /**
 * Removes a GPG key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_delete_gpg_key_for_authenticated_user',
    description: `Removes a GPG key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`admin:gpg_key\` scope to use this endpoint.`,
    inputSchema: github.UsersDeleteGpgKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersDeleteGpgKeyForAuthenticatedUser(
    params: github.UsersDeleteGpgKeyForAuthenticatedUserParams
  ): Promise<github.UsersDeleteGpgKeyForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/gpg_keys/${params.gpg_key_id}`)
      .json<github.UsersDeleteGpgKeyForAuthenticatedUserResponse>()
  }

  /**
 * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the `permissions` key.
 */
  @aiFunction({
    name: 'github_apps_list_installations_for_authenticated_user',
    description: `Lists installations of your GitHub App that the authenticated user has explicit permission (\`:read\`, \`:write\`, or \`:admin\`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the \`permissions\` key.`,
    inputSchema: github.AppsListInstallationsForAuthenticatedUserParamsSchema,
    tags: ['apps']
  })
  async appsListInstallationsForAuthenticatedUser(
    params: github.AppsListInstallationsForAuthenticatedUserParams
  ): Promise<github.AppsListInstallationsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/installations', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListInstallationsForAuthenticatedUserResponse>()
  }

  /**
 * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

The access the user has to each repository is included in the hash under the `permissions` key.
 */
  @aiFunction({
    name: 'github_apps_list_installation_repos_for_authenticated_user',
    description: `List repositories that the authenticated user has explicit permission (\`:read\`, \`:write\`, or \`:admin\`) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

The access the user has to each repository is included in the hash under the \`permissions\` key.`,
    inputSchema:
      github.AppsListInstallationReposForAuthenticatedUserParamsSchema,
    tags: ['apps']
  })
  async appsListInstallationReposForAuthenticatedUser(
    params: github.AppsListInstallationReposForAuthenticatedUserParams
  ): Promise<github.AppsListInstallationReposForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/installations/${params.installation_id}/repositories`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListInstallationReposForAuthenticatedUserResponse>()
  }

  /**
 * Add a single repository to an installation. The authenticated user must have admin access to the repository.

This endpoint only works for PATs (classic) with the `repo` scope.
 */
  @aiFunction({
    name: 'github_apps_add_repo_to_installation_for_authenticated_user',
    description: `Add a single repository to an installation. The authenticated user must have admin access to the repository.

This endpoint only works for PATs (classic) with the \`repo\` scope.`,
    inputSchema:
      github.AppsAddRepoToInstallationForAuthenticatedUserParamsSchema,
    tags: ['apps']
  })
  async appsAddRepoToInstallationForAuthenticatedUser(
    params: github.AppsAddRepoToInstallationForAuthenticatedUserParams
  ): Promise<github.AppsAddRepoToInstallationForAuthenticatedUserResponse> {
    return this.ky
      .put(
        `/user/installations/${params.installation_id}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.AppsAddRepoToInstallationForAuthenticatedUserResponse>()
  }

  /**
 * Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.

This endpoint only works for PATs (classic) with the `repo` scope.
 */
  @aiFunction({
    name: 'github_apps_remove_repo_from_installation_for_authenticated_user',
    description: `Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the \`repository_selection\` of \`selected\`.

This endpoint only works for PATs (classic) with the \`repo\` scope.`,
    inputSchema:
      github.AppsRemoveRepoFromInstallationForAuthenticatedUserParamsSchema,
    tags: ['apps']
  })
  async appsRemoveRepoFromInstallationForAuthenticatedUser(
    params: github.AppsRemoveRepoFromInstallationForAuthenticatedUserParams
  ): Promise<github.AppsRemoveRepoFromInstallationForAuthenticatedUserResponse> {
    return this.ky
      .delete(
        `/user/installations/${params.installation_id}/repositories/${params.repository_id}`,
        {}
      )
      .json<github.AppsRemoveRepoFromInstallationForAuthenticatedUserResponse>()
  }

  /**
   * Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
   */
  @aiFunction({
    name: 'github_interactions_get_restrictions_for_authenticated_user',
    description: `Shows which type of GitHub user can interact with your public repositories and when the restriction expires.`,
    inputSchema:
      github.InteractionsGetRestrictionsForAuthenticatedUserParamsSchema,
    tags: ['interactions']
  })
  async interactionsGetRestrictionsForAuthenticatedUser(
    _params: github.InteractionsGetRestrictionsForAuthenticatedUserParams
  ): Promise<github.InteractionsGetRestrictionsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/interaction-limits')
      .json<github.InteractionsGetRestrictionsForAuthenticatedUserResponse>()
  }

  /**
   * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
   */
  @aiFunction({
    name: 'github_interactions_set_restrictions_for_authenticated_user',
    description: `Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.`,
    inputSchema:
      github.InteractionsSetRestrictionsForAuthenticatedUserParamsSchema,
    tags: ['interactions']
  })
  async interactionsSetRestrictionsForAuthenticatedUser(
    params: github.InteractionsSetRestrictionsForAuthenticatedUserParams
  ): Promise<github.InteractionsSetRestrictionsForAuthenticatedUserResponse> {
    return this.ky
      .put('/user/interaction-limits', {
        json: pick(params, 'limit', 'expiry')
      })
      .json<github.InteractionsSetRestrictionsForAuthenticatedUserResponse>()
  }

  /**
   * Removes any interaction restrictions from your public repositories.
   */
  @aiFunction({
    name: 'github_interactions_remove_restrictions_for_authenticated_user',
    description: `Removes any interaction restrictions from your public repositories.`,
    inputSchema:
      github.InteractionsRemoveRestrictionsForAuthenticatedUserParamsSchema,
    tags: ['interactions']
  })
  async interactionsRemoveRestrictionsForAuthenticatedUser(
    _params: github.InteractionsRemoveRestrictionsForAuthenticatedUserParams
  ): Promise<github.InteractionsRemoveRestrictionsForAuthenticatedUserResponse> {
    return this.ky
      .delete('/user/interaction-limits')
      .json<github.InteractionsRemoveRestrictionsForAuthenticatedUserResponse>()
  }

  /**
 * List issues across owned and member repositories assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
 */
  @aiFunction({
    name: 'github_issues_list_for_authenticated_user',
    description: `List issues across owned and member repositories assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the \`pull_request\` key. Be aware that the \`id\` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.raw+json\`**: Returns the raw markdown body. Response will include \`body\`. This is the default if you do not pass any specific media type.
- **\`application/vnd.github.text+json\`**: Returns a text only representation of the markdown body. Response will include \`body_text\`.
- **\`application/vnd.github.html+json\`**: Returns HTML rendered from the body's markdown. Response will include \`body_html\`.
- **\`application/vnd.github.full+json\`**: Returns raw, text, and HTML representations. Response will include \`body\`, \`body_text\`, and \`body_html\`.`,
    inputSchema: github.IssuesListForAuthenticatedUserParamsSchema,
    tags: ['issues']
  })
  async issuesListForAuthenticatedUser(
    params: github.IssuesListForAuthenticatedUserParams
  ): Promise<github.IssuesListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/issues', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'filter',
            'state',
            'labels',
            'sort',
            'direction',
            'since',
            'per_page',
            'page'
          )
        )
      })
      .json<github.IssuesListForAuthenticatedUserResponse>()
  }

  /**
 * Lists the public SSH keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_list_public_ssh_keys_for_authenticated_user',
    description: `Lists the public SSH keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`read:public_key\` scope to use this endpoint.`,
    inputSchema: github.UsersListPublicSshKeysForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListPublicSshKeysForAuthenticatedUser(
    params: github.UsersListPublicSshKeysForAuthenticatedUserParams
  ): Promise<github.UsersListPublicSshKeysForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/keys', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListPublicSshKeysForAuthenticatedUserResponse>()
  }

  /**
 * Adds a public SSH key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_create_public_ssh_key_for_authenticated_user',
    description: `Adds a public SSH key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`write:gpg_key\` scope to use this endpoint.`,
    inputSchema: github.UsersCreatePublicSshKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersCreatePublicSshKeyForAuthenticatedUser(
    params: github.UsersCreatePublicSshKeyForAuthenticatedUserParams
  ): Promise<github.UsersCreatePublicSshKeyForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/keys', {
        json: pick(params, 'title', 'key')
      })
      .json<github.UsersCreatePublicSshKeyForAuthenticatedUserResponse>()
  }

  /**
 * View extended details for a single public SSH key.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_get_public_ssh_key_for_authenticated_user',
    description: `View extended details for a single public SSH key.

OAuth app tokens and personal access tokens (classic) need the \`read:public_key\` scope to use this endpoint.`,
    inputSchema: github.UsersGetPublicSshKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersGetPublicSshKeyForAuthenticatedUser(
    params: github.UsersGetPublicSshKeyForAuthenticatedUserParams
  ): Promise<github.UsersGetPublicSshKeyForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/keys/${params.key_id}`)
      .json<github.UsersGetPublicSshKeyForAuthenticatedUserResponse>()
  }

  /**
 * Removes a public SSH key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_delete_public_ssh_key_for_authenticated_user',
    description: `Removes a public SSH key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`admin:public_key\` scope to use this endpoint.`,
    inputSchema: github.UsersDeletePublicSshKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersDeletePublicSshKeyForAuthenticatedUser(
    params: github.UsersDeletePublicSshKeyForAuthenticatedUserParams
  ): Promise<github.UsersDeletePublicSshKeyForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/keys/${params.key_id}`)
      .json<github.UsersDeletePublicSshKeyForAuthenticatedUserResponse>()
  }

  /**
   * Lists the active subscriptions for the authenticated user.
   */
  @aiFunction({
    name: 'github_apps_list_subscriptions_for_authenticated_user',
    description: `Lists the active subscriptions for the authenticated user.`,
    inputSchema: github.AppsListSubscriptionsForAuthenticatedUserParamsSchema,
    tags: ['apps']
  })
  async appsListSubscriptionsForAuthenticatedUser(
    params: github.AppsListSubscriptionsForAuthenticatedUserParams
  ): Promise<github.AppsListSubscriptionsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/marketplace_purchases', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListSubscriptionsForAuthenticatedUserResponse>()
  }

  /**
   * Lists the active subscriptions for the authenticated user.
   */
  @aiFunction({
    name: 'github_apps_list_subscriptions_for_authenticated_user_stubbed',
    description: `Lists the active subscriptions for the authenticated user.`,
    inputSchema:
      github.AppsListSubscriptionsForAuthenticatedUserStubbedParamsSchema,
    tags: ['apps']
  })
  async appsListSubscriptionsForAuthenticatedUserStubbed(
    params: github.AppsListSubscriptionsForAuthenticatedUserStubbedParams
  ): Promise<github.AppsListSubscriptionsForAuthenticatedUserStubbedResponse> {
    return this.ky
      .get('/user/marketplace_purchases/stubbed', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.AppsListSubscriptionsForAuthenticatedUserStubbedResponse>()
  }

  /**
   * Lists all of the authenticated user's organization memberships.
   */
  @aiFunction({
    name: 'github_orgs_list_memberships_for_authenticated_user',
    description: `Lists all of the authenticated user's organization memberships.`,
    inputSchema: github.OrgsListMembershipsForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsListMembershipsForAuthenticatedUser(
    params: github.OrgsListMembershipsForAuthenticatedUserParams
  ): Promise<github.OrgsListMembershipsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/memberships/orgs', {
        searchParams: sanitizeSearchParams(
          pick(params, 'state', 'per_page', 'page')
        )
      })
      .json<github.OrgsListMembershipsForAuthenticatedUserResponse>()
  }

  /**
   * If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.
   */
  @aiFunction({
    name: 'github_orgs_get_membership_for_authenticated_user',
    description: `If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a \`404\` is returned. This endpoint will return a \`403\` if the request is made by a GitHub App that is blocked by the organization.`,
    inputSchema: github.OrgsGetMembershipForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsGetMembershipForAuthenticatedUser(
    params: github.OrgsGetMembershipForAuthenticatedUserParams
  ): Promise<github.OrgsGetMembershipForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/memberships/orgs/${params.org}`)
      .json<github.OrgsGetMembershipForAuthenticatedUserResponse>()
  }

  /**
   * Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
   */
  @aiFunction({
    name: 'github_orgs_update_membership_for_authenticated_user',
    description: `Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.`,
    inputSchema: github.OrgsUpdateMembershipForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsUpdateMembershipForAuthenticatedUser(
    params: github.OrgsUpdateMembershipForAuthenticatedUserParams
  ): Promise<github.OrgsUpdateMembershipForAuthenticatedUserResponse> {
    return this.ky
      .patch(`/user/memberships/orgs/${params.org}`, {
        json: pick(params, 'state')
      })
      .json<github.OrgsUpdateMembershipForAuthenticatedUserResponse>()
  }

  /**
   * Lists all migrations a user has started.
   */
  @aiFunction({
    name: 'github_migrations_list_for_authenticated_user',
    description: `Lists all migrations a user has started.`,
    inputSchema: github.MigrationsListForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsListForAuthenticatedUser(
    params: github.MigrationsListForAuthenticatedUserParams
  ): Promise<github.MigrationsListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/migrations', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.MigrationsListForAuthenticatedUserResponse>()
  }

  /**
   * Initiates the generation of a user migration archive.
   */
  @aiFunction({
    name: 'github_migrations_start_for_authenticated_user',
    description: `Initiates the generation of a user migration archive.`,
    inputSchema: github.MigrationsStartForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsStartForAuthenticatedUser(
    params: github.MigrationsStartForAuthenticatedUserParams
  ): Promise<github.MigrationsStartForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/migrations', {
        json: pick(
          params,
          'lock_repositories',
          'exclude_metadata',
          'exclude_git_data',
          'exclude_attachments',
          'exclude_releases',
          'exclude_owner_projects',
          'org_metadata_only',
          'exclude',
          'repositories'
        )
      })
      .json<github.MigrationsStartForAuthenticatedUserResponse>()
  }

  /**
 * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:

*   `pending` - the migration hasn't started yet.
*   `exporting` - the migration is in progress.
*   `exported` - the migration finished successfully.
*   `failed` - the migration failed.

Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
 */
  @aiFunction({
    name: 'github_migrations_get_status_for_authenticated_user',
    description: `Fetches a single user migration. The response includes the \`state\` of the migration, which can be one of the following values:

*   \`pending\` - the migration hasn't started yet.
*   \`exporting\` - the migration is in progress.
*   \`exported\` - the migration finished successfully.
*   \`failed\` - the migration failed.

Once the migration has been \`exported\` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).`,
    inputSchema: github.MigrationsGetStatusForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetStatusForAuthenticatedUser(
    params: github.MigrationsGetStatusForAuthenticatedUserParams
  ): Promise<github.MigrationsGetStatusForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/migrations/${params.migration_id}`, {
        searchParams: sanitizeSearchParams(pick(params, 'exclude'))
      })
      .json<github.MigrationsGetStatusForAuthenticatedUserResponse>()
  }

  /**
 * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

*   attachments
*   bases
*   commit\_comments
*   issue\_comments
*   issue\_events
*   issues
*   milestones
*   organizations
*   projects
*   protected\_branches
*   pull\_request\_reviews
*   pull\_requests
*   releases
*   repositories
*   review\_comments
*   schema
*   users

The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.
 */
  @aiFunction({
    name: 'github_migrations_get_archive_for_authenticated_user',
    description: `Fetches the URL to download the migration archive as a \`tar.gz\` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

*   attachments
*   bases
*   commit\_comments
*   issue\_comments
*   issue\_events
*   issues
*   milestones
*   organizations
*   projects
*   protected\_branches
*   pull\_request\_reviews
*   pull\_requests
*   releases
*   repositories
*   review\_comments
*   schema
*   users

The archive will also contain an \`attachments\` directory that includes all attachment files uploaded to GitHub.com and a \`repositories\` directory that contains the repository's Git data.`,
    inputSchema: github.MigrationsGetArchiveForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsGetArchiveForAuthenticatedUser(
    params: github.MigrationsGetArchiveForAuthenticatedUserParams
  ): Promise<github.MigrationsGetArchiveForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/migrations/${params.migration_id}/archive`)
      .json<github.MigrationsGetArchiveForAuthenticatedUserResponse>()
  }

  /**
   * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
   */
  @aiFunction({
    name: 'github_migrations_delete_archive_for_authenticated_user',
    description: `Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.`,
    inputSchema: github.MigrationsDeleteArchiveForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsDeleteArchiveForAuthenticatedUser(
    params: github.MigrationsDeleteArchiveForAuthenticatedUserParams
  ): Promise<github.MigrationsDeleteArchiveForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/migrations/${params.migration_id}/archive`)
      .json<github.MigrationsDeleteArchiveForAuthenticatedUserResponse>()
  }

  /**
   * Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
   */
  @aiFunction({
    name: 'github_migrations_unlock_repo_for_authenticated_user',
    description: `Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of \`404 Not Found\` if the repository is not locked.`,
    inputSchema: github.MigrationsUnlockRepoForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsUnlockRepoForAuthenticatedUser(
    params: github.MigrationsUnlockRepoForAuthenticatedUserParams
  ): Promise<github.MigrationsUnlockRepoForAuthenticatedUserResponse> {
    return this.ky
      .delete(
        `/user/migrations/${params.migration_id}/repos/${params.repo_name}/lock`,
        {}
      )
      .json<github.MigrationsUnlockRepoForAuthenticatedUserResponse>()
  }

  /**
   * Lists all the repositories for this user migration.
   */
  @aiFunction({
    name: 'github_migrations_list_repos_for_authenticated_user',
    description: `Lists all the repositories for this user migration.`,
    inputSchema: github.MigrationsListReposForAuthenticatedUserParamsSchema,
    tags: ['migrations']
  })
  async migrationsListReposForAuthenticatedUser(
    params: github.MigrationsListReposForAuthenticatedUserParams
  ): Promise<github.MigrationsListReposForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/migrations/${params.migration_id}/repositories`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.MigrationsListReposForAuthenticatedUserResponse>()
  }

  /**
 * List organizations for the authenticated user.

For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.

> [!NOTE]
> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.
 */
  @aiFunction({
    name: 'github_orgs_list_for_authenticated_user',
    description: `List organizations for the authenticated user.

For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with \`read:org\` scope, you can publicize your organization membership with \`user\` scope, etc.). Therefore, this API requires at least \`user\` or \`read:org\` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a \`403 Forbidden\` response.

> [!NOTE]
> Requests using a fine-grained access token will receive a \`200 Success\` response with an empty list.`,
    inputSchema: github.OrgsListForAuthenticatedUserParamsSchema,
    tags: ['orgs']
  })
  async orgsListForAuthenticatedUser(
    params: github.OrgsListForAuthenticatedUserParams
  ): Promise<github.OrgsListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/orgs', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListForAuthenticatedUserResponse>()
  }

  /**
 * Lists packages owned by the authenticated user within the user's namespace.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_list_packages_for_authenticated_user',
    description: `Lists packages owned by the authenticated user within the user's namespace.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesListPackagesForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesListPackagesForAuthenticatedUser(
    params: github.PackagesListPackagesForAuthenticatedUserParams
  ): Promise<github.PackagesListPackagesForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/packages', {
        searchParams: sanitizeSearchParams(
          pick(params, 'package_type', 'visibility', 'page', 'per_page')
        )
      })
      .json<github.PackagesListPackagesForAuthenticatedUserResponse>()
  }

  /**
 * Gets a specific package for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_for_authenticated_user',
    description: `Gets a specific package for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesGetPackageForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageForAuthenticatedUser(
    params: github.PackagesGetPackageForAuthenticatedUserParams
  ): Promise<github.PackagesGetPackageForAuthenticatedUserResponse> {
    return this.ky
      .get(
        `/user/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesGetPackageForAuthenticatedUserResponse>()
  }

  /**
 * Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_for_authenticated_user',
    description: `Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesDeletePackageForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageForAuthenticatedUser(
    params: github.PackagesDeletePackageForAuthenticatedUserParams
  ): Promise<github.PackagesDeletePackageForAuthenticatedUserResponse> {
    return this.ky
      .delete(
        `/user/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesDeletePackageForAuthenticatedUserResponse>()
  }

  /**
 * Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_for_authenticated_user',
    description: `Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesRestorePackageForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageForAuthenticatedUser(
    params: github.PackagesRestorePackageForAuthenticatedUserParams
  ): Promise<github.PackagesRestorePackageForAuthenticatedUserResponse> {
    return this.ky
      .post(
        `/user/packages/${params.package_type}/${params.package_name}/restore`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'token'))
        }
      )
      .json<github.PackagesRestorePackageForAuthenticatedUserResponse>()
  }

  /**
 * Lists package versions for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_all_package_versions_for_package_owned_by_authenticated_user',
    description: `Lists package versions for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUser(
    params: github.PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserParams
  ): Promise<github.PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserResponse> {
    return this.ky
      .get(
        `/user/packages/${params.package_type}/${params.package_name}/versions`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'page', 'per_page', 'state')
          )
        }
      )
      .json<github.PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserResponse>()
  }

  /**
 * Gets a specific package version for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_version_for_authenticated_user',
    description: `Gets a specific package version for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesGetPackageVersionForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageVersionForAuthenticatedUser(
    params: github.PackagesGetPackageVersionForAuthenticatedUserParams
  ): Promise<github.PackagesGetPackageVersionForAuthenticatedUserResponse> {
    return this.ky
      .get(
        `/user/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesGetPackageVersionForAuthenticatedUserResponse>()
  }

  /**
 * Deletes a specific package version for a package owned by the authenticated user.  If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_version_for_authenticated_user',
    description: `Deletes a specific package version for a package owned by the authenticated user.  If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesDeletePackageVersionForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageVersionForAuthenticatedUser(
    params: github.PackagesDeletePackageVersionForAuthenticatedUserParams
  ): Promise<github.PackagesDeletePackageVersionForAuthenticatedUserResponse> {
    return this.ky
      .delete(
        `/user/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesDeletePackageVersionForAuthenticatedUserResponse>()
  }

  /**
 * Restores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_version_for_authenticated_user',
    description: `Restores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesRestorePackageVersionForAuthenticatedUserParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageVersionForAuthenticatedUser(
    params: github.PackagesRestorePackageVersionForAuthenticatedUserParams
  ): Promise<github.PackagesRestorePackageVersionForAuthenticatedUserResponse> {
    return this.ky
      .post(
        `/user/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}/restore`,
        {}
      )
      .json<github.PackagesRestorePackageVersionForAuthenticatedUserResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_create_for_authenticated_user',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsCreateForAuthenticatedUserParamsSchema,
    tags: ['projects']
  })
  async projectsCreateForAuthenticatedUser(
    params: github.ProjectsCreateForAuthenticatedUserParams
  ): Promise<github.ProjectsCreateForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/projects', {
        json: pick(params, 'name', 'body')
      })
      .json<github.ProjectsCreateForAuthenticatedUserResponse>()
  }

  /**
 * Lists your publicly visible email address, which you can set with the
[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
endpoint.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_list_public_emails_for_authenticated_user',
    description: `Lists your publicly visible email address, which you can set with the
[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
endpoint.

OAuth app tokens and personal access tokens (classic) need the \`user:email\` scope to use this endpoint.`,
    inputSchema: github.UsersListPublicEmailsForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListPublicEmailsForAuthenticatedUser(
    params: github.UsersListPublicEmailsForAuthenticatedUserParams
  ): Promise<github.UsersListPublicEmailsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/public_emails', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListPublicEmailsForAuthenticatedUserResponse>()
  }

  /**
 * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
 */
  @aiFunction({
    name: 'github_repos_list_for_authenticated_user',
    description: `Lists repositories that the authenticated user has explicit permission (\`:read\`, \`:write\`, or \`:admin\`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.`,
    inputSchema: github.ReposListForAuthenticatedUserParamsSchema,
    tags: ['repos']
  })
  async reposListForAuthenticatedUser(
    params: github.ReposListForAuthenticatedUserParams
  ): Promise<github.ReposListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/repos', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'visibility',
            'affiliation',
            'type',
            'sort',
            'direction',
            'per_page',
            'page',
            'since',
            'before'
          )
        )
      })
      .json<github.ReposListForAuthenticatedUserResponse>()
  }

  /**
 * Creates a new repository for the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
 */
  @aiFunction({
    name: 'github_repos_create_for_authenticated_user',
    description: `Creates a new repository for the authenticated user.

OAuth app tokens and personal access tokens (classic) need the \`public_repo\` or \`repo\` scope to create a public repository, and \`repo\` scope to create a private repository.`,
    inputSchema: github.ReposCreateForAuthenticatedUserParamsSchema,
    tags: ['repos']
  })
  async reposCreateForAuthenticatedUser(
    params: github.ReposCreateForAuthenticatedUserParams
  ): Promise<github.ReposCreateForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/repos', {
        json: pick(
          params,
          'name',
          'description',
          'homepage',
          'private',
          'has_issues',
          'has_projects',
          'has_wiki',
          'has_discussions',
          'team_id',
          'auto_init',
          'gitignore_template',
          'license_template',
          'allow_squash_merge',
          'allow_merge_commit',
          'allow_rebase_merge',
          'allow_auto_merge',
          'delete_branch_on_merge',
          'squash_merge_commit_title',
          'squash_merge_commit_message',
          'merge_commit_title',
          'merge_commit_message',
          'has_downloads',
          'is_template'
        )
      })
      .json<github.ReposCreateForAuthenticatedUserResponse>()
  }

  /**
   * When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
   */
  @aiFunction({
    name: 'github_repos_list_invitations_for_authenticated_user',
    description: `When authenticating as a user, this endpoint will list all currently open repository invitations for that user.`,
    inputSchema: github.ReposListInvitationsForAuthenticatedUserParamsSchema,
    tags: ['repos']
  })
  async reposListInvitationsForAuthenticatedUser(
    params: github.ReposListInvitationsForAuthenticatedUserParams
  ): Promise<github.ReposListInvitationsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/repository_invitations', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ReposListInvitationsForAuthenticatedUserResponse>()
  }

  /**
   * Decline a repository invitation.
   */
  @aiFunction({
    name: 'github_repos_decline_invitation_for_authenticated_user',
    description: `Decline a repository invitation.`,
    inputSchema: github.ReposDeclineInvitationForAuthenticatedUserParamsSchema,
    tags: ['repos']
  })
  async reposDeclineInvitationForAuthenticatedUser(
    params: github.ReposDeclineInvitationForAuthenticatedUserParams
  ): Promise<github.ReposDeclineInvitationForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/repository_invitations/${params.invitation_id}`)
      .json<github.ReposDeclineInvitationForAuthenticatedUserResponse>()
  }

  /**
   * Accept a repository invitation.
   */
  @aiFunction({
    name: 'github_repos_accept_invitation_for_authenticated_user',
    description: `Accept a repository invitation.`,
    inputSchema: github.ReposAcceptInvitationForAuthenticatedUserParamsSchema,
    tags: ['repos']
  })
  async reposAcceptInvitationForAuthenticatedUser(
    params: github.ReposAcceptInvitationForAuthenticatedUserParams
  ): Promise<github.ReposAcceptInvitationForAuthenticatedUserResponse> {
    return this.ky
      .patch(`/user/repository_invitations/${params.invitation_id}`)
      .json<github.ReposAcceptInvitationForAuthenticatedUserResponse>()
  }

  /**
   * Lists all of your social accounts.
   */
  @aiFunction({
    name: 'github_users_list_social_accounts_for_authenticated_user',
    description: `Lists all of your social accounts.`,
    inputSchema: github.UsersListSocialAccountsForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListSocialAccountsForAuthenticatedUser(
    params: github.UsersListSocialAccountsForAuthenticatedUserParams
  ): Promise<github.UsersListSocialAccountsForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/social_accounts', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListSocialAccountsForAuthenticatedUserResponse>()
  }

  /**
 * Add one or more social accounts to the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_add_social_account_for_authenticated_user',
    description: `Add one or more social accounts to the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    inputSchema: github.UsersAddSocialAccountForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersAddSocialAccountForAuthenticatedUser(
    params: github.UsersAddSocialAccountForAuthenticatedUserParams
  ): Promise<github.UsersAddSocialAccountForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/social_accounts', {
        json: params
      })
      .json<github.UsersAddSocialAccountForAuthenticatedUserResponse>()
  }

  /**
 * Deletes one or more social accounts from the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_delete_social_account_for_authenticated_user',
    description: `Deletes one or more social accounts from the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    inputSchema:
      github.UsersDeleteSocialAccountForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersDeleteSocialAccountForAuthenticatedUser(
    params: github.UsersDeleteSocialAccountForAuthenticatedUserParams
  ): Promise<github.UsersDeleteSocialAccountForAuthenticatedUserResponse> {
    return this.ky
      .delete('/user/social_accounts', {
        json: params
      })
      .json<github.UsersDeleteSocialAccountForAuthenticatedUserResponse>()
  }

  /**
 * Lists the SSH signing keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_list_ssh_signing_keys_for_authenticated_user',
    description: `Lists the SSH signing keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`read:ssh_signing_key\` scope to use this endpoint.`,
    inputSchema: github.UsersListSshSigningKeysForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersListSshSigningKeysForAuthenticatedUser(
    params: github.UsersListSshSigningKeysForAuthenticatedUserParams
  ): Promise<github.UsersListSshSigningKeysForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/ssh_signing_keys', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListSshSigningKeysForAuthenticatedUserResponse>()
  }

  /**
 * Creates an SSH signing key for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_create_ssh_signing_key_for_authenticated_user',
    description: `Creates an SSH signing key for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`write:ssh_signing_key\` scope to use this endpoint.`,
    inputSchema:
      github.UsersCreateSshSigningKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersCreateSshSigningKeyForAuthenticatedUser(
    params: github.UsersCreateSshSigningKeyForAuthenticatedUserParams
  ): Promise<github.UsersCreateSshSigningKeyForAuthenticatedUserResponse> {
    return this.ky
      .post('/user/ssh_signing_keys', {
        json: pick(params, 'title', 'key')
      })
      .json<github.UsersCreateSshSigningKeyForAuthenticatedUserResponse>()
  }

  /**
 * Gets extended details for an SSH signing key.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_get_ssh_signing_key_for_authenticated_user',
    description: `Gets extended details for an SSH signing key.

OAuth app tokens and personal access tokens (classic) need the \`read:ssh_signing_key\` scope to use this endpoint.`,
    inputSchema: github.UsersGetSshSigningKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersGetSshSigningKeyForAuthenticatedUser(
    params: github.UsersGetSshSigningKeyForAuthenticatedUserParams
  ): Promise<github.UsersGetSshSigningKeyForAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/ssh_signing_keys/${params.ssh_signing_key_id}`)
      .json<github.UsersGetSshSigningKeyForAuthenticatedUserResponse>()
  }

  /**
 * Deletes an SSH signing key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_delete_ssh_signing_key_for_authenticated_user',
    description: `Deletes an SSH signing key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the \`admin:ssh_signing_key\` scope to use this endpoint.`,
    inputSchema:
      github.UsersDeleteSshSigningKeyForAuthenticatedUserParamsSchema,
    tags: ['users']
  })
  async usersDeleteSshSigningKeyForAuthenticatedUser(
    params: github.UsersDeleteSshSigningKeyForAuthenticatedUserParams
  ): Promise<github.UsersDeleteSshSigningKeyForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/ssh_signing_keys/${params.ssh_signing_key_id}`)
      .json<github.UsersDeleteSshSigningKeyForAuthenticatedUserResponse>()
  }

  /**
 * Lists repositories the authenticated user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
 */
  @aiFunction({
    name: 'github_activity_list_repos_starred_by_authenticated_user',
    description: `Lists repositories the authenticated user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.star+json\`**: Includes a timestamp of when the star was created.`,
    inputSchema: github.ActivityListReposStarredByAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListReposStarredByAuthenticatedUser(
    params: github.ActivityListReposStarredByAuthenticatedUserParams
  ): Promise<github.ActivityListReposStarredByAuthenticatedUserResponse> {
    return this.ky
      .get('/user/starred', {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.ActivityListReposStarredByAuthenticatedUserResponse>()
  }

  /**
   * Whether the authenticated user has starred the repository.
   */
  @aiFunction({
    name: 'github_activity_check_repo_is_starred_by_authenticated_user',
    description: `Whether the authenticated user has starred the repository.`,
    inputSchema:
      github.ActivityCheckRepoIsStarredByAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityCheckRepoIsStarredByAuthenticatedUser(
    params: github.ActivityCheckRepoIsStarredByAuthenticatedUserParams
  ): Promise<github.ActivityCheckRepoIsStarredByAuthenticatedUserResponse> {
    return this.ky
      .get(`/user/starred/${params.owner}/${params.repo}`, {})
      .json<github.ActivityCheckRepoIsStarredByAuthenticatedUserResponse>()
  }

  /**
   * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".
   */
  @aiFunction({
    name: 'github_activity_star_repo_for_authenticated_user',
    description: `Note that you'll need to set \`Content-Length\` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).".`,
    inputSchema: github.ActivityStarRepoForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityStarRepoForAuthenticatedUser(
    params: github.ActivityStarRepoForAuthenticatedUserParams
  ): Promise<github.ActivityStarRepoForAuthenticatedUserResponse> {
    return this.ky
      .put(`/user/starred/${params.owner}/${params.repo}`, {})
      .json<github.ActivityStarRepoForAuthenticatedUserResponse>()
  }

  /**
   * Unstar a repository that the authenticated user has previously starred.
   */
  @aiFunction({
    name: 'github_activity_unstar_repo_for_authenticated_user',
    description: `Unstar a repository that the authenticated user has previously starred.`,
    inputSchema: github.ActivityUnstarRepoForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityUnstarRepoForAuthenticatedUser(
    params: github.ActivityUnstarRepoForAuthenticatedUserParams
  ): Promise<github.ActivityUnstarRepoForAuthenticatedUserResponse> {
    return this.ky
      .delete(`/user/starred/${params.owner}/${params.repo}`, {})
      .json<github.ActivityUnstarRepoForAuthenticatedUserResponse>()
  }

  /**
   * Lists repositories the authenticated user is watching.
   */
  @aiFunction({
    name: 'github_activity_list_watched_repos_for_authenticated_user',
    description: `Lists repositories the authenticated user is watching.`,
    inputSchema:
      github.ActivityListWatchedReposForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListWatchedReposForAuthenticatedUser(
    params: github.ActivityListWatchedReposForAuthenticatedUserParams
  ): Promise<github.ActivityListWatchedReposForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/subscriptions', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListWatchedReposForAuthenticatedUserResponse>()
  }

  /**
 * List all of the teams across all of the organizations to which the authenticated
user belongs.

OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.

When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
 */
  @aiFunction({
    name: 'github_teams_list_for_authenticated_user',
    description: `List all of the teams across all of the organizations to which the authenticated
user belongs.

OAuth app tokens and personal access tokens (classic) need the \`user\`, \`repo\`, or \`read:org\` scope to use this endpoint.

When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.`,
    inputSchema: github.TeamsListForAuthenticatedUserParamsSchema,
    tags: ['teams']
  })
  async teamsListForAuthenticatedUser(
    params: github.TeamsListForAuthenticatedUserParams
  ): Promise<github.TeamsListForAuthenticatedUserResponse> {
    return this.ky
      .get('/user/teams', {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.TeamsListForAuthenticatedUserResponse>()
  }

  /**
 * Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
 */
  @aiFunction({
    name: 'github_users_get_by_id',
    description: `Provides publicly available information about someone with a GitHub account. This method takes their durable user \`ID\` instead of their \`login\`, which can change over time.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a \`404 Not Found\` status.

The \`email\` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for \`email\`, then it will have a value of \`null\`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).`,
    inputSchema: github.UsersGetByIdParamsSchema,
    tags: ['users']
  })
  async usersGetById(
    params: github.UsersGetByIdParams
  ): Promise<github.UsersGetByIdResponse> {
    return this.ky
      .get(`/user/${params.account_id}`)
      .json<github.UsersGetByIdResponse>()
  }

  /**
 * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
 */
  @aiFunction({
    name: 'github_users_list',
    description: `Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the \`since\` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.`,
    inputSchema: github.UsersListParamsSchema,
    tags: ['users']
  })
  async usersList(
    params: github.UsersListParams
  ): Promise<github.UsersListResponse> {
    return this.ky
      .get('/users', {
        searchParams: sanitizeSearchParams(pick(params, 'since', 'per_page'))
      })
      .json<github.UsersListResponse>()
  }

  /**
 * Provides publicly available information about someone with a GitHub account.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
 */
  @aiFunction({
    name: 'github_users_get_by_username',
    description: `Provides publicly available information about someone with a GitHub account.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a \`404 Not Found\` status.

The \`email\` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for \`email\`, then it will have a value of \`null\`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).`,
    inputSchema: github.UsersGetByUsernameParamsSchema,
    tags: ['users']
  })
  async usersGetByUsername(
    params: github.UsersGetByUsernameParams
  ): Promise<github.UsersGetByUsernameResponse> {
    return this.ky
      .get(`/users/${params.username}`)
      .json<github.UsersGetByUsernameResponse>()
  }

  /**
 * List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
 */
  @aiFunction({
    name: 'github_users_list_attestations',
    description: `List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the \`attestations:read\` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI \`attestation verify\` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).`,
    inputSchema: github.UsersListAttestationsParamsSchema,
    tags: ['users']
  })
  async usersListAttestations(
    params: github.UsersListAttestationsParams
  ): Promise<github.UsersListAttestationsResponse> {
    return this.ky
      .get(
        `/users/${params.username}/attestations/${params.subject_digest}`,
        {
          searchParams: sanitizeSearchParams(
            pick(params, 'per_page', 'before', 'after', 'predicate_type')
          )
        }
      )
      .json<github.UsersListAttestationsResponse>()
  }

  /**
 * Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_packages_list_docker_migration_conflicting_packages_for_user',
    description: `Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint.`,
    inputSchema:
      github.PackagesListDockerMigrationConflictingPackagesForUserParamsSchema,
    tags: ['packages']
  })
  async packagesListDockerMigrationConflictingPackagesForUser(
    params: github.PackagesListDockerMigrationConflictingPackagesForUserParams
  ): Promise<github.PackagesListDockerMigrationConflictingPackagesForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/docker/conflicts`)
      .json<github.PackagesListDockerMigrationConflictingPackagesForUserResponse>()
  }

  /**
 * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_events_for_authenticated_user',
    description: `If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListEventsForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListEventsForAuthenticatedUser(
    params: github.ActivityListEventsForAuthenticatedUserParams
  ): Promise<github.ActivityListEventsForAuthenticatedUserResponse> {
    return this.ky
      .get(`/users/${params.username}/events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListEventsForAuthenticatedUserResponse>()
  }

  /**
 * This is the user's organization dashboard. You must be authenticated as the user to view this.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_org_events_for_authenticated_user',
    description: `This is the user's organization dashboard. You must be authenticated as the user to view this.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListOrgEventsForAuthenticatedUserParamsSchema,
    tags: ['activity']
  })
  async activityListOrgEventsForAuthenticatedUser(
    params: github.ActivityListOrgEventsForAuthenticatedUserParams
  ): Promise<github.ActivityListOrgEventsForAuthenticatedUserResponse> {
    return this.ky
      .get(`/users/${params.username}/events/orgs/${params.org}`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListOrgEventsForAuthenticatedUserResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_public_events_for_user',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListPublicEventsForUserParamsSchema,
    tags: ['activity']
  })
  async activityListPublicEventsForUser(
    params: github.ActivityListPublicEventsForUserParams
  ): Promise<github.ActivityListPublicEventsForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/events/public`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListPublicEventsForUserResponse>()
  }

  /**
   * Lists the people following the specified user.
   */
  @aiFunction({
    name: 'github_users_list_followers_for_user',
    description: `Lists the people following the specified user.`,
    inputSchema: github.UsersListFollowersForUserParamsSchema,
    tags: ['users']
  })
  async usersListFollowersForUser(
    params: github.UsersListFollowersForUserParams
  ): Promise<github.UsersListFollowersForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/followers`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListFollowersForUserResponse>()
  }

  /**
   * Lists the people who the specified user follows.
   */
  @aiFunction({
    name: 'github_users_list_following_for_user',
    description: `Lists the people who the specified user follows.`,
    inputSchema: github.UsersListFollowingForUserParamsSchema,
    tags: ['users']
  })
  async usersListFollowingForUser(
    params: github.UsersListFollowingForUserParams
  ): Promise<github.UsersListFollowingForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/following`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListFollowingForUserResponse>()
  }

  /**
   * Check if a user follows another user.
   */
  @aiFunction({
    name: 'github_users_check_following_for_user',
    description: `Check if a user follows another user.`,
    inputSchema: github.UsersCheckFollowingForUserParamsSchema,
    tags: ['users']
  })
  async usersCheckFollowingForUser(
    params: github.UsersCheckFollowingForUserParams
  ): Promise<github.UsersCheckFollowingForUserResponse> {
    return this.ky
      .get(
        `/users/${params.username}/following/${params.target_user}`,
        {}
      )
      .json<github.UsersCheckFollowingForUserResponse>()
  }

  /**
   * Lists public gists for the specified user:.
   */
  @aiFunction({
    name: 'github_gists_list_for_user',
    description: `Lists public gists for the specified user:.`,
    inputSchema: github.GistsListForUserParamsSchema,
    tags: ['gists']
  })
  async gistsListForUser(
    params: github.GistsListForUserParams
  ): Promise<github.GistsListForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/gists`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'since', 'per_page', 'page')
        )
      })
      .json<github.GistsListForUserResponse>()
  }

  /**
   * Lists the GPG keys for a user. This information is accessible by anyone.
   */
  @aiFunction({
    name: 'github_users_list_gpg_keys_for_user',
    description: `Lists the GPG keys for a user. This information is accessible by anyone.`,
    inputSchema: github.UsersListGpgKeysForUserParamsSchema,
    tags: ['users']
  })
  async usersListGpgKeysForUser(
    params: github.UsersListGpgKeysForUserParams
  ): Promise<github.UsersListGpgKeysForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/gpg_keys`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListGpgKeysForUserResponse>()
  }

  /**
 * Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

  The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_users_get_context_for_user',
    description: `Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

  The \`subject_type\` and \`subject_id\` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about \`octocat\` who owns the \`Spoon-Knife\` repository, you would use a \`subject_type\` value of \`repository\` and a \`subject_id\` value of \`1300192\` (the ID of the \`Spoon-Knife\` repository).

OAuth app tokens and personal access tokens (classic) need the \`repo\` scope to use this endpoint.`,
    inputSchema: github.UsersGetContextForUserParamsSchema,
    tags: ['users']
  })
  async usersGetContextForUser(
    params: github.UsersGetContextForUserParams
  ): Promise<github.UsersGetContextForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/hovercard`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'subject_type', 'subject_id')
        )
      })
      .json<github.UsersGetContextForUserResponse>()
  }

  /**
 * Enables an authenticated GitHub App to find the user’s installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
 */
  @aiFunction({
    name: 'github_apps_get_user_installation',
    description: `Enables an authenticated GitHub App to find the user’s installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.`,
    inputSchema: github.AppsGetUserInstallationParamsSchema,
    tags: ['apps']
  })
  async appsGetUserInstallation(
    params: github.AppsGetUserInstallationParams
  ): Promise<github.AppsGetUserInstallationResponse> {
    return this.ky
      .get(`/users/${params.username}/installation`)
      .json<github.AppsGetUserInstallationResponse>()
  }

  /**
   * Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
   */
  @aiFunction({
    name: 'github_users_list_public_keys_for_user',
    description: `Lists the _verified_ public SSH keys for a user. This is accessible by anyone.`,
    inputSchema: github.UsersListPublicKeysForUserParamsSchema,
    tags: ['users']
  })
  async usersListPublicKeysForUser(
    params: github.UsersListPublicKeysForUserParams
  ): Promise<github.UsersListPublicKeysForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/keys`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListPublicKeysForUserResponse>()
  }

  /**
 * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.

This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.
 */
  @aiFunction({
    name: 'github_orgs_list_for_user',
    description: `List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.

This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.`,
    inputSchema: github.OrgsListForUserParamsSchema,
    tags: ['orgs']
  })
  async orgsListForUser(
    params: github.OrgsListForUserParams
  ): Promise<github.OrgsListForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/orgs`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.OrgsListForUserResponse>()
  }

  /**
 * Lists all packages in a user's namespace for which the requesting user has access.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_list_packages_for_user',
    description: `Lists all packages in a user's namespace for which the requesting user has access.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesListPackagesForUserParamsSchema,
    tags: ['packages']
  })
  async packagesListPackagesForUser(
    params: github.PackagesListPackagesForUserParams
  ): Promise<github.PackagesListPackagesForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/packages`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'package_type', 'visibility', 'page', 'per_page')
        )
      })
      .json<github.PackagesListPackagesForUserResponse>()
  }

  /**
 * Gets a specific package metadata for a public package owned by a user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_for_user',
    description: `Gets a specific package metadata for a public package owned by a user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesGetPackageForUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageForUser(
    params: github.PackagesGetPackageForUserParams
  ): Promise<github.PackagesGetPackageForUserResponse> {
    return this.ky
      .get(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesGetPackageForUserResponse>()
  }

  /**
 * Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_for_user',
    description: `Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesDeletePackageForUserParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageForUser(
    params: github.PackagesDeletePackageForUserParams
  ): Promise<github.PackagesDeletePackageForUserResponse> {
    return this.ky
      .delete(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}`,
        {}
      )
      .json<github.PackagesDeletePackageForUserResponse>()
  }

  /**
 * Restores an entire package for a user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_for_user',
    description: `Restores an entire package for a user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesRestorePackageForUserParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageForUser(
    params: github.PackagesRestorePackageForUserParams
  ): Promise<github.PackagesRestorePackageForUserResponse> {
    return this.ky
      .post(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}/restore`,
        {
          searchParams: sanitizeSearchParams(pick(params, 'token'))
        }
      )
      .json<github.PackagesRestorePackageForUserResponse>()
  }

  /**
 * Lists package versions for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_all_package_versions_for_package_owned_by_user',
    description: `Lists package versions for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema:
      github.PackagesGetAllPackageVersionsForPackageOwnedByUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetAllPackageVersionsForPackageOwnedByUser(
    params: github.PackagesGetAllPackageVersionsForPackageOwnedByUserParams
  ): Promise<github.PackagesGetAllPackageVersionsForPackageOwnedByUserResponse> {
    return this.ky
      .get(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}/versions`,
        {}
      )
      .json<github.PackagesGetAllPackageVersionsForPackageOwnedByUserResponse>()
  }

  /**
 * Gets a specific package version for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_get_package_version_for_user',
    description: `Gets a specific package version for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesGetPackageVersionForUserParamsSchema,
    tags: ['packages']
  })
  async packagesGetPackageVersionForUser(
    params: github.PackagesGetPackageVersionForUserParams
  ): Promise<github.PackagesGetPackageVersionForUserResponse> {
    return this.ky
      .get(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesGetPackageVersionForUserResponse>()
  }

  /**
 * Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_delete_package_version_for_user',
    description: `Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`delete:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesDeletePackageVersionForUserParamsSchema,
    tags: ['packages']
  })
  async packagesDeletePackageVersionForUser(
    params: github.PackagesDeletePackageVersionForUserParams
  ): Promise<github.PackagesDeletePackageVersionForUserResponse> {
    return this.ky
      .delete(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}`,
        {}
      )
      .json<github.PackagesDeletePackageVersionForUserResponse>()
  }

  /**
 * Restores a specific package version for a user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".
 */
  @aiFunction({
    name: 'github_packages_restore_package_version_for_user',
    description: `Restores a specific package version for a user.

You can restore a deleted package under the following conditions:
  - The package was deleted within the last 30 days.
  - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the \`package_type\` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the \`read:packages\` and \`write:packages\` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).".`,
    inputSchema: github.PackagesRestorePackageVersionForUserParamsSchema,
    tags: ['packages']
  })
  async packagesRestorePackageVersionForUser(
    params: github.PackagesRestorePackageVersionForUserParams
  ): Promise<github.PackagesRestorePackageVersionForUserResponse> {
    return this.ky
      .post(
        `/users/${params.username}/packages/${params.package_type}/${params.package_name}/versions/${params.package_version_id}/restore`,
        {}
      )
      .json<github.PackagesRestorePackageVersionForUserResponse>()
  }

  /**
 * > [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.
 */
  @aiFunction({
    name: 'github_projects_list_for_user',
    description: `> [!WARNING]
> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.
> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.`,
    inputSchema: github.ProjectsListForUserParamsSchema,
    tags: ['projects']
  })
  async projectsListForUser(
    params: github.ProjectsListForUserParams
  ): Promise<github.ProjectsListForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/projects`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'state', 'per_page', 'page')
        )
      })
      .json<github.ProjectsListForUserResponse>()
  }

  /**
 * These are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_received_events_for_user',
    description: `These are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListReceivedEventsForUserParamsSchema,
    tags: ['activity']
  })
  async activityListReceivedEventsForUser(
    params: github.ActivityListReceivedEventsForUserParams
  ): Promise<github.ActivityListReceivedEventsForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/received_events`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListReceivedEventsForUserResponse>()
  }

  /**
 * > [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
 */
  @aiFunction({
    name: 'github_activity_list_received_public_events_for_user',
    description: `> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.`,
    inputSchema: github.ActivityListReceivedPublicEventsForUserParamsSchema,
    tags: ['activity']
  })
  async activityListReceivedPublicEventsForUser(
    params: github.ActivityListReceivedPublicEventsForUserParams
  ): Promise<github.ActivityListReceivedPublicEventsForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/received_events/public`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListReceivedPublicEventsForUserResponse>()
  }

  /**
   * Lists public repositories for the specified user.
   */
  @aiFunction({
    name: 'github_repos_list_for_user',
    description: `Lists public repositories for the specified user.`,
    inputSchema: github.ReposListForUserParamsSchema,
    tags: ['repos']
  })
  async reposListForUser(
    params: github.ReposListForUserParams
  ): Promise<github.ReposListForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/repos`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'type', 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.ReposListForUserResponse>()
  }

  /**
 * Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_github_actions_billing_user',
    description: `Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    inputSchema: github.BillingGetGithubActionsBillingUserParamsSchema,
    tags: ['billing']
  })
  async billingGetGithubActionsBillingUser(
    params: github.BillingGetGithubActionsBillingUserParams
  ): Promise<github.BillingGetGithubActionsBillingUserResponse> {
    return this.ky
      .get(`/users/${params.username}/settings/billing/actions`)
      .json<github.BillingGetGithubActionsBillingUserResponse>()
  }

  /**
 * Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_github_packages_billing_user',
    description: `Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    inputSchema: github.BillingGetGithubPackagesBillingUserParamsSchema,
    tags: ['billing']
  })
  async billingGetGithubPackagesBillingUser(
    params: github.BillingGetGithubPackagesBillingUserParams
  ): Promise<github.BillingGetGithubPackagesBillingUserResponse> {
    return this.ky
      .get(`/users/${params.username}/settings/billing/packages`)
      .json<github.BillingGetGithubPackagesBillingUserResponse>()
  }

  /**
 * Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
 */
  @aiFunction({
    name: 'github_billing_get_shared_storage_billing_user',
    description: `Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

OAuth app tokens and personal access tokens (classic) need the \`user\` scope to use this endpoint.`,
    inputSchema: github.BillingGetSharedStorageBillingUserParamsSchema,
    tags: ['billing']
  })
  async billingGetSharedStorageBillingUser(
    params: github.BillingGetSharedStorageBillingUserParams
  ): Promise<github.BillingGetSharedStorageBillingUserResponse> {
    return this.ky
      .get(`/users/${params.username}/settings/billing/shared-storage`)
      .json<github.BillingGetSharedStorageBillingUserResponse>()
  }

  /**
   * Lists social media accounts for a user. This endpoint is accessible by anyone.
   */
  @aiFunction({
    name: 'github_users_list_social_accounts_for_user',
    description: `Lists social media accounts for a user. This endpoint is accessible by anyone.`,
    inputSchema: github.UsersListSocialAccountsForUserParamsSchema,
    tags: ['users']
  })
  async usersListSocialAccountsForUser(
    params: github.UsersListSocialAccountsForUserParams
  ): Promise<github.UsersListSocialAccountsForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/social_accounts`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListSocialAccountsForUserResponse>()
  }

  /**
   * Lists the SSH signing keys for a user. This operation is accessible by anyone.
   */
  @aiFunction({
    name: 'github_users_list_ssh_signing_keys_for_user',
    description: `Lists the SSH signing keys for a user. This operation is accessible by anyone.`,
    inputSchema: github.UsersListSshSigningKeysForUserParamsSchema,
    tags: ['users']
  })
  async usersListSshSigningKeysForUser(
    params: github.UsersListSshSigningKeysForUserParams
  ): Promise<github.UsersListSshSigningKeysForUserResponse> {
    return this.ky
      .get(`/users/${params.username}/ssh_signing_keys`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.UsersListSshSigningKeysForUserResponse>()
  }

  /**
 * Lists repositories a user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
 */
  @aiFunction({
    name: 'github_activity_list_repos_starred_by_user',
    description: `Lists repositories a user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **\`application/vnd.github.star+json\`**: Includes a timestamp of when the star was created.`,
    inputSchema: github.ActivityListReposStarredByUserParamsSchema,
    tags: ['activity']
  })
  async activityListReposStarredByUser(
    params: github.ActivityListReposStarredByUserParams
  ): Promise<github.ActivityListReposStarredByUserResponse> {
    return this.ky
      .get(`/users/${params.username}/starred`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'sort', 'direction', 'per_page', 'page')
        )
      })
      .json<github.ActivityListReposStarredByUserResponse>()
  }

  /**
   * Lists repositories a user is watching.
   */
  @aiFunction({
    name: 'github_activity_list_repos_watched_by_user',
    description: `Lists repositories a user is watching.`,
    inputSchema: github.ActivityListReposWatchedByUserParamsSchema,
    tags: ['activity']
  })
  async activityListReposWatchedByUser(
    params: github.ActivityListReposWatchedByUserParams
  ): Promise<github.ActivityListReposWatchedByUserResponse> {
    return this.ky
      .get(`/users/${params.username}/subscriptions`, {
        searchParams: sanitizeSearchParams(pick(params, 'per_page', 'page'))
      })
      .json<github.ActivityListReposWatchedByUserResponse>()
  }

  /**
   * Get all supported GitHub API versions.
   */
  @aiFunction({
    name: 'github_meta_get_all_versions',
    description: `Get all supported GitHub API versions.`,
    inputSchema: github.MetaGetAllVersionsParamsSchema,
    tags: ['meta']
  })
  async metaGetAllVersions(
    _params: github.MetaGetAllVersionsParams
  ): Promise<github.MetaGetAllVersionsResponse> {
    return this.ky.get('/versions').json<github.MetaGetAllVersionsResponse>()
  }

  /**
   * Get a random sentence from the Zen of GitHub.
   */
  @aiFunction({
    name: 'github_meta_get_zen',
    description: `Get a random sentence from the Zen of GitHub.`,
    inputSchema: github.MetaGetZenParamsSchema,
    tags: ['meta']
  })
  async metaGetZen(
    _params: github.MetaGetZenParams
  ): Promise<github.MetaGetZenResponse> {
    return this.ky.get('/zen').json<github.MetaGetZenResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/github.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace github {
  export const apiBaseUrl = 'https://api.github.com'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const RootSchema = z.object({
    current_user_url: z.string(),
    current_user_authorizations_html_url: z.string(),
    authorizations_url: z.string(),
    code_search_url: z.string(),
    commit_search_url: z.string(),
    emails_url: z.string(),
    emojis_url: z.string(),
    events_url: z.string(),
    feeds_url: z.string(),
    followers_url: z.string(),
    following_url: z.string(),
    gists_url: z.string(),
    hub_url: z.string().optional(),
    issue_search_url: z.string(),
    issues_url: z.string(),
    keys_url: z.string(),
    label_search_url: z.string(),
    notifications_url: z.string(),
    organization_url: z.string(),
    organization_repositories_url: z.string(),
    organization_teams_url: z.string(),
    public_gists_url: z.string(),
    rate_limit_url: z.string(),
    repository_url: z.string(),
    repository_search_url: z.string(),
    current_user_repositories_url: z.string(),
    starred_url: z.string(),
    starred_gists_url: z.string(),
    topic_search_url: z.string().optional(),
    user_url: z.string(),
    user_organizations_url: z.string(),
    user_repositories_url: z.string(),
    user_search_url: z.string()
  })
  export type Root = z.infer<typeof RootSchema>

  export const SecurityAdvisoryEcosystemsSchema = z
    .enum([
      'rubygems',
      'npm',
      'pip',
      'maven',
      'nuget',
      'composer',
      'go',
      'rust',
      'erlang',
      'actions',
      'pub',
      'other',
      'swift'
    ])
    .describe("The package's language or package management ecosystem.")
  export type SecurityAdvisoryEcosystems = z.infer<
    typeof SecurityAdvisoryEcosystemsSchema
  >

  export const CvssSeveritiesSchema = z.object({
    cvss_v3: z
      .object({
        vector_string: z.string().describe('The CVSS 3 vector string.'),
        score: z
          .number()
          .gte(0)
          .lte(10)
          .describe('The CVSS 3 score.')
          .readonly()
      })
      .optional(),
    cvss_v4: z
      .object({
        vector_string: z.string().describe('The CVSS 4 vector string.'),
        score: z
          .number()
          .gte(0)
          .lte(10)
          .describe('The CVSS 4 score.')
          .readonly()
      })
      .optional()
  })
  export type CvssSeverities = z.infer<typeof CvssSeveritiesSchema>

  export const SecurityAdvisoryEpssSchema = z
    .object({
      percentage: z.number().gte(0).lte(100).optional(),
      percentile: z.number().gte(0).lte(100).optional()
    })
    .describe(
      'The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).'
    )
    .readonly()
  export type SecurityAdvisoryEpss = z.infer<typeof SecurityAdvisoryEpssSchema>

  export const SimpleUserSchema = z
    .object({
      name: z.string().optional(),
      email: z.string().optional(),
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      starred_at: z.string().optional(),
      user_view_type: z.string().optional()
    })
    .describe('A GitHub user.')
  export type SimpleUser = z.infer<typeof SimpleUserSchema>

  export const SecurityAdvisoryCreditTypesSchema = z
    .enum([
      'analyst',
      'finder',
      'reporter',
      'coordinator',
      'remediation_developer',
      'remediation_reviewer',
      'remediation_verifier',
      'tool',
      'sponsor',
      'other'
    ])
    .describe('The type of credit the user is receiving.')
  export type SecurityAdvisoryCreditTypes = z.infer<
    typeof SecurityAdvisoryCreditTypesSchema
  >

  export const PaginationBeforeSchema = z
    .any()
    .describe(
      'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
    )
  export type PaginationBefore = z.infer<typeof PaginationBeforeSchema>

  export const PaginationAfterSchema = z
    .any()
    .describe(
      'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
    )
  export type PaginationAfter = z.infer<typeof PaginationAfterSchema>

  export const DirectionSchema = z
    .any()
    .describe('The direction to sort the results by.')
  export type Direction = z.infer<typeof DirectionSchema>

  export const GhsaIdSchema = z
    .any()
    .describe('The GHSA (GitHub Security Advisory) identifier of the advisory.')
  export type GhsaId = z.infer<typeof GhsaIdSchema>

  export const EnterpriseSchema = z
    .any()
    .describe(
      'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
    )
  export type Enterprise = z.infer<typeof EnterpriseSchema>

  export const WebhookConfigUrlSchema = z
    .string()
    .url()
    .describe('The URL to which the payloads will be delivered.')
  export type WebhookConfigUrl = z.infer<typeof WebhookConfigUrlSchema>

  export const WebhookConfigContentTypeSchema = z
    .string()
    .describe(
      'The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.'
    )
  export type WebhookConfigContentType = z.infer<
    typeof WebhookConfigContentTypeSchema
  >

  export const WebhookConfigSecretSchema = z
    .string()
    .describe(
      'If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).'
    )
  export type WebhookConfigSecret = z.infer<typeof WebhookConfigSecretSchema>

  export const WebhookConfigInsecureSslSchema = z.union([
    z
      .string()
      .describe(
        'Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**'
      ),
    z.number()
  ])
  export type WebhookConfigInsecureSsl = z.infer<
    typeof WebhookConfigInsecureSslSchema
  >

  export const HookDeliveryItemSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('Unique identifier of the webhook delivery.'),
      guid: z
        .string()
        .describe(
          'Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).'
        ),
      delivered_at: z
        .string()
        .datetime({ offset: true })
        .describe('Time when the webhook delivery occurred.'),
      redelivery: z
        .boolean()
        .describe('Whether the webhook delivery is a redelivery.'),
      duration: z.number().describe('Time spent delivering.'),
      status: z
        .string()
        .describe(
          'Describes the response returned after attempting the delivery.'
        ),
      status_code: z
        .number()
        .int()
        .describe('Status code received when delivery was made.'),
      event: z.string().describe('The event that triggered the delivery.'),
      action: z
        .string()
        .describe(
          'The type of activity for the event that triggered the delivery.'
        ),
      installation_id: z
        .number()
        .int()
        .describe(
          'The id of the GitHub App installation associated with this event.'
        ),
      repository_id: z
        .number()
        .int()
        .describe('The id of the repository associated with this event.'),
      throttled_at: z
        .string()
        .datetime({ offset: true })
        .describe('Time when the webhook delivery was throttled.')
        .optional()
    })
    .describe(
      'Delivery made by a webhook, without request and response information.'
    )
  export type HookDeliveryItem = z.infer<typeof HookDeliveryItemSchema>

  export const PerPageSchema = z
    .any()
    .describe(
      'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
    )
  export type PerPage = z.infer<typeof PerPageSchema>

  export const CursorSchema = z
    .any()
    .describe(
      'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.'
    )
  export type Cursor = z.infer<typeof CursorSchema>

  export const HookDeliverySchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the delivery.'),
      guid: z
        .string()
        .describe(
          'Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).'
        ),
      delivered_at: z
        .string()
        .datetime({ offset: true })
        .describe('Time when the delivery was delivered.'),
      redelivery: z.boolean().describe('Whether the delivery is a redelivery.'),
      duration: z.number().describe('Time spent delivering.'),
      status: z
        .string()
        .describe('Description of the status of the attempted delivery'),
      status_code: z
        .number()
        .int()
        .describe('Status code received when delivery was made.'),
      event: z.string().describe('The event that triggered the delivery.'),
      action: z
        .string()
        .describe(
          'The type of activity for the event that triggered the delivery.'
        ),
      installation_id: z
        .number()
        .int()
        .describe(
          'The id of the GitHub App installation associated with this event.'
        ),
      repository_id: z
        .number()
        .int()
        .describe('The id of the repository associated with this event.'),
      throttled_at: z
        .string()
        .datetime({ offset: true })
        .describe('Time when the webhook delivery was throttled.')
        .optional(),
      url: z.string().describe('The URL target of the delivery.').optional(),
      request: z.object({
        headers: z
          .record(z.any())
          .describe('The request headers sent with the webhook delivery.'),
        payload: z.record(z.any()).describe('The webhook payload.')
      }),
      response: z.object({
        headers: z
          .record(z.any())
          .describe(
            'The response headers received when the delivery was made.'
          ),
        payload: z.string().describe('The response payload received.')
      })
    })
    .describe('Delivery made by a webhook.')
  export type HookDelivery = z.infer<typeof HookDeliverySchema>

  export const DeliveryIdSchema = z.any()
  export type DeliveryId = z.infer<typeof DeliveryIdSchema>

  export const PageSchema = z
    .object({
      url: z
        .string()
        .url()
        .describe('The API address for accessing this Page resource.'),
      status: z
        .enum(['built', 'building', 'errored'])
        .describe('The status of the most recent build of the Page.'),
      cname: z.string().describe("The Pages site's custom domain"),
      protected_domain_state: z
        .enum(['pending', 'verified', 'unverified'])
        .describe('The state if the domain is verified')
        .optional(),
      pending_domain_unverified_at: z
        .string()
        .datetime({ offset: true })
        .describe('The timestamp when a pending domain becomes unverified.')
        .optional(),
      custom_404: z
        .boolean()
        .describe('Whether the Page has a custom 404 page.')
        .default(false),
      html_url: z
        .string()
        .url()
        .describe('The web address the Page can be accessed from.')
        .optional(),
      build_type: z
        .enum(['legacy', 'workflow'])
        .describe('The process in which the Page will be built.')
        .optional(),
      source: PagesSourceHashSchema.optional(),
      public: z
        .boolean()
        .describe(
          'Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.'
        ),
      https_certificate: PagesHttpsCertificateSchema.optional(),
      https_enforced: z
        .boolean()
        .describe('Whether https is enabled on the domain')
        .optional()
    })
    .describe('The configuration for GitHub Pages for a repository.')
  export type Page = z.infer<typeof PageSchema>

  export const AppPermissionsSchema = z
    .object({
      actions: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.'
        )
        .optional(),
      administration: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.'
        )
        .optional(),
      checks: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for checks on code.'
        )
        .optional(),
      codespaces: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to create, edit, delete, and list Codespaces.'
        )
        .optional(),
      contents: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.'
        )
        .optional(),
      dependabot_secrets: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage Dependabot secrets.'
        )
        .optional(),
      deployments: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for deployments and deployment statuses.'
        )
        .optional(),
      environments: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for managing repository environments.'
        )
        .optional(),
      issues: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.'
        )
        .optional(),
      metadata: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.'
        )
        .optional(),
      packages: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for packages published to GitHub Packages.'
        )
        .optional(),
      pages: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.'
        )
        .optional(),
      pull_requests: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.'
        )
        .optional(),
      repository_custom_properties: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.'
        )
        .optional(),
      repository_hooks: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage the post-receive hooks for a repository.'
        )
        .optional(),
      repository_projects: z
        .enum(['read', 'write', 'admin'])
        .describe(
          'The level of permission to grant the access token to manage repository projects, columns, and cards.'
        )
        .optional(),
      secret_scanning_alerts: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage secret scanning alerts.'
        )
        .optional(),
      secrets: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage repository secrets.'
        )
        .optional(),
      security_events: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage security events like code scanning alerts.'
        )
        .optional(),
      single_file: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage just a single file.'
        )
        .optional(),
      statuses: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for commit statuses.'
        )
        .optional(),
      vulnerability_alerts: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage Dependabot alerts.'
        )
        .optional(),
      workflows: z
        .literal('write')
        .describe(
          'The level of permission to grant the access token to update GitHub Actions workflow files.'
        )
        .optional(),
      members: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for organization teams and members.'
        )
        .optional(),
      organization_administration: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage access to an organization.'
        )
        .optional(),
      organization_custom_roles: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for custom repository roles management.'
        )
        .optional(),
      organization_custom_org_roles: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for custom organization roles management.'
        )
        .optional(),
      organization_custom_properties: z
        .enum(['read', 'write', 'admin'])
        .describe(
          'The level of permission to grant the access token for custom property management.'
        )
        .optional(),
      organization_copilot_seat_management: z
        .literal('write')
        .describe(
          'The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.'
        )
        .optional(),
      organization_announcement_banners: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage announcement banners for an organization.'
        )
        .optional(),
      organization_events: z
        .literal('read')
        .describe(
          'The level of permission to grant the access token to view events triggered by an activity in an organization.'
        )
        .optional(),
      organization_hooks: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage the post-receive hooks for an organization.'
        )
        .optional(),
      organization_personal_access_tokens: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.'
        )
        .optional(),
      organization_personal_access_token_requests: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.'
        )
        .optional(),
      organization_plan: z
        .literal('read')
        .describe(
          "The level of permission to grant the access token for viewing an organization's plan."
        )
        .optional(),
      organization_projects: z
        .enum(['read', 'write', 'admin'])
        .describe(
          'The level of permission to grant the access token to manage organization projects and projects public preview (where available).'
        )
        .optional(),
      organization_packages: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token for organization packages published to GitHub Packages.'
        )
        .optional(),
      organization_secrets: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage organization secrets.'
        )
        .optional(),
      organization_self_hosted_runners: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.'
        )
        .optional(),
      organization_user_blocking: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage users blocked by the organization.'
        )
        .optional(),
      team_discussions: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage team discussions and related comments.'
        )
        .optional(),
      email_addresses: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage the email addresses belonging to a user.'
        )
        .optional(),
      followers: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage the followers belonging to a user.'
        )
        .optional(),
      git_ssh_keys: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to manage git SSH keys.'
        )
        .optional(),
      gpg_keys: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage GPG keys belonging to a user.'
        )
        .optional(),
      interaction_limits: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to view and manage interaction limits on a repository.'
        )
        .optional(),
      profile: z
        .literal('write')
        .describe(
          'The level of permission to grant the access token to manage the profile settings belonging to a user.'
        )
        .optional(),
      starring: z
        .enum(['read', 'write'])
        .describe(
          'The level of permission to grant the access token to list and manage repositories a user is starring.'
        )
        .optional()
    })
    .describe('The permissions granted to the user access token.')
  export type AppPermissions = z.infer<typeof AppPermissionsSchema>

  export const NullableSimpleUserSchema = z
    .object({
      name: z.string().optional(),
      email: z.string().optional(),
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      starred_at: z.string().optional(),
      user_view_type: z.string().optional()
    })
    .describe('A GitHub user.')
  export type NullableSimpleUser = z.infer<typeof NullableSimpleUserSchema>

  export const SinceSchema = z
    .any()
    .describe(
      'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type Since = z.infer<typeof SinceSchema>

  export const InstallationIdSchema = z
    .any()
    .describe('The unique identifier of the installation.')
  export type InstallationId = z.infer<typeof InstallationIdSchema>

  export const NullableLicenseSimpleSchema = z
    .object({
      key: z.string(),
      name: z.string(),
      url: z.string().url(),
      spdx_id: z.string(),
      node_id: z.string(),
      html_url: z.string().url().optional()
    })
    .describe('License Simple')
  export type NullableLicenseSimple = z.infer<
    typeof NullableLicenseSimpleSchema
  >

  export const ClientIdSchema = z
    .any()
    .describe('The client ID of the GitHub app.')
  export type ClientId = z.infer<typeof ClientIdSchema>

  export const AppSlugSchema = z.any()
  export type AppSlug = z.infer<typeof AppSlugSchema>

  export const SimpleClassroomRepositorySchema = z
    .object({
      id: z.number().int().describe('A unique identifier of the repository.'),
      full_name: z
        .string()
        .describe('The full, globally unique name of the repository.'),
      html_url: z
        .string()
        .url()
        .describe('The URL to view the repository on GitHub.com.'),
      node_id: z.string().describe('The GraphQL identifier of the repository.'),
      private: z.boolean().describe('Whether the repository is private.'),
      default_branch: z
        .string()
        .describe('The default branch for the repository.')
    })
    .describe('A GitHub repository view for Classroom')
  export type SimpleClassroomRepository = z.infer<
    typeof SimpleClassroomRepositorySchema
  >

  export const SimpleClassroomOrganizationSchema = z
    .object({
      id: z.number().int(),
      login: z.string(),
      node_id: z.string(),
      html_url: z.string().url(),
      name: z.string(),
      avatar_url: z.string()
    })
    .describe('A GitHub organization.')
  export type SimpleClassroomOrganization = z.infer<
    typeof SimpleClassroomOrganizationSchema
  >

  export const AssignmentIdSchema = z
    .any()
    .describe('The unique identifier of the classroom assignment.')
  export type AssignmentId = z.infer<typeof AssignmentIdSchema>

  export const SimpleClassroomUserSchema = z
    .object({
      id: z.number().int(),
      login: z.string(),
      avatar_url: z.string().url(),
      html_url: z.string().url()
    })
    .describe('A GitHub user simplified for Classroom.')
  export type SimpleClassroomUser = z.infer<typeof SimpleClassroomUserSchema>

  export const SimpleClassroomSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the classroom.'),
      name: z.string().describe('The name of the classroom.'),
      archived: z
        .boolean()
        .describe('Returns whether classroom is archived or not.'),
      url: z.string().describe('The url of the classroom on GitHub Classroom.')
    })
    .describe('A GitHub Classroom classroom')
  export type SimpleClassroom = z.infer<typeof SimpleClassroomSchema>

  export const ClassroomAssignmentGradeSchema = z
    .object({
      assignment_name: z.string().describe('Name of the assignment'),
      assignment_url: z.string().describe('URL of the assignment'),
      starter_code_url: z
        .string()
        .describe('URL of the starter code for the assignment'),
      github_username: z.string().describe('GitHub username of the student'),
      roster_identifier: z
        .string()
        .describe('Roster identifier of the student'),
      student_repository_name: z
        .string()
        .describe("Name of the student's assignment repository"),
      student_repository_url: z
        .string()
        .describe("URL of the student's assignment repository"),
      submission_timestamp: z
        .string()
        .describe("Timestamp of the student's assignment submission"),
      points_awarded: z
        .number()
        .int()
        .describe('Number of points awarded to the student'),
      points_available: z
        .number()
        .int()
        .describe('Number of points available for the assignment'),
      group_name: z
        .string()
        .describe('If a group assignment, name of the group the student is in')
        .optional()
    })
    .describe('Grade for a student or groups GitHub Classroom assignment')
  export type ClassroomAssignmentGrade = z.infer<
    typeof ClassroomAssignmentGradeSchema
  >

  export const ClassroomIdSchema = z
    .any()
    .describe('The unique identifier of the classroom.')
  export type ClassroomId = z.infer<typeof ClassroomIdSchema>

  export const CodeOfConductSchema = z
    .object({
      key: z.string(),
      name: z.string(),
      url: z.string().url(),
      body: z.string().optional(),
      html_url: z.string().url()
    })
    .describe('Code Of Conduct')
  export type CodeOfConduct = z.infer<typeof CodeOfConductSchema>

  export const CodeSecurityConfigurationSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('The ID of the code security configuration')
        .optional(),
      name: z
        .string()
        .describe(
          'The name of the code security configuration. Must be unique within the organization.'
        )
        .optional(),
      target_type: z
        .enum(['global', 'organization', 'enterprise'])
        .describe('The type of the code security configuration.')
        .optional(),
      description: z
        .string()
        .describe('A description of the code security configuration')
        .optional(),
      advanced_security: z
        .enum(['enabled', 'disabled'])
        .describe('The enablement status of GitHub Advanced Security')
        .optional(),
      dependency_graph: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependency Graph')
        .optional(),
      dependency_graph_autosubmit_action: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Automatic dependency submission')
        .optional(),
      dependency_graph_autosubmit_action_options: z
        .object({
          labeled_runners: z
            .boolean()
            .describe(
              "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
            )
            .optional()
        })
        .describe('Feature options for Automatic dependency submission')
        .optional(),
      dependabot_alerts: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot alerts')
        .optional(),
      dependabot_security_updates: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot security updates')
        .optional(),
      code_scanning_default_setup: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of code scanning default setup')
        .optional(),
      code_scanning_default_setup_options: z
        .object({
          runner_type: z
            .enum(['standard', 'labeled', 'not_set'])
            .describe(
              'Whether to use labeled runners or standard GitHub runners.'
            )
            .optional(),
          runner_label: z
            .string()
            .describe(
              "The label of the runner to use for code scanning when runner_type is 'labeled'."
            )
            .optional()
        })
        .describe('Feature options for code scanning default setup')
        .optional(),
      code_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of code scanning delegated alert dismissal'
        )
        .optional(),
      secret_scanning: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning')
        .optional(),
      secret_scanning_push_protection: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning push protection')
        .optional(),
      secret_scanning_delegated_bypass: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning delegated bypass')
        .optional(),
      secret_scanning_delegated_bypass_options: z
        .object({
          reviewers: z
            .array(
              z.object({
                reviewer_id: z
                  .number()
                  .int()
                  .describe(
                    'The ID of the team or role selected as a bypass reviewer'
                  ),
                reviewer_type: z
                  .enum(['TEAM', 'ROLE'])
                  .describe('The type of the bypass reviewer')
              })
            )
            .describe(
              'The bypass reviewers for secret scanning delegated bypass'
            )
            .optional()
        })
        .describe('Feature options for secret scanning delegated bypass')
        .optional(),
      secret_scanning_validity_checks: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning validity checks')
        .optional(),
      secret_scanning_non_provider_patterns: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning non-provider patterns'
        )
        .optional(),
      secret_scanning_generic_secrets: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Copilot secret scanning')
        .optional(),
      secret_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning delegated alert dismissal'
        )
        .optional(),
      private_vulnerability_reporting: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of private vulnerability reporting')
        .optional(),
      enforcement: z
        .enum(['enforced', 'unenforced'])
        .describe('The enforcement status for a security configuration')
        .optional(),
      url: z.string().url().describe('The URL of the configuration').optional(),
      html_url: z
        .string()
        .url()
        .describe('The URL of the configuration')
        .optional(),
      created_at: z.string().datetime({ offset: true }).optional(),
      updated_at: z.string().datetime({ offset: true }).optional()
    })
    .describe('A code security configuration')
  export type CodeSecurityConfiguration = z.infer<
    typeof CodeSecurityConfigurationSchema
  >

  export const CodeScanningDefaultSetupOptionsSchema = z
    .object({
      runner_type: z
        .enum(['standard', 'labeled', 'not_set'])
        .describe('Whether to use labeled runners or standard GitHub runners.')
        .optional(),
      runner_label: z
        .string()
        .describe(
          "The label of the runner to use for code scanning default setup when runner_type is 'labeled'."
        )
        .optional()
    })
    .describe('Feature options for code scanning default setup')
  export type CodeScanningDefaultSetupOptions = z.infer<
    typeof CodeScanningDefaultSetupOptionsSchema
  >

  export const ConfigurationIdSchema = z
    .any()
    .describe('The unique identifier of the code security configuration.')
  export type ConfigurationId = z.infer<typeof ConfigurationIdSchema>

  export const AlertNumberSchema = z
    .any()
    .describe(
      'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
    )
  export type AlertNumber = z.infer<typeof AlertNumberSchema>

  export const DependabotAlertPackageSchema = z
    .object({
      ecosystem: z
        .string()
        .describe("The package's language or package management ecosystem.")
        .readonly(),
      name: z
        .string()
        .describe('The unique package name within its ecosystem.')
        .readonly()
    })
    .strict()
    .describe('Details for the vulnerable package.')
    .readonly()
  export type DependabotAlertPackage = z.infer<
    typeof DependabotAlertPackageSchema
  >

  export const AlertUrlSchema = z
    .string()
    .url()
    .describe('The REST API URL of the alert resource.')
    .readonly()
  export type AlertUrl = z.infer<typeof AlertUrlSchema>

  export const AlertHtmlUrlSchema = z
    .string()
    .url()
    .describe('The GitHub URL of the alert resource.')
    .readonly()
  export type AlertHtmlUrl = z.infer<typeof AlertHtmlUrlSchema>

  export const AlertCreatedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type AlertCreatedAt = z.infer<typeof AlertCreatedAtSchema>

  export const AlertUpdatedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type AlertUpdatedAt = z.infer<typeof AlertUpdatedAtSchema>

  export const AlertDismissedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type AlertDismissedAt = z.infer<typeof AlertDismissedAtSchema>

  export const AlertFixedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type AlertFixedAt = z.infer<typeof AlertFixedAtSchema>

  export const AlertAutoDismissedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type AlertAutoDismissedAt = z.infer<typeof AlertAutoDismissedAtSchema>

  export const DependabotAlertCommaSeparatedStatesSchema = z
    .any()
    .describe(
      'A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`'
    )
  export type DependabotAlertCommaSeparatedStates = z.infer<
    typeof DependabotAlertCommaSeparatedStatesSchema
  >

  export const DependabotAlertCommaSeparatedSeveritiesSchema = z
    .any()
    .describe(
      'A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`'
    )
  export type DependabotAlertCommaSeparatedSeverities = z.infer<
    typeof DependabotAlertCommaSeparatedSeveritiesSchema
  >

  export const DependabotAlertCommaSeparatedEcosystemsSchema = z
    .any()
    .describe(
      'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`'
    )
  export type DependabotAlertCommaSeparatedEcosystems = z.infer<
    typeof DependabotAlertCommaSeparatedEcosystemsSchema
  >

  export const DependabotAlertCommaSeparatedPackagesSchema = z
    .any()
    .describe(
      'A comma-separated list of package names. If specified, only alerts for these packages will be returned.'
    )
  export type DependabotAlertCommaSeparatedPackages = z.infer<
    typeof DependabotAlertCommaSeparatedPackagesSchema
  >

  export const DependabotAlertCommaSeparatedEpssSchema = z
    .any()
    .describe(
      'CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.'
    )
  export type DependabotAlertCommaSeparatedEpss = z.infer<
    typeof DependabotAlertCommaSeparatedEpssSchema
  >

  export const DependabotAlertScopeSchema = z
    .any()
    .describe(
      'The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.'
    )
  export type DependabotAlertScope = z.infer<typeof DependabotAlertScopeSchema>

  export const DependabotAlertSortSchema = z
    .any()
    .describe(
      "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage."
    )
  export type DependabotAlertSort = z.infer<typeof DependabotAlertSortSchema>

  export const PaginationFirstSchema = z
    .any()
    .describe(
      '**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.'
    )
  export type PaginationFirst = z.infer<typeof PaginationFirstSchema>

  export const PaginationLastSchema = z
    .any()
    .describe(
      '**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.'
    )
  export type PaginationLast = z.infer<typeof PaginationLastSchema>

  export const NullableAlertUpdatedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type NullableAlertUpdatedAt = z.infer<
    typeof NullableAlertUpdatedAtSchema
  >

  export const SecretScanningAlertStateSchema = z
    .any()
    .describe(
      'Set to `open` or `resolved` to only list secret scanning alerts in a specific state.'
    )
  export type SecretScanningAlertState = z.infer<
    typeof SecretScanningAlertStateSchema
  >

  export const SecretScanningAlertResolutionSchema = z
    .any()
    .describe(
      'A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.'
    )
  export type SecretScanningAlertResolution = z.infer<
    typeof SecretScanningAlertResolutionSchema
  >

  export const SecretScanningAlertSecretTypeSchema = z
    .any()
    .describe(
      'A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.'
    )
  export type SecretScanningAlertSecretType = z.infer<
    typeof SecretScanningAlertSecretTypeSchema
  >

  export const SecretScanningAlertSortSchema = z
    .any()
    .describe(
      'The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.'
    )
  export type SecretScanningAlertSort = z.infer<
    typeof SecretScanningAlertSortSchema
  >

  export const SecretScanningAlertValiditySchema = z
    .any()
    .describe(
      'A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.'
    )
  export type SecretScanningAlertValidity = z.infer<
    typeof SecretScanningAlertValiditySchema
  >

  export const SecretScanningAlertPubliclyLeakedSchema = z
    .any()
    .describe(
      'A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.'
    )
  export type SecretScanningAlertPubliclyLeaked = z.infer<
    typeof SecretScanningAlertPubliclyLeakedSchema
  >

  export const SecretScanningAlertMultiRepoSchema = z
    .any()
    .describe(
      'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.'
    )
  export type SecretScanningAlertMultiRepo = z.infer<
    typeof SecretScanningAlertMultiRepoSchema
  >

  export const ActorSchema = z
    .any()
    .describe(
      "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run."
    )
  export type Actor = z.infer<typeof ActorSchema>

  export const IssueTypeSchema = z
    .object({
      id: z.number().int().describe('The unique identifier of the issue type.'),
      node_id: z.string().describe('The node identifier of the issue type.'),
      name: z.string().describe('The name of the issue type.'),
      description: z.string().describe('The description of the issue type.'),
      color: z
        .enum([
          'gray',
          'blue',
          'green',
          'yellow',
          'orange',
          'red',
          'pink',
          'purple'
        ])
        .describe('The color of the issue type.')
        .optional(),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time the issue type created.')
        .optional(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time the issue type last updated.')
        .optional(),
      is_enabled: z
        .boolean()
        .describe('The enabled state of the issue type.')
        .optional()
    })
    .describe('The type of issue.')
  export type IssueType = z.infer<typeof IssueTypeSchema>

  export const AuthorAssociationSchema = z
    .enum([
      'COLLABORATOR',
      'CONTRIBUTOR',
      'FIRST_TIMER',
      'FIRST_TIME_CONTRIBUTOR',
      'MANNEQUIN',
      'MEMBER',
      'NONE',
      'OWNER'
    ])
    .describe('How the author is associated with the repository.')
  export type AuthorAssociation = z.infer<typeof AuthorAssociationSchema>

  export const ReactionRollupSchema = z.object({
    url: z.string().url(),
    total_count: z.number().int(),
    '+1': z.number().int(),
    '-1': z.number().int(),
    laugh: z.number().int(),
    confused: z.number().int(),
    heart: z.number().int(),
    hooray: z.number().int(),
    eyes: z.number().int(),
    rocket: z.number().int()
  })
  export type ReactionRollup = z.infer<typeof ReactionRollupSchema>

  export const SubIssuesSummarySchema = z.object({
    total: z.number().int(),
    completed: z.number().int(),
    percent_completed: z.number().int()
  })
  export type SubIssuesSummary = z.infer<typeof SubIssuesSummarySchema>

  export const LinkWithTypeSchema = z
    .object({ href: z.string(), type: z.string() })
    .describe('Hypermedia Link with Type')
  export type LinkWithType = z.infer<typeof LinkWithTypeSchema>

  export const PublicUserSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      user_view_type: z.string().optional(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      name: z.string(),
      company: z.string(),
      blog: z.string(),
      location: z.string(),
      email: z.string().email(),
      notification_email: z.string().email().optional(),
      hireable: z.boolean(),
      bio: z.string(),
      twitter_username: z.string().optional(),
      public_repos: z.number().int(),
      public_gists: z.number().int(),
      followers: z.number().int(),
      following: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      plan: z
        .object({
          collaborators: z.number().int(),
          name: z.string(),
          space: z.number().int(),
          private_repos: z.number().int()
        })
        .optional(),
      private_gists: z.number().int().optional(),
      total_private_repos: z.number().int().optional(),
      owned_private_repos: z.number().int().optional(),
      disk_usage: z.number().int().optional(),
      collaborators: z.number().int().optional()
    })
    .strict()
    .describe('Public User')
  export type PublicUser = z.infer<typeof PublicUserSchema>

  export const GistIdSchema = z
    .any()
    .describe('The unique identifier of the gist.')
  export type GistId = z.infer<typeof GistIdSchema>

  export const CommentIdSchema = z
    .any()
    .describe('The unique identifier of the comment.')
  export type CommentId = z.infer<typeof CommentIdSchema>

  export const GitignoreTemplateSchema = z
    .object({ name: z.string(), source: z.string() })
    .describe('Gitignore Template')
  export type GitignoreTemplate = z.infer<typeof GitignoreTemplateSchema>

  export const LabelsSchema = z
    .any()
    .describe('A list of comma separated label names. Example: `bug,ui,@high`')
  export type Labels = z.infer<typeof LabelsSchema>

  export const LicenseSimpleSchema = z
    .object({
      key: z.string(),
      name: z.string(),
      url: z.string().url(),
      spdx_id: z.string(),
      node_id: z.string(),
      html_url: z.string().url().optional()
    })
    .describe('License Simple')
  export type LicenseSimple = z.infer<typeof LicenseSimpleSchema>

  export const LicenseSchema = z
    .object({
      key: z.string(),
      name: z.string(),
      spdx_id: z.string(),
      url: z.string().url(),
      node_id: z.string(),
      html_url: z.string().url(),
      description: z.string(),
      implementation: z.string(),
      permissions: z.array(z.string()),
      conditions: z.array(z.string()),
      limitations: z.array(z.string()),
      body: z.string(),
      featured: z.boolean()
    })
    .describe('License')
  export type License = z.infer<typeof LicenseSchema>

  export const MarketplaceListingPlanSchema = z
    .object({
      url: z.string().url(),
      accounts_url: z.string().url(),
      id: z.number().int(),
      number: z.number().int(),
      name: z.string(),
      description: z.string(),
      monthly_price_in_cents: z.number().int(),
      yearly_price_in_cents: z.number().int(),
      price_model: z.enum(['FREE', 'FLAT_RATE', 'PER_UNIT']),
      has_free_trial: z.boolean(),
      unit_name: z.string(),
      state: z.string(),
      bullets: z.array(z.string())
    })
    .describe('Marketplace Listing Plan')
  export type MarketplaceListingPlan = z.infer<
    typeof MarketplaceListingPlanSchema
  >

  export const AccountIdSchema = z.any().describe('account_id parameter')
  export type AccountId = z.infer<typeof AccountIdSchema>

  export const PlanIdSchema = z
    .any()
    .describe('The unique identifier of the plan.')
  export type PlanId = z.infer<typeof PlanIdSchema>

  export const SortSchema = z
    .any()
    .describe('The property to sort the results by.')
  export type Sort = z.infer<typeof SortSchema>

  export const ApiOverviewSchema = z
    .object({
      verifiable_password_authentication: z.boolean(),
      ssh_key_fingerprints: z
        .object({
          SHA256_RSA: z.string().optional(),
          SHA256_DSA: z.string().optional(),
          SHA256_ECDSA: z.string().optional(),
          SHA256_ED25519: z.string().optional()
        })
        .optional(),
      ssh_keys: z.array(z.string()).optional(),
      hooks: z.array(z.string()).optional(),
      github_enterprise_importer: z.array(z.string()).optional(),
      web: z.array(z.string()).optional(),
      api: z.array(z.string()).optional(),
      git: z.array(z.string()).optional(),
      packages: z.array(z.string()).optional(),
      pages: z.array(z.string()).optional(),
      importer: z.array(z.string()).optional(),
      actions: z.array(z.string()).optional(),
      actions_macos: z.array(z.string()).optional(),
      codespaces: z.array(z.string()).optional(),
      dependabot: z.array(z.string()).optional(),
      copilot: z.array(z.string()).optional(),
      domains: z
        .object({
          website: z.array(z.string()).optional(),
          codespaces: z.array(z.string()).optional(),
          copilot: z.array(z.string()).optional(),
          packages: z.array(z.string()).optional(),
          actions: z.array(z.string()).optional(),
          actions_inbound: z
            .object({
              full_domains: z.array(z.string()).optional(),
              wildcard_domains: z.array(z.string()).optional()
            })
            .optional(),
          artifact_attestations: z
            .object({
              trust_domain: z.string().optional(),
              services: z.array(z.string()).optional()
            })
            .optional()
        })
        .optional()
    })
    .describe('Api Overview')
  export type ApiOverview = z.infer<typeof ApiOverviewSchema>

  export const OwnerSchema = z
    .any()
    .describe(
      'The account owner of the repository. The name is not case sensitive.'
    )
  export type Owner = z.infer<typeof OwnerSchema>

  export const RepoSchema = z
    .any()
    .describe(
      'The name of the repository without the `.git` extension. The name is not case sensitive.'
    )
  export type Repo = z.infer<typeof RepoSchema>

  export const SecurityAndAnalysisSchema = z.object({
    advanced_security: z
      .object({ status: z.enum(['enabled', 'disabled']).optional() })
      .optional(),
    dependabot_security_updates: z
      .object({
        status: z
          .enum(['enabled', 'disabled'])
          .describe(
            'The enablement status of Dependabot security updates for the repository.'
          )
          .optional()
      })
      .describe(
        'Enable or disable Dependabot security updates for the repository.'
      )
      .optional(),
    secret_scanning: z
      .object({ status: z.enum(['enabled', 'disabled']).optional() })
      .optional(),
    secret_scanning_push_protection: z
      .object({ status: z.enum(['enabled', 'disabled']).optional() })
      .optional(),
    secret_scanning_non_provider_patterns: z
      .object({ status: z.enum(['enabled', 'disabled']).optional() })
      .optional(),
    secret_scanning_ai_detection: z
      .object({ status: z.enum(['enabled', 'disabled']).optional() })
      .optional()
  })
  export type SecurityAndAnalysis = z.infer<typeof SecurityAndAnalysisSchema>

  export const AllSchema = z
    .any()
    .describe('If `true`, show notifications marked as read.')
  export type All = z.infer<typeof AllSchema>

  export const ParticipatingSchema = z
    .any()
    .describe(
      'If `true`, only shows notifications in which the user is directly participating or mentioned.'
    )
  export type Participating = z.infer<typeof ParticipatingSchema>

  export const BeforeSchema = z
    .any()
    .describe(
      'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type Before = z.infer<typeof BeforeSchema>

  export const ThreadIdSchema = z
    .any()
    .describe(
      'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
    )
  export type ThreadId = z.infer<typeof ThreadIdSchema>

  export const ThreadSubscriptionSchema = z
    .object({
      subscribed: z.boolean(),
      ignored: z.boolean(),
      reason: z.string(),
      created_at: z.string().datetime({ offset: true }),
      url: z.string().url(),
      thread_url: z.string().url().optional(),
      repository_url: z.string().url().optional()
    })
    .describe('Thread Subscription')
  export type ThreadSubscription = z.infer<typeof ThreadSubscriptionSchema>

  export const OrganizationSimpleSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string().url(),
      hooks_url: z.string(),
      issues_url: z.string(),
      members_url: z.string(),
      public_members_url: z.string(),
      avatar_url: z.string(),
      description: z.string()
    })
    .describe('A GitHub organization.')
  export type OrganizationSimple = z.infer<typeof OrganizationSimpleSchema>

  export const SinceOrgSchema = z
    .any()
    .describe(
      'An organization ID. Only return organizations with an ID greater than this ID.'
    )
  export type SinceOrg = z.infer<typeof SinceOrgSchema>

  export const BillingUsageReportSchema = z.object({
    usageItems: z
      .array(
        z.object({
          date: z.string().describe('Date of the usage line item.'),
          product: z.string().describe('Product name.'),
          sku: z.string().describe('SKU name.'),
          quantity: z
            .number()
            .int()
            .describe('Quantity of the usage line item.'),
          unitType: z.string().describe('Unit type of the usage line item.'),
          pricePerUnit: z
            .number()
            .describe('Price per unit of the usage line item.'),
          grossAmount: z
            .number()
            .describe('Gross amount of the usage line item.'),
          discountAmount: z
            .number()
            .describe('Discount amount of the usage line item.'),
          netAmount: z.number().describe('Net amount of the usage line item.'),
          organizationName: z.string().describe('Name of the organization.'),
          repositoryName: z
            .string()
            .describe('Name of the repository.')
            .optional()
        })
      )
      .optional()
  })
  export type BillingUsageReport = z.infer<typeof BillingUsageReportSchema>

  export const OrgSchema = z
    .any()
    .describe('The organization name. The name is not case sensitive.')
  export type Org = z.infer<typeof OrgSchema>

  export const BillingUsageReportYearSchema = z
    .any()
    .describe(
      'If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.'
    )
  export type BillingUsageReportYear = z.infer<
    typeof BillingUsageReportYearSchema
  >

  export const BillingUsageReportMonthSchema = z
    .any()
    .describe(
      'If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.'
    )
  export type BillingUsageReportMonth = z.infer<
    typeof BillingUsageReportMonthSchema
  >

  export const BillingUsageReportDaySchema = z
    .any()
    .describe(
      'If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.'
    )
  export type BillingUsageReportDay = z.infer<
    typeof BillingUsageReportDaySchema
  >

  export const BillingUsageReportHourSchema = z
    .any()
    .describe(
      'If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.'
    )
  export type BillingUsageReportHour = z.infer<
    typeof BillingUsageReportHourSchema
  >

  export const OrganizationFullSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string().url(),
      hooks_url: z.string(),
      issues_url: z.string(),
      members_url: z.string(),
      public_members_url: z.string(),
      avatar_url: z.string(),
      description: z.string(),
      name: z.string().optional(),
      company: z.string().optional(),
      blog: z.string().url().optional(),
      location: z.string().optional(),
      email: z.string().email().optional(),
      twitter_username: z.string().optional(),
      is_verified: z.boolean().optional(),
      has_organization_projects: z.boolean(),
      has_repository_projects: z.boolean(),
      public_repos: z.number().int(),
      public_gists: z.number().int(),
      followers: z.number().int(),
      following: z.number().int(),
      html_url: z.string().url(),
      type: z.string(),
      total_private_repos: z.number().int().optional(),
      owned_private_repos: z.number().int().optional(),
      private_gists: z.number().int().optional(),
      disk_usage: z.number().int().optional(),
      collaborators: z
        .number()
        .int()
        .describe(
          'The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000.'
        )
        .optional(),
      billing_email: z.string().email().optional(),
      plan: z
        .object({
          name: z.string(),
          space: z.number().int(),
          private_repos: z.number().int(),
          filled_seats: z.number().int().optional(),
          seats: z.number().int().optional()
        })
        .optional(),
      default_repository_permission: z.string().optional(),
      members_can_create_repositories: z.boolean().optional(),
      two_factor_requirement_enabled: z.boolean().optional(),
      members_allowed_repository_creation_type: z.string().optional(),
      members_can_create_public_repositories: z.boolean().optional(),
      members_can_create_private_repositories: z.boolean().optional(),
      members_can_create_internal_repositories: z.boolean().optional(),
      members_can_create_pages: z.boolean().optional(),
      members_can_create_public_pages: z.boolean().optional(),
      members_can_create_private_pages: z.boolean().optional(),
      members_can_fork_private_repositories: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional(),
      advanced_security_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      dependabot_alerts_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      dependabot_security_updates_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      dependency_graph_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      secret_scanning_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      secret_scanning_push_protection_enabled_for_new_repositories: z
        .boolean()
        .describe(
          '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.'
        )
        .optional(),
      secret_scanning_push_protection_custom_link_enabled: z
        .boolean()
        .describe(
          'Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.'
        )
        .optional(),
      secret_scanning_push_protection_custom_link: z
        .string()
        .describe(
          'An optional URL string to display to contributors who are blocked from pushing a secret.'
        )
        .optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      archived_at: z.string().datetime({ offset: true }),
      deploy_keys_enabled_for_repositories: z
        .boolean()
        .describe(
          'Controls whether or not deploy keys may be added and used for repositories in the organization.'
        )
        .optional()
    })
    .describe('Organization Full')
  export type OrganizationFull = z.infer<typeof OrganizationFullSchema>

  export const ActionsCacheUsageOrgEnterpriseSchema = z.object({
    total_active_caches_count: z
      .number()
      .int()
      .describe(
        'The count of active caches across all repositories of an enterprise or an organization.'
      ),
    total_active_caches_size_in_bytes: z
      .number()
      .int()
      .describe(
        'The total size in bytes of all active cache items across all repositories of an enterprise or an organization.'
      )
  })
  export type ActionsCacheUsageOrgEnterprise = z.infer<
    typeof ActionsCacheUsageOrgEnterpriseSchema
  >

  export const ActionsCacheUsageByRepositorySchema = z
    .object({
      full_name: z
        .string()
        .describe(
          'The repository owner and name for the cache usage being shown.'
        ),
      active_caches_size_in_bytes: z
        .number()
        .int()
        .describe(
          'The sum of the size in bytes of all the active cache items in the repository.'
        ),
      active_caches_count: z
        .number()
        .int()
        .describe('The number of active caches in the repository.')
    })
    .describe('GitHub Actions Cache Usage by repository.')
  export type ActionsCacheUsageByRepository = z.infer<
    typeof ActionsCacheUsageByRepositorySchema
  >

  export const NullableActionsHostedRunnerPoolImageSchema = z
    .object({
      id: z
        .string()
        .describe(
          'The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.'
        ),
      size_gb: z.number().int().describe('Image size in GB.'),
      display_name: z.string().describe('Display name for this image.'),
      source: z
        .enum(['github', 'partner', 'custom'])
        .describe('The image provider.')
    })
    .describe('Provides details of a hosted runner image')
  export type NullableActionsHostedRunnerPoolImage = z.infer<
    typeof NullableActionsHostedRunnerPoolImageSchema
  >

  export const ActionsHostedRunnerMachineSpecSchema = z
    .object({
      id: z
        .string()
        .describe(
          'The ID used for the `size` parameter when creating a new runner.'
        ),
      cpu_cores: z.number().int().describe('The number of cores.'),
      memory_gb: z
        .number()
        .int()
        .describe('The available RAM for the machine spec.'),
      storage_gb: z
        .number()
        .int()
        .describe('The available SSD storage for the machine spec.')
    })
    .describe('Provides details of a particular machine spec.')
  export type ActionsHostedRunnerMachineSpec = z.infer<
    typeof ActionsHostedRunnerMachineSpecSchema
  >

  export const PublicIpSchema = z
    .object({
      enabled: z.boolean().describe('Whether public IP is enabled.').optional(),
      prefix: z.string().describe('The prefix for the public IP.').optional(),
      length: z
        .number()
        .int()
        .describe('The length of the IP prefix.')
        .optional()
    })
    .describe(
      'Provides details of Public IP for a GitHub-hosted larger runners'
    )
  export type PublicIp = z.infer<typeof PublicIpSchema>

  export const ActionsHostedRunnerImageSchema = z
    .object({
      id: z
        .string()
        .describe(
          'The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.'
        ),
      platform: z.string().describe('The operating system of the image.'),
      size_gb: z.number().int().describe('Image size in GB.'),
      display_name: z.string().describe('Display name for this image.'),
      source: z
        .enum(['github', 'partner', 'custom'])
        .describe('The image provider.')
    })
    .describe('Provides details of a hosted runner image')
  export type ActionsHostedRunnerImage = z.infer<
    typeof ActionsHostedRunnerImageSchema
  >

  export const ActionsHostedRunnerLimitsSchema = z.object({
    public_ips: z
      .object({
        maximum: z
          .number()
          .int()
          .describe(
            'The maximum number of static public IP addresses that can be used for Hosted Runners.'
          ),
        current_usage: z
          .number()
          .int()
          .describe(
            'The current number of static public IP addresses in use by Hosted Runners.'
          )
      })
      .describe(
        'Provides details of static public IP limits for GitHub-hosted Hosted Runners'
      )
  })
  export type ActionsHostedRunnerLimits = z.infer<
    typeof ActionsHostedRunnerLimitsSchema
  >

  export const HostedRunnerIdSchema = z
    .any()
    .describe('Unique identifier of the GitHub-hosted runner.')
  export type HostedRunnerId = z.infer<typeof HostedRunnerIdSchema>

  export const OidcCustomSubSchema = z
    .object({
      include_claim_keys: z
        .array(z.string())
        .describe(
          'Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.'
        )
    })
    .describe('Actions OIDC Subject customization')
  export type OidcCustomSub = z.infer<typeof OidcCustomSubSchema>

  export const EmptyObjectSchema = z
    .object({})
    .strict()
    .describe('An object without any properties.')
  export type EmptyObject = z.infer<typeof EmptyObjectSchema>

  export const EnabledRepositoriesSchema = z
    .enum(['all', 'none', 'selected'])
    .describe(
      'The policy that controls the repositories in the organization that are allowed to run GitHub Actions.'
    )
  export type EnabledRepositories = z.infer<typeof EnabledRepositoriesSchema>

  export const AllowedActionsSchema = z
    .enum(['all', 'local_only', 'selected'])
    .describe(
      'The permissions policy that controls the actions and reusable workflows that are allowed to run.'
    )
  export type AllowedActions = z.infer<typeof AllowedActionsSchema>

  export const SelectedActionsUrlSchema = z
    .string()
    .describe(
      'The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`.'
    )
  export type SelectedActionsUrl = z.infer<typeof SelectedActionsUrlSchema>

  export const RepositoryIdSchema = z
    .any()
    .describe('The unique identifier of the repository.')
  export type RepositoryId = z.infer<typeof RepositoryIdSchema>

  export const SelectedActionsSchema = z.object({
    github_owned_allowed: z
      .boolean()
      .describe(
        'Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.'
      )
      .optional(),
    verified_allowed: z
      .boolean()
      .describe(
        'Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.'
      )
      .optional(),
    patterns_allowed: z
      .array(z.string())
      .describe(
        'Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.'
      )
      .optional()
  })
  export type SelectedActions = z.infer<typeof SelectedActionsSchema>

  export const ActionsDefaultWorkflowPermissionsSchema = z
    .enum(['read', 'write'])
    .describe(
      'The default workflow permissions granted to the GITHUB_TOKEN when running workflows.'
    )
  export type ActionsDefaultWorkflowPermissions = z.infer<
    typeof ActionsDefaultWorkflowPermissionsSchema
  >

  export const ActionsCanApprovePullRequestReviewsSchema = z
    .boolean()
    .describe(
      'Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.'
    )
  export type ActionsCanApprovePullRequestReviews = z.infer<
    typeof ActionsCanApprovePullRequestReviewsSchema
  >

  export const RunnerGroupsOrgSchema = z.object({
    id: z.number(),
    name: z.string(),
    visibility: z.string(),
    default: z.boolean(),
    selected_repositories_url: z
      .string()
      .describe(
        'Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`'
      )
      .optional(),
    runners_url: z.string(),
    hosted_runners_url: z.string().optional(),
    network_configuration_id: z
      .string()
      .describe('The identifier of a hosted compute network configuration.')
      .optional(),
    inherited: z.boolean(),
    inherited_allows_public_repositories: z.boolean().optional(),
    allows_public_repositories: z.boolean(),
    workflow_restrictions_read_only: z
      .boolean()
      .describe(
        'If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.'
      )
      .default(false),
    restricted_to_workflows: z
      .boolean()
      .describe(
        'If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.'
      )
      .default(false),
    selected_workflows: z
      .array(
        z
          .string()
          .describe(
            'Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.'
          )
      )
      .describe(
        'List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.'
      )
      .optional()
  })
  export type RunnerGroupsOrg = z.infer<typeof RunnerGroupsOrgSchema>

  export const VisibleToRepositorySchema = z
    .any()
    .describe(
      'Only return runner groups that are allowed to be used by this repository.'
    )
  export type VisibleToRepository = z.infer<typeof VisibleToRepositorySchema>

  export const RunnerGroupIdSchema = z
    .any()
    .describe('Unique identifier of the self-hosted runner group.')
  export type RunnerGroupId = z.infer<typeof RunnerGroupIdSchema>

  export const RunnerLabelSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('Unique identifier of the label.')
        .optional(),
      name: z.string().describe('Name of the label.'),
      type: z
        .enum(['read-only', 'custom'])
        .describe(
          'The type of label. Read-only labels are applied automatically when the runner is configured.'
        )
        .optional()
    })
    .describe('A label for a self hosted runner')
  export type RunnerLabel = z.infer<typeof RunnerLabelSchema>

  export const RunnerIdSchema = z
    .any()
    .describe('Unique identifier of the self-hosted runner.')
  export type RunnerId = z.infer<typeof RunnerIdSchema>

  export const RunnerApplicationSchema = z
    .object({
      os: z.string(),
      architecture: z.string(),
      download_url: z.string(),
      filename: z.string(),
      temp_download_token: z
        .string()
        .describe(
          'A short lived bearer token used to download the runner, if needed.'
        )
        .optional(),
      sha256_checksum: z.string().optional()
    })
    .describe('Runner Application')
  export type RunnerApplication = z.infer<typeof RunnerApplicationSchema>

  export const RunnerLabelNameSchema = z
    .any()
    .describe("The name of a self-hosted runner's custom label.")
  export type RunnerLabelName = z.infer<typeof RunnerLabelNameSchema>

  export const OrganizationActionsSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe('Visibility of a secret'),
      selected_repositories_url: z.string().url().optional()
    })
    .describe('Secrets for GitHub Actions for an organization.')
  export type OrganizationActionsSecret = z.infer<
    typeof OrganizationActionsSecretSchema
  >

  export const ActionsPublicKeySchema = z
    .object({
      key_id: z.string().describe('The identifier for the key.'),
      key: z.string().describe('The Base64 encoded public key.'),
      id: z.number().int().optional(),
      url: z.string().optional(),
      title: z.string().optional(),
      created_at: z.string().optional()
    })
    .describe('The public key used for setting Actions Secrets.')
  export type ActionsPublicKey = z.infer<typeof ActionsPublicKeySchema>

  export const SecretNameSchema = z.any().describe('The name of the secret.')
  export type SecretName = z.infer<typeof SecretNameSchema>

  export const OrganizationActionsVariableSchema = z
    .object({
      name: z.string().describe('The name of the variable.'),
      value: z.string().describe('The value of the variable.'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe('Visibility of a variable'),
      selected_repositories_url: z.string().url().optional()
    })
    .describe('Organization variable for GitHub Actions.')
  export type OrganizationActionsVariable = z.infer<
    typeof OrganizationActionsVariableSchema
  >

  export const VariablesPerPageSchema = z
    .any()
    .describe(
      'The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
    )
  export type VariablesPerPage = z.infer<typeof VariablesPerPageSchema>

  export const VariableNameSchema = z
    .any()
    .describe('The name of the variable.')
  export type VariableName = z.infer<typeof VariableNameSchema>

  export const UsernameSchema = z
    .any()
    .describe('The handle for the GitHub user account.')
  export type Username = z.infer<typeof UsernameSchema>

  export const AlertInstancesUrlSchema = z
    .string()
    .url()
    .describe(
      'The REST API URL for fetching the list of instances for an alert.'
    )
    .readonly()
  export type AlertInstancesUrl = z.infer<typeof AlertInstancesUrlSchema>

  export const CodeScanningAlertStateSchema = z
    .enum(['open', 'dismissed', 'fixed'])
    .describe('State of a code scanning alert.')
  export type CodeScanningAlertState = z.infer<
    typeof CodeScanningAlertStateSchema
  >

  export const CodeScanningAlertDismissedReasonSchema = z
    .enum(['false positive', "won't fix", 'used in tests'])
    .describe(
      '**Required when the state is dismissed.** The reason for dismissing or closing the alert.'
    )
  export type CodeScanningAlertDismissedReason = z.infer<
    typeof CodeScanningAlertDismissedReasonSchema
  >

  export const CodeScanningAlertDismissedCommentSchema = z
    .string()
    .max(280)
    .describe(
      'The dismissal comment associated with the dismissal of the alert.'
    )
  export type CodeScanningAlertDismissedComment = z.infer<
    typeof CodeScanningAlertDismissedCommentSchema
  >

  export const CodeScanningAlertRuleSummarySchema = z.object({
    id: z
      .string()
      .describe('A unique identifier for the rule used to detect the alert.')
      .optional(),
    name: z
      .string()
      .describe('The name of the rule used to detect the alert.')
      .optional(),
    severity: z
      .enum(['none', 'note', 'warning', 'error'])
      .describe('The severity of the alert.')
      .optional(),
    security_severity_level: z
      .enum(['low', 'medium', 'high', 'critical'])
      .describe('The security severity of the alert.')
      .optional(),
    description: z
      .string()
      .describe('A short description of the rule used to detect the alert.')
      .optional(),
    full_description: z
      .string()
      .describe('A description of the rule used to detect the alert.')
      .optional(),
    tags: z
      .array(z.string())
      .describe('A set of tags applicable for the rule.')
      .optional(),
    help: z
      .string()
      .describe(
        'Detailed documentation for the rule as GitHub Flavored Markdown.'
      )
      .optional(),
    help_uri: z
      .string()
      .describe(
        'A link to the documentation for the rule used to detect the alert.'
      )
      .optional()
  })
  export type CodeScanningAlertRuleSummary = z.infer<
    typeof CodeScanningAlertRuleSummarySchema
  >

  export const CodeScanningAnalysisToolNameSchema = z
    .string()
    .describe(
      'The name of the tool used to generate the code scanning analysis.'
    )
  export type CodeScanningAnalysisToolName = z.infer<
    typeof CodeScanningAnalysisToolNameSchema
  >

  export const CodeScanningAnalysisToolVersionSchema = z
    .string()
    .describe(
      'The version of the tool used to generate the code scanning analysis.'
    )
  export type CodeScanningAnalysisToolVersion = z.infer<
    typeof CodeScanningAnalysisToolVersionSchema
  >

  export const CodeScanningAnalysisToolGuidSchema = z
    .string()
    .describe(
      'The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.'
    )
  export type CodeScanningAnalysisToolGuid = z.infer<
    typeof CodeScanningAnalysisToolGuidSchema
  >

  export const CodeScanningRefSchema = z
    .string()
    .describe(
      'The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`.'
    )
  export type CodeScanningRef = z.infer<typeof CodeScanningRefSchema>

  export const CodeScanningAnalysisAnalysisKeySchema = z
    .string()
    .describe(
      'Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.'
    )
  export type CodeScanningAnalysisAnalysisKey = z.infer<
    typeof CodeScanningAnalysisAnalysisKeySchema
  >

  export const CodeScanningAlertEnvironmentSchema = z
    .string()
    .describe(
      'Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.'
    )
  export type CodeScanningAlertEnvironment = z.infer<
    typeof CodeScanningAlertEnvironmentSchema
  >

  export const CodeScanningAnalysisCategorySchema = z
    .string()
    .describe(
      'Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.'
    )
  export type CodeScanningAnalysisCategory = z.infer<
    typeof CodeScanningAnalysisCategorySchema
  >

  export const CodeScanningAlertLocationSchema = z
    .object({
      path: z.string().optional(),
      start_line: z.number().int().optional(),
      end_line: z.number().int().optional(),
      start_column: z.number().int().optional(),
      end_column: z.number().int().optional()
    })
    .describe('Describe a region within a file for the alert.')
  export type CodeScanningAlertLocation = z.infer<
    typeof CodeScanningAlertLocationSchema
  >

  export const CodeScanningAlertClassificationSchema = z
    .enum(['source', 'generated', 'test', 'library'])
    .describe(
      'A classification of the file. For example to identify it as generated.'
    )
  export type CodeScanningAlertClassification = z.infer<
    typeof CodeScanningAlertClassificationSchema
  >

  export const NullableCodespaceMachineSchema = z
    .object({
      name: z.string().describe('The name of the machine.'),
      display_name: z
        .string()
        .describe(
          'The display name of the machine includes cores, memory, and storage.'
        ),
      operating_system: z
        .string()
        .describe('The operating system of the machine.'),
      storage_in_bytes: z
        .number()
        .int()
        .describe('How much storage is available to the codespace.'),
      memory_in_bytes: z
        .number()
        .int()
        .describe('How much memory is available to the codespace.'),
      cpus: z
        .number()
        .int()
        .describe('How many cores are available to the codespace.'),
      prebuild_availability: z
        .enum(['none', 'ready', 'in_progress'])
        .describe(
          'Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.'
        )
    })
    .describe('A description of the machine powering a codespace.')
  export type NullableCodespaceMachine = z.infer<
    typeof NullableCodespaceMachineSchema
  >

  export const CodespacesOrgSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'The type of repositories in the organization that the secret is visible to'
        ),
      selected_repositories_url: z
        .string()
        .url()
        .describe(
          'The API URL at which the list of repositories this secret is visible to can be retrieved'
        )
        .optional()
    })
    .describe('Secrets for a GitHub Codespace.')
  export type CodespacesOrgSecret = z.infer<typeof CodespacesOrgSecretSchema>

  export const CodespacesPublicKeySchema = z
    .object({
      key_id: z.string().describe('The identifier for the key.'),
      key: z.string().describe('The Base64 encoded public key.'),
      id: z.number().int().optional(),
      url: z.string().optional(),
      title: z.string().optional(),
      created_at: z.string().optional()
    })
    .describe('The public key used for setting Codespaces secrets.')
  export type CodespacesPublicKey = z.infer<typeof CodespacesPublicKeySchema>

  export const CopilotOrganizationSeatBreakdownSchema = z
    .object({
      total: z
        .number()
        .int()
        .describe(
          'The total number of seats being billed for the organization as of the current billing cycle.'
        )
        .optional(),
      added_this_cycle: z
        .number()
        .int()
        .describe('Seats added during the current billing cycle.')
        .optional(),
      pending_cancellation: z
        .number()
        .int()
        .describe(
          'The number of seats that are pending cancellation at the end of the current billing cycle.'
        )
        .optional(),
      pending_invitation: z
        .number()
        .int()
        .describe(
          'The number of users who have been invited to receive a Copilot seat through this organization.'
        )
        .optional(),
      active_this_cycle: z
        .number()
        .int()
        .describe(
          'The number of seats that have used Copilot during the current billing cycle.'
        )
        .optional(),
      inactive_this_cycle: z
        .number()
        .int()
        .describe(
          'The number of seats that have not used Copilot during the current billing cycle.'
        )
        .optional()
    })
    .describe('The breakdown of Copilot Business seats for the organization.')
  export type CopilotOrganizationSeatBreakdown = z.infer<
    typeof CopilotOrganizationSeatBreakdownSchema
  >

  export const NullableOrganizationSimpleSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string().url(),
      hooks_url: z.string(),
      issues_url: z.string(),
      members_url: z.string(),
      public_members_url: z.string(),
      avatar_url: z.string(),
      description: z.string()
    })
    .describe('A GitHub organization.')
  export type NullableOrganizationSimple = z.infer<
    typeof NullableOrganizationSimpleSchema
  >

  export const NullableTeamSimpleSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the team'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the team'),
      members_url: z.string(),
      name: z.string().describe('Name of the team'),
      description: z.string().describe('Description of the team'),
      permission: z
        .string()
        .describe('Permission that the team will have for its repositories'),
      privacy: z
        .string()
        .describe('The level of privacy this team should have')
        .optional(),
      notification_setting: z
        .string()
        .describe('The notification setting the team has set')
        .optional(),
      html_url: z.string().url(),
      repositories_url: z.string().url(),
      slug: z.string(),
      ldap_dn: z
        .string()
        .describe(
          'Distinguished Name (DN) that team maps to within LDAP environment'
        )
        .optional()
    })
    .describe(
      'Groups of organization members that gives permissions on specified repositories.'
    )
  export type NullableTeamSimple = z.infer<typeof NullableTeamSimpleSchema>

  export const EnterpriseTeamSchema = z
    .object({
      id: z.number().int(),
      name: z.string(),
      slug: z.string(),
      url: z.string().url(),
      sync_to_organizations: z.string(),
      group_id: z.string().optional(),
      group_name: z.string().optional(),
      html_url: z.string().url(),
      members_url: z.string(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Group of enterprise owners and/or members')
  export type EnterpriseTeam = z.infer<typeof EnterpriseTeamSchema>

  export const CopilotIdeCodeCompletionsSchema = z
    .object({
      total_engaged_users: z
        .number()
        .int()
        .describe(
          'Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances.'
        )
        .optional(),
      languages: z
        .array(
          z
            .object({
              name: z
                .string()
                .describe(
                  'Name of the language used for Copilot code completion suggestions.'
                )
                .optional(),
              total_engaged_users: z
                .number()
                .int()
                .describe(
                  'Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances.'
                )
                .optional()
            })
            .describe(
              'Usage metrics for a given language for the given editor for Copilot code completions.'
            )
        )
        .describe('Code completion metrics for active languages.')
        .optional(),
      editors: z
        .array(
          z
            .object({
              name: z.string().describe('Name of the given editor.').optional(),
              total_engaged_users: z
                .number()
                .int()
                .describe(
                  'Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances.'
                )
                .optional(),
              models: z
                .array(
                  z.object({
                    name: z
                      .string()
                      .describe(
                        "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'."
                      )
                      .optional(),
                    is_custom_model: z
                      .boolean()
                      .describe(
                        'Indicates whether a model is custom or default.'
                      )
                      .optional(),
                    custom_model_training_date: z
                      .string()
                      .describe('The training date for the custom model.')
                      .optional(),
                    total_engaged_users: z
                      .number()
                      .int()
                      .describe(
                        'Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances.'
                      )
                      .optional(),
                    languages: z
                      .array(
                        z
                          .object({
                            name: z
                              .string()
                              .describe(
                                'Name of the language used for Copilot code completion suggestions, for the given editor.'
                              )
                              .optional(),
                            total_engaged_users: z
                              .number()
                              .int()
                              .describe(
                                'Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances.'
                              )
                              .optional(),
                            total_code_suggestions: z
                              .number()
                              .int()
                              .describe(
                                'The number of Copilot code suggestions generated for the given editor, for the given language.'
                              )
                              .optional(),
                            total_code_acceptances: z
                              .number()
                              .int()
                              .describe(
                                'The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances.'
                              )
                              .optional(),
                            total_code_lines_suggested: z
                              .number()
                              .int()
                              .describe(
                                'The number of lines of code suggested by Copilot code completions for the given editor, for the given language.'
                              )
                              .optional(),
                            total_code_lines_accepted: z
                              .number()
                              .int()
                              .describe(
                                'The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language.'
                              )
                              .optional()
                          })
                          .describe(
                            'Usage metrics for a given language for the given editor for Copilot code completions.'
                          )
                      )
                      .describe(
                        'Code completion metrics for active languages, for the given editor.'
                      )
                      .optional()
                  })
                )
                .describe(
                  'List of model metrics for custom models and the default model.'
                )
                .optional()
            })
            .catchall(z.any())
            .describe('Copilot code completion metrics for active editors.')
        )
        .optional()
    })
    .catchall(z.any())
    .describe('Usage metrics for Copilot editor code completions in the IDE.')
  export type CopilotIdeCodeCompletions = z.infer<
    typeof CopilotIdeCodeCompletionsSchema
  >

  export const CopilotIdeChatSchema = z
    .object({
      total_engaged_users: z
        .number()
        .int()
        .describe('Total number of users who prompted Copilot Chat in the IDE.')
        .optional(),
      editors: z
        .array(
          z
            .object({
              name: z.string().describe('Name of the given editor.').optional(),
              total_engaged_users: z
                .number()
                .int()
                .describe(
                  'The number of users who prompted Copilot Chat in the specified editor.'
                )
                .optional(),
              models: z
                .array(
                  z.object({
                    name: z
                      .string()
                      .describe(
                        "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'."
                      )
                      .optional(),
                    is_custom_model: z
                      .boolean()
                      .describe(
                        'Indicates whether a model is custom or default.'
                      )
                      .optional(),
                    custom_model_training_date: z
                      .string()
                      .describe('The training date for the custom model.')
                      .optional(),
                    total_engaged_users: z
                      .number()
                      .int()
                      .describe(
                        'The number of users who prompted Copilot Chat in the given editor and model.'
                      )
                      .optional(),
                    total_chats: z
                      .number()
                      .int()
                      .describe(
                        'The total number of chats initiated by users in the given editor and model.'
                      )
                      .optional(),
                    total_chat_insertion_events: z
                      .number()
                      .int()
                      .describe(
                        "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor."
                      )
                      .optional(),
                    total_chat_copy_events: z
                      .number()
                      .int()
                      .describe(
                        "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor."
                      )
                      .optional()
                  })
                )
                .describe(
                  'List of model metrics for custom models and the default model.'
                )
                .optional()
            })
            .describe('Copilot Chat metrics, for active editors.')
        )
        .optional()
    })
    .catchall(z.any())
    .describe('Usage metrics for Copilot Chat in the IDE.')
  export type CopilotIdeChat = z.infer<typeof CopilotIdeChatSchema>

  export const CopilotDotcomChatSchema = z
    .object({
      total_engaged_users: z
        .number()
        .int()
        .describe(
          'Total number of users who prompted Copilot Chat on github.com at least once.'
        )
        .optional(),
      models: z
        .array(
          z.object({
            name: z
              .string()
              .describe(
                "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'."
              )
              .optional(),
            is_custom_model: z
              .boolean()
              .describe('Indicates whether a model is custom or default.')
              .optional(),
            custom_model_training_date: z
              .string()
              .describe(
                'The training date for the custom model (if applicable).'
              )
              .optional(),
            total_engaged_users: z
              .number()
              .int()
              .describe(
                'Total number of users who prompted Copilot Chat on github.com at least once for each model.'
              )
              .optional(),
            total_chats: z
              .number()
              .int()
              .describe(
                'Total number of chats initiated by users on github.com.'
              )
              .optional()
          })
        )
        .describe(
          'List of model metrics for a custom models and the default model.'
        )
        .optional()
    })
    .catchall(z.any())
    .describe('Usage metrics for Copilot Chat in GitHub.com')
  export type CopilotDotcomChat = z.infer<typeof CopilotDotcomChatSchema>

  export const CopilotDotcomPullRequestsSchema = z
    .object({
      total_engaged_users: z
        .number()
        .int()
        .describe(
          'The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once.'
        )
        .optional(),
      repositories: z
        .array(
          z.object({
            name: z.string().describe('Repository name').optional(),
            total_engaged_users: z
              .number()
              .int()
              .describe(
                'The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository.'
              )
              .optional(),
            models: z
              .array(
                z.object({
                  name: z
                    .string()
                    .describe(
                      "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'."
                    )
                    .optional(),
                  is_custom_model: z
                    .boolean()
                    .describe('Indicates whether a model is custom or default.')
                    .optional(),
                  custom_model_training_date: z
                    .string()
                    .describe('The training date for the custom model.')
                    .optional(),
                  total_pr_summaries_created: z
                    .number()
                    .int()
                    .describe(
                      'The number of pull request summaries generated using Copilot for Pull Requests in the given repository.'
                    )
                    .optional(),
                  total_engaged_users: z
                    .number()
                    .int()
                    .describe(
                      'The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model.'
                    )
                    .optional()
                })
              )
              .describe(
                'List of model metrics for custom models and the default model.'
              )
              .optional()
          })
        )
        .describe(
          'Repositories in which users used Copilot for Pull Requests to generate pull request summaries'
        )
        .optional()
    })
    .catchall(z.any())
    .describe('Usage metrics for Copilot for pull requests.')
  export type CopilotDotcomPullRequests = z.infer<
    typeof CopilotDotcomPullRequestsSchema
  >

  export const CopilotUsageMetricsSchema = z
    .object({
      day: z
        .string()
        .date()
        .describe(
          'The date for which the usage metrics are reported, in `YYYY-MM-DD` format.'
        ),
      total_suggestions_count: z
        .number()
        .int()
        .describe(
          'The total number of Copilot code completion suggestions shown to users.'
        )
        .optional(),
      total_acceptances_count: z
        .number()
        .int()
        .describe(
          'The total number of Copilot code completion suggestions accepted by users.'
        )
        .optional(),
      total_lines_suggested: z
        .number()
        .int()
        .describe(
          'The total number of lines of code completions suggested by Copilot.'
        )
        .optional(),
      total_lines_accepted: z
        .number()
        .int()
        .describe(
          'The total number of lines of code completions accepted by users.'
        )
        .optional(),
      total_active_users: z
        .number()
        .int()
        .describe(
          'The total number of users who were shown Copilot code completion suggestions during the day specified.'
        )
        .optional(),
      total_chat_acceptances: z
        .number()
        .int()
        .describe(
          'The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline).'
        )
        .optional(),
      total_chat_turns: z
        .number()
        .int()
        .describe(
          'The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE.'
        )
        .optional(),
      total_active_chat_users: z
        .number()
        .int()
        .describe(
          'The total number of users who interacted with Copilot Chat in the IDE during the day specified.'
        )
        .optional(),
      breakdown: z
        .array(
          z
            .object({
              language: z
                .string()
                .describe(
                  'The language in which Copilot suggestions were shown to users in the specified editor.'
                )
                .optional(),
              editor: z
                .string()
                .describe(
                  'The editor in which Copilot suggestions were shown to users for the specified language.'
                )
                .optional(),
              suggestions_count: z
                .number()
                .int()
                .describe(
                  'The number of Copilot suggestions shown to users in the editor specified during the day specified.'
                )
                .optional(),
              acceptances_count: z
                .number()
                .int()
                .describe(
                  'The number of Copilot suggestions accepted by users in the editor specified during the day specified.'
                )
                .optional(),
              lines_suggested: z
                .number()
                .int()
                .describe(
                  'The number of lines of code suggested by Copilot in the editor specified during the day specified.'
                )
                .optional(),
              lines_accepted: z
                .number()
                .int()
                .describe(
                  'The number of lines of code accepted by users in the editor specified during the day specified.'
                )
                .optional(),
              active_users: z
                .number()
                .int()
                .describe(
                  'The number of users who were shown Copilot completion suggestions in the editor specified during the day specified.'
                )
                .optional()
            })
            .catchall(z.any())
            .describe('Breakdown of Copilot usage by editor for this language')
        )
        .describe(
          'Breakdown of Copilot code completions usage by language and editor'
        )
    })
    .strict()
    .describe('Summary of Copilot usage.')
  export type CopilotUsageMetrics = z.infer<typeof CopilotUsageMetricsSchema>

  export const OrganizationDependabotSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe('Visibility of a secret'),
      selected_repositories_url: z.string().url().optional()
    })
    .describe('Secrets for GitHub Dependabot for an organization.')
  export type OrganizationDependabotSecret = z.infer<
    typeof OrganizationDependabotSecretSchema
  >

  export const DependabotPublicKeySchema = z
    .object({
      key_id: z.string().describe('The identifier for the key.'),
      key: z.string().describe('The Base64 encoded public key.')
    })
    .describe('The public key used for setting Dependabot Secrets.')
  export type DependabotPublicKey = z.infer<typeof DependabotPublicKeySchema>

  export const OrgHookSchema = z
    .object({
      id: z.number().int(),
      url: z.string().url(),
      ping_url: z.string().url(),
      deliveries_url: z.string().url().optional(),
      name: z.string(),
      events: z.array(z.string()),
      active: z.boolean(),
      config: z.object({
        url: z.string().optional(),
        insecure_ssl: z.string().optional(),
        content_type: z.string().optional(),
        secret: z.string().optional()
      }),
      updated_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      type: z.string()
    })
    .describe('Org Hook')
  export type OrgHook = z.infer<typeof OrgHookSchema>

  export const HookIdSchema = z
    .any()
    .describe(
      'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
    )
  export type HookId = z.infer<typeof HookIdSchema>

  export const ApiInsightsRouteStatsSchema = z
    .array(
      z.object({
        http_method: z.string().describe('The HTTP method').optional(),
        api_route: z
          .string()
          .describe("The API path's route template")
          .optional(),
        total_request_count: z
          .number()
          .int()
          .describe(
            'The total number of requests within the queried time period'
          )
          .optional(),
        rate_limited_request_count: z
          .number()
          .int()
          .describe(
            'The total number of requests that were rate limited within the queried time period'
          )
          .optional(),
        last_rate_limited_timestamp: z.string().optional(),
        last_request_timestamp: z.string().optional()
      })
    )
    .describe('API Insights usage route stats for an actor')
  export type ApiInsightsRouteStats = z.infer<
    typeof ApiInsightsRouteStatsSchema
  >

  export const ApiInsightsActorTypeSchema = z
    .any()
    .describe('The type of the actor')
  export type ApiInsightsActorType = z.infer<typeof ApiInsightsActorTypeSchema>

  export const ApiInsightsActorIdSchema = z
    .any()
    .describe('The ID of the actor')
  export type ApiInsightsActorId = z.infer<typeof ApiInsightsActorIdSchema>

  export const ApiInsightsMinTimestampSchema = z
    .any()
    .describe(
      'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type ApiInsightsMinTimestamp = z.infer<
    typeof ApiInsightsMinTimestampSchema
  >

  export const ApiInsightsMaxTimestampSchema = z
    .any()
    .describe(
      'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type ApiInsightsMaxTimestamp = z.infer<
    typeof ApiInsightsMaxTimestampSchema
  >

  export const ApiInsightsRouteStatsSortSchema = z
    .any()
    .describe('The property to sort the results by.')
  export type ApiInsightsRouteStatsSort = z.infer<
    typeof ApiInsightsRouteStatsSortSchema
  >

  export const ApiInsightsApiRouteSubstringSchema = z
    .any()
    .describe(
      'Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.'
    )
  export type ApiInsightsApiRouteSubstring = z.infer<
    typeof ApiInsightsApiRouteSubstringSchema
  >

  export const ApiInsightsSubjectStatsSchema = z
    .array(
      z.object({
        subject_type: z.string().optional(),
        subject_name: z.string().optional(),
        subject_id: z.number().int().optional(),
        total_request_count: z.number().int().optional(),
        rate_limited_request_count: z.number().int().optional(),
        last_rate_limited_timestamp: z.string().optional(),
        last_request_timestamp: z.string().optional()
      })
    )
    .describe('API Insights usage subject stats for an organization')
  export type ApiInsightsSubjectStats = z.infer<
    typeof ApiInsightsSubjectStatsSchema
  >

  export const ApiInsightsSortSchema = z
    .any()
    .describe('The property to sort the results by.')
  export type ApiInsightsSort = z.infer<typeof ApiInsightsSortSchema>

  export const ApiInsightsSubjectNameSubstringSchema = z
    .any()
    .describe(
      'Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.'
    )
  export type ApiInsightsSubjectNameSubstring = z.infer<
    typeof ApiInsightsSubjectNameSubstringSchema
  >

  export const ApiInsightsSummaryStatsSchema = z
    .object({
      total_request_count: z
        .number()
        .int()
        .describe('The total number of requests within the queried time period')
        .optional(),
      rate_limited_request_count: z
        .number()
        .int()
        .describe(
          'The total number of requests that were rate limited within the queried time period'
        )
        .optional()
    })
    .describe('API Insights usage summary stats for an organization')
  export type ApiInsightsSummaryStats = z.infer<
    typeof ApiInsightsSummaryStatsSchema
  >

  export const ApiInsightsUserIdSchema = z
    .any()
    .describe('The ID of the user to query for stats')
  export type ApiInsightsUserId = z.infer<typeof ApiInsightsUserIdSchema>

  export const ApiInsightsTimeStatsSchema = z
    .array(
      z.object({
        timestamp: z.string().optional(),
        total_request_count: z.number().int().optional(),
        rate_limited_request_count: z.number().int().optional()
      })
    )
    .describe('API Insights usage time stats for an organization')
  export type ApiInsightsTimeStats = z.infer<typeof ApiInsightsTimeStatsSchema>

  export const ApiInsightsTimestampIncrementSchema = z
    .any()
    .describe(
      'The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)'
    )
  export type ApiInsightsTimestampIncrement = z.infer<
    typeof ApiInsightsTimestampIncrementSchema
  >

  export const ApiInsightsUserStatsSchema = z
    .array(
      z.object({
        actor_type: z.string().optional(),
        actor_name: z.string().optional(),
        actor_id: z.number().int().optional(),
        integration_id: z.number().int().optional(),
        oauth_application_id: z.number().int().optional(),
        total_request_count: z.number().int().optional(),
        rate_limited_request_count: z.number().int().optional(),
        last_rate_limited_timestamp: z.string().optional(),
        last_request_timestamp: z.string().optional()
      })
    )
    .describe('API Insights usage stats for a user')
  export type ApiInsightsUserStats = z.infer<typeof ApiInsightsUserStatsSchema>

  export const ApiInsightsActorNameSubstringSchema = z
    .any()
    .describe(
      'Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.'
    )
  export type ApiInsightsActorNameSubstring = z.infer<
    typeof ApiInsightsActorNameSubstringSchema
  >

  export const InteractionGroupSchema = z
    .enum(['existing_users', 'contributors_only', 'collaborators_only'])
    .describe(
      'The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.'
    )
  export type InteractionGroup = z.infer<typeof InteractionGroupSchema>

  export const InteractionExpirySchema = z
    .enum(['one_day', 'three_days', 'one_week', 'one_month', 'six_months'])
    .describe(
      'The duration of the interaction restriction. Default: `one_day`.'
    )
  export type InteractionExpiry = z.infer<typeof InteractionExpirySchema>

  export const InvitationIdSchema = z
    .any()
    .describe('The unique identifier of the invitation.')
  export type InvitationId = z.infer<typeof InvitationIdSchema>

  export const OrganizationCreateIssueTypeSchema = z.object({
    name: z.string().describe('Name of the issue type.'),
    is_enabled: z
      .boolean()
      .describe(
        'Whether or not the issue type is enabled at the organization level.'
      ),
    is_private: z
      .boolean()
      .describe(
        'Whether or not the issue type is restricted to issues in private repositories.'
      )
      .optional(),
    description: z
      .string()
      .describe('Description of the issue type.')
      .optional(),
    color: z
      .enum([
        'gray',
        'blue',
        'green',
        'yellow',
        'orange',
        'red',
        'pink',
        'purple'
      ])
      .describe('Color for the issue type.')
      .optional()
  })
  export type OrganizationCreateIssueType = z.infer<
    typeof OrganizationCreateIssueTypeSchema
  >

  export const OrganizationUpdateIssueTypeSchema = z.object({
    name: z.string().describe('Name of the issue type.'),
    is_enabled: z
      .boolean()
      .describe(
        'Whether or not the issue type is enabled at the organization level.'
      ),
    is_private: z
      .boolean()
      .describe(
        'Whether or not the issue type is restricted to issues in private repositories.'
      )
      .optional(),
    description: z
      .string()
      .describe('Description of the issue type.')
      .optional(),
    color: z
      .enum([
        'gray',
        'blue',
        'green',
        'yellow',
        'orange',
        'red',
        'pink',
        'purple'
      ])
      .describe('Color for the issue type.')
      .optional()
  })
  export type OrganizationUpdateIssueType = z.infer<
    typeof OrganizationUpdateIssueTypeSchema
  >

  export const IssueTypeIdSchema = z
    .any()
    .describe('The unique identifier of the issue type.')
  export type IssueTypeId = z.infer<typeof IssueTypeIdSchema>

  export const CodespaceNameSchema = z
    .any()
    .describe('The name of the codespace.')
  export type CodespaceName = z.infer<typeof CodespaceNameSchema>

  export const MigrationIdSchema = z
    .any()
    .describe('The unique identifier of the migration.')
  export type MigrationId = z.infer<typeof MigrationIdSchema>

  export const RepoNameSchema = z.any().describe('repo_name parameter')
  export type RepoName = z.infer<typeof RepoNameSchema>

  export const TeamSlugSchema = z.any().describe('The slug of the team name.')
  export type TeamSlug = z.infer<typeof TeamSlugSchema>

  export const RoleIdSchema = z
    .any()
    .describe('The unique identifier of the role.')
  export type RoleId = z.infer<typeof RoleIdSchema>

  export const TeamSimpleSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the team'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the team'),
      members_url: z.string(),
      name: z.string().describe('Name of the team'),
      description: z.string().describe('Description of the team'),
      permission: z
        .string()
        .describe('Permission that the team will have for its repositories'),
      privacy: z
        .string()
        .describe('The level of privacy this team should have')
        .optional(),
      notification_setting: z
        .string()
        .describe('The notification setting the team has set')
        .optional(),
      html_url: z.string().url(),
      repositories_url: z.string().url(),
      slug: z.string(),
      ldap_dn: z
        .string()
        .describe(
          'Distinguished Name (DN) that team maps to within LDAP environment'
        )
        .optional()
    })
    .describe(
      'Groups of organization members that gives permissions on specified repositories.'
    )
  export type TeamSimple = z.infer<typeof TeamSimpleSchema>

  export const PackageVisibilitySchema = z
    .any()
    .describe(
      'The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."'
    )
  export type PackageVisibility = z.infer<typeof PackageVisibilitySchema>

  export const PackageTypeSchema = z
    .any()
    .describe(
      "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
    )
  export type PackageType = z.infer<typeof PackageTypeSchema>

  export const PackageNameSchema = z.any().describe('The name of the package.')
  export type PackageName = z.infer<typeof PackageNameSchema>

  export const PackageVersionSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('Unique identifier of the package version.'),
      name: z.string().describe('The name of the package version.'),
      url: z.string(),
      package_html_url: z.string(),
      html_url: z.string().optional(),
      license: z.string().optional(),
      description: z.string().optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      deleted_at: z.string().datetime({ offset: true }).optional(),
      metadata: z
        .object({
          package_type: z.enum([
            'npm',
            'maven',
            'rubygems',
            'docker',
            'nuget',
            'container'
          ]),
          container: z.object({ tags: z.array(z.string()) }).optional(),
          docker: z.object({ tag: z.array(z.string()).optional() }).optional()
        })
        .optional()
    })
    .describe('A version of a software package')
  export type PackageVersion = z.infer<typeof PackageVersionSchema>

  export const PackageVersionIdSchema = z
    .any()
    .describe('Unique identifier of the package version.')
  export type PackageVersionId = z.infer<typeof PackageVersionIdSchema>

  export const PersonalAccessTokenSortSchema = z
    .any()
    .describe('The property by which to sort the results.')
  export type PersonalAccessTokenSort = z.infer<
    typeof PersonalAccessTokenSortSchema
  >

  export const PersonalAccessTokenOwnerSchema = z
    .any()
    .describe('A list of owner usernames to use to filter the results.')
  export type PersonalAccessTokenOwner = z.infer<
    typeof PersonalAccessTokenOwnerSchema
  >

  export const PersonalAccessTokenRepositorySchema = z
    .any()
    .describe('The name of the repository to use to filter the results.')
  export type PersonalAccessTokenRepository = z.infer<
    typeof PersonalAccessTokenRepositorySchema
  >

  export const PersonalAccessTokenPermissionSchema = z
    .any()
    .describe('The permission to use to filter the results.')
  export type PersonalAccessTokenPermission = z.infer<
    typeof PersonalAccessTokenPermissionSchema
  >

  export const PersonalAccessTokenBeforeSchema = z
    .any()
    .describe(
      'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type PersonalAccessTokenBefore = z.infer<
    typeof PersonalAccessTokenBeforeSchema
  >

  export const PersonalAccessTokenAfterSchema = z
    .any()
    .describe(
      'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type PersonalAccessTokenAfter = z.infer<
    typeof PersonalAccessTokenAfterSchema
  >

  export const PersonalAccessTokenTokenIdSchema = z
    .any()
    .describe('The ID of the token')
  export type PersonalAccessTokenTokenId = z.infer<
    typeof PersonalAccessTokenTokenIdSchema
  >

  export const FineGrainedPersonalAccessTokenIdSchema = z
    .any()
    .describe(
      'The unique identifier of the fine-grained personal access token.'
    )
  export type FineGrainedPersonalAccessTokenId = z.infer<
    typeof FineGrainedPersonalAccessTokenIdSchema
  >

  export const OrgPrivateRegistryConfigurationSchema = z
    .object({
      name: z
        .string()
        .describe('The name of the private registry configuration.'),
      registry_type: z
        .literal('maven_repository')
        .describe('The registry type.'),
      username: z
        .string()
        .describe(
          'The username to use when authenticating with the private registry.'
        )
        .optional(),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'Which type of organization repositories have access to the private registry.'
        ),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Private registry configuration for an organization')
  export type OrgPrivateRegistryConfiguration = z.infer<
    typeof OrgPrivateRegistryConfigurationSchema
  >

  export const OrgPrivateRegistryConfigurationWithSelectedRepositoriesSchema = z
    .object({
      name: z
        .string()
        .describe('The name of the private registry configuration.'),
      registry_type: z
        .literal('maven_repository')
        .describe('The registry type.'),
      username: z
        .string()
        .describe(
          'The username to use when authenticating with the private registry.'
        )
        .optional(),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.'
        ),
      selected_repository_ids: z
        .array(z.number().int())
        .describe(
          'An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.'
        )
        .optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Private registry configuration for an organization')
  export type OrgPrivateRegistryConfigurationWithSelectedRepositories = z.infer<
    typeof OrgPrivateRegistryConfigurationWithSelectedRepositoriesSchema
  >

  export const CustomPropertySchema = z
    .object({
      property_name: z.string().describe('The name of the property'),
      url: z
        .string()
        .url()
        .describe(
          'The URL that can be used to fetch, update, or delete info about this property via the API.'
        )
        .optional(),
      source_type: z
        .enum(['organization', 'enterprise'])
        .describe('The source type of the property')
        .optional(),
      value_type: z
        .enum(['string', 'single_select', 'multi_select', 'true_false'])
        .describe('The type of the value for the property'),
      required: z
        .boolean()
        .describe('Whether the property is required.')
        .optional(),
      default_value: z
        .union([z.string(), z.array(z.string())])
        .describe('Default value of the property')
        .optional(),
      description: z
        .string()
        .describe('Short description of the property')
        .optional(),
      allowed_values: z
        .array(z.string().max(75))
        .max(200)
        .describe(
          'An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.'
        )
        .optional(),
      values_editable_by: z
        .enum(['org_actors', 'org_and_repo_actors'])
        .describe('Who can edit the values of the property')
        .optional()
    })
    .describe('Custom property defined on an organization')
  export type CustomProperty = z.infer<typeof CustomPropertySchema>

  export const CustomPropertyNameSchema = z
    .any()
    .describe('The custom property name')
  export type CustomPropertyName = z.infer<typeof CustomPropertyNameSchema>

  export const CustomPropertySetPayloadSchema = z
    .object({
      value_type: z
        .enum(['string', 'single_select', 'multi_select', 'true_false'])
        .describe('The type of the value for the property'),
      required: z
        .boolean()
        .describe('Whether the property is required.')
        .optional(),
      default_value: z
        .union([z.string(), z.array(z.string())])
        .describe('Default value of the property')
        .optional(),
      description: z
        .string()
        .describe('Short description of the property')
        .optional(),
      allowed_values: z
        .array(z.string().max(75))
        .max(200)
        .describe(
          'An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.'
        )
        .optional(),
      values_editable_by: z
        .enum(['org_actors', 'org_and_repo_actors'])
        .describe('Who can edit the values of the property')
        .optional()
    })
    .describe('Custom property set payload')
  export type CustomPropertySetPayload = z.infer<
    typeof CustomPropertySetPayloadSchema
  >

  export const CustomPropertyValueSchema = z
    .object({
      property_name: z.string().describe('The name of the property'),
      value: z
        .union([z.string(), z.array(z.string())])
        .describe('The value assigned to the property')
    })
    .describe('Custom property name and associated value')
  export type CustomPropertyValue = z.infer<typeof CustomPropertyValueSchema>

  export const CodeOfConductSimpleSchema = z
    .object({
      url: z.string().url(),
      key: z.string(),
      name: z.string(),
      html_url: z.string().url()
    })
    .describe('Code of Conduct Simple')
  export type CodeOfConductSimple = z.infer<typeof CodeOfConductSimpleSchema>

  export const RepositoryRuleEnforcementSchema = z
    .enum(['disabled', 'active', 'evaluate'])
    .describe(
      'The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).'
    )
  export type RepositoryRuleEnforcement = z.infer<
    typeof RepositoryRuleEnforcementSchema
  >

  export const RepositoryRulesetBypassActorSchema = z
    .object({
      actor_id: z
        .number()
        .int()
        .describe(
          'The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.'
        )
        .optional(),
      actor_type: z
        .enum([
          'Integration',
          'OrganizationAdmin',
          'RepositoryRole',
          'Team',
          'DeployKey'
        ])
        .describe('The type of actor that can bypass a ruleset.'),
      bypass_mode: z
        .enum(['always', 'pull_request'])
        .describe(
          'When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.'
        )
        .default('always')
    })
    .describe('An actor that can bypass rules in a ruleset')
  export type RepositoryRulesetBypassActor = z.infer<
    typeof RepositoryRulesetBypassActorSchema
  >

  export const RepositoryRulesetConditionsSchema = z
    .object({
      ref_name: z
        .object({
          include: z
            .array(z.string())
            .describe(
              'Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.'
            )
            .optional(),
          exclude: z
            .array(z.string())
            .describe(
              'Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.'
            )
            .optional()
        })
        .optional()
    })
    .describe('Parameters for a repository ruleset ref name condition')
  export type RepositoryRulesetConditions = z.infer<
    typeof RepositoryRulesetConditionsSchema
  >

  export const RepositoryRulesetConditionsRepositoryNameTargetSchema = z
    .object({
      repository_name: z.object({
        include: z
          .array(z.string())
          .describe(
            'Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.'
          )
          .optional(),
        exclude: z
          .array(z.string())
          .describe(
            'Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.'
          )
          .optional(),
        protected: z
          .boolean()
          .describe('Whether renaming of target repositories is prevented.')
          .optional()
      })
    })
    .describe('Parameters for a repository name condition')
  export type RepositoryRulesetConditionsRepositoryNameTarget = z.infer<
    typeof RepositoryRulesetConditionsRepositoryNameTargetSchema
  >

  export const RepositoryRulesetConditionsRepositoryIdTargetSchema = z
    .object({
      repository_id: z.object({
        repository_ids: z
          .array(z.number().int())
          .describe(
            'The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.'
          )
          .optional()
      })
    })
    .describe('Parameters for a repository ID condition')
  export type RepositoryRulesetConditionsRepositoryIdTarget = z.infer<
    typeof RepositoryRulesetConditionsRepositoryIdTargetSchema
  >

  export const RepositoryRulesetConditionsRepositoryPropertySpecSchema = z
    .object({
      name: z
        .string()
        .describe('The name of the repository property to target'),
      property_values: z
        .array(z.string())
        .describe('The values to match for the repository property'),
      source: z
        .enum(['custom', 'system'])
        .describe(
          "The source of the repository property. Defaults to 'custom' if not specified."
        )
        .optional()
    })
    .describe('Parameters for a targeting a repository property')
  export type RepositoryRulesetConditionsRepositoryPropertySpec = z.infer<
    typeof RepositoryRulesetConditionsRepositoryPropertySpecSchema
  >

  export const RepositoryRuleCreationSchema = z
    .object({ type: z.literal('creation') })
    .describe(
      'Only allow users with bypass permission to create matching refs.'
    )
  export type RepositoryRuleCreation = z.infer<
    typeof RepositoryRuleCreationSchema
  >

  export const RepositoryRuleUpdateSchema = z
    .object({
      type: z.literal('update'),
      parameters: z
        .object({
          update_allows_fetch_and_merge: z
            .boolean()
            .describe('Branch can pull changes from its upstream repository')
        })
        .optional()
    })
    .describe(
      'Only allow users with bypass permission to update matching refs.'
    )
  export type RepositoryRuleUpdate = z.infer<typeof RepositoryRuleUpdateSchema>

  export const RepositoryRuleDeletionSchema = z
    .object({ type: z.literal('deletion') })
    .describe(
      'Only allow users with bypass permissions to delete matching refs.'
    )
  export type RepositoryRuleDeletion = z.infer<
    typeof RepositoryRuleDeletionSchema
  >

  export const RepositoryRuleRequiredLinearHistorySchema = z
    .object({ type: z.literal('required_linear_history') })
    .describe('Prevent merge commits from being pushed to matching refs.')
  export type RepositoryRuleRequiredLinearHistory = z.infer<
    typeof RepositoryRuleRequiredLinearHistorySchema
  >

  export const RepositoryRuleMergeQueueSchema = z
    .object({
      type: z.literal('merge_queue'),
      parameters: z
        .object({
          check_response_timeout_minutes: z
            .number()
            .int()
            .gte(1)
            .lte(360)
            .describe(
              'Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed'
            ),
          grouping_strategy: z
            .enum(['ALLGREEN', 'HEADGREEN'])
            .describe(
              'When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.'
            ),
          max_entries_to_build: z
            .number()
            .int()
            .gte(0)
            .lte(100)
            .describe(
              'Limit the number of queued pull requests requesting checks and workflow runs at the same time.'
            ),
          max_entries_to_merge: z
            .number()
            .int()
            .gte(0)
            .lte(100)
            .describe(
              'The maximum number of PRs that will be merged together in a group.'
            ),
          merge_method: z
            .enum(['MERGE', 'SQUASH', 'REBASE'])
            .describe(
              'Method to use when merging changes from queued pull requests.'
            ),
          min_entries_to_merge: z
            .number()
            .int()
            .gte(0)
            .lte(100)
            .describe(
              'The minimum number of PRs that will be merged together in a group.'
            ),
          min_entries_to_merge_wait_minutes: z
            .number()
            .int()
            .gte(0)
            .lte(360)
            .describe(
              'The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.'
            )
        })
        .optional()
    })
    .describe('Merges must be performed via a merge queue.')
  export type RepositoryRuleMergeQueue = z.infer<
    typeof RepositoryRuleMergeQueueSchema
  >

  export const RepositoryRuleRequiredDeploymentsSchema = z
    .object({
      type: z.literal('required_deployments'),
      parameters: z
        .object({
          required_deployment_environments: z
            .array(z.string())
            .describe(
              'The environments that must be successfully deployed to before branches can be merged.'
            )
        })
        .optional()
    })
    .describe(
      'Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.'
    )
  export type RepositoryRuleRequiredDeployments = z.infer<
    typeof RepositoryRuleRequiredDeploymentsSchema
  >

  export const RepositoryRuleRequiredSignaturesSchema = z
    .object({ type: z.literal('required_signatures') })
    .describe('Commits pushed to matching refs must have verified signatures.')
  export type RepositoryRuleRequiredSignatures = z.infer<
    typeof RepositoryRuleRequiredSignaturesSchema
  >

  export const RepositoryRulePullRequestSchema = z
    .object({
      type: z.literal('pull_request'),
      parameters: z
        .object({
          allowed_merge_methods: z
            .array(z.enum(['merge', 'squash', 'rebase']))
            .describe(
              'Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.'
            )
            .optional(),
          automatic_copilot_code_review_enabled: z
            .boolean()
            .describe(
              '> [!NOTE]\n> `automatic_copilot_code_review_enabled` is in beta and subject to change.\n\nAutomatically request review from Copilot for new pull requests, if the author has access to Copilot code review.'
            )
            .optional(),
          dismiss_stale_reviews_on_push: z
            .boolean()
            .describe(
              'New, reviewable commits pushed will dismiss previous pull request review approvals.'
            ),
          require_code_owner_review: z
            .boolean()
            .describe(
              'Require an approving review in pull requests that modify files that have a designated code owner.'
            ),
          require_last_push_approval: z
            .boolean()
            .describe(
              'Whether the most recent reviewable push must be approved by someone other than the person who pushed it.'
            ),
          required_approving_review_count: z
            .number()
            .int()
            .gte(0)
            .lte(10)
            .describe(
              'The number of approving reviews that are required before a pull request can be merged.'
            ),
          required_review_thread_resolution: z
            .boolean()
            .describe(
              'All conversations on code must be resolved before a pull request can be merged.'
            )
        })
        .optional()
    })
    .describe(
      'Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.'
    )
  export type RepositoryRulePullRequest = z.infer<
    typeof RepositoryRulePullRequestSchema
  >

  export const RepositoryRuleParamsStatusCheckConfigurationSchema = z
    .object({
      context: z
        .string()
        .describe(
          'The status check context name that must be present on the commit.'
        ),
      integration_id: z
        .number()
        .int()
        .describe(
          'The optional integration ID that this status check must originate from.'
        )
        .optional()
    })
    .describe('Required status check')
  export type RepositoryRuleParamsStatusCheckConfiguration = z.infer<
    typeof RepositoryRuleParamsStatusCheckConfigurationSchema
  >

  export const RepositoryRuleNonFastForwardSchema = z
    .object({ type: z.literal('non_fast_forward') })
    .describe('Prevent users with push access from force pushing to refs.')
  export type RepositoryRuleNonFastForward = z.infer<
    typeof RepositoryRuleNonFastForwardSchema
  >

  export const RepositoryRuleCommitMessagePatternSchema = z
    .object({
      type: z.literal('commit_message_pattern'),
      parameters: z
        .object({
          name: z
            .string()
            .describe('How this rule will appear to users.')
            .optional(),
          negate: z
            .boolean()
            .describe('If true, the rule will fail if the pattern matches.')
            .optional(),
          operator: z
            .enum(['starts_with', 'ends_with', 'contains', 'regex'])
            .describe('The operator to use for matching.'),
          pattern: z.string().describe('The pattern to match with.')
        })
        .optional()
    })
    .describe('Parameters to be used for the commit_message_pattern rule')
  export type RepositoryRuleCommitMessagePattern = z.infer<
    typeof RepositoryRuleCommitMessagePatternSchema
  >

  export const RepositoryRuleCommitAuthorEmailPatternSchema = z
    .object({
      type: z.literal('commit_author_email_pattern'),
      parameters: z
        .object({
          name: z
            .string()
            .describe('How this rule will appear to users.')
            .optional(),
          negate: z
            .boolean()
            .describe('If true, the rule will fail if the pattern matches.')
            .optional(),
          operator: z
            .enum(['starts_with', 'ends_with', 'contains', 'regex'])
            .describe('The operator to use for matching.'),
          pattern: z.string().describe('The pattern to match with.')
        })
        .optional()
    })
    .describe('Parameters to be used for the commit_author_email_pattern rule')
  export type RepositoryRuleCommitAuthorEmailPattern = z.infer<
    typeof RepositoryRuleCommitAuthorEmailPatternSchema
  >

  export const RepositoryRuleCommitterEmailPatternSchema = z
    .object({
      type: z.literal('committer_email_pattern'),
      parameters: z
        .object({
          name: z
            .string()
            .describe('How this rule will appear to users.')
            .optional(),
          negate: z
            .boolean()
            .describe('If true, the rule will fail if the pattern matches.')
            .optional(),
          operator: z
            .enum(['starts_with', 'ends_with', 'contains', 'regex'])
            .describe('The operator to use for matching.'),
          pattern: z.string().describe('The pattern to match with.')
        })
        .optional()
    })
    .describe('Parameters to be used for the committer_email_pattern rule')
  export type RepositoryRuleCommitterEmailPattern = z.infer<
    typeof RepositoryRuleCommitterEmailPatternSchema
  >

  export const RepositoryRuleBranchNamePatternSchema = z
    .object({
      type: z.literal('branch_name_pattern'),
      parameters: z
        .object({
          name: z
            .string()
            .describe('How this rule will appear to users.')
            .optional(),
          negate: z
            .boolean()
            .describe('If true, the rule will fail if the pattern matches.')
            .optional(),
          operator: z
            .enum(['starts_with', 'ends_with', 'contains', 'regex'])
            .describe('The operator to use for matching.'),
          pattern: z.string().describe('The pattern to match with.')
        })
        .optional()
    })
    .describe('Parameters to be used for the branch_name_pattern rule')
  export type RepositoryRuleBranchNamePattern = z.infer<
    typeof RepositoryRuleBranchNamePatternSchema
  >

  export const RepositoryRuleTagNamePatternSchema = z
    .object({
      type: z.literal('tag_name_pattern'),
      parameters: z
        .object({
          name: z
            .string()
            .describe('How this rule will appear to users.')
            .optional(),
          negate: z
            .boolean()
            .describe('If true, the rule will fail if the pattern matches.')
            .optional(),
          operator: z
            .enum(['starts_with', 'ends_with', 'contains', 'regex'])
            .describe('The operator to use for matching.'),
          pattern: z.string().describe('The pattern to match with.')
        })
        .optional()
    })
    .describe('Parameters to be used for the tag_name_pattern rule')
  export type RepositoryRuleTagNamePattern = z.infer<
    typeof RepositoryRuleTagNamePatternSchema
  >

  export const RepositoryRuleFilePathRestrictionSchema = z
    .object({
      type: z.literal('file_path_restriction'),
      parameters: z
        .object({
          restricted_file_paths: z
            .array(z.string())
            .describe(
              'The file paths that are restricted from being pushed to the commit graph.'
            )
        })
        .optional()
    })
    .describe(
      'Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.'
    )
  export type RepositoryRuleFilePathRestriction = z.infer<
    typeof RepositoryRuleFilePathRestrictionSchema
  >

  export const RepositoryRuleMaxFilePathLengthSchema = z
    .object({
      type: z.literal('max_file_path_length'),
      parameters: z
        .object({
          max_file_path_length: z
            .number()
            .int()
            .gte(1)
            .lte(256)
            .describe('The maximum amount of characters allowed in file paths.')
        })
        .optional()
    })
    .describe(
      'Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.'
    )
  export type RepositoryRuleMaxFilePathLength = z.infer<
    typeof RepositoryRuleMaxFilePathLengthSchema
  >

  export const RepositoryRuleFileExtensionRestrictionSchema = z
    .object({
      type: z.literal('file_extension_restriction'),
      parameters: z
        .object({
          restricted_file_extensions: z
            .array(z.string())
            .describe(
              'The file extensions that are restricted from being pushed to the commit graph.'
            )
        })
        .optional()
    })
    .describe(
      'Prevent commits that include files with specified file extensions from being pushed to the commit graph.'
    )
  export type RepositoryRuleFileExtensionRestriction = z.infer<
    typeof RepositoryRuleFileExtensionRestrictionSchema
  >

  export const RepositoryRuleMaxFileSizeSchema = z
    .object({
      type: z.literal('max_file_size'),
      parameters: z
        .object({
          max_file_size: z
            .number()
            .int()
            .gte(1)
            .lte(100)
            .describe(
              'The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).'
            )
        })
        .optional()
    })
    .describe(
      'Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.'
    )
  export type RepositoryRuleMaxFileSize = z.infer<
    typeof RepositoryRuleMaxFileSizeSchema
  >

  export const RepositoryRuleParamsWorkflowFileReferenceSchema = z
    .object({
      path: z.string().describe('The path to the workflow file'),
      ref: z
        .string()
        .describe('The ref (branch or tag) of the workflow file to use')
        .optional(),
      repository_id: z
        .number()
        .int()
        .describe('The ID of the repository where the workflow is defined'),
      sha: z
        .string()
        .describe('The commit SHA of the workflow file to use')
        .optional()
    })
    .describe('A workflow that must run for this rule to pass')
  export type RepositoryRuleParamsWorkflowFileReference = z.infer<
    typeof RepositoryRuleParamsWorkflowFileReferenceSchema
  >

  export const RepositoryRuleParamsCodeScanningToolSchema = z
    .object({
      alerts_threshold: z
        .enum(['none', 'errors', 'errors_and_warnings', 'all'])
        .describe(
          'The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."'
        ),
      security_alerts_threshold: z
        .enum(['none', 'critical', 'high_or_higher', 'medium_or_higher', 'all'])
        .describe(
          'The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."'
        ),
      tool: z.string().describe('The name of a code scanning tool')
    })
    .describe(
      'A tool that must provide code scanning results for this rule to pass.'
    )
  export type RepositoryRuleParamsCodeScanningTool = z.infer<
    typeof RepositoryRuleParamsCodeScanningToolSchema
  >

  export const RulesetTargetsSchema = z
    .any()
    .describe(
      'A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n'
    )
  export type RulesetTargets = z.infer<typeof RulesetTargetsSchema>

  export const RuleSuitesSchema = z
    .array(
      z.object({
        id: z
          .number()
          .int()
          .describe('The unique identifier of the rule insight.')
          .optional(),
        actor_id: z
          .number()
          .int()
          .describe('The number that identifies the user.')
          .optional(),
        actor_name: z
          .string()
          .describe('The handle for the GitHub user account.')
          .optional(),
        before_sha: z
          .string()
          .describe('The first commit sha before the push evaluation.')
          .optional(),
        after_sha: z
          .string()
          .describe('The last commit sha in the push evaluation.')
          .optional(),
        ref: z
          .string()
          .describe('The ref name that the evaluation ran on.')
          .optional(),
        repository_id: z
          .number()
          .int()
          .describe(
            'The ID of the repository associated with the rule evaluation.'
          )
          .optional(),
        repository_name: z
          .string()
          .describe('The name of the repository without the `.git` extension.')
          .optional(),
        pushed_at: z.string().datetime({ offset: true }).optional(),
        result: z
          .enum(['pass', 'fail', 'bypass'])
          .describe(
            'The result of the rule evaluations for rules with the `active` enforcement status.'
          )
          .optional(),
        evaluation_result: z
          .enum(['pass', 'fail', 'bypass'])
          .describe(
            'The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`.'
          )
          .optional()
      })
    )
    .describe('Response')
  export type RuleSuites = z.infer<typeof RuleSuitesSchema>

  export const RefInQuerySchema = z
    .any()
    .describe(
      'The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.'
    )
  export type RefInQuery = z.infer<typeof RefInQuerySchema>

  export const RepositoryNameInQuerySchema = z
    .any()
    .describe('The name of the repository to filter on.')
  export type RepositoryNameInQuery = z.infer<
    typeof RepositoryNameInQuerySchema
  >

  export const TimePeriodSchema = z
    .any()
    .describe(
      'The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).'
    )
  export type TimePeriod = z.infer<typeof TimePeriodSchema>

  export const ActorNameInQuerySchema = z
    .any()
    .describe(
      'The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.'
    )
  export type ActorNameInQuery = z.infer<typeof ActorNameInQuerySchema>

  export const RuleSuiteResultSchema = z
    .any()
    .describe(
      'The rule results to filter on. When specified, only suites with this result will be returned.'
    )
  export type RuleSuiteResult = z.infer<typeof RuleSuiteResultSchema>

  export const RuleSuiteSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('The unique identifier of the rule insight.')
        .optional(),
      actor_id: z
        .number()
        .int()
        .describe('The number that identifies the user.')
        .optional(),
      actor_name: z
        .string()
        .describe('The handle for the GitHub user account.')
        .optional(),
      before_sha: z
        .string()
        .describe('The first commit sha before the push evaluation.')
        .optional(),
      after_sha: z
        .string()
        .describe('The last commit sha in the push evaluation.')
        .optional(),
      ref: z
        .string()
        .describe('The ref name that the evaluation ran on.')
        .optional(),
      repository_id: z
        .number()
        .int()
        .describe(
          'The ID of the repository associated with the rule evaluation.'
        )
        .optional(),
      repository_name: z
        .string()
        .describe('The name of the repository without the `.git` extension.')
        .optional(),
      pushed_at: z.string().datetime({ offset: true }).optional(),
      result: z
        .enum(['pass', 'fail', 'bypass'])
        .describe(
          'The result of the rule evaluations for rules with the `active` enforcement status.'
        )
        .optional(),
      evaluation_result: z
        .enum(['pass', 'fail', 'bypass'])
        .describe(
          'The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run.'
        )
        .optional(),
      rule_evaluations: z
        .array(
          z.object({
            rule_source: z
              .object({
                type: z
                  .string()
                  .describe('The type of rule source.')
                  .optional(),
                id: z
                  .number()
                  .int()
                  .describe('The ID of the rule source.')
                  .optional(),
                name: z
                  .string()
                  .describe('The name of the rule source.')
                  .optional()
              })
              .optional(),
            enforcement: z
              .enum(['active', 'evaluate', 'deleted ruleset'])
              .describe('The enforcement level of this rule source.')
              .optional(),
            result: z
              .enum(['pass', 'fail'])
              .describe('The result of the evaluation of the individual rule.')
              .optional(),
            rule_type: z.string().describe('The type of rule.').optional(),
            details: z
              .string()
              .describe(
                'The detailed failure message for the rule. Null if the rule passed.'
              )
              .optional()
          })
        )
        .describe('Details on the evaluated rules.')
        .optional()
    })
    .describe('Response')
  export type RuleSuite = z.infer<typeof RuleSuiteSchema>

  export const RuleSuiteIdSchema = z
    .any()
    .describe(
      'The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.'
    )
  export type RuleSuiteId = z.infer<typeof RuleSuiteIdSchema>

  export const RulesetVersionSchema = z
    .object({
      version_id: z
        .number()
        .int()
        .describe('The ID of the previous version of the ruleset'),
      actor: z
        .object({
          id: z.number().int().optional(),
          type: z.string().optional()
        })
        .describe('The actor who updated the ruleset'),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('The historical version of a ruleset')
  export type RulesetVersion = z.infer<typeof RulesetVersionSchema>

  export const SecretScanningPaginationBeforeOrgRepoSchema = z
    .any()
    .describe(
      'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.'
    )
  export type SecretScanningPaginationBeforeOrgRepo = z.infer<
    typeof SecretScanningPaginationBeforeOrgRepoSchema
  >

  export const SecretScanningPaginationAfterOrgRepoSchema = z
    .any()
    .describe(
      'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.  To receive an initial cursor on your first request, include an empty "after" query string.'
    )
  export type SecretScanningPaginationAfterOrgRepo = z.infer<
    typeof SecretScanningPaginationAfterOrgRepoSchema
  >

  export const ActionsBillingUsageSchema = z.object({
    total_minutes_used: z
      .number()
      .int()
      .describe('The sum of the free and paid GitHub Actions minutes used.'),
    total_paid_minutes_used: z
      .number()
      .int()
      .describe('The total paid GitHub Actions minutes used.'),
    included_minutes: z
      .number()
      .int()
      .describe('The amount of free GitHub Actions minutes available.'),
    minutes_used_breakdown: z.object({
      UBUNTU: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu runner machines.')
        .optional(),
      MACOS: z
        .number()
        .int()
        .describe('Total minutes used on macOS runner machines.')
        .optional(),
      WINDOWS: z
        .number()
        .int()
        .describe('Total minutes used on Windows runner machines.')
        .optional(),
      ubuntu_4_core: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu 4 core runner machines.')
        .optional(),
      ubuntu_8_core: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu 8 core runner machines.')
        .optional(),
      ubuntu_16_core: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu 16 core runner machines.')
        .optional(),
      ubuntu_32_core: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu 32 core runner machines.')
        .optional(),
      ubuntu_64_core: z
        .number()
        .int()
        .describe('Total minutes used on Ubuntu 64 core runner machines.')
        .optional(),
      windows_4_core: z
        .number()
        .int()
        .describe('Total minutes used on Windows 4 core runner machines.')
        .optional(),
      windows_8_core: z
        .number()
        .int()
        .describe('Total minutes used on Windows 8 core runner machines.')
        .optional(),
      windows_16_core: z
        .number()
        .int()
        .describe('Total minutes used on Windows 16 core runner machines.')
        .optional(),
      windows_32_core: z
        .number()
        .int()
        .describe('Total minutes used on Windows 32 core runner machines.')
        .optional(),
      windows_64_core: z
        .number()
        .int()
        .describe('Total minutes used on Windows 64 core runner machines.')
        .optional(),
      macos_12_core: z
        .number()
        .int()
        .describe('Total minutes used on macOS 12 core runner machines.')
        .optional(),
      total: z
        .number()
        .int()
        .describe('Total minutes used on all runner machines.')
        .optional()
    })
  })
  export type ActionsBillingUsage = z.infer<typeof ActionsBillingUsageSchema>

  export const PackagesBillingUsageSchema = z.object({
    total_gigabytes_bandwidth_used: z
      .number()
      .int()
      .describe(
        'Sum of the free and paid storage space (GB) for GitHuub Packages.'
      ),
    total_paid_gigabytes_bandwidth_used: z
      .number()
      .int()
      .describe('Total paid storage space (GB) for GitHuub Packages.'),
    included_gigabytes_bandwidth: z
      .number()
      .int()
      .describe('Free storage space (GB) for GitHub Packages.')
  })
  export type PackagesBillingUsage = z.infer<typeof PackagesBillingUsageSchema>

  export const CombinedBillingUsageSchema = z.object({
    days_left_in_billing_cycle: z
      .number()
      .int()
      .describe('Numbers of days left in billing cycle.'),
    estimated_paid_storage_for_month: z
      .number()
      .int()
      .describe('Estimated storage space (GB) used in billing cycle.'),
    estimated_storage_for_month: z
      .number()
      .int()
      .describe(
        'Estimated sum of free and paid storage space (GB) used in billing cycle.'
      )
  })
  export type CombinedBillingUsage = z.infer<typeof CombinedBillingUsageSchema>

  export const NetworkConfigurationSchema = z
    .object({
      id: z
        .string()
        .describe('The unique identifier of the network configuration.'),
      name: z.string().describe('The name of the network configuration.'),
      compute_service: z
        .enum(['none', 'actions', 'codespaces'])
        .describe(
          'The hosted compute service the network configuration supports.'
        )
        .optional(),
      network_settings_ids: z
        .array(z.string())
        .describe(
          'The unique identifier of each network settings in the configuration.'
        )
        .optional(),
      created_on: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time at which the network configuration was created, in ISO 8601 format.'
        )
    })
    .describe('A hosted compute network configuration.')
  export type NetworkConfiguration = z.infer<typeof NetworkConfigurationSchema>

  export const NetworkConfigurationIdSchema = z
    .any()
    .describe('Unique identifier of the hosted compute network configuration.')
  export type NetworkConfigurationId = z.infer<
    typeof NetworkConfigurationIdSchema
  >

  export const NetworkSettingsSchema = z
    .object({
      id: z
        .string()
        .describe('The unique identifier of the network settings resource.'),
      network_configuration_id: z
        .string()
        .describe(
          'The identifier of the network configuration that is using this settings resource.'
        )
        .optional(),
      name: z.string().describe('The name of the network settings resource.'),
      subnet_id: z
        .string()
        .describe(
          'The subnet this network settings resource is configured for.'
        ),
      region: z
        .string()
        .describe(
          'The location of the subnet this network settings resource is configured for.'
        )
    })
    .describe('A hosted compute network settings resource.')
  export type NetworkSettings = z.infer<typeof NetworkSettingsSchema>

  export const NetworkSettingsIdSchema = z
    .any()
    .describe('Unique identifier of the hosted compute network settings.')
  export type NetworkSettingsId = z.infer<typeof NetworkSettingsIdSchema>

  export const TeamOrganizationSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string().url(),
      hooks_url: z.string(),
      issues_url: z.string(),
      members_url: z.string(),
      public_members_url: z.string(),
      avatar_url: z.string(),
      description: z.string(),
      name: z.string().optional(),
      company: z.string().optional(),
      blog: z.string().url().optional(),
      location: z.string().optional(),
      email: z.string().email().optional(),
      twitter_username: z.string().optional(),
      is_verified: z.boolean().optional(),
      has_organization_projects: z.boolean(),
      has_repository_projects: z.boolean(),
      public_repos: z.number().int(),
      public_gists: z.number().int(),
      followers: z.number().int(),
      following: z.number().int(),
      html_url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      type: z.string(),
      total_private_repos: z.number().int().optional(),
      owned_private_repos: z.number().int().optional(),
      private_gists: z.number().int().optional(),
      disk_usage: z.number().int().optional(),
      collaborators: z.number().int().optional(),
      billing_email: z.string().email().optional(),
      plan: z
        .object({
          name: z.string(),
          space: z.number().int(),
          private_repos: z.number().int(),
          filled_seats: z.number().int().optional(),
          seats: z.number().int().optional()
        })
        .optional(),
      default_repository_permission: z.string().optional(),
      members_can_create_repositories: z.boolean().optional(),
      two_factor_requirement_enabled: z.boolean().optional(),
      members_allowed_repository_creation_type: z.string().optional(),
      members_can_create_public_repositories: z.boolean().optional(),
      members_can_create_private_repositories: z.boolean().optional(),
      members_can_create_internal_repositories: z.boolean().optional(),
      members_can_create_pages: z.boolean().optional(),
      members_can_create_public_pages: z.boolean().optional(),
      members_can_create_private_pages: z.boolean().optional(),
      members_can_fork_private_repositories: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional(),
      updated_at: z.string().datetime({ offset: true }),
      archived_at: z.string().datetime({ offset: true })
    })
    .describe('Team Organization')
  export type TeamOrganization = z.infer<typeof TeamOrganizationSchema>

  export const DiscussionNumberSchema = z
    .any()
    .describe('The number that identifies the discussion.')
  export type DiscussionNumber = z.infer<typeof DiscussionNumberSchema>

  export const CommentNumberSchema = z
    .any()
    .describe('The number that identifies the comment.')
  export type CommentNumber = z.infer<typeof CommentNumberSchema>

  export const ReactionIdSchema = z
    .any()
    .describe('The unique identifier of the reaction.')
  export type ReactionId = z.infer<typeof ReactionIdSchema>

  export const TeamMembershipSchema = z
    .object({
      url: z.string().url(),
      role: z
        .enum(['member', 'maintainer'])
        .describe('The role of the user in the team.')
        .default('member'),
      state: z
        .enum(['active', 'pending'])
        .describe("The state of the user's membership in the team.")
    })
    .describe('Team Membership')
  export type TeamMembership = z.infer<typeof TeamMembershipSchema>

  export const ProjectIdSchema = z
    .any()
    .describe('The unique identifier of the project.')
  export type ProjectId = z.infer<typeof ProjectIdSchema>

  export const SecurityProductSchema = z
    .any()
    .describe('The security feature to enable or disable.')
  export type SecurityProduct = z.infer<typeof SecurityProductSchema>

  export const OrgSecurityProductEnablementSchema = z
    .any()
    .describe(
      'The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.'
    )
  export type OrgSecurityProductEnablement = z.infer<
    typeof OrgSecurityProductEnablementSchema
  >

  export const CardIdSchema = z
    .any()
    .describe('The unique identifier of the card.')
  export type CardId = z.infer<typeof CardIdSchema>

  export const ProjectColumnSchema = z
    .object({
      url: z.string().url(),
      project_url: z.string().url(),
      cards_url: z.string().url(),
      id: z
        .number()
        .int()
        .describe('The unique identifier of the project column'),
      node_id: z.string(),
      name: z.string().describe('Name of the project column'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Project columns contain cards of work.')
  export type ProjectColumn = z.infer<typeof ProjectColumnSchema>

  export const ColumnIdSchema = z
    .any()
    .describe('The unique identifier of the column.')
  export type ColumnId = z.infer<typeof ColumnIdSchema>

  export const RateLimitSchema = z.object({
    limit: z.number().int(),
    remaining: z.number().int(),
    reset: z.number().int(),
    used: z.number().int()
  })
  export type RateLimit = z.infer<typeof RateLimitSchema>

  export const ArtifactSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string().describe('The name of the artifact.'),
      size_in_bytes: z
        .number()
        .int()
        .describe('The size in bytes of the artifact.'),
      url: z.string(),
      archive_download_url: z.string(),
      expired: z.boolean().describe('Whether or not the artifact has expired.'),
      created_at: z.string().datetime({ offset: true }),
      expires_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      digest: z
        .string()
        .describe(
          'The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.'
        )
        .optional(),
      workflow_run: z
        .object({
          id: z.number().int().optional(),
          repository_id: z.number().int().optional(),
          head_repository_id: z.number().int().optional(),
          head_branch: z.string().optional(),
          head_sha: z.string().optional()
        })
        .optional()
    })
    .describe('An artifact')
  export type Artifact = z.infer<typeof ArtifactSchema>

  export const ArtifactNameSchema = z
    .any()
    .describe(
      'The name field of an artifact. When specified, only artifacts with this name will be returned.'
    )
  export type ArtifactName = z.infer<typeof ArtifactNameSchema>

  export const ArtifactIdSchema = z
    .any()
    .describe('The unique identifier of the artifact.')
  export type ArtifactId = z.infer<typeof ArtifactIdSchema>

  export const ActionsCacheListSchema = z
    .object({
      total_count: z.number().int().describe('Total number of caches'),
      actions_caches: z
        .array(
          z.object({
            id: z.number().int().optional(),
            ref: z.string().optional(),
            key: z.string().optional(),
            version: z.string().optional(),
            last_accessed_at: z.string().datetime({ offset: true }).optional(),
            created_at: z.string().datetime({ offset: true }).optional(),
            size_in_bytes: z.number().int().optional()
          })
        )
        .describe('Array of caches')
    })
    .describe('Repository actions caches')
  export type ActionsCacheList = z.infer<typeof ActionsCacheListSchema>

  export const ActionsCacheGitRefFullSchema = z
    .any()
    .describe(
      'The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
    )
  export type ActionsCacheGitRefFull = z.infer<
    typeof ActionsCacheGitRefFullSchema
  >

  export const ActionsCacheKeySchema = z
    .any()
    .describe('An explicit key or prefix for identifying the cache')
  export type ActionsCacheKey = z.infer<typeof ActionsCacheKeySchema>

  export const ActionsCacheListSortSchema = z
    .any()
    .describe(
      'The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.'
    )
  export type ActionsCacheListSort = z.infer<typeof ActionsCacheListSortSchema>

  export const ActionsCacheKeyRequiredSchema = z
    .any()
    .describe('A key for identifying the cache.')
  export type ActionsCacheKeyRequired = z.infer<
    typeof ActionsCacheKeyRequiredSchema
  >

  export const CacheIdSchema = z
    .any()
    .describe('The unique identifier of the GitHub Actions cache.')
  export type CacheId = z.infer<typeof CacheIdSchema>

  export const JobSchema = z
    .object({
      id: z.number().int().describe('The id of the job.'),
      run_id: z
        .number()
        .int()
        .describe('The id of the associated workflow run.'),
      run_url: z.string(),
      run_attempt: z
        .number()
        .int()
        .describe(
          'Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.'
        )
        .optional(),
      node_id: z.string(),
      head_sha: z.string().describe('The SHA of the commit that is being run.'),
      url: z.string(),
      html_url: z.string(),
      status: z
        .enum([
          'queued',
          'in_progress',
          'completed',
          'waiting',
          'requested',
          'pending'
        ])
        .describe('The phase of the lifecycle that the job is currently in.'),
      conclusion: z
        .enum([
          'success',
          'failure',
          'neutral',
          'cancelled',
          'skipped',
          'timed_out',
          'action_required'
        ])
        .describe('The outcome of the job.'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time that the job created, in ISO 8601 format.'),
      started_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time that the job started, in ISO 8601 format.'),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time that the job finished, in ISO 8601 format.'),
      name: z.string().describe('The name of the job.'),
      steps: z
        .array(
          z.object({
            status: z
              .enum(['queued', 'in_progress', 'completed'])
              .describe(
                'The phase of the lifecycle that the job is currently in.'
              ),
            conclusion: z.string().describe('The outcome of the job.'),
            name: z.string().describe('The name of the job.'),
            number: z.number().int(),
            started_at: z
              .string()
              .datetime({ offset: true })
              .describe('The time that the step started, in ISO 8601 format.')
              .optional(),
            completed_at: z
              .string()
              .datetime({ offset: true })
              .describe('The time that the job finished, in ISO 8601 format.')
              .optional()
          })
        )
        .describe('Steps in this job.')
        .optional(),
      check_run_url: z.string(),
      labels: z
        .array(z.string())
        .describe(
          'Labels for the workflow job. Specified by the "runs_on" attribute in the action\'s workflow file.'
        ),
      runner_id: z
        .number()
        .int()
        .describe(
          "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
        ),
      runner_name: z
        .string()
        .describe(
          "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
        ),
      runner_group_id: z
        .number()
        .int()
        .describe(
          "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
        ),
      runner_group_name: z
        .string()
        .describe(
          "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
        ),
      workflow_name: z.string().describe('The name of the workflow.'),
      head_branch: z.string().describe('The name of the current branch.')
    })
    .describe('Information of a job execution in a workflow run')
  export type Job = z.infer<typeof JobSchema>

  export const JobIdSchema = z
    .any()
    .describe('The unique identifier of the job.')
  export type JobId = z.infer<typeof JobIdSchema>

  export const OidcCustomSubRepoSchema = z
    .object({
      use_default: z
        .boolean()
        .describe(
          'Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.'
        ),
      include_claim_keys: z
        .array(z.string())
        .describe(
          'Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.'
        )
        .optional()
    })
    .describe('Actions OIDC subject customization for a repository')
  export type OidcCustomSubRepo = z.infer<typeof OidcCustomSubRepoSchema>

  export const ActionsSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Set secrets for GitHub Actions.')
  export type ActionsSecret = z.infer<typeof ActionsSecretSchema>

  export const ActionsVariableSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.'),
    created_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
      ),
    updated_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
      )
  })
  export type ActionsVariable = z.infer<typeof ActionsVariableSchema>

  export const ActionsEnabledSchema = z
    .boolean()
    .describe('Whether GitHub Actions is enabled on the repository.')
  export type ActionsEnabled = z.infer<typeof ActionsEnabledSchema>

  export const ActionsWorkflowAccessToRepositorySchema = z.object({
    access_level: z
      .enum(['none', 'user', 'organization'])
      .describe(
        'Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.'
      )
  })
  export type ActionsWorkflowAccessToRepository = z.infer<
    typeof ActionsWorkflowAccessToRepositorySchema
  >

  export const ReferencedWorkflowSchema = z
    .object({ path: z.string(), sha: z.string(), ref: z.string().optional() })
    .describe('A workflow referenced/reused by the initial caller workflow')
  export type ReferencedWorkflow = z.infer<typeof ReferencedWorkflowSchema>

  export const PullRequestMinimalSchema = z.object({
    id: z.number().int(),
    number: z.number().int(),
    url: z.string(),
    head: z.object({
      ref: z.string(),
      sha: z.string(),
      repo: z.object({
        id: z.number().int(),
        url: z.string(),
        name: z.string()
      })
    }),
    base: z.object({
      ref: z.string(),
      sha: z.string(),
      repo: z.object({
        id: z.number().int(),
        url: z.string(),
        name: z.string()
      })
    })
  })
  export type PullRequestMinimal = z.infer<typeof PullRequestMinimalSchema>

  export const NullableSimpleCommitSchema = z
    .object({
      id: z.string().describe('SHA for the commit'),
      tree_id: z.string().describe("SHA for the commit's tree"),
      message: z
        .string()
        .describe('Message describing the purpose of the commit'),
      timestamp: z
        .string()
        .datetime({ offset: true })
        .describe('Timestamp of the commit'),
      author: z
        .object({
          name: z.string().describe("Name of the commit's author"),
          email: z
            .string()
            .email()
            .describe("Git email address of the commit's author")
        })
        .describe('Information about the Git author'),
      committer: z
        .object({
          name: z.string().describe("Name of the commit's committer"),
          email: z
            .string()
            .email()
            .describe("Git email address of the commit's committer")
        })
        .describe('Information about the Git committer')
    })
    .describe('A commit.')
  export type NullableSimpleCommit = z.infer<typeof NullableSimpleCommitSchema>

  export const WorkflowRunBranchSchema = z
    .any()
    .describe(
      'Returns workflow runs associated with a branch. Use the name of the branch of the `push`.'
    )
  export type WorkflowRunBranch = z.infer<typeof WorkflowRunBranchSchema>

  export const EventSchema = z
    .object({
      id: z.string(),
      type: z.string(),
      actor: ActorSchema,
      repo: z.object({
        id: z.number().int(),
        name: z.string(),
        url: z.string().url()
      }),
      org: ActorSchema.optional(),
      payload: z.object({
        action: z.string().optional(),
        issue: IssueSchema.optional(),
        comment: IssueCommentSchema.optional(),
        pages: z
          .array(
            z.object({
              page_name: z.string().optional(),
              title: z.string().optional(),
              summary: z.string().optional(),
              action: z.string().optional(),
              sha: z.string().optional(),
              html_url: z.string().optional()
            })
          )
          .optional()
      }),
      public: z.boolean(),
      created_at: z.string().datetime({ offset: true })
    })
    .describe('Event')
  export type Event = z.infer<typeof EventSchema>

  export const WorkflowRunStatusSchema = z
    .any()
    .describe(
      'Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.'
    )
  export type WorkflowRunStatus = z.infer<typeof WorkflowRunStatusSchema>

  export const CreatedSchema = z
    .any()
    .describe(
      'Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
    )
  export type Created = z.infer<typeof CreatedSchema>

  export const ExcludePullRequestsSchema = z
    .any()
    .describe(
      'If `true` pull requests are omitted from the response (empty array).'
    )
  export type ExcludePullRequests = z.infer<typeof ExcludePullRequestsSchema>

  export const WorkflowRunCheckSuiteIdSchema = z
    .any()
    .describe(
      'Returns workflow runs with the `check_suite_id` that you specify.'
    )
  export type WorkflowRunCheckSuiteId = z.infer<
    typeof WorkflowRunCheckSuiteIdSchema
  >

  export const WorkflowRunHeadShaSchema = z
    .any()
    .describe(
      'Only returns workflow runs that are associated with the specified `head_sha`.'
    )
  export type WorkflowRunHeadSha = z.infer<typeof WorkflowRunHeadShaSchema>

  export const RunIdSchema = z
    .any()
    .describe('The unique identifier of the workflow run.')
  export type RunId = z.infer<typeof RunIdSchema>

  export const AttemptNumberSchema = z
    .any()
    .describe('The attempt number of the workflow run.')
  export type AttemptNumber = z.infer<typeof AttemptNumberSchema>

  export const ReviewCustomGatesCommentRequiredSchema = z.object({
    environment_name: z
      .string()
      .describe('The name of the environment to approve or reject.'),
    comment: z
      .string()
      .describe(
        'Comment associated with the pending deployment protection rule. **Required when state is not provided.**'
      )
  })
  export type ReviewCustomGatesCommentRequired = z.infer<
    typeof ReviewCustomGatesCommentRequiredSchema
  >

  export const ReviewCustomGatesStateRequiredSchema = z.object({
    environment_name: z
      .string()
      .describe('The name of the environment to approve or reject.'),
    state: z
      .enum(['approved', 'rejected'])
      .describe(
        'Whether to approve or reject deployment to the specified environments.'
      ),
    comment: z
      .string()
      .describe('Optional comment to include with the review.')
      .optional()
  })
  export type ReviewCustomGatesStateRequired = z.infer<
    typeof ReviewCustomGatesStateRequiredSchema
  >

  export const DeploymentReviewerTypeSchema = z
    .enum(['User', 'Team'])
    .describe('The type of reviewer.')
  export type DeploymentReviewerType = z.infer<
    typeof DeploymentReviewerTypeSchema
  >

  export const WorkflowRunUsageSchema = z
    .object({
      billable: z.object({
        UBUNTU: z
          .object({
            total_ms: z.number().int(),
            jobs: z.number().int(),
            job_runs: z
              .array(
                z.object({
                  job_id: z.number().int(),
                  duration_ms: z.number().int()
                })
              )
              .optional()
          })
          .optional(),
        MACOS: z
          .object({
            total_ms: z.number().int(),
            jobs: z.number().int(),
            job_runs: z
              .array(
                z.object({
                  job_id: z.number().int(),
                  duration_ms: z.number().int()
                })
              )
              .optional()
          })
          .optional(),
        WINDOWS: z
          .object({
            total_ms: z.number().int(),
            jobs: z.number().int(),
            job_runs: z
              .array(
                z.object({
                  job_id: z.number().int(),
                  duration_ms: z.number().int()
                })
              )
              .optional()
          })
          .optional()
      }),
      run_duration_ms: z.number().int().optional()
    })
    .describe('Workflow Run Usage')
  export type WorkflowRunUsage = z.infer<typeof WorkflowRunUsageSchema>

  export const WorkflowSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      path: z.string(),
      state: z.enum([
        'active',
        'deleted',
        'disabled_fork',
        'disabled_inactivity',
        'disabled_manually'
      ]),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      url: z.string(),
      html_url: z.string(),
      badge_url: z.string(),
      deleted_at: z.string().datetime({ offset: true }).optional()
    })
    .describe('A GitHub Actions workflow')
  export type Workflow = z.infer<typeof WorkflowSchema>

  export const WorkflowIdSchema = z
    .any()
    .describe(
      'The ID of the workflow. You can also pass the workflow file name as a string.'
    )
  export type WorkflowId = z.infer<typeof WorkflowIdSchema>

  export const WorkflowUsageSchema = z
    .object({
      billable: z.object({
        UBUNTU: z.object({ total_ms: z.number().int().optional() }).optional(),
        MACOS: z.object({ total_ms: z.number().int().optional() }).optional(),
        WINDOWS: z.object({ total_ms: z.number().int().optional() }).optional()
      })
    })
    .describe('Workflow Usage')
  export type WorkflowUsage = z.infer<typeof WorkflowUsageSchema>

  export const AutolinkSchema = z
    .object({
      id: z.number().int(),
      key_prefix: z.string().describe('The prefix of a key that is linkified.'),
      url_template: z
        .string()
        .describe(
          'A template for the target URL that is generated if a key was found.'
        ),
      is_alphanumeric: z
        .boolean()
        .describe(
          'Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.'
        )
    })
    .describe('An autolink reference.')
  export type Autolink = z.infer<typeof AutolinkSchema>

  export const AutolinkIdSchema = z
    .any()
    .describe('The unique identifier of the autolink.')
  export type AutolinkId = z.infer<typeof AutolinkIdSchema>

  export const CheckAutomatedSecurityFixesSchema = z
    .object({
      enabled: z
        .boolean()
        .describe(
          'Whether Dependabot security updates are enabled for the repository.'
        ),
      paused: z
        .boolean()
        .describe(
          'Whether Dependabot security updates are paused for the repository.'
        )
    })
    .describe('Check Dependabot security updates')
  export type CheckAutomatedSecurityFixes = z.infer<
    typeof CheckAutomatedSecurityFixesSchema
  >

  export const ProtectedBranchRequiredStatusCheckSchema = z
    .object({
      url: z.string().optional(),
      enforcement_level: z.string().optional(),
      contexts: z.array(z.string()),
      checks: z.array(
        z.object({ context: z.string(), app_id: z.number().int() })
      ),
      contexts_url: z.string().optional(),
      strict: z.boolean().optional()
    })
    .describe('Protected Branch Required Status Check')
  export type ProtectedBranchRequiredStatusCheck = z.infer<
    typeof ProtectedBranchRequiredStatusCheckSchema
  >

  export const ProtectedBranchAdminEnforcedSchema = z
    .object({ url: z.string().url(), enabled: z.boolean() })
    .describe('Protected Branch Admin Enforced')
  export type ProtectedBranchAdminEnforced = z.infer<
    typeof ProtectedBranchAdminEnforcedSchema
  >

  export const BranchRestrictionPolicySchema = z
    .object({
      url: z.string().url(),
      users_url: z.string().url(),
      teams_url: z.string().url(),
      apps_url: z.string().url(),
      users: z.array(
        z.object({
          login: z.string().optional(),
          id: z.number().int().optional(),
          node_id: z.string().optional(),
          avatar_url: z.string().optional(),
          gravatar_id: z.string().optional(),
          url: z.string().optional(),
          html_url: z.string().optional(),
          followers_url: z.string().optional(),
          following_url: z.string().optional(),
          gists_url: z.string().optional(),
          starred_url: z.string().optional(),
          subscriptions_url: z.string().optional(),
          organizations_url: z.string().optional(),
          repos_url: z.string().optional(),
          events_url: z.string().optional(),
          received_events_url: z.string().optional(),
          type: z.string().optional(),
          site_admin: z.boolean().optional(),
          user_view_type: z.string().optional()
        })
      ),
      teams: z.array(
        z.object({
          id: z.number().int().optional(),
          node_id: z.string().optional(),
          url: z.string().optional(),
          html_url: z.string().optional(),
          name: z.string().optional(),
          slug: z.string().optional(),
          description: z.string().optional(),
          privacy: z.string().optional(),
          notification_setting: z.string().optional(),
          permission: z.string().optional(),
          members_url: z.string().optional(),
          repositories_url: z.string().optional(),
          parent: z.string().optional()
        })
      ),
      apps: z.array(
        z.object({
          id: z.number().int().optional(),
          slug: z.string().optional(),
          node_id: z.string().optional(),
          owner: z
            .object({
              login: z.string().optional(),
              id: z.number().int().optional(),
              node_id: z.string().optional(),
              url: z.string().optional(),
              repos_url: z.string().optional(),
              events_url: z.string().optional(),
              hooks_url: z.string().optional(),
              issues_url: z.string().optional(),
              members_url: z.string().optional(),
              public_members_url: z.string().optional(),
              avatar_url: z.string().optional(),
              description: z.string().optional(),
              gravatar_id: z.string().optional(),
              html_url: z.string().optional(),
              followers_url: z.string().optional(),
              following_url: z.string().optional(),
              gists_url: z.string().optional(),
              starred_url: z.string().optional(),
              subscriptions_url: z.string().optional(),
              organizations_url: z.string().optional(),
              received_events_url: z.string().optional(),
              type: z.string().optional(),
              site_admin: z.boolean().optional(),
              user_view_type: z.string().optional()
            })
            .optional(),
          name: z.string().optional(),
          client_id: z.string().optional(),
          description: z.string().optional(),
          external_url: z.string().optional(),
          html_url: z.string().optional(),
          created_at: z.string().optional(),
          updated_at: z.string().optional(),
          permissions: z
            .object({
              metadata: z.string().optional(),
              contents: z.string().optional(),
              issues: z.string().optional(),
              single_file: z.string().optional()
            })
            .optional(),
          events: z.array(z.string()).optional()
        })
      )
    })
    .describe('Branch Restriction Policy')
  export type BranchRestrictionPolicy = z.infer<
    typeof BranchRestrictionPolicySchema
  >

  export const NullableGitUserSchema = z
    .object({
      name: z.string().optional(),
      email: z.string().optional(),
      date: z.string().optional()
    })
    .describe('Metaproperties for Git author/committer information.')
  export type NullableGitUser = z.infer<typeof NullableGitUserSchema>

  export const VerificationSchema = z.object({
    verified: z.boolean(),
    reason: z.string(),
    payload: z.string(),
    signature: z.string(),
    verified_at: z.string()
  })
  export type Verification = z.infer<typeof VerificationSchema>

  export const DiffEntrySchema = z
    .object({
      sha: z.string(),
      filename: z.string(),
      status: z.enum([
        'added',
        'removed',
        'modified',
        'renamed',
        'copied',
        'changed',
        'unchanged'
      ]),
      additions: z.number().int(),
      deletions: z.number().int(),
      changes: z.number().int(),
      blob_url: z.string().url(),
      raw_url: z.string().url(),
      contents_url: z.string().url(),
      patch: z.string().optional(),
      previous_filename: z.string().optional()
    })
    .describe('Diff Entry')
  export type DiffEntry = z.infer<typeof DiffEntrySchema>

  export const BranchSchema = z
    .any()
    .describe(
      'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
    )
  export type Branch = z.infer<typeof BranchSchema>

  export const StatusCheckPolicySchema = z
    .object({
      url: z.string().url(),
      strict: z.boolean(),
      contexts: z.array(z.string()),
      checks: z.array(
        z.object({ context: z.string(), app_id: z.number().int() })
      ),
      contexts_url: z.string().url()
    })
    .describe('Status Check Policy')
  export type StatusCheckPolicy = z.infer<typeof StatusCheckPolicySchema>

  export const CheckRunIdSchema = z
    .any()
    .describe('The unique identifier of the check run.')
  export type CheckRunId = z.infer<typeof CheckRunIdSchema>

  export const CheckAnnotationSchema = z
    .object({
      path: z.string(),
      start_line: z.number().int(),
      end_line: z.number().int(),
      start_column: z.number().int(),
      end_column: z.number().int(),
      annotation_level: z.string(),
      title: z.string(),
      message: z.string(),
      raw_details: z.string(),
      blob_href: z.string()
    })
    .describe('Check Annotation')
  export type CheckAnnotation = z.infer<typeof CheckAnnotationSchema>

  export const SimpleCommitSchema = z
    .object({
      id: z.string().describe('SHA for the commit'),
      tree_id: z.string().describe("SHA for the commit's tree"),
      message: z
        .string()
        .describe('Message describing the purpose of the commit'),
      timestamp: z
        .string()
        .datetime({ offset: true })
        .describe('Timestamp of the commit'),
      author: z
        .object({
          name: z.string().describe("Name of the commit's author"),
          email: z
            .string()
            .email()
            .describe("Git email address of the commit's author")
        })
        .describe('Information about the Git author'),
      committer: z
        .object({
          name: z.string().describe("Name of the commit's committer"),
          email: z
            .string()
            .email()
            .describe("Git email address of the commit's committer")
        })
        .describe('Information about the Git committer')
    })
    .describe('A commit.')
  export type SimpleCommit = z.infer<typeof SimpleCommitSchema>

  export const CheckSuiteIdSchema = z
    .any()
    .describe('The unique identifier of the check suite.')
  export type CheckSuiteId = z.infer<typeof CheckSuiteIdSchema>

  export const CheckNameSchema = z
    .any()
    .describe('Returns check runs with the specified `name`.')
  export type CheckName = z.infer<typeof CheckNameSchema>

  export const StatusSchema = z
    .object({
      url: z.string(),
      avatar_url: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      state: z.string(),
      description: z.string(),
      target_url: z.string(),
      context: z.string(),
      created_at: z.string(),
      updated_at: z.string(),
      creator: NullableSimpleUserSchema
    })
    .describe('The status of a commit.')
  export type Status = z.infer<typeof StatusSchema>

  export const PrAliasSchema = z
    .any()
    .describe(
      'The number of the pull request for the results you want to list.'
    )
  export type PrAlias = z.infer<typeof PrAliasSchema>

  export const CodeScanningAlertRuleSchema = z.object({
    id: z
      .string()
      .describe('A unique identifier for the rule used to detect the alert.')
      .optional(),
    name: z
      .string()
      .describe('The name of the rule used to detect the alert.')
      .optional(),
    severity: z
      .enum(['none', 'note', 'warning', 'error'])
      .describe('The severity of the alert.')
      .optional(),
    security_severity_level: z
      .enum(['low', 'medium', 'high', 'critical'])
      .describe('The security severity of the alert.')
      .optional(),
    description: z
      .string()
      .describe('A short description of the rule used to detect the alert.')
      .optional(),
    full_description: z
      .string()
      .describe('A description of the rule used to detect the alert.')
      .optional(),
    tags: z
      .array(z.string())
      .describe('A set of tags applicable for the rule.')
      .optional(),
    help: z
      .string()
      .describe(
        'Detailed documentation for the rule as GitHub Flavored Markdown.'
      )
      .optional(),
    help_uri: z
      .string()
      .describe(
        'A link to the documentation for the rule used to detect the alert.'
      )
      .optional()
  })
  export type CodeScanningAlertRule = z.infer<
    typeof CodeScanningAlertRuleSchema
  >

  export const CodeScanningAlertSetStateSchema = z
    .enum(['open', 'dismissed'])
    .describe(
      'Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.'
    )
  export type CodeScanningAlertSetState = z.infer<
    typeof CodeScanningAlertSetStateSchema
  >

  export const CodeScanningAlertCreateRequestSchema = z
    .boolean()
    .describe('If `true`, attempt to create an alert dismissal request.')
  export type CodeScanningAlertCreateRequest = z.infer<
    typeof CodeScanningAlertCreateRequestSchema
  >

  export const CodeScanningAutofixStatusSchema = z
    .enum(['pending', 'error', 'success', 'outdated'])
    .describe('The status of an autofix.')
  export type CodeScanningAutofixStatus = z.infer<
    typeof CodeScanningAutofixStatusSchema
  >

  export const CodeScanningAutofixDescriptionSchema = z
    .string()
    .describe('The description of an autofix.')
  export type CodeScanningAutofixDescription = z.infer<
    typeof CodeScanningAutofixDescriptionSchema
  >

  export const CodeScanningAutofixStartedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type CodeScanningAutofixStartedAt = z.infer<
    typeof CodeScanningAutofixStartedAtSchema
  >

  export const CodeScanningAutofixCommitsSchema = z
    .object({
      target_ref: z
        .string()
        .describe(
          'The Git reference of target branch for the commit. Branch needs to already exist.  For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
        )
        .optional(),
      message: z.string().describe('Commit message to be used.').optional()
    })
    .describe('Commit an autofix for a code scanning alert')
  export type CodeScanningAutofixCommits = z.infer<
    typeof CodeScanningAutofixCommitsSchema
  >

  export const CodeScanningAutofixCommitsResponseSchema = z.object({
    target_ref: z
      .string()
      .describe(
        'The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      )
      .optional(),
    sha: z.string().describe('SHA of commit with autofix.').optional()
  })
  export type CodeScanningAutofixCommitsResponse = z.infer<
    typeof CodeScanningAutofixCommitsResponseSchema
  >

  export const CodeScanningAnalysisCommitShaSchema = z
    .string()
    .regex(new RegExp('^[0-9a-fA-F]+$'))
    .min(40)
    .max(40)
    .describe(
      'The SHA of the commit to which the analysis you are uploading relates.'
    )
  export type CodeScanningAnalysisCommitSha = z.infer<
    typeof CodeScanningAnalysisCommitShaSchema
  >

  export const CodeScanningAnalysisEnvironmentSchema = z
    .string()
    .describe(
      'Identifies the variable values associated with the environment in which this analysis was performed.'
    )
  export type CodeScanningAnalysisEnvironment = z.infer<
    typeof CodeScanningAnalysisEnvironmentSchema
  >

  export const CodeScanningAnalysisCreatedAtSchema = z
    .string()
    .datetime({ offset: true })
    .describe(
      'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
    .readonly()
  export type CodeScanningAnalysisCreatedAt = z.infer<
    typeof CodeScanningAnalysisCreatedAtSchema
  >

  export const CodeScanningAnalysisUrlSchema = z
    .string()
    .url()
    .describe('The REST API URL of the analysis resource.')
    .readonly()
  export type CodeScanningAnalysisUrl = z.infer<
    typeof CodeScanningAnalysisUrlSchema
  >

  export const CodeScanningAnalysisSarifIdSchema = z
    .string()
    .describe('An identifier for the upload.')
  export type CodeScanningAnalysisSarifId = z.infer<
    typeof CodeScanningAnalysisSarifIdSchema
  >

  export const CodeScanningAnalysisDeletionSchema = z
    .object({
      next_analysis_url: z
        .string()
        .url()
        .describe(
          'Next deletable analysis in chain, without last analysis deletion confirmation'
        )
        .readonly(),
      confirm_delete_url: z
        .string()
        .url()
        .describe(
          'Next deletable analysis in chain, with last analysis deletion confirmation'
        )
        .readonly()
    })
    .describe('Successful deletion of a code scanning analysis')
  export type CodeScanningAnalysisDeletion = z.infer<
    typeof CodeScanningAnalysisDeletionSchema
  >

  export const CodeScanningVariantAnalysisLanguageSchema = z
    .enum([
      'cpp',
      'csharp',
      'go',
      'java',
      'javascript',
      'python',
      'ruby',
      'swift'
    ])
    .describe('The language targeted by the CodeQL query')
  export type CodeScanningVariantAnalysisLanguage = z.infer<
    typeof CodeScanningVariantAnalysisLanguageSchema
  >

  export const CodeScanningVariantAnalysisRepositorySchema = z
    .object({
      id: z.number().int().describe('A unique identifier of the repository.'),
      name: z.string().describe('The name of the repository.'),
      full_name: z
        .string()
        .describe('The full, globally unique, name of the repository.'),
      private: z.boolean().describe('Whether the repository is private.'),
      stargazers_count: z.number().int(),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Repository Identifier')
  export type CodeScanningVariantAnalysisRepository = z.infer<
    typeof CodeScanningVariantAnalysisRepositorySchema
  >

  export const CodeScanningVariantAnalysisStatusSchema = z
    .enum([
      'pending',
      'in_progress',
      'succeeded',
      'failed',
      'canceled',
      'timed_out'
    ])
    .describe('The new status of the CodeQL variant analysis repository task.')
  export type CodeScanningVariantAnalysisStatus = z.infer<
    typeof CodeScanningVariantAnalysisStatusSchema
  >

  export const CodeScanningDefaultSetupSchema = z
    .object({
      state: z
        .enum(['configured', 'not-configured'])
        .describe('Code scanning default setup has been configured or not.')
        .optional(),
      languages: z
        .array(
          z.enum([
            'actions',
            'c-cpp',
            'csharp',
            'go',
            'java-kotlin',
            'javascript-typescript',
            'javascript',
            'python',
            'ruby',
            'typescript',
            'swift'
          ])
        )
        .describe('Languages to be analyzed.')
        .optional(),
      runner_type: z
        .enum(['standard', 'labeled'])
        .describe('Runner type to be used.')
        .optional(),
      runner_label: z
        .string()
        .describe('Runner label to be used if the runner type is labeled.')
        .optional(),
      query_suite: z
        .enum(['default', 'extended'])
        .describe('CodeQL query suite to be used.')
        .optional(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe('Timestamp of latest configuration update.')
        .optional(),
      schedule: z
        .literal('weekly')
        .describe('The frequency of the periodic analysis.')
        .optional()
    })
    .describe('Configuration for code scanning default setup.')
  export type CodeScanningDefaultSetup = z.infer<
    typeof CodeScanningDefaultSetupSchema
  >

  export const CodeScanningDefaultSetupUpdateSchema = z
    .object({
      state: z
        .enum(['configured', 'not-configured'])
        .describe('The desired state of code scanning default setup.')
        .optional(),
      runner_type: z
        .enum(['standard', 'labeled'])
        .describe('Runner type to be used.')
        .optional(),
      runner_label: z
        .string()
        .describe('Runner label to be used if the runner type is labeled.')
        .optional(),
      query_suite: z
        .enum(['default', 'extended'])
        .describe('CodeQL query suite to be used.')
        .optional(),
      languages: z
        .array(
          z.enum([
            'actions',
            'c-cpp',
            'csharp',
            'go',
            'java-kotlin',
            'javascript-typescript',
            'python',
            'ruby',
            'swift'
          ])
        )
        .describe('CodeQL languages to be analyzed.')
        .optional()
    })
    .strict()
    .describe('Configuration for code scanning default setup.')
  export type CodeScanningDefaultSetupUpdate = z.infer<
    typeof CodeScanningDefaultSetupUpdateSchema
  >

  export const CodeScanningRefFullSchema = z
    .string()
    .regex(new RegExp('^refs/(heads|tags|pull)/.*$'))
    .describe(
      'The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/tags/<tag>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`.'
    )
  export type CodeScanningRefFull = z.infer<typeof CodeScanningRefFullSchema>

  export const CodeScanningAnalysisSarifFileSchema = z
    .string()
    .describe(
      'A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)."'
    )
  export type CodeScanningAnalysisSarifFile = z.infer<
    typeof CodeScanningAnalysisSarifFileSchema
  >

  export const CodeScanningSarifsStatusSchema = z.object({
    processing_status: z
      .enum(['pending', 'complete', 'failed'])
      .describe(
        '`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.'
      )
      .optional(),
    analyses_url: z
      .string()
      .url()
      .describe(
        'The REST API URL for getting the analyses associated with the upload.'
      )
      .readonly()
      .optional(),
    errors: z
      .array(z.string())
      .describe('Any errors that ocurred during processing of the delivery.')
      .readonly()
      .optional()
  })
  export type CodeScanningSarifsStatus = z.infer<
    typeof CodeScanningSarifsStatusSchema
  >

  export const CodeownersErrorsSchema = z
    .object({
      errors: z.array(
        z.object({
          line: z
            .number()
            .int()
            .describe('The line number where this errors occurs.'),
          column: z
            .number()
            .int()
            .describe('The column number where this errors occurs.'),
          source: z
            .string()
            .describe('The contents of the line where the error occurs.')
            .optional(),
          kind: z.string().describe('The type of error.'),
          suggestion: z
            .string()
            .describe(
              'Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.'
            )
            .optional(),
          message: z
            .string()
            .describe(
              'A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).'
            ),
          path: z
            .string()
            .describe('The path of the file where the error occured.')
        })
      )
    })
    .describe("A list of errors found in a repo's CODEOWNERS file")
  export type CodeownersErrors = z.infer<typeof CodeownersErrorsSchema>

  export const CodespaceMachineSchema = z
    .object({
      name: z.string().describe('The name of the machine.'),
      display_name: z
        .string()
        .describe(
          'The display name of the machine includes cores, memory, and storage.'
        ),
      operating_system: z
        .string()
        .describe('The operating system of the machine.'),
      storage_in_bytes: z
        .number()
        .int()
        .describe('How much storage is available to the codespace.'),
      memory_in_bytes: z
        .number()
        .int()
        .describe('How much memory is available to the codespace.'),
      cpus: z
        .number()
        .int()
        .describe('How many cores are available to the codespace.'),
      prebuild_availability: z
        .enum(['none', 'ready', 'in_progress'])
        .describe(
          'Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.'
        )
    })
    .describe('A description of the machine powering a codespace.')
  export type CodespaceMachine = z.infer<typeof CodespaceMachineSchema>

  export const CodespacesPermissionsCheckForDevcontainerSchema = z
    .object({
      accepted: z
        .boolean()
        .describe(
          'Whether the user has accepted the permissions defined by the devcontainer config'
        )
    })
    .describe('Permission check result for a given devcontainer config.')
  export type CodespacesPermissionsCheckForDevcontainer = z.infer<
    typeof CodespacesPermissionsCheckForDevcontainerSchema
  >

  export const RepoCodespacesSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Set repository secrets for GitHub Codespaces.')
  export type RepoCodespacesSecret = z.infer<typeof RepoCodespacesSecretSchema>

  export const CollaboratorSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      email: z.string().optional(),
      name: z.string().optional(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      permissions: z
        .object({
          pull: z.boolean(),
          triage: z.boolean().optional(),
          push: z.boolean(),
          maintain: z.boolean().optional(),
          admin: z.boolean()
        })
        .optional(),
      role_name: z.string(),
      user_view_type: z.string().optional()
    })
    .describe('Collaborator')
  export type Collaborator = z.infer<typeof CollaboratorSchema>

  export const NullableCollaboratorSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      email: z.string().optional(),
      name: z.string().optional(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      permissions: z
        .object({
          pull: z.boolean(),
          triage: z.boolean().optional(),
          push: z.boolean(),
          maintain: z.boolean().optional(),
          admin: z.boolean()
        })
        .optional(),
      role_name: z.string(),
      user_view_type: z.string().optional()
    })
    .describe('Collaborator')
  export type NullableCollaborator = z.infer<typeof NullableCollaboratorSchema>

  export const BranchShortSchema = z
    .object({
      name: z.string(),
      commit: z.object({ sha: z.string(), url: z.string() }),
      protected: z.boolean()
    })
    .describe('Branch Short')
  export type BranchShort = z.infer<typeof BranchShortSchema>

  export const CommitShaSchema = z.any().describe('The SHA of the commit.')
  export type CommitSha = z.infer<typeof CommitShaSchema>

  export const LinkSchema = z
    .object({ href: z.string() })
    .describe('Hypermedia Link')
  export type Link = z.infer<typeof LinkSchema>

  export const CommitRefSchema = z
    .any()
    .describe(
      'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
    )
  export type CommitRef = z.infer<typeof CommitRefSchema>

  export const SimpleCommitStatusSchema = z.object({
    description: z.string(),
    id: z.number().int(),
    node_id: z.string(),
    state: z.string(),
    context: z.string(),
    target_url: z.string().url(),
    required: z.boolean().optional(),
    avatar_url: z.string().url(),
    url: z.string().url(),
    created_at: z.string().datetime({ offset: true }),
    updated_at: z.string().datetime({ offset: true })
  })
  export type SimpleCommitStatus = z.infer<typeof SimpleCommitStatusSchema>

  export const NullableCodeOfConductSimpleSchema = z
    .object({
      url: z.string().url(),
      key: z.string(),
      name: z.string(),
      html_url: z.string().url()
    })
    .describe('Code of Conduct Simple')
  export type NullableCodeOfConductSimple = z.infer<
    typeof NullableCodeOfConductSimpleSchema
  >

  export const NullableCommunityHealthFileSchema = z.object({
    url: z.string().url(),
    html_url: z.string().url()
  })
  export type NullableCommunityHealthFile = z.infer<
    typeof NullableCommunityHealthFileSchema
  >

  export const ContentDirectorySchema = z
    .array(
      z.object({
        type: z.enum(['dir', 'file', 'submodule', 'symlink']),
        size: z.number().int(),
        name: z.string(),
        path: z.string(),
        content: z.string().optional(),
        sha: z.string(),
        url: z.string().url(),
        git_url: z.string().url(),
        html_url: z.string().url(),
        download_url: z.string().url(),
        _links: z.object({
          git: z.string().url(),
          html: z.string().url(),
          self: z.string().url()
        })
      })
    )
    .describe('A list of directory items')
  export type ContentDirectory = z.infer<typeof ContentDirectorySchema>

  export const ContentFileSchema = z
    .object({
      type: z.literal('file'),
      encoding: z.string(),
      size: z.number().int(),
      name: z.string(),
      path: z.string(),
      content: z.string(),
      sha: z.string(),
      url: z.string().url(),
      git_url: z.string().url(),
      html_url: z.string().url(),
      download_url: z.string().url(),
      _links: z.object({
        git: z.string().url(),
        html: z.string().url(),
        self: z.string().url()
      }),
      target: z.string().optional(),
      submodule_git_url: z.string().optional()
    })
    .describe('Content File')
  export type ContentFile = z.infer<typeof ContentFileSchema>

  export const ContentSymlinkSchema = z
    .object({
      type: z.literal('symlink'),
      target: z.string(),
      size: z.number().int(),
      name: z.string(),
      path: z.string(),
      sha: z.string(),
      url: z.string().url(),
      git_url: z.string().url(),
      html_url: z.string().url(),
      download_url: z.string().url(),
      _links: z.object({
        git: z.string().url(),
        html: z.string().url(),
        self: z.string().url()
      })
    })
    .describe('An object describing a symlink')
  export type ContentSymlink = z.infer<typeof ContentSymlinkSchema>

  export const ContentSubmoduleSchema = z
    .object({
      type: z.literal('submodule'),
      submodule_git_url: z.string().url(),
      size: z.number().int(),
      name: z.string(),
      path: z.string(),
      sha: z.string(),
      url: z.string().url(),
      git_url: z.string().url(),
      html_url: z.string().url(),
      download_url: z.string().url(),
      _links: z.object({
        git: z.string().url(),
        html: z.string().url(),
        self: z.string().url()
      })
    })
    .describe('An object describing a submodule')
  export type ContentSubmodule = z.infer<typeof ContentSubmoduleSchema>

  export const FileCommitSchema = z
    .object({
      content: z.object({
        name: z.string().optional(),
        path: z.string().optional(),
        sha: z.string().optional(),
        size: z.number().int().optional(),
        url: z.string().optional(),
        html_url: z.string().optional(),
        git_url: z.string().optional(),
        download_url: z.string().optional(),
        type: z.string().optional(),
        _links: z
          .object({
            self: z.string().optional(),
            git: z.string().optional(),
            html: z.string().optional()
          })
          .optional()
      }),
      commit: z.object({
        sha: z.string().optional(),
        node_id: z.string().optional(),
        url: z.string().optional(),
        html_url: z.string().optional(),
        author: z
          .object({
            date: z.string().optional(),
            name: z.string().optional(),
            email: z.string().optional()
          })
          .optional(),
        committer: z
          .object({
            date: z.string().optional(),
            name: z.string().optional(),
            email: z.string().optional()
          })
          .optional(),
        message: z.string().optional(),
        tree: z
          .object({ url: z.string().optional(), sha: z.string().optional() })
          .optional(),
        parents: z
          .array(
            z.object({
              url: z.string().optional(),
              html_url: z.string().optional(),
              sha: z.string().optional()
            })
          )
          .optional(),
        verification: z
          .object({
            verified: z.boolean().optional(),
            reason: z.string().optional(),
            signature: z.string().optional(),
            payload: z.string().optional(),
            verified_at: z.string().optional()
          })
          .optional()
      })
    })
    .describe('File Commit')
  export type FileCommit = z.infer<typeof FileCommitSchema>

  export const ContributorSchema = z
    .object({
      login: z.string().optional(),
      id: z.number().int().optional(),
      node_id: z.string().optional(),
      avatar_url: z.string().url().optional(),
      gravatar_id: z.string().optional(),
      url: z.string().url().optional(),
      html_url: z.string().url().optional(),
      followers_url: z.string().url().optional(),
      following_url: z.string().optional(),
      gists_url: z.string().optional(),
      starred_url: z.string().optional(),
      subscriptions_url: z.string().url().optional(),
      organizations_url: z.string().url().optional(),
      repos_url: z.string().url().optional(),
      events_url: z.string().optional(),
      received_events_url: z.string().url().optional(),
      type: z.string(),
      site_admin: z.boolean().optional(),
      contributions: z.number().int(),
      email: z.string().optional(),
      name: z.string().optional(),
      user_view_type: z.string().optional()
    })
    .describe('Contributor')
  export type Contributor = z.infer<typeof ContributorSchema>

  export const DependabotAlertCommaSeparatedManifestsSchema = z
    .any()
    .describe(
      'A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.'
    )
  export type DependabotAlertCommaSeparatedManifests = z.infer<
    typeof DependabotAlertCommaSeparatedManifestsSchema
  >

  export const DependabotSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Set secrets for Dependabot.')
  export type DependabotSecret = z.infer<typeof DependabotSecretSchema>

  export const DependencyGraphDiffSchema = z
    .array(
      z.object({
        change_type: z.enum(['added', 'removed']),
        manifest: z.string(),
        ecosystem: z.string(),
        name: z.string(),
        version: z.string(),
        package_url: z.string(),
        license: z.string(),
        source_repository_url: z.string(),
        vulnerabilities: z.array(
          z.object({
            severity: z.string(),
            advisory_ghsa_id: z.string(),
            advisory_summary: z.string(),
            advisory_url: z.string()
          })
        ),
        scope: z
          .enum(['unknown', 'runtime', 'development'])
          .describe(
            'Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.'
          )
      })
    )
    .describe('A diff of the dependencies between two commits.')
  export type DependencyGraphDiff = z.infer<typeof DependencyGraphDiffSchema>

  export const ManifestPathSchema = z
    .any()
    .describe(
      'The full path, relative to the repository root, of the dependency manifest file.'
    )
  export type ManifestPath = z.infer<typeof ManifestPathSchema>

  export const DependencyGraphSpdxSbomSchema = z
    .object({
      sbom: z.object({
        SPDXID: z
          .string()
          .describe('The SPDX identifier for the SPDX document.'),
        spdxVersion: z
          .string()
          .describe(
            'The version of the SPDX specification that this document conforms to.'
          ),
        comment: z
          .string()
          .describe('An optional comment about the SPDX document.')
          .optional(),
        creationInfo: z.object({
          created: z
            .string()
            .describe('The date and time the SPDX document was created.'),
          creators: z
            .array(z.string())
            .describe('The tools that were used to generate the SPDX document.')
        }),
        name: z.string().describe('The name of the SPDX document.'),
        dataLicense: z
          .string()
          .describe('The license under which the SPDX document is licensed.'),
        documentNamespace: z
          .string()
          .describe('The namespace for the SPDX document.'),
        packages: z.array(
          z.object({
            SPDXID: z
              .string()
              .describe('A unique SPDX identifier for the package.')
              .optional(),
            name: z.string().describe('The name of the package.').optional(),
            versionInfo: z
              .string()
              .describe(
                'The version of the package. If the package does not have an exact version specified,\na version range is given.'
              )
              .optional(),
            downloadLocation: z
              .string()
              .describe(
                'The location where the package can be downloaded,\nor NOASSERTION if this has not been determined.'
              )
              .optional(),
            filesAnalyzed: z
              .boolean()
              .describe(
                "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document."
              )
              .optional(),
            licenseConcluded: z
              .string()
              .describe(
                'The license of the package as determined while creating the SPDX document.'
              )
              .optional(),
            licenseDeclared: z
              .string()
              .describe(
                'The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created.'
              )
              .optional(),
            supplier: z
              .string()
              .describe(
                'The distribution source of this package, or NOASSERTION if this was not determined.'
              )
              .optional(),
            copyrightText: z
              .string()
              .describe(
                'The copyright holders of the package, and any dates present with those notices, if available.'
              )
              .optional(),
            externalRefs: z
              .array(
                z.object({
                  referenceCategory: z
                    .string()
                    .describe(
                      'The category of reference to an external resource this reference refers to.'
                    ),
                  referenceLocator: z
                    .string()
                    .describe(
                      'A locator for the particular external resource this reference refers to.'
                    ),
                  referenceType: z
                    .string()
                    .describe(
                      'The category of reference to an external resource this reference refers to.'
                    )
                })
              )
              .optional()
          })
        ),
        relationships: z
          .array(
            z.object({
              relationshipType: z
                .string()
                .describe(
                  'The type of relationship between the two SPDX elements.'
                )
                .optional(),
              spdxElementId: z
                .string()
                .describe(
                  'The SPDX identifier of the package that is the source of the relationship.'
                )
                .optional(),
              relatedSpdxElement: z
                .string()
                .describe(
                  'The SPDX identifier of the package that is the target of the relationship.'
                )
                .optional()
            })
          )
          .optional()
      })
    })
    .describe(
      'A schema for the SPDX JSON format returned by the Dependency Graph.'
    )
  export type DependencyGraphSpdxSbom = z.infer<
    typeof DependencyGraphSpdxSbomSchema
  >

  export const MetadataSchema = z
    .record(z.union([z.string(), z.number(), z.boolean()]))
    .describe(
      'User-defined metadata to store domain-specific information limited to 8 keys with scalar values.'
    )
  export type Metadata = z.infer<typeof MetadataSchema>

  export const DeploymentIdSchema = z.any().describe('deployment_id parameter')
  export type DeploymentId = z.infer<typeof DeploymentIdSchema>

  export const WaitTimerSchema = z
    .number()
    .int()
    .describe(
      'The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).'
    )
  export type WaitTimer = z.infer<typeof WaitTimerSchema>

  export const DeploymentBranchPolicySettingsSchema = z
    .object({
      protected_branches: z
        .boolean()
        .describe(
          'Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.'
        ),
      custom_branch_policies: z
        .boolean()
        .describe(
          'Whether only branches that match the specified name patterns can deploy to this environment.  If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.'
        )
    })
    .describe(
      'The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.'
    )
  export type DeploymentBranchPolicySettings = z.infer<
    typeof DeploymentBranchPolicySettingsSchema
  >

  export const EnvironmentNameSchema = z
    .any()
    .describe(
      'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
    )
  export type EnvironmentName = z.infer<typeof EnvironmentNameSchema>

  export const PreventSelfReviewSchema = z
    .boolean()
    .describe(
      'Whether or not a user who created the job is prevented from approving their own job.'
    )
  export type PreventSelfReview = z.infer<typeof PreventSelfReviewSchema>

  export const DeploymentBranchPolicySchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('The unique identifier of the branch or tag policy.')
        .optional(),
      node_id: z.string().optional(),
      name: z
        .string()
        .describe(
          'The name pattern that branches or tags must match in order to deploy to the environment.'
        )
        .optional(),
      type: z
        .enum(['branch', 'tag'])
        .describe('Whether this rule targets a branch or tag.')
        .optional()
    })
    .describe('Details of a deployment branch or tag policy.')
  export type DeploymentBranchPolicy = z.infer<
    typeof DeploymentBranchPolicySchema
  >

  export const DeploymentBranchPolicyNamePatternWithTypeSchema = z.object({
    name: z
      .string()
      .describe(
        'The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).'
      ),
    type: z
      .enum(['branch', 'tag'])
      .describe('Whether this rule targets a branch or tag')
      .optional()
  })
  export type DeploymentBranchPolicyNamePatternWithType = z.infer<
    typeof DeploymentBranchPolicyNamePatternWithTypeSchema
  >

  export const BranchPolicyIdSchema = z
    .any()
    .describe('The unique identifier of the branch policy.')
  export type BranchPolicyId = z.infer<typeof BranchPolicyIdSchema>

  export const DeploymentBranchPolicyNamePatternSchema = z.object({
    name: z
      .string()
      .describe(
        'The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).'
      )
  })
  export type DeploymentBranchPolicyNamePattern = z.infer<
    typeof DeploymentBranchPolicyNamePatternSchema
  >

  export const CustomDeploymentRuleAppSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe(
          'The unique identifier of the deployment protection rule integration.'
        ),
      slug: z
        .string()
        .describe(
          'The slugified name of the deployment protection rule integration.'
        ),
      integration_url: z
        .string()
        .describe('The URL for the endpoint to get details about the app.'),
      node_id: z
        .string()
        .describe('The node ID for the deployment protection rule integration.')
    })
    .describe(
      'A GitHub App that is providing a custom deployment protection rule.'
    )
  export type CustomDeploymentRuleApp = z.infer<
    typeof CustomDeploymentRuleAppSchema
  >

  export const DeploymentProtectionRulesSchema = z.any()
  export type DeploymentProtectionRules = z.infer<
    typeof DeploymentProtectionRulesSchema
  >

  export const ProtectionRuleIdSchema = z
    .any()
    .describe('The unique identifier of the protection rule.')
  export type ProtectionRuleId = z.infer<typeof ProtectionRuleIdSchema>

  export const ShortBlobSchema = z
    .object({ url: z.string(), sha: z.string() })
    .describe('Short Blob')
  export type ShortBlob = z.infer<typeof ShortBlobSchema>

  export const BlobSchema = z
    .object({
      content: z.string(),
      encoding: z.string(),
      url: z.string().url(),
      sha: z.string(),
      size: z.number().int(),
      node_id: z.string(),
      highlighted_content: z.string().optional()
    })
    .describe('Blob')
  export type Blob = z.infer<typeof BlobSchema>

  export const GitCommitSchema = z
    .object({
      sha: z.string().describe('SHA for the commit'),
      node_id: z.string(),
      url: z.string().url(),
      author: z
        .object({
          date: z
            .string()
            .datetime({ offset: true })
            .describe('Timestamp of the commit'),
          email: z.string().describe('Git email address of the user'),
          name: z.string().describe('Name of the git user')
        })
        .describe('Identifying information for the git-user'),
      committer: z
        .object({
          date: z
            .string()
            .datetime({ offset: true })
            .describe('Timestamp of the commit'),
          email: z.string().describe('Git email address of the user'),
          name: z.string().describe('Name of the git user')
        })
        .describe('Identifying information for the git-user'),
      message: z
        .string()
        .describe('Message describing the purpose of the commit'),
      tree: z.object({
        sha: z.string().describe('SHA for the commit'),
        url: z.string().url()
      }),
      parents: z.array(
        z.object({
          sha: z.string().describe('SHA for the commit'),
          url: z.string().url(),
          html_url: z.string().url()
        })
      ),
      verification: z.object({
        verified: z.boolean(),
        reason: z.string(),
        signature: z.string(),
        payload: z.string(),
        verified_at: z.string()
      }),
      html_url: z.string().url()
    })
    .describe('Low-level Git commit operations within a repository')
  export type GitCommit = z.infer<typeof GitCommitSchema>

  export const GitRefSchema = z
    .any()
    .describe(
      'The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
    )
  export type GitRef = z.infer<typeof GitRefSchema>

  export const GitRefOnlySchema = z
    .any()
    .describe(
      'The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
    )
  export type GitRefOnly = z.infer<typeof GitRefOnlySchema>

  export const GitTreeSchema = z
    .object({
      sha: z.string(),
      url: z.string().url(),
      truncated: z.boolean(),
      tree: z
        .array(
          z.object({
            path: z.string().optional(),
            mode: z.string().optional(),
            type: z.string().optional(),
            sha: z.string().optional(),
            size: z.number().int().optional(),
            url: z.string().optional()
          })
        )
        .describe('Objects specifying a tree structure')
    })
    .describe('The hierarchy between files in a Git repository.')
  export type GitTree = z.infer<typeof GitTreeSchema>

  export const HookResponseSchema = z.object({
    code: z.number().int(),
    status: z.string(),
    message: z.string()
  })
  export type HookResponse = z.infer<typeof HookResponseSchema>

  export const ImportSchema = z
    .object({
      vcs: z.string(),
      use_lfs: z.boolean().optional(),
      vcs_url: z.string().describe('The URL of the originating repository.'),
      svc_root: z.string().optional(),
      tfvc_project: z.string().optional(),
      status: z.enum([
        'auth',
        'error',
        'none',
        'detecting',
        'choose',
        'auth_failed',
        'importing',
        'mapping',
        'waiting_to_push',
        'pushing',
        'complete',
        'setup',
        'unknown',
        'detection_found_multiple',
        'detection_found_nothing',
        'detection_needs_auth'
      ]),
      status_text: z.string().optional(),
      failed_step: z.string().optional(),
      error_message: z.string().optional(),
      import_percent: z.number().int().optional(),
      commit_count: z.number().int().optional(),
      push_percent: z.number().int().optional(),
      has_large_files: z.boolean().optional(),
      large_files_size: z.number().int().optional(),
      large_files_count: z.number().int().optional(),
      project_choices: z
        .array(
          z.object({
            vcs: z.string().optional(),
            tfvc_project: z.string().optional(),
            human_name: z.string().optional()
          })
        )
        .optional(),
      message: z.string().optional(),
      authors_count: z.number().int().optional(),
      url: z.string().url(),
      html_url: z.string().url(),
      authors_url: z.string().url(),
      repository_url: z.string().url(),
      svn_root: z.string().optional()
    })
    .describe('A repository import from an external source.')
  export type Import = z.infer<typeof ImportSchema>

  export const PorterAuthorSchema = z
    .object({
      id: z.number().int(),
      remote_id: z.string(),
      remote_name: z.string(),
      email: z.string(),
      name: z.string(),
      url: z.string().url(),
      import_url: z.string().url()
    })
    .describe('Porter Author')
  export type PorterAuthor = z.infer<typeof PorterAuthorSchema>

  export const SinceUserSchema = z
    .any()
    .describe('A user ID. Only return users with an ID greater than this ID.')
  export type SinceUser = z.infer<typeof SinceUserSchema>

  export const PorterLargeFileSchema = z
    .object({
      ref_name: z.string(),
      path: z.string(),
      oid: z.string(),
      size: z.number().int()
    })
    .describe('Porter Large File')
  export type PorterLargeFile = z.infer<typeof PorterLargeFileSchema>

  export const IssueEventLabelSchema = z
    .object({ name: z.string(), color: z.string() })
    .describe('Issue Event Label')
  export type IssueEventLabel = z.infer<typeof IssueEventLabelSchema>

  export const IssueEventDismissedReviewSchema = z.object({
    state: z.string(),
    review_id: z.number().int(),
    dismissal_message: z.string(),
    dismissal_commit_id: z.string().optional()
  })
  export type IssueEventDismissedReview = z.infer<
    typeof IssueEventDismissedReviewSchema
  >

  export const IssueEventMilestoneSchema = z
    .object({ title: z.string() })
    .describe('Issue Event Milestone')
  export type IssueEventMilestone = z.infer<typeof IssueEventMilestoneSchema>

  export const IssueEventProjectCardSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int(),
      project_url: z.string().url(),
      project_id: z.number().int(),
      column_name: z.string(),
      previous_column_name: z.string().optional()
    })
    .describe('Issue Event Project Card')
  export type IssueEventProjectCard = z.infer<
    typeof IssueEventProjectCardSchema
  >

  export const IssueEventRenameSchema = z
    .object({ from: z.string(), to: z.string() })
    .describe('Issue Event Rename')
  export type IssueEventRename = z.infer<typeof IssueEventRenameSchema>

  export const IssueNumberSchema = z
    .any()
    .describe('The number that identifies the issue.')
  export type IssueNumber = z.infer<typeof IssueNumberSchema>

  export const LabelSchema = z
    .object({
      id: z.number().int().describe('Unique identifier for the label.'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the label'),
      name: z.string().describe('The name of the label.'),
      description: z
        .string()
        .describe('Optional description of the label, such as its purpose.'),
      color: z
        .string()
        .describe(
          '6-character hex code, without the leading #, identifying the color'
        ),
      default: z
        .boolean()
        .describe('Whether this label comes by default in a new repository.')
    })
    .describe(
      'Color-coded labels help you categorize and filter your issues (just like labels in Gmail).'
    )
  export type Label = z.infer<typeof LabelSchema>

  export const TimelineCommittedEventSchema = z
    .object({
      event: z.string().optional(),
      sha: z.string().describe('SHA for the commit'),
      node_id: z.string(),
      url: z.string().url(),
      author: z
        .object({
          date: z
            .string()
            .datetime({ offset: true })
            .describe('Timestamp of the commit'),
          email: z.string().describe('Git email address of the user'),
          name: z.string().describe('Name of the git user')
        })
        .describe('Identifying information for the git-user'),
      committer: z
        .object({
          date: z
            .string()
            .datetime({ offset: true })
            .describe('Timestamp of the commit'),
          email: z.string().describe('Git email address of the user'),
          name: z.string().describe('Name of the git user')
        })
        .describe('Identifying information for the git-user'),
      message: z
        .string()
        .describe('Message describing the purpose of the commit'),
      tree: z.object({
        sha: z.string().describe('SHA for the commit'),
        url: z.string().url()
      }),
      parents: z.array(
        z.object({
          sha: z.string().describe('SHA for the commit'),
          url: z.string().url(),
          html_url: z.string().url()
        })
      ),
      verification: z.object({
        verified: z.boolean(),
        reason: z.string(),
        signature: z.string(),
        payload: z.string(),
        verified_at: z.string()
      }),
      html_url: z.string().url()
    })
    .describe('Timeline Committed Event')
  export type TimelineCommittedEvent = z.infer<
    typeof TimelineCommittedEventSchema
  >

  export const DeployKeySchema = z
    .object({
      id: z.number().int(),
      key: z.string(),
      url: z.string(),
      title: z.string(),
      verified: z.boolean(),
      created_at: z.string(),
      read_only: z.boolean(),
      added_by: z.string().optional(),
      last_used: z.string().optional(),
      enabled: z.boolean().optional()
    })
    .describe('An SSH key granting access to a single repository.')
  export type DeployKey = z.infer<typeof DeployKeySchema>

  export const KeyIdSchema = z
    .any()
    .describe('The unique identifier of the key.')
  export type KeyId = z.infer<typeof KeyIdSchema>

  export const LanguageSchema = z.record(z.number().int()).describe('Language')
  export type Language = z.infer<typeof LanguageSchema>

  export const MergedUpstreamSchema = z
    .object({
      message: z.string().optional(),
      merge_type: z.enum(['merge', 'fast-forward', 'none']).optional(),
      base_branch: z.string().optional()
    })
    .describe('Results of a successful merge upstream request')
  export type MergedUpstream = z.infer<typeof MergedUpstreamSchema>

  export const MilestoneNumberSchema = z
    .any()
    .describe('The number that identifies the milestone.')
  export type MilestoneNumber = z.infer<typeof MilestoneNumberSchema>

  export const PagesSourceHashSchema = z.object({
    branch: z.string(),
    path: z.string()
  })
  export type PagesSourceHash = z.infer<typeof PagesSourceHashSchema>

  export const PagesHttpsCertificateSchema = z.object({
    state: z.enum([
      'new',
      'authorization_created',
      'authorization_pending',
      'authorized',
      'authorization_revoked',
      'issued',
      'uploaded',
      'approved',
      'errored',
      'bad_authz',
      'destroy_pending',
      'dns_changed'
    ]),
    description: z.string(),
    domains: z
      .array(z.string())
      .describe(
        'Array of the domain set and its alternate name (if it is configured)'
      ),
    expires_at: z.string().date().optional()
  })
  export type PagesHttpsCertificate = z.infer<
    typeof PagesHttpsCertificateSchema
  >

  export const PageBuildStatusSchema = z
    .object({ url: z.string().url(), status: z.string() })
    .describe('Page Build Status')
  export type PageBuildStatus = z.infer<typeof PageBuildStatusSchema>

  export const PageDeploymentSchema = z
    .object({
      id: z
        .union([z.number().int(), z.string()])
        .describe(
          'The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit.'
        ),
      status_url: z
        .string()
        .url()
        .describe('The URI to monitor GitHub Pages deployment status.'),
      page_url: z
        .string()
        .url()
        .describe('The URI to the deployed GitHub Pages.'),
      preview_url: z
        .string()
        .url()
        .describe('The URI to the deployed GitHub Pages preview.')
        .optional()
    })
    .describe('The GitHub Pages deployment status.')
  export type PageDeployment = z.infer<typeof PageDeploymentSchema>

  export const PagesDeploymentStatusSchema = z.object({
    status: z
      .enum([
        'deployment_in_progress',
        'syncing_files',
        'finished_file_sync',
        'updating_pages',
        'purging_cdn',
        'deployment_cancelled',
        'deployment_failed',
        'deployment_content_failed',
        'deployment_attempt_error',
        'deployment_lost',
        'succeed'
      ])
      .describe('The current status of the deployment.')
      .optional()
  })
  export type PagesDeploymentStatus = z.infer<
    typeof PagesDeploymentStatusSchema
  >

  export const PagesDeploymentIdSchema = z
    .any()
    .describe(
      'The ID of the Pages deployment. You can also give the commit SHA of the deployment.'
    )
  export type PagesDeploymentId = z.infer<typeof PagesDeploymentIdSchema>

  export const PagesHealthCheckSchema = z
    .object({
      domain: z
        .object({
          host: z.string().optional(),
          uri: z.string().optional(),
          nameservers: z.string().optional(),
          dns_resolves: z.boolean().optional(),
          is_proxied: z.boolean().optional(),
          is_cloudflare_ip: z.boolean().optional(),
          is_fastly_ip: z.boolean().optional(),
          is_old_ip_address: z.boolean().optional(),
          is_a_record: z.boolean().optional(),
          has_cname_record: z.boolean().optional(),
          has_mx_records_present: z.boolean().optional(),
          is_valid_domain: z.boolean().optional(),
          is_apex_domain: z.boolean().optional(),
          should_be_a_record: z.boolean().optional(),
          is_cname_to_github_user_domain: z.boolean().optional(),
          is_cname_to_pages_dot_github_dot_com: z.boolean().optional(),
          is_cname_to_fastly: z.boolean().optional(),
          is_pointed_to_github_pages_ip: z.boolean().optional(),
          is_non_github_pages_ip_present: z.boolean().optional(),
          is_pages_domain: z.boolean().optional(),
          is_served_by_pages: z.boolean().optional(),
          is_valid: z.boolean().optional(),
          reason: z.string().optional(),
          responds_to_https: z.boolean().optional(),
          enforces_https: z.boolean().optional(),
          https_error: z.string().optional(),
          is_https_eligible: z.boolean().optional(),
          caa_error: z.string().optional()
        })
        .optional(),
      alt_domain: z
        .object({
          host: z.string().optional(),
          uri: z.string().optional(),
          nameservers: z.string().optional(),
          dns_resolves: z.boolean().optional(),
          is_proxied: z.boolean().optional(),
          is_cloudflare_ip: z.boolean().optional(),
          is_fastly_ip: z.boolean().optional(),
          is_old_ip_address: z.boolean().optional(),
          is_a_record: z.boolean().optional(),
          has_cname_record: z.boolean().optional(),
          has_mx_records_present: z.boolean().optional(),
          is_valid_domain: z.boolean().optional(),
          is_apex_domain: z.boolean().optional(),
          should_be_a_record: z.boolean().optional(),
          is_cname_to_github_user_domain: z.boolean().optional(),
          is_cname_to_pages_dot_github_dot_com: z.boolean().optional(),
          is_cname_to_fastly: z.boolean().optional(),
          is_pointed_to_github_pages_ip: z.boolean().optional(),
          is_non_github_pages_ip_present: z.boolean().optional(),
          is_pages_domain: z.boolean().optional(),
          is_served_by_pages: z.boolean().optional(),
          is_valid: z.boolean().optional(),
          reason: z.string().optional(),
          responds_to_https: z.boolean().optional(),
          enforces_https: z.boolean().optional(),
          https_error: z.string().optional(),
          is_https_eligible: z.boolean().optional(),
          caa_error: z.string().optional()
        })
        .optional()
    })
    .describe('Pages Health Check Status')
  export type PagesHealthCheck = z.infer<typeof PagesHealthCheckSchema>

  export const PullNumberSchema = z
    .any()
    .describe('The number that identifies the pull request.')
  export type PullNumber = z.infer<typeof PullNumberSchema>

  export const PullRequestMergeResultSchema = z
    .object({ sha: z.string(), merged: z.boolean(), message: z.string() })
    .describe('Pull Request Merge Result')
  export type PullRequestMergeResult = z.infer<
    typeof PullRequestMergeResultSchema
  >

  export const ReviewIdSchema = z
    .any()
    .describe('The unique identifier of the review.')
  export type ReviewId = z.infer<typeof ReviewIdSchema>

  export const AssetIdSchema = z
    .any()
    .describe('The unique identifier of the asset.')
  export type AssetId = z.infer<typeof AssetIdSchema>

  export const ReleaseNotesContentSchema = z
    .object({
      name: z.string().describe('The generated name of the release'),
      body: z
        .string()
        .describe(
          'The generated body describing the contents of the release supporting markdown formatting'
        )
    })
    .describe('Generated name and body describing a release')
  export type ReleaseNotesContent = z.infer<typeof ReleaseNotesContentSchema>

  export const ReleaseIdSchema = z
    .any()
    .describe('The unique identifier of the release.')
  export type ReleaseId = z.infer<typeof ReleaseIdSchema>

  export const RepositoryRuleRulesetInfoSchema = z
    .any()
    .describe(
      'User-defined metadata to store domain-specific information limited to 8 keys with scalar values.'
    )
  export type RepositoryRuleRulesetInfo = z.infer<
    typeof RepositoryRuleRulesetInfoSchema
  >

  export const SecretScanningAlertResolutionCommentSchema = z
    .string()
    .describe(
      'An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.'
    )
  export type SecretScanningAlertResolutionComment = z.infer<
    typeof SecretScanningAlertResolutionCommentSchema
  >

  export const SecretScanningLocationCommitSchema = z
    .object({
      path: z.string().describe('The file path in the repository'),
      start_line: z
        .number()
        .describe('Line number at which the secret starts in the file'),
      end_line: z
        .number()
        .describe('Line number at which the secret ends in the file'),
      start_column: z
        .number()
        .describe(
          'The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII'
        ),
      end_column: z
        .number()
        .describe(
          'The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII'
        ),
      blob_sha: z.string().describe('SHA-1 hash ID of the associated blob'),
      blob_url: z
        .string()
        .describe('The API URL to get the associated blob resource'),
      commit_sha: z.string().describe('SHA-1 hash ID of the associated commit'),
      commit_url: z
        .string()
        .describe('The API URL to get the associated commit resource')
    })
    .describe(
      "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository."
    )
  export type SecretScanningLocationCommit = z.infer<
    typeof SecretScanningLocationCommitSchema
  >

  export const SecretScanningLocationWikiCommitSchema = z
    .object({
      path: z.string().describe('The file path of the wiki page'),
      start_line: z
        .number()
        .describe('Line number at which the secret starts in the file'),
      end_line: z
        .number()
        .describe('Line number at which the secret ends in the file'),
      start_column: z
        .number()
        .describe(
          'The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII.'
        ),
      end_column: z
        .number()
        .describe(
          'The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII.'
        ),
      blob_sha: z.string().describe('SHA-1 hash ID of the associated blob'),
      page_url: z
        .string()
        .describe('The GitHub URL to get the associated wiki page'),
      commit_sha: z.string().describe('SHA-1 hash ID of the associated commit'),
      commit_url: z
        .string()
        .describe('The GitHub URL to get the associated wiki commit')
    })
    .describe(
      "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki."
    )
  export type SecretScanningLocationWikiCommit = z.infer<
    typeof SecretScanningLocationWikiCommitSchema
  >

  export const SecretScanningLocationIssueTitleSchema = z
    .object({
      issue_title_url: z
        .string()
        .url()
        .describe('The API URL to get the issue where the secret was detected.')
    })
    .describe(
      "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue."
    )
  export type SecretScanningLocationIssueTitle = z.infer<
    typeof SecretScanningLocationIssueTitleSchema
  >

  export const SecretScanningLocationIssueBodySchema = z
    .object({
      issue_body_url: z
        .string()
        .url()
        .describe('The API URL to get the issue where the secret was detected.')
    })
    .describe(
      "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue."
    )
  export type SecretScanningLocationIssueBody = z.infer<
    typeof SecretScanningLocationIssueBodySchema
  >

  export const SecretScanningLocationIssueCommentSchema = z
    .object({
      issue_comment_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the issue comment where the secret was detected.'
        )
    })
    .describe(
      "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue."
    )
  export type SecretScanningLocationIssueComment = z.infer<
    typeof SecretScanningLocationIssueCommentSchema
  >

  export const SecretScanningLocationDiscussionTitleSchema = z
    .object({
      discussion_title_url: z
        .string()
        .url()
        .describe('The URL to the discussion where the secret was detected.')
    })
    .describe(
      "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion."
    )
  export type SecretScanningLocationDiscussionTitle = z.infer<
    typeof SecretScanningLocationDiscussionTitleSchema
  >

  export const SecretScanningLocationDiscussionBodySchema = z
    .object({
      discussion_body_url: z
        .string()
        .url()
        .describe('The URL to the discussion where the secret was detected.')
    })
    .describe(
      "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion."
    )
  export type SecretScanningLocationDiscussionBody = z.infer<
    typeof SecretScanningLocationDiscussionBodySchema
  >

  export const SecretScanningLocationDiscussionCommentSchema = z
    .object({
      discussion_comment_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the discussion comment where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion."
    )
  export type SecretScanningLocationDiscussionComment = z.infer<
    typeof SecretScanningLocationDiscussionCommentSchema
  >

  export const SecretScanningLocationPullRequestTitleSchema = z
    .object({
      pull_request_title_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the pull request where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request."
    )
  export type SecretScanningLocationPullRequestTitle = z.infer<
    typeof SecretScanningLocationPullRequestTitleSchema
  >

  export const SecretScanningLocationPullRequestBodySchema = z
    .object({
      pull_request_body_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the pull request where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request."
    )
  export type SecretScanningLocationPullRequestBody = z.infer<
    typeof SecretScanningLocationPullRequestBodySchema
  >

  export const SecretScanningLocationPullRequestCommentSchema = z
    .object({
      pull_request_comment_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the pull request comment where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request."
    )
  export type SecretScanningLocationPullRequestComment = z.infer<
    typeof SecretScanningLocationPullRequestCommentSchema
  >

  export const SecretScanningLocationPullRequestReviewSchema = z
    .object({
      pull_request_review_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the pull request review where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request."
    )
  export type SecretScanningLocationPullRequestReview = z.infer<
    typeof SecretScanningLocationPullRequestReviewSchema
  >

  export const SecretScanningLocationPullRequestReviewCommentSchema = z
    .object({
      pull_request_review_comment_url: z
        .string()
        .url()
        .describe(
          'The API URL to get the pull request review comment where the secret was detected.'
        )
    })
    .describe(
      "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request."
    )
  export type SecretScanningLocationPullRequestReviewComment = z.infer<
    typeof SecretScanningLocationPullRequestReviewCommentSchema
  >

  export const SecretScanningPushProtectionBypassReasonSchema = z
    .enum(['false_positive', 'used_in_tests', 'will_fix_later'])
    .describe('The reason for bypassing push protection.')
  export type SecretScanningPushProtectionBypassReason = z.infer<
    typeof SecretScanningPushProtectionBypassReasonSchema
  >

  export const SecretScanningPushProtectionBypassPlaceholderIdSchema = z
    .string()
    .describe(
      'The ID of the push protection bypass placeholder. This value is returned on any push protected routes.'
    )
  export type SecretScanningPushProtectionBypassPlaceholderId = z.infer<
    typeof SecretScanningPushProtectionBypassPlaceholderIdSchema
  >

  export const SecretScanningScanSchema = z
    .object({
      type: z.string().describe('The type of scan').optional(),
      status: z
        .string()
        .describe(
          'The state of the scan. Either "completed", "running", or "pending"'
        )
        .optional(),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the scan was completed. Empty if the scan is running'
        )
        .optional(),
      started_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the scan was started. Empty if the scan is pending'
        )
        .optional()
    })
    .describe(
      'Information on a single scan performed by secret scanning on the repository'
    )
  export type SecretScanningScan = z.infer<typeof SecretScanningScanSchema>

  export const CodeFrequencyStatSchema = z
    .array(z.number().int())
    .describe('Code Frequency Stat')
  export type CodeFrequencyStat = z.infer<typeof CodeFrequencyStatSchema>

  export const CommitActivitySchema = z
    .object({
      days: z.array(z.number().int()),
      total: z.number().int(),
      week: z.number().int()
    })
    .describe('Commit Activity')
  export type CommitActivity = z.infer<typeof CommitActivitySchema>

  export const ParticipationStatsSchema = z.object({
    all: z.array(z.number().int()),
    owner: z.array(z.number().int())
  })
  export type ParticipationStats = z.infer<typeof ParticipationStatsSchema>

  export const RepositorySubscriptionSchema = z
    .object({
      subscribed: z
        .boolean()
        .describe(
          'Determines if notifications should be received from this repository.'
        ),
      ignored: z
        .boolean()
        .describe(
          'Determines if all notifications should be blocked from this repository.'
        ),
      reason: z.string(),
      created_at: z.string().datetime({ offset: true }),
      url: z.string().url(),
      repository_url: z.string().url()
    })
    .describe('Repository invitations let you manage who you collaborate with.')
  export type RepositorySubscription = z.infer<
    typeof RepositorySubscriptionSchema
  >

  export const TagSchema = z
    .object({
      name: z.string(),
      commit: z.object({ sha: z.string(), url: z.string().url() }),
      zipball_url: z.string().url(),
      tarball_url: z.string().url(),
      node_id: z.string()
    })
    .describe('Tag')
  export type Tag = z.infer<typeof TagSchema>

  export const TagProtectionSchema = z
    .object({
      id: z.number().int().optional(),
      created_at: z.string().optional(),
      updated_at: z.string().optional(),
      enabled: z.boolean().optional(),
      pattern: z.string()
    })
    .describe('Tag protection')
  export type TagProtection = z.infer<typeof TagProtectionSchema>

  export const TagProtectionIdSchema = z
    .any()
    .describe('The unique identifier of the tag protection.')
  export type TagProtectionId = z.infer<typeof TagProtectionIdSchema>

  export const TopicSchema = z
    .object({ names: z.array(z.string()) })
    .describe('A topic aggregates entities that are related to a subject.')
  export type Topic = z.infer<typeof TopicSchema>

  export const TrafficSchema = z.object({
    timestamp: z.string().datetime({ offset: true }),
    uniques: z.number().int(),
    count: z.number().int()
  })
  export type Traffic = z.infer<typeof TrafficSchema>

  export const PerSchema = z
    .any()
    .describe('The time frame to display results for.')
  export type Per = z.infer<typeof PerSchema>

  export const ContentTrafficSchema = z
    .object({
      path: z.string(),
      title: z.string(),
      count: z.number().int(),
      uniques: z.number().int()
    })
    .describe('Content Traffic')
  export type ContentTraffic = z.infer<typeof ContentTrafficSchema>

  export const ReferrerTrafficSchema = z
    .object({
      referrer: z.string(),
      count: z.number().int(),
      uniques: z.number().int()
    })
    .describe('Referrer Traffic')
  export type ReferrerTraffic = z.infer<typeof ReferrerTrafficSchema>

  export const SinceRepoSchema = z
    .any()
    .describe(
      'A repository ID. Only return repositories with an ID greater than this ID.'
    )
  export type SinceRepo = z.infer<typeof SinceRepoSchema>

  export const SearchResultTextMatchesSchema = z.array(
    z.object({
      object_url: z.string().optional(),
      object_type: z.string().optional(),
      property: z.string().optional(),
      fragment: z.string().optional(),
      matches: z
        .array(
          z.object({
            text: z.string().optional(),
            indices: z.array(z.number().int()).optional()
          })
        )
        .optional()
    })
  )
  export type SearchResultTextMatches = z.infer<
    typeof SearchResultTextMatchesSchema
  >

  export const OrderSchema = z
    .any()
    .describe(
      'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
    )
  export type Order = z.infer<typeof OrderSchema>

  export const IssuesAdvancedSearchSchema = z
    .any()
    .describe(
      'Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`'
    )
  export type IssuesAdvancedSearch = z.infer<typeof IssuesAdvancedSearchSchema>

  export const TeamIdSchema = z
    .any()
    .describe('The unique identifier of the team.')
  export type TeamId = z.infer<typeof TeamIdSchema>

  export const PrivateUserSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      user_view_type: z.string().optional(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      name: z.string(),
      company: z.string(),
      blog: z.string(),
      location: z.string(),
      email: z.string().email(),
      notification_email: z.string().email().optional(),
      hireable: z.boolean(),
      bio: z.string(),
      twitter_username: z.string().optional(),
      public_repos: z.number().int(),
      public_gists: z.number().int(),
      followers: z.number().int(),
      following: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      private_gists: z.number().int(),
      total_private_repos: z.number().int(),
      owned_private_repos: z.number().int(),
      disk_usage: z.number().int(),
      collaborators: z.number().int(),
      two_factor_authentication: z.boolean(),
      plan: z
        .object({
          collaborators: z.number().int(),
          name: z.string(),
          space: z.number().int(),
          private_repos: z.number().int()
        })
        .optional(),
      business_plus: z.boolean().optional(),
      ldap_dn: z.string().optional()
    })
    .describe('Private User')
  export type PrivateUser = z.infer<typeof PrivateUserSchema>

  export const RepositoryIdInQuerySchema = z
    .any()
    .describe('ID of the Repository to filter on')
  export type RepositoryIdInQuery = z.infer<typeof RepositoryIdInQuerySchema>

  export const CodespacesSecretSchema = z
    .object({
      name: z.string().describe('The name of the secret'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'The type of repositories in the organization that the secret is visible to'
        ),
      selected_repositories_url: z
        .string()
        .url()
        .describe(
          'The API URL at which the list of repositories this secret is visible to can be retrieved'
        )
    })
    .describe('Secrets for a GitHub Codespace.')
  export type CodespacesSecret = z.infer<typeof CodespacesSecretSchema>

  export const CodespacesUserPublicKeySchema = z
    .object({
      key_id: z.string().describe('The identifier for the key.'),
      key: z.string().describe('The Base64 encoded public key.')
    })
    .describe("The public key used for setting user Codespaces' Secrets.")
  export type CodespacesUserPublicKey = z.infer<
    typeof CodespacesUserPublicKeySchema
  >

  export const CodespaceExportDetailsSchema = z
    .object({
      state: z.string().describe('State of the latest export').optional(),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe('Completion time of the last export operation')
        .optional(),
      branch: z.string().describe('Name of the exported branch').optional(),
      sha: z
        .string()
        .describe('Git commit SHA of the exported branch')
        .optional(),
      id: z.string().describe('Id for the export details').optional(),
      export_url: z
        .string()
        .describe('Url for fetching export details')
        .optional(),
      html_url: z
        .string()
        .describe('Web url for the exported branch')
        .optional()
    })
    .describe(
      'An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest'
    )
  export type CodespaceExportDetails = z.infer<
    typeof CodespaceExportDetailsSchema
  >

  export const ExportIdSchema = z
    .any()
    .describe(
      'The ID of the export operation, or `latest`. Currently only `latest` is currently supported.'
    )
  export type ExportId = z.infer<typeof ExportIdSchema>

  export const EmailSchema = z
    .object({
      email: z.string().email(),
      primary: z.boolean(),
      verified: z.boolean(),
      visibility: z.string()
    })
    .describe('Email')
  export type Email = z.infer<typeof EmailSchema>

  export const GpgKeySchema = z
    .object({
      id: z.number().int(),
      name: z.string().optional(),
      primary_key_id: z.number().int(),
      key_id: z.string(),
      public_key: z.string(),
      emails: z.array(
        z.object({
          email: z.string().optional(),
          verified: z.boolean().optional()
        })
      ),
      subkeys: z.array(
        z.object({
          id: z.number().int().optional(),
          primary_key_id: z.number().int().optional(),
          key_id: z.string().optional(),
          public_key: z.string().optional(),
          emails: z
            .array(
              z.object({
                email: z.string().optional(),
                verified: z.boolean().optional()
              })
            )
            .optional(),
          subkeys: z.array(z.any()).optional(),
          can_sign: z.boolean().optional(),
          can_encrypt_comms: z.boolean().optional(),
          can_encrypt_storage: z.boolean().optional(),
          can_certify: z.boolean().optional(),
          created_at: z.string().optional(),
          expires_at: z.string().optional(),
          raw_key: z.string().optional(),
          revoked: z.boolean().optional()
        })
      ),
      can_sign: z.boolean(),
      can_encrypt_comms: z.boolean(),
      can_encrypt_storage: z.boolean(),
      can_certify: z.boolean(),
      created_at: z.string().datetime({ offset: true }),
      expires_at: z.string().datetime({ offset: true }),
      revoked: z.boolean(),
      raw_key: z.string()
    })
    .describe('A unique encryption key')
  export type GpgKey = z.infer<typeof GpgKeySchema>

  export const GpgKeyIdSchema = z
    .any()
    .describe('The unique identifier of the GPG key.')
  export type GpgKeyId = z.infer<typeof GpgKeyIdSchema>

  export const KeySchema = z
    .object({
      key: z.string(),
      id: z.number().int(),
      url: z.string(),
      title: z.string(),
      created_at: z.string().datetime({ offset: true }),
      verified: z.boolean(),
      read_only: z.boolean()
    })
    .describe('Key')
  export type Key = z.infer<typeof KeySchema>

  export const MarketplaceAccountSchema = z.object({
    url: z.string().url(),
    id: z.number().int(),
    type: z.string(),
    node_id: z.string().optional(),
    login: z.string(),
    email: z.string().email().optional(),
    organization_billing_email: z.string().email().optional()
  })
  export type MarketplaceAccount = z.infer<typeof MarketplaceAccountSchema>

  export const SinceRepoDateSchema = z
    .any()
    .describe(
      'Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type SinceRepoDate = z.infer<typeof SinceRepoDateSchema>

  export const BeforeRepoDateSchema = z
    .any()
    .describe(
      'Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
    )
  export type BeforeRepoDate = z.infer<typeof BeforeRepoDateSchema>

  export const SocialAccountSchema = z
    .object({ provider: z.string(), url: z.string() })
    .describe('Social media account')
  export type SocialAccount = z.infer<typeof SocialAccountSchema>

  export const SshSigningKeySchema = z
    .object({
      key: z.string(),
      id: z.number().int(),
      title: z.string(),
      created_at: z.string().datetime({ offset: true })
    })
    .describe('A public SSH key used to sign Git commits')
  export type SshSigningKey = z.infer<typeof SshSigningKeySchema>

  export const SshSigningKeyIdSchema = z
    .any()
    .describe('The unique identifier of the SSH signing key.')
  export type SshSigningKeyId = z.infer<typeof SshSigningKeyIdSchema>

  export const SortStarredSchema = z
    .any()
    .describe(
      'The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.'
    )
  export type SortStarred = z.infer<typeof SortStarredSchema>

  export const HovercardSchema = z
    .object({
      contexts: z.array(z.object({ message: z.string(), octicon: z.string() }))
    })
    .describe('Hovercard')
  export type Hovercard = z.infer<typeof HovercardSchema>

  export const KeySimpleSchema = z
    .object({ id: z.number().int(), key: z.string() })
    .describe('Key Simple')
  export type KeySimple = z.infer<typeof KeySimpleSchema>

  export const VulnerabilitySchema = z
    .object({
      package: z
        .object({
          ecosystem: SecurityAdvisoryEcosystemsSchema,
          name: z
            .string()
            .describe('The unique package name within its ecosystem.')
        })
        .describe('The name of the package affected by the vulnerability.'),
      vulnerable_version_range: z
        .string()
        .describe(
          'The range of the package versions affected by the vulnerability.'
        ),
      first_patched_version: z
        .string()
        .describe('The package version that resolves the vulnerability.'),
      vulnerable_functions: z
        .array(z.string())
        .describe(
          'The functions in the package that are affected by the vulnerability.'
        )
        .readonly()
    })
    .describe(
      'A vulnerability describing the product and its affected versions within a GitHub Security Advisory.'
    )
  export type Vulnerability = z.infer<typeof VulnerabilitySchema>

  export const ClassroomSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the classroom.'),
      name: z.string().describe('The name of the classroom.'),
      archived: z.boolean().describe('Whether classroom is archived.'),
      organization: SimpleClassroomOrganizationSchema,
      url: z.string().describe('The URL of the classroom on GitHub Classroom.')
    })
    .describe('A GitHub Classroom classroom')
  export type Classroom = z.infer<typeof ClassroomSchema>

  export const SimpleClassroomAssignmentSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository.'),
      public_repo: z
        .boolean()
        .describe(
          'Whether an accepted assignment creates a public repository.'
        ),
      title: z.string().describe('Assignment title.'),
      type: z
        .enum(['individual', 'group'])
        .describe("Whether it's a Group Assignment or Individual Assignment."),
      invite_link: z
        .string()
        .describe('The link that a student can use to accept the assignment.'),
      invitations_enabled: z
        .boolean()
        .describe(
          'Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.'
        ),
      slug: z.string().describe('Sluggified name of the assignment.'),
      students_are_repo_admins: z
        .boolean()
        .describe(
          'Whether students are admins on created repository on accepted assignment.'
        ),
      feedback_pull_requests_enabled: z
        .boolean()
        .describe(
          'Whether feedback pull request will be created on assignment acceptance.'
        ),
      max_teams: z
        .number()
        .int()
        .describe('The maximum allowable teams for the assignment.')
        .optional(),
      max_members: z
        .number()
        .int()
        .describe('The maximum allowable members per team.')
        .optional(),
      editor: z.string().describe('The selected editor for the assignment.'),
      accepted: z
        .number()
        .int()
        .describe('The number of students that have accepted the assignment.'),
      submitted: z
        .number()
        .int()
        .describe('The number of students that have submitted the assignment.'),
      passing: z
        .number()
        .int()
        .describe('The number of students that have passed the assignment.'),
      language: z
        .string()
        .describe('The programming language used in the assignment.'),
      deadline: z
        .string()
        .datetime({ offset: true })
        .describe('The time at which the assignment is due.'),
      classroom: SimpleClassroomSchema
    })
    .describe('A GitHub Classroom assignment')
  export type SimpleClassroomAssignment = z.infer<
    typeof SimpleClassroomAssignmentSchema
  >

  export const CodeSecurityDefaultConfigurationsSchema = z
    .array(
      z.object({
        default_for_new_repos: z
          .enum(['public', 'private_and_internal', 'all'])
          .describe(
            'The visibility of newly created repositories for which the code security configuration will be applied to by default'
          )
          .optional(),
        configuration: CodeSecurityConfigurationSchema.optional()
      })
    )
    .describe('A list of default code security configurations')
  export type CodeSecurityDefaultConfigurations = z.infer<
    typeof CodeSecurityDefaultConfigurationsSchema
  >

  export const SimpleRepositorySchema = z
    .object({
      id: z.number().int().describe('A unique identifier of the repository.'),
      node_id: z.string().describe('The GraphQL identifier of the repository.'),
      name: z.string().describe('The name of the repository.'),
      full_name: z
        .string()
        .describe('The full, globally unique, name of the repository.'),
      owner: SimpleUserSchema,
      private: z.boolean().describe('Whether the repository is private.'),
      html_url: z
        .string()
        .url()
        .describe('The URL to view the repository on GitHub.com.'),
      description: z.string().describe('The repository description.'),
      fork: z.boolean().describe('Whether the repository is a fork.'),
      url: z
        .string()
        .url()
        .describe(
          'The URL to get more information about the repository from the GitHub API.'
        ),
      archive_url: z
        .string()
        .describe(
          'A template for the API URL to download the repository as an archive.'
        ),
      assignees_url: z
        .string()
        .describe(
          'A template for the API URL to list the available assignees for issues in the repository.'
        ),
      blobs_url: z
        .string()
        .describe(
          'A template for the API URL to create or retrieve a raw Git blob in the repository.'
        ),
      branches_url: z
        .string()
        .describe(
          'A template for the API URL to get information about branches in the repository.'
        ),
      collaborators_url: z
        .string()
        .describe(
          'A template for the API URL to get information about collaborators of the repository.'
        ),
      comments_url: z
        .string()
        .describe(
          'A template for the API URL to get information about comments on the repository.'
        ),
      commits_url: z
        .string()
        .describe(
          'A template for the API URL to get information about commits on the repository.'
        ),
      compare_url: z
        .string()
        .describe('A template for the API URL to compare two commits or refs.'),
      contents_url: z
        .string()
        .describe(
          'A template for the API URL to get the contents of the repository.'
        ),
      contributors_url: z
        .string()
        .url()
        .describe(
          'A template for the API URL to list the contributors to the repository.'
        ),
      deployments_url: z
        .string()
        .url()
        .describe('The API URL to list the deployments of the repository.'),
      downloads_url: z
        .string()
        .url()
        .describe('The API URL to list the downloads on the repository.'),
      events_url: z
        .string()
        .url()
        .describe('The API URL to list the events of the repository.'),
      forks_url: z
        .string()
        .url()
        .describe('The API URL to list the forks of the repository.'),
      git_commits_url: z
        .string()
        .describe(
          'A template for the API URL to get information about Git commits of the repository.'
        ),
      git_refs_url: z
        .string()
        .describe(
          'A template for the API URL to get information about Git refs of the repository.'
        ),
      git_tags_url: z
        .string()
        .describe(
          'A template for the API URL to get information about Git tags of the repository.'
        ),
      issue_comment_url: z
        .string()
        .describe(
          'A template for the API URL to get information about issue comments on the repository.'
        ),
      issue_events_url: z
        .string()
        .describe(
          'A template for the API URL to get information about issue events on the repository.'
        ),
      issues_url: z
        .string()
        .describe(
          'A template for the API URL to get information about issues on the repository.'
        ),
      keys_url: z
        .string()
        .describe(
          'A template for the API URL to get information about deploy keys on the repository.'
        ),
      labels_url: z
        .string()
        .describe(
          'A template for the API URL to get information about labels of the repository.'
        ),
      languages_url: z
        .string()
        .url()
        .describe(
          'The API URL to get information about the languages of the repository.'
        ),
      merges_url: z
        .string()
        .url()
        .describe('The API URL to merge branches in the repository.'),
      milestones_url: z
        .string()
        .describe(
          'A template for the API URL to get information about milestones of the repository.'
        ),
      notifications_url: z
        .string()
        .describe(
          'A template for the API URL to get information about notifications on the repository.'
        ),
      pulls_url: z
        .string()
        .describe(
          'A template for the API URL to get information about pull requests on the repository.'
        ),
      releases_url: z
        .string()
        .describe(
          'A template for the API URL to get information about releases on the repository.'
        ),
      stargazers_url: z
        .string()
        .url()
        .describe('The API URL to list the stargazers on the repository.'),
      statuses_url: z
        .string()
        .describe(
          'A template for the API URL to get information about statuses of a commit.'
        ),
      subscribers_url: z
        .string()
        .url()
        .describe('The API URL to list the subscribers on the repository.'),
      subscription_url: z
        .string()
        .url()
        .describe(
          'The API URL to subscribe to notifications for this repository.'
        ),
      tags_url: z
        .string()
        .url()
        .describe(
          'The API URL to get information about tags on the repository.'
        ),
      teams_url: z
        .string()
        .url()
        .describe('The API URL to list the teams on the repository.'),
      trees_url: z
        .string()
        .describe(
          'A template for the API URL to create or retrieve a raw Git tree of the repository.'
        ),
      hooks_url: z
        .string()
        .url()
        .describe('The API URL to list the hooks on the repository.')
    })
    .describe('A GitHub repository.')
  export type SimpleRepository = z.infer<typeof SimpleRepositorySchema>

  export const DependabotAlertSecurityVulnerabilitySchema = z
    .object({
      package: DependabotAlertPackageSchema,
      severity: z
        .enum(['low', 'medium', 'high', 'critical'])
        .describe('The severity of the vulnerability.')
        .readonly(),
      vulnerable_version_range: z
        .string()
        .describe(
          "Conditions that identify vulnerable versions of this vulnerability's package."
        )
        .readonly(),
      first_patched_version: z
        .object({
          identifier: z
            .string()
            .describe('The package version that patches this vulnerability.')
            .readonly()
        })
        .strict()
        .describe(
          'Details pertaining to the package version that patches this vulnerability.'
        )
        .readonly()
    })
    .strict()
    .describe(
      'Details pertaining to one vulnerable version range for the advisory.'
    )
    .readonly()
  export type DependabotAlertSecurityVulnerability = z.infer<
    typeof DependabotAlertSecurityVulnerabilitySchema
  >

  export const NullableMilestoneSchema = z
    .object({
      url: z.string().url(),
      html_url: z.string().url(),
      labels_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      number: z.number().int().describe('The number of the milestone.'),
      state: z
        .enum(['open', 'closed'])
        .describe('The state of the milestone.')
        .default('open'),
      title: z.string().describe('The title of the milestone.'),
      description: z.string(),
      creator: NullableSimpleUserSchema,
      open_issues: z.number().int(),
      closed_issues: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      closed_at: z.string().datetime({ offset: true }),
      due_on: z.string().datetime({ offset: true })
    })
    .describe('A collection of related issues and pull requests.')
  export type NullableMilestone = z.infer<typeof NullableMilestoneSchema>

  export const FeedSchema = z
    .object({
      timeline_url: z.string(),
      user_url: z.string(),
      current_user_public_url: z.string().optional(),
      current_user_url: z.string().optional(),
      current_user_actor_url: z.string().optional(),
      current_user_organization_url: z.string().optional(),
      current_user_organization_urls: z.array(z.string().url()).optional(),
      security_advisories_url: z.string().optional(),
      repository_discussions_url: z
        .string()
        .describe('A feed of discussions for a given repository.')
        .optional(),
      repository_discussions_category_url: z
        .string()
        .describe('A feed of discussions for a given repository and category.')
        .optional(),
      _links: z.object({
        timeline: LinkWithTypeSchema,
        user: LinkWithTypeSchema,
        security_advisories: LinkWithTypeSchema.optional(),
        current_user: LinkWithTypeSchema.optional(),
        current_user_public: LinkWithTypeSchema.optional(),
        current_user_actor: LinkWithTypeSchema.optional(),
        current_user_organization: LinkWithTypeSchema.optional(),
        current_user_organizations: z.array(LinkWithTypeSchema).optional(),
        repository_discussions: LinkWithTypeSchema.optional(),
        repository_discussions_category: LinkWithTypeSchema.optional()
      })
    })
    .describe('Feed')
  export type Feed = z.infer<typeof FeedSchema>

  export const GistHistorySchema = z
    .object({
      user: NullableSimpleUserSchema.optional(),
      version: z.string().optional(),
      committed_at: z.string().datetime({ offset: true }).optional(),
      change_status: z
        .object({
          total: z.number().int().optional(),
          additions: z.number().int().optional(),
          deletions: z.number().int().optional()
        })
        .optional(),
      url: z.string().url().optional()
    })
    .describe('Gist History')
  export type GistHistory = z.infer<typeof GistHistorySchema>

  export const GistCommitSchema = z
    .object({
      url: z.string().url(),
      version: z.string(),
      user: NullableSimpleUserSchema,
      change_status: z.object({
        total: z.number().int().optional(),
        additions: z.number().int().optional(),
        deletions: z.number().int().optional()
      }),
      committed_at: z.string().datetime({ offset: true })
    })
    .describe('Gist Commit')
  export type GistCommit = z.infer<typeof GistCommitSchema>

  export const MarketplacePurchaseSchema = z
    .object({
      url: z.string(),
      type: z.string(),
      id: z.number().int(),
      login: z.string(),
      organization_billing_email: z.string().optional(),
      email: z.string().optional(),
      marketplace_pending_change: z
        .object({
          is_installed: z.boolean().optional(),
          effective_date: z.string().optional(),
          unit_count: z.number().int().optional(),
          id: z.number().int().optional(),
          plan: MarketplaceListingPlanSchema.optional()
        })
        .optional(),
      marketplace_purchase: z.object({
        billing_cycle: z.string().optional(),
        next_billing_date: z.string().optional(),
        is_installed: z.boolean().optional(),
        unit_count: z.number().int().optional(),
        on_free_trial: z.boolean().optional(),
        free_trial_ends_on: z.string().optional(),
        updated_at: z.string().optional(),
        plan: MarketplaceListingPlanSchema.optional()
      })
    })
    .describe('Marketplace Purchase')
  export type MarketplacePurchase = z.infer<typeof MarketplacePurchaseSchema>

  export const RunnerSchema = z
    .object({
      id: z.number().int().describe('The ID of the runner.'),
      runner_group_id: z
        .number()
        .int()
        .describe('The ID of the runner group.')
        .optional(),
      name: z.string().describe('The name of the runner.'),
      os: z.string().describe('The Operating System of the runner.'),
      status: z.string().describe('The status of the runner.'),
      busy: z.boolean(),
      labels: z.array(RunnerLabelSchema),
      ephemeral: z.boolean().optional()
    })
    .describe('A self hosted runner')
  export type Runner = z.infer<typeof RunnerSchema>

  export const ToolNameSchema = z
    .any()
    .describe(
      'The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.'
    )
  export type ToolName = z.infer<typeof ToolNameSchema>

  export const ToolGuidSchema = z
    .any()
    .describe(
      'The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.'
    )
  export type ToolGuid = z.infer<typeof ToolGuidSchema>

  export const CopilotOrganizationDetailsSchema = z
    .object({
      seat_breakdown: CopilotOrganizationSeatBreakdownSchema,
      public_code_suggestions: z
        .enum(['allow', 'block', 'unconfigured'])
        .describe(
          'The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).'
        ),
      ide_chat: z
        .enum(['enabled', 'disabled', 'unconfigured'])
        .describe(
          'The organization policy for allowing or disallowing Copilot Chat in the IDE.'
        )
        .optional(),
      platform_chat: z
        .enum(['enabled', 'disabled', 'unconfigured'])
        .describe(
          'The organization policy for allowing or disallowing Copilot features on GitHub.com.'
        )
        .optional(),
      cli: z
        .enum(['enabled', 'disabled', 'unconfigured'])
        .describe(
          'The organization policy for allowing or disallowing Copilot in the CLI.'
        )
        .optional(),
      seat_management_setting: z
        .enum(['assign_all', 'assign_selected', 'disabled', 'unconfigured'])
        .describe('The mode of assigning new seats.'),
      plan_type: z
        .enum(['business', 'enterprise'])
        .describe(
          'The Copilot plan of the organization, or the parent enterprise, when applicable.'
        )
        .optional()
    })
    .catchall(z.any())
    .describe(
      'Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.'
    )
  export type CopilotOrganizationDetails = z.infer<
    typeof CopilotOrganizationDetailsSchema
  >

  export const TeamSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      slug: z.string(),
      description: z.string(),
      privacy: z.string().optional(),
      notification_setting: z.string().optional(),
      permission: z.string(),
      permissions: z
        .object({
          pull: z.boolean(),
          triage: z.boolean(),
          push: z.boolean(),
          maintain: z.boolean(),
          admin: z.boolean()
        })
        .optional(),
      url: z.string().url(),
      html_url: z.string().url(),
      members_url: z.string(),
      repositories_url: z.string().url(),
      parent: NullableTeamSimpleSchema
    })
    .describe(
      'Groups of organization members that gives permissions on specified repositories.'
    )
  export type Team = z.infer<typeof TeamSchema>

  export const OrganizationInvitationSchema = z
    .object({
      id: z.number().int(),
      login: z.string(),
      email: z.string(),
      role: z.string(),
      created_at: z.string(),
      failed_at: z.string().optional(),
      failed_reason: z.string().optional(),
      inviter: SimpleUserSchema,
      team_count: z.number().int(),
      node_id: z.string(),
      invitation_teams_url: z.string(),
      invitation_source: z.string().optional()
    })
    .describe('Organization Invitation')
  export type OrganizationInvitation = z.infer<
    typeof OrganizationInvitationSchema
  >

  export const InteractionLimitResponseSchema = z
    .object({
      limit: InteractionGroupSchema,
      origin: z.string(),
      expires_at: z.string().datetime({ offset: true })
    })
    .describe('Interaction limit settings.')
  export type InteractionLimitResponse = z.infer<
    typeof InteractionLimitResponseSchema
  >

  export const OrganizationRoleSchema = z
    .object({
      id: z.number().int().describe('The unique identifier of the role.'),
      name: z.string().describe('The name of the role.'),
      description: z
        .string()
        .describe(
          'A short description about who this role is for or what permissions it grants.'
        )
        .optional(),
      base_role: z
        .enum(['read', 'triage', 'write', 'maintain', 'admin'])
        .describe('The system role from which this role inherits permissions.')
        .optional(),
      source: z
        .enum(['Organization', 'Enterprise', 'Predefined'])
        .describe(
          'Source answers the question, "where did this role come from?"'
        )
        .optional(),
      permissions: z
        .array(z.string())
        .describe('A list of permissions included in this role.'),
      organization: NullableSimpleUserSchema,
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe('The date and time the role was created.'),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe('The date and time the role was last updated.')
    })
    .describe('Organization roles')
  export type OrganizationRole = z.infer<typeof OrganizationRoleSchema>

  export const TeamRoleAssignmentSchema = z
    .object({
      assignment: z
        .enum(['direct', 'indirect', 'mixed'])
        .describe(
          'Determines if the team has a direct, indirect, or mixed relationship to a role'
        )
        .optional(),
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      slug: z.string(),
      description: z.string(),
      privacy: z.string().optional(),
      notification_setting: z.string().optional(),
      permission: z.string(),
      permissions: z
        .object({
          pull: z.boolean(),
          triage: z.boolean(),
          push: z.boolean(),
          maintain: z.boolean(),
          admin: z.boolean()
        })
        .optional(),
      url: z.string().url(),
      html_url: z.string().url(),
      members_url: z.string(),
      repositories_url: z.string().url(),
      parent: NullableTeamSimpleSchema
    })
    .describe('The Relationship a Team has with a role.')
  export type TeamRoleAssignment = z.infer<typeof TeamRoleAssignmentSchema>

  export const UserRoleAssignmentSchema = z
    .object({
      assignment: z
        .enum(['direct', 'indirect', 'mixed'])
        .describe(
          'Determines if the user has a direct, indirect, or mixed relationship to a role'
        )
        .optional(),
      inherited_from: z
        .array(TeamSimpleSchema)
        .describe('Team the user has gotten the role through')
        .optional(),
      name: z.string().optional(),
      email: z.string().optional(),
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      events_url: z.string(),
      received_events_url: z.string().url(),
      type: z.string(),
      site_admin: z.boolean(),
      starred_at: z.string().optional(),
      user_view_type: z.string().optional()
    })
    .describe('The Relationship a User has with a role.')
  export type UserRoleAssignment = z.infer<typeof UserRoleAssignmentSchema>

  export const OrganizationProgrammaticAccessGrantRequestSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe(
          'Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests.'
        ),
      reason: z.string().describe('Reason for requesting access.'),
      owner: SimpleUserSchema,
      repository_selection: z
        .enum(['none', 'all', 'subset'])
        .describe('Type of repository selection requested.'),
      repositories_url: z
        .string()
        .describe(
          'URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`.'
        ),
      permissions: z
        .object({
          organization: z.record(z.string()).optional(),
          repository: z.record(z.string()).optional(),
          other: z.record(z.string()).optional()
        })
        .describe('Permissions requested, categorized by type of permission.'),
      created_at: z
        .string()
        .describe('Date and time when the request for access was created.'),
      token_id: z
        .number()
        .int()
        .describe(
          "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants."
        ),
      token_name: z
        .string()
        .describe(
          "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens."
        ),
      token_expired: z
        .boolean()
        .describe(
          'Whether the associated fine-grained personal access token has expired.'
        ),
      token_expires_at: z
        .string()
        .describe(
          'Date and time when the associated fine-grained personal access token expires.'
        ),
      token_last_used_at: z
        .string()
        .describe(
          'Date and time when the associated fine-grained personal access token was last used for authentication.'
        )
    })
    .describe(
      'Minimal representation of an organization programmatic access grant request for enumerations'
    )
  export type OrganizationProgrammaticAccessGrantRequest = z.infer<
    typeof OrganizationProgrammaticAccessGrantRequestSchema
  >

  export const OrganizationProgrammaticAccessGrantSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe(
          'Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token.'
        ),
      owner: SimpleUserSchema,
      repository_selection: z
        .enum(['none', 'all', 'subset'])
        .describe('Type of repository selection requested.'),
      repositories_url: z
        .string()
        .describe(
          'URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`.'
        ),
      permissions: z
        .object({
          organization: z.record(z.string()).optional(),
          repository: z.record(z.string()).optional(),
          other: z.record(z.string()).optional()
        })
        .describe('Permissions requested, categorized by type of permission.'),
      access_granted_at: z
        .string()
        .describe(
          'Date and time when the fine-grained personal access token was approved to access the organization.'
        ),
      token_id: z
        .number()
        .int()
        .describe(
          "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants."
        ),
      token_name: z
        .string()
        .describe(
          "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens."
        ),
      token_expired: z
        .boolean()
        .describe(
          'Whether the associated fine-grained personal access token has expired.'
        ),
      token_expires_at: z
        .string()
        .describe(
          'Date and time when the associated fine-grained personal access token expires.'
        ),
      token_last_used_at: z
        .string()
        .describe(
          'Date and time when the associated fine-grained personal access token was last used for authentication.'
        )
    })
    .describe(
      'Minimal representation of an organization programmatic access grant for enumerations'
    )
  export type OrganizationProgrammaticAccessGrant = z.infer<
    typeof OrganizationProgrammaticAccessGrantSchema
  >

  export const ProjectSchema = z
    .object({
      owner_url: z.string().url(),
      url: z.string().url(),
      html_url: z.string().url(),
      columns_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      name: z.string().describe('Name of the project'),
      body: z.string().describe('Body of the project'),
      number: z.number().int(),
      state: z
        .string()
        .describe("State of the project; either 'open' or 'closed'"),
      creator: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      organization_permission: z
        .enum(['read', 'write', 'admin', 'none'])
        .describe(
          'The baseline permission that all organization members have on this project. Only present if owner is an organization.'
        )
        .optional(),
      private: z
        .boolean()
        .describe(
          'Whether or not this project can be seen by everyone. Only present if owner is an organization.'
        )
        .optional()
    })
    .describe('Projects are a way to organize columns and cards of work.')
  export type Project = z.infer<typeof ProjectSchema>

  export const OrgRepoCustomPropertyValuesSchema = z
    .object({
      repository_id: z.number().int(),
      repository_name: z.string(),
      repository_full_name: z.string(),
      properties: z
        .array(CustomPropertyValueSchema)
        .describe('List of custom property names and associated values')
    })
    .describe('List of custom property values for a repository')
  export type OrgRepoCustomPropertyValues = z.infer<
    typeof OrgRepoCustomPropertyValuesSchema
  >

  export const RepositoryRulesetConditionsRepositoryPropertyTargetSchema = z
    .object({
      repository_property: z.object({
        include: z
          .array(RepositoryRulesetConditionsRepositoryPropertySpecSchema)
          .describe(
            'The repository properties and values to include. All of these properties must match for the condition to pass.'
          )
          .optional(),
        exclude: z
          .array(RepositoryRulesetConditionsRepositoryPropertySpecSchema)
          .describe(
            'The repository properties and values to exclude. The condition will not pass if any of these properties match.'
          )
          .optional()
      })
    })
    .describe('Parameters for a repository property condition')
  export type RepositoryRulesetConditionsRepositoryPropertyTarget = z.infer<
    typeof RepositoryRulesetConditionsRepositoryPropertyTargetSchema
  >

  export const RepositoryRuleRequiredStatusChecksSchema = z
    .object({
      type: z.literal('required_status_checks'),
      parameters: z
        .object({
          do_not_enforce_on_create: z
            .boolean()
            .describe(
              'Allow repositories and branches to be created if a check would otherwise prohibit it.'
            )
            .optional(),
          required_status_checks: z
            .array(RepositoryRuleParamsStatusCheckConfigurationSchema)
            .describe('Status checks that are required.'),
          strict_required_status_checks_policy: z
            .boolean()
            .describe(
              'Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.'
            )
        })
        .optional()
    })
    .describe(
      'Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.'
    )
  export type RepositoryRuleRequiredStatusChecks = z.infer<
    typeof RepositoryRuleRequiredStatusChecksSchema
  >

  export const RepositoryRuleWorkflowsSchema = z
    .object({
      type: z.literal('workflows'),
      parameters: z
        .object({
          do_not_enforce_on_create: z
            .boolean()
            .describe(
              'Allow repositories and branches to be created if a check would otherwise prohibit it.'
            )
            .optional(),
          workflows: z
            .array(RepositoryRuleParamsWorkflowFileReferenceSchema)
            .describe('Workflows that must pass for this rule to pass.')
        })
        .optional()
    })
    .describe(
      'Require all changes made to a targeted branch to pass the specified workflows before they can be merged.'
    )
  export type RepositoryRuleWorkflows = z.infer<
    typeof RepositoryRuleWorkflowsSchema
  >

  export const RepositoryRuleCodeScanningSchema = z
    .object({
      type: z.literal('code_scanning'),
      parameters: z
        .object({
          code_scanning_tools: z
            .array(RepositoryRuleParamsCodeScanningToolSchema)
            .describe(
              'Tools that must provide code scanning results for this rule to pass.'
            )
        })
        .optional()
    })
    .describe(
      'Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.'
    )
  export type RepositoryRuleCodeScanning = z.infer<
    typeof RepositoryRuleCodeScanningSchema
  >

  export const RulesetVersionWithStateSchema = z.intersection(
    RulesetVersionSchema,
    z.object({
      state: z.record(z.any()).describe('The state of the ruleset version')
    })
  )
  export type RulesetVersionWithState = z.infer<
    typeof RulesetVersionWithStateSchema
  >

  export const RepositoryAdvisoryVulnerabilitySchema = z
    .object({
      package: z
        .object({
          ecosystem: SecurityAdvisoryEcosystemsSchema,
          name: z
            .string()
            .describe('The unique package name within its ecosystem.')
        })
        .describe('The name of the package affected by the vulnerability.'),
      vulnerable_version_range: z
        .string()
        .describe(
          'The range of the package versions affected by the vulnerability.'
        ),
      patched_versions: z
        .string()
        .describe('The package version(s) that resolve the vulnerability.'),
      vulnerable_functions: z
        .array(z.string())
        .describe('The functions in the package that are affected.')
    })
    .strict()
    .describe(
      'A product affected by the vulnerability detailed in a repository security advisory.'
    )
  export type RepositoryAdvisoryVulnerability = z.infer<
    typeof RepositoryAdvisoryVulnerabilitySchema
  >

  export const ReactionSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      user: NullableSimpleUserSchema,
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe('The reaction to use'),
      created_at: z.string().datetime({ offset: true })
    })
    .describe(
      'Reactions to conversations provide a way to help people express their feelings more simply and effectively.'
    )
  export type Reaction = z.infer<typeof ReactionSchema>

  export const TeamProjectSchema = z
    .object({
      owner_url: z.string(),
      url: z.string(),
      html_url: z.string(),
      columns_url: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      body: z.string(),
      number: z.number().int(),
      state: z.string(),
      creator: SimpleUserSchema,
      created_at: z.string(),
      updated_at: z.string(),
      organization_permission: z
        .string()
        .describe(
          'The organization permission for this project. Only present when owner is an organization.'
        )
        .optional(),
      private: z
        .boolean()
        .describe(
          'Whether the project is private or not. Only present when owner is an organization.'
        )
        .optional(),
      permissions: z.object({
        read: z.boolean(),
        write: z.boolean(),
        admin: z.boolean()
      })
    })
    .describe("A team's access to a project.")
  export type TeamProject = z.infer<typeof TeamProjectSchema>

  export const ProjectCardSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int().describe("The project card's ID"),
      node_id: z.string(),
      note: z.string(),
      creator: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      archived: z
        .boolean()
        .describe('Whether or not the card is archived')
        .optional(),
      column_name: z.string().optional(),
      project_id: z.string().optional(),
      column_url: z.string().url(),
      content_url: z.string().url().optional(),
      project_url: z.string().url()
    })
    .describe('Project cards represent a scope of work.')
  export type ProjectCard = z.infer<typeof ProjectCardSchema>

  export const ProjectCollaboratorPermissionSchema = z
    .object({ permission: z.string(), user: NullableSimpleUserSchema })
    .describe('Project Collaborator Permission')
  export type ProjectCollaboratorPermission = z.infer<
    typeof ProjectCollaboratorPermissionSchema
  >

  export const RateLimitOverviewSchema = z
    .object({
      resources: z.object({
        core: RateLimitSchema,
        graphql: RateLimitSchema.optional(),
        search: RateLimitSchema,
        code_search: RateLimitSchema.optional(),
        source_import: RateLimitSchema.optional(),
        integration_manifest: RateLimitSchema.optional(),
        code_scanning_upload: RateLimitSchema.optional(),
        actions_runner_registration: RateLimitSchema.optional(),
        scim: RateLimitSchema.optional(),
        dependency_snapshots: RateLimitSchema.optional(),
        code_scanning_autofix: RateLimitSchema.optional()
      }),
      rate: RateLimitSchema
    })
    .describe('Rate Limit Overview')
  export type RateLimitOverview = z.infer<typeof RateLimitOverviewSchema>

  export const EnvironmentApprovalsSchema = z
    .object({
      environments: z
        .array(
          z.object({
            id: z
              .number()
              .int()
              .describe('The id of the environment.')
              .optional(),
            node_id: z.string().optional(),
            name: z
              .string()
              .describe('The name of the environment.')
              .optional(),
            url: z.string().optional(),
            html_url: z.string().optional(),
            created_at: z
              .string()
              .datetime({ offset: true })
              .describe(
                'The time that the environment was created, in ISO 8601 format.'
              )
              .optional(),
            updated_at: z
              .string()
              .datetime({ offset: true })
              .describe(
                'The time that the environment was last updated, in ISO 8601 format.'
              )
              .optional()
          })
        )
        .describe('The list of environments that were approved or rejected'),
      state: z
        .enum(['approved', 'rejected', 'pending'])
        .describe(
          'Whether deployment to the environment(s) was approved or rejected or pending (with comments)'
        ),
      user: SimpleUserSchema,
      comment: z
        .string()
        .describe('The comment submitted with the deployment review')
    })
    .describe('An entry in the reviews log for environment deployments')
  export type EnvironmentApprovals = z.infer<typeof EnvironmentApprovalsSchema>

  export const ActivitySchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      before: z.string().describe('The SHA of the commit before the activity.'),
      after: z.string().describe('The SHA of the commit after the activity.'),
      ref: z
        .string()
        .describe(
          'The full Git reference, formatted as `refs/heads/<branch name>`.'
        ),
      timestamp: z
        .string()
        .datetime({ offset: true })
        .describe('The time when the activity occurred.'),
      activity_type: z
        .enum([
          'push',
          'force_push',
          'branch_deletion',
          'branch_creation',
          'pr_merge',
          'merge_queue_merge'
        ])
        .describe('The type of the activity that was performed.'),
      actor: NullableSimpleUserSchema
    })
    .describe('Activity')
  export type Activity = z.infer<typeof ActivitySchema>

  export const CodeScanningCodeqlDatabaseSchema = z
    .object({
      id: z.number().int().describe('The ID of the CodeQL database.'),
      name: z.string().describe('The name of the CodeQL database.'),
      language: z.string().describe('The language of the CodeQL database.'),
      uploader: SimpleUserSchema,
      content_type: z
        .string()
        .describe('The MIME type of the CodeQL database file.'),
      size: z
        .number()
        .int()
        .describe('The size of the CodeQL database file in bytes.'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        ),
      url: z
        .string()
        .url()
        .describe(
          'The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.'
        ),
      commit_oid: z
        .string()
        .describe(
          'The commit SHA of the repository at the time the CodeQL database was created.'
        )
        .optional()
    })
    .describe('A CodeQL database.')
  export type CodeScanningCodeqlDatabase = z.infer<
    typeof CodeScanningCodeqlDatabaseSchema
  >

  export const CodeScanningVariantAnalysisSkippedRepoGroupSchema = z.object({
    repository_count: z
      .number()
      .int()
      .describe(
        'The total number of repositories that were skipped for this reason.'
      ),
    repositories: z
      .array(CodeScanningVariantAnalysisRepositorySchema)
      .describe(
        'A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it.'
      )
  })
  export type CodeScanningVariantAnalysisSkippedRepoGroup = z.infer<
    typeof CodeScanningVariantAnalysisSkippedRepoGroupSchema
  >

  export const CodeSecurityConfigurationForRepositorySchema = z
    .object({
      status: z
        .enum([
          'attached',
          'attaching',
          'detached',
          'removed',
          'enforced',
          'failed',
          'updating',
          'removed_by_enterprise'
        ])
        .describe(
          'The attachment status of the code security configuration on the repository.'
        )
        .optional(),
      configuration: CodeSecurityConfigurationSchema.optional()
    })
    .describe(
      'Code security configuration associated with a repository and attachment status'
    )
  export type CodeSecurityConfigurationForRepository = z.infer<
    typeof CodeSecurityConfigurationForRepositorySchema
  >

  export const RepositoryCollaboratorPermissionSchema = z
    .object({
      permission: z.string(),
      role_name: z.string(),
      user: NullableCollaboratorSchema
    })
    .describe('Repository Collaborator Permission')
  export type RepositoryCollaboratorPermission = z.infer<
    typeof RepositoryCollaboratorPermissionSchema
  >

  export const AutoMergeSchema = z
    .object({
      enabled_by: SimpleUserSchema,
      merge_method: z
        .enum(['merge', 'squash', 'rebase'])
        .describe('The merge method to use.'),
      commit_title: z.string().describe('Title for the merge commit message.'),
      commit_message: z
        .string()
        .describe('Commit message for the merge commit.')
    })
    .describe('The status of auto merging a pull request.')
  export type AutoMerge = z.infer<typeof AutoMergeSchema>

  export const DependabotAlertNumberSchema = z
    .any()
    .describe(
      'The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.'
    )
  export type DependabotAlertNumber = z.infer<
    typeof DependabotAlertNumberSchema
  >

  export const DependencySchema = z
    .object({
      package_url: z
        .string()
        .regex(new RegExp('^pkg'))
        .describe(
          'Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.'
        )
        .optional(),
      metadata: MetadataSchema.optional(),
      relationship: z
        .enum(['direct', 'indirect'])
        .describe(
          'A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.'
        )
        .optional(),
      scope: z
        .enum(['runtime', 'development'])
        .describe(
          'A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.'
        )
        .optional(),
      dependencies: z
        .array(z.string())
        .describe('Array of package-url (PURLs) of direct child dependencies.')
        .optional()
    })
    .strict()
  export type Dependency = z.infer<typeof DependencySchema>

  export const DeploymentProtectionRuleSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('The unique identifier for the deployment protection rule.'),
      node_id: z
        .string()
        .describe('The node ID for the deployment protection rule.'),
      enabled: z
        .boolean()
        .describe(
          'Whether the deployment protection rule is enabled for the environment.'
        ),
      app: CustomDeploymentRuleAppSchema
    })
    .describe('Deployment protection rule')
  export type DeploymentProtectionRule = z.infer<
    typeof DeploymentProtectionRuleSchema
  >

  export const GitTagSchema = z
    .object({
      node_id: z.string(),
      tag: z.string().describe('Name of the tag'),
      sha: z.string(),
      url: z.string().url().describe('URL for the tag'),
      message: z.string().describe('Message describing the purpose of the tag'),
      tagger: z.object({
        date: z.string(),
        email: z.string(),
        name: z.string()
      }),
      object: z.object({
        sha: z.string(),
        type: z.string(),
        url: z.string().url()
      }),
      verification: VerificationSchema.optional()
    })
    .describe('Metadata for a Git tag')
  export type GitTag = z.infer<typeof GitTagSchema>

  export const LicenseContentSchema = z
    .object({
      name: z.string(),
      path: z.string(),
      sha: z.string(),
      size: z.number().int(),
      url: z.string().url(),
      html_url: z.string().url(),
      git_url: z.string().url(),
      download_url: z.string().url(),
      type: z.string(),
      content: z.string(),
      encoding: z.string(),
      _links: z.object({
        git: z.string().url(),
        html: z.string().url(),
        self: z.string().url()
      }),
      license: NullableLicenseSimpleSchema
    })
    .describe('License Content')
  export type LicenseContent = z.infer<typeof LicenseContentSchema>

  export const MilestoneSchema = z
    .object({
      url: z.string().url(),
      html_url: z.string().url(),
      labels_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      number: z.number().int().describe('The number of the milestone.'),
      state: z
        .enum(['open', 'closed'])
        .describe('The state of the milestone.')
        .default('open'),
      title: z.string().describe('The title of the milestone.'),
      description: z.string(),
      creator: NullableSimpleUserSchema,
      open_issues: z.number().int(),
      closed_issues: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      closed_at: z.string().datetime({ offset: true }),
      due_on: z.string().datetime({ offset: true })
    })
    .describe('A collection of related issues and pull requests.')
  export type Milestone = z.infer<typeof MilestoneSchema>

  export const PageBuildSchema = z
    .object({
      url: z.string().url(),
      status: z.string(),
      error: z.object({ message: z.string() }),
      pusher: NullableSimpleUserSchema,
      commit: z.string(),
      duration: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('Page Build')
  export type PageBuild = z.infer<typeof PageBuildSchema>

  export const ReleaseAssetSchema = z
    .object({
      url: z.string().url(),
      browser_download_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      name: z.string().describe('The file name of the asset.'),
      label: z.string(),
      state: z
        .enum(['uploaded', 'open'])
        .describe('State of the release asset.'),
      content_type: z.string(),
      size: z.number().int(),
      download_count: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      uploader: NullableSimpleUserSchema
    })
    .describe('Data related to a release.')
  export type ReleaseAsset = z.infer<typeof ReleaseAssetSchema>

  export const SecretScanningPushProtectionBypassSchema = z.object({
    reason: SecretScanningPushProtectionBypassReasonSchema.optional(),
    expire_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    token_type: z
      .string()
      .describe('The token type this bypass is for.')
      .optional()
  })
  export type SecretScanningPushProtectionBypass = z.infer<
    typeof SecretScanningPushProtectionBypassSchema
  >

  export const SecretScanningScanHistorySchema = z.object({
    incremental_scans: z.array(SecretScanningScanSchema).optional(),
    pattern_update_scans: z.array(SecretScanningScanSchema).optional(),
    backfill_scans: z.array(SecretScanningScanSchema).optional(),
    custom_pattern_backfill_scans: z
      .array(
        z.intersection(
          SecretScanningScanSchema,
          z.object({
            pattern_name: z
              .string()
              .describe('Name of the custom pattern for custom pattern scans')
              .optional(),
            pattern_scope: z
              .string()
              .describe(
                'Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise"'
              )
              .optional()
          })
        )
      )
      .optional()
  })
  export type SecretScanningScanHistory = z.infer<
    typeof SecretScanningScanHistorySchema
  >

  export const PrivateVulnerabilityReportCreateSchema = z
    .object({
      summary: z
        .string()
        .max(1024)
        .describe('A short summary of the advisory.'),
      description: z
        .string()
        .max(65_535)
        .describe('A detailed description of what the advisory impacts.'),
      vulnerabilities: z
        .array(
          z
            .object({
              package: z
                .object({
                  ecosystem: SecurityAdvisoryEcosystemsSchema,
                  name: z
                    .string()
                    .describe('The unique package name within its ecosystem.')
                    .optional()
                })
                .describe(
                  'The name of the package affected by the vulnerability.'
                ),
              vulnerable_version_range: z
                .string()
                .describe(
                  'The range of the package versions affected by the vulnerability.'
                )
                .optional(),
              patched_versions: z
                .string()
                .describe(
                  'The package version(s) that resolve the vulnerability.'
                )
                .optional(),
              vulnerable_functions: z
                .array(z.string())
                .describe('The functions in the package that are affected.')
                .optional()
            })
            .strict()
        )
        .describe(
          'An array of products affected by the vulnerability detailed in a repository security advisory.'
        )
        .optional(),
      cwe_ids: z
        .array(z.string())
        .describe('A list of Common Weakness Enumeration (CWE) IDs.')
        .optional(),
      severity: z
        .enum(['critical', 'high', 'medium', 'low'])
        .describe(
          'The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.'
        )
        .optional(),
      cvss_vector_string: z
        .string()
        .describe(
          'The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.'
        )
        .optional(),
      start_private_fork: z
        .boolean()
        .describe(
          'Whether to create a temporary private fork of the repository to collaborate on a fix.'
        )
        .default(false)
    })
    .strict()
  export type PrivateVulnerabilityReportCreate = z.infer<
    typeof PrivateVulnerabilityReportCreateSchema
  >

  export const StargazerSchema = z
    .object({
      starred_at: z.string().datetime({ offset: true }),
      user: NullableSimpleUserSchema
    })
    .describe('Stargazer')
  export type Stargazer = z.infer<typeof StargazerSchema>

  export const ContributorActivitySchema = z
    .object({
      author: NullableSimpleUserSchema,
      total: z.number().int(),
      weeks: z.array(
        z.object({
          w: z.number().int().optional(),
          a: z.number().int().optional(),
          d: z.number().int().optional(),
          c: z.number().int().optional()
        })
      )
    })
    .describe('Contributor Activity')
  export type ContributorActivity = z.infer<typeof ContributorActivitySchema>

  export const CloneTrafficSchema = z
    .object({
      count: z.number().int(),
      uniques: z.number().int(),
      clones: z.array(TrafficSchema)
    })
    .describe('Clone Traffic')
  export type CloneTraffic = z.infer<typeof CloneTrafficSchema>

  export const ViewTrafficSchema = z
    .object({
      count: z.number().int(),
      uniques: z.number().int(),
      views: z.array(TrafficSchema)
    })
    .describe('View Traffic')
  export type ViewTraffic = z.infer<typeof ViewTrafficSchema>

  export const LabelSearchResultItemSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      name: z.string(),
      color: z.string(),
      default: z.boolean(),
      description: z.string(),
      score: z.number(),
      text_matches: SearchResultTextMatchesSchema.optional()
    })
    .describe('Label Search Result Item')
  export type LabelSearchResultItem = z.infer<
    typeof LabelSearchResultItemSchema
  >

  export const TopicSearchResultItemSchema = z
    .object({
      name: z.string(),
      display_name: z.string(),
      short_description: z.string(),
      description: z.string(),
      created_by: z.string(),
      released: z.string(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      featured: z.boolean(),
      curated: z.boolean(),
      score: z.number(),
      repository_count: z.number().int().optional(),
      logo_url: z.string().url().optional(),
      text_matches: SearchResultTextMatchesSchema.optional(),
      related: z
        .array(
          z.object({
            topic_relation: z
              .object({
                id: z.number().int().optional(),
                name: z.string().optional(),
                topic_id: z.number().int().optional(),
                relation_type: z.string().optional()
              })
              .optional()
          })
        )
        .optional(),
      aliases: z
        .array(
          z.object({
            topic_relation: z
              .object({
                id: z.number().int().optional(),
                name: z.string().optional(),
                topic_id: z.number().int().optional(),
                relation_type: z.string().optional()
              })
              .optional()
          })
        )
        .optional()
    })
    .describe('Topic Search Result Item')
  export type TopicSearchResultItem = z.infer<
    typeof TopicSearchResultItemSchema
  >

  export const UserSearchResultItemSchema = z
    .object({
      login: z.string(),
      id: z.number().int(),
      node_id: z.string(),
      avatar_url: z.string().url(),
      gravatar_id: z.string(),
      url: z.string().url(),
      html_url: z.string().url(),
      followers_url: z.string().url(),
      subscriptions_url: z.string().url(),
      organizations_url: z.string().url(),
      repos_url: z.string().url(),
      received_events_url: z.string().url(),
      type: z.string(),
      score: z.number(),
      following_url: z.string(),
      gists_url: z.string(),
      starred_url: z.string(),
      events_url: z.string(),
      public_repos: z.number().int().optional(),
      public_gists: z.number().int().optional(),
      followers: z.number().int().optional(),
      following: z.number().int().optional(),
      created_at: z.string().datetime({ offset: true }).optional(),
      updated_at: z.string().datetime({ offset: true }).optional(),
      name: z.string().optional(),
      bio: z.string().optional(),
      email: z.string().email().optional(),
      location: z.string().optional(),
      site_admin: z.boolean(),
      hireable: z.boolean().optional(),
      text_matches: SearchResultTextMatchesSchema.optional(),
      blog: z.string().optional(),
      company: z.string().optional(),
      suspended_at: z.string().datetime({ offset: true }).optional(),
      user_view_type: z.string().optional()
    })
    .describe('User Search Result Item')
  export type UserSearchResultItem = z.infer<typeof UserSearchResultItemSchema>

  export const IntegrationSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the GitHub app'),
      slug: z.string().describe('The slug name of the GitHub app').optional(),
      node_id: z.string(),
      client_id: z.string().optional(),
      owner: z.union([SimpleUserSchema, EnterpriseSchema]),
      name: z.string().describe('The name of the GitHub app'),
      description: z.string(),
      external_url: z.string().url(),
      html_url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      permissions: z
        .object({
          issues: z.string().optional(),
          checks: z.string().optional(),
          metadata: z.string().optional(),
          contents: z.string().optional(),
          deployments: z.string().optional()
        })
        .catchall(z.string())
        .describe('The set of permissions for the GitHub app'),
      events: z
        .array(z.string())
        .describe('The list of events for the GitHub app'),
      installations_count: z
        .number()
        .int()
        .describe('The number of installations associated with the GitHub app')
        .optional(),
      client_secret: z.string().optional(),
      webhook_secret: z.string().optional(),
      pem: z.string().optional()
    })
    .describe(
      'GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.'
    )
  export type Integration = z.infer<typeof IntegrationSchema>

  export const IntegrationInstallationRequestSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('Unique identifier of the request installation.'),
      node_id: z.string().optional(),
      account: z.union([SimpleUserSchema, EnterpriseSchema]),
      requester: SimpleUserSchema,
      created_at: z.string().datetime({ offset: true })
    })
    .describe('Request to install an integration on a target')
  export type IntegrationInstallationRequest = z.infer<
    typeof IntegrationInstallationRequestSchema
  >

  export const RepositorySchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository'),
      node_id: z.string(),
      name: z.string().describe('The name of the repository.'),
      full_name: z.string(),
      license: NullableLicenseSimpleSchema,
      forks: z.number().int(),
      permissions: z
        .object({
          admin: z.boolean(),
          pull: z.boolean(),
          triage: z.boolean().optional(),
          push: z.boolean(),
          maintain: z.boolean().optional()
        })
        .optional(),
      owner: SimpleUserSchema,
      private: z
        .boolean()
        .describe('Whether the repository is private or public.')
        .default(false),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string(),
      mirror_url: z.string().url(),
      hooks_url: z.string().url(),
      svn_url: z.string().url(),
      homepage: z.string().url(),
      language: z.string(),
      forks_count: z.number().int(),
      stargazers_count: z.number().int(),
      watchers_count: z.number().int(),
      size: z
        .number()
        .int()
        .describe(
          'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
        ),
      default_branch: z
        .string()
        .describe('The default branch of the repository.'),
      open_issues_count: z.number().int(),
      is_template: z
        .boolean()
        .describe(
          'Whether this repository acts as a template that can be used to generate new repositories.'
        )
        .default(false),
      topics: z.array(z.string()).optional(),
      has_issues: z
        .boolean()
        .describe('Whether issues are enabled.')
        .default(true),
      has_projects: z
        .boolean()
        .describe('Whether projects are enabled.')
        .default(true),
      has_wiki: z
        .boolean()
        .describe('Whether the wiki is enabled.')
        .default(true),
      has_pages: z.boolean(),
      has_downloads: z
        .boolean()
        .describe('Whether downloads are enabled.')
        .default(true),
      has_discussions: z
        .boolean()
        .describe('Whether discussions are enabled.')
        .default(false),
      archived: z
        .boolean()
        .describe('Whether the repository is archived.')
        .default(false),
      disabled: z
        .boolean()
        .describe('Returns whether or not this repository disabled.'),
      visibility: z
        .string()
        .describe('The repository visibility: public, private, or internal.')
        .default('public'),
      pushed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      allow_rebase_merge: z
        .boolean()
        .describe('Whether to allow rebase merges for pull requests.')
        .default(true),
      temp_clone_token: z.string().optional(),
      allow_squash_merge: z
        .boolean()
        .describe('Whether to allow squash merges for pull requests.')
        .default(true),
      allow_auto_merge: z
        .boolean()
        .describe('Whether to allow Auto-merge to be used on pull requests.')
        .default(false),
      delete_branch_on_merge: z
        .boolean()
        .describe(
          'Whether to delete head branches when pull requests are merged'
        )
        .default(false),
      allow_update_branch: z
        .boolean()
        .describe(
          'Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.'
        )
        .default(false),
      use_squash_pr_title_as_default: z
        .boolean()
        .describe(
          'Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.'
        )
        .default(false),
      squash_merge_commit_title: z
        .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
        .describe(
          "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
        )
        .optional(),
      squash_merge_commit_message: z
        .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
        .describe(
          "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      merge_commit_title: z
        .enum(['PR_TITLE', 'MERGE_MESSAGE'])
        .describe(
          "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
        )
        .optional(),
      merge_commit_message: z
        .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
        .describe(
          "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      allow_merge_commit: z
        .boolean()
        .describe('Whether to allow merge commits for pull requests.')
        .default(true),
      allow_forking: z
        .boolean()
        .describe('Whether to allow forking this repo')
        .optional(),
      web_commit_signoff_required: z
        .boolean()
        .describe(
          'Whether to require contributors to sign off on web-based commits'
        )
        .default(false),
      open_issues: z.number().int(),
      watchers: z.number().int(),
      master_branch: z.string().optional(),
      starred_at: z.string().optional(),
      anonymous_access_enabled: z
        .boolean()
        .describe('Whether anonymous git access is enabled for this repository')
        .optional()
    })
    .describe('A repository on GitHub.')
  export type Repository = z.infer<typeof RepositorySchema>

  export const NullableScopedInstallationSchema = z.object({
    permissions: AppPermissionsSchema,
    repository_selection: z
      .enum(['all', 'selected'])
      .describe(
        "Describe whether all repositories have been selected or there's a selection involved"
      ),
    single_file_name: z.string(),
    has_multiple_single_files: z.boolean().optional(),
    single_file_paths: z.array(z.string()).optional(),
    repositories_url: z.string().url(),
    account: SimpleUserSchema
  })
  export type NullableScopedInstallation = z.infer<
    typeof NullableScopedInstallationSchema
  >

  export const CodeSecurityConfigurationRepositoriesSchema = z
    .object({
      status: z
        .enum([
          'attached',
          'attaching',
          'detached',
          'removed',
          'enforced',
          'failed',
          'updating',
          'removed_by_enterprise'
        ])
        .describe(
          'The attachment status of the code security configuration on the repository.'
        )
        .optional(),
      repository: SimpleRepositorySchema.optional()
    })
    .describe(
      'Repositories associated with a code security configuration and attachment status'
    )
  export type CodeSecurityConfigurationRepositories = z.infer<
    typeof CodeSecurityConfigurationRepositoriesSchema
  >

  export const NullableIntegrationSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the GitHub app'),
      slug: z.string().describe('The slug name of the GitHub app').optional(),
      node_id: z.string(),
      client_id: z.string().optional(),
      owner: z.union([SimpleUserSchema, EnterpriseSchema]),
      name: z.string().describe('The name of the GitHub app'),
      description: z.string(),
      external_url: z.string().url(),
      html_url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      permissions: z
        .object({
          issues: z.string().optional(),
          checks: z.string().optional(),
          metadata: z.string().optional(),
          contents: z.string().optional(),
          deployments: z.string().optional()
        })
        .catchall(z.string())
        .describe('The set of permissions for the GitHub app'),
      events: z
        .array(z.string())
        .describe('The list of events for the GitHub app'),
      installations_count: z
        .number()
        .int()
        .describe('The number of installations associated with the GitHub app')
        .optional(),
      client_secret: z.string().optional(),
      webhook_secret: z.string().optional(),
      pem: z.string().optional()
    })
    .describe(
      'GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.'
    )
  export type NullableIntegration = z.infer<typeof NullableIntegrationSchema>

  export const BaseGistSchema = z
    .object({
      url: z.string().url(),
      forks_url: z.string().url(),
      commits_url: z.string().url(),
      id: z.string(),
      node_id: z.string(),
      git_pull_url: z.string().url(),
      git_push_url: z.string().url(),
      html_url: z.string().url(),
      files: z.record(
        z.object({
          filename: z.string().optional(),
          type: z.string().optional(),
          language: z.string().optional(),
          raw_url: z.string().optional(),
          size: z.number().int().optional(),
          encoding: z
            .string()
            .describe(
              'The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.'
            )
            .default('utf-8')
        })
      ),
      public: z.boolean(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      description: z.string(),
      comments: z.number().int(),
      comments_enabled: z.boolean().optional(),
      user: NullableSimpleUserSchema,
      comments_url: z.string().url(),
      owner: SimpleUserSchema.optional(),
      truncated: z.boolean().optional(),
      forks: z.array(z.any()).optional(),
      history: z.array(z.any()).optional()
    })
    .describe('Base Gist')
  export type BaseGist = z.infer<typeof BaseGistSchema>

  export const GistCommentSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      body: z.string().max(65_535).describe('The comment text.'),
      user: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      author_association: AuthorAssociationSchema
    })
    .describe('A comment made to a gist.')
  export type GistComment = z.infer<typeof GistCommentSchema>

  export const BillingUsageReportOrgSchema = z
    .any()
    .describe('Billing usage report response for an organization')
  export type BillingUsageReportOrg = z.infer<
    typeof BillingUsageReportOrgSchema
  >

  export const ActionsGetDefaultWorkflowPermissionsSchema = z.object({
    default_workflow_permissions: ActionsDefaultWorkflowPermissionsSchema,
    can_approve_pull_request_reviews: ActionsCanApprovePullRequestReviewsSchema
  })
  export type ActionsGetDefaultWorkflowPermissions = z.infer<
    typeof ActionsGetDefaultWorkflowPermissionsSchema
  >

  export const ActionsSetDefaultWorkflowPermissionsSchema = z.object({
    default_workflow_permissions:
      ActionsDefaultWorkflowPermissionsSchema.optional(),
    can_approve_pull_request_reviews:
      ActionsCanApprovePullRequestReviewsSchema.optional()
  })
  export type ActionsSetDefaultWorkflowPermissions = z.infer<
    typeof ActionsSetDefaultWorkflowPermissionsSchema
  >

  export const ActionsRunnerLabelsSchema = z.any().describe('Response')
  export type ActionsRunnerLabels = z.infer<typeof ActionsRunnerLabelsSchema>

  export const ActionsRunnerLabelsReadonlySchema = z.any().describe('Response')
  export type ActionsRunnerLabelsReadonly = z.infer<
    typeof ActionsRunnerLabelsReadonlySchema
  >

  export const InteractionLimitSchema = z
    .object({
      limit: InteractionGroupSchema,
      expiry: InteractionExpirySchema.optional()
    })
    .describe(
      'Limit interactions to a specific type of user for a specified duration'
    )
  export type InteractionLimit = z.infer<typeof InteractionLimitSchema>

  export const OrgMembershipSchema = z
    .object({
      url: z.string().url(),
      state: z
        .enum(['active', 'pending'])
        .describe(
          'The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.'
        ),
      role: z
        .enum(['admin', 'member', 'billing_manager'])
        .describe("The user's membership type in the organization."),
      organization_url: z.string().url(),
      organization: OrganizationSimpleSchema,
      user: NullableSimpleUserSchema,
      permissions: z.object({ can_create_repository: z.boolean() }).optional()
    })
    .describe('Org Membership')
  export type OrgMembership = z.infer<typeof OrgMembershipSchema>

  export const NullableRepositorySchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository'),
      node_id: z.string(),
      name: z.string().describe('The name of the repository.'),
      full_name: z.string(),
      license: NullableLicenseSimpleSchema,
      forks: z.number().int(),
      permissions: z
        .object({
          admin: z.boolean(),
          pull: z.boolean(),
          triage: z.boolean().optional(),
          push: z.boolean(),
          maintain: z.boolean().optional()
        })
        .optional(),
      owner: SimpleUserSchema,
      private: z
        .boolean()
        .describe('Whether the repository is private or public.')
        .default(false),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string(),
      mirror_url: z.string().url(),
      hooks_url: z.string().url(),
      svn_url: z.string().url(),
      homepage: z.string().url(),
      language: z.string(),
      forks_count: z.number().int(),
      stargazers_count: z.number().int(),
      watchers_count: z.number().int(),
      size: z
        .number()
        .int()
        .describe(
          'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
        ),
      default_branch: z
        .string()
        .describe('The default branch of the repository.'),
      open_issues_count: z.number().int(),
      is_template: z
        .boolean()
        .describe(
          'Whether this repository acts as a template that can be used to generate new repositories.'
        )
        .default(false),
      topics: z.array(z.string()).optional(),
      has_issues: z
        .boolean()
        .describe('Whether issues are enabled.')
        .default(true),
      has_projects: z
        .boolean()
        .describe('Whether projects are enabled.')
        .default(true),
      has_wiki: z
        .boolean()
        .describe('Whether the wiki is enabled.')
        .default(true),
      has_pages: z.boolean(),
      has_downloads: z
        .boolean()
        .describe('Whether downloads are enabled.')
        .default(true),
      has_discussions: z
        .boolean()
        .describe('Whether discussions are enabled.')
        .default(false),
      archived: z
        .boolean()
        .describe('Whether the repository is archived.')
        .default(false),
      disabled: z
        .boolean()
        .describe('Returns whether or not this repository disabled.'),
      visibility: z
        .string()
        .describe('The repository visibility: public, private, or internal.')
        .default('public'),
      pushed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      allow_rebase_merge: z
        .boolean()
        .describe('Whether to allow rebase merges for pull requests.')
        .default(true),
      temp_clone_token: z.string().optional(),
      allow_squash_merge: z
        .boolean()
        .describe('Whether to allow squash merges for pull requests.')
        .default(true),
      allow_auto_merge: z
        .boolean()
        .describe('Whether to allow Auto-merge to be used on pull requests.')
        .default(false),
      delete_branch_on_merge: z
        .boolean()
        .describe(
          'Whether to delete head branches when pull requests are merged'
        )
        .default(false),
      allow_update_branch: z
        .boolean()
        .describe(
          'Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.'
        )
        .default(false),
      use_squash_pr_title_as_default: z
        .boolean()
        .describe(
          'Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.'
        )
        .default(false),
      squash_merge_commit_title: z
        .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
        .describe(
          "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
        )
        .optional(),
      squash_merge_commit_message: z
        .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
        .describe(
          "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      merge_commit_title: z
        .enum(['PR_TITLE', 'MERGE_MESSAGE'])
        .describe(
          "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
        )
        .optional(),
      merge_commit_message: z
        .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
        .describe(
          "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      allow_merge_commit: z
        .boolean()
        .describe('Whether to allow merge commits for pull requests.')
        .default(true),
      allow_forking: z
        .boolean()
        .describe('Whether to allow forking this repo')
        .optional(),
      web_commit_signoff_required: z
        .boolean()
        .describe(
          'Whether to require contributors to sign off on web-based commits'
        )
        .default(false),
      open_issues: z.number().int(),
      watchers: z.number().int(),
      master_branch: z.string().optional(),
      starred_at: z.string().optional(),
      anonymous_access_enabled: z
        .boolean()
        .describe('Whether anonymous git access is enabled for this repository')
        .optional()
    })
    .describe('A repository on GitHub.')
  export type NullableRepository = z.infer<typeof NullableRepositorySchema>

  export const RepositoryAdvisoryCreditSchema = z
    .object({
      user: SimpleUserSchema,
      type: SecurityAdvisoryCreditTypesSchema,
      state: z
        .enum(['accepted', 'declined', 'pending'])
        .describe("The state of the user's acceptance of the credit.")
    })
    .strict()
    .describe('A credit given to a user for a repository security advisory.')
  export type RepositoryAdvisoryCredit = z.infer<
    typeof RepositoryAdvisoryCreditSchema
  >

  export const TeamFullSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the team'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the team'),
      html_url: z.string().url(),
      name: z.string().describe('Name of the team'),
      slug: z.string(),
      description: z.string(),
      privacy: z
        .enum(['closed', 'secret'])
        .describe('The level of privacy this team should have')
        .optional(),
      notification_setting: z
        .enum(['notifications_enabled', 'notifications_disabled'])
        .describe('The notification setting the team has set')
        .optional(),
      permission: z
        .string()
        .describe('Permission that the team will have for its repositories'),
      members_url: z.string(),
      repositories_url: z.string().url(),
      parent: NullableTeamSimpleSchema.optional(),
      members_count: z.number().int(),
      repos_count: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      organization: TeamOrganizationSchema,
      ldap_dn: z
        .string()
        .describe(
          'Distinguished Name (DN) that team maps to within LDAP environment'
        )
        .optional()
    })
    .describe(
      'Groups of organization members that gives permissions on specified repositories.'
    )
  export type TeamFull = z.infer<typeof TeamFullSchema>

  export const TeamDiscussionSchema = z
    .object({
      author: NullableSimpleUserSchema,
      body: z.string().describe('The main text of the discussion.'),
      body_html: z.string(),
      body_version: z
        .string()
        .describe(
          'The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.'
        ),
      comments_count: z.number().int(),
      comments_url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      last_edited_at: z.string().datetime({ offset: true }),
      html_url: z.string().url(),
      node_id: z.string(),
      number: z
        .number()
        .int()
        .describe('The unique sequence number of a team discussion.'),
      pinned: z
        .boolean()
        .describe(
          'Whether or not this discussion should be pinned for easy retrieval.'
        ),
      private: z
        .boolean()
        .describe(
          'Whether or not this discussion should be restricted to team members and organization owners.'
        ),
      team_url: z.string().url(),
      title: z.string().describe('The title of the discussion.'),
      updated_at: z.string().datetime({ offset: true }),
      url: z.string().url(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe(
      'A team discussion is a persistent record of a free-form conversation within a team.'
    )
  export type TeamDiscussion = z.infer<typeof TeamDiscussionSchema>

  export const TeamDiscussionCommentSchema = z
    .object({
      author: NullableSimpleUserSchema,
      body: z.string().describe('The main text of the comment.'),
      body_html: z.string(),
      body_version: z
        .string()
        .describe(
          'The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.'
        ),
      created_at: z.string().datetime({ offset: true }),
      last_edited_at: z.string().datetime({ offset: true }),
      discussion_url: z.string().url(),
      html_url: z.string().url(),
      node_id: z.string(),
      number: z
        .number()
        .int()
        .describe('The unique sequence number of a team discussion comment.'),
      updated_at: z.string().datetime({ offset: true }),
      url: z.string().url(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe('A reply to a discussion within a team.')
  export type TeamDiscussionComment = z.infer<
    typeof TeamDiscussionCommentSchema
  >

  export const TeamRepositorySchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository'),
      node_id: z.string(),
      name: z.string().describe('The name of the repository.'),
      full_name: z.string(),
      license: NullableLicenseSimpleSchema,
      forks: z.number().int(),
      permissions: z
        .object({
          admin: z.boolean(),
          pull: z.boolean(),
          triage: z.boolean().optional(),
          push: z.boolean(),
          maintain: z.boolean().optional()
        })
        .optional(),
      role_name: z.string().optional(),
      owner: NullableSimpleUserSchema,
      private: z
        .boolean()
        .describe('Whether the repository is private or public.')
        .default(false),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string(),
      mirror_url: z.string().url(),
      hooks_url: z.string().url(),
      svn_url: z.string().url(),
      homepage: z.string().url(),
      language: z.string(),
      forks_count: z.number().int(),
      stargazers_count: z.number().int(),
      watchers_count: z.number().int(),
      size: z.number().int(),
      default_branch: z
        .string()
        .describe('The default branch of the repository.'),
      open_issues_count: z.number().int(),
      is_template: z
        .boolean()
        .describe(
          'Whether this repository acts as a template that can be used to generate new repositories.'
        )
        .default(false),
      topics: z.array(z.string()).optional(),
      has_issues: z
        .boolean()
        .describe('Whether issues are enabled.')
        .default(true),
      has_projects: z
        .boolean()
        .describe('Whether projects are enabled.')
        .default(true),
      has_wiki: z
        .boolean()
        .describe('Whether the wiki is enabled.')
        .default(true),
      has_pages: z.boolean(),
      has_downloads: z
        .boolean()
        .describe('Whether downloads are enabled.')
        .default(true),
      archived: z
        .boolean()
        .describe('Whether the repository is archived.')
        .default(false),
      disabled: z
        .boolean()
        .describe('Returns whether or not this repository disabled.'),
      visibility: z
        .string()
        .describe('The repository visibility: public, private, or internal.')
        .default('public'),
      pushed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      allow_rebase_merge: z
        .boolean()
        .describe('Whether to allow rebase merges for pull requests.')
        .default(true),
      temp_clone_token: z.string().optional(),
      allow_squash_merge: z
        .boolean()
        .describe('Whether to allow squash merges for pull requests.')
        .default(true),
      allow_auto_merge: z
        .boolean()
        .describe('Whether to allow Auto-merge to be used on pull requests.')
        .default(false),
      delete_branch_on_merge: z
        .boolean()
        .describe(
          'Whether to delete head branches when pull requests are merged'
        )
        .default(false),
      allow_merge_commit: z
        .boolean()
        .describe('Whether to allow merge commits for pull requests.')
        .default(true),
      allow_forking: z
        .boolean()
        .describe('Whether to allow forking this repo')
        .default(false),
      web_commit_signoff_required: z
        .boolean()
        .describe(
          'Whether to require contributors to sign off on web-based commits'
        )
        .default(false),
      subscribers_count: z.number().int().optional(),
      network_count: z.number().int().optional(),
      open_issues: z.number().int(),
      watchers: z.number().int(),
      master_branch: z.string().optional()
    })
    .describe("A team's access to a repository.")
  export type TeamRepository = z.infer<typeof TeamRepositorySchema>

  export const ManifestSchema = z
    .object({
      name: z.string().describe('The name of the manifest.'),
      file: z
        .object({
          source_location: z
            .string()
            .describe(
              'The path of the manifest file relative to the root of the Git repository.'
            )
            .optional()
        })
        .strict()
        .optional(),
      metadata: MetadataSchema.optional(),
      resolved: z
        .record(DependencySchema)
        .describe('A collection of resolved package dependencies.')
        .optional()
    })
    .strict()
  export type Manifest = z.infer<typeof ManifestSchema>

  export const TimelineReviewedEventSchema = z
    .object({
      event: z.string(),
      id: z.number().int().describe('Unique identifier of the review'),
      node_id: z.string(),
      user: SimpleUserSchema,
      body: z.string().describe('The text of the review.'),
      state: z.string(),
      html_url: z.string().url(),
      pull_request_url: z.string().url(),
      _links: z.object({
        html: z.object({ href: z.string() }),
        pull_request: z.object({ href: z.string() })
      }),
      submitted_at: z.string().datetime({ offset: true }).optional(),
      commit_id: z.string().describe('A commit SHA for the review.'),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      author_association: AuthorAssociationSchema
    })
    .describe('Timeline Reviewed Event')
  export type TimelineReviewedEvent = z.infer<
    typeof TimelineReviewedEventSchema
  >

  export const PullRequestReviewSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the review'),
      node_id: z.string(),
      user: NullableSimpleUserSchema,
      body: z.string().describe('The text of the review.'),
      state: z.string(),
      html_url: z.string().url(),
      pull_request_url: z.string().url(),
      _links: z.object({
        html: z.object({ href: z.string() }),
        pull_request: z.object({ href: z.string() })
      }),
      submitted_at: z.string().datetime({ offset: true }).optional(),
      commit_id: z
        .string()
        .describe(
          'A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.'
        ),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      author_association: AuthorAssociationSchema
    })
    .describe('Pull Request Reviews are reviews on pull requests.')
  export type PullRequestReview = z.infer<typeof PullRequestReviewSchema>

  export const RepositoryAdvisoryCreateSchema = z
    .object({
      summary: z
        .string()
        .max(1024)
        .describe('A short summary of the advisory.'),
      description: z
        .string()
        .max(65_535)
        .describe('A detailed description of what the advisory impacts.'),
      cve_id: z
        .string()
        .describe('The Common Vulnerabilities and Exposures (CVE) ID.')
        .optional(),
      vulnerabilities: z
        .array(
          z
            .object({
              package: z
                .object({
                  ecosystem: SecurityAdvisoryEcosystemsSchema,
                  name: z
                    .string()
                    .describe('The unique package name within its ecosystem.')
                    .optional()
                })
                .describe(
                  'The name of the package affected by the vulnerability.'
                ),
              vulnerable_version_range: z
                .string()
                .describe(
                  'The range of the package versions affected by the vulnerability.'
                )
                .optional(),
              patched_versions: z
                .string()
                .describe(
                  'The package version(s) that resolve the vulnerability.'
                )
                .optional(),
              vulnerable_functions: z
                .array(z.string())
                .describe('The functions in the package that are affected.')
                .optional()
            })
            .strict()
        )
        .describe(
          'A product affected by the vulnerability detailed in a repository security advisory.'
        ),
      cwe_ids: z
        .array(z.string())
        .describe('A list of Common Weakness Enumeration (CWE) IDs.')
        .optional(),
      credits: z
        .array(
          z
            .object({
              login: z.string().describe('The username of the user credited.'),
              type: SecurityAdvisoryCreditTypesSchema
            })
            .strict()
        )
        .describe(
          'A list of users receiving credit for their participation in the security advisory.'
        )
        .optional(),
      severity: z
        .enum(['critical', 'high', 'medium', 'low'])
        .describe(
          'The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.'
        )
        .optional(),
      cvss_vector_string: z
        .string()
        .describe(
          'The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.'
        )
        .optional(),
      start_private_fork: z
        .boolean()
        .describe(
          'Whether to create a temporary private fork of the repository to collaborate on a fix.'
        )
        .default(false)
    })
    .strict()
  export type RepositoryAdvisoryCreate = z.infer<
    typeof RepositoryAdvisoryCreateSchema
  >

  export const RepositoryAdvisoryUpdateSchema = z
    .object({
      summary: z
        .string()
        .max(1024)
        .describe('A short summary of the advisory.')
        .optional(),
      description: z
        .string()
        .max(65_535)
        .describe('A detailed description of what the advisory impacts.')
        .optional(),
      cve_id: z
        .string()
        .describe('The Common Vulnerabilities and Exposures (CVE) ID.')
        .optional(),
      vulnerabilities: z
        .array(
          z
            .object({
              package: z
                .object({
                  ecosystem: SecurityAdvisoryEcosystemsSchema,
                  name: z
                    .string()
                    .describe('The unique package name within its ecosystem.')
                    .optional()
                })
                .describe(
                  'The name of the package affected by the vulnerability.'
                ),
              vulnerable_version_range: z
                .string()
                .describe(
                  'The range of the package versions affected by the vulnerability.'
                )
                .optional(),
              patched_versions: z
                .string()
                .describe(
                  'The package version(s) that resolve the vulnerability.'
                )
                .optional(),
              vulnerable_functions: z
                .array(z.string())
                .describe('The functions in the package that are affected.')
                .optional()
            })
            .strict()
        )
        .describe(
          'A product affected by the vulnerability detailed in a repository security advisory.'
        )
        .optional(),
      cwe_ids: z
        .array(z.string())
        .describe('A list of Common Weakness Enumeration (CWE) IDs.')
        .optional(),
      credits: z
        .array(
          z
            .object({
              login: z.string().describe('The username of the user credited.'),
              type: SecurityAdvisoryCreditTypesSchema
            })
            .strict()
        )
        .describe(
          'A list of users receiving credit for their participation in the security advisory.'
        )
        .optional(),
      severity: z
        .enum(['critical', 'high', 'medium', 'low'])
        .describe(
          'The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.'
        )
        .optional(),
      cvss_vector_string: z
        .string()
        .describe(
          'The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.'
        )
        .optional(),
      state: z
        .enum(['published', 'closed', 'draft'])
        .describe('The state of the advisory.')
        .optional(),
      collaborating_users: z
        .array(z.string())
        .describe(
          'A list of usernames who have been granted write access to the advisory.'
        )
        .optional(),
      collaborating_teams: z
        .array(z.string())
        .describe(
          'A list of team slugs which have been granted write access to the advisory.'
        )
        .optional()
    })
    .strict()
  export type RepositoryAdvisoryUpdate = z.infer<
    typeof RepositoryAdvisoryUpdateSchema
  >

  export const UserMarketplacePurchaseSchema = z
    .object({
      billing_cycle: z.string(),
      next_billing_date: z.string().datetime({ offset: true }),
      unit_count: z.number().int(),
      on_free_trial: z.boolean(),
      free_trial_ends_on: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      account: MarketplaceAccountSchema,
      plan: MarketplaceListingPlanSchema
    })
    .describe('User Marketplace Purchase')
  export type UserMarketplacePurchase = z.infer<
    typeof UserMarketplacePurchaseSchema
  >

  export const ClassroomAssignmentSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository.'),
      public_repo: z
        .boolean()
        .describe(
          'Whether an accepted assignment creates a public repository.'
        ),
      title: z.string().describe('Assignment title.'),
      type: z
        .enum(['individual', 'group'])
        .describe("Whether it's a group assignment or individual assignment."),
      invite_link: z
        .string()
        .describe('The link that a student can use to accept the assignment.'),
      invitations_enabled: z
        .boolean()
        .describe(
          'Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.'
        ),
      slug: z.string().describe('Sluggified name of the assignment.'),
      students_are_repo_admins: z
        .boolean()
        .describe(
          'Whether students are admins on created repository when a student accepts the assignment.'
        ),
      feedback_pull_requests_enabled: z
        .boolean()
        .describe(
          'Whether feedback pull request will be created when a student accepts the assignment.'
        ),
      max_teams: z
        .number()
        .int()
        .describe('The maximum allowable teams for the assignment.'),
      max_members: z
        .number()
        .int()
        .describe('The maximum allowable members per team.'),
      editor: z.string().describe('The selected editor for the assignment.'),
      accepted: z
        .number()
        .int()
        .describe('The number of students that have accepted the assignment.'),
      submitted: z
        .number()
        .int()
        .describe('The number of students that have submitted the assignment.'),
      passing: z
        .number()
        .int()
        .describe('The number of students that have passed the assignment.'),
      language: z
        .string()
        .describe('The programming language used in the assignment.'),
      deadline: z
        .string()
        .datetime({ offset: true })
        .describe('The time at which the assignment is due.'),
      starter_code_repository: SimpleClassroomRepositorySchema,
      classroom: ClassroomSchema
    })
    .describe('A GitHub Classroom assignment')
  export type ClassroomAssignment = z.infer<typeof ClassroomAssignmentSchema>

  export const MinimalRepositorySchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      full_name: z.string(),
      owner: SimpleUserSchema,
      private: z.boolean(),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string().optional(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string().optional(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string().optional(),
      mirror_url: z.string().optional(),
      hooks_url: z.string().url(),
      svn_url: z.string().optional(),
      homepage: z.string().optional(),
      language: z.string().optional(),
      forks_count: z.number().int().optional(),
      stargazers_count: z.number().int().optional(),
      watchers_count: z.number().int().optional(),
      size: z
        .number()
        .int()
        .describe(
          'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
        )
        .optional(),
      default_branch: z.string().optional(),
      open_issues_count: z.number().int().optional(),
      is_template: z.boolean().optional(),
      topics: z.array(z.string()).optional(),
      has_issues: z.boolean().optional(),
      has_projects: z.boolean().optional(),
      has_wiki: z.boolean().optional(),
      has_pages: z.boolean().optional(),
      has_downloads: z.boolean().optional(),
      has_discussions: z.boolean().optional(),
      archived: z.boolean().optional(),
      disabled: z.boolean().optional(),
      visibility: z.string().optional(),
      pushed_at: z.string().datetime({ offset: true }).optional(),
      created_at: z.string().datetime({ offset: true }).optional(),
      updated_at: z.string().datetime({ offset: true }).optional(),
      permissions: z
        .object({
          admin: z.boolean().optional(),
          maintain: z.boolean().optional(),
          push: z.boolean().optional(),
          triage: z.boolean().optional(),
          pull: z.boolean().optional()
        })
        .optional(),
      role_name: z.string().optional(),
      temp_clone_token: z.string().optional(),
      delete_branch_on_merge: z.boolean().optional(),
      subscribers_count: z.number().int().optional(),
      network_count: z.number().int().optional(),
      code_of_conduct: CodeOfConductSchema.optional(),
      license: z
        .object({
          key: z.string().optional(),
          name: z.string().optional(),
          spdx_id: z.string().optional(),
          url: z.string().optional(),
          node_id: z.string().optional()
        })
        .optional(),
      forks: z.number().int().optional(),
      open_issues: z.number().int().optional(),
      watchers: z.number().int().optional(),
      allow_forking: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional(),
      security_and_analysis: SecurityAndAnalysisSchema.optional()
    })
    .describe('Minimal Repository')
  export type MinimalRepository = z.infer<typeof MinimalRepositorySchema>

  export const ActionsHostedRunnerSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('The unique identifier of the hosted runner.'),
      name: z.string().describe('The name of the hosted runner.'),
      runner_group_id: z
        .number()
        .int()
        .describe(
          'The unique identifier of the group that the hosted runner belongs to.'
        )
        .optional(),
      image_details: NullableActionsHostedRunnerPoolImageSchema,
      machine_size_details: ActionsHostedRunnerMachineSpecSchema,
      status: z
        .enum(['Ready', 'Provisioning', 'Shutdown', 'Deleting', 'Stuck'])
        .describe('The status of the runner.'),
      platform: z.string().describe('The operating system of the image.'),
      maximum_runners: z
        .number()
        .int()
        .describe(
          'The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.'
        )
        .default(10),
      public_ip_enabled: z
        .boolean()
        .describe('Whether public IP is enabled for the hosted runners.'),
      public_ips: z
        .array(PublicIpSchema)
        .describe(
          'The public IP ranges when public IP is enabled for the hosted runners.'
        )
        .optional(),
      last_active_on: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time at which the runner was last used, in ISO 8601 format.'
        )
        .optional()
    })
    .describe('A Github-hosted hosted runner.')
  export type ActionsHostedRunner = z.infer<typeof ActionsHostedRunnerSchema>

  export const ActionsOrganizationPermissionsSchema = z.object({
    enabled_repositories: EnabledRepositoriesSchema,
    selected_repositories_url: z
      .string()
      .describe(
        'The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`.'
      )
      .optional(),
    allowed_actions: AllowedActionsSchema.optional(),
    selected_actions_url: SelectedActionsUrlSchema.optional()
  })
  export type ActionsOrganizationPermissions = z.infer<
    typeof ActionsOrganizationPermissionsSchema
  >

  export const ActionsRunnerJitconfigSchema = z.any().describe('Response')
  export type ActionsRunnerJitconfig = z.infer<
    typeof ActionsRunnerJitconfigSchema
  >

  export const AuthenticationTokenSchema = z
    .object({
      token: z.string().describe('The token used for authentication'),
      expires_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time this token expires'),
      permissions: z.record(z.any()).optional(),
      repositories: z
        .array(RepositorySchema)
        .describe('The repositories this token has access to')
        .optional(),
      single_file: z.string().optional(),
      repository_selection: z
        .enum(['all', 'selected'])
        .describe(
          "Describe whether all repositories have been selected or there's a selection involved"
        )
        .optional()
    })
    .describe('Authentication Token')
  export type AuthenticationToken = z.infer<typeof AuthenticationTokenSchema>

  export const CodeScanningAnalysisToolSchema = z.object({
    name: CodeScanningAnalysisToolNameSchema.optional(),
    version: CodeScanningAnalysisToolVersionSchema.optional(),
    guid: CodeScanningAnalysisToolGuidSchema.optional()
  })
  export type CodeScanningAnalysisTool = z.infer<
    typeof CodeScanningAnalysisToolSchema
  >

  export const NullableMinimalRepositorySchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      full_name: z.string(),
      owner: SimpleUserSchema,
      private: z.boolean(),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string().optional(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string().optional(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string().optional(),
      mirror_url: z.string().optional(),
      hooks_url: z.string().url(),
      svn_url: z.string().optional(),
      homepage: z.string().optional(),
      language: z.string().optional(),
      forks_count: z.number().int().optional(),
      stargazers_count: z.number().int().optional(),
      watchers_count: z.number().int().optional(),
      size: z
        .number()
        .int()
        .describe(
          'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
        )
        .optional(),
      default_branch: z.string().optional(),
      open_issues_count: z.number().int().optional(),
      is_template: z.boolean().optional(),
      topics: z.array(z.string()).optional(),
      has_issues: z.boolean().optional(),
      has_projects: z.boolean().optional(),
      has_wiki: z.boolean().optional(),
      has_pages: z.boolean().optional(),
      has_downloads: z.boolean().optional(),
      has_discussions: z.boolean().optional(),
      archived: z.boolean().optional(),
      disabled: z.boolean().optional(),
      visibility: z.string().optional(),
      pushed_at: z.string().datetime({ offset: true }).optional(),
      created_at: z.string().datetime({ offset: true }).optional(),
      updated_at: z.string().datetime({ offset: true }).optional(),
      permissions: z
        .object({
          admin: z.boolean().optional(),
          maintain: z.boolean().optional(),
          push: z.boolean().optional(),
          triage: z.boolean().optional(),
          pull: z.boolean().optional()
        })
        .optional(),
      role_name: z.string().optional(),
      temp_clone_token: z.string().optional(),
      delete_branch_on_merge: z.boolean().optional(),
      subscribers_count: z.number().int().optional(),
      network_count: z.number().int().optional(),
      code_of_conduct: CodeOfConductSchema.optional(),
      license: z
        .object({
          key: z.string().optional(),
          name: z.string().optional(),
          spdx_id: z.string().optional(),
          url: z.string().optional(),
          node_id: z.string().optional()
        })
        .optional(),
      forks: z.number().int().optional(),
      open_issues: z.number().int().optional(),
      watchers: z.number().int().optional(),
      allow_forking: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional(),
      security_and_analysis: SecurityAndAnalysisSchema.optional()
    })
    .describe('Minimal Repository')
  export type NullableMinimalRepository = z.infer<
    typeof NullableMinimalRepositorySchema
  >

  export const ActionsRepositoryPermissionsSchema = z.object({
    enabled: ActionsEnabledSchema,
    allowed_actions: AllowedActionsSchema.optional(),
    selected_actions_url: SelectedActionsUrlSchema.optional()
  })
  export type ActionsRepositoryPermissions = z.infer<
    typeof ActionsRepositoryPermissionsSchema
  >

  export const DeploymentSimpleSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int().describe('Unique identifier of the deployment'),
      node_id: z.string(),
      task: z.string().describe('Parameter to specify a task to execute'),
      original_environment: z.string().optional(),
      environment: z
        .string()
        .describe('Name for the target deployment environment.'),
      description: z.string(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      statuses_url: z.string().url(),
      repository_url: z.string().url(),
      transient_environment: z
        .boolean()
        .describe(
          'Specifies if the given environment is will no longer exist at some point in the future. Default: false.'
        )
        .optional(),
      production_environment: z
        .boolean()
        .describe(
          'Specifies if the given environment is one that end-users directly interact with. Default: false.'
        )
        .optional(),
      performed_via_github_app: NullableIntegrationSchema.optional()
    })
    .describe(
      'A deployment created as the result of an Actions check run from a workflow that references an environment'
    )
  export type DeploymentSimple = z.infer<typeof DeploymentSimpleSchema>

  export const CodeScanningAutofixSchema = z.object({
    status: CodeScanningAutofixStatusSchema,
    description: CodeScanningAutofixDescriptionSchema,
    started_at: CodeScanningAutofixStartedAtSchema
  })
  export type CodeScanningAutofix = z.infer<typeof CodeScanningAutofixSchema>

  export const CodeScanningVariantAnalysisRepoTaskSchema = z.object({
    repository: SimpleRepositorySchema,
    analysis_status: CodeScanningVariantAnalysisStatusSchema,
    artifact_size_in_bytes: z
      .number()
      .int()
      .describe(
        'The size of the artifact. This is only available for successful analyses.'
      )
      .optional(),
    result_count: z
      .number()
      .int()
      .describe(
        'The number of results in the case of a successful analysis. This is only available for successful analyses.'
      )
      .optional(),
    failure_message: z
      .string()
      .describe(
        'The reason of the failure of this repo task. This is only available if the repository task has failed.'
      )
      .optional(),
    database_commit_sha: z
      .string()
      .describe(
        'The SHA of the commit the CodeQL database was built against. This is only available for successful analyses.'
      )
      .optional(),
    source_location_prefix: z
      .string()
      .describe(
        'The source location prefix to use. This is only available for successful analyses.'
      )
      .optional(),
    artifact_url: z
      .string()
      .describe(
        'The URL of the artifact. This is only available for successful analyses.'
      )
      .optional()
  })
  export type CodeScanningVariantAnalysisRepoTask = z.infer<
    typeof CodeScanningVariantAnalysisRepoTaskSchema
  >

  export const CommitCommentSchema = z
    .object({
      html_url: z.string().url(),
      url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      body: z.string(),
      path: z.string(),
      position: z.number().int(),
      line: z.number().int(),
      commit_id: z.string(),
      user: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      author_association: AuthorAssociationSchema,
      reactions: ReactionRollupSchema.optional()
    })
    .describe('Commit Comment')
  export type CommitComment = z.infer<typeof CommitCommentSchema>

  export const CommunityProfileSchema = z
    .object({
      health_percentage: z.number().int(),
      description: z.string(),
      documentation: z.string(),
      files: z.object({
        code_of_conduct: NullableCodeOfConductSimpleSchema,
        code_of_conduct_file: NullableCommunityHealthFileSchema,
        license: NullableLicenseSimpleSchema,
        contributing: NullableCommunityHealthFileSchema,
        readme: NullableCommunityHealthFileSchema,
        issue_template: NullableCommunityHealthFileSchema,
        pull_request_template: NullableCommunityHealthFileSchema
      }),
      updated_at: z.string().datetime({ offset: true }),
      content_reports_enabled: z.boolean().optional()
    })
    .describe('Community Profile')
  export type CommunityProfile = z.infer<typeof CommunityProfileSchema>

  export const SnapshotSchema = z
    .object({
      version: z
        .number()
        .int()
        .describe('The version of the repository snapshot submission.'),
      job: z
        .object({
          id: z.string().describe('The external ID of the job.'),
          correlator: z
            .string()
            .describe(
              'Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository\'s current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you\'re using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you\'re using a build matrix, then you\'ll also need to add additional key(s) to distinguish between each submission inside a matrix variation.'
            ),
          html_url: z.string().describe('The url for the job.').optional()
        })
        .strict(),
      sha: z
        .string()
        .min(40)
        .max(40)
        .describe(
          'The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.'
        ),
      ref: z
        .string()
        .regex(new RegExp('^refs/'))
        .describe('The repository branch that triggered this snapshot.'),
      detector: z
        .object({
          name: z.string().describe('The name of the detector used.'),
          version: z.string().describe('The version of the detector used.'),
          url: z.string().describe('The url of the detector used.')
        })
        .strict()
        .describe('A description of the detector used.'),
      metadata: MetadataSchema.optional(),
      manifests: z
        .record(ManifestSchema)
        .describe(
          'A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.'
        )
        .optional(),
      scanned: z
        .string()
        .datetime({ offset: true })
        .describe('The time at which the snapshot was scanned.')
    })
    .strict()
    .describe("Create a new snapshot of a repository's dependencies.")
  export type Snapshot = z.infer<typeof SnapshotSchema>

  export const LabeledIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      label: z.object({ name: z.string(), color: z.string() })
    })
    .describe('Labeled Issue Event')
  export type LabeledIssueEvent = z.infer<typeof LabeledIssueEventSchema>

  export const UnlabeledIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      label: z.object({ name: z.string(), color: z.string() })
    })
    .describe('Unlabeled Issue Event')
  export type UnlabeledIssueEvent = z.infer<typeof UnlabeledIssueEventSchema>

  export const AssignedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: IntegrationSchema,
      assignee: SimpleUserSchema,
      assigner: SimpleUserSchema
    })
    .describe('Assigned Issue Event')
  export type AssignedIssueEvent = z.infer<typeof AssignedIssueEventSchema>

  export const UnassignedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      assignee: SimpleUserSchema,
      assigner: SimpleUserSchema
    })
    .describe('Unassigned Issue Event')
  export type UnassignedIssueEvent = z.infer<typeof UnassignedIssueEventSchema>

  export const MilestonedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      milestone: z.object({ title: z.string() })
    })
    .describe('Milestoned Issue Event')
  export type MilestonedIssueEvent = z.infer<typeof MilestonedIssueEventSchema>

  export const DemilestonedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      milestone: z.object({ title: z.string() })
    })
    .describe('Demilestoned Issue Event')
  export type DemilestonedIssueEvent = z.infer<
    typeof DemilestonedIssueEventSchema
  >

  export const RenamedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      rename: z.object({ from: z.string(), to: z.string() })
    })
    .describe('Renamed Issue Event')
  export type RenamedIssueEvent = z.infer<typeof RenamedIssueEventSchema>

  export const ReviewDismissedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      dismissed_review: z.object({
        state: z.string(),
        review_id: z.number().int(),
        dismissal_message: z.string(),
        dismissal_commit_id: z.string().optional()
      })
    })
    .describe('Review Dismissed Issue Event')
  export type ReviewDismissedIssueEvent = z.infer<
    typeof ReviewDismissedIssueEventSchema
  >

  export const LockedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      lock_reason: z.string()
    })
    .describe('Locked Issue Event')
  export type LockedIssueEvent = z.infer<typeof LockedIssueEventSchema>

  export const AddedToProjectIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      project_card: z
        .object({
          id: z.number().int(),
          url: z.string().url(),
          project_id: z.number().int(),
          project_url: z.string().url(),
          column_name: z.string(),
          previous_column_name: z.string().optional()
        })
        .optional()
    })
    .describe('Added to Project Issue Event')
  export type AddedToProjectIssueEvent = z.infer<
    typeof AddedToProjectIssueEventSchema
  >

  export const MovedColumnInProjectIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      project_card: z
        .object({
          id: z.number().int(),
          url: z.string().url(),
          project_id: z.number().int(),
          project_url: z.string().url(),
          column_name: z.string(),
          previous_column_name: z.string().optional()
        })
        .optional()
    })
    .describe('Moved Column in Project Issue Event')
  export type MovedColumnInProjectIssueEvent = z.infer<
    typeof MovedColumnInProjectIssueEventSchema
  >

  export const RemovedFromProjectIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      project_card: z
        .object({
          id: z.number().int(),
          url: z.string().url(),
          project_id: z.number().int(),
          project_url: z.string().url(),
          column_name: z.string(),
          previous_column_name: z.string().optional()
        })
        .optional()
    })
    .describe('Removed from Project Issue Event')
  export type RemovedFromProjectIssueEvent = z.infer<
    typeof RemovedFromProjectIssueEventSchema
  >

  export const ConvertedNoteToIssueIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: IntegrationSchema,
      project_card: z
        .object({
          id: z.number().int(),
          url: z.string().url(),
          project_id: z.number().int(),
          project_url: z.string().url(),
          column_name: z.string(),
          previous_column_name: z.string().optional()
        })
        .optional()
    })
    .describe('Converted Note to Issue Issue Event')
  export type ConvertedNoteToIssueIssueEvent = z.infer<
    typeof ConvertedNoteToIssueIssueEventSchema
  >

  export const PullRequestReviewCommentSchema = z
    .object({
      url: z.string().describe('URL for the pull request review comment'),
      pull_request_review_id: z
        .number()
        .int()
        .describe(
          'The ID of the pull request review to which the comment belongs.'
        ),
      id: z
        .number()
        .int()
        .describe('The ID of the pull request review comment.'),
      node_id: z
        .string()
        .describe('The node ID of the pull request review comment.'),
      diff_hunk: z
        .string()
        .describe('The diff of the line that the comment refers to.'),
      path: z
        .string()
        .describe(
          'The relative path of the file to which the comment applies.'
        ),
      position: z
        .number()
        .int()
        .describe(
          'The line index in the diff to which the comment applies. This field is closing down; use `line` instead.'
        )
        .optional(),
      original_position: z
        .number()
        .int()
        .describe(
          'The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.'
        )
        .optional(),
      commit_id: z
        .string()
        .describe('The SHA of the commit to which the comment applies.'),
      original_commit_id: z
        .string()
        .describe(
          'The SHA of the original commit to which the comment applies.'
        ),
      in_reply_to_id: z
        .number()
        .int()
        .describe('The comment ID to reply to.')
        .optional(),
      user: SimpleUserSchema,
      body: z.string().describe('The text of the comment.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      html_url: z
        .string()
        .url()
        .describe('HTML URL for the pull request review comment.'),
      pull_request_url: z
        .string()
        .url()
        .describe(
          'URL for the pull request that the review comment belongs to.'
        ),
      author_association: AuthorAssociationSchema,
      _links: z.object({
        self: z.object({ href: z.string().url() }),
        html: z.object({ href: z.string().url() }),
        pull_request: z.object({ href: z.string().url() })
      }),
      start_line: z
        .number()
        .int()
        .describe('The first line of the range for a multi-line comment.')
        .optional(),
      original_start_line: z
        .number()
        .int()
        .describe('The first line of the range for a multi-line comment.')
        .optional(),
      start_side: z
        .enum(['LEFT', 'RIGHT'])
        .describe(
          'The side of the first line of the range for a multi-line comment.'
        )
        .default('RIGHT'),
      line: z
        .number()
        .int()
        .describe(
          'The line of the blob to which the comment applies. The last line of the range for a multi-line comment'
        )
        .optional(),
      original_line: z
        .number()
        .int()
        .describe(
          'The line of the blob to which the comment applies. The last line of the range for a multi-line comment'
        )
        .optional(),
      side: z
        .enum(['LEFT', 'RIGHT'])
        .describe(
          'The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment'
        )
        .default('RIGHT'),
      subject_type: z
        .enum(['line', 'file'])
        .describe(
          'The level at which the comment is targeted, can be a diff line or a file.'
        )
        .optional(),
      reactions: ReactionRollupSchema.optional(),
      body_html: z.string().optional(),
      body_text: z.string().optional()
    })
    .describe(
      "Pull Request Review Comments are comments on a portion of the Pull Request's diff."
    )
  export type PullRequestReviewComment = z.infer<
    typeof PullRequestReviewCommentSchema
  >

  export const TimelineAssignedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      assignee: SimpleUserSchema
    })
    .describe('Timeline Assigned Issue Event')
  export type TimelineAssignedIssueEvent = z.infer<
    typeof TimelineAssignedIssueEventSchema
  >

  export const TimelineUnassignedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      assignee: SimpleUserSchema
    })
    .describe('Timeline Unassigned Issue Event')
  export type TimelineUnassignedIssueEvent = z.infer<
    typeof TimelineUnassignedIssueEventSchema
  >

  export const StateChangeIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      state_reason: z.string().optional()
    })
    .describe('State Change Issue Event')
  export type StateChangeIssueEvent = z.infer<
    typeof StateChangeIssueEventSchema
  >

  export const PullRequestReviewRequestSchema = z
    .object({ users: z.array(SimpleUserSchema), teams: z.array(TeamSchema) })
    .describe('Pull Request Review Request')
  export type PullRequestReviewRequest = z.infer<
    typeof PullRequestReviewRequestSchema
  >

  export const RepoSearchResultItemSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      full_name: z.string(),
      owner: NullableSimpleUserSchema,
      private: z.boolean(),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      pushed_at: z.string().datetime({ offset: true }),
      homepage: z.string().url(),
      size: z.number().int(),
      stargazers_count: z.number().int(),
      watchers_count: z.number().int(),
      language: z.string(),
      forks_count: z.number().int(),
      open_issues_count: z.number().int(),
      master_branch: z.string().optional(),
      default_branch: z.string(),
      score: z.number(),
      forks_url: z.string().url(),
      keys_url: z.string(),
      collaborators_url: z.string(),
      teams_url: z.string().url(),
      hooks_url: z.string().url(),
      issue_events_url: z.string(),
      events_url: z.string().url(),
      assignees_url: z.string(),
      branches_url: z.string(),
      tags_url: z.string().url(),
      blobs_url: z.string(),
      git_tags_url: z.string(),
      git_refs_url: z.string(),
      trees_url: z.string(),
      statuses_url: z.string(),
      languages_url: z.string().url(),
      stargazers_url: z.string().url(),
      contributors_url: z.string().url(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      commits_url: z.string(),
      git_commits_url: z.string(),
      comments_url: z.string(),
      issue_comment_url: z.string(),
      contents_url: z.string(),
      compare_url: z.string(),
      merges_url: z.string().url(),
      archive_url: z.string(),
      downloads_url: z.string().url(),
      issues_url: z.string(),
      pulls_url: z.string(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      labels_url: z.string(),
      releases_url: z.string(),
      deployments_url: z.string().url(),
      git_url: z.string(),
      ssh_url: z.string(),
      clone_url: z.string(),
      svn_url: z.string().url(),
      forks: z.number().int(),
      open_issues: z.number().int(),
      watchers: z.number().int(),
      topics: z.array(z.string()).optional(),
      mirror_url: z.string().url(),
      has_issues: z.boolean(),
      has_projects: z.boolean(),
      has_pages: z.boolean(),
      has_wiki: z.boolean(),
      has_downloads: z.boolean(),
      has_discussions: z.boolean().optional(),
      archived: z.boolean(),
      disabled: z
        .boolean()
        .describe('Returns whether or not this repository disabled.'),
      visibility: z
        .string()
        .describe('The repository visibility: public, private, or internal.')
        .optional(),
      license: NullableLicenseSimpleSchema,
      permissions: z
        .object({
          admin: z.boolean(),
          maintain: z.boolean().optional(),
          push: z.boolean(),
          triage: z.boolean().optional(),
          pull: z.boolean()
        })
        .optional(),
      text_matches: SearchResultTextMatchesSchema.optional(),
      temp_clone_token: z.string().optional(),
      allow_merge_commit: z.boolean().optional(),
      allow_squash_merge: z.boolean().optional(),
      allow_rebase_merge: z.boolean().optional(),
      allow_auto_merge: z.boolean().optional(),
      delete_branch_on_merge: z.boolean().optional(),
      allow_forking: z.boolean().optional(),
      is_template: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional()
    })
    .describe('Repo Search Result Item')
  export type RepoSearchResultItem = z.infer<typeof RepoSearchResultItemSchema>

  export const StarredRepositorySchema = z
    .object({
      starred_at: z.string().datetime({ offset: true }),
      repo: RepositorySchema
    })
    .describe('Starred Repository')
  export type StarredRepository = z.infer<typeof StarredRepositorySchema>

  export const WebhookConfigSchema = z
    .object({
      url: WebhookConfigUrlSchema.optional(),
      content_type: WebhookConfigContentTypeSchema.optional(),
      secret: WebhookConfigSecretSchema.optional(),
      insecure_ssl: WebhookConfigInsecureSslSchema.optional()
    })
    .describe('Configuration object of the webhook')
  export type WebhookConfig = z.infer<typeof WebhookConfigSchema>

  export const InstallationSchema = z
    .object({
      id: z.number().int().describe('The ID of the installation.'),
      account: z.union([SimpleUserSchema, EnterpriseSchema]),
      repository_selection: z
        .enum(['all', 'selected'])
        .describe(
          "Describe whether all repositories have been selected or there's a selection involved"
        ),
      access_tokens_url: z.string().url(),
      repositories_url: z.string().url(),
      html_url: z.string().url(),
      app_id: z.number().int(),
      target_id: z
        .number()
        .int()
        .describe(
          'The ID of the user or organization this token is being scoped to.'
        ),
      target_type: z.string(),
      permissions: AppPermissionsSchema,
      events: z.array(z.string()),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      single_file_name: z.string(),
      has_multiple_single_files: z.boolean().optional(),
      single_file_paths: z.array(z.string()).optional(),
      app_slug: z.string(),
      suspended_by: NullableSimpleUserSchema,
      suspended_at: z.string().datetime({ offset: true }),
      contact_email: z.string().optional()
    })
    .describe('Installation')
  export type Installation = z.infer<typeof InstallationSchema>

  export const InstallationTokenSchema = z
    .object({
      token: z.string(),
      expires_at: z.string(),
      permissions: AppPermissionsSchema.optional(),
      repository_selection: z.enum(['all', 'selected']).optional(),
      repositories: z.array(RepositorySchema).optional(),
      single_file: z.string().optional(),
      has_multiple_single_files: z.boolean().optional(),
      single_file_paths: z.array(z.string()).optional()
    })
    .describe(
      'Authentication token for a GitHub App installed on a user or org.'
    )
  export type InstallationToken = z.infer<typeof InstallationTokenSchema>

  export const AuthorizationSchema = z
    .object({
      id: z.number().int(),
      url: z.string().url(),
      scopes: z
        .array(z.string())
        .describe('A list of scopes that this authorization is in.'),
      token: z.string(),
      token_last_eight: z.string(),
      hashed_token: z.string(),
      app: z.object({
        client_id: z.string(),
        name: z.string(),
        url: z.string().url()
      }),
      note: z.string(),
      note_url: z.string().url(),
      updated_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      fingerprint: z.string(),
      user: NullableSimpleUserSchema.optional(),
      installation: NullableScopedInstallationSchema.optional(),
      expires_at: z.string().datetime({ offset: true })
    })
    .describe(
      'The authorization for an OAuth app, GitHub App, or a Personal Access Token.'
    )
  export type Authorization = z.infer<typeof AuthorizationSchema>

  export const ClassroomAcceptedAssignmentSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the repository.'),
      submitted: z
        .boolean()
        .describe('Whether an accepted assignment has been submitted.'),
      passing: z.boolean().describe('Whether a submission passed.'),
      commit_count: z.number().int().describe('Count of student commits.'),
      grade: z.string().describe('Most recent grade.'),
      students: z.array(SimpleClassroomUserSchema),
      repository: SimpleClassroomRepositorySchema,
      assignment: SimpleClassroomAssignmentSchema
    })
    .describe('A GitHub Classroom accepted assignment')
  export type ClassroomAcceptedAssignment = z.infer<
    typeof ClassroomAcceptedAssignmentSchema
  >

  export const DependabotAlertSecurityAdvisorySchema = z
    .object({
      ghsa_id: z
        .string()
        .describe(
          'The unique GitHub Security Advisory ID assigned to the advisory.'
        )
        .readonly(),
      cve_id: z
        .string()
        .describe('The unique CVE ID assigned to the advisory.')
        .readonly(),
      summary: z
        .string()
        .max(1024)
        .describe('A short, plain text summary of the advisory.')
        .readonly(),
      description: z
        .string()
        .describe('A long-form Markdown-supported description of the advisory.')
        .readonly(),
      vulnerabilities: z
        .array(DependabotAlertSecurityVulnerabilitySchema)
        .describe('Vulnerable version range information for the advisory.')
        .readonly(),
      severity: z
        .enum(['low', 'medium', 'high', 'critical'])
        .describe('The severity of the advisory.')
        .readonly(),
      cvss: z
        .object({
          score: z
            .number()
            .gte(0)
            .lte(10)
            .describe('The overall CVSS score of the advisory.')
            .readonly(),
          vector_string: z
            .string()
            .describe('The full CVSS vector string for the advisory.')
            .readonly()
        })
        .strict()
        .describe(
          'Details for the advisory pertaining to the Common Vulnerability Scoring System.'
        )
        .readonly(),
      cvss_severities: CvssSeveritiesSchema.optional(),
      epss: SecurityAdvisoryEpssSchema.optional(),
      cwes: z
        .array(
          z
            .object({
              cwe_id: z.string().describe('The unique CWE ID.').readonly(),
              name: z
                .string()
                .describe('The short, plain text name of the CWE.')
                .readonly()
            })
            .strict()
            .describe('A CWE weakness assigned to the advisory.')
            .readonly()
        )
        .describe(
          'Details for the advisory pertaining to Common Weakness Enumeration.'
        )
        .readonly(),
      identifiers: z
        .array(
          z
            .object({
              type: z
                .enum(['CVE', 'GHSA'])
                .describe('The type of advisory identifier.')
                .readonly(),
              value: z
                .string()
                .describe('The value of the advisory identifer.')
                .readonly()
            })
            .strict()
            .describe('An advisory identifier.')
            .readonly()
        )
        .describe(
          'Values that identify this advisory among security information sources.'
        )
        .readonly(),
      references: z
        .array(
          z
            .object({
              url: z
                .string()
                .url()
                .describe('The URL of the reference.')
                .readonly()
            })
            .strict()
            .describe('A link to additional advisory information.')
            .readonly()
        )
        .describe('Links to additional advisory information.')
        .readonly(),
      published_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .readonly(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .readonly(),
      withdrawn_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .readonly()
    })
    .strict()
    .describe('Details for the GitHub Security Advisory.')
    .readonly()
  export type DependabotAlertSecurityAdvisory = z.infer<
    typeof DependabotAlertSecurityAdvisorySchema
  >

  export const GistSimpleSchema = z
    .object({
      forks: z
        .array(
          z.object({
            id: z.string().optional(),
            url: z.string().url().optional(),
            user: PublicUserSchema.optional(),
            created_at: z.string().datetime({ offset: true }).optional(),
            updated_at: z.string().datetime({ offset: true }).optional()
          })
        )
        .optional(),
      history: z.array(GistHistorySchema).optional(),
      fork_of: z
        .object({
          url: z.string().url(),
          forks_url: z.string().url(),
          commits_url: z.string().url(),
          id: z.string(),
          node_id: z.string(),
          git_pull_url: z.string().url(),
          git_push_url: z.string().url(),
          html_url: z.string().url(),
          files: z.record(
            z.object({
              filename: z.string().optional(),
              type: z.string().optional(),
              language: z.string().optional(),
              raw_url: z.string().optional(),
              size: z.number().int().optional()
            })
          ),
          public: z.boolean(),
          created_at: z.string().datetime({ offset: true }),
          updated_at: z.string().datetime({ offset: true }),
          description: z.string(),
          comments: z.number().int(),
          comments_enabled: z.boolean().optional(),
          user: NullableSimpleUserSchema,
          comments_url: z.string().url(),
          owner: NullableSimpleUserSchema.optional(),
          truncated: z.boolean().optional(),
          forks: z.array(z.any()).optional(),
          history: z.array(z.any()).optional()
        })
        .describe('Gist')
        .optional(),
      url: z.string().optional(),
      forks_url: z.string().optional(),
      commits_url: z.string().optional(),
      id: z.string().optional(),
      node_id: z.string().optional(),
      git_pull_url: z.string().optional(),
      git_push_url: z.string().optional(),
      html_url: z.string().optional(),
      files: z
        .record(
          z.object({
            filename: z.string().optional(),
            type: z.string().optional(),
            language: z.string().optional(),
            raw_url: z.string().optional(),
            size: z.number().int().optional(),
            truncated: z.boolean().optional(),
            content: z.string().optional(),
            encoding: z
              .string()
              .describe(
                'The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.'
              )
              .default('utf-8')
          })
        )
        .optional(),
      public: z.boolean().optional(),
      created_at: z.string().optional(),
      updated_at: z.string().optional(),
      description: z.string().optional(),
      comments: z.number().int().optional(),
      comments_enabled: z.boolean().optional(),
      user: z.string().optional(),
      comments_url: z.string().optional(),
      owner: SimpleUserSchema.optional(),
      truncated: z.boolean().optional()
    })
    .describe('Gist Simple')
  export type GistSimple = z.infer<typeof GistSimpleSchema>

  export const ThreadSchema = z
    .object({
      id: z.string(),
      repository: MinimalRepositorySchema,
      subject: z.object({
        title: z.string(),
        url: z.string(),
        latest_comment_url: z.string(),
        type: z.string()
      }),
      reason: z.string(),
      unread: z.boolean(),
      updated_at: z.string(),
      last_read_at: z.string(),
      url: z.string(),
      subscription_url: z.string()
    })
    .describe('Thread')
  export type Thread = z.infer<typeof ThreadSchema>

  export const CopilotUsageMetricsDaySchema = z
    .object({
      date: z
        .string()
        .date()
        .describe(
          'The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format.'
        ),
      total_active_users: z
        .number()
        .int()
        .describe(
          'The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.'
        )
        .optional(),
      total_engaged_users: z
        .number()
        .int()
        .describe(
          'The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.'
        )
        .optional(),
      copilot_ide_code_completions: CopilotIdeCodeCompletionsSchema.optional(),
      copilot_ide_chat: CopilotIdeChatSchema.optional(),
      copilot_dotcom_chat: CopilotDotcomChatSchema.optional(),
      copilot_dotcom_pull_requests: CopilotDotcomPullRequestsSchema.optional()
    })
    .catchall(z.any())
    .describe('Copilot usage metrics for a given day.')
  export type CopilotUsageMetricsDay = z.infer<
    typeof CopilotUsageMetricsDaySchema
  >

  export const MigrationSchema = z
    .object({
      id: z.number().int(),
      owner: NullableSimpleUserSchema,
      guid: z.string(),
      state: z.string(),
      lock_repositories: z.boolean(),
      exclude_metadata: z.boolean(),
      exclude_git_data: z.boolean(),
      exclude_attachments: z.boolean(),
      exclude_releases: z.boolean(),
      exclude_owner_projects: z.boolean(),
      org_metadata_only: z.boolean(),
      repositories: z
        .array(RepositorySchema)
        .describe(
          'The repositories included in the migration. Only returned for export migrations.'
        ),
      url: z.string().url(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      node_id: z.string(),
      archive_url: z.string().url().optional(),
      exclude: z
        .array(
          z
            .string()
            .describe(
              'Allowed values that can be passed to the exclude parameter. The array can include any of: `"repositories"`.'
            )
        )
        .describe(
          'Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.'
        )
        .optional()
    })
    .describe('A migration.')
  export type Migration = z.infer<typeof MigrationSchema>

  export const PendingDeploymentSchema = z
    .object({
      environment: z.object({
        id: z.number().int().describe('The id of the environment.').optional(),
        node_id: z.string().optional(),
        name: z.string().describe('The name of the environment.').optional(),
        url: z.string().optional(),
        html_url: z.string().optional()
      }),
      wait_timer: z
        .number()
        .int()
        .describe('The set duration of the wait timer'),
      wait_timer_started_at: z
        .string()
        .datetime({ offset: true })
        .describe('The time that the wait timer began.'),
      current_user_can_approve: z
        .boolean()
        .describe(
          'Whether the currently authenticated user can approve the deployment'
        ),
      reviewers: z
        .array(
          z.object({
            type: DeploymentReviewerTypeSchema.optional(),
            reviewer: z.union([SimpleUserSchema, TeamSchema]).optional()
          })
        )
        .describe(
          'The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.'
        )
    })
    .describe(
      'Details of a deployment that is waiting for protection rules to pass'
    )
  export type PendingDeployment = z.infer<typeof PendingDeploymentSchema>

  export const DeploymentSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int().describe('Unique identifier of the deployment'),
      node_id: z.string(),
      sha: z.string(),
      ref: z
        .string()
        .describe('The ref to deploy. This can be a branch, tag, or sha.'),
      task: z.string().describe('Parameter to specify a task to execute'),
      payload: z.union([z.record(z.any()), z.string()]),
      original_environment: z.string().optional(),
      environment: z
        .string()
        .describe('Name for the target deployment environment.'),
      description: z.string(),
      creator: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      statuses_url: z.string().url(),
      repository_url: z.string().url(),
      transient_environment: z
        .boolean()
        .describe(
          'Specifies if the given environment is will no longer exist at some point in the future. Default: false.'
        )
        .optional(),
      production_environment: z
        .boolean()
        .describe(
          'Specifies if the given environment is one that end-users directly interact with. Default: false.'
        )
        .optional(),
      performed_via_github_app: NullableIntegrationSchema.optional()
    })
    .describe('A request for a specific ref(branch,sha,tag) to be deployed')
  export type Deployment = z.infer<typeof DeploymentSchema>

  export const CheckSuitePreferenceSchema = z
    .object({
      preferences: z.object({
        auto_trigger_checks: z
          .array(z.object({ app_id: z.number().int(), setting: z.boolean() }))
          .optional()
      }),
      repository: MinimalRepositorySchema
    })
    .describe('Check suite configuration preferences for a repository.')
  export type CheckSuitePreference = z.infer<typeof CheckSuitePreferenceSchema>

  export const DeploymentStatusSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      state: z
        .enum([
          'error',
          'failure',
          'inactive',
          'pending',
          'success',
          'queued',
          'in_progress'
        ])
        .describe('The state of the status.'),
      creator: NullableSimpleUserSchema,
      description: z
        .string()
        .max(140)
        .describe('A short description of the status.')
        .default(''),
      environment: z
        .string()
        .describe('The environment of the deployment that the status is for.')
        .default(''),
      target_url: z
        .string()
        .url()
        .describe('Closing down notice: the URL to associate with this status.')
        .default(''),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      deployment_url: z.string().url(),
      repository_url: z.string().url(),
      environment_url: z
        .string()
        .url()
        .describe('The URL for accessing your environment.')
        .default(''),
      log_url: z
        .string()
        .url()
        .describe('The URL to associate with this status.')
        .default(''),
      performed_via_github_app: NullableIntegrationSchema.optional()
    })
    .describe('The status of a deployment.')
  export type DeploymentStatus = z.infer<typeof DeploymentStatusSchema>

  export const TimelineLineCommentedEventSchema = z
    .object({
      event: z.string().optional(),
      node_id: z.string().optional(),
      comments: z.array(PullRequestReviewCommentSchema).optional()
    })
    .describe('Timeline Line Commented Event')
  export type TimelineLineCommentedEvent = z.infer<
    typeof TimelineLineCommentedEventSchema
  >

  export const TimelineCommitCommentedEventSchema = z
    .object({
      event: z.string().optional(),
      node_id: z.string().optional(),
      commit_id: z.string().optional(),
      comments: z.array(CommitCommentSchema).optional()
    })
    .describe('Timeline Commit Commented Event')
  export type TimelineCommitCommentedEvent = z.infer<
    typeof TimelineCommitCommentedEventSchema
  >

  export const ReviewCommentSchema = z
    .object({
      url: z.string().url(),
      pull_request_review_id: z.number().int(),
      id: z.number().int(),
      node_id: z.string(),
      diff_hunk: z.string(),
      path: z.string(),
      position: z.number().int(),
      original_position: z.number().int(),
      commit_id: z.string(),
      original_commit_id: z.string(),
      in_reply_to_id: z.number().int().optional(),
      user: NullableSimpleUserSchema,
      body: z.string(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      html_url: z.string().url(),
      pull_request_url: z.string().url(),
      author_association: AuthorAssociationSchema,
      _links: z.object({
        self: LinkSchema,
        html: LinkSchema,
        pull_request: LinkSchema
      }),
      body_text: z.string().optional(),
      body_html: z.string().optional(),
      reactions: ReactionRollupSchema.optional(),
      side: z
        .enum(['LEFT', 'RIGHT'])
        .describe(
          'The side of the first line of the range for a multi-line comment.'
        )
        .default('RIGHT'),
      start_side: z
        .enum(['LEFT', 'RIGHT'])
        .describe(
          'The side of the first line of the range for a multi-line comment.'
        )
        .default('RIGHT'),
      line: z
        .number()
        .int()
        .describe(
          'The line of the blob to which the comment applies. The last line of the range for a multi-line comment'
        )
        .optional(),
      original_line: z
        .number()
        .int()
        .describe(
          'The original line of the blob to which the comment applies. The last line of the range for a multi-line comment'
        )
        .optional(),
      start_line: z
        .number()
        .int()
        .describe('The first line of the range for a multi-line comment.')
        .optional(),
      original_start_line: z
        .number()
        .int()
        .describe(
          'The original first line of the range for a multi-line comment.'
        )
        .optional()
    })
    .describe('Legacy Review Comment')
  export type ReviewComment = z.infer<typeof ReviewCommentSchema>

  export const ReleaseSchema = z
    .object({
      url: z.string().url(),
      html_url: z.string().url(),
      assets_url: z.string().url(),
      upload_url: z.string(),
      tarball_url: z.string().url(),
      zipball_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      tag_name: z.string().describe('The name of the tag.'),
      target_commitish: z
        .string()
        .describe(
          'Specifies the commitish value that determines where the Git tag is created from.'
        ),
      name: z.string(),
      body: z.string().optional(),
      draft: z
        .boolean()
        .describe(
          'true to create a draft (unpublished) release, false to create a published one.'
        ),
      prerelease: z
        .boolean()
        .describe(
          'Whether to identify the release as a prerelease or a full release.'
        ),
      created_at: z.string().datetime({ offset: true }),
      published_at: z.string().datetime({ offset: true }),
      author: SimpleUserSchema,
      assets: z.array(ReleaseAssetSchema),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      mentions_count: z.number().int().optional(),
      discussion_url: z
        .string()
        .url()
        .describe('The URL of the release discussion.')
        .optional(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe('A release.')
  export type Release = z.infer<typeof ReleaseSchema>

  export const CodespaceSchema = z
    .object({
      id: z.number().int(),
      name: z
        .string()
        .describe('Automatically generated name of this codespace.'),
      display_name: z
        .string()
        .describe('Display name for this codespace.')
        .optional(),
      environment_id: z
        .string()
        .describe("UUID identifying this codespace's environment."),
      owner: SimpleUserSchema,
      billable_owner: SimpleUserSchema,
      repository: MinimalRepositorySchema,
      machine: NullableCodespaceMachineSchema,
      devcontainer_path: z
        .string()
        .describe(
          'Path to devcontainer.json from repo root used to create Codespace.'
        )
        .optional(),
      prebuild: z
        .boolean()
        .describe('Whether the codespace was created from a prebuild.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      last_used_at: z
        .string()
        .datetime({ offset: true })
        .describe('Last known time this codespace was started.'),
      state: z
        .enum([
          'Unknown',
          'Created',
          'Queued',
          'Provisioning',
          'Available',
          'Awaiting',
          'Unavailable',
          'Deleted',
          'Moved',
          'Shutdown',
          'Archived',
          'Starting',
          'ShuttingDown',
          'Failed',
          'Exporting',
          'Updating',
          'Rebuilding'
        ])
        .describe('State of this codespace.'),
      url: z.string().url().describe('API URL for this codespace.'),
      git_status: z
        .object({
          ahead: z
            .number()
            .int()
            .describe(
              'The number of commits the local repository is ahead of the remote.'
            )
            .optional(),
          behind: z
            .number()
            .int()
            .describe(
              'The number of commits the local repository is behind the remote.'
            )
            .optional(),
          has_unpushed_changes: z
            .boolean()
            .describe('Whether the local repository has unpushed changes.')
            .optional(),
          has_uncommitted_changes: z
            .boolean()
            .describe('Whether the local repository has uncommitted changes.')
            .optional(),
          ref: z
            .string()
            .describe(
              'The current branch (or SHA if in detached HEAD state) of the local repository.'
            )
            .optional()
        })
        .describe("Details about the codespace's git repository."),
      location: z
        .enum(['EastUs', 'SouthEastAsia', 'WestEurope', 'WestUs2'])
        .describe('The initally assigned location of a new codespace.'),
      idle_timeout_minutes: z
        .number()
        .int()
        .describe(
          'The number of minutes of inactivity after which this codespace will be automatically stopped.'
        ),
      web_url: z
        .string()
        .url()
        .describe('URL to access this codespace on the web.'),
      machines_url: z
        .string()
        .url()
        .describe(
          'API URL to access available alternate machine types for this codespace.'
        ),
      start_url: z.string().url().describe('API URL to start this codespace.'),
      stop_url: z.string().url().describe('API URL to stop this codespace.'),
      publish_url: z
        .string()
        .url()
        .describe('API URL to publish this codespace to a new repository.')
        .optional(),
      pulls_url: z
        .string()
        .url()
        .describe(
          'API URL for the Pull Request associated with this codespace, if any.'
        ),
      recent_folders: z.array(z.string()),
      runtime_constraints: z
        .object({
          allowed_port_privacy_settings: z
            .array(z.string())
            .describe(
              'The privacy settings a user can select from when forwarding a port.'
            )
            .optional()
        })
        .optional(),
      pending_operation: z
        .boolean()
        .describe(
          'Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.'
        )
        .optional(),
      pending_operation_disabled_reason: z
        .string()
        .describe(
          'Text to show user when codespace is disabled by a pending operation'
        )
        .optional(),
      idle_timeout_notice: z
        .string()
        .describe(
          'Text to show user when codespace idle timeout minutes has been overriden by an organization policy'
        )
        .optional(),
      retention_period_minutes: z
        .number()
        .int()
        .describe(
          'Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).'
        )
        .optional(),
      retention_expires_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"'
        )
        .optional(),
      last_known_stop_notice: z
        .string()
        .describe(
          'The text to display to a user when a codespace has been stopped for a potentially actionable reason.'
        )
        .optional()
    })
    .describe('A codespace.')
  export type Codespace = z.infer<typeof CodespaceSchema>

  export const CopilotSeatDetailsSchema = z
    .object({
      assignee: SimpleUserSchema,
      organization: NullableOrganizationSimpleSchema.optional(),
      assigning_team: z
        .union([TeamSchema, EnterpriseTeamSchema])
        .describe(
          'The team through which the assignee is granted access to GitHub Copilot, if applicable.'
        )
        .optional(),
      pending_cancellation_date: z
        .string()
        .date()
        .describe(
          "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle."
        )
        .optional(),
      last_activity_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format."
        )
        .optional(),
      last_activity_editor: z
        .string()
        .describe(
          'Last editor that was used by the user for a GitHub Copilot completion.'
        )
        .optional(),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.'
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format."
        )
        .optional(),
      plan_type: z
        .enum(['business', 'enterprise', 'unknown'])
        .describe(
          'The Copilot plan of the organization, or the parent enterprise, when applicable.'
        )
        .optional()
    })
    .strict()
    .describe(
      'Information about a Copilot Business seat assignment for a user, team, or organization.'
    )
  export type CopilotSeatDetails = z.infer<typeof CopilotSeatDetailsSchema>

  export const PackageSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the package.'),
      name: z.string().describe('The name of the package.'),
      package_type: z.enum([
        'npm',
        'maven',
        'rubygems',
        'docker',
        'nuget',
        'container'
      ]),
      url: z.string(),
      html_url: z.string(),
      version_count: z
        .number()
        .int()
        .describe('The number of versions of the package.'),
      visibility: z.enum(['private', 'public']),
      owner: NullableSimpleUserSchema.optional(),
      repository: NullableMinimalRepositorySchema.optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true })
    })
    .describe('A software package')
  export type Package = z.infer<typeof PackageSchema>

  export const OrgRulesetConditionsSchema = z
    .record(z.any())
    .and(
      z.union([
        z
          .record(z.any())
          .and(
            z.intersection(
              RepositoryRulesetConditionsSchema,
              RepositoryRulesetConditionsRepositoryNameTargetSchema
            )
          )
          .describe(
            'Conditions to target repositories by name and refs by name'
          ),
        z
          .record(z.any())
          .and(
            z.intersection(
              RepositoryRulesetConditionsSchema,
              RepositoryRulesetConditionsRepositoryIdTargetSchema
            )
          )
          .describe('Conditions to target repositories by id and refs by name'),
        z
          .record(z.any())
          .and(
            z.intersection(
              RepositoryRulesetConditionsSchema,
              RepositoryRulesetConditionsRepositoryPropertyTargetSchema
            )
          )
          .describe(
            'Conditions to target repositories by property and refs by name'
          )
      ])
    )
    .describe(
      'Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.'
    )
  export type OrgRulesetConditions = z.infer<typeof OrgRulesetConditionsSchema>

  export const ProtectedBranchPullRequestReviewSchema = z
    .object({
      url: z.string().url().optional(),
      dismissal_restrictions: z
        .object({
          users: z
            .array(SimpleUserSchema)
            .describe('The list of users with review dismissal access.')
            .optional(),
          teams: z
            .array(TeamSchema)
            .describe('The list of teams with review dismissal access.')
            .optional(),
          apps: z
            .array(IntegrationSchema)
            .describe('The list of apps with review dismissal access.')
            .optional(),
          url: z.string().optional(),
          users_url: z.string().optional(),
          teams_url: z.string().optional()
        })
        .optional(),
      bypass_pull_request_allowances: z
        .object({
          users: z
            .array(SimpleUserSchema)
            .describe(
              'The list of users allowed to bypass pull request requirements.'
            )
            .optional(),
          teams: z
            .array(TeamSchema)
            .describe(
              'The list of teams allowed to bypass pull request requirements.'
            )
            .optional(),
          apps: z
            .array(IntegrationSchema)
            .describe(
              'The list of apps allowed to bypass pull request requirements.'
            )
            .optional()
        })
        .describe(
          'Allow specific users, teams, or apps to bypass pull request requirements.'
        )
        .optional(),
      dismiss_stale_reviews: z.boolean(),
      require_code_owner_reviews: z.boolean(),
      required_approving_review_count: z
        .number()
        .int()
        .gte(0)
        .lte(6)
        .optional(),
      require_last_push_approval: z
        .boolean()
        .describe(
          'Whether the most recent push must be approved by someone other than the person who pushed it.'
        )
        .default(false)
    })
    .describe('Protected Branch Pull Request Review')
  export type ProtectedBranchPullRequestReview = z.infer<
    typeof ProtectedBranchPullRequestReviewSchema
  >

  export const CommitSchema = z
    .object({
      url: z.string().url(),
      sha: z.string(),
      node_id: z.string(),
      html_url: z.string().url(),
      comments_url: z.string().url(),
      commit: z.object({
        url: z.string().url(),
        author: NullableGitUserSchema,
        committer: NullableGitUserSchema,
        message: z.string(),
        comment_count: z.number().int(),
        tree: z.object({ sha: z.string(), url: z.string().url() }),
        verification: VerificationSchema.optional()
      }),
      author: z.union([SimpleUserSchema, EmptyObjectSchema]),
      committer: z.union([SimpleUserSchema, EmptyObjectSchema]),
      parents: z.array(
        z.object({
          sha: z.string(),
          url: z.string().url(),
          html_url: z.string().url().optional()
        })
      ),
      stats: z
        .object({
          additions: z.number().int().optional(),
          deletions: z.number().int().optional(),
          total: z.number().int().optional()
        })
        .optional(),
      files: z.array(DiffEntrySchema).optional()
    })
    .describe('Commit')
  export type Commit = z.infer<typeof CommitSchema>

  export const CheckRunSchema = z
    .object({
      id: z.number().int().describe('The id of the check.'),
      head_sha: z
        .string()
        .describe('The SHA of the commit that is being checked.'),
      node_id: z.string(),
      external_id: z.string(),
      url: z.string(),
      html_url: z.string(),
      details_url: z.string(),
      status: z
        .enum([
          'queued',
          'in_progress',
          'completed',
          'waiting',
          'requested',
          'pending'
        ])
        .describe(
          'The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.'
        ),
      conclusion: z.enum([
        'success',
        'failure',
        'neutral',
        'cancelled',
        'skipped',
        'timed_out',
        'action_required'
      ]),
      started_at: z.string().datetime({ offset: true }),
      completed_at: z.string().datetime({ offset: true }),
      output: z.object({
        title: z.string(),
        summary: z.string(),
        text: z.string(),
        annotations_count: z.number().int(),
        annotations_url: z.string().url()
      }),
      name: z.string().describe('The name of the check.'),
      check_suite: z.object({ id: z.number().int() }),
      app: NullableIntegrationSchema,
      pull_requests: z
        .array(PullRequestMinimalSchema)
        .describe(
          'Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.'
        ),
      deployment: DeploymentSimpleSchema.optional()
    })
    .describe('A check performed on the code of a given code change')
  export type CheckRun = z.infer<typeof CheckRunSchema>

  export const RepositoryInvitationSchema = z
    .object({
      id: z
        .number()
        .int()
        .describe('Unique identifier of the repository invitation.'),
      repository: MinimalRepositorySchema,
      invitee: NullableSimpleUserSchema,
      inviter: NullableSimpleUserSchema,
      permissions: z
        .enum(['read', 'write', 'admin', 'triage', 'maintain'])
        .describe('The permission associated with the invitation.'),
      created_at: z.string().datetime({ offset: true }),
      expired: z
        .boolean()
        .describe('Whether or not the invitation has expired')
        .optional(),
      url: z.string().describe('URL for the repository invitation'),
      html_url: z.string(),
      node_id: z.string()
    })
    .describe('Repository invitations let you manage who you collaborate with.')
  export type RepositoryInvitation = z.infer<typeof RepositoryInvitationSchema>

  export const CombinedCommitStatusSchema = z
    .object({
      state: z.string(),
      statuses: z.array(SimpleCommitStatusSchema),
      sha: z.string(),
      total_count: z.number().int(),
      repository: MinimalRepositorySchema,
      commit_url: z.string().url(),
      url: z.string().url()
    })
    .describe('Combined Commit Status')
  export type CombinedCommitStatus = z.infer<typeof CombinedCommitStatusSchema>

  export const ReviewRequestedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      review_requester: SimpleUserSchema,
      requested_team: TeamSchema.optional(),
      requested_reviewer: SimpleUserSchema.optional()
    })
    .describe('Review Requested Issue Event')
  export type ReviewRequestedIssueEvent = z.infer<
    typeof ReviewRequestedIssueEventSchema
  >

  export const ReviewRequestRemovedIssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string(),
      actor: SimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string(),
      performed_via_github_app: NullableIntegrationSchema,
      review_requester: SimpleUserSchema,
      requested_team: TeamSchema.optional(),
      requested_reviewer: SimpleUserSchema.optional()
    })
    .describe('Review Request Removed Issue Event')
  export type ReviewRequestRemovedIssueEvent = z.infer<
    typeof ReviewRequestRemovedIssueEventSchema
  >

  export const TimelineCommentEventSchema = z
    .object({
      event: z.string(),
      actor: SimpleUserSchema,
      id: z.number().int().describe('Unique identifier of the issue comment'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the issue comment'),
      body: z.string().describe('Contents of the issue comment').optional(),
      body_text: z.string().optional(),
      body_html: z.string().optional(),
      html_url: z.string().url(),
      user: SimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      issue_url: z.string().url(),
      author_association: AuthorAssociationSchema,
      performed_via_github_app: NullableIntegrationSchema.optional(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe('Timeline Comment Event')
  export type TimelineCommentEvent = z.infer<typeof TimelineCommentEventSchema>

  export const CodeSearchResultItemSchema = z
    .object({
      name: z.string(),
      path: z.string(),
      sha: z.string(),
      url: z.string().url(),
      git_url: z.string().url(),
      html_url: z.string().url(),
      repository: MinimalRepositorySchema,
      score: z.number(),
      file_size: z.number().int().optional(),
      language: z.string().optional(),
      last_modified_at: z.string().datetime({ offset: true }).optional(),
      line_numbers: z.array(z.string()).optional(),
      text_matches: SearchResultTextMatchesSchema.optional()
    })
    .describe('Code Search Result Item')
  export type CodeSearchResultItem = z.infer<typeof CodeSearchResultItemSchema>

  export const GlobalAdvisorySchema = z
    .object({
      ghsa_id: z
        .string()
        .describe('The GitHub Security Advisory ID.')
        .readonly(),
      cve_id: z
        .string()
        .describe('The Common Vulnerabilities and Exposures (CVE) ID.')
        .readonly(),
      url: z.string().describe('The API URL for the advisory.').readonly(),
      html_url: z
        .string()
        .url()
        .describe('The URL for the advisory.')
        .readonly(),
      repository_advisory_url: z
        .string()
        .url()
        .describe('The API URL for the repository advisory.')
        .readonly(),
      summary: z
        .string()
        .max(1024)
        .describe('A short summary of the advisory.'),
      description: z
        .string()
        .max(65_535)
        .describe('A detailed description of what the advisory entails.'),
      type: z
        .enum(['reviewed', 'unreviewed', 'malware'])
        .describe('The type of advisory.')
        .readonly(),
      severity: z
        .enum(['critical', 'high', 'medium', 'low', 'unknown'])
        .describe('The severity of the advisory.'),
      source_code_location: z
        .string()
        .url()
        .describe("The URL of the advisory's source code."),
      identifiers: z
        .array(
          z.object({
            type: z.enum(['CVE', 'GHSA']).describe('The type of identifier.'),
            value: z.string().describe('The identifier value.')
          })
        )
        .readonly(),
      references: z.array(
        z
          .string()
          .describe('URLs with more information regarding the advisory.')
      ),
      published_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was published, in ISO 8601 format.'
        )
        .readonly(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was last updated, in ISO 8601 format.'
        )
        .readonly(),
      github_reviewed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.'
        )
        .readonly(),
      nvd_published_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.'
        )
        .readonly(),
      withdrawn_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was withdrawn, in ISO 8601 format.'
        )
        .readonly(),
      vulnerabilities: z
        .array(VulnerabilitySchema)
        .describe(
          'The products and respective version ranges affected by the advisory.'
        ),
      cvss: z.object({
        vector_string: z.string().describe('The CVSS vector.'),
        score: z.number().gte(0).lte(10).describe('The CVSS score.').readonly()
      }),
      cvss_severities: CvssSeveritiesSchema.optional(),
      epss: SecurityAdvisoryEpssSchema.optional(),
      cwes: z.array(
        z.object({
          cwe_id: z
            .string()
            .describe('The Common Weakness Enumeration (CWE) identifier.'),
          name: z.string().describe('The name of the CWE.').readonly()
        })
      ),
      credits: z
        .array(
          z.object({
            user: SimpleUserSchema,
            type: SecurityAdvisoryCreditTypesSchema
          })
        )
        .describe('The users who contributed to the advisory.')
        .readonly()
    })
    .strict()
    .describe('A GitHub Security Advisory.')
  export type GlobalAdvisory = z.infer<typeof GlobalAdvisorySchema>

  export const IssueCommentSchema = z
    .object({
      id: z.number().int().describe('Unique identifier of the issue comment'),
      node_id: z.string(),
      url: z.string().url().describe('URL for the issue comment'),
      body: z.string().describe('Contents of the issue comment').optional(),
      body_text: z.string().optional(),
      body_html: z.string().optional(),
      html_url: z.string().url(),
      user: NullableSimpleUserSchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      issue_url: z.string().url(),
      author_association: AuthorAssociationSchema,
      performed_via_github_app: NullableIntegrationSchema.optional(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe('Comments provide a way for people to collaborate on an issue.')
  export type IssueComment = z.infer<typeof IssueCommentSchema>

  export const CodeScanningVariantAnalysisSchema = z
    .object({
      id: z.number().int().describe('The ID of the variant analysis.'),
      controller_repo: SimpleRepositorySchema,
      actor: SimpleUserSchema,
      query_language: CodeScanningVariantAnalysisLanguageSchema,
      query_pack_url: z
        .string()
        .describe('The download url for the query pack.'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        )
        .optional(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
        )
        .optional(),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          "The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available."
        )
        .optional(),
      status: z.enum(['in_progress', 'succeeded', 'failed', 'cancelled']),
      actions_workflow_run_id: z
        .number()
        .int()
        .describe(
          'The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started.'
        )
        .optional(),
      failure_reason: z
        .enum([
          'no_repos_queried',
          'actions_workflow_run_failed',
          'internal_error'
        ])
        .describe(
          'The reason for a failure of the variant analysis. This is only available if the variant analysis has failed.'
        )
        .optional(),
      scanned_repositories: z
        .array(
          z.object({
            repository: CodeScanningVariantAnalysisRepositorySchema,
            analysis_status: CodeScanningVariantAnalysisStatusSchema,
            result_count: z
              .number()
              .int()
              .describe(
                'The number of results in the case of a successful analysis. This is only available for successful analyses.'
              )
              .optional(),
            artifact_size_in_bytes: z
              .number()
              .int()
              .describe(
                'The size of the artifact. This is only available for successful analyses.'
              )
              .optional(),
            failure_message: z
              .string()
              .describe(
                'The reason of the failure of this repo task. This is only available if the repository task has failed.'
              )
              .optional()
          })
        )
        .optional(),
      skipped_repositories: z
        .object({
          access_mismatch_repos:
            CodeScanningVariantAnalysisSkippedRepoGroupSchema,
          not_found_repos: z.object({
            repository_count: z
              .number()
              .int()
              .describe(
                'The total number of repositories that were skipped for this reason.'
              ),
            repository_full_names: z
              .array(z.string())
              .describe(
                'A list of full repository names that were skipped. This list may not include all repositories that were skipped.'
              )
          }),
          no_codeql_db_repos: CodeScanningVariantAnalysisSkippedRepoGroupSchema,
          over_limit_repos: CodeScanningVariantAnalysisSkippedRepoGroupSchema
        })
        .describe(
          'Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis.'
        )
        .optional()
    })
    .describe('A run of a CodeQL query against one or more repositories.')
  export type CodeScanningVariantAnalysis = z.infer<
    typeof CodeScanningVariantAnalysisSchema
  >

  export const CommitComparisonSchema = z
    .object({
      url: z.string().url(),
      html_url: z.string().url(),
      permalink_url: z.string().url(),
      diff_url: z.string().url(),
      patch_url: z.string().url(),
      base_commit: CommitSchema,
      merge_base_commit: CommitSchema,
      status: z.enum(['diverged', 'ahead', 'behind', 'identical']),
      ahead_by: z.number().int(),
      behind_by: z.number().int(),
      total_commits: z.number().int(),
      commits: z.array(CommitSchema),
      files: z.array(DiffEntrySchema).optional()
    })
    .describe('Commit Comparison')
  export type CommitComparison = z.infer<typeof CommitComparisonSchema>

  export const EnvironmentSchema = z
    .object({
      id: z.number().int().describe('The id of the environment.'),
      node_id: z.string(),
      name: z.string().describe('The name of the environment.'),
      url: z.string(),
      html_url: z.string(),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the environment was created, in ISO 8601 format.'
        ),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the environment was last updated, in ISO 8601 format.'
        ),
      protection_rules: z
        .array(
          z.union([
            z.object({
              id: z.number().int(),
              node_id: z.string(),
              type: z.string(),
              wait_timer: WaitTimerSchema.optional()
            }),
            z.object({
              id: z.number().int(),
              node_id: z.string(),
              prevent_self_review: z
                .boolean()
                .describe(
                  'Whether deployments to this environment can be approved by the user who created the deployment.'
                )
                .optional(),
              type: z.string(),
              reviewers: z
                .array(
                  z.object({
                    type: DeploymentReviewerTypeSchema.optional(),
                    reviewer: z.union([SimpleUserSchema, TeamSchema]).optional()
                  })
                )
                .describe(
                  'The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.'
                )
                .optional()
            }),
            z.object({
              id: z.number().int(),
              node_id: z.string(),
              type: z.string()
            })
          ])
        )
        .describe('Built-in deployment protection rules for the environment.')
        .optional(),
      deployment_branch_policy: DeploymentBranchPolicySettingsSchema.optional()
    })
    .describe('Details of a deployment environment')
  export type Environment = z.infer<typeof EnvironmentSchema>

  export const HookSchema = z
    .object({
      type: z.string(),
      id: z.number().int().describe('Unique identifier of the webhook.'),
      name: z
        .string()
        .describe("The name of a valid service, use 'web' for a webhook."),
      active: z
        .boolean()
        .describe(
          'Determines whether the hook is actually triggered on pushes.'
        ),
      events: z
        .array(z.string())
        .describe(
          "Determines what events the hook is triggered for. Default: ['push']."
        ),
      config: WebhookConfigSchema,
      updated_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      url: z.string().url(),
      test_url: z.string().url(),
      ping_url: z.string().url(),
      deliveries_url: z.string().url().optional(),
      last_response: HookResponseSchema
    })
    .describe('Webhooks for repositories.')
  export type Hook = z.infer<typeof HookSchema>

  export const CodeScanningAlertInstanceSchema = z.object({
    ref: CodeScanningRefSchema.optional(),
    analysis_key: CodeScanningAnalysisAnalysisKeySchema.optional(),
    environment: CodeScanningAlertEnvironmentSchema.optional(),
    category: CodeScanningAnalysisCategorySchema.optional(),
    state: CodeScanningAlertStateSchema.optional(),
    commit_sha: z.string().optional(),
    message: z.object({ text: z.string().optional() }).optional(),
    location: CodeScanningAlertLocationSchema.optional(),
    html_url: z.string().optional(),
    classifications: z
      .array(CodeScanningAlertClassificationSchema)
      .describe(
        'Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.'
      )
      .optional()
  })
  export type CodeScanningAlertInstance = z.infer<
    typeof CodeScanningAlertInstanceSchema
  >

  export const FullRepositorySchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      name: z.string(),
      full_name: z.string(),
      owner: SimpleUserSchema,
      private: z.boolean(),
      html_url: z.string().url(),
      description: z.string(),
      fork: z.boolean(),
      url: z.string().url(),
      archive_url: z.string(),
      assignees_url: z.string(),
      blobs_url: z.string(),
      branches_url: z.string(),
      collaborators_url: z.string(),
      comments_url: z.string(),
      commits_url: z.string(),
      compare_url: z.string(),
      contents_url: z.string(),
      contributors_url: z.string().url(),
      deployments_url: z.string().url(),
      downloads_url: z.string().url(),
      events_url: z.string().url(),
      forks_url: z.string().url(),
      git_commits_url: z.string(),
      git_refs_url: z.string(),
      git_tags_url: z.string(),
      git_url: z.string(),
      issue_comment_url: z.string(),
      issue_events_url: z.string(),
      issues_url: z.string(),
      keys_url: z.string(),
      labels_url: z.string(),
      languages_url: z.string().url(),
      merges_url: z.string().url(),
      milestones_url: z.string(),
      notifications_url: z.string(),
      pulls_url: z.string(),
      releases_url: z.string(),
      ssh_url: z.string(),
      stargazers_url: z.string().url(),
      statuses_url: z.string(),
      subscribers_url: z.string().url(),
      subscription_url: z.string().url(),
      tags_url: z.string().url(),
      teams_url: z.string().url(),
      trees_url: z.string(),
      clone_url: z.string(),
      mirror_url: z.string().url(),
      hooks_url: z.string().url(),
      svn_url: z.string().url(),
      homepage: z.string().url(),
      language: z.string(),
      forks_count: z.number().int(),
      stargazers_count: z.number().int(),
      watchers_count: z.number().int(),
      size: z
        .number()
        .int()
        .describe(
          'The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.'
        ),
      default_branch: z.string(),
      open_issues_count: z.number().int(),
      is_template: z.boolean().optional(),
      topics: z.array(z.string()).optional(),
      has_issues: z.boolean(),
      has_projects: z.boolean(),
      has_wiki: z.boolean(),
      has_pages: z.boolean(),
      has_downloads: z.boolean().optional(),
      has_discussions: z.boolean(),
      archived: z.boolean(),
      disabled: z
        .boolean()
        .describe('Returns whether or not this repository disabled.'),
      visibility: z
        .string()
        .describe('The repository visibility: public, private, or internal.')
        .optional(),
      pushed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      permissions: z
        .object({
          admin: z.boolean(),
          maintain: z.boolean().optional(),
          push: z.boolean(),
          triage: z.boolean().optional(),
          pull: z.boolean()
        })
        .optional(),
      allow_rebase_merge: z.boolean().optional(),
      template_repository: NullableRepositorySchema.optional(),
      temp_clone_token: z.string().optional(),
      allow_squash_merge: z.boolean().optional(),
      allow_auto_merge: z.boolean().optional(),
      delete_branch_on_merge: z.boolean().optional(),
      allow_merge_commit: z.boolean().optional(),
      allow_update_branch: z.boolean().optional(),
      use_squash_pr_title_as_default: z.boolean().optional(),
      squash_merge_commit_title: z
        .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
        .describe(
          "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
        )
        .optional(),
      squash_merge_commit_message: z
        .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
        .describe(
          "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      merge_commit_title: z
        .enum(['PR_TITLE', 'MERGE_MESSAGE'])
        .describe(
          "The default value for a merge commit title.\n\n  - `PR_TITLE` - default to the pull request's title.\n  - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
        )
        .optional(),
      merge_commit_message: z
        .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
        .describe(
          "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
        )
        .optional(),
      allow_forking: z.boolean().optional(),
      web_commit_signoff_required: z.boolean().optional(),
      subscribers_count: z.number().int(),
      network_count: z.number().int(),
      license: NullableLicenseSimpleSchema,
      organization: NullableSimpleUserSchema.optional(),
      parent: RepositorySchema.optional(),
      source: RepositorySchema.optional(),
      forks: z.number().int(),
      master_branch: z.string().optional(),
      open_issues: z.number().int(),
      watchers: z.number().int(),
      anonymous_access_enabled: z
        .boolean()
        .describe('Whether anonymous git access is allowed.')
        .default(true),
      code_of_conduct: CodeOfConductSimpleSchema.optional(),
      security_and_analysis: SecurityAndAnalysisSchema.optional(),
      custom_properties: z
        .record(z.any())
        .describe(
          'The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.'
        )
        .optional()
    })
    .describe('Full Repository')
  export type FullRepository = z.infer<typeof FullRepositorySchema>

  export const WorkflowRunSchema = z
    .object({
      id: z.number().int().describe('The ID of the workflow run.'),
      name: z.string().describe('The name of the workflow run.').optional(),
      node_id: z.string(),
      check_suite_id: z
        .number()
        .int()
        .describe('The ID of the associated check suite.')
        .optional(),
      check_suite_node_id: z
        .string()
        .describe('The node ID of the associated check suite.')
        .optional(),
      head_branch: z.string(),
      head_sha: z
        .string()
        .describe(
          'The SHA of the head commit that points to the version of the workflow being run.'
        ),
      path: z.string().describe('The full path of the workflow'),
      run_number: z
        .number()
        .int()
        .describe('The auto incrementing run number for the workflow run.'),
      run_attempt: z
        .number()
        .int()
        .describe(
          'Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.'
        )
        .optional(),
      referenced_workflows: z.array(ReferencedWorkflowSchema).optional(),
      event: z.string(),
      status: z.string(),
      conclusion: z.string(),
      workflow_id: z.number().int().describe('The ID of the parent workflow.'),
      url: z.string().describe('The URL to the workflow run.'),
      html_url: z.string(),
      pull_requests: z
        .array(PullRequestMinimalSchema)
        .describe(
          'Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.'
        ),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      actor: SimpleUserSchema.optional(),
      triggering_actor: SimpleUserSchema.optional(),
      run_started_at: z
        .string()
        .datetime({ offset: true })
        .describe('The start time of the latest run. Resets on re-run.')
        .optional(),
      jobs_url: z
        .string()
        .describe('The URL to the jobs for the workflow run.'),
      logs_url: z
        .string()
        .describe('The URL to download the logs for the workflow run.'),
      check_suite_url: z
        .string()
        .describe('The URL to the associated check suite.'),
      artifacts_url: z
        .string()
        .describe('The URL to the artifacts for the workflow run.'),
      cancel_url: z.string().describe('The URL to cancel the workflow run.'),
      rerun_url: z.string().describe('The URL to rerun the workflow run.'),
      previous_attempt_url: z
        .string()
        .describe(
          'The URL to the previous attempted run of this workflow, if one exists.'
        )
        .optional(),
      workflow_url: z.string().describe('The URL to the workflow.'),
      head_commit: NullableSimpleCommitSchema,
      repository: MinimalRepositorySchema,
      head_repository: MinimalRepositorySchema,
      head_repository_id: z.number().int().optional(),
      display_title: z
        .string()
        .describe(
          'The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.'
        )
    })
    .describe('An invocation of a workflow')
  export type WorkflowRun = z.infer<typeof WorkflowRunSchema>

  export const ProtectedBranchSchema = z
    .object({
      url: z.string().url(),
      required_status_checks: StatusCheckPolicySchema.optional(),
      required_pull_request_reviews: z
        .object({
          url: z.string().url(),
          dismiss_stale_reviews: z.boolean().optional(),
          require_code_owner_reviews: z.boolean().optional(),
          required_approving_review_count: z.number().int().optional(),
          require_last_push_approval: z
            .boolean()
            .describe(
              'Whether the most recent push must be approved by someone other than the person who pushed it.'
            )
            .default(false),
          dismissal_restrictions: z
            .object({
              url: z.string().url(),
              users_url: z.string().url(),
              teams_url: z.string().url(),
              users: z.array(SimpleUserSchema),
              teams: z.array(TeamSchema),
              apps: z.array(IntegrationSchema).optional()
            })
            .optional(),
          bypass_pull_request_allowances: z
            .object({
              users: z.array(SimpleUserSchema),
              teams: z.array(TeamSchema),
              apps: z.array(IntegrationSchema).optional()
            })
            .optional()
        })
        .optional(),
      required_signatures: z
        .object({ url: z.string().url(), enabled: z.boolean() })
        .optional(),
      enforce_admins: z
        .object({ url: z.string().url(), enabled: z.boolean() })
        .strict()
        .optional(),
      required_linear_history: z
        .object({ enabled: z.boolean() })
        .strict()
        .optional(),
      allow_force_pushes: z
        .object({ enabled: z.boolean() })
        .strict()
        .optional(),
      allow_deletions: z.object({ enabled: z.boolean() }).strict().optional(),
      restrictions: BranchRestrictionPolicySchema.optional(),
      required_conversation_resolution: z
        .object({ enabled: z.boolean().optional() })
        .strict()
        .optional(),
      block_creations: z.object({ enabled: z.boolean() }).strict().optional(),
      lock_branch: z
        .object({ enabled: z.boolean().default(false) })
        .strict()
        .describe(
          'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.'
        )
        .optional(),
      allow_fork_syncing: z
        .object({ enabled: z.boolean().default(false) })
        .strict()
        .describe(
          'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.'
        )
        .optional()
    })
    .describe('Branch protections protect branches')
  export type ProtectedBranch = z.infer<typeof ProtectedBranchSchema>

  export const CheckSuiteSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      head_branch: z.string(),
      head_sha: z
        .string()
        .describe('The SHA of the head commit that is being checked.'),
      status: z
        .enum([
          'queued',
          'in_progress',
          'completed',
          'waiting',
          'requested',
          'pending'
        ])
        .describe(
          'The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.'
        ),
      conclusion: z.union([
        z.literal('success'),
        z.literal('failure'),
        z.literal('neutral'),
        z.literal('cancelled'),
        z.literal('skipped'),
        z.literal('timed_out'),
        z.literal('action_required'),
        z.literal('startup_failure'),
        z.literal('stale'),
        z.literal(null)
      ]),
      url: z.string(),
      before: z.string(),
      after: z.string(),
      pull_requests: z.array(PullRequestMinimalSchema),
      app: NullableIntegrationSchema,
      repository: MinimalRepositorySchema,
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      head_commit: SimpleCommitSchema,
      latest_check_runs_count: z.number().int(),
      check_runs_url: z.string(),
      rerequestable: z.boolean().optional(),
      runs_rerequestable: z.boolean().optional()
    })
    .describe('A suite of checks performed on the code of a given code change')
  export type CheckSuite = z.infer<typeof CheckSuiteSchema>

  export const SecretScanningAlertSchema = z.object({
    number: AlertNumberSchema.optional(),
    created_at: AlertCreatedAtSchema.optional(),
    updated_at: NullableAlertUpdatedAtSchema.optional(),
    url: AlertUrlSchema.optional(),
    html_url: AlertHtmlUrlSchema.optional(),
    locations_url: z
      .string()
      .url()
      .describe('The REST API URL of the code locations for this alert.')
      .optional(),
    state: SecretScanningAlertStateSchema.optional(),
    resolution: SecretScanningAlertResolutionSchema.optional(),
    resolved_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    resolved_by: NullableSimpleUserSchema.optional(),
    resolution_comment: z
      .string()
      .describe('An optional comment to resolve an alert.')
      .optional(),
    secret_type: z
      .string()
      .describe('The type of secret that secret scanning detected.')
      .optional(),
    secret_type_display_name: z
      .string()
      .describe(
        'User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."'
      )
      .optional(),
    secret: z.string().describe('The secret that was detected.').optional(),
    push_protection_bypassed: z
      .boolean()
      .describe('Whether push protection was bypassed for the detected secret.')
      .optional(),
    push_protection_bypassed_by: NullableSimpleUserSchema.optional(),
    push_protection_bypassed_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    push_protection_bypass_request_reviewer:
      NullableSimpleUserSchema.optional(),
    push_protection_bypass_request_reviewer_comment: z
      .string()
      .describe('An optional comment when reviewing a push protection bypass.')
      .optional(),
    push_protection_bypass_request_comment: z
      .string()
      .describe('An optional comment when requesting a push protection bypass.')
      .optional(),
    push_protection_bypass_request_html_url: z
      .string()
      .url()
      .describe('The URL to a push protection bypass request.')
      .optional(),
    validity: z
      .enum(['active', 'inactive', 'unknown'])
      .describe('The token status as of the latest validity check.')
      .optional(),
    publicly_leaked: z
      .boolean()
      .describe('Whether the detected secret was publicly leaked.')
      .optional(),
    multi_repo: z
      .boolean()
      .describe(
        'Whether the detected secret was found in multiple repositories under the same organization or enterprise.'
      )
      .optional(),
    is_base64_encoded: z
      .boolean()
      .describe(
        'A boolean value representing whether or not alert is base64 encoded'
      )
      .optional()
  })
  export type SecretScanningAlert = z.infer<typeof SecretScanningAlertSchema>

  export const CommitSearchResultItemSchema = z
    .object({
      url: z.string().url(),
      sha: z.string(),
      html_url: z.string().url(),
      comments_url: z.string().url(),
      commit: z.object({
        author: z.object({
          name: z.string(),
          email: z.string(),
          date: z.string().datetime({ offset: true })
        }),
        committer: NullableGitUserSchema,
        comment_count: z.number().int(),
        message: z.string(),
        tree: z.object({ sha: z.string(), url: z.string().url() }),
        url: z.string().url(),
        verification: VerificationSchema.optional()
      }),
      author: NullableSimpleUserSchema,
      committer: NullableGitUserSchema,
      parents: z.array(
        z.object({
          url: z.string().optional(),
          html_url: z.string().optional(),
          sha: z.string().optional()
        })
      ),
      repository: MinimalRepositorySchema,
      score: z.number(),
      node_id: z.string(),
      text_matches: SearchResultTextMatchesSchema.optional()
    })
    .describe('Commit Search Result Item')
  export type CommitSearchResultItem = z.infer<
    typeof CommitSearchResultItemSchema
  >

  export const RepositoryAdvisorySchema = z
    .object({
      ghsa_id: z
        .string()
        .describe('The GitHub Security Advisory ID.')
        .readonly(),
      cve_id: z
        .string()
        .describe('The Common Vulnerabilities and Exposures (CVE) ID.'),
      url: z
        .string()
        .url()
        .describe('The API URL for the advisory.')
        .readonly(),
      html_url: z
        .string()
        .url()
        .describe('The URL for the advisory.')
        .readonly(),
      summary: z
        .string()
        .max(1024)
        .describe('A short summary of the advisory.'),
      description: z
        .string()
        .max(65_535)
        .describe('A detailed description of what the advisory entails.'),
      severity: z
        .enum(['critical', 'high', 'medium', 'low'])
        .describe('The severity of the advisory.'),
      author: SimpleUserSchema.describe(
        'The author of the advisory.'
      ).readonly(),
      publisher: SimpleUserSchema.describe(
        'The publisher of the advisory.'
      ).readonly(),
      identifiers: z
        .array(
          z.object({
            type: z.enum(['CVE', 'GHSA']).describe('The type of identifier.'),
            value: z.string().describe('The identifier value.')
          })
        )
        .readonly(),
      state: z
        .enum(['published', 'closed', 'withdrawn', 'draft', 'triage'])
        .describe('The state of the advisory.'),
      created_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was created, in ISO 8601 format.'
        )
        .readonly(),
      updated_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was last updated, in ISO 8601 format.'
        )
        .readonly(),
      published_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was published, in ISO 8601 format.'
        )
        .readonly(),
      closed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was closed, in ISO 8601 format.'
        )
        .readonly(),
      withdrawn_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The date and time of when the advisory was withdrawn, in ISO 8601 format.'
        )
        .readonly(),
      submission: z
        .object({
          accepted: z
            .boolean()
            .describe(
              "Whether a private vulnerability report was accepted by the repository's administrators."
            )
            .readonly()
        })
        .readonly(),
      vulnerabilities: z.array(RepositoryAdvisoryVulnerabilitySchema),
      cvss: z.object({
        vector_string: z.string().describe('The CVSS vector.'),
        score: z.number().gte(0).lte(10).describe('The CVSS score.').readonly()
      }),
      cvss_severities: CvssSeveritiesSchema.optional(),
      cwes: z
        .array(
          z.object({
            cwe_id: z
              .string()
              .describe('The Common Weakness Enumeration (CWE) identifier.'),
            name: z.string().describe('The name of the CWE.').readonly()
          })
        )
        .readonly(),
      cwe_ids: z.array(z.string()).describe('A list of only the CWE IDs.'),
      credits: z.array(
        z.object({
          login: z
            .string()
            .describe('The username of the user credited.')
            .optional(),
          type: SecurityAdvisoryCreditTypesSchema.optional()
        })
      ),
      credits_detailed: z.array(RepositoryAdvisoryCreditSchema).readonly(),
      collaborating_users: z
        .array(SimpleUserSchema)
        .describe('A list of users that collaborate on the advisory.'),
      collaborating_teams: z
        .array(TeamSchema)
        .describe('A list of teams that collaborate on the advisory.'),
      private_fork: SimpleRepositorySchema.describe(
        "A temporary private fork of the advisory's repository for collaborating on a fix."
      ).readonly()
    })
    .strict()
    .describe('A repository security advisory.')
  export type RepositoryAdvisory = z.infer<typeof RepositoryAdvisorySchema>

  export const BranchProtectionSchema = z
    .object({
      url: z.string().optional(),
      enabled: z.boolean().optional(),
      required_status_checks:
        ProtectedBranchRequiredStatusCheckSchema.optional(),
      enforce_admins: ProtectedBranchAdminEnforcedSchema.optional(),
      required_pull_request_reviews:
        ProtectedBranchPullRequestReviewSchema.optional(),
      restrictions: BranchRestrictionPolicySchema.optional(),
      required_linear_history: z
        .object({ enabled: z.boolean().optional() })
        .optional(),
      allow_force_pushes: z
        .object({ enabled: z.boolean().optional() })
        .optional(),
      allow_deletions: z.object({ enabled: z.boolean().optional() }).optional(),
      block_creations: z.object({ enabled: z.boolean().optional() }).optional(),
      required_conversation_resolution: z
        .object({ enabled: z.boolean().optional() })
        .optional(),
      name: z.string().optional(),
      protection_url: z.string().optional(),
      required_signatures: z
        .object({ url: z.string().url(), enabled: z.boolean() })
        .optional(),
      lock_branch: z
        .object({ enabled: z.boolean().default(false) })
        .describe(
          'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.'
        )
        .optional(),
      allow_fork_syncing: z
        .object({ enabled: z.boolean().default(false) })
        .describe(
          'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.'
        )
        .optional()
    })
    .describe('Branch Protection')
  export type BranchProtection = z.infer<typeof BranchProtectionSchema>

  export const PullRequestSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      html_url: z.string().url(),
      diff_url: z.string().url(),
      patch_url: z.string().url(),
      issue_url: z.string().url(),
      commits_url: z.string().url(),
      review_comments_url: z.string().url(),
      review_comment_url: z.string(),
      comments_url: z.string().url(),
      statuses_url: z.string().url(),
      number: z
        .number()
        .int()
        .describe(
          'Number uniquely identifying the pull request within its repository.'
        ),
      state: z
        .enum(['open', 'closed'])
        .describe('State of this Pull Request. Either `open` or `closed`.'),
      locked: z.boolean(),
      title: z.string().describe('The title of the pull request.'),
      user: SimpleUserSchema,
      body: z.string(),
      labels: z.array(
        z.object({
          id: z.number().int(),
          node_id: z.string(),
          url: z.string(),
          name: z.string(),
          description: z.string(),
          color: z.string(),
          default: z.boolean()
        })
      ),
      milestone: NullableMilestoneSchema,
      active_lock_reason: z.string().optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      closed_at: z.string().datetime({ offset: true }),
      merged_at: z.string().datetime({ offset: true }),
      merge_commit_sha: z.string(),
      assignee: NullableSimpleUserSchema,
      assignees: z.array(SimpleUserSchema).optional(),
      requested_reviewers: z.array(SimpleUserSchema).optional(),
      requested_teams: z.array(TeamSimpleSchema).optional(),
      head: z.object({
        label: z.string(),
        ref: z.string(),
        repo: RepositorySchema,
        sha: z.string(),
        user: SimpleUserSchema
      }),
      base: z.object({
        label: z.string(),
        ref: z.string(),
        repo: RepositorySchema,
        sha: z.string(),
        user: SimpleUserSchema
      }),
      _links: z.object({
        comments: LinkSchema,
        commits: LinkSchema,
        statuses: LinkSchema,
        html: LinkSchema,
        issue: LinkSchema,
        review_comments: LinkSchema,
        review_comment: LinkSchema,
        self: LinkSchema
      }),
      author_association: AuthorAssociationSchema,
      auto_merge: AutoMergeSchema,
      draft: z
        .boolean()
        .describe('Indicates whether or not the pull request is a draft.')
        .optional(),
      merged: z.boolean(),
      mergeable: z.boolean(),
      rebaseable: z.boolean().optional(),
      mergeable_state: z.string(),
      merged_by: NullableSimpleUserSchema,
      comments: z.number().int(),
      review_comments: z.number().int(),
      maintainer_can_modify: z
        .boolean()
        .describe('Indicates whether maintainers can modify the pull request.'),
      commits: z.number().int(),
      additions: z.number().int(),
      deletions: z.number().int(),
      changed_files: z.number().int()
    })
    .describe(
      "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary."
    )
  export type PullRequest = z.infer<typeof PullRequestSchema>

  export const CodespaceWithFullRepositorySchema = z
    .object({
      id: z.number().int(),
      name: z
        .string()
        .describe('Automatically generated name of this codespace.'),
      display_name: z
        .string()
        .describe('Display name for this codespace.')
        .optional(),
      environment_id: z
        .string()
        .describe("UUID identifying this codespace's environment."),
      owner: SimpleUserSchema,
      billable_owner: SimpleUserSchema,
      repository: FullRepositorySchema,
      machine: NullableCodespaceMachineSchema,
      devcontainer_path: z
        .string()
        .describe(
          'Path to devcontainer.json from repo root used to create Codespace.'
        )
        .optional(),
      prebuild: z
        .boolean()
        .describe('Whether the codespace was created from a prebuild.'),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      last_used_at: z
        .string()
        .datetime({ offset: true })
        .describe('Last known time this codespace was started.'),
      state: z
        .enum([
          'Unknown',
          'Created',
          'Queued',
          'Provisioning',
          'Available',
          'Awaiting',
          'Unavailable',
          'Deleted',
          'Moved',
          'Shutdown',
          'Archived',
          'Starting',
          'ShuttingDown',
          'Failed',
          'Exporting',
          'Updating',
          'Rebuilding'
        ])
        .describe('State of this codespace.'),
      url: z.string().url().describe('API URL for this codespace.'),
      git_status: z
        .object({
          ahead: z
            .number()
            .int()
            .describe(
              'The number of commits the local repository is ahead of the remote.'
            )
            .optional(),
          behind: z
            .number()
            .int()
            .describe(
              'The number of commits the local repository is behind the remote.'
            )
            .optional(),
          has_unpushed_changes: z
            .boolean()
            .describe('Whether the local repository has unpushed changes.')
            .optional(),
          has_uncommitted_changes: z
            .boolean()
            .describe('Whether the local repository has uncommitted changes.')
            .optional(),
          ref: z
            .string()
            .describe(
              'The current branch (or SHA if in detached HEAD state) of the local repository.'
            )
            .optional()
        })
        .describe("Details about the codespace's git repository."),
      location: z
        .enum(['EastUs', 'SouthEastAsia', 'WestEurope', 'WestUs2'])
        .describe('The initally assigned location of a new codespace.'),
      idle_timeout_minutes: z
        .number()
        .int()
        .describe(
          'The number of minutes of inactivity after which this codespace will be automatically stopped.'
        ),
      web_url: z
        .string()
        .url()
        .describe('URL to access this codespace on the web.'),
      machines_url: z
        .string()
        .url()
        .describe(
          'API URL to access available alternate machine types for this codespace.'
        ),
      start_url: z.string().url().describe('API URL to start this codespace.'),
      stop_url: z.string().url().describe('API URL to stop this codespace.'),
      publish_url: z
        .string()
        .url()
        .describe('API URL to publish this codespace to a new repository.')
        .optional(),
      pulls_url: z
        .string()
        .url()
        .describe(
          'API URL for the Pull Request associated with this codespace, if any.'
        ),
      recent_folders: z.array(z.string()),
      runtime_constraints: z
        .object({
          allowed_port_privacy_settings: z
            .array(z.string())
            .describe(
              'The privacy settings a user can select from when forwarding a port.'
            )
            .optional()
        })
        .optional(),
      pending_operation: z
        .boolean()
        .describe(
          'Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.'
        )
        .optional(),
      pending_operation_disabled_reason: z
        .string()
        .describe(
          'Text to show user when codespace is disabled by a pending operation'
        )
        .optional(),
      idle_timeout_notice: z
        .string()
        .describe(
          'Text to show user when codespace idle timeout minutes has been overriden by an organization policy'
        )
        .optional(),
      retention_period_minutes: z
        .number()
        .int()
        .describe(
          'Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).'
        )
        .optional(),
      retention_expires_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"'
        )
        .optional()
    })
    .describe('A codespace.')
  export type CodespaceWithFullRepository = z.infer<
    typeof CodespaceWithFullRepositorySchema
  >

  export const OrganizationSecretScanningAlertSchema = z.object({
    number: AlertNumberSchema.optional(),
    created_at: AlertCreatedAtSchema.optional(),
    updated_at: NullableAlertUpdatedAtSchema.optional(),
    url: AlertUrlSchema.optional(),
    html_url: AlertHtmlUrlSchema.optional(),
    locations_url: z
      .string()
      .url()
      .describe('The REST API URL of the code locations for this alert.')
      .optional(),
    state: SecretScanningAlertStateSchema.optional(),
    resolution: SecretScanningAlertResolutionSchema.optional(),
    resolved_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    resolved_by: NullableSimpleUserSchema.optional(),
    secret_type: z
      .string()
      .describe('The type of secret that secret scanning detected.')
      .optional(),
    secret_type_display_name: z
      .string()
      .describe(
        'User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."'
      )
      .optional(),
    secret: z.string().describe('The secret that was detected.').optional(),
    repository: SimpleRepositorySchema.optional(),
    push_protection_bypassed: z
      .boolean()
      .describe('Whether push protection was bypassed for the detected secret.')
      .optional(),
    push_protection_bypassed_by: NullableSimpleUserSchema.optional(),
    push_protection_bypassed_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    push_protection_bypass_request_reviewer:
      NullableSimpleUserSchema.optional(),
    push_protection_bypass_request_reviewer_comment: z
      .string()
      .describe('An optional comment when reviewing a push protection bypass.')
      .optional(),
    push_protection_bypass_request_comment: z
      .string()
      .describe('An optional comment when requesting a push protection bypass.')
      .optional(),
    push_protection_bypass_request_html_url: z
      .string()
      .url()
      .describe('The URL to a push protection bypass request.')
      .optional(),
    resolution_comment: z
      .string()
      .describe(
        'The comment that was optionally added when this alert was closed'
      )
      .optional(),
    validity: z
      .enum(['active', 'inactive', 'unknown'])
      .describe('The token status as of the latest validity check.')
      .optional(),
    publicly_leaked: z
      .boolean()
      .describe('Whether the secret was publicly leaked.')
      .optional(),
    multi_repo: z
      .boolean()
      .describe(
        'Whether the detected secret was found in multiple repositories in the same organization or enterprise.'
      )
      .optional(),
    is_base64_encoded: z
      .boolean()
      .describe(
        'A boolean value representing whether or not alert is base64 encoded'
      )
      .optional()
  })
  export type OrganizationSecretScanningAlert = z.infer<
    typeof OrganizationSecretScanningAlertSchema
  >

  export const ShortBranchSchema = z
    .object({
      name: z.string(),
      commit: z.object({ sha: z.string(), url: z.string().url() }),
      protected: z.boolean(),
      protection: BranchProtectionSchema.optional(),
      protection_url: z.string().url().optional()
    })
    .describe('Short Branch')
  export type ShortBranch = z.infer<typeof ShortBranchSchema>

  export const PullRequestSimpleSchema = z
    .object({
      url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      html_url: z.string().url(),
      diff_url: z.string().url(),
      patch_url: z.string().url(),
      issue_url: z.string().url(),
      commits_url: z.string().url(),
      review_comments_url: z.string().url(),
      review_comment_url: z.string(),
      comments_url: z.string().url(),
      statuses_url: z.string().url(),
      number: z.number().int(),
      state: z.string(),
      locked: z.boolean(),
      title: z.string(),
      user: NullableSimpleUserSchema,
      body: z.string(),
      labels: z.array(
        z.object({
          id: z.number().int(),
          node_id: z.string(),
          url: z.string(),
          name: z.string(),
          description: z.string(),
          color: z.string(),
          default: z.boolean()
        })
      ),
      milestone: NullableMilestoneSchema,
      active_lock_reason: z.string().optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      closed_at: z.string().datetime({ offset: true }),
      merged_at: z.string().datetime({ offset: true }),
      merge_commit_sha: z.string(),
      assignee: NullableSimpleUserSchema,
      assignees: z.array(SimpleUserSchema).optional(),
      requested_reviewers: z.array(SimpleUserSchema).optional(),
      requested_teams: z.array(TeamSchema).optional(),
      head: z.object({
        label: z.string(),
        ref: z.string(),
        repo: RepositorySchema,
        sha: z.string(),
        user: NullableSimpleUserSchema
      }),
      base: z.object({
        label: z.string(),
        ref: z.string(),
        repo: RepositorySchema,
        sha: z.string(),
        user: NullableSimpleUserSchema
      }),
      _links: z.object({
        comments: LinkSchema,
        commits: LinkSchema,
        statuses: LinkSchema,
        html: LinkSchema,
        issue: LinkSchema,
        review_comments: LinkSchema,
        review_comment: LinkSchema,
        self: LinkSchema
      }),
      author_association: AuthorAssociationSchema,
      auto_merge: AutoMergeSchema,
      draft: z
        .boolean()
        .describe('Indicates whether or not the pull request is a draft.')
        .optional()
    })
    .describe('Pull Request Simple')
  export type PullRequestSimple = z.infer<typeof PullRequestSimpleSchema>

  export const IssueSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url().describe('URL for the issue'),
      repository_url: z.string().url(),
      labels_url: z.string(),
      comments_url: z.string().url(),
      events_url: z.string().url(),
      html_url: z.string().url(),
      number: z
        .number()
        .int()
        .describe(
          'Number uniquely identifying the issue within its repository'
        ),
      state: z
        .string()
        .describe("State of the issue; either 'open' or 'closed'"),
      state_reason: z
        .enum(['completed', 'reopened', 'not_planned'])
        .describe('The reason for the current state')
        .optional(),
      title: z.string().describe('Title of the issue'),
      body: z.string().describe('Contents of the issue').optional(),
      user: NullableSimpleUserSchema,
      labels: z
        .array(
          z.union([
            z.string(),
            z.object({
              id: z.number().int().optional(),
              node_id: z.string().optional(),
              url: z.string().url().optional(),
              name: z.string().optional(),
              description: z.string().optional(),
              color: z.string().optional(),
              default: z.boolean().optional()
            })
          ])
        )
        .describe(
          'Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository'
        ),
      assignee: NullableSimpleUserSchema,
      assignees: z.array(SimpleUserSchema).optional(),
      milestone: NullableMilestoneSchema,
      locked: z.boolean(),
      active_lock_reason: z.string().optional(),
      comments: z.number().int(),
      pull_request: z
        .object({
          merged_at: z.string().datetime({ offset: true }).optional(),
          diff_url: z.string().url(),
          html_url: z.string().url(),
          patch_url: z.string().url(),
          url: z.string().url()
        })
        .optional(),
      closed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      draft: z.boolean().optional(),
      closed_by: NullableSimpleUserSchema.optional(),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      timeline_url: z.string().url().optional(),
      type: IssueTypeSchema.optional(),
      repository: RepositorySchema.optional(),
      performed_via_github_app: NullableIntegrationSchema.optional(),
      author_association: AuthorAssociationSchema,
      reactions: ReactionRollupSchema.optional(),
      sub_issues_summary: SubIssuesSummarySchema.optional()
    })
    .describe(
      'Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.'
    )
  export type Issue = z.infer<typeof IssueSchema>

  export const NullableIssueSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url().describe('URL for the issue'),
      repository_url: z.string().url(),
      labels_url: z.string(),
      comments_url: z.string().url(),
      events_url: z.string().url(),
      html_url: z.string().url(),
      number: z
        .number()
        .int()
        .describe(
          'Number uniquely identifying the issue within its repository'
        ),
      state: z
        .string()
        .describe("State of the issue; either 'open' or 'closed'"),
      state_reason: z
        .enum(['completed', 'reopened', 'not_planned'])
        .describe('The reason for the current state')
        .optional(),
      title: z.string().describe('Title of the issue'),
      body: z.string().describe('Contents of the issue').optional(),
      user: NullableSimpleUserSchema,
      labels: z
        .array(
          z.union([
            z.string(),
            z.object({
              id: z.number().int().optional(),
              node_id: z.string().optional(),
              url: z.string().url().optional(),
              name: z.string().optional(),
              description: z.string().optional(),
              color: z.string().optional(),
              default: z.boolean().optional()
            })
          ])
        )
        .describe(
          'Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository'
        ),
      assignee: NullableSimpleUserSchema,
      assignees: z.array(SimpleUserSchema).optional(),
      milestone: NullableMilestoneSchema,
      locked: z.boolean(),
      active_lock_reason: z.string().optional(),
      comments: z.number().int(),
      pull_request: z
        .object({
          merged_at: z.string().datetime({ offset: true }).optional(),
          diff_url: z.string().url(),
          html_url: z.string().url(),
          patch_url: z.string().url(),
          url: z.string().url()
        })
        .optional(),
      closed_at: z.string().datetime({ offset: true }),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      draft: z.boolean().optional(),
      closed_by: NullableSimpleUserSchema.optional(),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      timeline_url: z.string().url().optional(),
      type: IssueTypeSchema.optional(),
      repository: RepositorySchema.optional(),
      performed_via_github_app: NullableIntegrationSchema.optional(),
      author_association: AuthorAssociationSchema,
      reactions: ReactionRollupSchema.optional(),
      sub_issues_summary: SubIssuesSummarySchema.optional()
    })
    .describe(
      'Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.'
    )
  export type NullableIssue = z.infer<typeof NullableIssueSchema>

  export const IssueSearchResultItemSchema = z
    .object({
      url: z.string().url(),
      repository_url: z.string().url(),
      labels_url: z.string(),
      comments_url: z.string().url(),
      events_url: z.string().url(),
      html_url: z.string().url(),
      id: z.number().int(),
      node_id: z.string(),
      number: z.number().int(),
      title: z.string(),
      locked: z.boolean(),
      active_lock_reason: z.string().optional(),
      assignees: z.array(SimpleUserSchema).optional(),
      user: NullableSimpleUserSchema,
      labels: z.array(
        z.object({
          id: z.number().int().optional(),
          node_id: z.string().optional(),
          url: z.string().optional(),
          name: z.string().optional(),
          color: z.string().optional(),
          default: z.boolean().optional(),
          description: z.string().optional()
        })
      ),
      sub_issues_summary: z
        .object({
          total: z.number().int(),
          completed: z.number().int(),
          percent_completed: z.number().int()
        })
        .optional(),
      state: z.string(),
      state_reason: z.string().optional(),
      assignee: NullableSimpleUserSchema,
      milestone: NullableMilestoneSchema,
      comments: z.number().int(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      closed_at: z.string().datetime({ offset: true }),
      text_matches: SearchResultTextMatchesSchema.optional(),
      pull_request: z
        .object({
          merged_at: z.string().datetime({ offset: true }).optional(),
          diff_url: z.string().url(),
          html_url: z.string().url(),
          patch_url: z.string().url(),
          url: z.string().url()
        })
        .optional(),
      body: z.string().optional(),
      score: z.number(),
      author_association: AuthorAssociationSchema,
      draft: z.boolean().optional(),
      repository: RepositorySchema.optional(),
      body_html: z.string().optional(),
      body_text: z.string().optional(),
      timeline_url: z.string().url().optional(),
      type: IssueTypeSchema.optional(),
      performed_via_github_app: NullableIntegrationSchema.optional(),
      reactions: ReactionRollupSchema.optional()
    })
    .describe('Issue Search Result Item')
  export type IssueSearchResultItem = z.infer<
    typeof IssueSearchResultItemSchema
  >

  export const CodeScanningAnalysisSchema = z.object({
    ref: CodeScanningRefSchema,
    commit_sha: CodeScanningAnalysisCommitShaSchema,
    analysis_key: CodeScanningAnalysisAnalysisKeySchema,
    environment: CodeScanningAnalysisEnvironmentSchema,
    category: CodeScanningAnalysisCategorySchema.optional(),
    error: z.string(),
    created_at: CodeScanningAnalysisCreatedAtSchema,
    results_count: z
      .number()
      .int()
      .describe('The total number of results in the analysis.'),
    rules_count: z
      .number()
      .int()
      .describe('The total number of rules used in the analysis.'),
    id: z.number().int().describe('Unique identifier for this analysis.'),
    url: CodeScanningAnalysisUrlSchema,
    sarif_id: CodeScanningAnalysisSarifIdSchema,
    tool: CodeScanningAnalysisToolSchema,
    deletable: z.boolean(),
    warning: z
      .string()
      .describe('Warning generated when processing the analysis')
  })
  export type CodeScanningAnalysis = z.infer<typeof CodeScanningAnalysisSchema>

  export const TimelineCrossReferencedEventSchema = z
    .object({
      event: z.string(),
      actor: SimpleUserSchema.optional(),
      created_at: z.string().datetime({ offset: true }),
      updated_at: z.string().datetime({ offset: true }),
      source: z.object({
        type: z.string().optional(),
        issue: IssueSchema.optional()
      })
    })
    .describe('Timeline Cross Referenced Event')
  export type TimelineCrossReferencedEvent = z.infer<
    typeof TimelineCrossReferencedEventSchema
  >

  export const SecretScanningLocationSchema = z.object({
    type: z
      .enum([
        'commit',
        'wiki_commit',
        'issue_title',
        'issue_body',
        'issue_comment',
        'discussion_title',
        'discussion_body',
        'discussion_comment',
        'pull_request_title',
        'pull_request_body',
        'pull_request_comment',
        'pull_request_review',
        'pull_request_review_comment'
      ])
      .describe(
        'The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.'
      )
      .optional(),
    details: z
      .union([
        SecretScanningLocationCommitSchema,
        SecretScanningLocationWikiCommitSchema,
        SecretScanningLocationIssueTitleSchema,
        SecretScanningLocationIssueBodySchema,
        SecretScanningLocationIssueCommentSchema,
        SecretScanningLocationDiscussionTitleSchema,
        SecretScanningLocationDiscussionBodySchema,
        SecretScanningLocationDiscussionCommentSchema,
        SecretScanningLocationPullRequestTitleSchema,
        SecretScanningLocationPullRequestBodySchema,
        SecretScanningLocationPullRequestCommentSchema,
        SecretScanningLocationPullRequestReviewSchema,
        SecretScanningLocationPullRequestReviewCommentSchema
      ])
      .optional()
  })
  export type SecretScanningLocation = z.infer<
    typeof SecretScanningLocationSchema
  >

  export const DependabotAlertSchema = z
    .object({
      number: AlertNumberSchema,
      state: z
        .enum(['auto_dismissed', 'dismissed', 'fixed', 'open'])
        .describe('The state of the Dependabot alert.')
        .readonly(),
      dependency: z
        .object({
          package: DependabotAlertPackageSchema.optional(),
          manifest_path: z
            .string()
            .describe(
              'The full path to the dependency manifest file, relative to the root of the repository.'
            )
            .readonly()
            .optional(),
          scope: z
            .enum(['development', 'runtime'])
            .describe('The execution scope of the vulnerable dependency.')
            .readonly()
            .optional(),
          relationship: z
            .enum(['unknown', 'direct', 'transitive'])
            .describe(
              'The vulnerable dependency\'s relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.\n'
            )
            .readonly()
            .optional()
        })
        .describe('Details for the vulnerable dependency.')
        .readonly(),
      security_advisory: DependabotAlertSecurityAdvisorySchema,
      security_vulnerability: DependabotAlertSecurityVulnerabilitySchema,
      url: AlertUrlSchema,
      html_url: AlertHtmlUrlSchema,
      created_at: AlertCreatedAtSchema,
      updated_at: AlertUpdatedAtSchema,
      dismissed_at: AlertDismissedAtSchema,
      dismissed_by: NullableSimpleUserSchema,
      dismissed_reason: z
        .enum([
          'fix_started',
          'inaccurate',
          'no_bandwidth',
          'not_used',
          'tolerable_risk'
        ])
        .describe('The reason that the alert was dismissed.'),
      dismissed_comment: z
        .string()
        .max(280)
        .describe("An optional comment associated with the alert's dismissal."),
      fixed_at: AlertFixedAtSchema,
      auto_dismissed_at: AlertAutoDismissedAtSchema.optional()
    })
    .strict()
    .describe('A Dependabot alert.')
  export type DependabotAlert = z.infer<typeof DependabotAlertSchema>

  export const BranchWithProtectionSchema = z
    .object({
      name: z.string(),
      commit: CommitSchema,
      _links: z.object({ html: z.string(), self: z.string().url() }),
      protected: z.boolean(),
      protection: BranchProtectionSchema,
      protection_url: z.string().url(),
      pattern: z.string().optional(),
      required_approving_review_count: z.number().int().optional()
    })
    .describe('Branch With Protection')
  export type BranchWithProtection = z.infer<typeof BranchWithProtectionSchema>

  export const DependabotAlertWithRepositorySchema = z
    .object({
      number: AlertNumberSchema,
      state: z
        .enum(['auto_dismissed', 'dismissed', 'fixed', 'open'])
        .describe('The state of the Dependabot alert.')
        .readonly(),
      dependency: z
        .object({
          package: DependabotAlertPackageSchema.optional(),
          manifest_path: z
            .string()
            .describe(
              'The full path to the dependency manifest file, relative to the root of the repository.'
            )
            .readonly()
            .optional(),
          scope: z
            .enum(['development', 'runtime'])
            .describe('The execution scope of the vulnerable dependency.')
            .readonly()
            .optional(),
          relationship: z
            .enum(['unknown', 'direct', 'transitive'])
            .describe(
              'The vulnerable dependency\'s relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.\n'
            )
            .readonly()
            .optional()
        })
        .describe('Details for the vulnerable dependency.')
        .readonly(),
      security_advisory: DependabotAlertSecurityAdvisorySchema,
      security_vulnerability: DependabotAlertSecurityVulnerabilitySchema,
      url: AlertUrlSchema,
      html_url: AlertHtmlUrlSchema,
      created_at: AlertCreatedAtSchema,
      updated_at: AlertUpdatedAtSchema,
      dismissed_at: AlertDismissedAtSchema,
      dismissed_by: NullableSimpleUserSchema,
      dismissed_reason: z
        .enum([
          'fix_started',
          'inaccurate',
          'no_bandwidth',
          'not_used',
          'tolerable_risk'
        ])
        .describe('The reason that the alert was dismissed.'),
      dismissed_comment: z
        .string()
        .max(280)
        .describe("An optional comment associated with the alert's dismissal."),
      fixed_at: AlertFixedAtSchema,
      auto_dismissed_at: AlertAutoDismissedAtSchema.optional(),
      repository: SimpleRepositorySchema
    })
    .strict()
    .describe('A Dependabot alert.')
  export type DependabotAlertWithRepository = z.infer<
    typeof DependabotAlertWithRepositorySchema
  >

  export const IssueEventSchema = z
    .object({
      id: z.number().int(),
      node_id: z.string(),
      url: z.string().url(),
      actor: NullableSimpleUserSchema,
      event: z.string(),
      commit_id: z.string(),
      commit_url: z.string(),
      created_at: z.string().datetime({ offset: true }),
      issue: NullableIssueSchema.optional(),
      label: IssueEventLabelSchema.optional(),
      assignee: NullableSimpleUserSchema.optional(),
      assigner: NullableSimpleUserSchema.optional(),
      review_requester: NullableSimpleUserSchema.optional(),
      requested_reviewer: NullableSimpleUserSchema.optional(),
      requested_team: TeamSchema.optional(),
      dismissed_review: IssueEventDismissedReviewSchema.optional(),
      milestone: IssueEventMilestoneSchema.optional(),
      project_card: IssueEventProjectCardSchema.optional(),
      rename: IssueEventRenameSchema.optional(),
      author_association: AuthorAssociationSchema.optional(),
      lock_reason: z.string().optional(),
      performed_via_github_app: NullableIntegrationSchema.optional()
    })
    .describe('Issue Event')
  export type IssueEvent = z.infer<typeof IssueEventSchema>

  export const IssueEventForIssueSchema = z
    .union([
      LabeledIssueEventSchema,
      UnlabeledIssueEventSchema,
      AssignedIssueEventSchema,
      UnassignedIssueEventSchema,
      MilestonedIssueEventSchema,
      DemilestonedIssueEventSchema,
      RenamedIssueEventSchema,
      ReviewRequestedIssueEventSchema,
      ReviewRequestRemovedIssueEventSchema,
      ReviewDismissedIssueEventSchema,
      LockedIssueEventSchema,
      AddedToProjectIssueEventSchema,
      MovedColumnInProjectIssueEventSchema,
      RemovedFromProjectIssueEventSchema,
      ConvertedNoteToIssueIssueEventSchema
    ])
    .describe('Issue Event for Issue')
  export type IssueEventForIssue = z.infer<typeof IssueEventForIssueSchema>

  export const RepositoryRuleSchema = z
    .record(z.any())
    .and(
      z.union([
        RepositoryRuleCreationSchema,
        RepositoryRuleUpdateSchema,
        RepositoryRuleDeletionSchema,
        RepositoryRuleRequiredLinearHistorySchema,
        RepositoryRuleMergeQueueSchema,
        RepositoryRuleRequiredDeploymentsSchema,
        RepositoryRuleRequiredSignaturesSchema,
        RepositoryRulePullRequestSchema,
        RepositoryRuleRequiredStatusChecksSchema,
        RepositoryRuleNonFastForwardSchema,
        RepositoryRuleCommitMessagePatternSchema,
        RepositoryRuleCommitAuthorEmailPatternSchema,
        RepositoryRuleCommitterEmailPatternSchema,
        RepositoryRuleBranchNamePatternSchema,
        RepositoryRuleTagNamePatternSchema,
        RepositoryRuleFilePathRestrictionSchema,
        RepositoryRuleMaxFilePathLengthSchema,
        RepositoryRuleFileExtensionRestrictionSchema,
        RepositoryRuleMaxFileSizeSchema,
        RepositoryRuleWorkflowsSchema,
        RepositoryRuleCodeScanningSchema
      ])
    )
    .describe('A repository rule.')
  export type RepositoryRule = z.infer<typeof RepositoryRuleSchema>

  export const CodeScanningAlertItemsSchema = z.object({
    number: AlertNumberSchema,
    created_at: AlertCreatedAtSchema,
    updated_at: AlertUpdatedAtSchema.optional(),
    url: AlertUrlSchema,
    html_url: AlertHtmlUrlSchema,
    instances_url: AlertInstancesUrlSchema,
    state: CodeScanningAlertStateSchema,
    fixed_at: AlertFixedAtSchema.optional(),
    dismissed_by: NullableSimpleUserSchema,
    dismissed_at: AlertDismissedAtSchema,
    dismissed_reason: CodeScanningAlertDismissedReasonSchema,
    dismissed_comment: CodeScanningAlertDismissedCommentSchema.optional(),
    rule: CodeScanningAlertRuleSummarySchema,
    tool: CodeScanningAnalysisToolSchema,
    most_recent_instance: CodeScanningAlertInstanceSchema,
    dismissal_approved_by: NullableSimpleUserSchema.optional()
  })
  export type CodeScanningAlertItems = z.infer<
    typeof CodeScanningAlertItemsSchema
  >

  export const CodeScanningAlertSchema = z.object({
    number: AlertNumberSchema,
    created_at: AlertCreatedAtSchema,
    updated_at: AlertUpdatedAtSchema.optional(),
    url: AlertUrlSchema,
    html_url: AlertHtmlUrlSchema,
    instances_url: AlertInstancesUrlSchema,
    state: CodeScanningAlertStateSchema,
    fixed_at: AlertFixedAtSchema.optional(),
    dismissed_by: NullableSimpleUserSchema,
    dismissed_at: AlertDismissedAtSchema,
    dismissed_reason: CodeScanningAlertDismissedReasonSchema,
    dismissed_comment: CodeScanningAlertDismissedCommentSchema.optional(),
    rule: CodeScanningAlertRuleSchema,
    tool: CodeScanningAnalysisToolSchema,
    most_recent_instance: CodeScanningAlertInstanceSchema,
    dismissal_approved_by: NullableSimpleUserSchema.optional()
  })
  export type CodeScanningAlert = z.infer<typeof CodeScanningAlertSchema>

  export const RepositoryRuleDetailedSchema = z
    .record(z.any())
    .and(
      z.union([
        z.intersection(
          RepositoryRuleCreationSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleUpdateSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleDeletionSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleRequiredLinearHistorySchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleMergeQueueSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleRequiredDeploymentsSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleRequiredSignaturesSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRulePullRequestSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleRequiredStatusChecksSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleNonFastForwardSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleCommitMessagePatternSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleCommitAuthorEmailPatternSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleCommitterEmailPatternSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleBranchNamePatternSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleTagNamePatternSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleFilePathRestrictionSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleMaxFilePathLengthSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleFileExtensionRestrictionSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleMaxFileSizeSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleWorkflowsSchema,
          RepositoryRuleRulesetInfoSchema
        ),
        z.intersection(
          RepositoryRuleCodeScanningSchema,
          RepositoryRuleRulesetInfoSchema
        )
      ])
    )
    .describe('A repository rule with ruleset details.')
  export type RepositoryRuleDetailed = z.infer<
    typeof RepositoryRuleDetailedSchema
  >

  export const CodeScanningOrganizationAlertItemsSchema = z.object({
    number: AlertNumberSchema,
    created_at: AlertCreatedAtSchema,
    updated_at: AlertUpdatedAtSchema.optional(),
    url: AlertUrlSchema,
    html_url: AlertHtmlUrlSchema,
    instances_url: AlertInstancesUrlSchema,
    state: CodeScanningAlertStateSchema,
    fixed_at: AlertFixedAtSchema.optional(),
    dismissed_by: NullableSimpleUserSchema,
    dismissed_at: AlertDismissedAtSchema,
    dismissed_reason: CodeScanningAlertDismissedReasonSchema,
    dismissed_comment: CodeScanningAlertDismissedCommentSchema.optional(),
    rule: CodeScanningAlertRuleSummarySchema,
    tool: CodeScanningAnalysisToolSchema,
    most_recent_instance: CodeScanningAlertInstanceSchema,
    repository: SimpleRepositorySchema,
    dismissal_approved_by: NullableSimpleUserSchema.optional()
  })
  export type CodeScanningOrganizationAlertItems = z.infer<
    typeof CodeScanningOrganizationAlertItemsSchema
  >

  export const RepositoryRulesetSchema = z
    .object({
      id: z.number().int().describe('The ID of the ruleset'),
      name: z.string().describe('The name of the ruleset'),
      target: z
        .enum(['branch', 'tag', 'push', 'repository'])
        .describe('The target of the ruleset')
        .optional(),
      source_type: z
        .enum(['Repository', 'Organization', 'Enterprise'])
        .describe('The type of the source of the ruleset')
        .optional(),
      source: z.string().describe('The name of the source'),
      enforcement: RepositoryRuleEnforcementSchema,
      bypass_actors: z
        .array(RepositoryRulesetBypassActorSchema)
        .describe('The actors that can bypass the rules in this ruleset')
        .optional(),
      current_user_can_bypass: z
        .enum(['always', 'pull_requests_only', 'never'])
        .describe(
          'The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.'
        )
        .optional(),
      node_id: z.string().optional(),
      _links: z
        .object({
          self: z
            .object({
              href: z.string().describe('The URL of the ruleset').optional()
            })
            .optional(),
          html: z
            .object({
              href: z
                .string()
                .describe('The html URL of the ruleset')
                .optional()
            })
            .optional()
        })
        .optional(),
      conditions: z
        .union([RepositoryRulesetConditionsSchema, OrgRulesetConditionsSchema])
        .optional(),
      rules: z.array(RepositoryRuleSchema).optional(),
      created_at: z.string().datetime({ offset: true }).optional(),
      updated_at: z.string().datetime({ offset: true }).optional()
    })
    .describe('A set of rules to apply when specified conditions are met.')
  export type RepositoryRuleset = z.infer<typeof RepositoryRulesetSchema>

  export const TimelineIssueEventsSchema = z
    .record(z.any())
    .and(
      z.union([
        LabeledIssueEventSchema,
        UnlabeledIssueEventSchema,
        MilestonedIssueEventSchema,
        DemilestonedIssueEventSchema,
        RenamedIssueEventSchema,
        ReviewRequestedIssueEventSchema,
        ReviewRequestRemovedIssueEventSchema,
        ReviewDismissedIssueEventSchema,
        LockedIssueEventSchema,
        AddedToProjectIssueEventSchema,
        MovedColumnInProjectIssueEventSchema,
        RemovedFromProjectIssueEventSchema,
        ConvertedNoteToIssueIssueEventSchema,
        TimelineCommentEventSchema,
        TimelineCrossReferencedEventSchema,
        TimelineCommittedEventSchema,
        TimelineReviewedEventSchema,
        TimelineLineCommentedEventSchema,
        TimelineCommitCommentedEventSchema,
        TimelineAssignedIssueEventSchema,
        TimelineUnassignedIssueEventSchema,
        StateChangeIssueEventSchema
      ])
    )
    .describe('Timeline Event')
  export type TimelineIssueEvents = z.infer<typeof TimelineIssueEventsSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const MetaRootParamsSchema = z.object({})
  export type MetaRootParams = z.infer<typeof MetaRootParamsSchema>

  export const MetaRootResponseSchema = RootSchema
  export type MetaRootResponse = z.infer<typeof MetaRootResponseSchema>

  export const SecurityAdvisoriesListGlobalAdvisoriesParamsSchema = z.object({
    ghsa_id: z
      .string()
      .describe(
        'If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.'
      )
      .optional(),
    type: z
      .enum(['reviewed', 'malware', 'unreviewed'])
      .describe(
        'If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.'
      )
      .default('reviewed'),
    cve_id: z
      .string()
      .describe(
        'If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.'
      )
      .optional(),
    ecosystem: z
      .any()
      .describe(
        'If specified, only advisories for these ecosystems will be returned.'
      )
      .optional(),
    severity: z
      .enum(['unknown', 'low', 'medium', 'high', 'critical'])
      .describe(
        'If specified, only advisories with these severities will be returned.'
      )
      .optional(),
    cwes: z
      .union([z.string(), z.array(z.string())])
      .describe(
        'If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`'
      )
      .optional(),
    is_withdrawn: z
      .boolean()
      .describe('Whether to only return advisories that have been withdrawn.')
      .optional(),
    affects: z
      .union([z.string(), z.array(z.string()).max(1000)])
      .describe(
        'If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`'
      )
      .optional(),
    published: z
      .string()
      .describe(
        'If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
      )
      .optional(),
    updated: z
      .string()
      .describe(
        'If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
      )
      .optional(),
    modified: z
      .string()
      .describe(
        'If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
      )
      .optional(),
    epss_percentage: z
      .string()
      .describe(
        'If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.'
      )
      .optional(),
    epss_percentile: z
      .string()
      .describe(
        "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs."
      )
      .optional(),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    sort: z
      .enum(['updated', 'published', 'epss_percentage', 'epss_percentile'])
      .describe('The property to sort the results by.')
      .default('published')
  })
  export type SecurityAdvisoriesListGlobalAdvisoriesParams = z.infer<
    typeof SecurityAdvisoriesListGlobalAdvisoriesParamsSchema
  >

  export const SecurityAdvisoriesListGlobalAdvisoriesResponseSchema =
    z.array(GlobalAdvisorySchema)
  export type SecurityAdvisoriesListGlobalAdvisoriesResponse = z.infer<
    typeof SecurityAdvisoriesListGlobalAdvisoriesResponseSchema
  >

  export const SecurityAdvisoriesGetGlobalAdvisoryParamsSchema = z.object({
    ghsa_id: z
      .string()
      .describe(
        'The GHSA (GitHub Security Advisory) identifier of the advisory.'
      )
  })
  export type SecurityAdvisoriesGetGlobalAdvisoryParams = z.infer<
    typeof SecurityAdvisoriesGetGlobalAdvisoryParamsSchema
  >

  export const SecurityAdvisoriesGetGlobalAdvisoryResponseSchema =
    GlobalAdvisorySchema
  export type SecurityAdvisoriesGetGlobalAdvisoryResponse = z.infer<
    typeof SecurityAdvisoriesGetGlobalAdvisoryResponseSchema
  >

  export const AppsGetAuthenticatedParamsSchema = z.object({})
  export type AppsGetAuthenticatedParams = z.infer<
    typeof AppsGetAuthenticatedParamsSchema
  >

  export const AppsGetAuthenticatedResponseSchema = IntegrationSchema
  export type AppsGetAuthenticatedResponse = z.infer<
    typeof AppsGetAuthenticatedResponseSchema
  >

  export const AppsCreateFromManifestParamsSchema = z.object({
    code: z.string()
  })
  export type AppsCreateFromManifestParams = z.infer<
    typeof AppsCreateFromManifestParamsSchema
  >

  export type AppsCreateFromManifestResponse = undefined

  export const AppsGetWebhookConfigForAppParamsSchema = z.object({})
  export type AppsGetWebhookConfigForAppParams = z.infer<
    typeof AppsGetWebhookConfigForAppParamsSchema
  >

  export const AppsGetWebhookConfigForAppResponseSchema = WebhookConfigSchema
  export type AppsGetWebhookConfigForAppResponse = z.infer<
    typeof AppsGetWebhookConfigForAppResponseSchema
  >

  export const AppsUpdateWebhookConfigForAppParamsSchema = z.object({
    url: WebhookConfigUrlSchema.optional(),
    content_type: WebhookConfigContentTypeSchema.optional(),
    secret: WebhookConfigSecretSchema.optional(),
    insecure_ssl: WebhookConfigInsecureSslSchema.optional()
  })
  export type AppsUpdateWebhookConfigForAppParams = z.infer<
    typeof AppsUpdateWebhookConfigForAppParamsSchema
  >

  export const AppsUpdateWebhookConfigForAppResponseSchema = WebhookConfigSchema
  export type AppsUpdateWebhookConfigForAppResponse = z.infer<
    typeof AppsUpdateWebhookConfigForAppResponseSchema
  >

  export const AppsListWebhookDeliveriesParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    cursor: z
      .string()
      .describe(
        'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.'
      )
      .optional()
  })
  export type AppsListWebhookDeliveriesParams = z.infer<
    typeof AppsListWebhookDeliveriesParamsSchema
  >

  export const AppsListWebhookDeliveriesResponseSchema = z.array(
    HookDeliveryItemSchema
  )
  export type AppsListWebhookDeliveriesResponse = z.infer<
    typeof AppsListWebhookDeliveriesResponseSchema
  >

  export const AppsGetWebhookDeliveryParamsSchema = z.object({
    delivery_id: z.number().int()
  })
  export type AppsGetWebhookDeliveryParams = z.infer<
    typeof AppsGetWebhookDeliveryParamsSchema
  >

  export const AppsGetWebhookDeliveryResponseSchema = HookDeliverySchema
  export type AppsGetWebhookDeliveryResponse = z.infer<
    typeof AppsGetWebhookDeliveryResponseSchema
  >

  export const AppsRedeliverWebhookDeliveryParamsSchema = z.object({
    delivery_id: z.number().int()
  })
  export type AppsRedeliverWebhookDeliveryParams = z.infer<
    typeof AppsRedeliverWebhookDeliveryParamsSchema
  >

  export type AppsRedeliverWebhookDeliveryResponse = undefined

  export const AppsListInstallationRequestsForAuthenticatedAppParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type AppsListInstallationRequestsForAuthenticatedAppParams = z.infer<
    typeof AppsListInstallationRequestsForAuthenticatedAppParamsSchema
  >

  export const AppsListInstallationRequestsForAuthenticatedAppResponseSchema =
    z.array(IntegrationInstallationRequestSchema)
  export type AppsListInstallationRequestsForAuthenticatedAppResponse = z.infer<
    typeof AppsListInstallationRequestsForAuthenticatedAppResponseSchema
  >

  export const AppsListInstallationsParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    outdated: z.string().optional()
  })
  export type AppsListInstallationsParams = z.infer<
    typeof AppsListInstallationsParamsSchema
  >

  export const AppsListInstallationsResponseSchema = z.array(InstallationSchema)
  export type AppsListInstallationsResponse = z.infer<
    typeof AppsListInstallationsResponseSchema
  >

  export const AppsGetInstallationParamsSchema = z.object({
    installation_id: z
      .number()
      .int()
      .describe('The unique identifier of the installation.')
  })
  export type AppsGetInstallationParams = z.infer<
    typeof AppsGetInstallationParamsSchema
  >

  export const AppsGetInstallationResponseSchema = InstallationSchema
  export type AppsGetInstallationResponse = z.infer<
    typeof AppsGetInstallationResponseSchema
  >

  export const AppsDeleteInstallationParamsSchema = z.object({
    installation_id: z
      .number()
      .int()
      .describe('The unique identifier of the installation.')
  })
  export type AppsDeleteInstallationParams = z.infer<
    typeof AppsDeleteInstallationParamsSchema
  >

  export type AppsDeleteInstallationResponse = undefined

  export const AppsCreateInstallationAccessTokenParamsSchema = z.object({
    repositories: z
      .array(z.string())
      .describe('List of repository names that the token should have access to')
      .optional(),
    repository_ids: z
      .array(z.number().int())
      .describe('List of repository IDs that the token should have access to')
      .optional(),
    permissions: AppPermissionsSchema.optional(),
    installation_id: z
      .number()
      .int()
      .describe('The unique identifier of the installation.')
  })
  export type AppsCreateInstallationAccessTokenParams = z.infer<
    typeof AppsCreateInstallationAccessTokenParamsSchema
  >

  export type AppsCreateInstallationAccessTokenResponse = undefined

  export const AppsSuspendInstallationParamsSchema = z.object({
    installation_id: z
      .number()
      .int()
      .describe('The unique identifier of the installation.')
  })
  export type AppsSuspendInstallationParams = z.infer<
    typeof AppsSuspendInstallationParamsSchema
  >

  export type AppsSuspendInstallationResponse = undefined

  export const AppsUnsuspendInstallationParamsSchema = z.object({
    installation_id: z
      .number()
      .int()
      .describe('The unique identifier of the installation.')
  })
  export type AppsUnsuspendInstallationParams = z.infer<
    typeof AppsUnsuspendInstallationParamsSchema
  >

  export type AppsUnsuspendInstallationResponse = undefined

  export const AppsDeleteAuthorizationParamsSchema = z.object({
    access_token: z
      .string()
      .describe(
        'The OAuth access token used to authenticate to the GitHub API.'
      ),
    client_id: z.string().describe('The client ID of the GitHub app.')
  })
  export type AppsDeleteAuthorizationParams = z.infer<
    typeof AppsDeleteAuthorizationParamsSchema
  >

  export type AppsDeleteAuthorizationResponse = undefined

  export const AppsCheckTokenParamsSchema = z.object({
    access_token: z
      .string()
      .describe('The access_token of the OAuth or GitHub application.'),
    client_id: z.string().describe('The client ID of the GitHub app.')
  })
  export type AppsCheckTokenParams = z.infer<typeof AppsCheckTokenParamsSchema>

  export const AppsCheckTokenResponseSchema = AuthorizationSchema
  export type AppsCheckTokenResponse = z.infer<
    typeof AppsCheckTokenResponseSchema
  >

  export const AppsDeleteTokenParamsSchema = z.object({
    access_token: z
      .string()
      .describe(
        'The OAuth access token used to authenticate to the GitHub API.'
      ),
    client_id: z.string().describe('The client ID of the GitHub app.')
  })
  export type AppsDeleteTokenParams = z.infer<
    typeof AppsDeleteTokenParamsSchema
  >

  export type AppsDeleteTokenResponse = undefined

  export const AppsResetTokenParamsSchema = z.object({
    access_token: z
      .string()
      .describe('The access_token of the OAuth or GitHub application.'),
    client_id: z.string().describe('The client ID of the GitHub app.')
  })
  export type AppsResetTokenParams = z.infer<typeof AppsResetTokenParamsSchema>

  export const AppsResetTokenResponseSchema = AuthorizationSchema
  export type AppsResetTokenResponse = z.infer<
    typeof AppsResetTokenResponseSchema
  >

  export const AppsScopeTokenParamsSchema = z.object({
    access_token: z
      .string()
      .describe('The access token used to authenticate to the GitHub API.'),
    target: z
      .string()
      .describe(
        'The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.'
      )
      .optional(),
    target_id: z
      .number()
      .int()
      .describe(
        'The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.'
      )
      .optional(),
    repositories: z
      .array(z.string())
      .describe(
        'The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.'
      )
      .optional(),
    repository_ids: z
      .array(z.number().int())
      .describe(
        'The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.'
      )
      .optional(),
    permissions: AppPermissionsSchema.optional(),
    client_id: z.string().describe('The client ID of the GitHub app.')
  })
  export type AppsScopeTokenParams = z.infer<typeof AppsScopeTokenParamsSchema>

  export const AppsScopeTokenResponseSchema = AuthorizationSchema
  export type AppsScopeTokenResponse = z.infer<
    typeof AppsScopeTokenResponseSchema
  >

  export const AppsGetBySlugParamsSchema = z.object({ app_slug: z.string() })
  export type AppsGetBySlugParams = z.infer<typeof AppsGetBySlugParamsSchema>

  export const AppsGetBySlugResponseSchema = IntegrationSchema
  export type AppsGetBySlugResponse = z.infer<
    typeof AppsGetBySlugResponseSchema
  >

  export const ClassroomGetAnAssignmentParamsSchema = z.object({
    assignment_id: z
      .number()
      .int()
      .describe('The unique identifier of the classroom assignment.')
  })
  export type ClassroomGetAnAssignmentParams = z.infer<
    typeof ClassroomGetAnAssignmentParamsSchema
  >

  export const ClassroomGetAnAssignmentResponseSchema =
    ClassroomAssignmentSchema
  export type ClassroomGetAnAssignmentResponse = z.infer<
    typeof ClassroomGetAnAssignmentResponseSchema
  >

  export const ClassroomListAcceptedAssignmentsForAnAssignmentParamsSchema =
    z.object({
      assignment_id: z
        .number()
        .int()
        .describe('The unique identifier of the classroom assignment.'),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30)
    })
  export type ClassroomListAcceptedAssignmentsForAnAssignmentParams = z.infer<
    typeof ClassroomListAcceptedAssignmentsForAnAssignmentParamsSchema
  >

  export const ClassroomListAcceptedAssignmentsForAnAssignmentResponseSchema =
    z.array(ClassroomAcceptedAssignmentSchema)
  export type ClassroomListAcceptedAssignmentsForAnAssignmentResponse = z.infer<
    typeof ClassroomListAcceptedAssignmentsForAnAssignmentResponseSchema
  >

  export const ClassroomGetAssignmentGradesParamsSchema = z.object({
    assignment_id: z
      .number()
      .int()
      .describe('The unique identifier of the classroom assignment.')
  })
  export type ClassroomGetAssignmentGradesParams = z.infer<
    typeof ClassroomGetAssignmentGradesParamsSchema
  >

  export const ClassroomGetAssignmentGradesResponseSchema = z.array(
    ClassroomAssignmentGradeSchema
  )
  export type ClassroomGetAssignmentGradesResponse = z.infer<
    typeof ClassroomGetAssignmentGradesResponseSchema
  >

  export const ClassroomListClassroomsParamsSchema = z.object({
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ClassroomListClassroomsParams = z.infer<
    typeof ClassroomListClassroomsParamsSchema
  >

  export const ClassroomListClassroomsResponseSchema = z.array(
    SimpleClassroomSchema
  )
  export type ClassroomListClassroomsResponse = z.infer<
    typeof ClassroomListClassroomsResponseSchema
  >

  export const ClassroomGetAclassroomParamsSchema = z.object({
    classroom_id: z
      .number()
      .int()
      .describe('The unique identifier of the classroom.')
  })
  export type ClassroomGetAclassroomParams = z.infer<
    typeof ClassroomGetAclassroomParamsSchema
  >

  export const ClassroomGetAclassroomResponseSchema = ClassroomSchema
  export type ClassroomGetAclassroomResponse = z.infer<
    typeof ClassroomGetAclassroomResponseSchema
  >

  export const ClassroomListAssignmentsForAclassroomParamsSchema = z.object({
    classroom_id: z
      .number()
      .int()
      .describe('The unique identifier of the classroom.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ClassroomListAssignmentsForAclassroomParams = z.infer<
    typeof ClassroomListAssignmentsForAclassroomParamsSchema
  >

  export const ClassroomListAssignmentsForAclassroomResponseSchema = z.array(
    SimpleClassroomAssignmentSchema
  )
  export type ClassroomListAssignmentsForAclassroomResponse = z.infer<
    typeof ClassroomListAssignmentsForAclassroomResponseSchema
  >

  export const CodesOfConductGetAllCodesOfConductParamsSchema = z.object({})
  export type CodesOfConductGetAllCodesOfConductParams = z.infer<
    typeof CodesOfConductGetAllCodesOfConductParamsSchema
  >

  export const CodesOfConductGetAllCodesOfConductResponseSchema =
    z.array(CodeOfConductSchema)
  export type CodesOfConductGetAllCodesOfConductResponse = z.infer<
    typeof CodesOfConductGetAllCodesOfConductResponseSchema
  >

  export const CodesOfConductGetConductCodeParamsSchema = z.object({
    key: z.string()
  })
  export type CodesOfConductGetConductCodeParams = z.infer<
    typeof CodesOfConductGetConductCodeParamsSchema
  >

  export const CodesOfConductGetConductCodeResponseSchema = CodeOfConductSchema
  export type CodesOfConductGetConductCodeResponse = z.infer<
    typeof CodesOfConductGetConductCodeResponseSchema
  >

  export const EmojisGetParamsSchema = z.object({})
  export type EmojisGetParams = z.infer<typeof EmojisGetParamsSchema>

  export const EmojisGetResponseSchema = z.record(z.string())
  export type EmojisGetResponse = z.infer<typeof EmojisGetResponseSchema>

  export const CodeSecurityGetConfigurationsForEnterpriseParamsSchema =
    z.object({
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      before: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      after: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional()
    })
  export type CodeSecurityGetConfigurationsForEnterpriseParams = z.infer<
    typeof CodeSecurityGetConfigurationsForEnterpriseParamsSchema
  >

  export const CodeSecurityGetConfigurationsForEnterpriseResponseSchema =
    z.array(CodeSecurityConfigurationSchema)
  export type CodeSecurityGetConfigurationsForEnterpriseResponse = z.infer<
    typeof CodeSecurityGetConfigurationsForEnterpriseResponseSchema
  >

  export const CodeSecurityCreateConfigurationForEnterpriseParamsSchema =
    z.object({
      name: z
        .string()
        .describe(
          'The name of the code security configuration. Must be unique within the enterprise.'
        ),
      description: z
        .string()
        .max(255)
        .describe('A description of the code security configuration'),
      advanced_security: z
        .enum(['enabled', 'disabled'])
        .describe('The enablement status of GitHub Advanced Security')
        .default('disabled'),
      dependency_graph: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependency Graph')
        .default('enabled'),
      dependency_graph_autosubmit_action: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Automatic dependency submission')
        .default('disabled'),
      dependency_graph_autosubmit_action_options: z
        .object({
          labeled_runners: z
            .boolean()
            .describe(
              "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
            )
            .default(false)
        })
        .describe('Feature options for Automatic dependency submission')
        .optional(),
      dependabot_alerts: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot alerts')
        .default('disabled'),
      dependabot_security_updates: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot security updates')
        .default('disabled'),
      code_scanning_default_setup: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of code scanning default setup')
        .default('disabled'),
      code_scanning_default_setup_options:
        CodeScanningDefaultSetupOptionsSchema.optional(),
      code_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of code scanning delegated alert dismissal'
        )
        .default('disabled'),
      secret_scanning: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning')
        .default('disabled'),
      secret_scanning_push_protection: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning push protection')
        .default('disabled'),
      secret_scanning_validity_checks: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning validity checks')
        .default('disabled'),
      secret_scanning_non_provider_patterns: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning non provider patterns'
        )
        .default('disabled'),
      secret_scanning_generic_secrets: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Copilot secret scanning')
        .default('disabled'),
      secret_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning delegated alert dismissal'
        )
        .default('disabled'),
      private_vulnerability_reporting: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of private vulnerability reporting')
        .default('disabled'),
      enforcement: z
        .enum(['enforced', 'unenforced'])
        .describe('The enforcement status for a security configuration')
        .default('enforced'),
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        )
    })
  export type CodeSecurityCreateConfigurationForEnterpriseParams = z.infer<
    typeof CodeSecurityCreateConfigurationForEnterpriseParamsSchema
  >

  export type CodeSecurityCreateConfigurationForEnterpriseResponse = undefined

  export const CodeSecurityGetDefaultConfigurationsForEnterpriseParamsSchema =
    z.object({
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        )
    })
  export type CodeSecurityGetDefaultConfigurationsForEnterpriseParams = z.infer<
    typeof CodeSecurityGetDefaultConfigurationsForEnterpriseParamsSchema
  >

  export const CodeSecurityGetDefaultConfigurationsForEnterpriseResponseSchema =
    CodeSecurityDefaultConfigurationsSchema
  export type CodeSecurityGetDefaultConfigurationsForEnterpriseResponse =
    z.infer<
      typeof CodeSecurityGetDefaultConfigurationsForEnterpriseResponseSchema
    >

  export const CodeSecurityGetSingleConfigurationForEnterpriseParamsSchema =
    z.object({
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.')
    })
  export type CodeSecurityGetSingleConfigurationForEnterpriseParams = z.infer<
    typeof CodeSecurityGetSingleConfigurationForEnterpriseParamsSchema
  >

  export const CodeSecurityGetSingleConfigurationForEnterpriseResponseSchema =
    CodeSecurityConfigurationSchema
  export type CodeSecurityGetSingleConfigurationForEnterpriseResponse = z.infer<
    typeof CodeSecurityGetSingleConfigurationForEnterpriseResponseSchema
  >

  export const CodeSecurityDeleteConfigurationForEnterpriseParamsSchema =
    z.object({
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.')
    })
  export type CodeSecurityDeleteConfigurationForEnterpriseParams = z.infer<
    typeof CodeSecurityDeleteConfigurationForEnterpriseParamsSchema
  >

  export type CodeSecurityDeleteConfigurationForEnterpriseResponse = undefined

  export const CodeSecurityUpdateEnterpriseConfigurationParamsSchema = z.object(
    {
      name: z
        .string()
        .describe(
          'The name of the code security configuration. Must be unique across the enterprise.'
        )
        .optional(),
      description: z
        .string()
        .max(255)
        .describe('A description of the code security configuration')
        .optional(),
      advanced_security: z
        .enum(['enabled', 'disabled'])
        .describe(
          'The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.'
        )
        .optional(),
      dependency_graph: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependency Graph')
        .optional(),
      dependency_graph_autosubmit_action: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Automatic dependency submission')
        .optional(),
      dependency_graph_autosubmit_action_options: z
        .object({
          labeled_runners: z
            .boolean()
            .describe(
              "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
            )
            .optional()
        })
        .describe('Feature options for Automatic dependency submission')
        .optional(),
      dependabot_alerts: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot alerts')
        .optional(),
      dependabot_security_updates: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Dependabot security updates')
        .optional(),
      code_scanning_default_setup: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of code scanning default setup')
        .optional(),
      code_scanning_default_setup_options:
        CodeScanningDefaultSetupOptionsSchema.optional(),
      code_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of code scanning delegated alert dismissal'
        )
        .default('disabled'),
      secret_scanning: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning')
        .optional(),
      secret_scanning_push_protection: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning push protection')
        .optional(),
      secret_scanning_validity_checks: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of secret scanning validity checks')
        .optional(),
      secret_scanning_non_provider_patterns: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning non-provider patterns'
        )
        .optional(),
      secret_scanning_generic_secrets: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of Copilot secret scanning')
        .default('disabled'),
      secret_scanning_delegated_alert_dismissal: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe(
          'The enablement status of secret scanning delegated alert dismissal'
        )
        .default('disabled'),
      private_vulnerability_reporting: z
        .enum(['enabled', 'disabled', 'not_set'])
        .describe('The enablement status of private vulnerability reporting')
        .optional(),
      enforcement: z
        .enum(['enforced', 'unenforced'])
        .describe('The enforcement status for a security configuration')
        .optional(),
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.')
    }
  )
  export type CodeSecurityUpdateEnterpriseConfigurationParams = z.infer<
    typeof CodeSecurityUpdateEnterpriseConfigurationParamsSchema
  >

  export const CodeSecurityUpdateEnterpriseConfigurationResponseSchema =
    CodeSecurityConfigurationSchema
  export type CodeSecurityUpdateEnterpriseConfigurationResponse = z.infer<
    typeof CodeSecurityUpdateEnterpriseConfigurationResponseSchema
  >

  export const CodeSecurityAttachEnterpriseConfigurationParamsSchema = z.object(
    {
      scope: z
        .enum(['all', 'all_without_configurations'])
        .describe('The type of repositories to attach the configuration to.'),
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.')
    }
  )
  export type CodeSecurityAttachEnterpriseConfigurationParams = z.infer<
    typeof CodeSecurityAttachEnterpriseConfigurationParamsSchema
  >

  export type CodeSecurityAttachEnterpriseConfigurationResponse = undefined

  export const CodeSecuritySetConfigurationAsDefaultForEnterpriseParamsSchema =
    z.object({
      default_for_new_repos: z
        .enum(['all', 'none', 'private_and_internal', 'public'])
        .describe(
          'Specify which types of repository this security configuration should be applied to by default.'
        )
        .optional(),
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.')
    })
  export type CodeSecuritySetConfigurationAsDefaultForEnterpriseParams =
    z.infer<
      typeof CodeSecuritySetConfigurationAsDefaultForEnterpriseParamsSchema
    >

  export const CodeSecuritySetConfigurationAsDefaultForEnterpriseResponseSchema =
    z.object({
      default_for_new_repos: z
        .enum(['all', 'none', 'private_and_internal', 'public'])
        .describe(
          'Specifies which types of repository this security configuration is applied to by default.'
        )
        .optional(),
      configuration: CodeSecurityConfigurationSchema.optional()
    })
  export type CodeSecuritySetConfigurationAsDefaultForEnterpriseResponse =
    z.infer<
      typeof CodeSecuritySetConfigurationAsDefaultForEnterpriseResponseSchema
    >

  export const CodeSecurityGetRepositoriesForEnterpriseConfigurationParamsSchema =
    z.object({
      enterprise: z
        .string()
        .describe(
          'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
        ),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      before: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      after: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      status: z
        .string()
        .describe(
          'A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`'
        )
        .default('all')
    })
  export type CodeSecurityGetRepositoriesForEnterpriseConfigurationParams =
    z.infer<
      typeof CodeSecurityGetRepositoriesForEnterpriseConfigurationParamsSchema
    >

  export const CodeSecurityGetRepositoriesForEnterpriseConfigurationResponseSchema =
    z.array(CodeSecurityConfigurationRepositoriesSchema)
  export type CodeSecurityGetRepositoriesForEnterpriseConfigurationResponse =
    z.infer<
      typeof CodeSecurityGetRepositoriesForEnterpriseConfigurationResponseSchema
    >

  export const DependabotListAlertsForEnterpriseParamsSchema = z.object({
    enterprise: z
      .string()
      .describe(
        'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
      ),
    state: z
      .string()
      .describe(
        'A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`'
      )
      .optional(),
    severity: z
      .string()
      .describe(
        'A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`'
      )
      .optional(),
    ecosystem: z
      .string()
      .describe(
        'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`'
      )
      .optional(),
    package: z
      .string()
      .describe(
        'A comma-separated list of package names. If specified, only alerts for these packages will be returned.'
      )
      .optional(),
    epss_percentage: z
      .string()
      .describe(
        'CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.'
      )
      .optional(),
    scope: z
      .enum(['development', 'runtime'])
      .describe(
        'The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'epss_percentage'])
      .describe(
        "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage."
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    first: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.'
      )
      .default(30),
    last: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type DependabotListAlertsForEnterpriseParams = z.infer<
    typeof DependabotListAlertsForEnterpriseParamsSchema
  >

  export const DependabotListAlertsForEnterpriseResponseSchema = z.array(
    DependabotAlertWithRepositorySchema
  )
  export type DependabotListAlertsForEnterpriseResponse = z.infer<
    typeof DependabotListAlertsForEnterpriseResponseSchema
  >

  export const SecretScanningListAlertsForEnterpriseParamsSchema = z.object({
    enterprise: z
      .string()
      .describe(
        'The slug version of the enterprise name. You can also substitute this value with the enterprise id.'
      ),
    state: z
      .enum(['open', 'resolved'])
      .describe(
        'Set to `open` or `resolved` to only list secret scanning alerts in a specific state.'
      )
      .optional(),
    secret_type: z
      .string()
      .describe(
        'A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.'
      )
      .optional(),
    resolution: z
      .string()
      .describe(
        'A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated'])
      .describe(
        'The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.'
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    validity: z
      .string()
      .describe(
        'A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.'
      )
      .optional(),
    is_publicly_leaked: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.'
      )
      .default(false),
    is_multi_repo: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.'
      )
      .default(false)
  })
  export type SecretScanningListAlertsForEnterpriseParams = z.infer<
    typeof SecretScanningListAlertsForEnterpriseParamsSchema
  >

  export const SecretScanningListAlertsForEnterpriseResponseSchema = z.array(
    OrganizationSecretScanningAlertSchema
  )
  export type SecretScanningListAlertsForEnterpriseResponse = z.infer<
    typeof SecretScanningListAlertsForEnterpriseResponseSchema
  >

  export const ActivityListPublicEventsParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListPublicEventsParams = z.infer<
    typeof ActivityListPublicEventsParamsSchema
  >

  export const ActivityListPublicEventsResponseSchema = z.array(EventSchema)
  export type ActivityListPublicEventsResponse = z.infer<
    typeof ActivityListPublicEventsResponseSchema
  >

  export const ActivityGetFeedsParamsSchema = z.object({})
  export type ActivityGetFeedsParams = z.infer<
    typeof ActivityGetFeedsParamsSchema
  >

  export const ActivityGetFeedsResponseSchema = FeedSchema
  export type ActivityGetFeedsResponse = z.infer<
    typeof ActivityGetFeedsResponseSchema
  >

  export const GistsListParamsSchema = z.object({
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListParams = z.infer<typeof GistsListParamsSchema>

  export const GistsListResponseSchema = z.array(BaseGistSchema)
  export type GistsListResponse = z.infer<typeof GistsListResponseSchema>

  export const GistsCreateParamsSchema = z.object({
    description: z.string().describe('Description of the gist').optional(),
    files: z
      .record(z.object({ content: z.string().describe('Content of the file') }))
      .describe('Names and content for the files that make up the gist'),
    public: z
      .union([
        z
          .boolean()
          .describe('Flag indicating whether the gist is public')
          .default(false),
        z.enum(['true', 'false']).default('false')
      ])
      .optional()
  })
  export type GistsCreateParams = z.infer<typeof GistsCreateParamsSchema>

  export type GistsCreateResponse = undefined

  export const GistsListPublicParamsSchema = z.object({
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListPublicParams = z.infer<
    typeof GistsListPublicParamsSchema
  >

  export const GistsListPublicResponseSchema = z.array(BaseGistSchema)
  export type GistsListPublicResponse = z.infer<
    typeof GistsListPublicResponseSchema
  >

  export const GistsListStarredParamsSchema = z.object({
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListStarredParams = z.infer<
    typeof GistsListStarredParamsSchema
  >

  export const GistsListStarredResponseSchema = z.array(BaseGistSchema)
  export type GistsListStarredResponse = z.infer<
    typeof GistsListStarredResponseSchema
  >

  export const GistsGetParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsGetParams = z.infer<typeof GistsGetParamsSchema>

  export const GistsGetResponseSchema = GistSimpleSchema
  export type GistsGetResponse = z.infer<typeof GistsGetResponseSchema>

  export const GistsDeleteParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsDeleteParams = z.infer<typeof GistsDeleteParamsSchema>

  export type GistsDeleteResponse = undefined

  export const GistsUpdateParamsSchema = z.object({
    description: z.string().describe('The description of the gist.').optional(),
    files: z
      .record(
        z.object({
          content: z
            .string()
            .describe('The new content of the file.')
            .optional(),
          filename: z
            .string()
            .describe('The new filename for the file.')
            .optional()
        })
      )
      .describe(
        'The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be\ndeleted if the specified object does not contain at least one of `content` or `filename`.'
      )
      .optional(),
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsUpdateParams = z.infer<typeof GistsUpdateParamsSchema>

  export const GistsUpdateResponseSchema = GistSimpleSchema
  export type GistsUpdateResponse = z.infer<typeof GistsUpdateResponseSchema>

  export const GistsListCommentsParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListCommentsParams = z.infer<
    typeof GistsListCommentsParamsSchema
  >

  export const GistsListCommentsResponseSchema = z.array(GistCommentSchema)
  export type GistsListCommentsResponse = z.infer<
    typeof GistsListCommentsResponseSchema
  >

  export const GistsCreateCommentParamsSchema = z.object({
    body: z.string().max(65_535).describe('The comment text.'),
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsCreateCommentParams = z.infer<
    typeof GistsCreateCommentParamsSchema
  >

  export type GistsCreateCommentResponse = undefined

  export const GistsGetCommentParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type GistsGetCommentParams = z.infer<
    typeof GistsGetCommentParamsSchema
  >

  export const GistsGetCommentResponseSchema = GistCommentSchema
  export type GistsGetCommentResponse = z.infer<
    typeof GistsGetCommentResponseSchema
  >

  export const GistsDeleteCommentParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type GistsDeleteCommentParams = z.infer<
    typeof GistsDeleteCommentParamsSchema
  >

  export type GistsDeleteCommentResponse = undefined

  export const GistsUpdateCommentParamsSchema = z.object({
    body: z.string().max(65_535).describe('The comment text.'),
    gist_id: z.string().describe('The unique identifier of the gist.'),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type GistsUpdateCommentParams = z.infer<
    typeof GistsUpdateCommentParamsSchema
  >

  export const GistsUpdateCommentResponseSchema = GistCommentSchema
  export type GistsUpdateCommentResponse = z.infer<
    typeof GistsUpdateCommentResponseSchema
  >

  export const GistsListCommitsParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListCommitsParams = z.infer<
    typeof GistsListCommitsParamsSchema
  >

  export const GistsListCommitsResponseSchema = z.array(GistCommitSchema)
  export type GistsListCommitsResponse = z.infer<
    typeof GistsListCommitsResponseSchema
  >

  export const GistsListForksParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListForksParams = z.infer<typeof GistsListForksParamsSchema>

  export const GistsListForksResponseSchema = z.array(GistSimpleSchema)
  export type GistsListForksResponse = z.infer<
    typeof GistsListForksResponseSchema
  >

  export const GistsForkParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsForkParams = z.infer<typeof GistsForkParamsSchema>

  export type GistsForkResponse = undefined

  export const GistsCheckIsStarredParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsCheckIsStarredParams = z.infer<
    typeof GistsCheckIsStarredParamsSchema
  >

  export type GistsCheckIsStarredResponse = undefined

  export const GistsStarParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsStarParams = z.infer<typeof GistsStarParamsSchema>

  export type GistsStarResponse = undefined

  export const GistsUnstarParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.')
  })
  export type GistsUnstarParams = z.infer<typeof GistsUnstarParamsSchema>

  export type GistsUnstarResponse = undefined

  export const GistsGetRevisionParamsSchema = z.object({
    gist_id: z.string().describe('The unique identifier of the gist.'),
    sha: z.string()
  })
  export type GistsGetRevisionParams = z.infer<
    typeof GistsGetRevisionParamsSchema
  >

  export const GistsGetRevisionResponseSchema = GistSimpleSchema
  export type GistsGetRevisionResponse = z.infer<
    typeof GistsGetRevisionResponseSchema
  >

  export const GitignoreGetAllTemplatesParamsSchema = z.object({})
  export type GitignoreGetAllTemplatesParams = z.infer<
    typeof GitignoreGetAllTemplatesParamsSchema
  >

  export const GitignoreGetAllTemplatesResponseSchema = z.array(z.string())
  export type GitignoreGetAllTemplatesResponse = z.infer<
    typeof GitignoreGetAllTemplatesResponseSchema
  >

  export const GitignoreGetTemplateParamsSchema = z.object({ name: z.string() })
  export type GitignoreGetTemplateParams = z.infer<
    typeof GitignoreGetTemplateParamsSchema
  >

  export const GitignoreGetTemplateResponseSchema = GitignoreTemplateSchema
  export type GitignoreGetTemplateResponse = z.infer<
    typeof GitignoreGetTemplateResponseSchema
  >

  export const AppsListReposAccessibleToInstallationParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type AppsListReposAccessibleToInstallationParams = z.infer<
    typeof AppsListReposAccessibleToInstallationParamsSchema
  >

  export const AppsListReposAccessibleToInstallationResponseSchema = z.object({
    total_count: z.number().int(),
    repositories: z.array(RepositorySchema),
    repository_selection: z.string().optional()
  })
  export type AppsListReposAccessibleToInstallationResponse = z.infer<
    typeof AppsListReposAccessibleToInstallationResponseSchema
  >

  export const AppsRevokeInstallationAccessTokenParamsSchema = z.object({})
  export type AppsRevokeInstallationAccessTokenParams = z.infer<
    typeof AppsRevokeInstallationAccessTokenParamsSchema
  >

  export type AppsRevokeInstallationAccessTokenResponse = undefined

  export const IssuesListParamsSchema = z.object({
    filter: z
      .enum(['assigned', 'created', 'mentioned', 'subscribed', 'repos', 'all'])
      .describe(
        "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation."
      )
      .default('assigned'),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the issues to return.')
      .default('open'),
    labels: z
      .string()
      .describe(
        'A list of comma separated label names. Example: `bug,ui,@high`'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'comments'])
      .describe('What to sort results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    collab: z.boolean().optional(),
    orgs: z.boolean().optional(),
    owned: z.boolean().optional(),
    pulls: z.boolean().optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListParams = z.infer<typeof IssuesListParamsSchema>

  export const IssuesListResponseSchema = z.array(IssueSchema)
  export type IssuesListResponse = z.infer<typeof IssuesListResponseSchema>

  export const LicensesGetAllCommonlyUsedParamsSchema = z.object({
    featured: z.boolean().optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type LicensesGetAllCommonlyUsedParams = z.infer<
    typeof LicensesGetAllCommonlyUsedParamsSchema
  >

  export const LicensesGetAllCommonlyUsedResponseSchema =
    z.array(LicenseSimpleSchema)
  export type LicensesGetAllCommonlyUsedResponse = z.infer<
    typeof LicensesGetAllCommonlyUsedResponseSchema
  >

  export const LicensesGetParamsSchema = z.object({ license: z.string() })
  export type LicensesGetParams = z.infer<typeof LicensesGetParamsSchema>

  export const LicensesGetResponseSchema = LicenseSchema
  export type LicensesGetResponse = z.infer<typeof LicensesGetResponseSchema>

  export const MarkdownRenderParamsSchema = z.object({
    text: z.string().describe('The Markdown text to render in HTML.'),
    mode: z
      .enum(['markdown', 'gfm'])
      .describe('The rendering mode.')
      .default('markdown'),
    context: z
      .string()
      .describe(
        'The repository context to use when creating references in `gfm` mode.  For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.'
      )
      .optional()
  })
  export type MarkdownRenderParams = z.infer<typeof MarkdownRenderParamsSchema>

  export type MarkdownRenderResponse = undefined

  export const MarkdownRenderRawParamsSchema = z.object({})
  export type MarkdownRenderRawParams = z.infer<
    typeof MarkdownRenderRawParamsSchema
  >

  export type MarkdownRenderRawResponse = undefined

  export const AppsGetSubscriptionPlanForAccountParamsSchema = z.object({
    account_id: z.number().int().describe('account_id parameter')
  })
  export type AppsGetSubscriptionPlanForAccountParams = z.infer<
    typeof AppsGetSubscriptionPlanForAccountParamsSchema
  >

  export const AppsGetSubscriptionPlanForAccountResponseSchema =
    MarketplacePurchaseSchema
  export type AppsGetSubscriptionPlanForAccountResponse = z.infer<
    typeof AppsGetSubscriptionPlanForAccountResponseSchema
  >

  export const AppsListPlansParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type AppsListPlansParams = z.infer<typeof AppsListPlansParamsSchema>

  export const AppsListPlansResponseSchema = z.array(
    MarketplaceListingPlanSchema
  )
  export type AppsListPlansResponse = z.infer<
    typeof AppsListPlansResponseSchema
  >

  export const AppsListAccountsForPlanParamsSchema = z.object({
    plan_id: z.number().int().describe('The unique identifier of the plan.'),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property to sort the results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type AppsListAccountsForPlanParams = z.infer<
    typeof AppsListAccountsForPlanParamsSchema
  >

  export const AppsListAccountsForPlanResponseSchema = z.array(
    MarketplacePurchaseSchema
  )
  export type AppsListAccountsForPlanResponse = z.infer<
    typeof AppsListAccountsForPlanResponseSchema
  >

  export const AppsGetSubscriptionPlanForAccountStubbedParamsSchema = z.object({
    account_id: z.number().int().describe('account_id parameter')
  })
  export type AppsGetSubscriptionPlanForAccountStubbedParams = z.infer<
    typeof AppsGetSubscriptionPlanForAccountStubbedParamsSchema
  >

  export const AppsGetSubscriptionPlanForAccountStubbedResponseSchema =
    MarketplacePurchaseSchema
  export type AppsGetSubscriptionPlanForAccountStubbedResponse = z.infer<
    typeof AppsGetSubscriptionPlanForAccountStubbedResponseSchema
  >

  export const AppsListPlansStubbedParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type AppsListPlansStubbedParams = z.infer<
    typeof AppsListPlansStubbedParamsSchema
  >

  export const AppsListPlansStubbedResponseSchema = z.array(
    MarketplaceListingPlanSchema
  )
  export type AppsListPlansStubbedResponse = z.infer<
    typeof AppsListPlansStubbedResponseSchema
  >

  export const AppsListAccountsForPlanStubbedParamsSchema = z.object({
    plan_id: z.number().int().describe('The unique identifier of the plan.'),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property to sort the results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type AppsListAccountsForPlanStubbedParams = z.infer<
    typeof AppsListAccountsForPlanStubbedParamsSchema
  >

  export const AppsListAccountsForPlanStubbedResponseSchema = z.array(
    MarketplacePurchaseSchema
  )
  export type AppsListAccountsForPlanStubbedResponse = z.infer<
    typeof AppsListAccountsForPlanStubbedResponseSchema
  >

  export const MetaGetParamsSchema = z.object({})
  export type MetaGetParams = z.infer<typeof MetaGetParamsSchema>

  export const MetaGetResponseSchema = ApiOverviewSchema
  export type MetaGetResponse = z.infer<typeof MetaGetResponseSchema>

  export const ActivityListPublicEventsForRepoNetworkParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListPublicEventsForRepoNetworkParams = z.infer<
    typeof ActivityListPublicEventsForRepoNetworkParamsSchema
  >

  export const ActivityListPublicEventsForRepoNetworkResponseSchema =
    z.array(EventSchema)
  export type ActivityListPublicEventsForRepoNetworkResponse = z.infer<
    typeof ActivityListPublicEventsForRepoNetworkResponseSchema
  >

  export const ActivityListNotificationsForAuthenticatedUserParamsSchema =
    z.object({
      all: z
        .boolean()
        .describe('If `true`, show notifications marked as read.')
        .default(false),
      participating: z
        .boolean()
        .describe(
          'If `true`, only shows notifications in which the user is directly participating or mentioned.'
        )
        .default(false),
      since: z
        .string()
        .datetime({ offset: true })
        .describe(
          'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      before: z
        .string()
        .datetime({ offset: true })
        .describe(
          'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(50)
    })
  export type ActivityListNotificationsForAuthenticatedUserParams = z.infer<
    typeof ActivityListNotificationsForAuthenticatedUserParamsSchema
  >

  export const ActivityListNotificationsForAuthenticatedUserResponseSchema =
    z.array(ThreadSchema)
  export type ActivityListNotificationsForAuthenticatedUserResponse = z.infer<
    typeof ActivityListNotificationsForAuthenticatedUserResponseSchema
  >

  export const ActivityMarkNotificationsAsReadParamsSchema = z.object({
    last_read_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.'
      )
      .optional(),
    read: z
      .boolean()
      .describe('Whether the notification has been read.')
      .optional()
  })
  export type ActivityMarkNotificationsAsReadParams = z.infer<
    typeof ActivityMarkNotificationsAsReadParamsSchema
  >

  export type ActivityMarkNotificationsAsReadResponse = undefined

  export const ActivityGetThreadParamsSchema = z.object({
    thread_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
      )
  })
  export type ActivityGetThreadParams = z.infer<
    typeof ActivityGetThreadParamsSchema
  >

  export const ActivityGetThreadResponseSchema = ThreadSchema
  export type ActivityGetThreadResponse = z.infer<
    typeof ActivityGetThreadResponseSchema
  >

  export const ActivityMarkThreadAsDoneParamsSchema = z.object({
    thread_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
      )
  })
  export type ActivityMarkThreadAsDoneParams = z.infer<
    typeof ActivityMarkThreadAsDoneParamsSchema
  >

  export type ActivityMarkThreadAsDoneResponse = undefined

  export const ActivityMarkThreadAsReadParamsSchema = z.object({
    thread_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
      )
  })
  export type ActivityMarkThreadAsReadParams = z.infer<
    typeof ActivityMarkThreadAsReadParamsSchema
  >

  export type ActivityMarkThreadAsReadResponse = undefined

  export const ActivityGetThreadSubscriptionForAuthenticatedUserParamsSchema =
    z.object({
      thread_id: z
        .number()
        .int()
        .describe(
          'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
        )
    })
  export type ActivityGetThreadSubscriptionForAuthenticatedUserParams = z.infer<
    typeof ActivityGetThreadSubscriptionForAuthenticatedUserParamsSchema
  >

  export const ActivityGetThreadSubscriptionForAuthenticatedUserResponseSchema =
    ThreadSubscriptionSchema
  export type ActivityGetThreadSubscriptionForAuthenticatedUserResponse =
    z.infer<
      typeof ActivityGetThreadSubscriptionForAuthenticatedUserResponseSchema
    >

  export const ActivitySetThreadSubscriptionParamsSchema = z.object({
    ignored: z
      .boolean()
      .describe('Whether to block all notifications from a thread.')
      .default(false),
    thread_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
      )
  })
  export type ActivitySetThreadSubscriptionParams = z.infer<
    typeof ActivitySetThreadSubscriptionParamsSchema
  >

  export const ActivitySetThreadSubscriptionResponseSchema =
    ThreadSubscriptionSchema
  export type ActivitySetThreadSubscriptionResponse = z.infer<
    typeof ActivitySetThreadSubscriptionResponseSchema
  >

  export const ActivityDeleteThreadSubscriptionParamsSchema = z.object({
    thread_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).'
      )
  })
  export type ActivityDeleteThreadSubscriptionParams = z.infer<
    typeof ActivityDeleteThreadSubscriptionParamsSchema
  >

  export type ActivityDeleteThreadSubscriptionResponse = undefined

  export const MetaGetOctocatParamsSchema = z.object({
    s: z
      .string()
      .describe("The words to show in Octocat's speech bubble")
      .optional()
  })
  export type MetaGetOctocatParams = z.infer<typeof MetaGetOctocatParamsSchema>

  export type MetaGetOctocatResponse = undefined

  export const OrgsListParamsSchema = z.object({
    since: z
      .number()
      .int()
      .describe(
        'An organization ID. Only return organizations with an ID greater than this ID.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type OrgsListParams = z.infer<typeof OrgsListParamsSchema>

  export const OrgsListResponseSchema = z.array(OrganizationSimpleSchema)
  export type OrgsListResponse = z.infer<typeof OrgsListResponseSchema>

  export const BillingGetGithubBillingUsageReportOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    year: z
      .number()
      .int()
      .describe(
        'If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.'
      )
      .optional(),
    month: z
      .number()
      .int()
      .describe(
        'If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.'
      )
      .optional(),
    day: z
      .number()
      .int()
      .describe(
        'If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.'
      )
      .optional(),
    hour: z
      .number()
      .int()
      .describe(
        'If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.'
      )
      .optional()
  })
  export type BillingGetGithubBillingUsageReportOrgParams = z.infer<
    typeof BillingGetGithubBillingUsageReportOrgParamsSchema
  >

  export const BillingGetGithubBillingUsageReportOrgResponseSchema =
    BillingUsageReportSchema
  export type BillingGetGithubBillingUsageReportOrgResponse = z.infer<
    typeof BillingGetGithubBillingUsageReportOrgResponseSchema
  >

  export const OrgsGetParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsGetParams = z.infer<typeof OrgsGetParamsSchema>

  export const OrgsGetResponseSchema = OrganizationFullSchema
  export type OrgsGetResponse = z.infer<typeof OrgsGetResponseSchema>

  export const OrgsDeleteParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsDeleteParams = z.infer<typeof OrgsDeleteParamsSchema>

  export type OrgsDeleteResponse = undefined

  export const OrgsUpdateParamsSchema = z.object({
    billing_email: z
      .string()
      .describe('Billing email address. This address is not publicized.')
      .optional(),
    company: z.string().describe('The company name.').optional(),
    email: z
      .string()
      .describe('The publicly visible email address.')
      .optional(),
    twitter_username: z
      .string()
      .describe('The Twitter username of the company.')
      .optional(),
    location: z.string().describe('The location.').optional(),
    name: z.string().describe('The shorthand name of the company.').optional(),
    description: z
      .string()
      .describe(
        'The description of the company. The maximum size is 160 characters.'
      )
      .optional(),
    has_organization_projects: z
      .boolean()
      .describe('Whether an organization can use organization projects.')
      .optional(),
    has_repository_projects: z
      .boolean()
      .describe(
        'Whether repositories that belong to the organization can use repository projects.'
      )
      .optional(),
    default_repository_permission: z
      .enum(['read', 'write', 'admin', 'none'])
      .describe(
        'Default permission level members have for organization repositories.'
      )
      .default('read'),
    members_can_create_repositories: z
      .boolean()
      .describe(
        'Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.'
      )
      .default(true),
    members_can_create_internal_repositories: z
      .boolean()
      .describe(
        'Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.'
      )
      .optional(),
    members_can_create_private_repositories: z
      .boolean()
      .describe(
        'Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.'
      )
      .optional(),
    members_can_create_public_repositories: z
      .boolean()
      .describe(
        'Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.'
      )
      .optional(),
    members_allowed_repository_creation_type: z
      .enum(['all', 'private', 'none'])
      .describe(
        'Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.'
      )
      .optional(),
    members_can_create_pages: z
      .boolean()
      .describe(
        'Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.'
      )
      .default(true),
    members_can_create_public_pages: z
      .boolean()
      .describe(
        'Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.'
      )
      .default(true),
    members_can_create_private_pages: z
      .boolean()
      .describe(
        'Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.'
      )
      .default(true),
    members_can_fork_private_repositories: z
      .boolean()
      .describe(
        'Whether organization members can fork private organization repositories.'
      )
      .default(false),
    web_commit_signoff_required: z
      .boolean()
      .describe(
        "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface."
      )
      .default(false),
    blog: z.string().optional(),
    advanced_security_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    dependabot_alerts_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    dependabot_security_updates_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    dependency_graph_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    secret_scanning_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    secret_scanning_push_protection_enabled_for_new_repositories: z
      .boolean()
      .describe(
        '**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
      )
      .optional(),
    secret_scanning_push_protection_custom_link_enabled: z
      .boolean()
      .describe(
        'Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.'
      )
      .optional(),
    secret_scanning_push_protection_custom_link: z
      .string()
      .describe(
        'If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret.'
      )
      .optional(),
    deploy_keys_enabled_for_repositories: z
      .boolean()
      .describe(
        'Controls whether or not deploy keys may be added and used for repositories in the organization.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsUpdateParams = z.infer<typeof OrgsUpdateParamsSchema>

  export const OrgsUpdateResponseSchema = OrganizationFullSchema
  export type OrgsUpdateResponse = z.infer<typeof OrgsUpdateResponseSchema>

  export const ActionsGetActionsCacheUsageForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGetActionsCacheUsageForOrgParams = z.infer<
    typeof ActionsGetActionsCacheUsageForOrgParamsSchema
  >

  export const ActionsGetActionsCacheUsageForOrgResponseSchema =
    ActionsCacheUsageOrgEnterpriseSchema
  export type ActionsGetActionsCacheUsageForOrgResponse = z.infer<
    typeof ActionsGetActionsCacheUsageForOrgResponseSchema
  >

  export const ActionsGetActionsCacheUsageByRepoForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsGetActionsCacheUsageByRepoForOrgParams = z.infer<
    typeof ActionsGetActionsCacheUsageByRepoForOrgParamsSchema
  >

  export const ActionsGetActionsCacheUsageByRepoForOrgResponseSchema = z.object(
    {
      total_count: z.number().int(),
      repository_cache_usages: z.array(ActionsCacheUsageByRepositorySchema)
    }
  )
  export type ActionsGetActionsCacheUsageByRepoForOrgResponse = z.infer<
    typeof ActionsGetActionsCacheUsageByRepoForOrgResponseSchema
  >

  export const ActionsListHostedRunnersForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListHostedRunnersForOrgParams = z.infer<
    typeof ActionsListHostedRunnersForOrgParamsSchema
  >

  export const ActionsListHostedRunnersForOrgResponseSchema = z.object({
    total_count: z.number().int(),
    runners: z.array(ActionsHostedRunnerSchema)
  })
  export type ActionsListHostedRunnersForOrgResponse = z.infer<
    typeof ActionsListHostedRunnersForOrgResponseSchema
  >

  export const ActionsCreateHostedRunnerForOrgParamsSchema = z.object({
    name: z
      .string()
      .describe(
        "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
      ),
    image: z
      .object({
        id: z
          .string()
          .describe('The unique identifier of the runner image.')
          .optional(),
        source: z
          .enum(['github', 'partner', 'custom'])
          .describe('The source of the runner image.')
          .optional()
      })
      .describe(
        'The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.'
      ),
    size: z
      .string()
      .describe(
        'The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`'
      ),
    runner_group_id: z
      .number()
      .int()
      .describe('The existing runner group to add this runner to.'),
    maximum_runners: z
      .number()
      .int()
      .describe(
        'The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.'
      )
      .optional(),
    enable_static_ip: z
      .boolean()
      .describe(
        'Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsCreateHostedRunnerForOrgParams = z.infer<
    typeof ActionsCreateHostedRunnerForOrgParamsSchema
  >

  export type ActionsCreateHostedRunnerForOrgResponse = undefined

  export const ActionsGetHostedRunnersGithubOwnedImagesForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsGetHostedRunnersGithubOwnedImagesForOrgParams = z.infer<
    typeof ActionsGetHostedRunnersGithubOwnedImagesForOrgParamsSchema
  >

  export const ActionsGetHostedRunnersGithubOwnedImagesForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      images: z.array(ActionsHostedRunnerImageSchema)
    })
  export type ActionsGetHostedRunnersGithubOwnedImagesForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnersGithubOwnedImagesForOrgResponseSchema
  >

  export const ActionsGetHostedRunnersPartnerImagesForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsGetHostedRunnersPartnerImagesForOrgParams = z.infer<
    typeof ActionsGetHostedRunnersPartnerImagesForOrgParamsSchema
  >

  export const ActionsGetHostedRunnersPartnerImagesForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      images: z.array(ActionsHostedRunnerImageSchema)
    })
  export type ActionsGetHostedRunnersPartnerImagesForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnersPartnerImagesForOrgResponseSchema
  >

  export const ActionsGetHostedRunnersLimitsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGetHostedRunnersLimitsForOrgParams = z.infer<
    typeof ActionsGetHostedRunnersLimitsForOrgParamsSchema
  >

  export const ActionsGetHostedRunnersLimitsForOrgResponseSchema =
    ActionsHostedRunnerLimitsSchema
  export type ActionsGetHostedRunnersLimitsForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnersLimitsForOrgResponseSchema
  >

  export const ActionsGetHostedRunnersMachineSpecsForOrgParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    }
  )
  export type ActionsGetHostedRunnersMachineSpecsForOrgParams = z.infer<
    typeof ActionsGetHostedRunnersMachineSpecsForOrgParamsSchema
  >

  export const ActionsGetHostedRunnersMachineSpecsForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      machine_specs: z.array(ActionsHostedRunnerMachineSpecSchema)
    })
  export type ActionsGetHostedRunnersMachineSpecsForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnersMachineSpecsForOrgResponseSchema
  >

  export const ActionsGetHostedRunnersPlatformsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGetHostedRunnersPlatformsForOrgParams = z.infer<
    typeof ActionsGetHostedRunnersPlatformsForOrgParamsSchema
  >

  export const ActionsGetHostedRunnersPlatformsForOrgResponseSchema = z.object({
    total_count: z.number().int(),
    platforms: z.array(z.string())
  })
  export type ActionsGetHostedRunnersPlatformsForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnersPlatformsForOrgResponseSchema
  >

  export const ActionsGetHostedRunnerForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hosted_runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the GitHub-hosted runner.')
  })
  export type ActionsGetHostedRunnerForOrgParams = z.infer<
    typeof ActionsGetHostedRunnerForOrgParamsSchema
  >

  export const ActionsGetHostedRunnerForOrgResponseSchema =
    ActionsHostedRunnerSchema
  export type ActionsGetHostedRunnerForOrgResponse = z.infer<
    typeof ActionsGetHostedRunnerForOrgResponseSchema
  >

  export const ActionsDeleteHostedRunnerForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hosted_runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the GitHub-hosted runner.')
  })
  export type ActionsDeleteHostedRunnerForOrgParams = z.infer<
    typeof ActionsDeleteHostedRunnerForOrgParamsSchema
  >

  export type ActionsDeleteHostedRunnerForOrgResponse = undefined

  export const ActionsUpdateHostedRunnerForOrgParamsSchema = z.object({
    name: z
      .string()
      .describe(
        "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
      )
      .optional(),
    runner_group_id: z
      .number()
      .int()
      .describe('The existing runner group to add this runner to.')
      .optional(),
    maximum_runners: z
      .number()
      .int()
      .describe(
        'The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.'
      )
      .optional(),
    enable_static_ip: z
      .boolean()
      .describe(
        'Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hosted_runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the GitHub-hosted runner.')
  })
  export type ActionsUpdateHostedRunnerForOrgParams = z.infer<
    typeof ActionsUpdateHostedRunnerForOrgParamsSchema
  >

  export const ActionsUpdateHostedRunnerForOrgResponseSchema =
    ActionsHostedRunnerSchema
  export type ActionsUpdateHostedRunnerForOrgResponse = z.infer<
    typeof ActionsUpdateHostedRunnerForOrgResponseSchema
  >

  export const OidcGetOidcCustomSubTemplateForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OidcGetOidcCustomSubTemplateForOrgParams = z.infer<
    typeof OidcGetOidcCustomSubTemplateForOrgParamsSchema
  >

  export const OidcGetOidcCustomSubTemplateForOrgResponseSchema =
    OidcCustomSubSchema
  export type OidcGetOidcCustomSubTemplateForOrgResponse = z.infer<
    typeof OidcGetOidcCustomSubTemplateForOrgResponseSchema
  >

  export const OidcUpdateOidcCustomSubTemplateForOrgParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
    .merge(OidcCustomSubSchema)
  export type OidcUpdateOidcCustomSubTemplateForOrgParams = z.infer<
    typeof OidcUpdateOidcCustomSubTemplateForOrgParamsSchema
  >

  export type OidcUpdateOidcCustomSubTemplateForOrgResponse = undefined

  export const ActionsGetGithubActionsPermissionsOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsGetGithubActionsPermissionsOrganizationParams = z.infer<
    typeof ActionsGetGithubActionsPermissionsOrganizationParamsSchema
  >

  export const ActionsGetGithubActionsPermissionsOrganizationResponseSchema =
    ActionsOrganizationPermissionsSchema
  export type ActionsGetGithubActionsPermissionsOrganizationResponse = z.infer<
    typeof ActionsGetGithubActionsPermissionsOrganizationResponseSchema
  >

  export const ActionsSetGithubActionsPermissionsOrganizationParamsSchema =
    z.object({
      enabled_repositories: EnabledRepositoriesSchema,
      allowed_actions: AllowedActionsSchema.optional(),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsSetGithubActionsPermissionsOrganizationParams = z.infer<
    typeof ActionsSetGithubActionsPermissionsOrganizationParamsSchema
  >

  export type ActionsSetGithubActionsPermissionsOrganizationResponse = undefined

  export const ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams =
    z.infer<
      typeof ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema
    >

  export const ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponseSchema =
    z.object({
      total_count: z.number(),
      repositories: z.array(RepositorySchema)
    })
  export type ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse =
    z.infer<
      typeof ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponseSchema
    >

  export const ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema =
    z.object({
      selected_repository_ids: z
        .array(
          z.number().int().describe('Unique identifier of the repository.')
        )
        .describe('List of repository IDs to enable for GitHub Actions.'),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationParams =
    z.infer<
      typeof ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationParamsSchema
    >

  export type ActionsSetSelectedRepositoriesEnabledGithubActionsOrganizationResponse =
    undefined

  export const ActionsEnableSelectedRepositoryGithubActionsOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type ActionsEnableSelectedRepositoryGithubActionsOrganizationParams =
    z.infer<
      typeof ActionsEnableSelectedRepositoryGithubActionsOrganizationParamsSchema
    >

  export type ActionsEnableSelectedRepositoryGithubActionsOrganizationResponse =
    undefined

  export const ActionsDisableSelectedRepositoryGithubActionsOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type ActionsDisableSelectedRepositoryGithubActionsOrganizationParams =
    z.infer<
      typeof ActionsDisableSelectedRepositoryGithubActionsOrganizationParamsSchema
    >

  export type ActionsDisableSelectedRepositoryGithubActionsOrganizationResponse =
    undefined

  export const ActionsGetAllowedActionsOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGetAllowedActionsOrganizationParams = z.infer<
    typeof ActionsGetAllowedActionsOrganizationParamsSchema
  >

  export const ActionsGetAllowedActionsOrganizationResponseSchema =
    SelectedActionsSchema
  export type ActionsGetAllowedActionsOrganizationResponse = z.infer<
    typeof ActionsGetAllowedActionsOrganizationResponseSchema
  >

  export const ActionsSetAllowedActionsOrganizationParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
    .merge(SelectedActionsSchema)
  export type ActionsSetAllowedActionsOrganizationParams = z.infer<
    typeof ActionsSetAllowedActionsOrganizationParamsSchema
  >

  export type ActionsSetAllowedActionsOrganizationResponse = undefined

  export const ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationParams =
    z.infer<
      typeof ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema
    >

  export const ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationResponseSchema =
    ActionsGetDefaultWorkflowPermissionsSchema
  export type ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationResponse =
    z.infer<
      typeof ActionsGetGithubActionsDefaultWorkflowPermissionsOrganizationResponseSchema
    >

  export const ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema =
    z
      .object({
        org: z
          .string()
          .describe('The organization name. The name is not case sensitive.')
      })
      .merge(ActionsSetDefaultWorkflowPermissionsSchema)
  export type ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationParams =
    z.infer<
      typeof ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationParamsSchema
    >

  export type ActionsSetGithubActionsDefaultWorkflowPermissionsOrganizationResponse =
    undefined

  export const ActionsListSelfHostedRunnerGroupsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    visible_to_repository: z
      .string()
      .describe(
        'Only return runner groups that are allowed to be used by this repository.'
      )
      .optional()
  })
  export type ActionsListSelfHostedRunnerGroupsForOrgParams = z.infer<
    typeof ActionsListSelfHostedRunnerGroupsForOrgParamsSchema
  >

  export const ActionsListSelfHostedRunnerGroupsForOrgResponseSchema = z.object(
    { total_count: z.number(), runner_groups: z.array(RunnerGroupsOrgSchema) }
  )
  export type ActionsListSelfHostedRunnerGroupsForOrgResponse = z.infer<
    typeof ActionsListSelfHostedRunnerGroupsForOrgResponseSchema
  >

  export const ActionsCreateSelfHostedRunnerGroupForOrgParamsSchema = z.object({
    name: z.string().describe('Name of the runner group.'),
    visibility: z
      .enum(['selected', 'all', 'private'])
      .describe(
        'Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.'
      )
      .default('all'),
    selected_repository_ids: z
      .array(z.number().int().describe('Unique identifier of the repository.'))
      .describe('List of repository IDs that can access the runner group.')
      .optional(),
    runners: z
      .array(z.number().int().describe('Unique identifier of the runner.'))
      .describe('List of runner IDs to add to the runner group.')
      .optional(),
    allows_public_repositories: z
      .boolean()
      .describe(
        'Whether the runner group can be used by `public` repositories.'
      )
      .default(false),
    restricted_to_workflows: z
      .boolean()
      .describe(
        'If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.'
      )
      .default(false),
    selected_workflows: z
      .array(
        z
          .string()
          .describe(
            'Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.'
          )
      )
      .describe(
        'List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.'
      )
      .optional(),
    network_configuration_id: z
      .string()
      .describe('The identifier of a hosted compute network configuration.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsCreateSelfHostedRunnerGroupForOrgParams = z.infer<
    typeof ActionsCreateSelfHostedRunnerGroupForOrgParamsSchema
  >

  export type ActionsCreateSelfHostedRunnerGroupForOrgResponse = undefined

  export const ActionsGetSelfHostedRunnerGroupForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_group_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner group.')
  })
  export type ActionsGetSelfHostedRunnerGroupForOrgParams = z.infer<
    typeof ActionsGetSelfHostedRunnerGroupForOrgParamsSchema
  >

  export const ActionsGetSelfHostedRunnerGroupForOrgResponseSchema =
    RunnerGroupsOrgSchema
  export type ActionsGetSelfHostedRunnerGroupForOrgResponse = z.infer<
    typeof ActionsGetSelfHostedRunnerGroupForOrgResponseSchema
  >

  export const ActionsDeleteSelfHostedRunnerGroupFromOrgParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.')
    }
  )
  export type ActionsDeleteSelfHostedRunnerGroupFromOrgParams = z.infer<
    typeof ActionsDeleteSelfHostedRunnerGroupFromOrgParamsSchema
  >

  export type ActionsDeleteSelfHostedRunnerGroupFromOrgResponse = undefined

  export const ActionsUpdateSelfHostedRunnerGroupForOrgParamsSchema = z.object({
    name: z.string().describe('Name of the runner group.'),
    visibility: z
      .enum(['selected', 'all', 'private'])
      .describe(
        'Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.'
      )
      .optional(),
    allows_public_repositories: z
      .boolean()
      .describe(
        'Whether the runner group can be used by `public` repositories.'
      )
      .default(false),
    restricted_to_workflows: z
      .boolean()
      .describe(
        'If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.'
      )
      .default(false),
    selected_workflows: z
      .array(
        z
          .string()
          .describe(
            'Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.'
          )
      )
      .describe(
        'List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.'
      )
      .optional(),
    network_configuration_id: z
      .string()
      .describe('The identifier of a hosted compute network configuration.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_group_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner group.')
  })
  export type ActionsUpdateSelfHostedRunnerGroupForOrgParams = z.infer<
    typeof ActionsUpdateSelfHostedRunnerGroupForOrgParamsSchema
  >

  export const ActionsUpdateSelfHostedRunnerGroupForOrgResponseSchema =
    RunnerGroupsOrgSchema
  export type ActionsUpdateSelfHostedRunnerGroupForOrgResponse = z.infer<
    typeof ActionsUpdateSelfHostedRunnerGroupForOrgResponseSchema
  >

  export const ActionsListGithubHostedRunnersInGroupForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ActionsListGithubHostedRunnersInGroupForOrgParams = z.infer<
    typeof ActionsListGithubHostedRunnersInGroupForOrgParamsSchema
  >

  export const ActionsListGithubHostedRunnersInGroupForOrgResponseSchema =
    z.object({
      total_count: z.number(),
      runners: z.array(ActionsHostedRunnerSchema)
    })
  export type ActionsListGithubHostedRunnersInGroupForOrgResponse = z.infer<
    typeof ActionsListGithubHostedRunnersInGroupForOrgResponseSchema
  >

  export const ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30)
    })
  export type ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams = z.infer<
    typeof ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema
  >

  export const ActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponseSchema =
    z.object({
      total_count: z.number(),
      repositories: z.array(MinimalRepositorySchema)
    })
  export type ActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse =
    z.infer<
      typeof ActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponseSchema
    >

  export const ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema =
    z.object({
      selected_repository_ids: z
        .array(
          z.number().int().describe('Unique identifier of the repository.')
        )
        .describe('List of repository IDs that can access the runner group.'),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.')
    })
  export type ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgParams = z.infer<
    typeof ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema
  >

  export type ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgResponse =
    undefined

  export const ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgParams = z.infer<
    typeof ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema
  >

  export type ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgResponse =
    undefined

  export const ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgParams =
    z.infer<
      typeof ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgParamsSchema
    >

  export type ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgResponse =
    undefined

  export const ActionsListSelfHostedRunnersInGroupForOrgParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type ActionsListSelfHostedRunnersInGroupForOrgParams = z.infer<
    typeof ActionsListSelfHostedRunnersInGroupForOrgParamsSchema
  >

  export const ActionsListSelfHostedRunnersInGroupForOrgResponseSchema =
    z.object({ total_count: z.number(), runners: z.array(RunnerSchema) })
  export type ActionsListSelfHostedRunnersInGroupForOrgResponse = z.infer<
    typeof ActionsListSelfHostedRunnersInGroupForOrgResponseSchema
  >

  export const ActionsSetSelfHostedRunnersInGroupForOrgParamsSchema = z.object({
    runners: z
      .array(z.number().int().describe('Unique identifier of the runner.'))
      .describe('List of runner IDs to add to the runner group.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_group_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner group.')
  })
  export type ActionsSetSelfHostedRunnersInGroupForOrgParams = z.infer<
    typeof ActionsSetSelfHostedRunnersInGroupForOrgParamsSchema
  >

  export type ActionsSetSelfHostedRunnersInGroupForOrgResponse = undefined

  export const ActionsAddSelfHostedRunnerToGroupForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_group_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner group.'),
    runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner.')
  })
  export type ActionsAddSelfHostedRunnerToGroupForOrgParams = z.infer<
    typeof ActionsAddSelfHostedRunnerToGroupForOrgParamsSchema
  >

  export type ActionsAddSelfHostedRunnerToGroupForOrgResponse = undefined

  export const ActionsRemoveSelfHostedRunnerFromGroupForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_group_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner group.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsRemoveSelfHostedRunnerFromGroupForOrgParams = z.infer<
    typeof ActionsRemoveSelfHostedRunnerFromGroupForOrgParamsSchema
  >

  export type ActionsRemoveSelfHostedRunnerFromGroupForOrgResponse = undefined

  export const ActionsListSelfHostedRunnersForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of a self-hosted runner.').optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListSelfHostedRunnersForOrgParams = z.infer<
    typeof ActionsListSelfHostedRunnersForOrgParamsSchema
  >

  export const ActionsListSelfHostedRunnersForOrgResponseSchema = z.object({
    total_count: z.number().int(),
    runners: z.array(RunnerSchema)
  })
  export type ActionsListSelfHostedRunnersForOrgResponse = z.infer<
    typeof ActionsListSelfHostedRunnersForOrgResponseSchema
  >

  export const ActionsListRunnerApplicationsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsListRunnerApplicationsForOrgParams = z.infer<
    typeof ActionsListRunnerApplicationsForOrgParamsSchema
  >

  export const ActionsListRunnerApplicationsForOrgResponseSchema = z.array(
    RunnerApplicationSchema
  )
  export type ActionsListRunnerApplicationsForOrgResponse = z.infer<
    typeof ActionsListRunnerApplicationsForOrgResponseSchema
  >

  export const ActionsGenerateRunnerJitconfigForOrgParamsSchema = z.object({
    name: z.string().describe('The name of the new runner.'),
    runner_group_id: z
      .number()
      .int()
      .describe('The ID of the runner group to register the runner to.'),
    labels: z
      .array(z.string())
      .min(1)
      .max(100)
      .describe(
        'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.'
      ),
    work_folder: z
      .string()
      .describe(
        'The working directory to be used for job execution, relative to the runner install directory.'
      )
      .default('_work'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGenerateRunnerJitconfigForOrgParams = z.infer<
    typeof ActionsGenerateRunnerJitconfigForOrgParamsSchema
  >

  export type ActionsGenerateRunnerJitconfigForOrgResponse = undefined

  export const ActionsCreateRegistrationTokenForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsCreateRegistrationTokenForOrgParams = z.infer<
    typeof ActionsCreateRegistrationTokenForOrgParamsSchema
  >

  export type ActionsCreateRegistrationTokenForOrgResponse = undefined

  export const ActionsCreateRemoveTokenForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsCreateRemoveTokenForOrgParams = z.infer<
    typeof ActionsCreateRemoveTokenForOrgParamsSchema
  >

  export type ActionsCreateRemoveTokenForOrgResponse = undefined

  export const ActionsGetSelfHostedRunnerForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner.')
  })
  export type ActionsGetSelfHostedRunnerForOrgParams = z.infer<
    typeof ActionsGetSelfHostedRunnerForOrgParamsSchema
  >

  export const ActionsGetSelfHostedRunnerForOrgResponseSchema = RunnerSchema
  export type ActionsGetSelfHostedRunnerForOrgResponse = z.infer<
    typeof ActionsGetSelfHostedRunnerForOrgResponseSchema
  >

  export const ActionsDeleteSelfHostedRunnerFromOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner.')
  })
  export type ActionsDeleteSelfHostedRunnerFromOrgParams = z.infer<
    typeof ActionsDeleteSelfHostedRunnerFromOrgParamsSchema
  >

  export type ActionsDeleteSelfHostedRunnerFromOrgResponse = undefined

  export const ActionsListLabelsForSelfHostedRunnerForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsListLabelsForSelfHostedRunnerForOrgParams = z.infer<
    typeof ActionsListLabelsForSelfHostedRunnerForOrgParamsSchema
  >

  export const ActionsListLabelsForSelfHostedRunnerForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsListLabelsForSelfHostedRunnerForOrgResponse = z.infer<
    typeof ActionsListLabelsForSelfHostedRunnerForOrgResponseSchema
  >

  export const ActionsAddCustomLabelsToSelfHostedRunnerForOrgParamsSchema =
    z.object({
      labels: z
        .array(z.string())
        .min(1)
        .max(100)
        .describe('The names of the custom labels to add to the runner.'),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsAddCustomLabelsToSelfHostedRunnerForOrgParams = z.infer<
    typeof ActionsAddCustomLabelsToSelfHostedRunnerForOrgParamsSchema
  >

  export const ActionsAddCustomLabelsToSelfHostedRunnerForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsAddCustomLabelsToSelfHostedRunnerForOrgResponse = z.infer<
    typeof ActionsAddCustomLabelsToSelfHostedRunnerForOrgResponseSchema
  >

  export const ActionsSetCustomLabelsForSelfHostedRunnerForOrgParamsSchema =
    z.object({
      labels: z
        .array(z.string())
        .min(0)
        .max(100)
        .describe(
          'The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsSetCustomLabelsForSelfHostedRunnerForOrgParams = z.infer<
    typeof ActionsSetCustomLabelsForSelfHostedRunnerForOrgParamsSchema
  >

  export const ActionsSetCustomLabelsForSelfHostedRunnerForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsSetCustomLabelsForSelfHostedRunnerForOrgResponse = z.infer<
    typeof ActionsSetCustomLabelsForSelfHostedRunnerForOrgResponseSchema
  >

  export const ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgParams =
    z.infer<
      typeof ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgParamsSchema
    >

  export const ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgResponse =
    z.infer<
      typeof ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForOrgResponseSchema
    >

  export const ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.'),
      name: z
        .string()
        .describe("The name of a self-hosted runner's custom label.")
    })
  export type ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgParams =
    z.infer<
      typeof ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgParamsSchema
    >

  export const ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgResponse =
    z.infer<
      typeof ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgResponseSchema
    >

  export const ActionsListOrgSecretsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListOrgSecretsParams = z.infer<
    typeof ActionsListOrgSecretsParamsSchema
  >

  export const ActionsListOrgSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(OrganizationActionsSecretSchema)
  })
  export type ActionsListOrgSecretsResponse = z.infer<
    typeof ActionsListOrgSecretsResponseSchema
  >

  export const ActionsGetOrgPublicKeyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsGetOrgPublicKeyParams = z.infer<
    typeof ActionsGetOrgPublicKeyParamsSchema
  >

  export const ActionsGetOrgPublicKeyResponseSchema = ActionsPublicKeySchema
  export type ActionsGetOrgPublicKeyResponse = z.infer<
    typeof ActionsGetOrgPublicKeyResponseSchema
  >

  export const ActionsGetOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsGetOrgSecretParams = z.infer<
    typeof ActionsGetOrgSecretParamsSchema
  >

  export const ActionsGetOrgSecretResponseSchema =
    OrganizationActionsSecretSchema
  export type ActionsGetOrgSecretResponse = z.infer<
    typeof ActionsGetOrgSecretResponseSchema
  >

  export const ActionsCreateOrUpdateOrgSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.'
      ),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.'),
    visibility: z
      .enum(['all', 'private', 'selected'])
      .describe(
        'Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.'
      ),
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsCreateOrUpdateOrgSecretParams = z.infer<
    typeof ActionsCreateOrUpdateOrgSecretParamsSchema
  >

  export type ActionsCreateOrUpdateOrgSecretResponse = undefined

  export const ActionsDeleteOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsDeleteOrgSecretParams = z.infer<
    typeof ActionsDeleteOrgSecretParamsSchema
  >

  export type ActionsDeleteOrgSecretResponse = undefined

  export const ActionsListSelectedReposForOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ActionsListSelectedReposForOrgSecretParams = z.infer<
    typeof ActionsListSelectedReposForOrgSecretParamsSchema
  >

  export const ActionsListSelectedReposForOrgSecretResponseSchema = z.object({
    total_count: z.number().int(),
    repositories: z.array(MinimalRepositorySchema)
  })
  export type ActionsListSelectedReposForOrgSecretResponse = z.infer<
    typeof ActionsListSelectedReposForOrgSecretResponseSchema
  >

  export const ActionsSetSelectedReposForOrgSecretParamsSchema = z.object({
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsSetSelectedReposForOrgSecretParams = z.infer<
    typeof ActionsSetSelectedReposForOrgSecretParamsSchema
  >

  export type ActionsSetSelectedReposForOrgSecretResponse = undefined

  export const ActionsAddSelectedRepoToOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    repository_id: z.number().int()
  })
  export type ActionsAddSelectedRepoToOrgSecretParams = z.infer<
    typeof ActionsAddSelectedRepoToOrgSecretParamsSchema
  >

  export type ActionsAddSelectedRepoToOrgSecretResponse = undefined

  export const ActionsRemoveSelectedRepoFromOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    repository_id: z.number().int()
  })
  export type ActionsRemoveSelectedRepoFromOrgSecretParams = z.infer<
    typeof ActionsRemoveSelectedRepoFromOrgSecretParamsSchema
  >

  export type ActionsRemoveSelectedRepoFromOrgSecretResponse = undefined

  export const ActionsListOrgVariablesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(10),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListOrgVariablesParams = z.infer<
    typeof ActionsListOrgVariablesParamsSchema
  >

  export const ActionsListOrgVariablesResponseSchema = z.object({
    total_count: z.number().int(),
    variables: z.array(OrganizationActionsVariableSchema)
  })
  export type ActionsListOrgVariablesResponse = z.infer<
    typeof ActionsListOrgVariablesResponseSchema
  >

  export const ActionsCreateOrgVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.'),
    visibility: z
      .enum(['all', 'private', 'selected'])
      .describe(
        'The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.'
      ),
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsCreateOrgVariableParams = z.infer<
    typeof ActionsCreateOrgVariableParamsSchema
  >

  export type ActionsCreateOrgVariableResponse = undefined

  export const ActionsGetOrgVariableParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsGetOrgVariableParams = z.infer<
    typeof ActionsGetOrgVariableParamsSchema
  >

  export const ActionsGetOrgVariableResponseSchema =
    OrganizationActionsVariableSchema
  export type ActionsGetOrgVariableResponse = z.infer<
    typeof ActionsGetOrgVariableResponseSchema
  >

  export const ActionsDeleteOrgVariableParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsDeleteOrgVariableParams = z.infer<
    typeof ActionsDeleteOrgVariableParamsSchema
  >

  export type ActionsDeleteOrgVariableResponse = undefined

  export const ActionsUpdateOrgVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.').optional(),
    visibility: z
      .enum(['all', 'private', 'selected'])
      .describe(
        'The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.'
      )
      .optional(),
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ActionsUpdateOrgVariableParams = z.infer<
    typeof ActionsUpdateOrgVariableParamsSchema
  >

  export type ActionsUpdateOrgVariableResponse = undefined

  export const ActionsListSelectedReposForOrgVariableParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ActionsListSelectedReposForOrgVariableParams = z.infer<
    typeof ActionsListSelectedReposForOrgVariableParamsSchema
  >

  export const ActionsListSelectedReposForOrgVariableResponseSchema = z.object({
    total_count: z.number().int(),
    repositories: z.array(MinimalRepositorySchema)
  })
  export type ActionsListSelectedReposForOrgVariableResponse = z.infer<
    typeof ActionsListSelectedReposForOrgVariableResponseSchema
  >

  export const ActionsSetSelectedReposForOrgVariableParamsSchema = z.object({
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'The IDs of the repositories that can access the organization variable.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsSetSelectedReposForOrgVariableParams = z.infer<
    typeof ActionsSetSelectedReposForOrgVariableParamsSchema
  >

  export type ActionsSetSelectedReposForOrgVariableResponse = undefined

  export const ActionsAddSelectedRepoToOrgVariableParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.'),
    repository_id: z.number().int()
  })
  export type ActionsAddSelectedRepoToOrgVariableParams = z.infer<
    typeof ActionsAddSelectedRepoToOrgVariableParamsSchema
  >

  export type ActionsAddSelectedRepoToOrgVariableResponse = undefined

  export const ActionsRemoveSelectedRepoFromOrgVariableParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    name: z.string().describe('The name of the variable.'),
    repository_id: z.number().int()
  })
  export type ActionsRemoveSelectedRepoFromOrgVariableParams = z.infer<
    typeof ActionsRemoveSelectedRepoFromOrgVariableParamsSchema
  >

  export type ActionsRemoveSelectedRepoFromOrgVariableResponse = undefined

  export const OrgsListAttestationsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    subject_digest: z
      .string()
      .describe(
        "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`."
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    predicate_type: z
      .string()
      .describe(
        'Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.'
      )
      .optional()
  })
  export type OrgsListAttestationsParams = z.infer<
    typeof OrgsListAttestationsParamsSchema
  >

  export const OrgsListAttestationsResponseSchema = z.object({
    attestations: z
      .array(
        z.object({
          bundle: z
            .object({
              mediaType: z.string().optional(),
              verificationMaterial: z.object({}).catchall(z.any()).optional(),
              dsseEnvelope: z.object({}).catchall(z.any()).optional()
            })
            .describe(
              "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information."
            )
            .optional(),
          repository_id: z.number().int().optional(),
          bundle_url: z.string().optional()
        })
      )
      .optional()
  })
  export type OrgsListAttestationsResponse = z.infer<
    typeof OrgsListAttestationsResponseSchema
  >

  export const OrgsListBlockedUsersParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListBlockedUsersParams = z.infer<
    typeof OrgsListBlockedUsersParamsSchema
  >

  export const OrgsListBlockedUsersResponseSchema = z.array(SimpleUserSchema)
  export type OrgsListBlockedUsersResponse = z.infer<
    typeof OrgsListBlockedUsersResponseSchema
  >

  export const OrgsCheckBlockedUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsCheckBlockedUserParams = z.infer<
    typeof OrgsCheckBlockedUserParamsSchema
  >

  export type OrgsCheckBlockedUserResponse = undefined

  export const OrgsBlockUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsBlockUserParams = z.infer<typeof OrgsBlockUserParamsSchema>

  export type OrgsBlockUserResponse = undefined

  export const OrgsUnblockUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsUnblockUserParams = z.infer<
    typeof OrgsUnblockUserParamsSchema
  >

  export type OrgsUnblockUserResponse = undefined

  export const CodeScanningListAlertsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    tool_name: z
      .any()
      .describe(
        'The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.'
      )
      .optional(),
    tool_guid: z
      .any()
      .describe(
        'The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.'
      )
      .optional(),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    state: z
      .any()
      .describe(
        'If specified, only code scanning alerts with this state will be returned.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property by which to sort the results.')
      .default('created'),
    severity: z
      .any()
      .describe(
        'If specified, only code scanning alerts with this severity will be returned.'
      )
      .optional()
  })
  export type CodeScanningListAlertsForOrgParams = z.infer<
    typeof CodeScanningListAlertsForOrgParamsSchema
  >

  export const CodeScanningListAlertsForOrgResponseSchema = z.array(
    CodeScanningOrganizationAlertItemsSchema
  )
  export type CodeScanningListAlertsForOrgResponse = z.infer<
    typeof CodeScanningListAlertsForOrgResponseSchema
  >

  export const CodeSecurityGetConfigurationsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    target_type: z
      .enum(['global', 'all'])
      .describe('The target type of the code security configuration')
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional()
  })
  export type CodeSecurityGetConfigurationsForOrgParams = z.infer<
    typeof CodeSecurityGetConfigurationsForOrgParamsSchema
  >

  export const CodeSecurityGetConfigurationsForOrgResponseSchema = z.array(
    CodeSecurityConfigurationSchema
  )
  export type CodeSecurityGetConfigurationsForOrgResponse = z.infer<
    typeof CodeSecurityGetConfigurationsForOrgResponseSchema
  >

  export const CodeSecurityCreateConfigurationParamsSchema = z.object({
    name: z
      .string()
      .describe(
        'The name of the code security configuration. Must be unique within the organization.'
      ),
    description: z
      .string()
      .max(255)
      .describe('A description of the code security configuration'),
    advanced_security: z
      .enum(['enabled', 'disabled'])
      .describe('The enablement status of GitHub Advanced Security')
      .default('disabled'),
    dependency_graph: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependency Graph')
      .default('enabled'),
    dependency_graph_autosubmit_action: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Automatic dependency submission')
      .default('disabled'),
    dependency_graph_autosubmit_action_options: z
      .object({
        labeled_runners: z
          .boolean()
          .describe(
            "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
          )
          .default(false)
      })
      .describe('Feature options for Automatic dependency submission')
      .optional(),
    dependabot_alerts: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependabot alerts')
      .default('disabled'),
    dependabot_security_updates: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependabot security updates')
      .default('disabled'),
    code_scanning_default_setup: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of code scanning default setup')
      .default('disabled'),
    code_scanning_default_setup_options:
      CodeScanningDefaultSetupOptionsSchema.optional(),
    code_scanning_delegated_alert_dismissal: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of code scanning delegated alert dismissal'
      )
      .default('not_set'),
    secret_scanning: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning')
      .default('disabled'),
    secret_scanning_push_protection: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning push protection')
      .default('disabled'),
    secret_scanning_delegated_bypass: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning delegated bypass')
      .default('disabled'),
    secret_scanning_delegated_bypass_options: z
      .object({
        reviewers: z
          .array(
            z.object({
              reviewer_id: z
                .number()
                .int()
                .describe(
                  'The ID of the team or role selected as a bypass reviewer'
                ),
              reviewer_type: z
                .enum(['TEAM', 'ROLE'])
                .describe('The type of the bypass reviewer')
            })
          )
          .describe('The bypass reviewers for secret scanning delegated bypass')
          .optional()
      })
      .describe('Feature options for secret scanning delegated bypass')
      .optional(),
    secret_scanning_validity_checks: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning validity checks')
      .default('disabled'),
    secret_scanning_non_provider_patterns: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of secret scanning non provider patterns'
      )
      .default('disabled'),
    secret_scanning_generic_secrets: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Copilot secret scanning')
      .default('disabled'),
    secret_scanning_delegated_alert_dismissal: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of secret scanning delegated alert dismissal'
      )
      .optional(),
    private_vulnerability_reporting: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of private vulnerability reporting')
      .default('disabled'),
    enforcement: z
      .enum(['enforced', 'unenforced'])
      .describe('The enforcement status for a security configuration')
      .default('enforced'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodeSecurityCreateConfigurationParams = z.infer<
    typeof CodeSecurityCreateConfigurationParamsSchema
  >

  export type CodeSecurityCreateConfigurationResponse = undefined

  export const CodeSecurityGetDefaultConfigurationsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodeSecurityGetDefaultConfigurationsParams = z.infer<
    typeof CodeSecurityGetDefaultConfigurationsParamsSchema
  >

  export const CodeSecurityGetDefaultConfigurationsResponseSchema =
    CodeSecurityDefaultConfigurationsSchema
  export type CodeSecurityGetDefaultConfigurationsResponse = z.infer<
    typeof CodeSecurityGetDefaultConfigurationsResponseSchema
  >

  export const CodeSecurityDetachConfigurationParamsSchema = z.object({
    selected_repository_ids: z
      .array(z.number().int().describe('Unique identifier of the repository.'))
      .describe('An array of repository IDs to detach from configurations.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodeSecurityDetachConfigurationParams = z.infer<
    typeof CodeSecurityDetachConfigurationParamsSchema
  >

  export type CodeSecurityDetachConfigurationResponse = undefined

  export const CodeSecurityGetConfigurationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    configuration_id: z
      .number()
      .int()
      .describe('The unique identifier of the code security configuration.')
  })
  export type CodeSecurityGetConfigurationParams = z.infer<
    typeof CodeSecurityGetConfigurationParamsSchema
  >

  export const CodeSecurityGetConfigurationResponseSchema =
    CodeSecurityConfigurationSchema
  export type CodeSecurityGetConfigurationResponse = z.infer<
    typeof CodeSecurityGetConfigurationResponseSchema
  >

  export const CodeSecurityDeleteConfigurationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    configuration_id: z
      .number()
      .int()
      .describe('The unique identifier of the code security configuration.')
  })
  export type CodeSecurityDeleteConfigurationParams = z.infer<
    typeof CodeSecurityDeleteConfigurationParamsSchema
  >

  export type CodeSecurityDeleteConfigurationResponse = undefined

  export const CodeSecurityUpdateConfigurationParamsSchema = z.object({
    name: z
      .string()
      .describe(
        'The name of the code security configuration. Must be unique within the organization.'
      )
      .optional(),
    description: z
      .string()
      .max(255)
      .describe('A description of the code security configuration')
      .optional(),
    advanced_security: z
      .enum(['enabled', 'disabled'])
      .describe('The enablement status of GitHub Advanced Security')
      .optional(),
    dependency_graph: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependency Graph')
      .optional(),
    dependency_graph_autosubmit_action: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Automatic dependency submission')
      .optional(),
    dependency_graph_autosubmit_action_options: z
      .object({
        labeled_runners: z
          .boolean()
          .describe(
            "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
          )
          .optional()
      })
      .describe('Feature options for Automatic dependency submission')
      .optional(),
    dependabot_alerts: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependabot alerts')
      .optional(),
    dependabot_security_updates: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Dependabot security updates')
      .optional(),
    code_scanning_default_setup: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of code scanning default setup')
      .optional(),
    code_scanning_default_setup_options:
      CodeScanningDefaultSetupOptionsSchema.optional(),
    code_scanning_delegated_alert_dismissal: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of code scanning delegated alert dismissal'
      )
      .default('disabled'),
    secret_scanning: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning')
      .optional(),
    secret_scanning_push_protection: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning push protection')
      .optional(),
    secret_scanning_delegated_bypass: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning delegated bypass')
      .optional(),
    secret_scanning_delegated_bypass_options: z
      .object({
        reviewers: z
          .array(
            z.object({
              reviewer_id: z
                .number()
                .int()
                .describe(
                  'The ID of the team or role selected as a bypass reviewer'
                ),
              reviewer_type: z
                .enum(['TEAM', 'ROLE'])
                .describe('The type of the bypass reviewer')
            })
          )
          .describe('The bypass reviewers for secret scanning delegated bypass')
          .optional()
      })
      .describe('Feature options for secret scanning delegated bypass')
      .optional(),
    secret_scanning_validity_checks: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of secret scanning validity checks')
      .optional(),
    secret_scanning_non_provider_patterns: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of secret scanning non-provider patterns'
      )
      .optional(),
    secret_scanning_generic_secrets: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of Copilot secret scanning')
      .optional(),
    secret_scanning_delegated_alert_dismissal: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe(
        'The enablement status of secret scanning delegated alert dismissal'
      )
      .optional(),
    private_vulnerability_reporting: z
      .enum(['enabled', 'disabled', 'not_set'])
      .describe('The enablement status of private vulnerability reporting')
      .optional(),
    enforcement: z
      .enum(['enforced', 'unenforced'])
      .describe('The enforcement status for a security configuration')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    configuration_id: z
      .number()
      .int()
      .describe('The unique identifier of the code security configuration.')
  })
  export type CodeSecurityUpdateConfigurationParams = z.infer<
    typeof CodeSecurityUpdateConfigurationParamsSchema
  >

  export const CodeSecurityUpdateConfigurationResponseSchema =
    CodeSecurityConfigurationSchema
  export type CodeSecurityUpdateConfigurationResponse = z.infer<
    typeof CodeSecurityUpdateConfigurationResponseSchema
  >

  export const CodeSecurityAttachConfigurationParamsSchema = z.object({
    scope: z
      .enum([
        'all',
        'all_without_configurations',
        'public',
        'private_or_internal',
        'selected'
      ])
      .describe(
        'The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`'
      ),
    selected_repository_ids: z
      .array(z.number().int().describe('Unique identifier of the repository.'))
      .describe(
        'An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    configuration_id: z
      .number()
      .int()
      .describe('The unique identifier of the code security configuration.')
  })
  export type CodeSecurityAttachConfigurationParams = z.infer<
    typeof CodeSecurityAttachConfigurationParamsSchema
  >

  export type CodeSecurityAttachConfigurationResponse = undefined

  export const CodeSecuritySetConfigurationAsDefaultParamsSchema = z.object({
    default_for_new_repos: z
      .enum(['all', 'none', 'private_and_internal', 'public'])
      .describe(
        'Specify which types of repository this security configuration should be applied to by default.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    configuration_id: z
      .number()
      .int()
      .describe('The unique identifier of the code security configuration.')
  })
  export type CodeSecuritySetConfigurationAsDefaultParams = z.infer<
    typeof CodeSecuritySetConfigurationAsDefaultParamsSchema
  >

  export const CodeSecuritySetConfigurationAsDefaultResponseSchema = z.object({
    default_for_new_repos: z
      .enum(['all', 'none', 'private_and_internal', 'public'])
      .describe(
        'Specifies which types of repository this security configuration is applied to by default.'
      )
      .optional(),
    configuration: CodeSecurityConfigurationSchema.optional()
  })
  export type CodeSecuritySetConfigurationAsDefaultResponse = z.infer<
    typeof CodeSecuritySetConfigurationAsDefaultResponseSchema
  >

  export const CodeSecurityGetRepositoriesForConfigurationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      configuration_id: z
        .number()
        .int()
        .describe('The unique identifier of the code security configuration.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      before: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      after: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      status: z
        .string()
        .describe(
          'A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`'
        )
        .default('all')
    })
  export type CodeSecurityGetRepositoriesForConfigurationParams = z.infer<
    typeof CodeSecurityGetRepositoriesForConfigurationParamsSchema
  >

  export const CodeSecurityGetRepositoriesForConfigurationResponseSchema =
    z.array(CodeSecurityConfigurationRepositoriesSchema)
  export type CodeSecurityGetRepositoriesForConfigurationResponse = z.infer<
    typeof CodeSecurityGetRepositoriesForConfigurationResponseSchema
  >

  export const CodespacesListInOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type CodespacesListInOrganizationParams = z.infer<
    typeof CodespacesListInOrganizationParamsSchema
  >

  export const CodespacesListInOrganizationResponseSchema = z.object({
    total_count: z.number().int(),
    codespaces: z.array(CodespaceSchema)
  })
  export type CodespacesListInOrganizationResponse = z.infer<
    typeof CodespacesListInOrganizationResponseSchema
  >

  export const CodespacesSetCodespacesAccessParamsSchema = z.object({
    visibility: z
      .enum([
        'disabled',
        'selected_members',
        'all_members',
        'all_members_and_outside_collaborators'
      ])
      .describe(
        'Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.'
      ),
    selected_usernames: z
      .array(z.string())
      .max(100)
      .describe(
        'The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodespacesSetCodespacesAccessParams = z.infer<
    typeof CodespacesSetCodespacesAccessParamsSchema
  >

  export type CodespacesSetCodespacesAccessResponse = undefined

  export const CodespacesSetCodespacesAccessUsersParamsSchema = z.object({
    selected_usernames: z
      .array(z.string())
      .max(100)
      .describe(
        'The usernames of the organization members whose codespaces be billed to the organization.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodespacesSetCodespacesAccessUsersParams = z.infer<
    typeof CodespacesSetCodespacesAccessUsersParamsSchema
  >

  export type CodespacesSetCodespacesAccessUsersResponse = undefined

  export const CodespacesDeleteCodespacesAccessUsersParamsSchema = z.object({
    selected_usernames: z
      .array(z.string())
      .max(100)
      .describe(
        'The usernames of the organization members whose codespaces should not be billed to the organization.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodespacesDeleteCodespacesAccessUsersParams = z.infer<
    typeof CodespacesDeleteCodespacesAccessUsersParamsSchema
  >

  export type CodespacesDeleteCodespacesAccessUsersResponse = undefined

  export const CodespacesListOrgSecretsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type CodespacesListOrgSecretsParams = z.infer<
    typeof CodespacesListOrgSecretsParamsSchema
  >

  export const CodespacesListOrgSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(CodespacesOrgSecretSchema)
  })
  export type CodespacesListOrgSecretsResponse = z.infer<
    typeof CodespacesListOrgSecretsResponseSchema
  >

  export const CodespacesGetOrgPublicKeyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CodespacesGetOrgPublicKeyParams = z.infer<
    typeof CodespacesGetOrgPublicKeyParamsSchema
  >

  export const CodespacesGetOrgPublicKeyResponseSchema =
    CodespacesPublicKeySchema
  export type CodespacesGetOrgPublicKeyResponse = z.infer<
    typeof CodespacesGetOrgPublicKeyResponseSchema
  >

  export const CodespacesGetOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesGetOrgSecretParams = z.infer<
    typeof CodespacesGetOrgSecretParamsSchema
  >

  export const CodespacesGetOrgSecretResponseSchema = CodespacesOrgSecretSchema
  export type CodespacesGetOrgSecretResponse = z.infer<
    typeof CodespacesGetOrgSecretResponseSchema
  >

  export const CodespacesCreateOrUpdateOrgSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.'
      )
      .optional(),
    key_id: z
      .string()
      .describe('The ID of the key you used to encrypt the secret.')
      .optional(),
    visibility: z
      .enum(['all', 'private', 'selected'])
      .describe(
        'Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.'
      ),
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesCreateOrUpdateOrgSecretParams = z.infer<
    typeof CodespacesCreateOrUpdateOrgSecretParamsSchema
  >

  export type CodespacesCreateOrUpdateOrgSecretResponse = undefined

  export const CodespacesDeleteOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesDeleteOrgSecretParams = z.infer<
    typeof CodespacesDeleteOrgSecretParamsSchema
  >

  export type CodespacesDeleteOrgSecretResponse = undefined

  export const CodespacesListSelectedReposForOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type CodespacesListSelectedReposForOrgSecretParams = z.infer<
    typeof CodespacesListSelectedReposForOrgSecretParamsSchema
  >

  export const CodespacesListSelectedReposForOrgSecretResponseSchema = z.object(
    {
      total_count: z.number().int(),
      repositories: z.array(MinimalRepositorySchema)
    }
  )
  export type CodespacesListSelectedReposForOrgSecretResponse = z.infer<
    typeof CodespacesListSelectedReposForOrgSecretResponseSchema
  >

  export const CodespacesSetSelectedReposForOrgSecretParamsSchema = z.object({
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesSetSelectedReposForOrgSecretParams = z.infer<
    typeof CodespacesSetSelectedReposForOrgSecretParamsSchema
  >

  export type CodespacesSetSelectedReposForOrgSecretResponse = undefined

  export const CodespacesAddSelectedRepoToOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    repository_id: z.number().int()
  })
  export type CodespacesAddSelectedRepoToOrgSecretParams = z.infer<
    typeof CodespacesAddSelectedRepoToOrgSecretParamsSchema
  >

  export type CodespacesAddSelectedRepoToOrgSecretResponse = undefined

  export const CodespacesRemoveSelectedRepoFromOrgSecretParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      secret_name: z.string().describe('The name of the secret.'),
      repository_id: z.number().int()
    }
  )
  export type CodespacesRemoveSelectedRepoFromOrgSecretParams = z.infer<
    typeof CodespacesRemoveSelectedRepoFromOrgSecretParamsSchema
  >

  export type CodespacesRemoveSelectedRepoFromOrgSecretResponse = undefined

  export const CopilotGetCopilotOrganizationDetailsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CopilotGetCopilotOrganizationDetailsParams = z.infer<
    typeof CopilotGetCopilotOrganizationDetailsParamsSchema
  >

  export const CopilotGetCopilotOrganizationDetailsResponseSchema =
    CopilotOrganizationDetailsSchema
  export type CopilotGetCopilotOrganizationDetailsResponse = z.infer<
    typeof CopilotGetCopilotOrganizationDetailsResponseSchema
  >

  export const CopilotListCopilotSeatsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(50)
  })
  export type CopilotListCopilotSeatsParams = z.infer<
    typeof CopilotListCopilotSeatsParamsSchema
  >

  export const CopilotListCopilotSeatsResponseSchema = z.object({
    total_seats: z
      .number()
      .int()
      .describe(
        'Total number of Copilot seats for the organization currently being billed.'
      )
      .optional(),
    seats: z.array(CopilotSeatDetailsSchema).optional()
  })
  export type CopilotListCopilotSeatsResponse = z.infer<
    typeof CopilotListCopilotSeatsResponseSchema
  >

  export const CopilotAddCopilotSeatsForTeamsParamsSchema = z.object({
    selected_teams: z
      .array(z.string())
      .min(1)
      .describe(
        'List of team names within the organization to which to grant access to GitHub Copilot.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CopilotAddCopilotSeatsForTeamsParams = z.infer<
    typeof CopilotAddCopilotSeatsForTeamsParamsSchema
  >

  export type CopilotAddCopilotSeatsForTeamsResponse = undefined

  export const CopilotCancelCopilotSeatAssignmentForTeamsParamsSchema =
    z.object({
      selected_teams: z
        .array(z.string())
        .min(1)
        .describe(
          'The names of teams from which to revoke access to GitHub Copilot.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type CopilotCancelCopilotSeatAssignmentForTeamsParams = z.infer<
    typeof CopilotCancelCopilotSeatAssignmentForTeamsParamsSchema
  >

  export const CopilotCancelCopilotSeatAssignmentForTeamsResponseSchema = z
    .object({ seats_cancelled: z.number().int() })
    .describe(
      'The total number of seats set to "pending cancellation" for members of the specified team(s).'
    )
  export type CopilotCancelCopilotSeatAssignmentForTeamsResponse = z.infer<
    typeof CopilotCancelCopilotSeatAssignmentForTeamsResponseSchema
  >

  export const CopilotAddCopilotSeatsForUsersParamsSchema = z.object({
    selected_usernames: z
      .array(z.string())
      .min(1)
      .describe(
        'The usernames of the organization members to be granted access to GitHub Copilot.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type CopilotAddCopilotSeatsForUsersParams = z.infer<
    typeof CopilotAddCopilotSeatsForUsersParamsSchema
  >

  export type CopilotAddCopilotSeatsForUsersResponse = undefined

  export const CopilotCancelCopilotSeatAssignmentForUsersParamsSchema =
    z.object({
      selected_usernames: z
        .array(z.string())
        .min(1)
        .describe(
          'The usernames of the organization members for which to revoke access to GitHub Copilot.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type CopilotCancelCopilotSeatAssignmentForUsersParams = z.infer<
    typeof CopilotCancelCopilotSeatAssignmentForUsersParamsSchema
  >

  export const CopilotCancelCopilotSeatAssignmentForUsersResponseSchema = z
    .object({ seats_cancelled: z.number().int() })
    .describe(
      'The total number of seats set to "pending cancellation" for the specified users.'
    )
  export type CopilotCancelCopilotSeatAssignmentForUsersResponse = z.infer<
    typeof CopilotCancelCopilotSeatAssignmentForUsersResponseSchema
  >

  export const CopilotCopilotMetricsForOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    since: z
      .string()
      .describe(
        'Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.'
      )
      .optional(),
    until: z
      .string()
      .describe(
        'Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(28)
  })
  export type CopilotCopilotMetricsForOrganizationParams = z.infer<
    typeof CopilotCopilotMetricsForOrganizationParamsSchema
  >

  export const CopilotCopilotMetricsForOrganizationResponseSchema = z.array(
    CopilotUsageMetricsDaySchema
  )
  export type CopilotCopilotMetricsForOrganizationResponse = z.infer<
    typeof CopilotCopilotMetricsForOrganizationResponseSchema
  >

  export const CopilotUsageMetricsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    since: z
      .string()
      .describe(
        'Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.'
      )
      .optional(),
    until: z
      .string()
      .describe(
        'Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(28)
  })
  export type CopilotUsageMetricsForOrgParams = z.infer<
    typeof CopilotUsageMetricsForOrgParamsSchema
  >

  export const CopilotUsageMetricsForOrgResponseSchema = z.array(
    CopilotUsageMetricsSchema
  )
  export type CopilotUsageMetricsForOrgResponse = z.infer<
    typeof CopilotUsageMetricsForOrgResponseSchema
  >

  export const DependabotListAlertsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    state: z
      .string()
      .describe(
        'A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`'
      )
      .optional(),
    severity: z
      .string()
      .describe(
        'A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`'
      )
      .optional(),
    ecosystem: z
      .string()
      .describe(
        'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`'
      )
      .optional(),
    package: z
      .string()
      .describe(
        'A comma-separated list of package names. If specified, only alerts for these packages will be returned.'
      )
      .optional(),
    epss_percentage: z
      .string()
      .describe(
        'CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.'
      )
      .optional(),
    scope: z
      .enum(['development', 'runtime'])
      .describe(
        'The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'epss_percentage'])
      .describe(
        "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage."
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    first: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.'
      )
      .default(30),
    last: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type DependabotListAlertsForOrgParams = z.infer<
    typeof DependabotListAlertsForOrgParamsSchema
  >

  export const DependabotListAlertsForOrgResponseSchema = z.array(
    DependabotAlertWithRepositorySchema
  )
  export type DependabotListAlertsForOrgResponse = z.infer<
    typeof DependabotListAlertsForOrgResponseSchema
  >

  export const DependabotListOrgSecretsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type DependabotListOrgSecretsParams = z.infer<
    typeof DependabotListOrgSecretsParamsSchema
  >

  export const DependabotListOrgSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(OrganizationDependabotSecretSchema)
  })
  export type DependabotListOrgSecretsResponse = z.infer<
    typeof DependabotListOrgSecretsResponseSchema
  >

  export const DependabotGetOrgPublicKeyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type DependabotGetOrgPublicKeyParams = z.infer<
    typeof DependabotGetOrgPublicKeyParamsSchema
  >

  export const DependabotGetOrgPublicKeyResponseSchema =
    DependabotPublicKeySchema
  export type DependabotGetOrgPublicKeyResponse = z.infer<
    typeof DependabotGetOrgPublicKeyResponseSchema
  >

  export const DependabotGetOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotGetOrgSecretParams = z.infer<
    typeof DependabotGetOrgSecretParamsSchema
  >

  export const DependabotGetOrgSecretResponseSchema =
    OrganizationDependabotSecretSchema
  export type DependabotGetOrgSecretResponse = z.infer<
    typeof DependabotGetOrgSecretResponseSchema
  >

  export const DependabotCreateOrUpdateOrgSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.'
      )
      .optional(),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.')
      .optional(),
    visibility: z
      .enum(['all', 'private', 'selected'])
      .describe(
        'Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.'
      ),
    selected_repository_ids: z
      .array(z.string())
      .describe(
        'An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotCreateOrUpdateOrgSecretParams = z.infer<
    typeof DependabotCreateOrUpdateOrgSecretParamsSchema
  >

  export type DependabotCreateOrUpdateOrgSecretResponse = undefined

  export const DependabotDeleteOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotDeleteOrgSecretParams = z.infer<
    typeof DependabotDeleteOrgSecretParamsSchema
  >

  export type DependabotDeleteOrgSecretResponse = undefined

  export const DependabotListSelectedReposForOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type DependabotListSelectedReposForOrgSecretParams = z.infer<
    typeof DependabotListSelectedReposForOrgSecretParamsSchema
  >

  export const DependabotListSelectedReposForOrgSecretResponseSchema = z.object(
    {
      total_count: z.number().int(),
      repositories: z.array(MinimalRepositorySchema)
    }
  )
  export type DependabotListSelectedReposForOrgSecretResponse = z.infer<
    typeof DependabotListSelectedReposForOrgSecretResponseSchema
  >

  export const DependabotSetSelectedReposForOrgSecretParamsSchema = z.object({
    selected_repository_ids: z
      .array(z.number().int())
      .describe(
        'An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotSetSelectedReposForOrgSecretParams = z.infer<
    typeof DependabotSetSelectedReposForOrgSecretParamsSchema
  >

  export type DependabotSetSelectedReposForOrgSecretResponse = undefined

  export const DependabotAddSelectedRepoToOrgSecretParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.'),
    repository_id: z.number().int()
  })
  export type DependabotAddSelectedRepoToOrgSecretParams = z.infer<
    typeof DependabotAddSelectedRepoToOrgSecretParamsSchema
  >

  export type DependabotAddSelectedRepoToOrgSecretResponse = undefined

  export const DependabotRemoveSelectedRepoFromOrgSecretParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      secret_name: z.string().describe('The name of the secret.'),
      repository_id: z.number().int()
    }
  )
  export type DependabotRemoveSelectedRepoFromOrgSecretParams = z.infer<
    typeof DependabotRemoveSelectedRepoFromOrgSecretParamsSchema
  >

  export type DependabotRemoveSelectedRepoFromOrgSecretResponse = undefined

  export const PackagesListDockerMigrationConflictingPackagesForOrganizationParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type PackagesListDockerMigrationConflictingPackagesForOrganizationParams =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForOrganizationParamsSchema
    >

  export const PackagesListDockerMigrationConflictingPackagesForOrganizationResponseSchema =
    z.array(PackageSchema)
  export type PackagesListDockerMigrationConflictingPackagesForOrganizationResponse =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForOrganizationResponseSchema
    >

  export const ActivityListPublicOrgEventsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListPublicOrgEventsParams = z.infer<
    typeof ActivityListPublicOrgEventsParamsSchema
  >

  export const ActivityListPublicOrgEventsResponseSchema = z.array(EventSchema)
  export type ActivityListPublicOrgEventsResponse = z.infer<
    typeof ActivityListPublicOrgEventsResponseSchema
  >

  export const OrgsListFailedInvitationsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListFailedInvitationsParams = z.infer<
    typeof OrgsListFailedInvitationsParamsSchema
  >

  export const OrgsListFailedInvitationsResponseSchema = z.array(
    OrganizationInvitationSchema
  )
  export type OrgsListFailedInvitationsResponse = z.infer<
    typeof OrgsListFailedInvitationsResponseSchema
  >

  export const OrgsListWebhooksParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListWebhooksParams = z.infer<
    typeof OrgsListWebhooksParamsSchema
  >

  export const OrgsListWebhooksResponseSchema = z.array(OrgHookSchema)
  export type OrgsListWebhooksResponse = z.infer<
    typeof OrgsListWebhooksResponseSchema
  >

  export const OrgsCreateWebhookParamsSchema = z.object({
    name: z.string().describe('Must be passed as "web".'),
    config: z
      .object({
        url: WebhookConfigUrlSchema,
        content_type: WebhookConfigContentTypeSchema.optional(),
        secret: WebhookConfigSecretSchema.optional(),
        insecure_ssl: WebhookConfigInsecureSslSchema.optional(),
        username: z.string().optional(),
        password: z.string().optional()
      })
      .describe('Key/value pairs to provide settings for this webhook.'),
    events: z
      .array(z.string())
      .describe(
        'Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events.'
      )
      .default(['push']),
    active: z
      .boolean()
      .describe(
        'Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.'
      )
      .default(true),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsCreateWebhookParams = z.infer<
    typeof OrgsCreateWebhookParamsSchema
  >

  export type OrgsCreateWebhookResponse = undefined

  export const OrgsGetWebhookParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsGetWebhookParams = z.infer<typeof OrgsGetWebhookParamsSchema>

  export const OrgsGetWebhookResponseSchema = OrgHookSchema
  export type OrgsGetWebhookResponse = z.infer<
    typeof OrgsGetWebhookResponseSchema
  >

  export const OrgsDeleteWebhookParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsDeleteWebhookParams = z.infer<
    typeof OrgsDeleteWebhookParamsSchema
  >

  export type OrgsDeleteWebhookResponse = undefined

  export const OrgsUpdateWebhookParamsSchema = z.object({
    config: z
      .object({
        url: WebhookConfigUrlSchema,
        content_type: WebhookConfigContentTypeSchema.optional(),
        secret: WebhookConfigSecretSchema.optional(),
        insecure_ssl: WebhookConfigInsecureSslSchema.optional()
      })
      .describe('Key/value pairs to provide settings for this webhook.')
      .optional(),
    events: z
      .array(z.string())
      .describe(
        'Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.'
      )
      .default(['push']),
    active: z
      .boolean()
      .describe(
        'Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.'
      )
      .default(true),
    name: z.string().optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsUpdateWebhookParams = z.infer<
    typeof OrgsUpdateWebhookParamsSchema
  >

  export const OrgsUpdateWebhookResponseSchema = OrgHookSchema
  export type OrgsUpdateWebhookResponse = z.infer<
    typeof OrgsUpdateWebhookResponseSchema
  >

  export const OrgsGetWebhookConfigForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsGetWebhookConfigForOrgParams = z.infer<
    typeof OrgsGetWebhookConfigForOrgParamsSchema
  >

  export const OrgsGetWebhookConfigForOrgResponseSchema = WebhookConfigSchema
  export type OrgsGetWebhookConfigForOrgResponse = z.infer<
    typeof OrgsGetWebhookConfigForOrgResponseSchema
  >

  export const OrgsUpdateWebhookConfigForOrgParamsSchema = z.object({
    url: WebhookConfigUrlSchema.optional(),
    content_type: WebhookConfigContentTypeSchema.optional(),
    secret: WebhookConfigSecretSchema.optional(),
    insecure_ssl: WebhookConfigInsecureSslSchema.optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsUpdateWebhookConfigForOrgParams = z.infer<
    typeof OrgsUpdateWebhookConfigForOrgParamsSchema
  >

  export const OrgsUpdateWebhookConfigForOrgResponseSchema = WebhookConfigSchema
  export type OrgsUpdateWebhookConfigForOrgResponse = z.infer<
    typeof OrgsUpdateWebhookConfigForOrgResponseSchema
  >

  export const OrgsListWebhookDeliveriesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    cursor: z
      .string()
      .describe(
        'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.'
      )
      .optional()
  })
  export type OrgsListWebhookDeliveriesParams = z.infer<
    typeof OrgsListWebhookDeliveriesParamsSchema
  >

  export const OrgsListWebhookDeliveriesResponseSchema = z.array(
    HookDeliveryItemSchema
  )
  export type OrgsListWebhookDeliveriesResponse = z.infer<
    typeof OrgsListWebhookDeliveriesResponseSchema
  >

  export const OrgsGetWebhookDeliveryParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    delivery_id: z.number().int()
  })
  export type OrgsGetWebhookDeliveryParams = z.infer<
    typeof OrgsGetWebhookDeliveryParamsSchema
  >

  export const OrgsGetWebhookDeliveryResponseSchema = HookDeliverySchema
  export type OrgsGetWebhookDeliveryResponse = z.infer<
    typeof OrgsGetWebhookDeliveryResponseSchema
  >

  export const OrgsRedeliverWebhookDeliveryParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    delivery_id: z.number().int()
  })
  export type OrgsRedeliverWebhookDeliveryParams = z.infer<
    typeof OrgsRedeliverWebhookDeliveryParamsSchema
  >

  export type OrgsRedeliverWebhookDeliveryResponse = undefined

  export const OrgsPingWebhookParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type OrgsPingWebhookParams = z.infer<
    typeof OrgsPingWebhookParamsSchema
  >

  export type OrgsPingWebhookResponse = undefined

  export const ApiInsightsGetRouteStatsByActorParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    actor_type: z
      .enum([
        'installation',
        'classic_pat',
        'fine_grained_pat',
        'oauth_app',
        'github_app_user_to_server'
      ])
      .describe('The type of the actor'),
    actor_id: z.number().int().describe('The ID of the actor'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    sort: z
      .array(
        z
          .enum([
            'last_rate_limited_timestamp',
            'last_request_timestamp',
            'rate_limited_request_count',
            'http_method',
            'api_route',
            'total_request_count'
          ])
          .default('total_request_count')
      )
      .describe('The property to sort the results by.')
      .optional(),
    api_route_substring: z
      .string()
      .describe(
        'Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.'
      )
      .optional()
  })
  export type ApiInsightsGetRouteStatsByActorParams = z.infer<
    typeof ApiInsightsGetRouteStatsByActorParamsSchema
  >

  export const ApiInsightsGetRouteStatsByActorResponseSchema =
    ApiInsightsRouteStatsSchema
  export type ApiInsightsGetRouteStatsByActorResponse = z.infer<
    typeof ApiInsightsGetRouteStatsByActorResponseSchema
  >

  export const ApiInsightsGetSubjectStatsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    sort: z
      .array(
        z
          .enum([
            'last_rate_limited_timestamp',
            'last_request_timestamp',
            'rate_limited_request_count',
            'subject_name',
            'total_request_count'
          ])
          .default('total_request_count')
      )
      .describe('The property to sort the results by.')
      .optional(),
    subject_name_substring: z
      .string()
      .describe(
        'Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.'
      )
      .optional()
  })
  export type ApiInsightsGetSubjectStatsParams = z.infer<
    typeof ApiInsightsGetSubjectStatsParamsSchema
  >

  export const ApiInsightsGetSubjectStatsResponseSchema =
    ApiInsightsSubjectStatsSchema
  export type ApiInsightsGetSubjectStatsResponse = z.infer<
    typeof ApiInsightsGetSubjectStatsResponseSchema
  >

  export const ApiInsightsGetSummaryStatsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional()
  })
  export type ApiInsightsGetSummaryStatsParams = z.infer<
    typeof ApiInsightsGetSummaryStatsParamsSchema
  >

  export const ApiInsightsGetSummaryStatsResponseSchema =
    ApiInsightsSummaryStatsSchema
  export type ApiInsightsGetSummaryStatsResponse = z.infer<
    typeof ApiInsightsGetSummaryStatsResponseSchema
  >

  export const ApiInsightsGetSummaryStatsByUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    user_id: z.string().describe('The ID of the user to query for stats'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional()
  })
  export type ApiInsightsGetSummaryStatsByUserParams = z.infer<
    typeof ApiInsightsGetSummaryStatsByUserParamsSchema
  >

  export const ApiInsightsGetSummaryStatsByUserResponseSchema =
    ApiInsightsSummaryStatsSchema
  export type ApiInsightsGetSummaryStatsByUserResponse = z.infer<
    typeof ApiInsightsGetSummaryStatsByUserResponseSchema
  >

  export const ApiInsightsGetSummaryStatsByActorParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    actor_type: z
      .enum([
        'installation',
        'classic_pat',
        'fine_grained_pat',
        'oauth_app',
        'github_app_user_to_server'
      ])
      .describe('The type of the actor'),
    actor_id: z.number().int().describe('The ID of the actor'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional()
  })
  export type ApiInsightsGetSummaryStatsByActorParams = z.infer<
    typeof ApiInsightsGetSummaryStatsByActorParamsSchema
  >

  export const ApiInsightsGetSummaryStatsByActorResponseSchema =
    ApiInsightsSummaryStatsSchema
  export type ApiInsightsGetSummaryStatsByActorResponse = z.infer<
    typeof ApiInsightsGetSummaryStatsByActorResponseSchema
  >

  export const ApiInsightsGetTimeStatsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    timestamp_increment: z
      .string()
      .describe(
        'The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)'
      )
  })
  export type ApiInsightsGetTimeStatsParams = z.infer<
    typeof ApiInsightsGetTimeStatsParamsSchema
  >

  export const ApiInsightsGetTimeStatsResponseSchema =
    ApiInsightsTimeStatsSchema
  export type ApiInsightsGetTimeStatsResponse = z.infer<
    typeof ApiInsightsGetTimeStatsResponseSchema
  >

  export const ApiInsightsGetTimeStatsByUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    user_id: z.string().describe('The ID of the user to query for stats'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    timestamp_increment: z
      .string()
      .describe(
        'The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)'
      )
  })
  export type ApiInsightsGetTimeStatsByUserParams = z.infer<
    typeof ApiInsightsGetTimeStatsByUserParamsSchema
  >

  export const ApiInsightsGetTimeStatsByUserResponseSchema =
    ApiInsightsTimeStatsSchema
  export type ApiInsightsGetTimeStatsByUserResponse = z.infer<
    typeof ApiInsightsGetTimeStatsByUserResponseSchema
  >

  export const ApiInsightsGetTimeStatsByActorParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    actor_type: z
      .enum([
        'installation',
        'classic_pat',
        'fine_grained_pat',
        'oauth_app',
        'github_app_user_to_server'
      ])
      .describe('The type of the actor'),
    actor_id: z.number().int().describe('The ID of the actor'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    timestamp_increment: z
      .string()
      .describe(
        'The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)'
      )
  })
  export type ApiInsightsGetTimeStatsByActorParams = z.infer<
    typeof ApiInsightsGetTimeStatsByActorParamsSchema
  >

  export const ApiInsightsGetTimeStatsByActorResponseSchema =
    ApiInsightsTimeStatsSchema
  export type ApiInsightsGetTimeStatsByActorResponse = z.infer<
    typeof ApiInsightsGetTimeStatsByActorResponseSchema
  >

  export const ApiInsightsGetUserStatsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    user_id: z.string().describe('The ID of the user to query for stats'),
    min_timestamp: z
      .string()
      .describe(
        'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      ),
    max_timestamp: z
      .string()
      .describe(
        'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    sort: z
      .array(
        z
          .enum([
            'last_rate_limited_timestamp',
            'last_request_timestamp',
            'rate_limited_request_count',
            'subject_name',
            'total_request_count'
          ])
          .default('total_request_count')
      )
      .describe('The property to sort the results by.')
      .optional(),
    actor_name_substring: z
      .string()
      .describe(
        'Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.'
      )
      .optional()
  })
  export type ApiInsightsGetUserStatsParams = z.infer<
    typeof ApiInsightsGetUserStatsParamsSchema
  >

  export const ApiInsightsGetUserStatsResponseSchema =
    ApiInsightsUserStatsSchema
  export type ApiInsightsGetUserStatsResponse = z.infer<
    typeof ApiInsightsGetUserStatsResponseSchema
  >

  export const AppsGetOrgInstallationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type AppsGetOrgInstallationParams = z.infer<
    typeof AppsGetOrgInstallationParamsSchema
  >

  export const AppsGetOrgInstallationResponseSchema = InstallationSchema
  export type AppsGetOrgInstallationResponse = z.infer<
    typeof AppsGetOrgInstallationResponseSchema
  >

  export const OrgsListAppInstallationsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListAppInstallationsParams = z.infer<
    typeof OrgsListAppInstallationsParamsSchema
  >

  export const OrgsListAppInstallationsResponseSchema = z.object({
    total_count: z.number().int(),
    installations: z.array(InstallationSchema)
  })
  export type OrgsListAppInstallationsResponse = z.infer<
    typeof OrgsListAppInstallationsResponseSchema
  >

  export const InteractionsGetRestrictionsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type InteractionsGetRestrictionsForOrgParams = z.infer<
    typeof InteractionsGetRestrictionsForOrgParamsSchema
  >

  export const InteractionsGetRestrictionsForOrgResponseSchema = z.union([
    InteractionLimitResponseSchema,
    z.object({}).strict()
  ])
  export type InteractionsGetRestrictionsForOrgResponse = z.infer<
    typeof InteractionsGetRestrictionsForOrgResponseSchema
  >

  export const InteractionsSetRestrictionsForOrgParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
    .merge(InteractionLimitSchema)
  export type InteractionsSetRestrictionsForOrgParams = z.infer<
    typeof InteractionsSetRestrictionsForOrgParamsSchema
  >

  export const InteractionsSetRestrictionsForOrgResponseSchema =
    InteractionLimitResponseSchema
  export type InteractionsSetRestrictionsForOrgResponse = z.infer<
    typeof InteractionsSetRestrictionsForOrgResponseSchema
  >

  export const InteractionsRemoveRestrictionsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type InteractionsRemoveRestrictionsForOrgParams = z.infer<
    typeof InteractionsRemoveRestrictionsForOrgParamsSchema
  >

  export type InteractionsRemoveRestrictionsForOrgResponse = undefined

  export const OrgsListPendingInvitationsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    role: z
      .enum([
        'all',
        'admin',
        'direct_member',
        'billing_manager',
        'hiring_manager'
      ])
      .describe('Filter invitations by their member role.')
      .default('all'),
    invitation_source: z
      .enum(['all', 'member', 'scim'])
      .describe('Filter invitations by their invitation source.')
      .default('all')
  })
  export type OrgsListPendingInvitationsParams = z.infer<
    typeof OrgsListPendingInvitationsParamsSchema
  >

  export const OrgsListPendingInvitationsResponseSchema = z.array(
    OrganizationInvitationSchema
  )
  export type OrgsListPendingInvitationsResponse = z.infer<
    typeof OrgsListPendingInvitationsResponseSchema
  >

  export const OrgsCreateInvitationParamsSchema = z.object({
    invitee_id: z
      .number()
      .int()
      .describe(
        '**Required unless you provide `email`**. GitHub user ID for the person you are inviting.'
      )
      .optional(),
    email: z
      .string()
      .describe(
        '**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.'
      )
      .optional(),
    role: z
      .enum(['admin', 'direct_member', 'billing_manager', 'reinstate'])
      .describe(
        'The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.  \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation.  \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.'
      )
      .default('direct_member'),
    team_ids: z
      .array(z.number().int())
      .describe('Specify IDs for the teams you want to invite new members to.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsCreateInvitationParams = z.infer<
    typeof OrgsCreateInvitationParamsSchema
  >

  export type OrgsCreateInvitationResponse = undefined

  export const OrgsCancelInvitationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    invitation_id: z
      .number()
      .int()
      .describe('The unique identifier of the invitation.')
  })
  export type OrgsCancelInvitationParams = z.infer<
    typeof OrgsCancelInvitationParamsSchema
  >

  export type OrgsCancelInvitationResponse = undefined

  export const OrgsListInvitationTeamsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    invitation_id: z
      .number()
      .int()
      .describe('The unique identifier of the invitation.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListInvitationTeamsParams = z.infer<
    typeof OrgsListInvitationTeamsParamsSchema
  >

  export const OrgsListInvitationTeamsResponseSchema = z.array(TeamSchema)
  export type OrgsListInvitationTeamsResponse = z.infer<
    typeof OrgsListInvitationTeamsResponseSchema
  >

  export const OrgsListIssueTypesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsListIssueTypesParams = z.infer<
    typeof OrgsListIssueTypesParamsSchema
  >

  export const OrgsListIssueTypesResponseSchema = z.array(IssueTypeSchema)
  export type OrgsListIssueTypesResponse = z.infer<
    typeof OrgsListIssueTypesResponseSchema
  >

  export const OrgsCreateIssueTypeParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
    .merge(OrganizationCreateIssueTypeSchema)
  export type OrgsCreateIssueTypeParams = z.infer<
    typeof OrgsCreateIssueTypeParamsSchema
  >

  export const OrgsCreateIssueTypeResponseSchema = IssueTypeSchema
  export type OrgsCreateIssueTypeResponse = z.infer<
    typeof OrgsCreateIssueTypeResponseSchema
  >

  export const OrgsUpdateIssueTypeParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      issue_type_id: z
        .number()
        .int()
        .describe('The unique identifier of the issue type.')
    })
    .merge(OrganizationUpdateIssueTypeSchema)
  export type OrgsUpdateIssueTypeParams = z.infer<
    typeof OrgsUpdateIssueTypeParamsSchema
  >

  export const OrgsUpdateIssueTypeResponseSchema = IssueTypeSchema
  export type OrgsUpdateIssueTypeResponse = z.infer<
    typeof OrgsUpdateIssueTypeResponseSchema
  >

  export const OrgsDeleteIssueTypeParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    issue_type_id: z
      .number()
      .int()
      .describe('The unique identifier of the issue type.')
  })
  export type OrgsDeleteIssueTypeParams = z.infer<
    typeof OrgsDeleteIssueTypeParamsSchema
  >

  export type OrgsDeleteIssueTypeResponse = undefined

  export const IssuesListForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    filter: z
      .enum(['assigned', 'created', 'mentioned', 'subscribed', 'repos', 'all'])
      .describe(
        "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation."
      )
      .default('assigned'),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the issues to return.')
      .default('open'),
    labels: z
      .string()
      .describe(
        'A list of comma separated label names. Example: `bug,ui,@high`'
      )
      .optional(),
    type: z.string().describe('Can be the name of an issue type.').optional(),
    sort: z
      .enum(['created', 'updated', 'comments'])
      .describe('What to sort results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListForOrgParams = z.infer<
    typeof IssuesListForOrgParamsSchema
  >

  export const IssuesListForOrgResponseSchema = z.array(IssueSchema)
  export type IssuesListForOrgResponse = z.infer<
    typeof IssuesListForOrgResponseSchema
  >

  export const OrgsListMembersParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    filter: z
      .enum(['2fa_disabled', 'all'])
      .describe(
        'Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.'
      )
      .default('all'),
    role: z
      .enum(['all', 'admin', 'member'])
      .describe('Filter members returned by their role.')
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListMembersParams = z.infer<
    typeof OrgsListMembersParamsSchema
  >

  export const OrgsListMembersResponseSchema = z.array(SimpleUserSchema)
  export type OrgsListMembersResponse = z.infer<
    typeof OrgsListMembersResponseSchema
  >

  export const OrgsCheckMembershipForUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsCheckMembershipForUserParams = z.infer<
    typeof OrgsCheckMembershipForUserParamsSchema
  >

  export type OrgsCheckMembershipForUserResponse = undefined

  export const OrgsRemoveMemberParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsRemoveMemberParams = z.infer<
    typeof OrgsRemoveMemberParamsSchema
  >

  export type OrgsRemoveMemberResponse = undefined

  export const CodespacesGetCodespacesForUserInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type CodespacesGetCodespacesForUserInOrgParams = z.infer<
    typeof CodespacesGetCodespacesForUserInOrgParamsSchema
  >

  export const CodespacesGetCodespacesForUserInOrgResponseSchema = z.object({
    total_count: z.number().int(),
    codespaces: z.array(CodespaceSchema)
  })
  export type CodespacesGetCodespacesForUserInOrgResponse = z.infer<
    typeof CodespacesGetCodespacesForUserInOrgResponseSchema
  >

  export const CodespacesDeleteFromOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesDeleteFromOrganizationParams = z.infer<
    typeof CodespacesDeleteFromOrganizationParamsSchema
  >

  export type CodespacesDeleteFromOrganizationResponse = undefined

  export const CodespacesStopInOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesStopInOrganizationParams = z.infer<
    typeof CodespacesStopInOrganizationParamsSchema
  >

  export const CodespacesStopInOrganizationResponseSchema = CodespaceSchema
  export type CodespacesStopInOrganizationResponse = z.infer<
    typeof CodespacesStopInOrganizationResponseSchema
  >

  export const CopilotGetCopilotSeatDetailsForUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type CopilotGetCopilotSeatDetailsForUserParams = z.infer<
    typeof CopilotGetCopilotSeatDetailsForUserParamsSchema
  >

  export const CopilotGetCopilotSeatDetailsForUserResponseSchema =
    CopilotSeatDetailsSchema
  export type CopilotGetCopilotSeatDetailsForUserResponse = z.infer<
    typeof CopilotGetCopilotSeatDetailsForUserResponseSchema
  >

  export const OrgsGetMembershipForUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsGetMembershipForUserParams = z.infer<
    typeof OrgsGetMembershipForUserParamsSchema
  >

  export const OrgsGetMembershipForUserResponseSchema = OrgMembershipSchema
  export type OrgsGetMembershipForUserResponse = z.infer<
    typeof OrgsGetMembershipForUserResponseSchema
  >

  export const OrgsSetMembershipForUserParamsSchema = z.object({
    role: z
      .enum(['admin', 'member'])
      .describe(
        'The role to give the user in the organization. Can be one of:  \n * `admin` - The user will become an owner of the organization.  \n * `member` - The user will become a non-owner member of the organization.'
      )
      .default('member'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsSetMembershipForUserParams = z.infer<
    typeof OrgsSetMembershipForUserParamsSchema
  >

  export const OrgsSetMembershipForUserResponseSchema = OrgMembershipSchema
  export type OrgsSetMembershipForUserResponse = z.infer<
    typeof OrgsSetMembershipForUserResponseSchema
  >

  export const OrgsRemoveMembershipForUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsRemoveMembershipForUserParams = z.infer<
    typeof OrgsRemoveMembershipForUserParamsSchema
  >

  export type OrgsRemoveMembershipForUserResponse = undefined

  export const MigrationsListForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    exclude: z
      .array(
        z
          .literal('repositories')
          .describe('Allowed values that can be passed to the exclude param.')
      )
      .describe(
        'Exclude attributes from the API response to improve performance'
      )
      .optional()
  })
  export type MigrationsListForOrgParams = z.infer<
    typeof MigrationsListForOrgParamsSchema
  >

  export const MigrationsListForOrgResponseSchema = z.array(MigrationSchema)
  export type MigrationsListForOrgResponse = z.infer<
    typeof MigrationsListForOrgResponseSchema
  >

  export const MigrationsStartForOrgParamsSchema = z.object({
    repositories: z
      .array(z.string())
      .describe(
        'A list of arrays indicating which repositories should be migrated.'
      ),
    lock_repositories: z
      .boolean()
      .describe(
        'Indicates whether repositories should be locked (to prevent manipulation) while migrating data.'
      )
      .default(false),
    exclude_metadata: z
      .boolean()
      .describe(
        'Indicates whether metadata should be excluded and only git source should be included for the migration.'
      )
      .default(false),
    exclude_git_data: z
      .boolean()
      .describe(
        'Indicates whether the repository git data should be excluded from the migration.'
      )
      .default(false),
    exclude_attachments: z
      .boolean()
      .describe(
        'Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).'
      )
      .default(false),
    exclude_releases: z
      .boolean()
      .describe(
        'Indicates whether releases should be excluded from the migration (to reduce migration archive file size).'
      )
      .default(false),
    exclude_owner_projects: z
      .boolean()
      .describe(
        'Indicates whether projects owned by the organization or users should be excluded. from the migration.'
      )
      .default(false),
    org_metadata_only: z
      .boolean()
      .describe(
        'Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).'
      )
      .default(false),
    exclude: z
      .array(z.literal('repositories'))
      .describe(
        'Exclude related items from being returned in the response in order to improve performance of the request.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type MigrationsStartForOrgParams = z.infer<
    typeof MigrationsStartForOrgParamsSchema
  >

  export type MigrationsStartForOrgResponse = undefined

  export const MigrationsGetStatusForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    exclude: z
      .array(
        z
          .literal('repositories')
          .describe('Allowed values that can be passed to the exclude param.')
      )
      .describe(
        'Exclude attributes from the API response to improve performance'
      )
      .optional()
  })
  export type MigrationsGetStatusForOrgParams = z.infer<
    typeof MigrationsGetStatusForOrgParamsSchema
  >

  export const MigrationsGetStatusForOrgResponseSchema = MigrationSchema
  export type MigrationsGetStatusForOrgResponse = z.infer<
    typeof MigrationsGetStatusForOrgResponseSchema
  >

  export const MigrationsDownloadArchiveForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.')
  })
  export type MigrationsDownloadArchiveForOrgParams = z.infer<
    typeof MigrationsDownloadArchiveForOrgParamsSchema
  >

  export type MigrationsDownloadArchiveForOrgResponse = undefined

  export const MigrationsDeleteArchiveForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.')
  })
  export type MigrationsDeleteArchiveForOrgParams = z.infer<
    typeof MigrationsDeleteArchiveForOrgParamsSchema
  >

  export type MigrationsDeleteArchiveForOrgResponse = undefined

  export const MigrationsUnlockRepoForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    repo_name: z.string().describe('repo_name parameter')
  })
  export type MigrationsUnlockRepoForOrgParams = z.infer<
    typeof MigrationsUnlockRepoForOrgParamsSchema
  >

  export type MigrationsUnlockRepoForOrgResponse = undefined

  export const MigrationsListReposForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type MigrationsListReposForOrgParams = z.infer<
    typeof MigrationsListReposForOrgParamsSchema
  >

  export const MigrationsListReposForOrgResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type MigrationsListReposForOrgResponse = z.infer<
    typeof MigrationsListReposForOrgResponseSchema
  >

  export const OrgsListOrgRolesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsListOrgRolesParams = z.infer<
    typeof OrgsListOrgRolesParamsSchema
  >

  export const OrgsListOrgRolesResponseSchema = z.object({
    total_count: z
      .number()
      .int()
      .describe(
        'The total number of organization roles available to the organization.'
      )
      .optional(),
    roles: z
      .array(OrganizationRoleSchema)
      .describe('The list of organization roles available to the organization.')
      .optional()
  })
  export type OrgsListOrgRolesResponse = z.infer<
    typeof OrgsListOrgRolesResponseSchema
  >

  export const OrgsRevokeAllOrgRolesTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type OrgsRevokeAllOrgRolesTeamParams = z.infer<
    typeof OrgsRevokeAllOrgRolesTeamParamsSchema
  >

  export type OrgsRevokeAllOrgRolesTeamResponse = undefined

  export const OrgsAssignTeamToOrgRoleParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    role_id: z.number().int().describe('The unique identifier of the role.')
  })
  export type OrgsAssignTeamToOrgRoleParams = z.infer<
    typeof OrgsAssignTeamToOrgRoleParamsSchema
  >

  export type OrgsAssignTeamToOrgRoleResponse = undefined

  export const OrgsRevokeOrgRoleTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    role_id: z.number().int().describe('The unique identifier of the role.')
  })
  export type OrgsRevokeOrgRoleTeamParams = z.infer<
    typeof OrgsRevokeOrgRoleTeamParamsSchema
  >

  export type OrgsRevokeOrgRoleTeamResponse = undefined

  export const OrgsRevokeAllOrgRolesUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsRevokeAllOrgRolesUserParams = z.infer<
    typeof OrgsRevokeAllOrgRolesUserParamsSchema
  >

  export type OrgsRevokeAllOrgRolesUserResponse = undefined

  export const OrgsAssignUserToOrgRoleParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    role_id: z.number().int().describe('The unique identifier of the role.')
  })
  export type OrgsAssignUserToOrgRoleParams = z.infer<
    typeof OrgsAssignUserToOrgRoleParamsSchema
  >

  export type OrgsAssignUserToOrgRoleResponse = undefined

  export const OrgsRevokeOrgRoleUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    role_id: z.number().int().describe('The unique identifier of the role.')
  })
  export type OrgsRevokeOrgRoleUserParams = z.infer<
    typeof OrgsRevokeOrgRoleUserParamsSchema
  >

  export type OrgsRevokeOrgRoleUserResponse = undefined

  export const OrgsGetOrgRoleParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    role_id: z.number().int().describe('The unique identifier of the role.')
  })
  export type OrgsGetOrgRoleParams = z.infer<typeof OrgsGetOrgRoleParamsSchema>

  export const OrgsGetOrgRoleResponseSchema = OrganizationRoleSchema
  export type OrgsGetOrgRoleResponse = z.infer<
    typeof OrgsGetOrgRoleResponseSchema
  >

  export const OrgsListOrgRoleTeamsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    role_id: z.number().int().describe('The unique identifier of the role.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListOrgRoleTeamsParams = z.infer<
    typeof OrgsListOrgRoleTeamsParamsSchema
  >

  export const OrgsListOrgRoleTeamsResponseSchema = z
    .array(TeamRoleAssignmentSchema)
    .describe('List of teams assigned to the organization role')
  export type OrgsListOrgRoleTeamsResponse = z.infer<
    typeof OrgsListOrgRoleTeamsResponseSchema
  >

  export const OrgsListOrgRoleUsersParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    role_id: z.number().int().describe('The unique identifier of the role.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListOrgRoleUsersParams = z.infer<
    typeof OrgsListOrgRoleUsersParamsSchema
  >

  export const OrgsListOrgRoleUsersResponseSchema = z
    .array(UserRoleAssignmentSchema)
    .describe('List of users assigned to the organization role')
  export type OrgsListOrgRoleUsersResponse = z.infer<
    typeof OrgsListOrgRoleUsersResponseSchema
  >

  export const OrgsListOutsideCollaboratorsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    filter: z
      .enum(['2fa_disabled', 'all'])
      .describe(
        'Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.'
      )
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListOutsideCollaboratorsParams = z.infer<
    typeof OrgsListOutsideCollaboratorsParamsSchema
  >

  export const OrgsListOutsideCollaboratorsResponseSchema =
    z.array(SimpleUserSchema)
  export type OrgsListOutsideCollaboratorsResponse = z.infer<
    typeof OrgsListOutsideCollaboratorsResponseSchema
  >

  export const OrgsConvertMemberToOutsideCollaboratorParamsSchema = z.object({
    async: z
      .boolean()
      .describe(
        'When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.'
      )
      .default(false),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsConvertMemberToOutsideCollaboratorParams = z.infer<
    typeof OrgsConvertMemberToOutsideCollaboratorParamsSchema
  >

  export type OrgsConvertMemberToOutsideCollaboratorResponse = undefined

  export const OrgsRemoveOutsideCollaboratorParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsRemoveOutsideCollaboratorParams = z.infer<
    typeof OrgsRemoveOutsideCollaboratorParamsSchema
  >

  export type OrgsRemoveOutsideCollaboratorResponse = undefined

  export const PackagesListPackagesForOrganizationParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    visibility: z
      .enum(['public', 'private', 'internal'])
      .describe(
        'The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type PackagesListPackagesForOrganizationParams = z.infer<
    typeof PackagesListPackagesForOrganizationParamsSchema
  >

  export const PackagesListPackagesForOrganizationResponseSchema =
    z.array(PackageSchema)
  export type PackagesListPackagesForOrganizationResponse = z.infer<
    typeof PackagesListPackagesForOrganizationResponseSchema
  >

  export const PackagesGetPackageForOrganizationParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type PackagesGetPackageForOrganizationParams = z.infer<
    typeof PackagesGetPackageForOrganizationParamsSchema
  >

  export const PackagesGetPackageForOrganizationResponseSchema = PackageSchema
  export type PackagesGetPackageForOrganizationResponse = z.infer<
    typeof PackagesGetPackageForOrganizationResponseSchema
  >

  export const PackagesDeletePackageForOrgParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type PackagesDeletePackageForOrgParams = z.infer<
    typeof PackagesDeletePackageForOrgParamsSchema
  >

  export type PackagesDeletePackageForOrgResponse = undefined

  export const PackagesRestorePackageForOrgParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    token: z.string().describe('package token').optional()
  })
  export type PackagesRestorePackageForOrgParams = z.infer<
    typeof PackagesRestorePackageForOrgParamsSchema
  >

  export type PackagesRestorePackageForOrgResponse = undefined

  export const PackagesGetAllPackageVersionsForPackageOwnedByOrgParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      state: z
        .enum(['active', 'deleted'])
        .describe('The state of the package, either active or deleted.')
        .default('active')
    })
  export type PackagesGetAllPackageVersionsForPackageOwnedByOrgParams = z.infer<
    typeof PackagesGetAllPackageVersionsForPackageOwnedByOrgParamsSchema
  >

  export const PackagesGetAllPackageVersionsForPackageOwnedByOrgResponseSchema =
    z.array(PackageVersionSchema)
  export type PackagesGetAllPackageVersionsForPackageOwnedByOrgResponse =
    z.infer<
      typeof PackagesGetAllPackageVersionsForPackageOwnedByOrgResponseSchema
    >

  export const PackagesGetPackageVersionForOrganizationParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.')
  })
  export type PackagesGetPackageVersionForOrganizationParams = z.infer<
    typeof PackagesGetPackageVersionForOrganizationParamsSchema
  >

  export const PackagesGetPackageVersionForOrganizationResponseSchema =
    PackageVersionSchema
  export type PackagesGetPackageVersionForOrganizationResponse = z.infer<
    typeof PackagesGetPackageVersionForOrganizationResponseSchema
  >

  export const PackagesDeletePackageVersionForOrgParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.')
  })
  export type PackagesDeletePackageVersionForOrgParams = z.infer<
    typeof PackagesDeletePackageVersionForOrgParamsSchema
  >

  export type PackagesDeletePackageVersionForOrgResponse = undefined

  export const PackagesRestorePackageVersionForOrgParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.')
  })
  export type PackagesRestorePackageVersionForOrgParams = z.infer<
    typeof PackagesRestorePackageVersionForOrgParamsSchema
  >

  export type PackagesRestorePackageVersionForOrgResponse = undefined

  export const OrgsListPatGrantRequestsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    sort: z
      .literal('created_at')
      .describe('The property by which to sort the results.')
      .default('created_at'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    owner: z
      .array(z.string())
      .max(10)
      .describe('A list of owner usernames to use to filter the results.')
      .optional(),
    repository: z
      .string()
      .describe('The name of the repository to use to filter the results.')
      .optional(),
    permission: z
      .string()
      .describe('The permission to use to filter the results.')
      .optional(),
    last_used_before: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    last_used_after: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    token_id: z
      .array(z.string())
      .max(50)
      .describe('The ID of the token')
      .optional()
  })
  export type OrgsListPatGrantRequestsParams = z.infer<
    typeof OrgsListPatGrantRequestsParamsSchema
  >

  export const OrgsListPatGrantRequestsResponseSchema = z.array(
    OrganizationProgrammaticAccessGrantRequestSchema
  )
  export type OrgsListPatGrantRequestsResponse = z.infer<
    typeof OrgsListPatGrantRequestsResponseSchema
  >

  export const OrgsReviewPatGrantRequestsInBulkParamsSchema = z.object({
    pat_request_ids: z
      .array(z.number().int())
      .min(1)
      .max(100)
      .describe(
        'Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.'
      )
      .optional(),
    action: z
      .enum(['approve', 'deny'])
      .describe('Action to apply to the requests.'),
    reason: z
      .string()
      .max(1024)
      .describe(
        'Reason for approving or denying the requests. Max 1024 characters.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsReviewPatGrantRequestsInBulkParams = z.infer<
    typeof OrgsReviewPatGrantRequestsInBulkParamsSchema
  >

  export type OrgsReviewPatGrantRequestsInBulkResponse = undefined

  export const OrgsReviewPatGrantRequestParamsSchema = z.object({
    action: z
      .enum(['approve', 'deny'])
      .describe('Action to apply to the request.'),
    reason: z
      .string()
      .max(1024)
      .describe(
        'Reason for approving or denying the request. Max 1024 characters.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    pat_request_id: z
      .number()
      .int()
      .describe(
        'Unique identifier of the request for access via fine-grained personal access token.'
      )
  })
  export type OrgsReviewPatGrantRequestParams = z.infer<
    typeof OrgsReviewPatGrantRequestParamsSchema
  >

  export type OrgsReviewPatGrantRequestResponse = undefined

  export const OrgsListPatGrantRequestRepositoriesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    pat_request_id: z
      .number()
      .int()
      .describe(
        'Unique identifier of the request for access via fine-grained personal access token.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListPatGrantRequestRepositoriesParams = z.infer<
    typeof OrgsListPatGrantRequestRepositoriesParamsSchema
  >

  export const OrgsListPatGrantRequestRepositoriesResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type OrgsListPatGrantRequestRepositoriesResponse = z.infer<
    typeof OrgsListPatGrantRequestRepositoriesResponseSchema
  >

  export const OrgsListPatGrantsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    sort: z
      .literal('created_at')
      .describe('The property by which to sort the results.')
      .default('created_at'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    owner: z
      .array(z.string())
      .max(10)
      .describe('A list of owner usernames to use to filter the results.')
      .optional(),
    repository: z
      .string()
      .describe('The name of the repository to use to filter the results.')
      .optional(),
    permission: z
      .string()
      .describe('The permission to use to filter the results.')
      .optional(),
    last_used_before: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    last_used_after: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    token_id: z
      .array(z.string())
      .max(50)
      .describe('The ID of the token')
      .optional()
  })
  export type OrgsListPatGrantsParams = z.infer<
    typeof OrgsListPatGrantsParamsSchema
  >

  export const OrgsListPatGrantsResponseSchema = z.array(
    OrganizationProgrammaticAccessGrantSchema
  )
  export type OrgsListPatGrantsResponse = z.infer<
    typeof OrgsListPatGrantsResponseSchema
  >

  export const OrgsUpdatePatAccessesParamsSchema = z.object({
    action: z
      .literal('revoke')
      .describe('Action to apply to the fine-grained personal access token.'),
    pat_ids: z
      .array(
        z
          .number()
          .int()
          .describe(
            'Unique identifier of the fine-grained personal access token.'
          )
      )
      .min(1)
      .max(100)
      .describe('The IDs of the fine-grained personal access tokens.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsUpdatePatAccessesParams = z.infer<
    typeof OrgsUpdatePatAccessesParamsSchema
  >

  export type OrgsUpdatePatAccessesResponse = undefined

  export const OrgsUpdatePatAccessParamsSchema = z.object({
    action: z
      .literal('revoke')
      .describe('Action to apply to the fine-grained personal access token.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    pat_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the fine-grained personal access token.'
      )
  })
  export type OrgsUpdatePatAccessParams = z.infer<
    typeof OrgsUpdatePatAccessParamsSchema
  >

  export type OrgsUpdatePatAccessResponse = undefined

  export const OrgsListPatGrantRepositoriesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    pat_id: z
      .number()
      .int()
      .describe('Unique identifier of the fine-grained personal access token.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListPatGrantRepositoriesParams = z.infer<
    typeof OrgsListPatGrantRepositoriesParamsSchema
  >

  export const OrgsListPatGrantRepositoriesResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type OrgsListPatGrantRepositoriesResponse = z.infer<
    typeof OrgsListPatGrantRepositoriesResponseSchema
  >

  export const PrivateRegistriesListOrgPrivateRegistriesParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type PrivateRegistriesListOrgPrivateRegistriesParams = z.infer<
    typeof PrivateRegistriesListOrgPrivateRegistriesParamsSchema
  >

  export const PrivateRegistriesListOrgPrivateRegistriesResponseSchema =
    z.object({
      total_count: z.number().int(),
      configurations: z.array(OrgPrivateRegistryConfigurationSchema)
    })
  export type PrivateRegistriesListOrgPrivateRegistriesResponse = z.infer<
    typeof PrivateRegistriesListOrgPrivateRegistriesResponseSchema
  >

  export const PrivateRegistriesCreateOrgPrivateRegistryParamsSchema = z.object(
    {
      registry_type: z
        .literal('maven_repository')
        .describe('The registry type.'),
      username: z
        .string()
        .describe(
          'The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.'
        )
        .optional(),
      encrypted_value: z
        .string()
        .regex(
          new RegExp(
            '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
          )
        )
        .describe(
          'The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.'
        ),
      key_id: z
        .string()
        .describe('The ID of the key you used to encrypt the secret.'),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.'
        ),
      selected_repository_ids: z
        .array(z.number().int())
        .describe(
          'An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.'
        )
        .optional(),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    }
  )
  export type PrivateRegistriesCreateOrgPrivateRegistryParams = z.infer<
    typeof PrivateRegistriesCreateOrgPrivateRegistryParamsSchema
  >

  export type PrivateRegistriesCreateOrgPrivateRegistryResponse = undefined

  export const PrivateRegistriesGetOrgPublicKeyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type PrivateRegistriesGetOrgPublicKeyParams = z.infer<
    typeof PrivateRegistriesGetOrgPublicKeyParamsSchema
  >

  export const PrivateRegistriesGetOrgPublicKeyResponseSchema = z.object({
    key_id: z.string().describe('The identifier for the key.'),
    key: z.string().describe('The Base64 encoded public key.')
  })
  export type PrivateRegistriesGetOrgPublicKeyResponse = z.infer<
    typeof PrivateRegistriesGetOrgPublicKeyResponseSchema
  >

  export const PrivateRegistriesGetOrgPrivateRegistryParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type PrivateRegistriesGetOrgPrivateRegistryParams = z.infer<
    typeof PrivateRegistriesGetOrgPrivateRegistryParamsSchema
  >

  export const PrivateRegistriesGetOrgPrivateRegistryResponseSchema =
    OrgPrivateRegistryConfigurationSchema
  export type PrivateRegistriesGetOrgPrivateRegistryResponse = z.infer<
    typeof PrivateRegistriesGetOrgPrivateRegistryResponseSchema
  >

  export const PrivateRegistriesDeleteOrgPrivateRegistryParamsSchema = z.object(
    {
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      secret_name: z.string().describe('The name of the secret.')
    }
  )
  export type PrivateRegistriesDeleteOrgPrivateRegistryParams = z.infer<
    typeof PrivateRegistriesDeleteOrgPrivateRegistryParamsSchema
  >

  export type PrivateRegistriesDeleteOrgPrivateRegistryResponse = undefined

  export const PrivateRegistriesUpdateOrgPrivateRegistryParamsSchema = z.object(
    {
      registry_type: z
        .literal('maven_repository')
        .describe('The registry type.')
        .optional(),
      username: z
        .string()
        .describe(
          'The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.'
        )
        .optional(),
      encrypted_value: z
        .string()
        .regex(
          new RegExp(
            '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
          )
        )
        .describe(
          'The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.'
        )
        .optional(),
      key_id: z
        .string()
        .describe('The ID of the key you used to encrypt the secret.')
        .optional(),
      visibility: z
        .enum(['all', 'private', 'selected'])
        .describe(
          'Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.'
        )
        .optional(),
      selected_repository_ids: z
        .array(z.number().int())
        .describe(
          'An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.'
        )
        .optional(),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      secret_name: z.string().describe('The name of the secret.')
    }
  )
  export type PrivateRegistriesUpdateOrgPrivateRegistryParams = z.infer<
    typeof PrivateRegistriesUpdateOrgPrivateRegistryParamsSchema
  >

  export type PrivateRegistriesUpdateOrgPrivateRegistryResponse = undefined

  export const ProjectsListForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the projects to return.')
      .default('open'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListForOrgParams = z.infer<
    typeof ProjectsListForOrgParamsSchema
  >

  export const ProjectsListForOrgResponseSchema = z.array(ProjectSchema)
  export type ProjectsListForOrgResponse = z.infer<
    typeof ProjectsListForOrgResponseSchema
  >

  export const ProjectsCreateForOrgParamsSchema = z.object({
    name: z.string().describe('The name of the project.'),
    body: z.string().describe('The description of the project.').optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ProjectsCreateForOrgParams = z.infer<
    typeof ProjectsCreateForOrgParamsSchema
  >

  export type ProjectsCreateForOrgResponse = undefined

  export const OrgsGetAllCustomPropertiesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsGetAllCustomPropertiesParams = z.infer<
    typeof OrgsGetAllCustomPropertiesParamsSchema
  >

  export const OrgsGetAllCustomPropertiesResponseSchema =
    z.array(CustomPropertySchema)
  export type OrgsGetAllCustomPropertiesResponse = z.infer<
    typeof OrgsGetAllCustomPropertiesResponseSchema
  >

  export const OrgsCreateOrUpdateCustomPropertiesParamsSchema = z.object({
    properties: z
      .array(CustomPropertySchema)
      .min(1)
      .max(100)
      .describe('The array of custom properties to create or update.'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsCreateOrUpdateCustomPropertiesParams = z.infer<
    typeof OrgsCreateOrUpdateCustomPropertiesParamsSchema
  >

  export const OrgsCreateOrUpdateCustomPropertiesResponseSchema =
    z.array(CustomPropertySchema)
  export type OrgsCreateOrUpdateCustomPropertiesResponse = z.infer<
    typeof OrgsCreateOrUpdateCustomPropertiesResponseSchema
  >

  export const OrgsGetCustomPropertyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    custom_property_name: z.string().describe('The custom property name')
  })
  export type OrgsGetCustomPropertyParams = z.infer<
    typeof OrgsGetCustomPropertyParamsSchema
  >

  export const OrgsGetCustomPropertyResponseSchema = CustomPropertySchema
  export type OrgsGetCustomPropertyResponse = z.infer<
    typeof OrgsGetCustomPropertyResponseSchema
  >

  export const OrgsCreateOrUpdateCustomPropertyParamsSchema = z
    .object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      custom_property_name: z.string().describe('The custom property name')
    })
    .merge(CustomPropertySetPayloadSchema)
  export type OrgsCreateOrUpdateCustomPropertyParams = z.infer<
    typeof OrgsCreateOrUpdateCustomPropertyParamsSchema
  >

  export const OrgsCreateOrUpdateCustomPropertyResponseSchema =
    CustomPropertySchema
  export type OrgsCreateOrUpdateCustomPropertyResponse = z.infer<
    typeof OrgsCreateOrUpdateCustomPropertyResponseSchema
  >

  export const OrgsRemoveCustomPropertyParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    custom_property_name: z.string().describe('The custom property name')
  })
  export type OrgsRemoveCustomPropertyParams = z.infer<
    typeof OrgsRemoveCustomPropertyParamsSchema
  >

  export type OrgsRemoveCustomPropertyResponse = undefined

  export const OrgsListCustomPropertiesValuesForReposParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    repository_query: z
      .string()
      .describe(
        'Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.'
      )
      .optional()
  })
  export type OrgsListCustomPropertiesValuesForReposParams = z.infer<
    typeof OrgsListCustomPropertiesValuesForReposParamsSchema
  >

  export const OrgsListCustomPropertiesValuesForReposResponseSchema = z.array(
    OrgRepoCustomPropertyValuesSchema
  )
  export type OrgsListCustomPropertiesValuesForReposResponse = z.infer<
    typeof OrgsListCustomPropertiesValuesForReposResponseSchema
  >

  export const OrgsCreateOrUpdateCustomPropertiesValuesForReposParamsSchema =
    z.object({
      repository_names: z
        .array(z.string())
        .min(1)
        .max(30)
        .describe(
          'The names of repositories that the custom property values will be applied to.'
        ),
      properties: z
        .array(CustomPropertyValueSchema)
        .describe(
          'List of custom property names and associated values to apply to the repositories.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type OrgsCreateOrUpdateCustomPropertiesValuesForReposParams = z.infer<
    typeof OrgsCreateOrUpdateCustomPropertiesValuesForReposParamsSchema
  >

  export type OrgsCreateOrUpdateCustomPropertiesValuesForReposResponse =
    undefined

  export const OrgsListPublicMembersParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListPublicMembersParams = z.infer<
    typeof OrgsListPublicMembersParamsSchema
  >

  export const OrgsListPublicMembersResponseSchema = z.array(SimpleUserSchema)
  export type OrgsListPublicMembersResponse = z.infer<
    typeof OrgsListPublicMembersResponseSchema
  >

  export const OrgsCheckPublicMembershipForUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type OrgsCheckPublicMembershipForUserParams = z.infer<
    typeof OrgsCheckPublicMembershipForUserParamsSchema
  >

  export type OrgsCheckPublicMembershipForUserResponse = undefined

  export const OrgsSetPublicMembershipForAuthenticatedUserParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      username: z.string().describe('The handle for the GitHub user account.')
    })
  export type OrgsSetPublicMembershipForAuthenticatedUserParams = z.infer<
    typeof OrgsSetPublicMembershipForAuthenticatedUserParamsSchema
  >

  export type OrgsSetPublicMembershipForAuthenticatedUserResponse = undefined

  export const OrgsRemovePublicMembershipForAuthenticatedUserParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      username: z.string().describe('The handle for the GitHub user account.')
    })
  export type OrgsRemovePublicMembershipForAuthenticatedUserParams = z.infer<
    typeof OrgsRemovePublicMembershipForAuthenticatedUserParamsSchema
  >

  export type OrgsRemovePublicMembershipForAuthenticatedUserResponse = undefined

  export const ReposListForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    type: z
      .enum(['all', 'public', 'private', 'forks', 'sources', 'member'])
      .describe('Specifies the types of repositories you want returned.')
      .default('all'),
    sort: z
      .enum(['created', 'updated', 'pushed', 'full_name'])
      .describe('The property to sort the results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListForOrgParams = z.infer<
    typeof ReposListForOrgParamsSchema
  >

  export const ReposListForOrgResponseSchema = z.array(MinimalRepositorySchema)
  export type ReposListForOrgResponse = z.infer<
    typeof ReposListForOrgResponseSchema
  >

  export const ReposCreateInOrgParamsSchema = z.object({
    name: z.string().describe('The name of the repository.'),
    description: z
      .string()
      .describe('A short description of the repository.')
      .optional(),
    homepage: z
      .string()
      .describe('A URL with more information about the repository.')
      .optional(),
    private: z
      .boolean()
      .describe('Whether the repository is private.')
      .default(false),
    visibility: z
      .enum(['public', 'private'])
      .describe('The visibility of the repository.')
      .optional(),
    has_issues: z
      .boolean()
      .describe(
        'Either `true` to enable issues for this repository or `false` to disable them.'
      )
      .default(true),
    has_projects: z
      .boolean()
      .describe(
        "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error."
      )
      .default(true),
    has_wiki: z
      .boolean()
      .describe(
        'Either `true` to enable the wiki for this repository or `false` to disable it.'
      )
      .default(true),
    has_downloads: z
      .boolean()
      .describe('Whether downloads are enabled.')
      .default(true),
    is_template: z
      .boolean()
      .describe(
        'Either `true` to make this repo available as a template repository or `false` to prevent it.'
      )
      .default(false),
    team_id: z
      .number()
      .int()
      .describe(
        'The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.'
      )
      .optional(),
    auto_init: z
      .boolean()
      .describe('Pass `true` to create an initial commit with empty README.')
      .default(false),
    gitignore_template: z
      .string()
      .describe(
        'Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell".'
      )
      .optional(),
    license_template: z
      .string()
      .describe(
        'Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0".'
      )
      .optional(),
    allow_squash_merge: z
      .boolean()
      .describe(
        'Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.'
      )
      .default(true),
    allow_merge_commit: z
      .boolean()
      .describe(
        'Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.'
      )
      .default(true),
    allow_rebase_merge: z
      .boolean()
      .describe(
        'Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.'
      )
      .default(true),
    allow_auto_merge: z
      .boolean()
      .describe(
        'Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.'
      )
      .default(false),
    delete_branch_on_merge: z
      .boolean()
      .describe(
        'Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**'
      )
      .default(false),
    use_squash_pr_title_as_default: z
      .boolean()
      .describe(
        'Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.'
      )
      .default(false),
    squash_merge_commit_title: z
      .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
      .describe(
        "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
      )
      .optional(),
    squash_merge_commit_message: z
      .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
      .describe(
        "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    merge_commit_title: z
      .enum(['PR_TITLE', 'MERGE_MESSAGE'])
      .describe(
        "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
      )
      .optional(),
    merge_commit_message: z
      .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
      .describe(
        "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    custom_properties: z
      .record(z.any())
      .describe(
        'The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ReposCreateInOrgParams = z.infer<
    typeof ReposCreateInOrgParamsSchema
  >

  export type ReposCreateInOrgResponse = undefined

  export const ReposGetOrgRulesetsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    targets: z
      .string()
      .describe(
        'A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n'
      )
      .optional()
  })
  export type ReposGetOrgRulesetsParams = z.infer<
    typeof ReposGetOrgRulesetsParamsSchema
  >

  export const ReposGetOrgRulesetsResponseSchema = z.array(
    RepositoryRulesetSchema
  )
  export type ReposGetOrgRulesetsResponse = z.infer<
    typeof ReposGetOrgRulesetsResponseSchema
  >

  export const ReposCreateOrgRulesetParamsSchema = z.object({
    name: z.string().describe('The name of the ruleset.'),
    target: z
      .enum(['branch', 'tag', 'push', 'repository'])
      .describe('The target of the ruleset')
      .default('branch'),
    enforcement: RepositoryRuleEnforcementSchema,
    bypass_actors: z
      .array(RepositoryRulesetBypassActorSchema)
      .describe('The actors that can bypass the rules in this ruleset')
      .optional(),
    conditions: OrgRulesetConditionsSchema.optional(),
    rules: z
      .array(RepositoryRuleSchema)
      .describe('An array of rules within the ruleset.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type ReposCreateOrgRulesetParams = z.infer<
    typeof ReposCreateOrgRulesetParamsSchema
  >

  export type ReposCreateOrgRulesetResponse = undefined

  export const ReposGetOrgRuleSuitesParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ref: z
      .string()
      .describe(
        'The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.'
      )
      .optional(),
    repository_name: z
      .string()
      .describe('The name of the repository to filter on.')
      .optional(),
    time_period: z
      .enum(['hour', 'day', 'week', 'month'])
      .describe(
        'The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).'
      )
      .default('day'),
    actor_name: z
      .string()
      .describe(
        'The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.'
      )
      .optional(),
    rule_suite_result: z
      .enum(['pass', 'fail', 'bypass', 'all'])
      .describe(
        'The rule results to filter on. When specified, only suites with this result will be returned.'
      )
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetOrgRuleSuitesParams = z.infer<
    typeof ReposGetOrgRuleSuitesParamsSchema
  >

  export const ReposGetOrgRuleSuitesResponseSchema = RuleSuitesSchema
  export type ReposGetOrgRuleSuitesResponse = z.infer<
    typeof ReposGetOrgRuleSuitesResponseSchema
  >

  export const ReposGetOrgRuleSuiteParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    rule_suite_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.'
      )
  })
  export type ReposGetOrgRuleSuiteParams = z.infer<
    typeof ReposGetOrgRuleSuiteParamsSchema
  >

  export const ReposGetOrgRuleSuiteResponseSchema = RuleSuiteSchema
  export type ReposGetOrgRuleSuiteResponse = z.infer<
    typeof ReposGetOrgRuleSuiteResponseSchema
  >

  export const ReposGetOrgRulesetParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ruleset_id: z.number().int().describe('The ID of the ruleset.')
  })
  export type ReposGetOrgRulesetParams = z.infer<
    typeof ReposGetOrgRulesetParamsSchema
  >

  export const ReposGetOrgRulesetResponseSchema = RepositoryRulesetSchema
  export type ReposGetOrgRulesetResponse = z.infer<
    typeof ReposGetOrgRulesetResponseSchema
  >

  export const ReposUpdateOrgRulesetParamsSchema = z.object({
    name: z.string().describe('The name of the ruleset.').optional(),
    target: z
      .enum(['branch', 'tag', 'push', 'repository'])
      .describe('The target of the ruleset')
      .optional(),
    enforcement: RepositoryRuleEnforcementSchema.optional(),
    bypass_actors: z
      .array(RepositoryRulesetBypassActorSchema)
      .describe('The actors that can bypass the rules in this ruleset')
      .optional(),
    conditions: OrgRulesetConditionsSchema.optional(),
    rules: z
      .array(RepositoryRuleSchema)
      .describe('An array of rules within the ruleset.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ruleset_id: z.number().int().describe('The ID of the ruleset.')
  })
  export type ReposUpdateOrgRulesetParams = z.infer<
    typeof ReposUpdateOrgRulesetParamsSchema
  >

  export const ReposUpdateOrgRulesetResponseSchema = RepositoryRulesetSchema
  export type ReposUpdateOrgRulesetResponse = z.infer<
    typeof ReposUpdateOrgRulesetResponseSchema
  >

  export const ReposDeleteOrgRulesetParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ruleset_id: z.number().int().describe('The ID of the ruleset.')
  })
  export type ReposDeleteOrgRulesetParams = z.infer<
    typeof ReposDeleteOrgRulesetParamsSchema
  >

  export type ReposDeleteOrgRulesetResponse = undefined

  export const OrgsGetOrgRulesetHistoryParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ruleset_id: z.number().int().describe('The ID of the ruleset.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsGetOrgRulesetHistoryParams = z.infer<
    typeof OrgsGetOrgRulesetHistoryParamsSchema
  >

  export const OrgsGetOrgRulesetHistoryResponseSchema =
    z.array(RulesetVersionSchema)
  export type OrgsGetOrgRulesetHistoryResponse = z.infer<
    typeof OrgsGetOrgRulesetHistoryResponseSchema
  >

  export const OrgsGetOrgRulesetVersionParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    ruleset_id: z.number().int().describe('The ID of the ruleset.'),
    version_id: z.number().int().describe('The ID of the version')
  })
  export type OrgsGetOrgRulesetVersionParams = z.infer<
    typeof OrgsGetOrgRulesetVersionParamsSchema
  >

  export const OrgsGetOrgRulesetVersionResponseSchema =
    RulesetVersionWithStateSchema
  export type OrgsGetOrgRulesetVersionResponse = z.infer<
    typeof OrgsGetOrgRulesetVersionResponseSchema
  >

  export const SecretScanningListAlertsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    state: z
      .enum(['open', 'resolved'])
      .describe(
        'Set to `open` or `resolved` to only list secret scanning alerts in a specific state.'
      )
      .optional(),
    secret_type: z
      .string()
      .describe(
        'A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.'
      )
      .optional(),
    resolution: z
      .string()
      .describe(
        'A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated'])
      .describe(
        'The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.'
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.  To receive an initial cursor on your first request, include an empty "after" query string.'
      )
      .optional(),
    validity: z
      .string()
      .describe(
        'A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.'
      )
      .optional(),
    is_publicly_leaked: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.'
      )
      .default(false),
    is_multi_repo: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.'
      )
      .default(false)
  })
  export type SecretScanningListAlertsForOrgParams = z.infer<
    typeof SecretScanningListAlertsForOrgParamsSchema
  >

  export const SecretScanningListAlertsForOrgResponseSchema = z.array(
    OrganizationSecretScanningAlertSchema
  )
  export type SecretScanningListAlertsForOrgResponse = z.infer<
    typeof SecretScanningListAlertsForOrgResponseSchema
  >

  export const SecurityAdvisoriesListOrgRepositoryAdvisoriesParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      direction: z
        .enum(['asc', 'desc'])
        .describe('The direction to sort the results by.')
        .default('desc'),
      sort: z
        .enum(['created', 'updated', 'published'])
        .describe('The property to sort the results by.')
        .default('created'),
      before: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      after: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      per_page: z
        .number()
        .int()
        .gte(1)
        .lte(100)
        .describe(
          'The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      state: z
        .enum(['triage', 'draft', 'published', 'closed'])
        .describe(
          'Filter by the state of the repository advisories. Only advisories of this state will be returned.'
        )
        .optional()
    })
  export type SecurityAdvisoriesListOrgRepositoryAdvisoriesParams = z.infer<
    typeof SecurityAdvisoriesListOrgRepositoryAdvisoriesParamsSchema
  >

  export const SecurityAdvisoriesListOrgRepositoryAdvisoriesResponseSchema =
    z.array(RepositoryAdvisorySchema)
  export type SecurityAdvisoriesListOrgRepositoryAdvisoriesResponse = z.infer<
    typeof SecurityAdvisoriesListOrgRepositoryAdvisoriesResponseSchema
  >

  export const OrgsListSecurityManagerTeamsParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsListSecurityManagerTeamsParams = z.infer<
    typeof OrgsListSecurityManagerTeamsParamsSchema
  >

  export const OrgsListSecurityManagerTeamsResponseSchema =
    z.array(TeamSimpleSchema)
  export type OrgsListSecurityManagerTeamsResponse = z.infer<
    typeof OrgsListSecurityManagerTeamsResponseSchema
  >

  export const OrgsAddSecurityManagerTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type OrgsAddSecurityManagerTeamParams = z.infer<
    typeof OrgsAddSecurityManagerTeamParamsSchema
  >

  export type OrgsAddSecurityManagerTeamResponse = undefined

  export const OrgsRemoveSecurityManagerTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type OrgsRemoveSecurityManagerTeamParams = z.infer<
    typeof OrgsRemoveSecurityManagerTeamParamsSchema
  >

  export type OrgsRemoveSecurityManagerTeamResponse = undefined

  export const BillingGetGithubActionsBillingOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type BillingGetGithubActionsBillingOrgParams = z.infer<
    typeof BillingGetGithubActionsBillingOrgParamsSchema
  >

  export const BillingGetGithubActionsBillingOrgResponseSchema =
    ActionsBillingUsageSchema
  export type BillingGetGithubActionsBillingOrgResponse = z.infer<
    typeof BillingGetGithubActionsBillingOrgResponseSchema
  >

  export const BillingGetGithubPackagesBillingOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type BillingGetGithubPackagesBillingOrgParams = z.infer<
    typeof BillingGetGithubPackagesBillingOrgParamsSchema
  >

  export const BillingGetGithubPackagesBillingOrgResponseSchema =
    PackagesBillingUsageSchema
  export type BillingGetGithubPackagesBillingOrgResponse = z.infer<
    typeof BillingGetGithubPackagesBillingOrgResponseSchema
  >

  export const BillingGetSharedStorageBillingOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type BillingGetSharedStorageBillingOrgParams = z.infer<
    typeof BillingGetSharedStorageBillingOrgParamsSchema
  >

  export const BillingGetSharedStorageBillingOrgResponseSchema =
    CombinedBillingUsageSchema
  export type BillingGetSharedStorageBillingOrgResponse = z.infer<
    typeof BillingGetSharedStorageBillingOrgResponseSchema
  >

  export const HostedComputeListNetworkConfigurationsForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type HostedComputeListNetworkConfigurationsForOrgParams = z.infer<
    typeof HostedComputeListNetworkConfigurationsForOrgParamsSchema
  >

  export const HostedComputeListNetworkConfigurationsForOrgResponseSchema =
    z.object({
      total_count: z.number().int(),
      network_configurations: z.array(NetworkConfigurationSchema)
    })
  export type HostedComputeListNetworkConfigurationsForOrgResponse = z.infer<
    typeof HostedComputeListNetworkConfigurationsForOrgResponseSchema
  >

  export const HostedComputeCreateNetworkConfigurationForOrgParamsSchema =
    z.object({
      name: z
        .string()
        .describe(
          "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
        ),
      compute_service: z
        .enum(['none', 'actions'])
        .describe(
          'The hosted compute service to use for the network configuration.'
        )
        .optional(),
      network_settings_ids: z
        .array(z.string())
        .min(1)
        .max(1)
        .describe(
          'The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.')
    })
  export type HostedComputeCreateNetworkConfigurationForOrgParams = z.infer<
    typeof HostedComputeCreateNetworkConfigurationForOrgParamsSchema
  >

  export type HostedComputeCreateNetworkConfigurationForOrgResponse = undefined

  export const HostedComputeGetNetworkConfigurationForOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      network_configuration_id: z
        .string()
        .describe(
          'Unique identifier of the hosted compute network configuration.'
        )
    })
  export type HostedComputeGetNetworkConfigurationForOrgParams = z.infer<
    typeof HostedComputeGetNetworkConfigurationForOrgParamsSchema
  >

  export const HostedComputeGetNetworkConfigurationForOrgResponseSchema =
    NetworkConfigurationSchema
  export type HostedComputeGetNetworkConfigurationForOrgResponse = z.infer<
    typeof HostedComputeGetNetworkConfigurationForOrgResponseSchema
  >

  export const HostedComputeDeleteNetworkConfigurationFromOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      network_configuration_id: z
        .string()
        .describe(
          'Unique identifier of the hosted compute network configuration.'
        )
    })
  export type HostedComputeDeleteNetworkConfigurationFromOrgParams = z.infer<
    typeof HostedComputeDeleteNetworkConfigurationFromOrgParamsSchema
  >

  export type HostedComputeDeleteNetworkConfigurationFromOrgResponse = undefined

  export const HostedComputeUpdateNetworkConfigurationForOrgParamsSchema =
    z.object({
      name: z
        .string()
        .describe(
          "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'."
        )
        .optional(),
      compute_service: z
        .enum(['none', 'actions'])
        .describe(
          'The hosted compute service to use for the network configuration.'
        )
        .optional(),
      network_settings_ids: z
        .array(z.string())
        .min(0)
        .max(1)
        .describe(
          'The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.'
        )
        .optional(),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      network_configuration_id: z
        .string()
        .describe(
          'Unique identifier of the hosted compute network configuration.'
        )
    })
  export type HostedComputeUpdateNetworkConfigurationForOrgParams = z.infer<
    typeof HostedComputeUpdateNetworkConfigurationForOrgParamsSchema
  >

  export const HostedComputeUpdateNetworkConfigurationForOrgResponseSchema =
    NetworkConfigurationSchema
  export type HostedComputeUpdateNetworkConfigurationForOrgResponse = z.infer<
    typeof HostedComputeUpdateNetworkConfigurationForOrgResponseSchema
  >

  export const HostedComputeGetNetworkSettingsForOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    network_settings_id: z
      .string()
      .describe('Unique identifier of the hosted compute network settings.')
  })
  export type HostedComputeGetNetworkSettingsForOrgParams = z.infer<
    typeof HostedComputeGetNetworkSettingsForOrgParamsSchema
  >

  export const HostedComputeGetNetworkSettingsForOrgResponseSchema =
    NetworkSettingsSchema
  export type HostedComputeGetNetworkSettingsForOrgResponse = z.infer<
    typeof HostedComputeGetNetworkSettingsForOrgResponseSchema
  >

  export const CopilotCopilotMetricsForTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    since: z
      .string()
      .describe(
        'Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.'
      )
      .optional(),
    until: z
      .string()
      .describe(
        'Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(28)
  })
  export type CopilotCopilotMetricsForTeamParams = z.infer<
    typeof CopilotCopilotMetricsForTeamParamsSchema
  >

  export const CopilotCopilotMetricsForTeamResponseSchema = z.array(
    CopilotUsageMetricsDaySchema
  )
  export type CopilotCopilotMetricsForTeamResponse = z.infer<
    typeof CopilotCopilotMetricsForTeamResponseSchema
  >

  export const CopilotUsageMetricsForTeamParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    since: z
      .string()
      .describe(
        'Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.'
      )
      .optional(),
    until: z
      .string()
      .describe(
        'Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(28)
  })
  export type CopilotUsageMetricsForTeamParams = z.infer<
    typeof CopilotUsageMetricsForTeamParamsSchema
  >

  export const CopilotUsageMetricsForTeamResponseSchema = z.array(
    CopilotUsageMetricsSchema
  )
  export type CopilotUsageMetricsForTeamResponse = z.infer<
    typeof CopilotUsageMetricsForTeamResponseSchema
  >

  export const TeamsListParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListParams = z.infer<typeof TeamsListParamsSchema>

  export const TeamsListResponseSchema = z.array(TeamSchema)
  export type TeamsListResponse = z.infer<typeof TeamsListResponseSchema>

  export const TeamsCreateParamsSchema = z.object({
    name: z.string().describe('The name of the team.'),
    description: z.string().describe('The description of the team.').optional(),
    maintainers: z
      .array(z.string())
      .describe(
        'List GitHub IDs for organization members who will become team maintainers.'
      )
      .optional(),
    repo_names: z
      .array(z.string())
      .describe(
        'The full name (e.g., "organization-name/repository-name") of repositories to add the team to.'
      )
      .optional(),
    privacy: z
      .enum(['secret', 'closed'])
      .describe(
        'The level of privacy this team should have. The options are:  \n**For a non-nested team:**  \n * `secret` - only visible to organization owners and members of this team.  \n * `closed` - visible to all members of this organization.  \nDefault: `secret`  \n**For a parent or child team:**  \n * `closed` - visible to all members of this organization.  \nDefault for child team: `closed`'
      )
      .optional(),
    notification_setting: z
      .enum(['notifications_enabled', 'notifications_disabled'])
      .describe(
        'The notification setting the team has chosen. The options are:  \n * `notifications_enabled` - team members receive notifications when the team is @mentioned.  \n * `notifications_disabled` - no one receives notifications.  \nDefault: `notifications_enabled`'
      )
      .optional(),
    permission: z
      .enum(['pull', 'push'])
      .describe(
        '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.'
      )
      .default('pull'),
    parent_team_id: z
      .number()
      .int()
      .describe('The ID of a team to set as the parent team.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type TeamsCreateParams = z.infer<typeof TeamsCreateParamsSchema>

  export type TeamsCreateResponse = undefined

  export const TeamsGetByNameParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type TeamsGetByNameParams = z.infer<typeof TeamsGetByNameParamsSchema>

  export const TeamsGetByNameResponseSchema = TeamFullSchema
  export type TeamsGetByNameResponse = z.infer<
    typeof TeamsGetByNameResponseSchema
  >

  export const TeamsDeleteInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type TeamsDeleteInOrgParams = z.infer<
    typeof TeamsDeleteInOrgParamsSchema
  >

  export type TeamsDeleteInOrgResponse = undefined

  export const TeamsUpdateInOrgParamsSchema = z.object({
    name: z.string().describe('The name of the team.').optional(),
    description: z.string().describe('The description of the team.').optional(),
    privacy: z
      .enum(['secret', 'closed'])
      .describe(
        'The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are:  \n**For a non-nested team:**  \n * `secret` - only visible to organization owners and members of this team.  \n * `closed` - visible to all members of this organization.  \n**For a parent or child team:**  \n * `closed` - visible to all members of this organization.'
      )
      .optional(),
    notification_setting: z
      .enum(['notifications_enabled', 'notifications_disabled'])
      .describe(
        'The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned.  \n * `notifications_disabled` - no one receives notifications.'
      )
      .optional(),
    permission: z
      .enum(['pull', 'push', 'admin'])
      .describe(
        '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.'
      )
      .default('pull'),
    parent_team_id: z
      .number()
      .int()
      .describe('The ID of a team to set as the parent team.')
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type TeamsUpdateInOrgParams = z.infer<
    typeof TeamsUpdateInOrgParamsSchema
  >

  export const TeamsUpdateInOrgResponseSchema = TeamFullSchema
  export type TeamsUpdateInOrgResponse = z.infer<
    typeof TeamsUpdateInOrgResponseSchema
  >

  export const TeamsListDiscussionsInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    pinned: z.string().describe('Pinned discussions only filter').optional()
  })
  export type TeamsListDiscussionsInOrgParams = z.infer<
    typeof TeamsListDiscussionsInOrgParamsSchema
  >

  export const TeamsListDiscussionsInOrgResponseSchema =
    z.array(TeamDiscussionSchema)
  export type TeamsListDiscussionsInOrgResponse = z.infer<
    typeof TeamsListDiscussionsInOrgResponseSchema
  >

  export const TeamsCreateDiscussionInOrgParamsSchema = z.object({
    title: z.string().describe("The discussion post's title."),
    body: z.string().describe("The discussion post's body text."),
    private: z
      .boolean()
      .describe(
        'Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.'
      )
      .default(false),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.')
  })
  export type TeamsCreateDiscussionInOrgParams = z.infer<
    typeof TeamsCreateDiscussionInOrgParamsSchema
  >

  export type TeamsCreateDiscussionInOrgResponse = undefined

  export const TeamsGetDiscussionInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsGetDiscussionInOrgParams = z.infer<
    typeof TeamsGetDiscussionInOrgParamsSchema
  >

  export const TeamsGetDiscussionInOrgResponseSchema = TeamDiscussionSchema
  export type TeamsGetDiscussionInOrgResponse = z.infer<
    typeof TeamsGetDiscussionInOrgResponseSchema
  >

  export const TeamsDeleteDiscussionInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsDeleteDiscussionInOrgParams = z.infer<
    typeof TeamsDeleteDiscussionInOrgParamsSchema
  >

  export type TeamsDeleteDiscussionInOrgResponse = undefined

  export const TeamsUpdateDiscussionInOrgParamsSchema = z.object({
    title: z.string().describe("The discussion post's title.").optional(),
    body: z.string().describe("The discussion post's body text.").optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsUpdateDiscussionInOrgParams = z.infer<
    typeof TeamsUpdateDiscussionInOrgParamsSchema
  >

  export const TeamsUpdateDiscussionInOrgResponseSchema = TeamDiscussionSchema
  export type TeamsUpdateDiscussionInOrgResponse = z.infer<
    typeof TeamsUpdateDiscussionInOrgResponseSchema
  >

  export const TeamsListDiscussionCommentsInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListDiscussionCommentsInOrgParams = z.infer<
    typeof TeamsListDiscussionCommentsInOrgParamsSchema
  >

  export const TeamsListDiscussionCommentsInOrgResponseSchema = z.array(
    TeamDiscussionCommentSchema
  )
  export type TeamsListDiscussionCommentsInOrgResponse = z.infer<
    typeof TeamsListDiscussionCommentsInOrgResponseSchema
  >

  export const TeamsCreateDiscussionCommentInOrgParamsSchema = z.object({
    body: z.string().describe("The discussion comment's body text."),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsCreateDiscussionCommentInOrgParams = z.infer<
    typeof TeamsCreateDiscussionCommentInOrgParamsSchema
  >

  export type TeamsCreateDiscussionCommentInOrgResponse = undefined

  export const TeamsGetDiscussionCommentInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsGetDiscussionCommentInOrgParams = z.infer<
    typeof TeamsGetDiscussionCommentInOrgParamsSchema
  >

  export const TeamsGetDiscussionCommentInOrgResponseSchema =
    TeamDiscussionCommentSchema
  export type TeamsGetDiscussionCommentInOrgResponse = z.infer<
    typeof TeamsGetDiscussionCommentInOrgResponseSchema
  >

  export const TeamsDeleteDiscussionCommentInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsDeleteDiscussionCommentInOrgParams = z.infer<
    typeof TeamsDeleteDiscussionCommentInOrgParamsSchema
  >

  export type TeamsDeleteDiscussionCommentInOrgResponse = undefined

  export const TeamsUpdateDiscussionCommentInOrgParamsSchema = z.object({
    body: z.string().describe("The discussion comment's body text."),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsUpdateDiscussionCommentInOrgParams = z.infer<
    typeof TeamsUpdateDiscussionCommentInOrgParamsSchema
  >

  export const TeamsUpdateDiscussionCommentInOrgResponseSchema =
    TeamDiscussionCommentSchema
  export type TeamsUpdateDiscussionCommentInOrgResponse = z.infer<
    typeof TeamsUpdateDiscussionCommentInOrgResponseSchema
  >

  export const ReactionsListForTeamDiscussionCommentInOrgParamsSchema =
    z.object({
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      team_slug: z.string().describe('The slug of the team name.'),
      discussion_number: z
        .number()
        .int()
        .describe('The number that identifies the discussion.'),
      comment_number: z
        .number()
        .int()
        .describe('The number that identifies the comment.'),
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe(
          'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.'
        )
        .optional(),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ReactionsListForTeamDiscussionCommentInOrgParams = z.infer<
    typeof ReactionsListForTeamDiscussionCommentInOrgParamsSchema
  >

  export const ReactionsListForTeamDiscussionCommentInOrgResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForTeamDiscussionCommentInOrgResponse = z.infer<
    typeof ReactionsListForTeamDiscussionCommentInOrgResponseSchema
  >

  export const ReactionsCreateForTeamDiscussionCommentInOrgParamsSchema =
    z.object({
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe(
          'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.'
        ),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      team_slug: z.string().describe('The slug of the team name.'),
      discussion_number: z
        .number()
        .int()
        .describe('The number that identifies the discussion.'),
      comment_number: z
        .number()
        .int()
        .describe('The number that identifies the comment.')
    })
  export type ReactionsCreateForTeamDiscussionCommentInOrgParams = z.infer<
    typeof ReactionsCreateForTeamDiscussionCommentInOrgParamsSchema
  >

  export const ReactionsCreateForTeamDiscussionCommentInOrgResponseSchema =
    ReactionSchema
  export type ReactionsCreateForTeamDiscussionCommentInOrgResponse = z.infer<
    typeof ReactionsCreateForTeamDiscussionCommentInOrgResponseSchema
  >

  export const ReactionsDeleteForTeamDiscussionCommentParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForTeamDiscussionCommentParams = z.infer<
    typeof ReactionsDeleteForTeamDiscussionCommentParamsSchema
  >

  export type ReactionsDeleteForTeamDiscussionCommentResponse = undefined

  export const ReactionsListForTeamDiscussionInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForTeamDiscussionInOrgParams = z.infer<
    typeof ReactionsListForTeamDiscussionInOrgParamsSchema
  >

  export const ReactionsListForTeamDiscussionInOrgResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForTeamDiscussionInOrgResponse = z.infer<
    typeof ReactionsListForTeamDiscussionInOrgResponseSchema
  >

  export const ReactionsCreateForTeamDiscussionInOrgParamsSchema = z.object({
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type ReactionsCreateForTeamDiscussionInOrgParams = z.infer<
    typeof ReactionsCreateForTeamDiscussionInOrgParamsSchema
  >

  export const ReactionsCreateForTeamDiscussionInOrgResponseSchema =
    ReactionSchema
  export type ReactionsCreateForTeamDiscussionInOrgResponse = z.infer<
    typeof ReactionsCreateForTeamDiscussionInOrgResponseSchema
  >

  export const ReactionsDeleteForTeamDiscussionParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForTeamDiscussionParams = z.infer<
    typeof ReactionsDeleteForTeamDiscussionParamsSchema
  >

  export type ReactionsDeleteForTeamDiscussionResponse = undefined

  export const TeamsListPendingInvitationsInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListPendingInvitationsInOrgParams = z.infer<
    typeof TeamsListPendingInvitationsInOrgParamsSchema
  >

  export const TeamsListPendingInvitationsInOrgResponseSchema = z.array(
    OrganizationInvitationSchema
  )
  export type TeamsListPendingInvitationsInOrgResponse = z.infer<
    typeof TeamsListPendingInvitationsInOrgResponseSchema
  >

  export const TeamsListMembersInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    role: z
      .enum(['member', 'maintainer', 'all'])
      .describe('Filters members returned by their role in the team.')
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListMembersInOrgParams = z.infer<
    typeof TeamsListMembersInOrgParamsSchema
  >

  export const TeamsListMembersInOrgResponseSchema = z.array(SimpleUserSchema)
  export type TeamsListMembersInOrgResponse = z.infer<
    typeof TeamsListMembersInOrgResponseSchema
  >

  export const TeamsGetMembershipForUserInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsGetMembershipForUserInOrgParams = z.infer<
    typeof TeamsGetMembershipForUserInOrgParamsSchema
  >

  export const TeamsGetMembershipForUserInOrgResponseSchema =
    TeamMembershipSchema
  export type TeamsGetMembershipForUserInOrgResponse = z.infer<
    typeof TeamsGetMembershipForUserInOrgResponseSchema
  >

  export const TeamsAddOrUpdateMembershipForUserInOrgParamsSchema = z.object({
    role: z
      .enum(['member', 'maintainer'])
      .describe('The role that this user should have in the team.')
      .default('member'),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsAddOrUpdateMembershipForUserInOrgParams = z.infer<
    typeof TeamsAddOrUpdateMembershipForUserInOrgParamsSchema
  >

  export const TeamsAddOrUpdateMembershipForUserInOrgResponseSchema =
    TeamMembershipSchema
  export type TeamsAddOrUpdateMembershipForUserInOrgResponse = z.infer<
    typeof TeamsAddOrUpdateMembershipForUserInOrgResponseSchema
  >

  export const TeamsRemoveMembershipForUserInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsRemoveMembershipForUserInOrgParams = z.infer<
    typeof TeamsRemoveMembershipForUserInOrgParamsSchema
  >

  export type TeamsRemoveMembershipForUserInOrgResponse = undefined

  export const TeamsListProjectsInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListProjectsInOrgParams = z.infer<
    typeof TeamsListProjectsInOrgParamsSchema
  >

  export const TeamsListProjectsInOrgResponseSchema = z.array(TeamProjectSchema)
  export type TeamsListProjectsInOrgResponse = z.infer<
    typeof TeamsListProjectsInOrgResponseSchema
  >

  export const TeamsCheckPermissionsForProjectInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsCheckPermissionsForProjectInOrgParams = z.infer<
    typeof TeamsCheckPermissionsForProjectInOrgParamsSchema
  >

  export const TeamsCheckPermissionsForProjectInOrgResponseSchema =
    TeamProjectSchema
  export type TeamsCheckPermissionsForProjectInOrgResponse = z.infer<
    typeof TeamsCheckPermissionsForProjectInOrgResponseSchema
  >

  export const TeamsAddOrUpdateProjectPermissionsInOrgParamsSchema = z.object({
    permission: z
      .enum(['read', 'write', 'admin'])
      .describe(
        'The permission to grant to the team for this project. Default: the team\'s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you\'ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."'
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsAddOrUpdateProjectPermissionsInOrgParams = z.infer<
    typeof TeamsAddOrUpdateProjectPermissionsInOrgParamsSchema
  >

  export type TeamsAddOrUpdateProjectPermissionsInOrgResponse = undefined

  export const TeamsRemoveProjectInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsRemoveProjectInOrgParams = z.infer<
    typeof TeamsRemoveProjectInOrgParamsSchema
  >

  export type TeamsRemoveProjectInOrgResponse = undefined

  export const TeamsListReposInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListReposInOrgParams = z.infer<
    typeof TeamsListReposInOrgParamsSchema
  >

  export const TeamsListReposInOrgResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type TeamsListReposInOrgResponse = z.infer<
    typeof TeamsListReposInOrgResponseSchema
  >

  export const TeamsCheckPermissionsForRepoInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsCheckPermissionsForRepoInOrgParams = z.infer<
    typeof TeamsCheckPermissionsForRepoInOrgParamsSchema
  >

  export const TeamsCheckPermissionsForRepoInOrgResponseSchema =
    TeamRepositorySchema
  export type TeamsCheckPermissionsForRepoInOrgResponse = z.infer<
    typeof TeamsCheckPermissionsForRepoInOrgResponseSchema
  >

  export const TeamsAddOrUpdateRepoPermissionsInOrgParamsSchema = z.object({
    permission: z
      .string()
      .describe(
        "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
      )
      .optional(),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsAddOrUpdateRepoPermissionsInOrgParams = z.infer<
    typeof TeamsAddOrUpdateRepoPermissionsInOrgParamsSchema
  >

  export type TeamsAddOrUpdateRepoPermissionsInOrgResponse = undefined

  export const TeamsRemoveRepoInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsRemoveRepoInOrgParams = z.infer<
    typeof TeamsRemoveRepoInOrgParamsSchema
  >

  export type TeamsRemoveRepoInOrgResponse = undefined

  export const TeamsListChildInOrgParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.'),
    team_slug: z.string().describe('The slug of the team name.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListChildInOrgParams = z.infer<
    typeof TeamsListChildInOrgParamsSchema
  >

  export const TeamsListChildInOrgResponseSchema = z.array(TeamSchema)
  export type TeamsListChildInOrgResponse = z.infer<
    typeof TeamsListChildInOrgResponseSchema
  >

  export const OrgsEnableOrDisableSecurityProductOnAllOrgReposParamsSchema =
    z.object({
      query_suite: z
        .enum(['default', 'extended'])
        .describe(
          "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied."
        )
        .optional(),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      security_product: z
        .enum([
          'dependency_graph',
          'dependabot_alerts',
          'dependabot_security_updates',
          'advanced_security',
          'code_scanning_default_setup',
          'secret_scanning',
          'secret_scanning_push_protection'
        ])
        .describe('The security feature to enable or disable.'),
      enablement: z
        .enum(['enable_all', 'disable_all'])
        .describe(
          'The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.'
        )
    })
  export type OrgsEnableOrDisableSecurityProductOnAllOrgReposParams = z.infer<
    typeof OrgsEnableOrDisableSecurityProductOnAllOrgReposParamsSchema
  >

  export type OrgsEnableOrDisableSecurityProductOnAllOrgReposResponse =
    undefined

  export const ProjectsGetCardParamsSchema = z.object({
    card_id: z.number().int().describe('The unique identifier of the card.')
  })
  export type ProjectsGetCardParams = z.infer<
    typeof ProjectsGetCardParamsSchema
  >

  export const ProjectsGetCardResponseSchema = ProjectCardSchema
  export type ProjectsGetCardResponse = z.infer<
    typeof ProjectsGetCardResponseSchema
  >

  export const ProjectsDeleteCardParamsSchema = z.object({
    card_id: z.number().int().describe('The unique identifier of the card.')
  })
  export type ProjectsDeleteCardParams = z.infer<
    typeof ProjectsDeleteCardParamsSchema
  >

  export type ProjectsDeleteCardResponse = undefined

  export const ProjectsUpdateCardParamsSchema = z.object({
    note: z.string().describe("The project card's note").optional(),
    archived: z
      .boolean()
      .describe('Whether or not the card is archived')
      .optional(),
    card_id: z.number().int().describe('The unique identifier of the card.')
  })
  export type ProjectsUpdateCardParams = z.infer<
    typeof ProjectsUpdateCardParamsSchema
  >

  export const ProjectsUpdateCardResponseSchema = ProjectCardSchema
  export type ProjectsUpdateCardResponse = z.infer<
    typeof ProjectsUpdateCardResponseSchema
  >

  export const ProjectsMoveCardParamsSchema = z.object({
    position: z
      .string()
      .regex(new RegExp('^(?:top|bottom|after:\\d+)$'))
      .describe(
        'The position of the card in a column. Can be one of: `top`, `bottom`, or `after:<card_id>` to place after the specified card.'
      ),
    column_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the column the card should be moved to'
      )
      .optional(),
    card_id: z.number().int().describe('The unique identifier of the card.')
  })
  export type ProjectsMoveCardParams = z.infer<
    typeof ProjectsMoveCardParamsSchema
  >

  export type ProjectsMoveCardResponse = undefined

  export const ProjectsGetColumnParamsSchema = z.object({
    column_id: z.number().int().describe('The unique identifier of the column.')
  })
  export type ProjectsGetColumnParams = z.infer<
    typeof ProjectsGetColumnParamsSchema
  >

  export const ProjectsGetColumnResponseSchema = ProjectColumnSchema
  export type ProjectsGetColumnResponse = z.infer<
    typeof ProjectsGetColumnResponseSchema
  >

  export const ProjectsDeleteColumnParamsSchema = z.object({
    column_id: z.number().int().describe('The unique identifier of the column.')
  })
  export type ProjectsDeleteColumnParams = z.infer<
    typeof ProjectsDeleteColumnParamsSchema
  >

  export type ProjectsDeleteColumnResponse = undefined

  export const ProjectsUpdateColumnParamsSchema = z.object({
    name: z.string().describe('Name of the project column'),
    column_id: z.number().int().describe('The unique identifier of the column.')
  })
  export type ProjectsUpdateColumnParams = z.infer<
    typeof ProjectsUpdateColumnParamsSchema
  >

  export const ProjectsUpdateColumnResponseSchema = ProjectColumnSchema
  export type ProjectsUpdateColumnResponse = z.infer<
    typeof ProjectsUpdateColumnResponseSchema
  >

  export const ProjectsListCardsParamsSchema = z.object({
    column_id: z
      .number()
      .int()
      .describe('The unique identifier of the column.'),
    archived_state: z
      .enum(['all', 'archived', 'not_archived'])
      .describe(
        "Filters the project cards that are returned by the card's state."
      )
      .default('not_archived'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListCardsParams = z.infer<
    typeof ProjectsListCardsParamsSchema
  >

  export const ProjectsListCardsResponseSchema = z.array(ProjectCardSchema)
  export type ProjectsListCardsResponse = z.infer<
    typeof ProjectsListCardsResponseSchema
  >

  export const ProjectsCreateCardParamsSchema = z
    .object({
      column_id: z
        .number()
        .int()
        .describe('The unique identifier of the column.')
    })
    .and(
      z.union([
        z.object({ note: z.string().describe("The project card's note") }),
        z.object({
          content_id: z
            .number()
            .int()
            .describe(
              'The unique identifier of the content associated with the card'
            ),
          content_type: z
            .string()
            .describe('The piece of content associated with the card')
        })
      ])
    )
  export type ProjectsCreateCardParams = z.infer<
    typeof ProjectsCreateCardParamsSchema
  >

  export type ProjectsCreateCardResponse = undefined

  export const ProjectsMoveColumnParamsSchema = z.object({
    position: z
      .string()
      .regex(new RegExp('^(?:first|last|after:\\d+)$'))
      .describe(
        'The position of the column in a project. Can be one of: `first`, `last`, or `after:<column_id>` to place after the specified column.'
      ),
    column_id: z.number().int().describe('The unique identifier of the column.')
  })
  export type ProjectsMoveColumnParams = z.infer<
    typeof ProjectsMoveColumnParamsSchema
  >

  export type ProjectsMoveColumnResponse = undefined

  export const ProjectsGetParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type ProjectsGetParams = z.infer<typeof ProjectsGetParamsSchema>

  export const ProjectsGetResponseSchema = ProjectSchema
  export type ProjectsGetResponse = z.infer<typeof ProjectsGetResponseSchema>

  export const ProjectsDeleteParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type ProjectsDeleteParams = z.infer<typeof ProjectsDeleteParamsSchema>

  export type ProjectsDeleteResponse = undefined

  export const ProjectsUpdateParamsSchema = z.object({
    name: z.string().describe('Name of the project').optional(),
    body: z.string().describe('Body of the project').optional(),
    state: z
      .string()
      .describe("State of the project; either 'open' or 'closed'")
      .optional(),
    organization_permission: z
      .enum(['read', 'write', 'admin', 'none'])
      .describe(
        'The baseline permission that all organization members have on this project'
      )
      .optional(),
    private: z
      .boolean()
      .describe('Whether or not this project can be seen by everyone.')
      .optional(),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type ProjectsUpdateParams = z.infer<typeof ProjectsUpdateParamsSchema>

  export const ProjectsUpdateResponseSchema = ProjectSchema
  export type ProjectsUpdateResponse = z.infer<
    typeof ProjectsUpdateResponseSchema
  >

  export const ProjectsListCollaboratorsParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.'),
    affiliation: z
      .enum(['outside', 'direct', 'all'])
      .describe(
        "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see."
      )
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListCollaboratorsParams = z.infer<
    typeof ProjectsListCollaboratorsParamsSchema
  >

  export const ProjectsListCollaboratorsResponseSchema =
    z.array(SimpleUserSchema)
  export type ProjectsListCollaboratorsResponse = z.infer<
    typeof ProjectsListCollaboratorsResponseSchema
  >

  export const ProjectsAddCollaboratorParamsSchema = z.object({
    permission: z
      .enum(['read', 'write', 'admin'])
      .describe('The permission to grant the collaborator.')
      .default('write'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ProjectsAddCollaboratorParams = z.infer<
    typeof ProjectsAddCollaboratorParamsSchema
  >

  export type ProjectsAddCollaboratorResponse = undefined

  export const ProjectsRemoveCollaboratorParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ProjectsRemoveCollaboratorParams = z.infer<
    typeof ProjectsRemoveCollaboratorParamsSchema
  >

  export type ProjectsRemoveCollaboratorResponse = undefined

  export const ProjectsGetPermissionForUserParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ProjectsGetPermissionForUserParams = z.infer<
    typeof ProjectsGetPermissionForUserParamsSchema
  >

  export const ProjectsGetPermissionForUserResponseSchema =
    ProjectCollaboratorPermissionSchema
  export type ProjectsGetPermissionForUserResponse = z.infer<
    typeof ProjectsGetPermissionForUserResponseSchema
  >

  export const ProjectsListColumnsParamsSchema = z.object({
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListColumnsParams = z.infer<
    typeof ProjectsListColumnsParamsSchema
  >

  export const ProjectsListColumnsResponseSchema = z.array(ProjectColumnSchema)
  export type ProjectsListColumnsResponse = z.infer<
    typeof ProjectsListColumnsResponseSchema
  >

  export const ProjectsCreateColumnParamsSchema = z.object({
    name: z.string().describe('Name of the project column'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type ProjectsCreateColumnParams = z.infer<
    typeof ProjectsCreateColumnParamsSchema
  >

  export type ProjectsCreateColumnResponse = undefined

  export const RateLimitGetParamsSchema = z.object({})
  export type RateLimitGetParams = z.infer<typeof RateLimitGetParamsSchema>

  export const RateLimitGetResponseSchema = RateLimitOverviewSchema
  export type RateLimitGetResponse = z.infer<typeof RateLimitGetResponseSchema>

  export const ReposGetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetParams = z.infer<typeof ReposGetParamsSchema>

  export const ReposGetResponseSchema = FullRepositorySchema
  export type ReposGetResponse = z.infer<typeof ReposGetResponseSchema>

  export const ReposDeleteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposDeleteParams = z.infer<typeof ReposDeleteParamsSchema>

  export type ReposDeleteResponse = undefined

  export const ReposUpdateParamsSchema = z.object({
    name: z.string().describe('The name of the repository.').optional(),
    description: z
      .string()
      .describe('A short description of the repository.')
      .optional(),
    homepage: z
      .string()
      .describe('A URL with more information about the repository.')
      .optional(),
    private: z
      .boolean()
      .describe(
        'Either `true` to make the repository private or `false` to make it public. Default: `false`.  \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.'
      )
      .default(false),
    visibility: z
      .enum(['public', 'private'])
      .describe('The visibility of the repository.')
      .optional(),
    security_and_analysis: z
      .object({
        advanced_security: z
          .object({
            status: z
              .string()
              .describe('Can be `enabled` or `disabled`.')
              .optional()
          })
          .describe(
            'Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)."'
          )
          .optional(),
        secret_scanning: z
          .object({
            status: z
              .string()
              .describe('Can be `enabled` or `disabled`.')
              .optional()
          })
          .describe(
            'Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)."'
          )
          .optional(),
        secret_scanning_push_protection: z
          .object({
            status: z
              .string()
              .describe('Can be `enabled` or `disabled`.')
              .optional()
          })
          .describe(
            'Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."'
          )
          .optional(),
        secret_scanning_ai_detection: z
          .object({
            status: z
              .string()
              .describe('Can be `enabled` or `disabled`.')
              .optional()
          })
          .describe(
            'Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)."'
          )
          .optional(),
        secret_scanning_non_provider_patterns: z
          .object({
            status: z
              .string()
              .describe('Can be `enabled` or `disabled`.')
              .optional()
          })
          .describe(
            'Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."'
          )
          .optional()
      })
      .describe(
        'Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.'
      )
      .optional(),
    has_issues: z
      .boolean()
      .describe(
        'Either `true` to enable issues for this repository or `false` to disable them.'
      )
      .default(true),
    has_projects: z
      .boolean()
      .describe(
        "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error."
      )
      .default(true),
    has_wiki: z
      .boolean()
      .describe(
        'Either `true` to enable the wiki for this repository or `false` to disable it.'
      )
      .default(true),
    is_template: z
      .boolean()
      .describe(
        'Either `true` to make this repo available as a template repository or `false` to prevent it.'
      )
      .default(false),
    default_branch: z
      .string()
      .describe('Updates the default branch for this repository.')
      .optional(),
    allow_squash_merge: z
      .boolean()
      .describe(
        'Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.'
      )
      .default(true),
    allow_merge_commit: z
      .boolean()
      .describe(
        'Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.'
      )
      .default(true),
    allow_rebase_merge: z
      .boolean()
      .describe(
        'Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.'
      )
      .default(true),
    allow_auto_merge: z
      .boolean()
      .describe(
        'Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.'
      )
      .default(false),
    delete_branch_on_merge: z
      .boolean()
      .describe(
        'Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.'
      )
      .default(false),
    allow_update_branch: z
      .boolean()
      .describe(
        'Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.'
      )
      .default(false),
    use_squash_pr_title_as_default: z
      .boolean()
      .describe(
        'Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.'
      )
      .default(false),
    squash_merge_commit_title: z
      .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
      .describe(
        "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
      )
      .optional(),
    squash_merge_commit_message: z
      .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
      .describe(
        "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    merge_commit_title: z
      .enum(['PR_TITLE', 'MERGE_MESSAGE'])
      .describe(
        "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
      )
      .optional(),
    merge_commit_message: z
      .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
      .describe(
        "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    archived: z
      .boolean()
      .describe(
        'Whether to archive this repository. `false` will unarchive a previously archived repository.'
      )
      .default(false),
    allow_forking: z
      .boolean()
      .describe(
        'Either `true` to allow private forks, or `false` to prevent private forks.'
      )
      .default(false),
    web_commit_signoff_required: z
      .boolean()
      .describe(
        'Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.'
      )
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposUpdateParams = z.infer<typeof ReposUpdateParamsSchema>

  export const ReposUpdateResponseSchema = FullRepositorySchema
  export type ReposUpdateResponse = z.infer<typeof ReposUpdateResponseSchema>

  export const ActionsListArtifactsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    name: z
      .string()
      .describe(
        'The name field of an artifact. When specified, only artifacts with this name will be returned.'
      )
      .optional()
  })
  export type ActionsListArtifactsForRepoParams = z.infer<
    typeof ActionsListArtifactsForRepoParamsSchema
  >

  export const ActionsListArtifactsForRepoResponseSchema = z.object({
    total_count: z.number().int(),
    artifacts: z.array(ArtifactSchema)
  })
  export type ActionsListArtifactsForRepoResponse = z.infer<
    typeof ActionsListArtifactsForRepoResponseSchema
  >

  export const ActionsGetArtifactParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    artifact_id: z
      .number()
      .int()
      .describe('The unique identifier of the artifact.')
  })
  export type ActionsGetArtifactParams = z.infer<
    typeof ActionsGetArtifactParamsSchema
  >

  export const ActionsGetArtifactResponseSchema = ArtifactSchema
  export type ActionsGetArtifactResponse = z.infer<
    typeof ActionsGetArtifactResponseSchema
  >

  export const ActionsDeleteArtifactParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    artifact_id: z
      .number()
      .int()
      .describe('The unique identifier of the artifact.')
  })
  export type ActionsDeleteArtifactParams = z.infer<
    typeof ActionsDeleteArtifactParamsSchema
  >

  export type ActionsDeleteArtifactResponse = undefined

  export const ActionsDownloadArtifactParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    artifact_id: z
      .number()
      .int()
      .describe('The unique identifier of the artifact.'),
    archive_format: z.string()
  })
  export type ActionsDownloadArtifactParams = z.infer<
    typeof ActionsDownloadArtifactParamsSchema
  >

  export type ActionsDownloadArtifactResponse = undefined

  export const ActionsGetActionsCacheUsageParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGetActionsCacheUsageParams = z.infer<
    typeof ActionsGetActionsCacheUsageParamsSchema
  >

  export const ActionsGetActionsCacheUsageResponseSchema =
    ActionsCacheUsageByRepositorySchema
  export type ActionsGetActionsCacheUsageResponse = z.infer<
    typeof ActionsGetActionsCacheUsageResponseSchema
  >

  export const ActionsGetActionsCacheListParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    ref: z
      .string()
      .describe(
        'The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional(),
    key: z
      .string()
      .describe('An explicit key or prefix for identifying the cache')
      .optional(),
    sort: z
      .enum(['created_at', 'last_accessed_at', 'size_in_bytes'])
      .describe(
        'The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.'
      )
      .default('last_accessed_at'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc')
  })
  export type ActionsGetActionsCacheListParams = z.infer<
    typeof ActionsGetActionsCacheListParamsSchema
  >

  export const ActionsGetActionsCacheListResponseSchema = ActionsCacheListSchema
  export type ActionsGetActionsCacheListResponse = z.infer<
    typeof ActionsGetActionsCacheListResponseSchema
  >

  export const ActionsDeleteActionsCacheByKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    key: z.string().describe('A key for identifying the cache.'),
    ref: z
      .string()
      .describe(
        'The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional()
  })
  export type ActionsDeleteActionsCacheByKeyParams = z.infer<
    typeof ActionsDeleteActionsCacheByKeyParamsSchema
  >

  export const ActionsDeleteActionsCacheByKeyResponseSchema =
    ActionsCacheListSchema
  export type ActionsDeleteActionsCacheByKeyResponse = z.infer<
    typeof ActionsDeleteActionsCacheByKeyResponseSchema
  >

  export const ActionsDeleteActionsCacheByIdParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    cache_id: z
      .number()
      .int()
      .describe('The unique identifier of the GitHub Actions cache.')
  })
  export type ActionsDeleteActionsCacheByIdParams = z.infer<
    typeof ActionsDeleteActionsCacheByIdParamsSchema
  >

  export type ActionsDeleteActionsCacheByIdResponse = undefined

  export const ActionsGetJobForWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    job_id: z.number().int().describe('The unique identifier of the job.')
  })
  export type ActionsGetJobForWorkflowRunParams = z.infer<
    typeof ActionsGetJobForWorkflowRunParamsSchema
  >

  export const ActionsGetJobForWorkflowRunResponseSchema = JobSchema
  export type ActionsGetJobForWorkflowRunResponse = z.infer<
    typeof ActionsGetJobForWorkflowRunResponseSchema
  >

  export const ActionsDownloadJobLogsForWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    job_id: z.number().int().describe('The unique identifier of the job.')
  })
  export type ActionsDownloadJobLogsForWorkflowRunParams = z.infer<
    typeof ActionsDownloadJobLogsForWorkflowRunParamsSchema
  >

  export type ActionsDownloadJobLogsForWorkflowRunResponse = undefined

  export const ActionsReRunJobForWorkflowRunParamsSchema = z.object({
    enable_debug_logging: z
      .boolean()
      .describe('Whether to enable debug logging for the re-run.')
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    job_id: z.number().int().describe('The unique identifier of the job.')
  })
  export type ActionsReRunJobForWorkflowRunParams = z.infer<
    typeof ActionsReRunJobForWorkflowRunParamsSchema
  >

  export type ActionsReRunJobForWorkflowRunResponse = undefined

  export const ActionsGetCustomOidcSubClaimForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGetCustomOidcSubClaimForRepoParams = z.infer<
    typeof ActionsGetCustomOidcSubClaimForRepoParamsSchema
  >

  export const ActionsGetCustomOidcSubClaimForRepoResponseSchema =
    OidcCustomSubRepoSchema
  export type ActionsGetCustomOidcSubClaimForRepoResponse = z.infer<
    typeof ActionsGetCustomOidcSubClaimForRepoResponseSchema
  >

  export const ActionsSetCustomOidcSubClaimForRepoParamsSchema = z.object({
    use_default: z
      .boolean()
      .describe(
        'Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.'
      ),
    include_claim_keys: z
      .array(z.string())
      .describe(
        'Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsSetCustomOidcSubClaimForRepoParams = z.infer<
    typeof ActionsSetCustomOidcSubClaimForRepoParamsSchema
  >

  export type ActionsSetCustomOidcSubClaimForRepoResponse = undefined

  export const ActionsListRepoOrganizationSecretsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListRepoOrganizationSecretsParams = z.infer<
    typeof ActionsListRepoOrganizationSecretsParamsSchema
  >

  export const ActionsListRepoOrganizationSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(ActionsSecretSchema)
  })
  export type ActionsListRepoOrganizationSecretsResponse = z.infer<
    typeof ActionsListRepoOrganizationSecretsResponseSchema
  >

  export const ActionsListRepoOrganizationVariablesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(10),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListRepoOrganizationVariablesParams = z.infer<
    typeof ActionsListRepoOrganizationVariablesParamsSchema
  >

  export const ActionsListRepoOrganizationVariablesResponseSchema = z.object({
    total_count: z.number().int(),
    variables: z.array(ActionsVariableSchema)
  })
  export type ActionsListRepoOrganizationVariablesResponse = z.infer<
    typeof ActionsListRepoOrganizationVariablesResponseSchema
  >

  export const ActionsGetGithubActionsPermissionsRepositoryParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
  export type ActionsGetGithubActionsPermissionsRepositoryParams = z.infer<
    typeof ActionsGetGithubActionsPermissionsRepositoryParamsSchema
  >

  export const ActionsGetGithubActionsPermissionsRepositoryResponseSchema =
    ActionsRepositoryPermissionsSchema
  export type ActionsGetGithubActionsPermissionsRepositoryResponse = z.infer<
    typeof ActionsGetGithubActionsPermissionsRepositoryResponseSchema
  >

  export const ActionsSetGithubActionsPermissionsRepositoryParamsSchema =
    z.object({
      enabled: ActionsEnabledSchema,
      allowed_actions: AllowedActionsSchema.optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
  export type ActionsSetGithubActionsPermissionsRepositoryParams = z.infer<
    typeof ActionsSetGithubActionsPermissionsRepositoryParamsSchema
  >

  export type ActionsSetGithubActionsPermissionsRepositoryResponse = undefined

  export const ActionsGetWorkflowAccessToRepositoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGetWorkflowAccessToRepositoryParams = z.infer<
    typeof ActionsGetWorkflowAccessToRepositoryParamsSchema
  >

  export const ActionsGetWorkflowAccessToRepositoryResponseSchema =
    ActionsWorkflowAccessToRepositorySchema
  export type ActionsGetWorkflowAccessToRepositoryResponse = z.infer<
    typeof ActionsGetWorkflowAccessToRepositoryResponseSchema
  >

  export const ActionsSetWorkflowAccessToRepositoryParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(ActionsWorkflowAccessToRepositorySchema)
  export type ActionsSetWorkflowAccessToRepositoryParams = z.infer<
    typeof ActionsSetWorkflowAccessToRepositoryParamsSchema
  >

  export type ActionsSetWorkflowAccessToRepositoryResponse = undefined

  export const ActionsGetAllowedActionsRepositoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGetAllowedActionsRepositoryParams = z.infer<
    typeof ActionsGetAllowedActionsRepositoryParamsSchema
  >

  export const ActionsGetAllowedActionsRepositoryResponseSchema =
    SelectedActionsSchema
  export type ActionsGetAllowedActionsRepositoryResponse = z.infer<
    typeof ActionsGetAllowedActionsRepositoryResponseSchema
  >

  export const ActionsSetAllowedActionsRepositoryParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(SelectedActionsSchema)
  export type ActionsSetAllowedActionsRepositoryParams = z.infer<
    typeof ActionsSetAllowedActionsRepositoryParamsSchema
  >

  export type ActionsSetAllowedActionsRepositoryResponse = undefined

  export const ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
  export type ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryParams =
    z.infer<
      typeof ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema
    >

  export const ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryResponseSchema =
    ActionsGetDefaultWorkflowPermissionsSchema
  export type ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryResponse =
    z.infer<
      typeof ActionsGetGithubActionsDefaultWorkflowPermissionsRepositoryResponseSchema
    >

  export const ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema =
    z
      .object({
        owner: z
          .string()
          .describe(
            'The account owner of the repository. The name is not case sensitive.'
          ),
        repo: z
          .string()
          .describe(
            'The name of the repository without the `.git` extension. The name is not case sensitive.'
          )
      })
      .merge(ActionsSetDefaultWorkflowPermissionsSchema)
  export type ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryParams =
    z.infer<
      typeof ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryParamsSchema
    >

  export type ActionsSetGithubActionsDefaultWorkflowPermissionsRepositoryResponse =
    undefined

  export const ActionsListSelfHostedRunnersForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string().describe('The name of a self-hosted runner.').optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListSelfHostedRunnersForRepoParams = z.infer<
    typeof ActionsListSelfHostedRunnersForRepoParamsSchema
  >

  export const ActionsListSelfHostedRunnersForRepoResponseSchema = z.object({
    total_count: z.number().int(),
    runners: z.array(RunnerSchema)
  })
  export type ActionsListSelfHostedRunnersForRepoResponse = z.infer<
    typeof ActionsListSelfHostedRunnersForRepoResponseSchema
  >

  export const ActionsListRunnerApplicationsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsListRunnerApplicationsForRepoParams = z.infer<
    typeof ActionsListRunnerApplicationsForRepoParamsSchema
  >

  export const ActionsListRunnerApplicationsForRepoResponseSchema = z.array(
    RunnerApplicationSchema
  )
  export type ActionsListRunnerApplicationsForRepoResponse = z.infer<
    typeof ActionsListRunnerApplicationsForRepoResponseSchema
  >

  export const ActionsGenerateRunnerJitconfigForRepoParamsSchema = z.object({
    name: z.string().describe('The name of the new runner.'),
    runner_group_id: z
      .number()
      .int()
      .describe('The ID of the runner group to register the runner to.'),
    labels: z
      .array(z.string())
      .min(1)
      .max(100)
      .describe(
        'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.'
      ),
    work_folder: z
      .string()
      .describe(
        'The working directory to be used for job execution, relative to the runner install directory.'
      )
      .default('_work'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGenerateRunnerJitconfigForRepoParams = z.infer<
    typeof ActionsGenerateRunnerJitconfigForRepoParamsSchema
  >

  export type ActionsGenerateRunnerJitconfigForRepoResponse = undefined

  export const ActionsCreateRegistrationTokenForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsCreateRegistrationTokenForRepoParams = z.infer<
    typeof ActionsCreateRegistrationTokenForRepoParamsSchema
  >

  export type ActionsCreateRegistrationTokenForRepoResponse = undefined

  export const ActionsCreateRemoveTokenForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsCreateRemoveTokenForRepoParams = z.infer<
    typeof ActionsCreateRemoveTokenForRepoParamsSchema
  >

  export type ActionsCreateRemoveTokenForRepoResponse = undefined

  export const ActionsGetSelfHostedRunnerForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner.')
  })
  export type ActionsGetSelfHostedRunnerForRepoParams = z.infer<
    typeof ActionsGetSelfHostedRunnerForRepoParamsSchema
  >

  export const ActionsGetSelfHostedRunnerForRepoResponseSchema = RunnerSchema
  export type ActionsGetSelfHostedRunnerForRepoResponse = z.infer<
    typeof ActionsGetSelfHostedRunnerForRepoResponseSchema
  >

  export const ActionsDeleteSelfHostedRunnerFromRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    runner_id: z
      .number()
      .int()
      .describe('Unique identifier of the self-hosted runner.')
  })
  export type ActionsDeleteSelfHostedRunnerFromRepoParams = z.infer<
    typeof ActionsDeleteSelfHostedRunnerFromRepoParamsSchema
  >

  export type ActionsDeleteSelfHostedRunnerFromRepoResponse = undefined

  export const ActionsListLabelsForSelfHostedRunnerForRepoParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsListLabelsForSelfHostedRunnerForRepoParams = z.infer<
    typeof ActionsListLabelsForSelfHostedRunnerForRepoParamsSchema
  >

  export const ActionsListLabelsForSelfHostedRunnerForRepoResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsListLabelsForSelfHostedRunnerForRepoResponse = z.infer<
    typeof ActionsListLabelsForSelfHostedRunnerForRepoResponseSchema
  >

  export const ActionsAddCustomLabelsToSelfHostedRunnerForRepoParamsSchema =
    z.object({
      labels: z
        .array(z.string())
        .min(1)
        .max(100)
        .describe('The names of the custom labels to add to the runner.'),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsAddCustomLabelsToSelfHostedRunnerForRepoParams = z.infer<
    typeof ActionsAddCustomLabelsToSelfHostedRunnerForRepoParamsSchema
  >

  export const ActionsAddCustomLabelsToSelfHostedRunnerForRepoResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsAddCustomLabelsToSelfHostedRunnerForRepoResponse = z.infer<
    typeof ActionsAddCustomLabelsToSelfHostedRunnerForRepoResponseSchema
  >

  export const ActionsSetCustomLabelsForSelfHostedRunnerForRepoParamsSchema =
    z.object({
      labels: z
        .array(z.string())
        .min(0)
        .max(100)
        .describe(
          'The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.'
        ),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsSetCustomLabelsForSelfHostedRunnerForRepoParams = z.infer<
    typeof ActionsSetCustomLabelsForSelfHostedRunnerForRepoParamsSchema
  >

  export const ActionsSetCustomLabelsForSelfHostedRunnerForRepoResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsSetCustomLabelsForSelfHostedRunnerForRepoResponse =
    z.infer<
      typeof ActionsSetCustomLabelsForSelfHostedRunnerForRepoResponseSchema
    >

  export const ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.')
    })
  export type ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoParams =
    z.infer<
      typeof ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoParamsSchema
    >

  export const ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoResponse =
    z.infer<
      typeof ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoResponseSchema
    >

  export const ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      runner_id: z
        .number()
        .int()
        .describe('Unique identifier of the self-hosted runner.'),
      name: z
        .string()
        .describe("The name of a self-hosted runner's custom label.")
    })
  export type ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoParams =
    z.infer<
      typeof ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoParamsSchema
    >

  export const ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponseSchema =
    z.object({
      total_count: z.number().int(),
      labels: z.array(RunnerLabelSchema)
    })
  export type ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse =
    z.infer<
      typeof ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponseSchema
    >

  export const ActionsListWorkflowRunsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    actor: z
      .string()
      .describe(
        "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run."
      )
      .optional(),
    branch: z
      .string()
      .describe(
        'Returns workflow runs associated with a branch. Use the name of the branch of the `push`.'
      )
      .optional(),
    event: z
      .string()
      .describe(
        'Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."'
      )
      .optional(),
    status: z
      .enum([
        'completed',
        'action_required',
        'cancelled',
        'failure',
        'neutral',
        'skipped',
        'stale',
        'success',
        'timed_out',
        'in_progress',
        'queued',
        'requested',
        'waiting',
        'pending'
      ])
      .describe(
        'Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    created: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
      )
      .optional(),
    exclude_pull_requests: z
      .boolean()
      .describe(
        'If `true` pull requests are omitted from the response (empty array).'
      )
      .default(false),
    check_suite_id: z
      .number()
      .int()
      .describe(
        'Returns workflow runs with the `check_suite_id` that you specify.'
      )
      .optional(),
    head_sha: z
      .string()
      .describe(
        'Only returns workflow runs that are associated with the specified `head_sha`.'
      )
      .optional()
  })
  export type ActionsListWorkflowRunsForRepoParams = z.infer<
    typeof ActionsListWorkflowRunsForRepoParamsSchema
  >

  export const ActionsListWorkflowRunsForRepoResponseSchema = z.object({
    total_count: z.number().int(),
    workflow_runs: z.array(WorkflowRunSchema)
  })
  export type ActionsListWorkflowRunsForRepoResponse = z.infer<
    typeof ActionsListWorkflowRunsForRepoResponseSchema
  >

  export const ActionsGetWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    exclude_pull_requests: z
      .boolean()
      .describe(
        'If `true` pull requests are omitted from the response (empty array).'
      )
      .default(false)
  })
  export type ActionsGetWorkflowRunParams = z.infer<
    typeof ActionsGetWorkflowRunParamsSchema
  >

  export const ActionsGetWorkflowRunResponseSchema = WorkflowRunSchema
  export type ActionsGetWorkflowRunResponse = z.infer<
    typeof ActionsGetWorkflowRunResponseSchema
  >

  export const ActionsDeleteWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsDeleteWorkflowRunParams = z.infer<
    typeof ActionsDeleteWorkflowRunParamsSchema
  >

  export type ActionsDeleteWorkflowRunResponse = undefined

  export const ActionsGetReviewsForRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsGetReviewsForRunParams = z.infer<
    typeof ActionsGetReviewsForRunParamsSchema
  >

  export const ActionsGetReviewsForRunResponseSchema = z.array(
    EnvironmentApprovalsSchema
  )
  export type ActionsGetReviewsForRunResponse = z.infer<
    typeof ActionsGetReviewsForRunResponseSchema
  >

  export const ActionsApproveWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsApproveWorkflowRunParams = z.infer<
    typeof ActionsApproveWorkflowRunParamsSchema
  >

  export type ActionsApproveWorkflowRunResponse = undefined

  export const ActionsListWorkflowRunArtifactsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    name: z
      .string()
      .describe(
        'The name field of an artifact. When specified, only artifacts with this name will be returned.'
      )
      .optional()
  })
  export type ActionsListWorkflowRunArtifactsParams = z.infer<
    typeof ActionsListWorkflowRunArtifactsParamsSchema
  >

  export const ActionsListWorkflowRunArtifactsResponseSchema = z.object({
    total_count: z.number().int(),
    artifacts: z.array(ArtifactSchema)
  })
  export type ActionsListWorkflowRunArtifactsResponse = z.infer<
    typeof ActionsListWorkflowRunArtifactsResponseSchema
  >

  export const ActionsGetWorkflowRunAttemptParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    attempt_number: z
      .number()
      .int()
      .describe('The attempt number of the workflow run.'),
    exclude_pull_requests: z
      .boolean()
      .describe(
        'If `true` pull requests are omitted from the response (empty array).'
      )
      .default(false)
  })
  export type ActionsGetWorkflowRunAttemptParams = z.infer<
    typeof ActionsGetWorkflowRunAttemptParamsSchema
  >

  export const ActionsGetWorkflowRunAttemptResponseSchema = WorkflowRunSchema
  export type ActionsGetWorkflowRunAttemptResponse = z.infer<
    typeof ActionsGetWorkflowRunAttemptResponseSchema
  >

  export const ActionsListJobsForWorkflowRunAttemptParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    attempt_number: z
      .number()
      .int()
      .describe('The attempt number of the workflow run.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListJobsForWorkflowRunAttemptParams = z.infer<
    typeof ActionsListJobsForWorkflowRunAttemptParamsSchema
  >

  export const ActionsListJobsForWorkflowRunAttemptResponseSchema = z.object({
    total_count: z.number().int(),
    jobs: z.array(JobSchema)
  })
  export type ActionsListJobsForWorkflowRunAttemptResponse = z.infer<
    typeof ActionsListJobsForWorkflowRunAttemptResponseSchema
  >

  export const ActionsDownloadWorkflowRunAttemptLogsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    attempt_number: z
      .number()
      .int()
      .describe('The attempt number of the workflow run.')
  })
  export type ActionsDownloadWorkflowRunAttemptLogsParams = z.infer<
    typeof ActionsDownloadWorkflowRunAttemptLogsParamsSchema
  >

  export type ActionsDownloadWorkflowRunAttemptLogsResponse = undefined

  export const ActionsCancelWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsCancelWorkflowRunParams = z.infer<
    typeof ActionsCancelWorkflowRunParamsSchema
  >

  export type ActionsCancelWorkflowRunResponse = undefined

  export const ActionsReviewCustomGatesForRunParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      run_id: z
        .number()
        .int()
        .describe('The unique identifier of the workflow run.')
    })
    .and(
      z.union([
        ReviewCustomGatesCommentRequiredSchema,
        ReviewCustomGatesStateRequiredSchema
      ])
    )
  export type ActionsReviewCustomGatesForRunParams = z.infer<
    typeof ActionsReviewCustomGatesForRunParamsSchema
  >

  export type ActionsReviewCustomGatesForRunResponse = undefined

  export const ActionsForceCancelWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsForceCancelWorkflowRunParams = z.infer<
    typeof ActionsForceCancelWorkflowRunParamsSchema
  >

  export type ActionsForceCancelWorkflowRunResponse = undefined

  export const ActionsListJobsForWorkflowRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.'),
    filter: z
      .enum(['latest', 'all'])
      .describe(
        'Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.'
      )
      .default('latest'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListJobsForWorkflowRunParams = z.infer<
    typeof ActionsListJobsForWorkflowRunParamsSchema
  >

  export const ActionsListJobsForWorkflowRunResponseSchema = z.object({
    total_count: z.number().int(),
    jobs: z.array(JobSchema)
  })
  export type ActionsListJobsForWorkflowRunResponse = z.infer<
    typeof ActionsListJobsForWorkflowRunResponseSchema
  >

  export const ActionsDownloadWorkflowRunLogsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsDownloadWorkflowRunLogsParams = z.infer<
    typeof ActionsDownloadWorkflowRunLogsParamsSchema
  >

  export type ActionsDownloadWorkflowRunLogsResponse = undefined

  export const ActionsDeleteWorkflowRunLogsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsDeleteWorkflowRunLogsParams = z.infer<
    typeof ActionsDeleteWorkflowRunLogsParamsSchema
  >

  export type ActionsDeleteWorkflowRunLogsResponse = undefined

  export const ActionsGetPendingDeploymentsForRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsGetPendingDeploymentsForRunParams = z.infer<
    typeof ActionsGetPendingDeploymentsForRunParamsSchema
  >

  export const ActionsGetPendingDeploymentsForRunResponseSchema = z.array(
    PendingDeploymentSchema
  )
  export type ActionsGetPendingDeploymentsForRunResponse = z.infer<
    typeof ActionsGetPendingDeploymentsForRunResponseSchema
  >

  export const ActionsReviewPendingDeploymentsForRunParamsSchema = z.object({
    environment_ids: z
      .array(z.number().int())
      .describe('The list of environment ids to approve or reject'),
    state: z
      .enum(['approved', 'rejected'])
      .describe(
        'Whether to approve or reject deployment to the specified environments.'
      ),
    comment: z
      .string()
      .describe('A comment to accompany the deployment review'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsReviewPendingDeploymentsForRunParams = z.infer<
    typeof ActionsReviewPendingDeploymentsForRunParamsSchema
  >

  export const ActionsReviewPendingDeploymentsForRunResponseSchema =
    z.array(DeploymentSchema)
  export type ActionsReviewPendingDeploymentsForRunResponse = z.infer<
    typeof ActionsReviewPendingDeploymentsForRunResponseSchema
  >

  export const ActionsReRunWorkflowParamsSchema = z.object({
    enable_debug_logging: z
      .boolean()
      .describe('Whether to enable debug logging for the re-run.')
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsReRunWorkflowParams = z.infer<
    typeof ActionsReRunWorkflowParamsSchema
  >

  export type ActionsReRunWorkflowResponse = undefined

  export const ActionsReRunWorkflowFailedJobsParamsSchema = z.object({
    enable_debug_logging: z
      .boolean()
      .describe('Whether to enable debug logging for the re-run.')
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsReRunWorkflowFailedJobsParams = z.infer<
    typeof ActionsReRunWorkflowFailedJobsParamsSchema
  >

  export type ActionsReRunWorkflowFailedJobsResponse = undefined

  export const ActionsGetWorkflowRunUsageParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    run_id: z
      .number()
      .int()
      .describe('The unique identifier of the workflow run.')
  })
  export type ActionsGetWorkflowRunUsageParams = z.infer<
    typeof ActionsGetWorkflowRunUsageParamsSchema
  >

  export const ActionsGetWorkflowRunUsageResponseSchema = WorkflowRunUsageSchema
  export type ActionsGetWorkflowRunUsageResponse = z.infer<
    typeof ActionsGetWorkflowRunUsageResponseSchema
  >

  export const ActionsListRepoSecretsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListRepoSecretsParams = z.infer<
    typeof ActionsListRepoSecretsParamsSchema
  >

  export const ActionsListRepoSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(ActionsSecretSchema)
  })
  export type ActionsListRepoSecretsResponse = z.infer<
    typeof ActionsListRepoSecretsResponseSchema
  >

  export const ActionsGetRepoPublicKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsGetRepoPublicKeyParams = z.infer<
    typeof ActionsGetRepoPublicKeyParamsSchema
  >

  export const ActionsGetRepoPublicKeyResponseSchema = ActionsPublicKeySchema
  export type ActionsGetRepoPublicKeyResponse = z.infer<
    typeof ActionsGetRepoPublicKeyResponseSchema
  >

  export const ActionsGetRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsGetRepoSecretParams = z.infer<
    typeof ActionsGetRepoSecretParamsSchema
  >

  export const ActionsGetRepoSecretResponseSchema = ActionsSecretSchema
  export type ActionsGetRepoSecretResponse = z.infer<
    typeof ActionsGetRepoSecretResponseSchema
  >

  export const ActionsCreateOrUpdateRepoSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.'
      ),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsCreateOrUpdateRepoSecretParams = z.infer<
    typeof ActionsCreateOrUpdateRepoSecretParamsSchema
  >

  export type ActionsCreateOrUpdateRepoSecretResponse = undefined

  export const ActionsDeleteRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsDeleteRepoSecretParams = z.infer<
    typeof ActionsDeleteRepoSecretParamsSchema
  >

  export type ActionsDeleteRepoSecretResponse = undefined

  export const ActionsListRepoVariablesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(10),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListRepoVariablesParams = z.infer<
    typeof ActionsListRepoVariablesParamsSchema
  >

  export const ActionsListRepoVariablesResponseSchema = z.object({
    total_count: z.number().int(),
    variables: z.array(ActionsVariableSchema)
  })
  export type ActionsListRepoVariablesResponse = z.infer<
    typeof ActionsListRepoVariablesResponseSchema
  >

  export const ActionsCreateRepoVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsCreateRepoVariableParams = z.infer<
    typeof ActionsCreateRepoVariableParamsSchema
  >

  export type ActionsCreateRepoVariableResponse = undefined

  export const ActionsGetRepoVariableParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsGetRepoVariableParams = z.infer<
    typeof ActionsGetRepoVariableParamsSchema
  >

  export const ActionsGetRepoVariableResponseSchema = ActionsVariableSchema
  export type ActionsGetRepoVariableResponse = z.infer<
    typeof ActionsGetRepoVariableResponseSchema
  >

  export const ActionsDeleteRepoVariableParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsDeleteRepoVariableParams = z.infer<
    typeof ActionsDeleteRepoVariableParamsSchema
  >

  export type ActionsDeleteRepoVariableResponse = undefined

  export const ActionsUpdateRepoVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.').optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActionsUpdateRepoVariableParams = z.infer<
    typeof ActionsUpdateRepoVariableParamsSchema
  >

  export type ActionsUpdateRepoVariableResponse = undefined

  export const ActionsListRepoWorkflowsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListRepoWorkflowsParams = z.infer<
    typeof ActionsListRepoWorkflowsParamsSchema
  >

  export const ActionsListRepoWorkflowsResponseSchema = z.object({
    total_count: z.number().int(),
    workflows: z.array(WorkflowSchema)
  })
  export type ActionsListRepoWorkflowsResponse = z.infer<
    typeof ActionsListRepoWorkflowsResponseSchema
  >

  export const ActionsGetWorkflowParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      )
  })
  export type ActionsGetWorkflowParams = z.infer<
    typeof ActionsGetWorkflowParamsSchema
  >

  export const ActionsGetWorkflowResponseSchema = WorkflowSchema
  export type ActionsGetWorkflowResponse = z.infer<
    typeof ActionsGetWorkflowResponseSchema
  >

  export const ActionsDisableWorkflowParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      )
  })
  export type ActionsDisableWorkflowParams = z.infer<
    typeof ActionsDisableWorkflowParamsSchema
  >

  export type ActionsDisableWorkflowResponse = undefined

  export const ActionsCreateWorkflowDispatchParamsSchema = z.object({
    ref: z
      .string()
      .describe(
        'The git reference for the workflow. The reference can be a branch or tag name.'
      ),
    inputs: z
      .record(z.any())
      .describe(
        'Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      )
  })
  export type ActionsCreateWorkflowDispatchParams = z.infer<
    typeof ActionsCreateWorkflowDispatchParamsSchema
  >

  export type ActionsCreateWorkflowDispatchResponse = undefined

  export const ActionsEnableWorkflowParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      )
  })
  export type ActionsEnableWorkflowParams = z.infer<
    typeof ActionsEnableWorkflowParamsSchema
  >

  export type ActionsEnableWorkflowResponse = undefined

  export const ActionsListWorkflowRunsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      ),
    actor: z
      .string()
      .describe(
        "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run."
      )
      .optional(),
    branch: z
      .string()
      .describe(
        'Returns workflow runs associated with a branch. Use the name of the branch of the `push`.'
      )
      .optional(),
    event: z
      .string()
      .describe(
        'Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."'
      )
      .optional(),
    status: z
      .enum([
        'completed',
        'action_required',
        'cancelled',
        'failure',
        'neutral',
        'skipped',
        'stale',
        'success',
        'timed_out',
        'in_progress',
        'queued',
        'requested',
        'waiting',
        'pending'
      ])
      .describe(
        'Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    created: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."'
      )
      .optional(),
    exclude_pull_requests: z
      .boolean()
      .describe(
        'If `true` pull requests are omitted from the response (empty array).'
      )
      .default(false),
    check_suite_id: z
      .number()
      .int()
      .describe(
        'Returns workflow runs with the `check_suite_id` that you specify.'
      )
      .optional(),
    head_sha: z
      .string()
      .describe(
        'Only returns workflow runs that are associated with the specified `head_sha`.'
      )
      .optional()
  })
  export type ActionsListWorkflowRunsParams = z.infer<
    typeof ActionsListWorkflowRunsParamsSchema
  >

  export const ActionsListWorkflowRunsResponseSchema = z.object({
    total_count: z.number().int(),
    workflow_runs: z.array(WorkflowRunSchema)
  })
  export type ActionsListWorkflowRunsResponse = z.infer<
    typeof ActionsListWorkflowRunsResponseSchema
  >

  export const ActionsGetWorkflowUsageParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    workflow_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the workflow. You can also pass the workflow file name as a string.'
      )
  })
  export type ActionsGetWorkflowUsageParams = z.infer<
    typeof ActionsGetWorkflowUsageParamsSchema
  >

  export const ActionsGetWorkflowUsageResponseSchema = WorkflowUsageSchema
  export type ActionsGetWorkflowUsageResponse = z.infer<
    typeof ActionsGetWorkflowUsageResponseSchema
  >

  export const ReposListActivitiesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    ref: z
      .string()
      .describe(
        'The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.'
      )
      .optional(),
    actor: z
      .string()
      .describe(
        'The GitHub username to use to filter by the actor who performed the activity.'
      )
      .optional(),
    time_period: z
      .enum(['day', 'week', 'month', 'quarter', 'year'])
      .describe(
        'The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).'
      )
      .optional(),
    activity_type: z
      .enum([
        'push',
        'force_push',
        'branch_creation',
        'branch_deletion',
        'pr_merge',
        'merge_queue_merge'
      ])
      .describe(
        'The activity type to filter by.\n\nFor example, you can choose to filter by "force_push", to see all force pushes to the repository.'
      )
      .optional()
  })
  export type ReposListActivitiesParams = z.infer<
    typeof ReposListActivitiesParamsSchema
  >

  export const ReposListActivitiesResponseSchema = z.array(ActivitySchema)
  export type ReposListActivitiesResponse = z.infer<
    typeof ReposListActivitiesResponseSchema
  >

  export const IssuesListAssigneesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListAssigneesParams = z.infer<
    typeof IssuesListAssigneesParamsSchema
  >

  export const IssuesListAssigneesResponseSchema = z.array(SimpleUserSchema)
  export type IssuesListAssigneesResponse = z.infer<
    typeof IssuesListAssigneesResponseSchema
  >

  export const IssuesCheckUserCanBeAssignedParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    assignee: z.string()
  })
  export type IssuesCheckUserCanBeAssignedParams = z.infer<
    typeof IssuesCheckUserCanBeAssignedParamsSchema
  >

  export type IssuesCheckUserCanBeAssignedResponse = undefined

  export const ReposCreateAttestationParamsSchema = z.object({
    bundle: z
      .object({
        mediaType: z.string().optional(),
        verificationMaterial: z.object({}).catchall(z.any()).optional(),
        dsseEnvelope: z.object({}).catchall(z.any()).optional()
      })
      .describe(
        "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information."
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateAttestationParams = z.infer<
    typeof ReposCreateAttestationParamsSchema
  >

  export type ReposCreateAttestationResponse = undefined

  export const ReposListAttestationsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    subject_digest: z
      .string()
      .describe(
        "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`."
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    predicate_type: z
      .string()
      .describe(
        'Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.'
      )
      .optional()
  })
  export type ReposListAttestationsParams = z.infer<
    typeof ReposListAttestationsParamsSchema
  >

  export const ReposListAttestationsResponseSchema = z.object({
    attestations: z
      .array(
        z.object({
          bundle: z
            .object({
              mediaType: z.string().optional(),
              verificationMaterial: z.object({}).catchall(z.any()).optional(),
              dsseEnvelope: z.object({}).catchall(z.any()).optional()
            })
            .describe(
              "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information."
            )
            .optional(),
          repository_id: z.number().int().optional(),
          bundle_url: z.string().optional()
        })
      )
      .optional()
  })
  export type ReposListAttestationsResponse = z.infer<
    typeof ReposListAttestationsResponseSchema
  >

  export const ReposListAutolinksParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposListAutolinksParams = z.infer<
    typeof ReposListAutolinksParamsSchema
  >

  export const ReposListAutolinksResponseSchema = z.array(AutolinkSchema)
  export type ReposListAutolinksResponse = z.infer<
    typeof ReposListAutolinksResponseSchema
  >

  export const ReposCreateAutolinkParamsSchema = z.object({
    key_prefix: z
      .string()
      .describe(
        'This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.'
      ),
    url_template: z
      .string()
      .describe(
        'The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`.'
      ),
    is_alphanumeric: z
      .boolean()
      .describe(
        'Whether this autolink reference matches alphanumeric characters. If true, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.'
      )
      .default(true),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateAutolinkParams = z.infer<
    typeof ReposCreateAutolinkParamsSchema
  >

  export type ReposCreateAutolinkResponse = undefined

  export const ReposGetAutolinkParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    autolink_id: z
      .number()
      .int()
      .describe('The unique identifier of the autolink.')
  })
  export type ReposGetAutolinkParams = z.infer<
    typeof ReposGetAutolinkParamsSchema
  >

  export const ReposGetAutolinkResponseSchema = AutolinkSchema
  export type ReposGetAutolinkResponse = z.infer<
    typeof ReposGetAutolinkResponseSchema
  >

  export const ReposDeleteAutolinkParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    autolink_id: z
      .number()
      .int()
      .describe('The unique identifier of the autolink.')
  })
  export type ReposDeleteAutolinkParams = z.infer<
    typeof ReposDeleteAutolinkParamsSchema
  >

  export type ReposDeleteAutolinkResponse = undefined

  export const ReposCheckAutomatedSecurityFixesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCheckAutomatedSecurityFixesParams = z.infer<
    typeof ReposCheckAutomatedSecurityFixesParamsSchema
  >

  export const ReposCheckAutomatedSecurityFixesResponseSchema =
    CheckAutomatedSecurityFixesSchema
  export type ReposCheckAutomatedSecurityFixesResponse = z.infer<
    typeof ReposCheckAutomatedSecurityFixesResponseSchema
  >

  export const ReposEnableAutomatedSecurityFixesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposEnableAutomatedSecurityFixesParams = z.infer<
    typeof ReposEnableAutomatedSecurityFixesParamsSchema
  >

  export type ReposEnableAutomatedSecurityFixesResponse = undefined

  export const ReposDisableAutomatedSecurityFixesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposDisableAutomatedSecurityFixesParams = z.infer<
    typeof ReposDisableAutomatedSecurityFixesParamsSchema
  >

  export type ReposDisableAutomatedSecurityFixesResponse = undefined

  export const ReposListBranchesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    protected: z
      .boolean()
      .describe(
        'Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListBranchesParams = z.infer<
    typeof ReposListBranchesParamsSchema
  >

  export const ReposListBranchesResponseSchema = z.array(ShortBranchSchema)
  export type ReposListBranchesResponse = z.infer<
    typeof ReposListBranchesResponseSchema
  >

  export const ReposGetBranchParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetBranchParams = z.infer<typeof ReposGetBranchParamsSchema>

  export const ReposGetBranchResponseSchema = BranchWithProtectionSchema
  export type ReposGetBranchResponse = z.infer<
    typeof ReposGetBranchResponseSchema
  >

  export const ReposGetBranchProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetBranchProtectionParams = z.infer<
    typeof ReposGetBranchProtectionParamsSchema
  >

  export const ReposGetBranchProtectionResponseSchema = BranchProtectionSchema
  export type ReposGetBranchProtectionResponse = z.infer<
    typeof ReposGetBranchProtectionResponseSchema
  >

  export const ReposUpdateBranchProtectionParamsSchema = z.object({
    required_status_checks: z
      .object({
        strict: z
          .boolean()
          .describe('Require branches to be up to date before merging.'),
        contexts: z
          .array(z.string())
          .describe(
            '**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.'
          ),
        checks: z
          .array(
            z.object({
              context: z.string().describe('The name of the required check'),
              app_id: z
                .number()
                .int()
                .describe(
                  'The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.'
                )
                .optional()
            })
          )
          .describe(
            'The list of status checks to require in order to merge into this branch.'
          )
          .optional()
      })
      .describe(
        'Require status checks to pass before merging. Set to `null` to disable.'
      ),
    enforce_admins: z
      .boolean()
      .describe(
        'Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.'
      ),
    required_pull_request_reviews: z
      .object({
        dismissal_restrictions: z
          .object({
            users: z
              .array(z.string())
              .describe('The list of user `login`s with dismissal access')
              .optional(),
            teams: z
              .array(z.string())
              .describe('The list of team `slug`s with dismissal access')
              .optional(),
            apps: z
              .array(z.string())
              .describe('The list of app `slug`s with dismissal access')
              .optional()
          })
          .describe(
            'Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.'
          )
          .optional(),
        dismiss_stale_reviews: z
          .boolean()
          .describe(
            'Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.'
          )
          .optional(),
        require_code_owner_reviews: z
          .boolean()
          .describe(
            'Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.'
          )
          .optional(),
        required_approving_review_count: z
          .number()
          .int()
          .describe(
            'Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.'
          )
          .optional(),
        require_last_push_approval: z
          .boolean()
          .describe(
            'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.'
          )
          .default(false),
        bypass_pull_request_allowances: z
          .object({
            users: z
              .array(z.string())
              .describe(
                'The list of user `login`s allowed to bypass pull request requirements.'
              )
              .optional(),
            teams: z
              .array(z.string())
              .describe(
                'The list of team `slug`s allowed to bypass pull request requirements.'
              )
              .optional(),
            apps: z
              .array(z.string())
              .describe(
                'The list of app `slug`s allowed to bypass pull request requirements.'
              )
              .optional()
          })
          .describe(
            'Allow specific users, teams, or apps to bypass pull request requirements.'
          )
          .optional()
      })
      .describe(
        'Require at least one approving review on a pull request, before merging. Set to `null` to disable.'
      ),
    restrictions: z
      .object({
        users: z
          .array(z.string())
          .describe('The list of user `login`s with push access'),
        teams: z
          .array(z.string())
          .describe('The list of team `slug`s with push access'),
        apps: z
          .array(z.string())
          .describe('The list of app `slug`s with push access')
          .optional()
      })
      .describe(
        'Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.'
      ),
    required_linear_history: z
      .boolean()
      .describe(
        'Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.'
      )
      .optional(),
    allow_force_pushes: z
      .boolean()
      .describe(
        'Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."'
      )
      .optional(),
    allow_deletions: z
      .boolean()
      .describe(
        'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.'
      )
      .optional(),
    block_creations: z
      .boolean()
      .describe(
        'If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.'
      )
      .optional(),
    required_conversation_resolution: z
      .boolean()
      .describe(
        'Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.'
      )
      .optional(),
    lock_branch: z
      .boolean()
      .describe(
        'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.'
      )
      .default(false),
    allow_fork_syncing: z
      .boolean()
      .describe(
        'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.'
      )
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposUpdateBranchProtectionParams = z.infer<
    typeof ReposUpdateBranchProtectionParamsSchema
  >

  export const ReposUpdateBranchProtectionResponseSchema = ProtectedBranchSchema
  export type ReposUpdateBranchProtectionResponse = z.infer<
    typeof ReposUpdateBranchProtectionResponseSchema
  >

  export const ReposDeleteBranchProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposDeleteBranchProtectionParams = z.infer<
    typeof ReposDeleteBranchProtectionParamsSchema
  >

  export type ReposDeleteBranchProtectionResponse = undefined

  export const ReposGetAdminBranchProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetAdminBranchProtectionParams = z.infer<
    typeof ReposGetAdminBranchProtectionParamsSchema
  >

  export const ReposGetAdminBranchProtectionResponseSchema =
    ProtectedBranchAdminEnforcedSchema
  export type ReposGetAdminBranchProtectionResponse = z.infer<
    typeof ReposGetAdminBranchProtectionResponseSchema
  >

  export const ReposSetAdminBranchProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposSetAdminBranchProtectionParams = z.infer<
    typeof ReposSetAdminBranchProtectionParamsSchema
  >

  export const ReposSetAdminBranchProtectionResponseSchema =
    ProtectedBranchAdminEnforcedSchema
  export type ReposSetAdminBranchProtectionResponse = z.infer<
    typeof ReposSetAdminBranchProtectionResponseSchema
  >

  export const ReposDeleteAdminBranchProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposDeleteAdminBranchProtectionParams = z.infer<
    typeof ReposDeleteAdminBranchProtectionParamsSchema
  >

  export type ReposDeleteAdminBranchProtectionResponse = undefined

  export const ReposGetPullRequestReviewProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetPullRequestReviewProtectionParams = z.infer<
    typeof ReposGetPullRequestReviewProtectionParamsSchema
  >

  export const ReposGetPullRequestReviewProtectionResponseSchema =
    ProtectedBranchPullRequestReviewSchema
  export type ReposGetPullRequestReviewProtectionResponse = z.infer<
    typeof ReposGetPullRequestReviewProtectionResponseSchema
  >

  export const ReposDeletePullRequestReviewProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposDeletePullRequestReviewProtectionParams = z.infer<
    typeof ReposDeletePullRequestReviewProtectionParamsSchema
  >

  export type ReposDeletePullRequestReviewProtectionResponse = undefined

  export const ReposUpdatePullRequestReviewProtectionParamsSchema = z.object({
    dismissal_restrictions: z
      .object({
        users: z
          .array(z.string())
          .describe('The list of user `login`s with dismissal access')
          .optional(),
        teams: z
          .array(z.string())
          .describe('The list of team `slug`s with dismissal access')
          .optional(),
        apps: z
          .array(z.string())
          .describe('The list of app `slug`s with dismissal access')
          .optional()
      })
      .describe(
        'Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.'
      )
      .optional(),
    dismiss_stale_reviews: z
      .boolean()
      .describe(
        'Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.'
      )
      .optional(),
    require_code_owner_reviews: z
      .boolean()
      .describe(
        'Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.'
      )
      .optional(),
    required_approving_review_count: z
      .number()
      .int()
      .describe(
        'Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.'
      )
      .optional(),
    require_last_push_approval: z
      .boolean()
      .describe(
        'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`'
      )
      .default(false),
    bypass_pull_request_allowances: z
      .object({
        users: z
          .array(z.string())
          .describe(
            'The list of user `login`s allowed to bypass pull request requirements.'
          )
          .optional(),
        teams: z
          .array(z.string())
          .describe(
            'The list of team `slug`s allowed to bypass pull request requirements.'
          )
          .optional(),
        apps: z
          .array(z.string())
          .describe(
            'The list of app `slug`s allowed to bypass pull request requirements.'
          )
          .optional()
      })
      .describe(
        'Allow specific users, teams, or apps to bypass pull request requirements.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposUpdatePullRequestReviewProtectionParams = z.infer<
    typeof ReposUpdatePullRequestReviewProtectionParamsSchema
  >

  export const ReposUpdatePullRequestReviewProtectionResponseSchema =
    ProtectedBranchPullRequestReviewSchema
  export type ReposUpdatePullRequestReviewProtectionResponse = z.infer<
    typeof ReposUpdatePullRequestReviewProtectionResponseSchema
  >

  export const ReposGetCommitSignatureProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetCommitSignatureProtectionParams = z.infer<
    typeof ReposGetCommitSignatureProtectionParamsSchema
  >

  export const ReposGetCommitSignatureProtectionResponseSchema =
    ProtectedBranchAdminEnforcedSchema
  export type ReposGetCommitSignatureProtectionResponse = z.infer<
    typeof ReposGetCommitSignatureProtectionResponseSchema
  >

  export const ReposCreateCommitSignatureProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposCreateCommitSignatureProtectionParams = z.infer<
    typeof ReposCreateCommitSignatureProtectionParamsSchema
  >

  export const ReposCreateCommitSignatureProtectionResponseSchema =
    ProtectedBranchAdminEnforcedSchema
  export type ReposCreateCommitSignatureProtectionResponse = z.infer<
    typeof ReposCreateCommitSignatureProtectionResponseSchema
  >

  export const ReposDeleteCommitSignatureProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposDeleteCommitSignatureProtectionParams = z.infer<
    typeof ReposDeleteCommitSignatureProtectionParamsSchema
  >

  export type ReposDeleteCommitSignatureProtectionResponse = undefined

  export const ReposGetStatusChecksProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetStatusChecksProtectionParams = z.infer<
    typeof ReposGetStatusChecksProtectionParamsSchema
  >

  export const ReposGetStatusChecksProtectionResponseSchema =
    StatusCheckPolicySchema
  export type ReposGetStatusChecksProtectionResponse = z.infer<
    typeof ReposGetStatusChecksProtectionResponseSchema
  >

  export const ReposRemoveStatusCheckProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposRemoveStatusCheckProtectionParams = z.infer<
    typeof ReposRemoveStatusCheckProtectionParamsSchema
  >

  export type ReposRemoveStatusCheckProtectionResponse = undefined

  export const ReposUpdateStatusCheckProtectionParamsSchema = z.object({
    strict: z
      .boolean()
      .describe('Require branches to be up to date before merging.')
      .optional(),
    contexts: z
      .array(z.string())
      .describe(
        '**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.'
      )
      .optional(),
    checks: z
      .array(
        z.object({
          context: z.string().describe('The name of the required check'),
          app_id: z
            .number()
            .int()
            .describe(
              'The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.'
            )
            .optional()
        })
      )
      .describe(
        'The list of status checks to require in order to merge into this branch.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposUpdateStatusCheckProtectionParams = z.infer<
    typeof ReposUpdateStatusCheckProtectionParamsSchema
  >

  export const ReposUpdateStatusCheckProtectionResponseSchema =
    StatusCheckPolicySchema
  export type ReposUpdateStatusCheckProtectionResponse = z.infer<
    typeof ReposUpdateStatusCheckProtectionResponseSchema
  >

  export const ReposGetAllStatusCheckContextsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetAllStatusCheckContextsParams = z.infer<
    typeof ReposGetAllStatusCheckContextsParamsSchema
  >

  export const ReposGetAllStatusCheckContextsResponseSchema = z.array(
    z.string()
  )
  export type ReposGetAllStatusCheckContextsResponse = z.infer<
    typeof ReposGetAllStatusCheckContextsResponseSchema
  >

  export const ReposAddStatusCheckContextsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          contexts: z
            .array(z.string())
            .describe('The name of the status checks')
        }),
        z.array(z.string()).describe('The name of the status checks')
      ])
    )
  export type ReposAddStatusCheckContextsParams = z.infer<
    typeof ReposAddStatusCheckContextsParamsSchema
  >

  export const ReposAddStatusCheckContextsResponseSchema = z.array(z.string())
  export type ReposAddStatusCheckContextsResponse = z.infer<
    typeof ReposAddStatusCheckContextsResponseSchema
  >

  export const ReposSetStatusCheckContextsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          contexts: z
            .array(z.string())
            .describe('The name of the status checks')
        }),
        z.array(z.string()).describe('The name of the status checks')
      ])
    )
  export type ReposSetStatusCheckContextsParams = z.infer<
    typeof ReposSetStatusCheckContextsParamsSchema
  >

  export const ReposSetStatusCheckContextsResponseSchema = z.array(z.string())
  export type ReposSetStatusCheckContextsResponse = z.infer<
    typeof ReposSetStatusCheckContextsResponseSchema
  >

  export const ReposRemoveStatusCheckContextsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          contexts: z
            .array(z.string())
            .describe('The name of the status checks')
        }),
        z.array(z.string()).describe('The name of the status checks')
      ])
    )
  export type ReposRemoveStatusCheckContextsParams = z.infer<
    typeof ReposRemoveStatusCheckContextsParamsSchema
  >

  export const ReposRemoveStatusCheckContextsResponseSchema = z.array(
    z.string()
  )
  export type ReposRemoveStatusCheckContextsResponse = z.infer<
    typeof ReposRemoveStatusCheckContextsResponseSchema
  >

  export const ReposGetAccessRestrictionsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetAccessRestrictionsParams = z.infer<
    typeof ReposGetAccessRestrictionsParamsSchema
  >

  export const ReposGetAccessRestrictionsResponseSchema =
    BranchRestrictionPolicySchema
  export type ReposGetAccessRestrictionsResponse = z.infer<
    typeof ReposGetAccessRestrictionsResponseSchema
  >

  export const ReposDeleteAccessRestrictionsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposDeleteAccessRestrictionsParams = z.infer<
    typeof ReposDeleteAccessRestrictionsParamsSchema
  >

  export type ReposDeleteAccessRestrictionsResponse = undefined

  export const ReposGetAppsWithAccessToProtectedBranchParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetAppsWithAccessToProtectedBranchParams = z.infer<
    typeof ReposGetAppsWithAccessToProtectedBranchParamsSchema
  >

  export const ReposGetAppsWithAccessToProtectedBranchResponseSchema =
    z.array(IntegrationSchema)
  export type ReposGetAppsWithAccessToProtectedBranchResponse = z.infer<
    typeof ReposGetAppsWithAccessToProtectedBranchResponseSchema
  >

  export const ReposAddAppAccessRestrictionsParamsSchema = z.object({
    apps: z
      .array(z.string())
      .describe(
        'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposAddAppAccessRestrictionsParams = z.infer<
    typeof ReposAddAppAccessRestrictionsParamsSchema
  >

  export const ReposAddAppAccessRestrictionsResponseSchema =
    z.array(IntegrationSchema)
  export type ReposAddAppAccessRestrictionsResponse = z.infer<
    typeof ReposAddAppAccessRestrictionsResponseSchema
  >

  export const ReposSetAppAccessRestrictionsParamsSchema = z.object({
    apps: z
      .array(z.string())
      .describe(
        'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposSetAppAccessRestrictionsParams = z.infer<
    typeof ReposSetAppAccessRestrictionsParamsSchema
  >

  export const ReposSetAppAccessRestrictionsResponseSchema =
    z.array(IntegrationSchema)
  export type ReposSetAppAccessRestrictionsResponse = z.infer<
    typeof ReposSetAppAccessRestrictionsResponseSchema
  >

  export const ReposRemoveAppAccessRestrictionsParamsSchema = z.object({
    apps: z
      .array(z.string())
      .describe(
        'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposRemoveAppAccessRestrictionsParams = z.infer<
    typeof ReposRemoveAppAccessRestrictionsParamsSchema
  >

  export const ReposRemoveAppAccessRestrictionsResponseSchema =
    z.array(IntegrationSchema)
  export type ReposRemoveAppAccessRestrictionsResponse = z.infer<
    typeof ReposRemoveAppAccessRestrictionsResponseSchema
  >

  export const ReposGetTeamsWithAccessToProtectedBranchParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetTeamsWithAccessToProtectedBranchParams = z.infer<
    typeof ReposGetTeamsWithAccessToProtectedBranchParamsSchema
  >

  export const ReposGetTeamsWithAccessToProtectedBranchResponseSchema =
    z.array(TeamSchema)
  export type ReposGetTeamsWithAccessToProtectedBranchResponse = z.infer<
    typeof ReposGetTeamsWithAccessToProtectedBranchResponseSchema
  >

  export const ReposAddTeamAccessRestrictionsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          teams: z.array(z.string()).describe('The slug values for teams')
        }),
        z.array(z.string()).describe('The slug values for teams')
      ])
    )
  export type ReposAddTeamAccessRestrictionsParams = z.infer<
    typeof ReposAddTeamAccessRestrictionsParamsSchema
  >

  export const ReposAddTeamAccessRestrictionsResponseSchema =
    z.array(TeamSchema)
  export type ReposAddTeamAccessRestrictionsResponse = z.infer<
    typeof ReposAddTeamAccessRestrictionsResponseSchema
  >

  export const ReposSetTeamAccessRestrictionsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          teams: z.array(z.string()).describe('The slug values for teams')
        }),
        z.array(z.string()).describe('The slug values for teams')
      ])
    )
  export type ReposSetTeamAccessRestrictionsParams = z.infer<
    typeof ReposSetTeamAccessRestrictionsParamsSchema
  >

  export const ReposSetTeamAccessRestrictionsResponseSchema =
    z.array(TeamSchema)
  export type ReposSetTeamAccessRestrictionsResponse = z.infer<
    typeof ReposSetTeamAccessRestrictionsResponseSchema
  >

  export const ReposRemoveTeamAccessRestrictionsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      branch: z
        .string()
        .describe(
          'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
        )
    })
    .and(
      z.union([
        z.object({
          teams: z.array(z.string()).describe('The slug values for teams')
        }),
        z.array(z.string()).describe('The slug values for teams')
      ])
    )
  export type ReposRemoveTeamAccessRestrictionsParams = z.infer<
    typeof ReposRemoveTeamAccessRestrictionsParamsSchema
  >

  export const ReposRemoveTeamAccessRestrictionsResponseSchema =
    z.array(TeamSchema)
  export type ReposRemoveTeamAccessRestrictionsResponse = z.infer<
    typeof ReposRemoveTeamAccessRestrictionsResponseSchema
  >

  export const ReposGetUsersWithAccessToProtectedBranchParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposGetUsersWithAccessToProtectedBranchParams = z.infer<
    typeof ReposGetUsersWithAccessToProtectedBranchParamsSchema
  >

  export const ReposGetUsersWithAccessToProtectedBranchResponseSchema =
    z.array(SimpleUserSchema)
  export type ReposGetUsersWithAccessToProtectedBranchResponse = z.infer<
    typeof ReposGetUsersWithAccessToProtectedBranchResponseSchema
  >

  export const ReposAddUserAccessRestrictionsParamsSchema = z.object({
    users: z.array(z.string()).describe('The username for users'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposAddUserAccessRestrictionsParams = z.infer<
    typeof ReposAddUserAccessRestrictionsParamsSchema
  >

  export const ReposAddUserAccessRestrictionsResponseSchema =
    z.array(SimpleUserSchema)
  export type ReposAddUserAccessRestrictionsResponse = z.infer<
    typeof ReposAddUserAccessRestrictionsResponseSchema
  >

  export const ReposSetUserAccessRestrictionsParamsSchema = z.object({
    users: z.array(z.string()).describe('The username for users'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposSetUserAccessRestrictionsParams = z.infer<
    typeof ReposSetUserAccessRestrictionsParamsSchema
  >

  export const ReposSetUserAccessRestrictionsResponseSchema =
    z.array(SimpleUserSchema)
  export type ReposSetUserAccessRestrictionsResponse = z.infer<
    typeof ReposSetUserAccessRestrictionsResponseSchema
  >

  export const ReposRemoveUserAccessRestrictionsParamsSchema = z.object({
    users: z.array(z.string()).describe('The username for users'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposRemoveUserAccessRestrictionsParams = z.infer<
    typeof ReposRemoveUserAccessRestrictionsParamsSchema
  >

  export const ReposRemoveUserAccessRestrictionsResponseSchema =
    z.array(SimpleUserSchema)
  export type ReposRemoveUserAccessRestrictionsResponse = z.infer<
    typeof ReposRemoveUserAccessRestrictionsResponseSchema
  >

  export const ReposRenameBranchParamsSchema = z.object({
    new_name: z.string().describe('The new name of the branch.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      )
  })
  export type ReposRenameBranchParams = z.infer<
    typeof ReposRenameBranchParamsSchema
  >

  export type ReposRenameBranchResponse = undefined

  export const ChecksCreateParamsSchema = z
    .object({
      name: z
        .string()
        .describe('The name of the check. For example, "code-coverage".'),
      head_sha: z.string().describe('The SHA of the commit.'),
      details_url: z
        .string()
        .describe(
          "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used."
        )
        .optional(),
      external_id: z
        .string()
        .describe("A reference for the run on the integrator's system.")
        .optional(),
      status: z
        .enum([
          'queued',
          'in_progress',
          'completed',
          'waiting',
          'requested',
          'pending'
        ])
        .describe(
          'The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.'
        )
        .default('queued'),
      started_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      conclusion: z
        .enum([
          'action_required',
          'cancelled',
          'failure',
          'neutral',
          'success',
          'skipped',
          'stale',
          'timed_out'
        ])
        .describe(
          '**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.'
        )
        .optional(),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      output: z
        .object({
          title: z.string().describe('The title of the check run.'),
          summary: z
            .string()
            .max(65_535)
            .describe(
              'The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.'
            ),
          text: z
            .string()
            .max(65_535)
            .describe(
              'The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.'
            )
            .optional(),
          annotations: z
            .array(
              z.object({
                path: z
                  .string()
                  .describe(
                    'The path of the file to add an annotation to. For example, `assets/css/main.css`.'
                  ),
                start_line: z
                  .number()
                  .int()
                  .describe(
                    'The start line of the annotation. Line numbers start at 1.'
                  ),
                end_line: z
                  .number()
                  .int()
                  .describe('The end line of the annotation.'),
                start_column: z
                  .number()
                  .int()
                  .describe(
                    'The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.'
                  )
                  .optional(),
                end_column: z
                  .number()
                  .int()
                  .describe(
                    'The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.'
                  )
                  .optional(),
                annotation_level: z
                  .enum(['notice', 'warning', 'failure'])
                  .describe('The level of the annotation.'),
                message: z
                  .string()
                  .describe(
                    'A short description of the feedback for these lines of code. The maximum size is 64 KB.'
                  ),
                title: z
                  .string()
                  .describe(
                    'The title that represents the annotation. The maximum size is 255 characters.'
                  )
                  .optional(),
                raw_details: z
                  .string()
                  .describe(
                    'Details about this annotation. The maximum size is 64 KB.'
                  )
                  .optional()
              })
            )
            .max(50)
            .describe(
              'Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".'
            )
            .optional(),
          images: z
            .array(
              z.object({
                alt: z.string().describe('The alternative text for the image.'),
                image_url: z.string().describe('The full URL of the image.'),
                caption: z
                  .string()
                  .describe('A short image description.')
                  .optional()
              })
            )
            .describe(
              'Adds images to the output displayed in the GitHub pull request UI.'
            )
            .optional()
        })
        .describe(
          'Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.'
        )
        .optional(),
      actions: z
        .array(
          z.object({
            label: z
              .string()
              .max(20)
              .describe(
                'The text to be displayed on a button in the web UI. The maximum size is 20 characters.'
              ),
            description: z
              .string()
              .max(40)
              .describe(
                'A short explanation of what this action would do. The maximum size is 40 characters.'
              ),
            identifier: z
              .string()
              .max(20)
              .describe(
                "A reference for the action on the integrator's system. The maximum size is 20 characters."
              )
          })
        )
        .max(3)
        .describe(
          'Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)."'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .and(
      z.union([
        z.object({ status: z.literal('completed') }).catchall(z.any()),
        z
          .object({ status: z.enum(['queued', 'in_progress']).optional() })
          .catchall(z.any())
      ])
    )
  export type ChecksCreateParams = z.infer<typeof ChecksCreateParamsSchema>

  export type ChecksCreateResponse = undefined

  export const ChecksGetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_run_id: z
      .number()
      .int()
      .describe('The unique identifier of the check run.')
  })
  export type ChecksGetParams = z.infer<typeof ChecksGetParamsSchema>

  export const ChecksGetResponseSchema = CheckRunSchema
  export type ChecksGetResponse = z.infer<typeof ChecksGetResponseSchema>

  export const ChecksUpdateParamsSchema = z
    .object({
      name: z
        .string()
        .describe('The name of the check. For example, "code-coverage".')
        .optional(),
      details_url: z
        .string()
        .describe(
          "The URL of the integrator's site that has the full details of the check."
        )
        .optional(),
      external_id: z
        .string()
        .describe("A reference for the run on the integrator's system.")
        .optional(),
      started_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      status: z
        .enum([
          'queued',
          'in_progress',
          'completed',
          'waiting',
          'requested',
          'pending'
        ])
        .describe(
          'The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.'
        )
        .optional(),
      conclusion: z
        .enum([
          'action_required',
          'cancelled',
          'failure',
          'neutral',
          'success',
          'skipped',
          'stale',
          'timed_out'
        ])
        .describe(
          '**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.'
        )
        .optional(),
      completed_at: z
        .string()
        .datetime({ offset: true })
        .describe(
          'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      output: z
        .object({
          title: z.string().describe('**Required**.').optional(),
          summary: z.string().max(65_535).describe('Can contain Markdown.'),
          text: z
            .string()
            .max(65_535)
            .describe('Can contain Markdown.')
            .optional(),
          annotations: z
            .array(
              z.object({
                path: z
                  .string()
                  .describe(
                    'The path of the file to add an annotation to. For example, `assets/css/main.css`.'
                  ),
                start_line: z
                  .number()
                  .int()
                  .describe(
                    'The start line of the annotation. Line numbers start at 1.'
                  ),
                end_line: z
                  .number()
                  .int()
                  .describe('The end line of the annotation.'),
                start_column: z
                  .number()
                  .int()
                  .describe(
                    'The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.'
                  )
                  .optional(),
                end_column: z
                  .number()
                  .int()
                  .describe(
                    'The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.'
                  )
                  .optional(),
                annotation_level: z
                  .enum(['notice', 'warning', 'failure'])
                  .describe('The level of the annotation.'),
                message: z
                  .string()
                  .describe(
                    'A short description of the feedback for these lines of code. The maximum size is 64 KB.'
                  ),
                title: z
                  .string()
                  .describe(
                    'The title that represents the annotation. The maximum size is 255 characters.'
                  )
                  .optional(),
                raw_details: z
                  .string()
                  .describe(
                    'Details about this annotation. The maximum size is 64 KB.'
                  )
                  .optional()
              })
            )
            .max(50)
            .describe(
              'Adds information from your analysis to specific lines of code. Annotations are visible in GitHub\'s pull request UI. Annotations are visible in GitHub\'s pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)".'
            )
            .optional(),
          images: z
            .array(
              z.object({
                alt: z.string().describe('The alternative text for the image.'),
                image_url: z.string().describe('The full URL of the image.'),
                caption: z
                  .string()
                  .describe('A short image description.')
                  .optional()
              })
            )
            .describe(
              'Adds images to the output displayed in the GitHub pull request UI.'
            )
            .optional()
        })
        .describe(
          'Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.'
        )
        .optional(),
      actions: z
        .array(
          z.object({
            label: z
              .string()
              .max(20)
              .describe(
                'The text to be displayed on a button in the web UI. The maximum size is 20 characters.'
              ),
            description: z
              .string()
              .max(40)
              .describe(
                'A short explanation of what this action would do. The maximum size is 40 characters.'
              ),
            identifier: z
              .string()
              .max(20)
              .describe(
                "A reference for the action on the integrator's system. The maximum size is 20 characters."
              )
          })
        )
        .max(3)
        .describe(
          'Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)."'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      check_run_id: z
        .number()
        .int()
        .describe('The unique identifier of the check run.')
    })
    .and(
      z.union([
        z
          .object({ status: z.literal('completed').optional() })
          .catchall(z.any()),
        z
          .object({ status: z.enum(['queued', 'in_progress']).optional() })
          .catchall(z.any())
      ])
    )
  export type ChecksUpdateParams = z.infer<typeof ChecksUpdateParamsSchema>

  export const ChecksUpdateResponseSchema = CheckRunSchema
  export type ChecksUpdateResponse = z.infer<typeof ChecksUpdateResponseSchema>

  export const ChecksListAnnotationsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_run_id: z
      .number()
      .int()
      .describe('The unique identifier of the check run.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ChecksListAnnotationsParams = z.infer<
    typeof ChecksListAnnotationsParamsSchema
  >

  export const ChecksListAnnotationsResponseSchema = z.array(
    CheckAnnotationSchema
  )
  export type ChecksListAnnotationsResponse = z.infer<
    typeof ChecksListAnnotationsResponseSchema
  >

  export const ChecksRerequestRunParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_run_id: z
      .number()
      .int()
      .describe('The unique identifier of the check run.')
  })
  export type ChecksRerequestRunParams = z.infer<
    typeof ChecksRerequestRunParamsSchema
  >

  export type ChecksRerequestRunResponse = undefined

  export const ChecksCreateSuiteParamsSchema = z.object({
    head_sha: z.string().describe('The sha of the head commit.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ChecksCreateSuiteParams = z.infer<
    typeof ChecksCreateSuiteParamsSchema
  >

  export const ChecksCreateSuiteResponseSchema = CheckSuiteSchema
  export type ChecksCreateSuiteResponse = z.infer<
    typeof ChecksCreateSuiteResponseSchema
  >

  export const ChecksSetSuitesPreferencesParamsSchema = z.object({
    auto_trigger_checks: z
      .array(
        z.object({
          app_id: z.number().int().describe('The `id` of the GitHub App.'),
          setting: z
            .boolean()
            .describe(
              'Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.'
            )
            .default(true)
        })
      )
      .describe(
        'Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ChecksSetSuitesPreferencesParams = z.infer<
    typeof ChecksSetSuitesPreferencesParamsSchema
  >

  export const ChecksSetSuitesPreferencesResponseSchema =
    CheckSuitePreferenceSchema
  export type ChecksSetSuitesPreferencesResponse = z.infer<
    typeof ChecksSetSuitesPreferencesResponseSchema
  >

  export const ChecksGetSuiteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_suite_id: z
      .number()
      .int()
      .describe('The unique identifier of the check suite.')
  })
  export type ChecksGetSuiteParams = z.infer<typeof ChecksGetSuiteParamsSchema>

  export const ChecksGetSuiteResponseSchema = CheckSuiteSchema
  export type ChecksGetSuiteResponse = z.infer<
    typeof ChecksGetSuiteResponseSchema
  >

  export const ChecksListForSuiteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_suite_id: z
      .number()
      .int()
      .describe('The unique identifier of the check suite.'),
    check_name: z
      .string()
      .describe('Returns check runs with the specified `name`.')
      .optional(),
    status: z
      .enum(['queued', 'in_progress', 'completed'])
      .describe('Returns check runs with the specified `status`.')
      .optional(),
    filter: z
      .enum(['latest', 'all'])
      .describe(
        'Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.'
      )
      .default('latest'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ChecksListForSuiteParams = z.infer<
    typeof ChecksListForSuiteParamsSchema
  >

  export const ChecksListForSuiteResponseSchema = z.object({
    total_count: z.number().int(),
    check_runs: z.array(CheckRunSchema)
  })
  export type ChecksListForSuiteResponse = z.infer<
    typeof ChecksListForSuiteResponseSchema
  >

  export const ChecksRerequestSuiteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    check_suite_id: z
      .number()
      .int()
      .describe('The unique identifier of the check suite.')
  })
  export type ChecksRerequestSuiteParams = z.infer<
    typeof ChecksRerequestSuiteParamsSchema
  >

  export type ChecksRerequestSuiteResponse = undefined

  export const CodeScanningListAlertsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tool_name: z
      .any()
      .describe(
        'The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.'
      )
      .optional(),
    tool_guid: z
      .any()
      .describe(
        'The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    ref: z
      .any()
      .describe(
        'The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional(),
    pr: z
      .number()
      .int()
      .describe(
        'The number of the pull request for the results you want to list.'
      )
      .optional(),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property by which to sort the results.')
      .default('created'),
    state: z
      .any()
      .describe(
        'If specified, only code scanning alerts with this state will be returned.'
      )
      .optional(),
    severity: z
      .any()
      .describe(
        'If specified, only code scanning alerts with this severity will be returned.'
      )
      .optional()
  })
  export type CodeScanningListAlertsForRepoParams = z.infer<
    typeof CodeScanningListAlertsForRepoParamsSchema
  >

  export const CodeScanningListAlertsForRepoResponseSchema = z.array(
    CodeScanningAlertItemsSchema
  )
  export type CodeScanningListAlertsForRepoResponse = z.infer<
    typeof CodeScanningListAlertsForRepoResponseSchema
  >

  export const CodeScanningGetAlertParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type CodeScanningGetAlertParams = z.infer<
    typeof CodeScanningGetAlertParamsSchema
  >

  export const CodeScanningGetAlertResponseSchema = CodeScanningAlertSchema
  export type CodeScanningGetAlertResponse = z.infer<
    typeof CodeScanningGetAlertResponseSchema
  >

  export const CodeScanningUpdateAlertParamsSchema = z.object({
    state: CodeScanningAlertSetStateSchema,
    dismissed_reason: CodeScanningAlertDismissedReasonSchema.optional(),
    dismissed_comment: CodeScanningAlertDismissedCommentSchema.optional(),
    create_request: CodeScanningAlertCreateRequestSchema.optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type CodeScanningUpdateAlertParams = z.infer<
    typeof CodeScanningUpdateAlertParamsSchema
  >

  export const CodeScanningUpdateAlertResponseSchema = CodeScanningAlertSchema
  export type CodeScanningUpdateAlertResponse = z.infer<
    typeof CodeScanningUpdateAlertResponseSchema
  >

  export const CodeScanningGetAutofixParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type CodeScanningGetAutofixParams = z.infer<
    typeof CodeScanningGetAutofixParamsSchema
  >

  export const CodeScanningGetAutofixResponseSchema = CodeScanningAutofixSchema
  export type CodeScanningGetAutofixResponse = z.infer<
    typeof CodeScanningGetAutofixResponseSchema
  >

  export const CodeScanningCreateAutofixParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type CodeScanningCreateAutofixParams = z.infer<
    typeof CodeScanningCreateAutofixParamsSchema
  >

  export const CodeScanningCreateAutofixResponseSchema =
    CodeScanningAutofixSchema
  export type CodeScanningCreateAutofixResponse = z.infer<
    typeof CodeScanningCreateAutofixResponseSchema
  >

  export const CodeScanningCommitAutofixParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      alert_number: z
        .any()
        .describe(
          'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
        )
    })
    .merge(CodeScanningAutofixCommitsSchema)
  export type CodeScanningCommitAutofixParams = z.infer<
    typeof CodeScanningCommitAutofixParamsSchema
  >

  export type CodeScanningCommitAutofixResponse = undefined

  export const CodeScanningListAlertInstancesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      ),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    ref: z
      .any()
      .describe(
        'The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional(),
    pr: z
      .number()
      .int()
      .describe(
        'The number of the pull request for the results you want to list.'
      )
      .optional()
  })
  export type CodeScanningListAlertInstancesParams = z.infer<
    typeof CodeScanningListAlertInstancesParamsSchema
  >

  export const CodeScanningListAlertInstancesResponseSchema = z.array(
    CodeScanningAlertInstanceSchema
  )
  export type CodeScanningListAlertInstancesResponse = z.infer<
    typeof CodeScanningListAlertInstancesResponseSchema
  >

  export const CodeScanningListRecentAnalysesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tool_name: z
      .any()
      .describe(
        'The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.'
      )
      .optional(),
    tool_guid: z
      .any()
      .describe(
        'The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    pr: z
      .number()
      .int()
      .describe(
        'The number of the pull request for the results you want to list.'
      )
      .optional(),
    ref: z
      .any()
      .describe(
        'The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional(),
    sarif_id: z
      .any()
      .describe('Filter analyses belonging to the same SARIF upload.')
      .optional(),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    sort: z
      .literal('created')
      .describe('The property by which to sort the results.')
      .default('created')
  })
  export type CodeScanningListRecentAnalysesParams = z.infer<
    typeof CodeScanningListRecentAnalysesParamsSchema
  >

  export const CodeScanningListRecentAnalysesResponseSchema = z.array(
    CodeScanningAnalysisSchema
  )
  export type CodeScanningListRecentAnalysesResponse = z.infer<
    typeof CodeScanningListRecentAnalysesResponseSchema
  >

  export const CodeScanningGetAnalysisParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    analysis_id: z
      .number()
      .int()
      .describe(
        'The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.'
      )
  })
  export type CodeScanningGetAnalysisParams = z.infer<
    typeof CodeScanningGetAnalysisParamsSchema
  >

  export const CodeScanningGetAnalysisResponseSchema =
    CodeScanningAnalysisSchema
  export type CodeScanningGetAnalysisResponse = z.infer<
    typeof CodeScanningGetAnalysisResponseSchema
  >

  export const CodeScanningDeleteAnalysisParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    analysis_id: z
      .number()
      .int()
      .describe(
        'The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.'
      ),
    confirm_delete: z
      .union([z.string(), z.null()])
      .describe(
        "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`"
      )
      .optional()
  })
  export type CodeScanningDeleteAnalysisParams = z.infer<
    typeof CodeScanningDeleteAnalysisParamsSchema
  >

  export const CodeScanningDeleteAnalysisResponseSchema =
    CodeScanningAnalysisDeletionSchema
  export type CodeScanningDeleteAnalysisResponse = z.infer<
    typeof CodeScanningDeleteAnalysisResponseSchema
  >

  export const CodeScanningListCodeqlDatabasesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type CodeScanningListCodeqlDatabasesParams = z.infer<
    typeof CodeScanningListCodeqlDatabasesParamsSchema
  >

  export const CodeScanningListCodeqlDatabasesResponseSchema = z.array(
    CodeScanningCodeqlDatabaseSchema
  )
  export type CodeScanningListCodeqlDatabasesResponse = z.infer<
    typeof CodeScanningListCodeqlDatabasesResponseSchema
  >

  export const CodeScanningGetCodeqlDatabaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    language: z.string().describe('The language of the CodeQL database.')
  })
  export type CodeScanningGetCodeqlDatabaseParams = z.infer<
    typeof CodeScanningGetCodeqlDatabaseParamsSchema
  >

  export const CodeScanningGetCodeqlDatabaseResponseSchema =
    CodeScanningCodeqlDatabaseSchema
  export type CodeScanningGetCodeqlDatabaseResponse = z.infer<
    typeof CodeScanningGetCodeqlDatabaseResponseSchema
  >

  export const CodeScanningDeleteCodeqlDatabaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    language: z.string().describe('The language of the CodeQL database.')
  })
  export type CodeScanningDeleteCodeqlDatabaseParams = z.infer<
    typeof CodeScanningDeleteCodeqlDatabaseParamsSchema
  >

  export type CodeScanningDeleteCodeqlDatabaseResponse = undefined

  export const CodeScanningCreateVariantAnalysisParamsSchema = z
    .object({
      language: CodeScanningVariantAnalysisLanguageSchema,
      query_pack: z
        .string()
        .describe(
          'A Base64-encoded tarball containing a CodeQL query and all its dependencies'
        ),
      repositories: z
        .array(z.string())
        .describe(
          'List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.'
        )
        .optional(),
      repository_lists: z
        .array(z.string())
        .max(1)
        .describe(
          'List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.'
        )
        .optional(),
      repository_owners: z
        .array(z.string())
        .max(1)
        .describe(
          'List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .and(z.union([z.any(), z.any(), z.any()]))
  export type CodeScanningCreateVariantAnalysisParams = z.infer<
    typeof CodeScanningCreateVariantAnalysisParamsSchema
  >

  export type CodeScanningCreateVariantAnalysisResponse = undefined

  export const CodeScanningGetVariantAnalysisParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    codeql_variant_analysis_id: z
      .number()
      .int()
      .describe('The unique identifier of the variant analysis.')
  })
  export type CodeScanningGetVariantAnalysisParams = z.infer<
    typeof CodeScanningGetVariantAnalysisParamsSchema
  >

  export const CodeScanningGetVariantAnalysisResponseSchema =
    CodeScanningVariantAnalysisSchema
  export type CodeScanningGetVariantAnalysisResponse = z.infer<
    typeof CodeScanningGetVariantAnalysisResponseSchema
  >

  export const CodeScanningGetVariantAnalysisRepoTaskParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z.string().describe('The name of the controller repository.'),
    codeql_variant_analysis_id: z
      .number()
      .int()
      .describe('The ID of the variant analysis.'),
    repo_owner: z
      .string()
      .describe(
        'The account owner of the variant analysis repository. The name is not case sensitive.'
      ),
    repo_name: z
      .string()
      .describe('The name of the variant analysis repository.')
  })
  export type CodeScanningGetVariantAnalysisRepoTaskParams = z.infer<
    typeof CodeScanningGetVariantAnalysisRepoTaskParamsSchema
  >

  export const CodeScanningGetVariantAnalysisRepoTaskResponseSchema =
    CodeScanningVariantAnalysisRepoTaskSchema
  export type CodeScanningGetVariantAnalysisRepoTaskResponse = z.infer<
    typeof CodeScanningGetVariantAnalysisRepoTaskResponseSchema
  >

  export const CodeScanningGetDefaultSetupParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type CodeScanningGetDefaultSetupParams = z.infer<
    typeof CodeScanningGetDefaultSetupParamsSchema
  >

  export const CodeScanningGetDefaultSetupResponseSchema =
    CodeScanningDefaultSetupSchema
  export type CodeScanningGetDefaultSetupResponse = z.infer<
    typeof CodeScanningGetDefaultSetupResponseSchema
  >

  export const CodeScanningUpdateDefaultSetupParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(CodeScanningDefaultSetupUpdateSchema)
  export type CodeScanningUpdateDefaultSetupParams = z.infer<
    typeof CodeScanningUpdateDefaultSetupParamsSchema
  >

  export const CodeScanningUpdateDefaultSetupResponseSchema = EmptyObjectSchema
  export type CodeScanningUpdateDefaultSetupResponse = z.infer<
    typeof CodeScanningUpdateDefaultSetupResponseSchema
  >

  export const CodeScanningUploadSarifParamsSchema = z.object({
    commit_sha: CodeScanningAnalysisCommitShaSchema,
    ref: CodeScanningRefFullSchema,
    sarif: CodeScanningAnalysisSarifFileSchema,
    checkout_uri: z
      .string()
      .url()
      .describe(
        'The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.'
      )
      .optional(),
    started_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    tool_name: z
      .string()
      .describe(
        'The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.'
      )
      .optional(),
    validate: z
      .boolean()
      .describe(
        'Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type CodeScanningUploadSarifParams = z.infer<
    typeof CodeScanningUploadSarifParamsSchema
  >

  export type CodeScanningUploadSarifResponse = undefined

  export const CodeScanningGetSarifParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sarif_id: z.string().describe('The SARIF ID obtained after uploading.')
  })
  export type CodeScanningGetSarifParams = z.infer<
    typeof CodeScanningGetSarifParamsSchema
  >

  export const CodeScanningGetSarifResponseSchema =
    CodeScanningSarifsStatusSchema
  export type CodeScanningGetSarifResponse = z.infer<
    typeof CodeScanningGetSarifResponseSchema
  >

  export const CodeSecurityGetConfigurationForRepositoryParamsSchema = z.object(
    {
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    }
  )
  export type CodeSecurityGetConfigurationForRepositoryParams = z.infer<
    typeof CodeSecurityGetConfigurationForRepositoryParamsSchema
  >

  export const CodeSecurityGetConfigurationForRepositoryResponseSchema =
    CodeSecurityConfigurationForRepositorySchema
  export type CodeSecurityGetConfigurationForRepositoryResponse = z.infer<
    typeof CodeSecurityGetConfigurationForRepositoryResponseSchema
  >

  export const ReposCodeownersErrorsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)"
      )
      .optional()
  })
  export type ReposCodeownersErrorsParams = z.infer<
    typeof ReposCodeownersErrorsParamsSchema
  >

  export const ReposCodeownersErrorsResponseSchema = CodeownersErrorsSchema
  export type ReposCodeownersErrorsResponse = z.infer<
    typeof ReposCodeownersErrorsResponseSchema
  >

  export const CodespacesListInRepositoryForAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type CodespacesListInRepositoryForAuthenticatedUserParams = z.infer<
    typeof CodespacesListInRepositoryForAuthenticatedUserParamsSchema
  >

  export const CodespacesListInRepositoryForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      codespaces: z.array(CodespaceSchema)
    })
  export type CodespacesListInRepositoryForAuthenticatedUserResponse = z.infer<
    typeof CodespacesListInRepositoryForAuthenticatedUserResponseSchema
  >

  export const CodespacesCreateWithRepoForAuthenticatedUserParamsSchema =
    z.object({
      ref: z
        .string()
        .describe('Git ref (typically a branch name) for this codespace')
        .optional(),
      location: z
        .string()
        .describe(
          'The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.'
        )
        .optional(),
      geo: z
        .enum(['EuropeWest', 'SoutheastAsia', 'UsEast', 'UsWest'])
        .describe(
          'The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.'
        )
        .optional(),
      client_ip: z
        .string()
        .describe('IP for location auto-detection when proxying a request')
        .optional(),
      machine: z
        .string()
        .describe('Machine type to use for this codespace')
        .optional(),
      devcontainer_path: z
        .string()
        .describe('Path to devcontainer.json config to use for this codespace')
        .optional(),
      multi_repo_permissions_opt_out: z
        .boolean()
        .describe(
          'Whether to authorize requested permissions from devcontainer.json'
        )
        .optional(),
      working_directory: z
        .string()
        .describe('Working directory for this codespace')
        .optional(),
      idle_timeout_minutes: z
        .number()
        .int()
        .describe('Time in minutes before codespace stops from inactivity')
        .optional(),
      display_name: z
        .string()
        .describe('Display name for this codespace')
        .optional(),
      retention_period_minutes: z
        .number()
        .int()
        .describe(
          'Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
  export type CodespacesCreateWithRepoForAuthenticatedUserParams = z.infer<
    typeof CodespacesCreateWithRepoForAuthenticatedUserParamsSchema
  >

  export type CodespacesCreateWithRepoForAuthenticatedUserResponse = undefined

  export const CodespacesListDevcontainersInRepositoryForAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type CodespacesListDevcontainersInRepositoryForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesListDevcontainersInRepositoryForAuthenticatedUserParamsSchema
    >

  export const CodespacesListDevcontainersInRepositoryForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      devcontainers: z.array(
        z.object({
          path: z.string(),
          name: z.string().optional(),
          display_name: z.string().optional()
        })
      )
    })
  export type CodespacesListDevcontainersInRepositoryForAuthenticatedUserResponse =
    z.infer<
      typeof CodespacesListDevcontainersInRepositoryForAuthenticatedUserResponseSchema
    >

  export const CodespacesRepoMachinesForAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      location: z
        .string()
        .describe(
          'The location to check for available machines. Assigned by IP if not provided.'
        )
        .optional(),
      client_ip: z
        .string()
        .describe('IP for location auto-detection when proxying a request')
        .optional(),
      ref: z
        .string()
        .describe(
          'The branch or commit to check for prebuild availability and devcontainer restrictions.'
        )
        .optional()
    })
  export type CodespacesRepoMachinesForAuthenticatedUserParams = z.infer<
    typeof CodespacesRepoMachinesForAuthenticatedUserParamsSchema
  >

  export const CodespacesRepoMachinesForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      machines: z.array(CodespaceMachineSchema)
    })
  export type CodespacesRepoMachinesForAuthenticatedUserResponse = z.infer<
    typeof CodespacesRepoMachinesForAuthenticatedUserResponseSchema
  >

  export const CodespacesPreFlightWithRepoForAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      ref: z
        .string()
        .describe(
          'The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.'
        )
        .optional(),
      client_ip: z
        .string()
        .describe(
          'An alternative IP for default location auto-detection, such as when proxying a request.'
        )
        .optional()
    })
  export type CodespacesPreFlightWithRepoForAuthenticatedUserParams = z.infer<
    typeof CodespacesPreFlightWithRepoForAuthenticatedUserParamsSchema
  >

  export const CodespacesPreFlightWithRepoForAuthenticatedUserResponseSchema =
    z.object({
      billable_owner: SimpleUserSchema.optional(),
      defaults: z
        .object({ location: z.string(), devcontainer_path: z.string() })
        .optional()
    })
  export type CodespacesPreFlightWithRepoForAuthenticatedUserResponse = z.infer<
    typeof CodespacesPreFlightWithRepoForAuthenticatedUserResponseSchema
  >

  export const CodespacesCheckPermissionsForDevcontainerParamsSchema = z.object(
    {
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      ref: z
        .string()
        .describe(
          'The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
        ),
      devcontainer_path: z
        .string()
        .describe(
          'Path to the devcontainer.json configuration to use for the permission check.'
        )
    }
  )
  export type CodespacesCheckPermissionsForDevcontainerParams = z.infer<
    typeof CodespacesCheckPermissionsForDevcontainerParamsSchema
  >

  export const CodespacesCheckPermissionsForDevcontainerResponseSchema =
    CodespacesPermissionsCheckForDevcontainerSchema
  export type CodespacesCheckPermissionsForDevcontainerResponse = z.infer<
    typeof CodespacesCheckPermissionsForDevcontainerResponseSchema
  >

  export const CodespacesListRepoSecretsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type CodespacesListRepoSecretsParams = z.infer<
    typeof CodespacesListRepoSecretsParamsSchema
  >

  export const CodespacesListRepoSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(RepoCodespacesSecretSchema)
  })
  export type CodespacesListRepoSecretsResponse = z.infer<
    typeof CodespacesListRepoSecretsResponseSchema
  >

  export const CodespacesGetRepoPublicKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type CodespacesGetRepoPublicKeyParams = z.infer<
    typeof CodespacesGetRepoPublicKeyParamsSchema
  >

  export const CodespacesGetRepoPublicKeyResponseSchema =
    CodespacesPublicKeySchema
  export type CodespacesGetRepoPublicKeyResponse = z.infer<
    typeof CodespacesGetRepoPublicKeyResponseSchema
  >

  export const CodespacesGetRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesGetRepoSecretParams = z.infer<
    typeof CodespacesGetRepoSecretParamsSchema
  >

  export const CodespacesGetRepoSecretResponseSchema =
    RepoCodespacesSecretSchema
  export type CodespacesGetRepoSecretResponse = z.infer<
    typeof CodespacesGetRepoSecretResponseSchema
  >

  export const CodespacesCreateOrUpdateRepoSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.'
      )
      .optional(),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesCreateOrUpdateRepoSecretParams = z.infer<
    typeof CodespacesCreateOrUpdateRepoSecretParamsSchema
  >

  export type CodespacesCreateOrUpdateRepoSecretResponse = undefined

  export const CodespacesDeleteRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesDeleteRepoSecretParams = z.infer<
    typeof CodespacesDeleteRepoSecretParamsSchema
  >

  export type CodespacesDeleteRepoSecretResponse = undefined

  export const ReposListCollaboratorsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    affiliation: z
      .enum(['outside', 'direct', 'all'])
      .describe(
        'Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.'
      )
      .default('all'),
    permission: z
      .enum(['pull', 'triage', 'push', 'maintain', 'admin'])
      .describe(
        'Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListCollaboratorsParams = z.infer<
    typeof ReposListCollaboratorsParamsSchema
  >

  export const ReposListCollaboratorsResponseSchema =
    z.array(CollaboratorSchema)
  export type ReposListCollaboratorsResponse = z.infer<
    typeof ReposListCollaboratorsResponseSchema
  >

  export const ReposCheckCollaboratorParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ReposCheckCollaboratorParams = z.infer<
    typeof ReposCheckCollaboratorParamsSchema
  >

  export type ReposCheckCollaboratorResponse = undefined

  export const ReposAddCollaboratorParamsSchema = z.object({
    permission: z
      .string()
      .describe(
        'The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.'
      )
      .default('push'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ReposAddCollaboratorParams = z.infer<
    typeof ReposAddCollaboratorParamsSchema
  >

  export type ReposAddCollaboratorResponse = undefined

  export const ReposRemoveCollaboratorParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ReposRemoveCollaboratorParams = z.infer<
    typeof ReposRemoveCollaboratorParamsSchema
  >

  export type ReposRemoveCollaboratorResponse = undefined

  export const ReposGetCollaboratorPermissionLevelParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type ReposGetCollaboratorPermissionLevelParams = z.infer<
    typeof ReposGetCollaboratorPermissionLevelParamsSchema
  >

  export const ReposGetCollaboratorPermissionLevelResponseSchema =
    RepositoryCollaboratorPermissionSchema
  export type ReposGetCollaboratorPermissionLevelResponse = z.infer<
    typeof ReposGetCollaboratorPermissionLevelResponseSchema
  >

  export const ReposListCommitCommentsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListCommitCommentsForRepoParams = z.infer<
    typeof ReposListCommitCommentsForRepoParamsSchema
  >

  export const ReposListCommitCommentsForRepoResponseSchema =
    z.array(CommitCommentSchema)
  export type ReposListCommitCommentsForRepoResponse = z.infer<
    typeof ReposListCommitCommentsForRepoResponseSchema
  >

  export const ReposGetCommitCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type ReposGetCommitCommentParams = z.infer<
    typeof ReposGetCommitCommentParamsSchema
  >

  export const ReposGetCommitCommentResponseSchema = CommitCommentSchema
  export type ReposGetCommitCommentResponse = z.infer<
    typeof ReposGetCommitCommentResponseSchema
  >

  export const ReposDeleteCommitCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type ReposDeleteCommitCommentParams = z.infer<
    typeof ReposDeleteCommitCommentParamsSchema
  >

  export type ReposDeleteCommitCommentResponse = undefined

  export const ReposUpdateCommitCommentParamsSchema = z.object({
    body: z.string().describe('The contents of the comment'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type ReposUpdateCommitCommentParams = z.infer<
    typeof ReposUpdateCommitCommentParamsSchema
  >

  export const ReposUpdateCommitCommentResponseSchema = CommitCommentSchema
  export type ReposUpdateCommitCommentResponse = z.infer<
    typeof ReposUpdateCommitCommentResponseSchema
  >

  export const ReactionsListForCommitCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForCommitCommentParams = z.infer<
    typeof ReactionsListForCommitCommentParamsSchema
  >

  export const ReactionsListForCommitCommentResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForCommitCommentResponse = z.infer<
    typeof ReactionsListForCommitCommentResponseSchema
  >

  export const ReactionsCreateForCommitCommentParamsSchema = z.object({
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type ReactionsCreateForCommitCommentParams = z.infer<
    typeof ReactionsCreateForCommitCommentParamsSchema
  >

  export const ReactionsCreateForCommitCommentResponseSchema = ReactionSchema
  export type ReactionsCreateForCommitCommentResponse = z.infer<
    typeof ReactionsCreateForCommitCommentResponseSchema
  >

  export const ReactionsDeleteForCommitCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForCommitCommentParams = z.infer<
    typeof ReactionsDeleteForCommitCommentParamsSchema
  >

  export type ReactionsDeleteForCommitCommentResponse = undefined

  export const ReposListCommitsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sha: z
      .string()
      .describe(
        'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).'
      )
      .optional(),
    path: z
      .string()
      .describe('Only commits containing this file path will be returned.')
      .optional(),
    author: z
      .string()
      .describe(
        'GitHub username or email address to use to filter by commit author.'
      )
      .optional(),
    committer: z
      .string()
      .describe(
        'GitHub username or email address to use to filter by commit committer.'
      )
      .optional(),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.'
      )
      .optional(),
    until: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListCommitsParams = z.infer<
    typeof ReposListCommitsParamsSchema
  >

  export const ReposListCommitsResponseSchema = z.array(CommitSchema)
  export type ReposListCommitsResponse = z.infer<
    typeof ReposListCommitsResponseSchema
  >

  export const ReposListBranchesForHeadCommitParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    commit_sha: z.string().describe('The SHA of the commit.')
  })
  export type ReposListBranchesForHeadCommitParams = z.infer<
    typeof ReposListBranchesForHeadCommitParamsSchema
  >

  export const ReposListBranchesForHeadCommitResponseSchema =
    z.array(BranchShortSchema)
  export type ReposListBranchesForHeadCommitResponse = z.infer<
    typeof ReposListBranchesForHeadCommitResponseSchema
  >

  export const ReposListCommentsForCommitParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    commit_sha: z.string().describe('The SHA of the commit.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListCommentsForCommitParams = z.infer<
    typeof ReposListCommentsForCommitParamsSchema
  >

  export const ReposListCommentsForCommitResponseSchema =
    z.array(CommitCommentSchema)
  export type ReposListCommentsForCommitResponse = z.infer<
    typeof ReposListCommentsForCommitResponseSchema
  >

  export const ReposCreateCommitCommentParamsSchema = z.object({
    body: z.string().describe('The contents of the comment.'),
    path: z
      .string()
      .describe('Relative path of the file to comment on.')
      .optional(),
    position: z
      .number()
      .int()
      .describe('Line index in the diff to comment on.')
      .optional(),
    line: z
      .number()
      .int()
      .describe(
        '**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    commit_sha: z.string().describe('The SHA of the commit.')
  })
  export type ReposCreateCommitCommentParams = z.infer<
    typeof ReposCreateCommitCommentParamsSchema
  >

  export type ReposCreateCommitCommentResponse = undefined

  export const ReposListPullRequestsAssociatedWithCommitParamsSchema = z.object(
    {
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      commit_sha: z.string().describe('The SHA of the commit.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type ReposListPullRequestsAssociatedWithCommitParams = z.infer<
    typeof ReposListPullRequestsAssociatedWithCommitParamsSchema
  >

  export const ReposListPullRequestsAssociatedWithCommitResponseSchema =
    z.array(PullRequestSimpleSchema)
  export type ReposListPullRequestsAssociatedWithCommitResponse = z.infer<
    typeof ReposListPullRequestsAssociatedWithCommitResponseSchema
  >

  export const ReposGetCommitParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      ),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ReposGetCommitParams = z.infer<typeof ReposGetCommitParamsSchema>

  export const ReposGetCommitResponseSchema = CommitSchema
  export type ReposGetCommitResponse = z.infer<
    typeof ReposGetCommitResponseSchema
  >

  export const ChecksListForRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      ),
    check_name: z
      .string()
      .describe('Returns check runs with the specified `name`.')
      .optional(),
    status: z
      .enum(['queued', 'in_progress', 'completed'])
      .describe('Returns check runs with the specified `status`.')
      .optional(),
    filter: z
      .enum(['latest', 'all'])
      .describe(
        'Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.'
      )
      .default('latest'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    app_id: z.number().int().optional()
  })
  export type ChecksListForRefParams = z.infer<
    typeof ChecksListForRefParamsSchema
  >

  export const ChecksListForRefResponseSchema = z.object({
    total_count: z.number().int(),
    check_runs: z.array(CheckRunSchema)
  })
  export type ChecksListForRefResponse = z.infer<
    typeof ChecksListForRefResponseSchema
  >

  export const ChecksListSuitesForRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      ),
    app_id: z
      .number()
      .int()
      .describe('Filters check suites by GitHub App `id`.')
      .optional(),
    check_name: z
      .string()
      .describe('Returns check runs with the specified `name`.')
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ChecksListSuitesForRefParams = z.infer<
    typeof ChecksListSuitesForRefParamsSchema
  >

  export const ChecksListSuitesForRefResponseSchema = z.object({
    total_count: z.number().int(),
    check_suites: z.array(CheckSuiteSchema)
  })
  export type ChecksListSuitesForRefResponse = z.infer<
    typeof ChecksListSuitesForRefResponseSchema
  >

  export const ReposGetCombinedStatusForRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetCombinedStatusForRefParams = z.infer<
    typeof ReposGetCombinedStatusForRefParamsSchema
  >

  export const ReposGetCombinedStatusForRefResponseSchema =
    CombinedCommitStatusSchema
  export type ReposGetCombinedStatusForRefResponse = z.infer<
    typeof ReposGetCombinedStatusForRefResponseSchema
  >

  export const ReposListCommitStatusesForRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListCommitStatusesForRefParams = z.infer<
    typeof ReposListCommitStatusesForRefParamsSchema
  >

  export const ReposListCommitStatusesForRefResponseSchema =
    z.array(StatusSchema)
  export type ReposListCommitStatusesForRefResponse = z.infer<
    typeof ReposListCommitStatusesForRefResponseSchema
  >

  export const ReposGetCommunityProfileMetricsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetCommunityProfileMetricsParams = z.infer<
    typeof ReposGetCommunityProfileMetricsParamsSchema
  >

  export const ReposGetCommunityProfileMetricsResponseSchema =
    CommunityProfileSchema
  export type ReposGetCommunityProfileMetricsResponse = z.infer<
    typeof ReposGetCommunityProfileMetricsResponseSchema
  >

  export const ReposCompareCommitsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    basehead: z
      .string()
      .describe(
        'The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.'
      ),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ReposCompareCommitsParams = z.infer<
    typeof ReposCompareCommitsParamsSchema
  >

  export const ReposCompareCommitsResponseSchema = CommitComparisonSchema
  export type ReposCompareCommitsResponse = z.infer<
    typeof ReposCompareCommitsResponseSchema
  >

  export const ReposGetContentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    path: z.string().describe('path parameter'),
    ref: z
      .string()
      .describe(
        'The name of the commit/branch/tag. Default: the repository’s default branch.'
      )
      .optional()
  })
  export type ReposGetContentParams = z.infer<
    typeof ReposGetContentParamsSchema
  >

  export const ReposGetContentResponseSchema = z.union([
    ContentDirectorySchema,
    ContentFileSchema,
    ContentSymlinkSchema,
    ContentSubmoduleSchema
  ])
  export type ReposGetContentResponse = z.infer<
    typeof ReposGetContentResponseSchema
  >

  export const ReposCreateOrUpdateFileContentsParamsSchema = z.object({
    message: z.string().describe('The commit message.'),
    content: z
      .string()
      .describe('The new file content, using Base64 encoding.'),
    sha: z
      .string()
      .describe(
        '**Required if you are updating a file**. The blob SHA of the file being replaced.'
      )
      .optional(),
    branch: z
      .string()
      .describe('The branch name. Default: the repository’s default branch.')
      .optional(),
    committer: z
      .object({
        name: z
          .string()
          .describe(
            "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted."
          ),
        email: z
          .string()
          .describe(
            "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted."
          ),
        date: z.string().optional()
      })
      .describe(
        'The person that committed the file. Default: the authenticated user.'
      )
      .optional(),
    author: z
      .object({
        name: z
          .string()
          .describe(
            "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted."
          ),
        email: z
          .string()
          .describe(
            "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted."
          ),
        date: z.string().optional()
      })
      .describe(
        'The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    path: z.string().describe('path parameter')
  })
  export type ReposCreateOrUpdateFileContentsParams = z.infer<
    typeof ReposCreateOrUpdateFileContentsParamsSchema
  >

  export const ReposCreateOrUpdateFileContentsResponseSchema = FileCommitSchema
  export type ReposCreateOrUpdateFileContentsResponse = z.infer<
    typeof ReposCreateOrUpdateFileContentsResponseSchema
  >

  export const ReposDeleteFileParamsSchema = z.object({
    message: z.string().describe('The commit message.'),
    sha: z.string().describe('The blob SHA of the file being deleted.'),
    branch: z
      .string()
      .describe('The branch name. Default: the repository’s default branch')
      .optional(),
    committer: z
      .object({
        name: z
          .string()
          .describe('The name of the author (or committer) of the commit')
          .optional(),
        email: z
          .string()
          .describe('The email of the author (or committer) of the commit')
          .optional()
      })
      .describe('object containing information about the committer.')
      .optional(),
    author: z
      .object({
        name: z
          .string()
          .describe('The name of the author (or committer) of the commit')
          .optional(),
        email: z
          .string()
          .describe('The email of the author (or committer) of the commit')
          .optional()
      })
      .describe('object containing information about the author.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    path: z.string().describe('path parameter')
  })
  export type ReposDeleteFileParams = z.infer<
    typeof ReposDeleteFileParamsSchema
  >

  export const ReposDeleteFileResponseSchema = FileCommitSchema
  export type ReposDeleteFileResponse = z.infer<
    typeof ReposDeleteFileResponseSchema
  >

  export const ReposListContributorsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    anon: z
      .string()
      .describe(
        'Set to `1` or `true` to include anonymous contributors in results.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListContributorsParams = z.infer<
    typeof ReposListContributorsParamsSchema
  >

  export const ReposListContributorsResponseSchema = z.array(ContributorSchema)
  export type ReposListContributorsResponse = z.infer<
    typeof ReposListContributorsResponseSchema
  >

  export const DependabotListAlertsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    state: z
      .string()
      .describe(
        'A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`'
      )
      .optional(),
    severity: z
      .string()
      .describe(
        'A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`'
      )
      .optional(),
    ecosystem: z
      .string()
      .describe(
        'A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`'
      )
      .optional(),
    package: z
      .string()
      .describe(
        'A comma-separated list of package names. If specified, only alerts for these packages will be returned.'
      )
      .optional(),
    manifest: z
      .string()
      .describe(
        'A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.'
      )
      .optional(),
    epss_percentage: z
      .string()
      .describe(
        'CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.'
      )
      .optional(),
    scope: z
      .enum(['development', 'runtime'])
      .describe(
        'The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'epss_percentage'])
      .describe(
        "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage."
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    page: z
      .number()
      .int()
      .describe(
        '**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    first: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.'
      )
      .default(30),
    last: z
      .number()
      .int()
      .gte(1)
      .lte(100)
      .describe(
        '**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.'
      )
      .optional()
  })
  export type DependabotListAlertsForRepoParams = z.infer<
    typeof DependabotListAlertsForRepoParamsSchema
  >

  export const DependabotListAlertsForRepoResponseSchema = z.array(
    DependabotAlertSchema
  )
  export type DependabotListAlertsForRepoResponse = z.infer<
    typeof DependabotListAlertsForRepoResponseSchema
  >

  export const DependabotGetAlertParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.'
      )
  })
  export type DependabotGetAlertParams = z.infer<
    typeof DependabotGetAlertParamsSchema
  >

  export const DependabotGetAlertResponseSchema = DependabotAlertSchema
  export type DependabotGetAlertResponse = z.infer<
    typeof DependabotGetAlertResponseSchema
  >

  export const DependabotUpdateAlertParamsSchema = z.object({
    state: z
      .enum(['dismissed', 'open'])
      .describe(
        'The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.'
      ),
    dismissed_reason: z
      .enum([
        'fix_started',
        'inaccurate',
        'no_bandwidth',
        'not_used',
        'tolerable_risk'
      ])
      .describe(
        '**Required when `state` is `dismissed`.** A reason for dismissing the alert.'
      )
      .optional(),
    dismissed_comment: z
      .string()
      .max(280)
      .describe('An optional comment associated with dismissing the alert.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.'
      )
  })
  export type DependabotUpdateAlertParams = z.infer<
    typeof DependabotUpdateAlertParamsSchema
  >

  export const DependabotUpdateAlertResponseSchema = DependabotAlertSchema
  export type DependabotUpdateAlertResponse = z.infer<
    typeof DependabotUpdateAlertResponseSchema
  >

  export const DependabotListRepoSecretsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type DependabotListRepoSecretsParams = z.infer<
    typeof DependabotListRepoSecretsParamsSchema
  >

  export const DependabotListRepoSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(DependabotSecretSchema)
  })
  export type DependabotListRepoSecretsResponse = z.infer<
    typeof DependabotListRepoSecretsResponseSchema
  >

  export const DependabotGetRepoPublicKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type DependabotGetRepoPublicKeyParams = z.infer<
    typeof DependabotGetRepoPublicKeyParamsSchema
  >

  export const DependabotGetRepoPublicKeyResponseSchema =
    DependabotPublicKeySchema
  export type DependabotGetRepoPublicKeyResponse = z.infer<
    typeof DependabotGetRepoPublicKeyResponseSchema
  >

  export const DependabotGetRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotGetRepoSecretParams = z.infer<
    typeof DependabotGetRepoSecretParamsSchema
  >

  export const DependabotGetRepoSecretResponseSchema = DependabotSecretSchema
  export type DependabotGetRepoSecretResponse = z.infer<
    typeof DependabotGetRepoSecretResponseSchema
  >

  export const DependabotCreateOrUpdateRepoSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint.'
      )
      .optional(),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotCreateOrUpdateRepoSecretParams = z.infer<
    typeof DependabotCreateOrUpdateRepoSecretParamsSchema
  >

  export type DependabotCreateOrUpdateRepoSecretResponse = undefined

  export const DependabotDeleteRepoSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type DependabotDeleteRepoSecretParams = z.infer<
    typeof DependabotDeleteRepoSecretParamsSchema
  >

  export type DependabotDeleteRepoSecretResponse = undefined

  export const DependencyGraphDiffRangeParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    basehead: z
      .string()
      .describe(
        'The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.'
      ),
    name: z
      .string()
      .describe(
        'The full path, relative to the repository root, of the dependency manifest file.'
      )
      .optional()
  })
  export type DependencyGraphDiffRangeParams = z.infer<
    typeof DependencyGraphDiffRangeParamsSchema
  >

  export const DependencyGraphDiffRangeResponseSchema =
    DependencyGraphDiffSchema
  export type DependencyGraphDiffRangeResponse = z.infer<
    typeof DependencyGraphDiffRangeResponseSchema
  >

  export const DependencyGraphExportSbomParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type DependencyGraphExportSbomParams = z.infer<
    typeof DependencyGraphExportSbomParamsSchema
  >

  export const DependencyGraphExportSbomResponseSchema =
    DependencyGraphSpdxSbomSchema
  export type DependencyGraphExportSbomResponse = z.infer<
    typeof DependencyGraphExportSbomResponseSchema
  >

  export const DependencyGraphCreateRepositorySnapshotParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(SnapshotSchema)
  export type DependencyGraphCreateRepositorySnapshotParams = z.infer<
    typeof DependencyGraphCreateRepositorySnapshotParamsSchema
  >

  export type DependencyGraphCreateRepositorySnapshotResponse = undefined

  export const ReposListDeploymentsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sha: z
      .string()
      .describe('The SHA recorded at creation time.')
      .default('none'),
    ref: z
      .string()
      .describe('The name of the ref. This can be a branch, tag, or SHA.')
      .default('none'),
    task: z
      .string()
      .describe(
        'The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).'
      )
      .default('none'),
    environment: z
      .union([z.string().default('none'), z.null()])
      .describe(
        'The name of the environment that was deployed to (e.g., `staging` or `production`).'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListDeploymentsParams = z.infer<
    typeof ReposListDeploymentsParamsSchema
  >

  export const ReposListDeploymentsResponseSchema = z.array(DeploymentSchema)
  export type ReposListDeploymentsResponse = z.infer<
    typeof ReposListDeploymentsResponseSchema
  >

  export const ReposCreateDeploymentParamsSchema = z.object({
    ref: z
      .string()
      .describe('The ref to deploy. This can be a branch, tag, or SHA.'),
    task: z
      .string()
      .describe(
        'Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).'
      )
      .default('deploy'),
    auto_merge: z
      .boolean()
      .describe(
        "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch."
      )
      .default(true),
    required_contexts: z
      .array(z.string())
      .describe(
        'The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.'
      )
      .optional(),
    payload: z
      .union([
        z.record(z.any()),
        z
          .string()
          .describe('JSON payload with extra information about the deployment.')
          .default('')
      ])
      .optional(),
    environment: z
      .string()
      .describe(
        'Name for the target deployment environment (e.g., `production`, `staging`, `qa`).'
      )
      .default('production'),
    description: z
      .string()
      .describe('Short description of the deployment.')
      .default(''),
    transient_environment: z
      .boolean()
      .describe(
        'Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`'
      )
      .default(false),
    production_environment: z
      .boolean()
      .describe(
        'Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateDeploymentParams = z.infer<
    typeof ReposCreateDeploymentParamsSchema
  >

  export type ReposCreateDeploymentResponse = undefined

  export const ReposGetDeploymentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    deployment_id: z.number().int().describe('deployment_id parameter')
  })
  export type ReposGetDeploymentParams = z.infer<
    typeof ReposGetDeploymentParamsSchema
  >

  export const ReposGetDeploymentResponseSchema = DeploymentSchema
  export type ReposGetDeploymentResponse = z.infer<
    typeof ReposGetDeploymentResponseSchema
  >

  export const ReposDeleteDeploymentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    deployment_id: z.number().int().describe('deployment_id parameter')
  })
  export type ReposDeleteDeploymentParams = z.infer<
    typeof ReposDeleteDeploymentParamsSchema
  >

  export type ReposDeleteDeploymentResponse = undefined

  export const ReposListDeploymentStatusesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    deployment_id: z.number().int().describe('deployment_id parameter'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListDeploymentStatusesParams = z.infer<
    typeof ReposListDeploymentStatusesParamsSchema
  >

  export const ReposListDeploymentStatusesResponseSchema = z.array(
    DeploymentStatusSchema
  )
  export type ReposListDeploymentStatusesResponse = z.infer<
    typeof ReposListDeploymentStatusesResponseSchema
  >

  export const ReposCreateDeploymentStatusParamsSchema = z.object({
    state: z
      .enum([
        'error',
        'failure',
        'inactive',
        'in_progress',
        'queued',
        'pending',
        'success'
      ])
      .describe(
        'The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.'
      ),
    target_url: z
      .string()
      .describe(
        "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`."
      )
      .default(''),
    log_url: z
      .string()
      .describe(
        'The full URL of the deployment\'s output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`'
      )
      .default(''),
    description: z
      .string()
      .describe(
        'A short description of the status. The maximum description length is 140 characters.'
      )
      .default(''),
    environment: z
      .string()
      .describe(
        'Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used.'
      )
      .optional(),
    environment_url: z
      .string()
      .describe('Sets the URL for accessing your environment. Default: `""`')
      .default(''),
    auto_inactive: z
      .boolean()
      .describe(
        "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`"
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    deployment_id: z.number().int().describe('deployment_id parameter')
  })
  export type ReposCreateDeploymentStatusParams = z.infer<
    typeof ReposCreateDeploymentStatusParamsSchema
  >

  export type ReposCreateDeploymentStatusResponse = undefined

  export const ReposGetDeploymentStatusParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    deployment_id: z.number().int().describe('deployment_id parameter'),
    status_id: z.number().int()
  })
  export type ReposGetDeploymentStatusParams = z.infer<
    typeof ReposGetDeploymentStatusParamsSchema
  >

  export const ReposGetDeploymentStatusResponseSchema = DeploymentStatusSchema
  export type ReposGetDeploymentStatusResponse = z.infer<
    typeof ReposGetDeploymentStatusResponseSchema
  >

  export const ReposCreateDispatchEventParamsSchema = z.object({
    event_type: z
      .string()
      .min(1)
      .max(100)
      .describe(
        'A custom webhook event name. Must be 100 characters or fewer.'
      ),
    client_payload: z
      .record(z.any())
      .describe(
        'JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateDispatchEventParams = z.infer<
    typeof ReposCreateDispatchEventParamsSchema
  >

  export type ReposCreateDispatchEventResponse = undefined

  export const ReposGetAllEnvironmentsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetAllEnvironmentsParams = z.infer<
    typeof ReposGetAllEnvironmentsParamsSchema
  >

  export const ReposGetAllEnvironmentsResponseSchema = z.object({
    total_count: z
      .number()
      .int()
      .describe('The number of environments in this repository')
      .optional(),
    environments: z.array(EnvironmentSchema).optional()
  })
  export type ReposGetAllEnvironmentsResponse = z.infer<
    typeof ReposGetAllEnvironmentsResponseSchema
  >

  export const ReposGetEnvironmentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ReposGetEnvironmentParams = z.infer<
    typeof ReposGetEnvironmentParamsSchema
  >

  export const ReposGetEnvironmentResponseSchema = EnvironmentSchema
  export type ReposGetEnvironmentResponse = z.infer<
    typeof ReposGetEnvironmentResponseSchema
  >

  export const ReposCreateOrUpdateEnvironmentParamsSchema = z.object({
    wait_timer: WaitTimerSchema.optional(),
    prevent_self_review: PreventSelfReviewSchema.optional(),
    reviewers: z
      .array(
        z.object({
          type: DeploymentReviewerTypeSchema.optional(),
          id: z
            .number()
            .int()
            .describe(
              'The id of the user or team who can review the deployment'
            )
            .optional()
        })
      )
      .describe(
        'The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.'
      )
      .optional(),
    deployment_branch_policy: DeploymentBranchPolicySettingsSchema.optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ReposCreateOrUpdateEnvironmentParams = z.infer<
    typeof ReposCreateOrUpdateEnvironmentParamsSchema
  >

  export const ReposCreateOrUpdateEnvironmentResponseSchema = EnvironmentSchema
  export type ReposCreateOrUpdateEnvironmentResponse = z.infer<
    typeof ReposCreateOrUpdateEnvironmentResponseSchema
  >

  export const ReposDeleteAnEnvironmentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ReposDeleteAnEnvironmentParams = z.infer<
    typeof ReposDeleteAnEnvironmentParamsSchema
  >

  export type ReposDeleteAnEnvironmentResponse = undefined

  export const ReposListDeploymentBranchPoliciesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListDeploymentBranchPoliciesParams = z.infer<
    typeof ReposListDeploymentBranchPoliciesParamsSchema
  >

  export const ReposListDeploymentBranchPoliciesResponseSchema = z.object({
    total_count: z
      .number()
      .int()
      .describe(
        'The number of deployment branch policies for the environment.'
      ),
    branch_policies: z.array(DeploymentBranchPolicySchema)
  })
  export type ReposListDeploymentBranchPoliciesResponse = z.infer<
    typeof ReposListDeploymentBranchPoliciesResponseSchema
  >

  export const ReposCreateDeploymentBranchPolicyParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      environment_name: z
        .string()
        .describe(
          'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
        )
    })
    .merge(DeploymentBranchPolicyNamePatternWithTypeSchema)
  export type ReposCreateDeploymentBranchPolicyParams = z.infer<
    typeof ReposCreateDeploymentBranchPolicyParamsSchema
  >

  export const ReposCreateDeploymentBranchPolicyResponseSchema =
    DeploymentBranchPolicySchema
  export type ReposCreateDeploymentBranchPolicyResponse = z.infer<
    typeof ReposCreateDeploymentBranchPolicyResponseSchema
  >

  export const ReposGetDeploymentBranchPolicyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    branch_policy_id: z
      .number()
      .int()
      .describe('The unique identifier of the branch policy.')
  })
  export type ReposGetDeploymentBranchPolicyParams = z.infer<
    typeof ReposGetDeploymentBranchPolicyParamsSchema
  >

  export const ReposGetDeploymentBranchPolicyResponseSchema =
    DeploymentBranchPolicySchema
  export type ReposGetDeploymentBranchPolicyResponse = z.infer<
    typeof ReposGetDeploymentBranchPolicyResponseSchema
  >

  export const ReposUpdateDeploymentBranchPolicyParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      environment_name: z
        .string()
        .describe(
          'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
        ),
      branch_policy_id: z
        .number()
        .int()
        .describe('The unique identifier of the branch policy.')
    })
    .merge(DeploymentBranchPolicyNamePatternSchema)
  export type ReposUpdateDeploymentBranchPolicyParams = z.infer<
    typeof ReposUpdateDeploymentBranchPolicyParamsSchema
  >

  export const ReposUpdateDeploymentBranchPolicyResponseSchema =
    DeploymentBranchPolicySchema
  export type ReposUpdateDeploymentBranchPolicyResponse = z.infer<
    typeof ReposUpdateDeploymentBranchPolicyResponseSchema
  >

  export const ReposDeleteDeploymentBranchPolicyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    branch_policy_id: z
      .number()
      .int()
      .describe('The unique identifier of the branch policy.')
  })
  export type ReposDeleteDeploymentBranchPolicyParams = z.infer<
    typeof ReposDeleteDeploymentBranchPolicyParamsSchema
  >

  export type ReposDeleteDeploymentBranchPolicyResponse = undefined

  export const ReposGetAllDeploymentProtectionRulesParamsSchema = z.object({
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      )
  })
  export type ReposGetAllDeploymentProtectionRulesParams = z.infer<
    typeof ReposGetAllDeploymentProtectionRulesParamsSchema
  >

  export const ReposGetAllDeploymentProtectionRulesResponseSchema = z.object({
    total_count: z
      .number()
      .int()
      .describe(
        'The number of enabled custom deployment protection rules for this environment'
      )
      .optional(),
    custom_deployment_protection_rules: z
      .array(DeploymentProtectionRuleSchema)
      .optional()
  })
  export type ReposGetAllDeploymentProtectionRulesResponse = z.infer<
    typeof ReposGetAllDeploymentProtectionRulesResponseSchema
  >

  export const ReposCreateDeploymentProtectionRuleParamsSchema = z.object({
    integration_id: z
      .number()
      .int()
      .describe(
        'The ID of the custom app that will be enabled on the environment.'
      )
      .optional(),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      )
  })
  export type ReposCreateDeploymentProtectionRuleParams = z.infer<
    typeof ReposCreateDeploymentProtectionRuleParamsSchema
  >

  export type ReposCreateDeploymentProtectionRuleResponse = undefined

  export const ReposListCustomDeploymentRuleIntegrationsParamsSchema = z.object(
    {
      environment_name: z
        .string()
        .describe(
          'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30)
    }
  )
  export type ReposListCustomDeploymentRuleIntegrationsParams = z.infer<
    typeof ReposListCustomDeploymentRuleIntegrationsParamsSchema
  >

  export const ReposListCustomDeploymentRuleIntegrationsResponseSchema =
    z.object({
      total_count: z
        .number()
        .int()
        .describe(
          'The total number of custom deployment protection rule integrations available for this environment.'
        )
        .optional(),
      available_custom_deployment_protection_rule_integrations: z
        .array(CustomDeploymentRuleAppSchema)
        .optional()
    })
  export type ReposListCustomDeploymentRuleIntegrationsResponse = z.infer<
    typeof ReposListCustomDeploymentRuleIntegrationsResponseSchema
  >

  export const ReposGetCustomDeploymentProtectionRuleParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    protection_rule_id: z
      .number()
      .int()
      .describe('The unique identifier of the protection rule.')
  })
  export type ReposGetCustomDeploymentProtectionRuleParams = z.infer<
    typeof ReposGetCustomDeploymentProtectionRuleParamsSchema
  >

  export const ReposGetCustomDeploymentProtectionRuleResponseSchema =
    DeploymentProtectionRuleSchema
  export type ReposGetCustomDeploymentProtectionRuleResponse = z.infer<
    typeof ReposGetCustomDeploymentProtectionRuleResponseSchema
  >

  export const ReposDisableDeploymentProtectionRuleParamsSchema = z.object({
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    protection_rule_id: z
      .number()
      .int()
      .describe('The unique identifier of the protection rule.')
  })
  export type ReposDisableDeploymentProtectionRuleParams = z.infer<
    typeof ReposDisableDeploymentProtectionRuleParamsSchema
  >

  export type ReposDisableDeploymentProtectionRuleResponse = undefined

  export const ActionsListEnvironmentSecretsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListEnvironmentSecretsParams = z.infer<
    typeof ActionsListEnvironmentSecretsParamsSchema
  >

  export const ActionsListEnvironmentSecretsResponseSchema = z.object({
    total_count: z.number().int(),
    secrets: z.array(ActionsSecretSchema)
  })
  export type ActionsListEnvironmentSecretsResponse = z.infer<
    typeof ActionsListEnvironmentSecretsResponseSchema
  >

  export const ActionsGetEnvironmentPublicKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ActionsGetEnvironmentPublicKeyParams = z.infer<
    typeof ActionsGetEnvironmentPublicKeyParamsSchema
  >

  export const ActionsGetEnvironmentPublicKeyResponseSchema =
    ActionsPublicKeySchema
  export type ActionsGetEnvironmentPublicKeyResponse = z.infer<
    typeof ActionsGetEnvironmentPublicKeyResponseSchema
  >

  export const ActionsGetEnvironmentSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsGetEnvironmentSecretParams = z.infer<
    typeof ActionsGetEnvironmentSecretParamsSchema
  >

  export const ActionsGetEnvironmentSecretResponseSchema = ActionsSecretSchema
  export type ActionsGetEnvironmentSecretResponse = z.infer<
    typeof ActionsGetEnvironmentSecretResponseSchema
  >

  export const ActionsCreateOrUpdateEnvironmentSecretParamsSchema = z.object({
    encrypted_value: z
      .string()
      .regex(
        new RegExp(
          '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
        )
      )
      .describe(
        'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint.'
      ),
    key_id: z
      .string()
      .describe('ID of the key you used to encrypt the secret.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsCreateOrUpdateEnvironmentSecretParams = z.infer<
    typeof ActionsCreateOrUpdateEnvironmentSecretParamsSchema
  >

  export type ActionsCreateOrUpdateEnvironmentSecretResponse = undefined

  export const ActionsDeleteEnvironmentSecretParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    secret_name: z.string().describe('The name of the secret.')
  })
  export type ActionsDeleteEnvironmentSecretParams = z.infer<
    typeof ActionsDeleteEnvironmentSecretParamsSchema
  >

  export type ActionsDeleteEnvironmentSecretResponse = undefined

  export const ActionsListEnvironmentVariablesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(10),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActionsListEnvironmentVariablesParams = z.infer<
    typeof ActionsListEnvironmentVariablesParamsSchema
  >

  export const ActionsListEnvironmentVariablesResponseSchema = z.object({
    total_count: z.number().int(),
    variables: z.array(ActionsVariableSchema)
  })
  export type ActionsListEnvironmentVariablesResponse = z.infer<
    typeof ActionsListEnvironmentVariablesResponseSchema
  >

  export const ActionsCreateEnvironmentVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ActionsCreateEnvironmentVariableParams = z.infer<
    typeof ActionsCreateEnvironmentVariableParamsSchema
  >

  export type ActionsCreateEnvironmentVariableResponse = undefined

  export const ActionsGetEnvironmentVariableParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      ),
    name: z.string().describe('The name of the variable.')
  })
  export type ActionsGetEnvironmentVariableParams = z.infer<
    typeof ActionsGetEnvironmentVariableParamsSchema
  >

  export const ActionsGetEnvironmentVariableResponseSchema =
    ActionsVariableSchema
  export type ActionsGetEnvironmentVariableResponse = z.infer<
    typeof ActionsGetEnvironmentVariableResponseSchema
  >

  export const ActionsDeleteEnvironmentVariableParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string().describe('The name of the variable.'),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ActionsDeleteEnvironmentVariableParams = z.infer<
    typeof ActionsDeleteEnvironmentVariableParamsSchema
  >

  export type ActionsDeleteEnvironmentVariableResponse = undefined

  export const ActionsUpdateEnvironmentVariableParamsSchema = z.object({
    name: z.string().describe('The name of the variable.'),
    value: z.string().describe('The value of the variable.').optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    environment_name: z
      .string()
      .describe(
        'The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.'
      )
  })
  export type ActionsUpdateEnvironmentVariableParams = z.infer<
    typeof ActionsUpdateEnvironmentVariableParamsSchema
  >

  export type ActionsUpdateEnvironmentVariableResponse = undefined

  export const ActivityListRepoEventsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListRepoEventsParams = z.infer<
    typeof ActivityListRepoEventsParamsSchema
  >

  export const ActivityListRepoEventsResponseSchema = z.array(EventSchema)
  export type ActivityListRepoEventsResponse = z.infer<
    typeof ActivityListRepoEventsResponseSchema
  >

  export const ReposListForksParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sort: z
      .enum(['newest', 'oldest', 'stargazers', 'watchers'])
      .describe('The sort order. `stargazers` will sort by star count.')
      .default('newest'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListForksParams = z.infer<typeof ReposListForksParamsSchema>

  export const ReposListForksResponseSchema = z.array(MinimalRepositorySchema)
  export type ReposListForksResponse = z.infer<
    typeof ReposListForksResponseSchema
  >

  export const ReposCreateForkParamsSchema = z.object({
    organization: z
      .string()
      .describe(
        'Optional parameter to specify the organization name if forking into an organization.'
      )
      .optional(),
    name: z
      .string()
      .describe(
        'When forking from an existing repository, a new name for the fork.'
      )
      .optional(),
    default_branch_only: z
      .boolean()
      .describe(
        'When forking from an existing repository, fork with only the default branch.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateForkParams = z.infer<
    typeof ReposCreateForkParamsSchema
  >

  export type ReposCreateForkResponse = undefined

  export const GitCreateBlobParamsSchema = z.object({
    content: z.string().describe("The new blob's content."),
    encoding: z
      .string()
      .describe(
        'The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.'
      )
      .default('utf-8'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type GitCreateBlobParams = z.infer<typeof GitCreateBlobParamsSchema>

  export type GitCreateBlobResponse = undefined

  export const GitGetBlobParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    file_sha: z.string()
  })
  export type GitGetBlobParams = z.infer<typeof GitGetBlobParamsSchema>

  export const GitGetBlobResponseSchema = BlobSchema
  export type GitGetBlobResponse = z.infer<typeof GitGetBlobResponseSchema>

  export const GitCreateCommitParamsSchema = z.object({
    message: z.string().describe('The commit message'),
    tree: z
      .string()
      .describe('The SHA of the tree object this commit points to'),
    parents: z
      .array(z.string())
      .describe(
        'The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.'
      )
      .optional(),
    author: z
      .object({
        name: z
          .string()
          .describe('The name of the author (or committer) of the commit'),
        email: z
          .string()
          .describe('The email of the author (or committer) of the commit'),
        date: z
          .string()
          .datetime({ offset: true })
          .describe(
            'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
          )
          .optional()
      })
      .describe(
        'Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.'
      )
      .optional(),
    committer: z
      .object({
        name: z
          .string()
          .describe('The name of the author (or committer) of the commit')
          .optional(),
        email: z
          .string()
          .describe('The email of the author (or committer) of the commit')
          .optional(),
        date: z
          .string()
          .datetime({ offset: true })
          .describe(
            'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
          )
          .optional()
      })
      .describe(
        'Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.'
      )
      .optional(),
    signature: z
      .string()
      .describe(
        'The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type GitCreateCommitParams = z.infer<
    typeof GitCreateCommitParamsSchema
  >

  export type GitCreateCommitResponse = undefined

  export const GitGetCommitParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    commit_sha: z.string().describe('The SHA of the commit.')
  })
  export type GitGetCommitParams = z.infer<typeof GitGetCommitParamsSchema>

  export const GitGetCommitResponseSchema = GitCommitSchema
  export type GitGetCommitResponse = z.infer<typeof GitGetCommitResponseSchema>

  export const GitListMatchingRefsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      )
  })
  export type GitListMatchingRefsParams = z.infer<
    typeof GitListMatchingRefsParamsSchema
  >

  export const GitListMatchingRefsResponseSchema = z.array(GitRefSchema)
  export type GitListMatchingRefsResponse = z.infer<
    typeof GitListMatchingRefsResponseSchema
  >

  export const GitGetRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      )
  })
  export type GitGetRefParams = z.infer<typeof GitGetRefParamsSchema>

  export const GitGetRefResponseSchema = GitRefSchema
  export type GitGetRefResponse = z.infer<typeof GitGetRefResponseSchema>

  export const GitCreateRefParamsSchema = z.object({
    ref: z
      .string()
      .describe(
        "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected."
      ),
    sha: z.string().describe('The SHA1 value for this reference.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type GitCreateRefParams = z.infer<typeof GitCreateRefParamsSchema>

  export type GitCreateRefResponse = undefined

  export const GitDeleteRefParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      )
  })
  export type GitDeleteRefParams = z.infer<typeof GitDeleteRefParamsSchema>

  export type GitDeleteRefResponse = undefined

  export const GitUpdateRefParamsSchema = z.object({
    sha: z.string().describe('The SHA1 value to set this reference to'),
    force: z
      .boolean()
      .describe(
        "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work."
      )
      .default(false),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.'
      )
  })
  export type GitUpdateRefParams = z.infer<typeof GitUpdateRefParamsSchema>

  export const GitUpdateRefResponseSchema = GitRefSchema
  export type GitUpdateRefResponse = z.infer<typeof GitUpdateRefResponseSchema>

  export const GitCreateTagParamsSchema = z.object({
    tag: z
      .string()
      .describe(
        'The tag\'s name. This is typically a version (e.g., "v0.0.1").'
      ),
    message: z.string().describe('The tag message.'),
    object: z.string().describe('The SHA of the git object this is tagging.'),
    type: z
      .enum(['commit', 'tree', 'blob'])
      .describe(
        "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`."
      ),
    tagger: z
      .object({
        name: z.string().describe('The name of the author of the tag'),
        email: z.string().describe('The email of the author of the tag'),
        date: z
          .string()
          .datetime({ offset: true })
          .describe(
            'When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
          )
          .optional()
      })
      .describe(
        'An object with information about the individual creating the tag.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type GitCreateTagParams = z.infer<typeof GitCreateTagParamsSchema>

  export type GitCreateTagResponse = undefined

  export const GitGetTagParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tag_sha: z.string()
  })
  export type GitGetTagParams = z.infer<typeof GitGetTagParamsSchema>

  export const GitGetTagResponseSchema = GitTagSchema
  export type GitGetTagResponse = z.infer<typeof GitGetTagResponseSchema>

  export const GitCreateTreeParamsSchema = z.object({
    tree: z
      .array(
        z.object({
          path: z
            .string()
            .describe('The file referenced in the tree.')
            .optional(),
          mode: z
            .enum(['100644', '100755', '040000', '160000', '120000'])
            .describe(
              'The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.'
            )
            .optional(),
          type: z
            .enum(['blob', 'tree', 'commit'])
            .describe('Either `blob`, `tree`, or `commit`.')
            .optional(),
          sha: z
            .string()
            .describe(
              'The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted.  \n  \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.'
            )
            .optional(),
          content: z
            .string()
            .describe(
              'The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.  \n  \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.'
            )
            .optional()
        })
      )
      .describe(
        'Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.'
      ),
    base_tree: z
      .string()
      .describe(
        "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit."
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type GitCreateTreeParams = z.infer<typeof GitCreateTreeParamsSchema>

  export type GitCreateTreeResponse = undefined

  export const GitGetTreeParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tree_sha: z
      .string()
      .describe('The SHA1 value or ref (branch or tag) name of the tree.'),
    recursive: z
      .string()
      .describe(
        'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees.'
      )
      .optional()
  })
  export type GitGetTreeParams = z.infer<typeof GitGetTreeParamsSchema>

  export const GitGetTreeResponseSchema = GitTreeSchema
  export type GitGetTreeResponse = z.infer<typeof GitGetTreeResponseSchema>

  export const ReposListWebhooksParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListWebhooksParams = z.infer<
    typeof ReposListWebhooksParamsSchema
  >

  export const ReposListWebhooksResponseSchema = z.array(HookSchema)
  export type ReposListWebhooksResponse = z.infer<
    typeof ReposListWebhooksResponseSchema
  >

  export const ReposCreateWebhookParamsSchema = z.object({
    name: z
      .string()
      .describe(
        'Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.'
      )
      .optional(),
    config: z
      .object({
        url: WebhookConfigUrlSchema.optional(),
        content_type: WebhookConfigContentTypeSchema.optional(),
        secret: WebhookConfigSecretSchema.optional(),
        insecure_ssl: WebhookConfigInsecureSslSchema.optional()
      })
      .describe('Key/value pairs to provide settings for this webhook.')
      .optional(),
    events: z
      .array(z.string())
      .describe(
        'Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.'
      )
      .default(['push']),
    active: z
      .boolean()
      .describe(
        'Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.'
      )
      .default(true),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateWebhookParams = z.infer<
    typeof ReposCreateWebhookParamsSchema
  >

  export type ReposCreateWebhookResponse = undefined

  export const ReposGetWebhookParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposGetWebhookParams = z.infer<
    typeof ReposGetWebhookParamsSchema
  >

  export const ReposGetWebhookResponseSchema = HookSchema
  export type ReposGetWebhookResponse = z.infer<
    typeof ReposGetWebhookResponseSchema
  >

  export const ReposDeleteWebhookParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposDeleteWebhookParams = z.infer<
    typeof ReposDeleteWebhookParamsSchema
  >

  export type ReposDeleteWebhookResponse = undefined

  export const ReposUpdateWebhookParamsSchema = z.object({
    config: WebhookConfigSchema.optional(),
    events: z
      .array(z.string())
      .describe(
        'Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.'
      )
      .default(['push']),
    add_events: z
      .array(z.string())
      .describe(
        'Determines a list of events to be added to the list of events that the Hook triggers for.'
      )
      .optional(),
    remove_events: z
      .array(z.string())
      .describe(
        'Determines a list of events to be removed from the list of events that the Hook triggers for.'
      )
      .optional(),
    active: z
      .boolean()
      .describe(
        'Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.'
      )
      .default(true),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposUpdateWebhookParams = z.infer<
    typeof ReposUpdateWebhookParamsSchema
  >

  export const ReposUpdateWebhookResponseSchema = HookSchema
  export type ReposUpdateWebhookResponse = z.infer<
    typeof ReposUpdateWebhookResponseSchema
  >

  export const ReposGetWebhookConfigForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposGetWebhookConfigForRepoParams = z.infer<
    typeof ReposGetWebhookConfigForRepoParamsSchema
  >

  export const ReposGetWebhookConfigForRepoResponseSchema = WebhookConfigSchema
  export type ReposGetWebhookConfigForRepoResponse = z.infer<
    typeof ReposGetWebhookConfigForRepoResponseSchema
  >

  export const ReposUpdateWebhookConfigForRepoParamsSchema = z.object({
    url: WebhookConfigUrlSchema.optional(),
    content_type: WebhookConfigContentTypeSchema.optional(),
    secret: WebhookConfigSecretSchema.optional(),
    insecure_ssl: WebhookConfigInsecureSslSchema.optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposUpdateWebhookConfigForRepoParams = z.infer<
    typeof ReposUpdateWebhookConfigForRepoParamsSchema
  >

  export const ReposUpdateWebhookConfigForRepoResponseSchema =
    WebhookConfigSchema
  export type ReposUpdateWebhookConfigForRepoResponse = z.infer<
    typeof ReposUpdateWebhookConfigForRepoResponseSchema
  >

  export const ReposListWebhookDeliveriesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    cursor: z
      .string()
      .describe(
        'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.'
      )
      .optional()
  })
  export type ReposListWebhookDeliveriesParams = z.infer<
    typeof ReposListWebhookDeliveriesParamsSchema
  >

  export const ReposListWebhookDeliveriesResponseSchema = z.array(
    HookDeliveryItemSchema
  )
  export type ReposListWebhookDeliveriesResponse = z.infer<
    typeof ReposListWebhookDeliveriesResponseSchema
  >

  export const ReposGetWebhookDeliveryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    delivery_id: z.number().int()
  })
  export type ReposGetWebhookDeliveryParams = z.infer<
    typeof ReposGetWebhookDeliveryParamsSchema
  >

  export const ReposGetWebhookDeliveryResponseSchema = HookDeliverySchema
  export type ReposGetWebhookDeliveryResponse = z.infer<
    typeof ReposGetWebhookDeliveryResponseSchema
  >

  export const ReposRedeliverWebhookDeliveryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      ),
    delivery_id: z.number().int()
  })
  export type ReposRedeliverWebhookDeliveryParams = z.infer<
    typeof ReposRedeliverWebhookDeliveryParamsSchema
  >

  export type ReposRedeliverWebhookDeliveryResponse = undefined

  export const ReposPingWebhookParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposPingWebhookParams = z.infer<
    typeof ReposPingWebhookParamsSchema
  >

  export type ReposPingWebhookResponse = undefined

  export const ReposTestPushWebhookParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    hook_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.'
      )
  })
  export type ReposTestPushWebhookParams = z.infer<
    typeof ReposTestPushWebhookParamsSchema
  >

  export type ReposTestPushWebhookResponse = undefined

  export const MigrationsGetImportStatusParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsGetImportStatusParams = z.infer<
    typeof MigrationsGetImportStatusParamsSchema
  >

  export const MigrationsGetImportStatusResponseSchema = ImportSchema
  export type MigrationsGetImportStatusResponse = z.infer<
    typeof MigrationsGetImportStatusResponseSchema
  >

  export const MigrationsStartImportParamsSchema = z.object({
    vcs_url: z.string().describe('The URL of the originating repository.'),
    vcs: z
      .enum(['subversion', 'git', 'mercurial', 'tfvc'])
      .describe(
        'The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.'
      )
      .optional(),
    vcs_username: z
      .string()
      .describe(
        'If authentication is required, the username to provide to `vcs_url`.'
      )
      .optional(),
    vcs_password: z
      .string()
      .describe(
        'If authentication is required, the password to provide to `vcs_url`.'
      )
      .optional(),
    tfvc_project: z
      .string()
      .describe(
        'For a tfvc import, the name of the project that is being imported.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsStartImportParams = z.infer<
    typeof MigrationsStartImportParamsSchema
  >

  export type MigrationsStartImportResponse = undefined

  export const MigrationsCancelImportParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsCancelImportParams = z.infer<
    typeof MigrationsCancelImportParamsSchema
  >

  export type MigrationsCancelImportResponse = undefined

  export const MigrationsUpdateImportParamsSchema = z.object({
    vcs_username: z
      .string()
      .describe('The username to provide to the originating repository.')
      .optional(),
    vcs_password: z
      .string()
      .describe('The password to provide to the originating repository.')
      .optional(),
    vcs: z
      .enum(['subversion', 'tfvc', 'git', 'mercurial'])
      .describe('The type of version control system you are migrating from.')
      .optional(),
    tfvc_project: z
      .string()
      .describe(
        'For a tfvc import, the name of the project that is being imported.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsUpdateImportParams = z.infer<
    typeof MigrationsUpdateImportParamsSchema
  >

  export const MigrationsUpdateImportResponseSchema = ImportSchema
  export type MigrationsUpdateImportResponse = z.infer<
    typeof MigrationsUpdateImportResponseSchema
  >

  export const MigrationsGetCommitAuthorsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    since: z
      .number()
      .int()
      .describe('A user ID. Only return users with an ID greater than this ID.')
      .optional()
  })
  export type MigrationsGetCommitAuthorsParams = z.infer<
    typeof MigrationsGetCommitAuthorsParamsSchema
  >

  export const MigrationsGetCommitAuthorsResponseSchema =
    z.array(PorterAuthorSchema)
  export type MigrationsGetCommitAuthorsResponse = z.infer<
    typeof MigrationsGetCommitAuthorsResponseSchema
  >

  export const MigrationsMapCommitAuthorParamsSchema = z.object({
    email: z.string().describe('The new Git author email.').optional(),
    name: z.string().describe('The new Git author name.').optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    author_id: z.number().int()
  })
  export type MigrationsMapCommitAuthorParams = z.infer<
    typeof MigrationsMapCommitAuthorParamsSchema
  >

  export const MigrationsMapCommitAuthorResponseSchema = PorterAuthorSchema
  export type MigrationsMapCommitAuthorResponse = z.infer<
    typeof MigrationsMapCommitAuthorResponseSchema
  >

  export const MigrationsGetLargeFilesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsGetLargeFilesParams = z.infer<
    typeof MigrationsGetLargeFilesParamsSchema
  >

  export const MigrationsGetLargeFilesResponseSchema = z.array(
    PorterLargeFileSchema
  )
  export type MigrationsGetLargeFilesResponse = z.infer<
    typeof MigrationsGetLargeFilesResponseSchema
  >

  export const MigrationsSetLfsPreferenceParamsSchema = z.object({
    use_lfs: z
      .enum(['opt_in', 'opt_out'])
      .describe(
        'Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type MigrationsSetLfsPreferenceParams = z.infer<
    typeof MigrationsSetLfsPreferenceParamsSchema
  >

  export const MigrationsSetLfsPreferenceResponseSchema = ImportSchema
  export type MigrationsSetLfsPreferenceResponse = z.infer<
    typeof MigrationsSetLfsPreferenceResponseSchema
  >

  export const AppsGetRepoInstallationParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type AppsGetRepoInstallationParams = z.infer<
    typeof AppsGetRepoInstallationParamsSchema
  >

  export const AppsGetRepoInstallationResponseSchema = InstallationSchema
  export type AppsGetRepoInstallationResponse = z.infer<
    typeof AppsGetRepoInstallationResponseSchema
  >

  export const InteractionsGetRestrictionsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type InteractionsGetRestrictionsForRepoParams = z.infer<
    typeof InteractionsGetRestrictionsForRepoParamsSchema
  >

  export const InteractionsGetRestrictionsForRepoResponseSchema = z.union([
    InteractionLimitResponseSchema,
    z.object({}).strict()
  ])
  export type InteractionsGetRestrictionsForRepoResponse = z.infer<
    typeof InteractionsGetRestrictionsForRepoResponseSchema
  >

  export const InteractionsSetRestrictionsForRepoParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(InteractionLimitSchema)
  export type InteractionsSetRestrictionsForRepoParams = z.infer<
    typeof InteractionsSetRestrictionsForRepoParamsSchema
  >

  export const InteractionsSetRestrictionsForRepoResponseSchema =
    InteractionLimitResponseSchema
  export type InteractionsSetRestrictionsForRepoResponse = z.infer<
    typeof InteractionsSetRestrictionsForRepoResponseSchema
  >

  export const InteractionsRemoveRestrictionsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type InteractionsRemoveRestrictionsForRepoParams = z.infer<
    typeof InteractionsRemoveRestrictionsForRepoParamsSchema
  >

  export type InteractionsRemoveRestrictionsForRepoResponse = undefined

  export const ReposListInvitationsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListInvitationsParams = z.infer<
    typeof ReposListInvitationsParamsSchema
  >

  export const ReposListInvitationsResponseSchema = z.array(
    RepositoryInvitationSchema
  )
  export type ReposListInvitationsResponse = z.infer<
    typeof ReposListInvitationsResponseSchema
  >

  export const ReposDeleteInvitationParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    invitation_id: z
      .number()
      .int()
      .describe('The unique identifier of the invitation.')
  })
  export type ReposDeleteInvitationParams = z.infer<
    typeof ReposDeleteInvitationParamsSchema
  >

  export type ReposDeleteInvitationResponse = undefined

  export const ReposUpdateInvitationParamsSchema = z.object({
    permissions: z
      .enum(['read', 'write', 'maintain', 'triage', 'admin'])
      .describe(
        'The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    invitation_id: z
      .number()
      .int()
      .describe('The unique identifier of the invitation.')
  })
  export type ReposUpdateInvitationParams = z.infer<
    typeof ReposUpdateInvitationParamsSchema
  >

  export const ReposUpdateInvitationResponseSchema = RepositoryInvitationSchema
  export type ReposUpdateInvitationResponse = z.infer<
    typeof ReposUpdateInvitationResponseSchema
  >

  export const IssuesListForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    milestone: z
      .string()
      .describe(
        'If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.'
      )
      .optional(),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the issues to return.')
      .default('open'),
    assignee: z
      .string()
      .describe(
        'Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.'
      )
      .optional(),
    type: z
      .string()
      .describe(
        'Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.'
      )
      .optional(),
    creator: z.string().describe('The user that created the issue.').optional(),
    mentioned: z
      .string()
      .describe("A user that's mentioned in the issue.")
      .optional(),
    labels: z
      .string()
      .describe(
        'A list of comma separated label names. Example: `bug,ui,@high`'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'comments'])
      .describe('What to sort results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListForRepoParams = z.infer<
    typeof IssuesListForRepoParamsSchema
  >

  export const IssuesListForRepoResponseSchema = z.array(IssueSchema)
  export type IssuesListForRepoResponse = z.infer<
    typeof IssuesListForRepoResponseSchema
  >

  export const IssuesCreateParamsSchema = z.object({
    title: z
      .union([z.string(), z.number().int()])
      .describe('The title of the issue.'),
    body: z.string().describe('The contents of the issue.').optional(),
    assignee: z
      .string()
      .describe(
        'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_'
      )
      .optional(),
    milestone: z
      .union([
        z.string(),
        z
          .number()
          .int()
          .describe(
            'The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._'
          )
      ])
      .optional(),
    labels: z
      .array(
        z.union([
          z.string(),
          z.object({
            id: z.number().int().optional(),
            name: z.string().optional(),
            description: z.string().optional(),
            color: z.string().optional()
          })
        ])
      )
      .describe(
        'Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._'
      )
      .optional(),
    assignees: z
      .array(z.string())
      .describe(
        'Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._'
      )
      .optional(),
    type: z
      .string()
      .describe(
        'The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type IssuesCreateParams = z.infer<typeof IssuesCreateParamsSchema>

  export type IssuesCreateResponse = undefined

  export const IssuesListCommentsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property to sort the results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('Either `asc` or `desc`. Ignored without the `sort` parameter.')
      .optional(),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListCommentsForRepoParams = z.infer<
    typeof IssuesListCommentsForRepoParamsSchema
  >

  export const IssuesListCommentsForRepoResponseSchema =
    z.array(IssueCommentSchema)
  export type IssuesListCommentsForRepoResponse = z.infer<
    typeof IssuesListCommentsForRepoResponseSchema
  >

  export const IssuesGetCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type IssuesGetCommentParams = z.infer<
    typeof IssuesGetCommentParamsSchema
  >

  export const IssuesGetCommentResponseSchema = IssueCommentSchema
  export type IssuesGetCommentResponse = z.infer<
    typeof IssuesGetCommentResponseSchema
  >

  export const IssuesDeleteCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type IssuesDeleteCommentParams = z.infer<
    typeof IssuesDeleteCommentParamsSchema
  >

  export type IssuesDeleteCommentResponse = undefined

  export const IssuesUpdateCommentParamsSchema = z.object({
    body: z.string().describe('The contents of the comment.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type IssuesUpdateCommentParams = z.infer<
    typeof IssuesUpdateCommentParamsSchema
  >

  export const IssuesUpdateCommentResponseSchema = IssueCommentSchema
  export type IssuesUpdateCommentResponse = z.infer<
    typeof IssuesUpdateCommentResponseSchema
  >

  export const ReactionsListForIssueCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForIssueCommentParams = z.infer<
    typeof ReactionsListForIssueCommentParamsSchema
  >

  export const ReactionsListForIssueCommentResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForIssueCommentResponse = z.infer<
    typeof ReactionsListForIssueCommentResponseSchema
  >

  export const ReactionsCreateForIssueCommentParamsSchema = z.object({
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type ReactionsCreateForIssueCommentParams = z.infer<
    typeof ReactionsCreateForIssueCommentParamsSchema
  >

  export const ReactionsCreateForIssueCommentResponseSchema = ReactionSchema
  export type ReactionsCreateForIssueCommentResponse = z.infer<
    typeof ReactionsCreateForIssueCommentResponseSchema
  >

  export const ReactionsDeleteForIssueCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForIssueCommentParams = z.infer<
    typeof ReactionsDeleteForIssueCommentParamsSchema
  >

  export type ReactionsDeleteForIssueCommentResponse = undefined

  export const IssuesListEventsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListEventsForRepoParams = z.infer<
    typeof IssuesListEventsForRepoParamsSchema
  >

  export const IssuesListEventsForRepoResponseSchema = z.array(IssueEventSchema)
  export type IssuesListEventsForRepoResponse = z.infer<
    typeof IssuesListEventsForRepoResponseSchema
  >

  export const IssuesGetEventParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    event_id: z.number().int()
  })
  export type IssuesGetEventParams = z.infer<typeof IssuesGetEventParamsSchema>

  export const IssuesGetEventResponseSchema = IssueEventSchema
  export type IssuesGetEventResponse = z.infer<
    typeof IssuesGetEventResponseSchema
  >

  export const IssuesGetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesGetParams = z.infer<typeof IssuesGetParamsSchema>

  export const IssuesGetResponseSchema = IssueSchema
  export type IssuesGetResponse = z.infer<typeof IssuesGetResponseSchema>

  export const IssuesUpdateParamsSchema = z.object({
    title: z
      .union([z.string(), z.number().int()])
      .describe('The title of the issue.')
      .optional(),
    body: z.string().describe('The contents of the issue.').optional(),
    assignee: z
      .string()
      .describe(
        'Username to assign to this issue. **This field is closing down.**'
      )
      .optional(),
    state: z
      .enum(['open', 'closed'])
      .describe('The open or closed state of the issue.')
      .optional(),
    state_reason: z
      .enum(['completed', 'not_planned', 'reopened'])
      .describe(
        'The reason for the state change. Ignored unless `state` is changed.'
      )
      .optional(),
    milestone: z
      .union([
        z.string(),
        z
          .number()
          .int()
          .describe(
            'The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.'
          )
      ])
      .optional(),
    labels: z
      .array(
        z.union([
          z.string(),
          z.object({
            id: z.number().int().optional(),
            name: z.string().optional(),
            description: z.string().optional(),
            color: z.string().optional()
          })
        ])
      )
      .describe(
        'Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.'
      )
      .optional(),
    assignees: z
      .array(z.string())
      .describe(
        'Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.'
      )
      .optional(),
    type: z
      .string()
      .describe(
        'The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesUpdateParams = z.infer<typeof IssuesUpdateParamsSchema>

  export const IssuesUpdateResponseSchema = IssueSchema
  export type IssuesUpdateResponse = z.infer<typeof IssuesUpdateResponseSchema>

  export const IssuesAddAssigneesParamsSchema = z.object({
    assignees: z
      .array(z.string())
      .describe(
        'Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesAddAssigneesParams = z.infer<
    typeof IssuesAddAssigneesParamsSchema
  >

  export type IssuesAddAssigneesResponse = undefined

  export const IssuesRemoveAssigneesParamsSchema = z.object({
    assignees: z
      .array(z.string())
      .describe(
        'Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesRemoveAssigneesParams = z.infer<
    typeof IssuesRemoveAssigneesParamsSchema
  >

  export const IssuesRemoveAssigneesResponseSchema = IssueSchema
  export type IssuesRemoveAssigneesResponse = z.infer<
    typeof IssuesRemoveAssigneesResponseSchema
  >

  export const IssuesCheckUserCanBeAssignedToIssueParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    assignee: z.string()
  })
  export type IssuesCheckUserCanBeAssignedToIssueParams = z.infer<
    typeof IssuesCheckUserCanBeAssignedToIssueParamsSchema
  >

  export type IssuesCheckUserCanBeAssignedToIssueResponse = undefined

  export const IssuesListCommentsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListCommentsParams = z.infer<
    typeof IssuesListCommentsParamsSchema
  >

  export const IssuesListCommentsResponseSchema = z.array(IssueCommentSchema)
  export type IssuesListCommentsResponse = z.infer<
    typeof IssuesListCommentsResponseSchema
  >

  export const IssuesCreateCommentParamsSchema = z.object({
    body: z.string().describe('The contents of the comment.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesCreateCommentParams = z.infer<
    typeof IssuesCreateCommentParamsSchema
  >

  export type IssuesCreateCommentResponse = undefined

  export const IssuesListEventsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListEventsParams = z.infer<
    typeof IssuesListEventsParamsSchema
  >

  export const IssuesListEventsResponseSchema = z.array(
    IssueEventForIssueSchema
  )
  export type IssuesListEventsResponse = z.infer<
    typeof IssuesListEventsResponseSchema
  >

  export const IssuesListLabelsOnIssueParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListLabelsOnIssueParams = z.infer<
    typeof IssuesListLabelsOnIssueParamsSchema
  >

  export const IssuesListLabelsOnIssueResponseSchema = z.array(LabelSchema)
  export type IssuesListLabelsOnIssueResponse = z.infer<
    typeof IssuesListLabelsOnIssueResponseSchema
  >

  export const IssuesAddLabelsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      issue_number: z
        .number()
        .int()
        .describe('The number that identifies the issue.')
    })
    .and(
      z.union([
        z.object({
          labels: z
            .array(z.string())
            .min(1)
            .describe(
              'The names of the labels to add to the issue\'s existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)."'
            )
            .optional()
        }),
        z.array(z.string()).min(1),
        z.object({
          labels: z
            .array(z.object({ name: z.string() }))
            .min(1)
            .optional()
        }),
        z.array(z.object({ name: z.string() })).min(1),
        z.string()
      ])
    )
  export type IssuesAddLabelsParams = z.infer<
    typeof IssuesAddLabelsParamsSchema
  >

  export const IssuesAddLabelsResponseSchema = z.array(LabelSchema)
  export type IssuesAddLabelsResponse = z.infer<
    typeof IssuesAddLabelsResponseSchema
  >

  export const IssuesSetLabelsParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      issue_number: z
        .number()
        .int()
        .describe('The number that identifies the issue.')
    })
    .and(
      z.union([
        z.object({
          labels: z
            .array(z.string())
            .min(1)
            .describe(
              'The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)."'
            )
            .optional()
        }),
        z.array(z.string()).min(1),
        z.object({
          labels: z
            .array(z.object({ name: z.string() }))
            .min(1)
            .optional()
        }),
        z.array(z.object({ name: z.string() })).min(1),
        z.string()
      ])
    )
  export type IssuesSetLabelsParams = z.infer<
    typeof IssuesSetLabelsParamsSchema
  >

  export const IssuesSetLabelsResponseSchema = z.array(LabelSchema)
  export type IssuesSetLabelsResponse = z.infer<
    typeof IssuesSetLabelsResponseSchema
  >

  export const IssuesRemoveAllLabelsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesRemoveAllLabelsParams = z.infer<
    typeof IssuesRemoveAllLabelsParamsSchema
  >

  export type IssuesRemoveAllLabelsResponse = undefined

  export const IssuesRemoveLabelParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    name: z.string()
  })
  export type IssuesRemoveLabelParams = z.infer<
    typeof IssuesRemoveLabelParamsSchema
  >

  export const IssuesRemoveLabelResponseSchema = z.array(LabelSchema)
  export type IssuesRemoveLabelResponse = z.infer<
    typeof IssuesRemoveLabelResponseSchema
  >

  export const IssuesLockParamsSchema = z.object({
    lock_reason: z
      .enum(['off-topic', 'too heated', 'resolved', 'spam'])
      .describe(
        "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:  \n * `off-topic`  \n * `too heated`  \n * `resolved`  \n * `spam`"
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesLockParams = z.infer<typeof IssuesLockParamsSchema>

  export type IssuesLockResponse = undefined

  export const IssuesUnlockParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesUnlockParams = z.infer<typeof IssuesUnlockParamsSchema>

  export type IssuesUnlockResponse = undefined

  export const ReactionsListForIssueParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForIssueParams = z.infer<
    typeof ReactionsListForIssueParamsSchema
  >

  export const ReactionsListForIssueResponseSchema = z.array(ReactionSchema)
  export type ReactionsListForIssueResponse = z.infer<
    typeof ReactionsListForIssueResponseSchema
  >

  export const ReactionsCreateForIssueParamsSchema = z.object({
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type ReactionsCreateForIssueParams = z.infer<
    typeof ReactionsCreateForIssueParamsSchema
  >

  export const ReactionsCreateForIssueResponseSchema = ReactionSchema
  export type ReactionsCreateForIssueResponse = z.infer<
    typeof ReactionsCreateForIssueResponseSchema
  >

  export const ReactionsDeleteForIssueParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForIssueParams = z.infer<
    typeof ReactionsDeleteForIssueParamsSchema
  >

  export type ReactionsDeleteForIssueResponse = undefined

  export const IssuesRemoveSubIssueParamsSchema = z.object({
    sub_issue_id: z
      .number()
      .int()
      .describe('The id of the sub-issue to remove'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesRemoveSubIssueParams = z.infer<
    typeof IssuesRemoveSubIssueParamsSchema
  >

  export const IssuesRemoveSubIssueResponseSchema = IssueSchema
  export type IssuesRemoveSubIssueResponse = z.infer<
    typeof IssuesRemoveSubIssueResponseSchema
  >

  export const IssuesListSubIssuesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListSubIssuesParams = z.infer<
    typeof IssuesListSubIssuesParamsSchema
  >

  export const IssuesListSubIssuesResponseSchema = z.array(IssueSchema)
  export type IssuesListSubIssuesResponse = z.infer<
    typeof IssuesListSubIssuesResponseSchema
  >

  export const IssuesAddSubIssueParamsSchema = z.object({
    sub_issue_id: z
      .number()
      .int()
      .describe(
        'The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue'
      ),
    replace_parent: z
      .boolean()
      .describe(
        'Option that, when true, instructs the operation to replace the sub-issues current parent issue'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesAddSubIssueParams = z.infer<
    typeof IssuesAddSubIssueParamsSchema
  >

  export type IssuesAddSubIssueResponse = undefined

  export const IssuesReprioritizeSubIssueParamsSchema = z.object({
    sub_issue_id: z
      .number()
      .int()
      .describe('The id of the sub-issue to reprioritize'),
    after_id: z
      .number()
      .int()
      .describe(
        'The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified).'
      )
      .optional(),
    before_id: z
      .number()
      .int()
      .describe(
        'The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified).'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.')
  })
  export type IssuesReprioritizeSubIssueParams = z.infer<
    typeof IssuesReprioritizeSubIssueParamsSchema
  >

  export const IssuesReprioritizeSubIssueResponseSchema = IssueSchema
  export type IssuesReprioritizeSubIssueResponse = z.infer<
    typeof IssuesReprioritizeSubIssueResponseSchema
  >

  export const IssuesListEventsForTimelineParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    issue_number: z
      .number()
      .int()
      .describe('The number that identifies the issue.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListEventsForTimelineParams = z.infer<
    typeof IssuesListEventsForTimelineParamsSchema
  >

  export const IssuesListEventsForTimelineResponseSchema = z.array(
    TimelineIssueEventsSchema
  )
  export type IssuesListEventsForTimelineResponse = z.infer<
    typeof IssuesListEventsForTimelineResponseSchema
  >

  export const ReposListDeployKeysParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListDeployKeysParams = z.infer<
    typeof ReposListDeployKeysParamsSchema
  >

  export const ReposListDeployKeysResponseSchema = z.array(DeployKeySchema)
  export type ReposListDeployKeysResponse = z.infer<
    typeof ReposListDeployKeysResponseSchema
  >

  export const ReposCreateDeployKeyParamsSchema = z.object({
    title: z.string().describe('A name for the key.').optional(),
    key: z.string().describe('The contents of the key.'),
    read_only: z
      .boolean()
      .describe(
        'If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.  \n  \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)."'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateDeployKeyParams = z.infer<
    typeof ReposCreateDeployKeyParamsSchema
  >

  export type ReposCreateDeployKeyResponse = undefined

  export const ReposGetDeployKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    key_id: z.number().int().describe('The unique identifier of the key.')
  })
  export type ReposGetDeployKeyParams = z.infer<
    typeof ReposGetDeployKeyParamsSchema
  >

  export const ReposGetDeployKeyResponseSchema = DeployKeySchema
  export type ReposGetDeployKeyResponse = z.infer<
    typeof ReposGetDeployKeyResponseSchema
  >

  export const ReposDeleteDeployKeyParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    key_id: z.number().int().describe('The unique identifier of the key.')
  })
  export type ReposDeleteDeployKeyParams = z.infer<
    typeof ReposDeleteDeployKeyParamsSchema
  >

  export type ReposDeleteDeployKeyResponse = undefined

  export const IssuesListLabelsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListLabelsForRepoParams = z.infer<
    typeof IssuesListLabelsForRepoParamsSchema
  >

  export const IssuesListLabelsForRepoResponseSchema = z.array(LabelSchema)
  export type IssuesListLabelsForRepoResponse = z.infer<
    typeof IssuesListLabelsForRepoResponseSchema
  >

  export const IssuesCreateLabelParamsSchema = z.object({
    name: z
      .string()
      .describe(
        'The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."'
      ),
    color: z
      .string()
      .describe(
        'The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.'
      )
      .optional(),
    description: z
      .string()
      .describe(
        'A short description of the label. Must be 100 characters or fewer.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type IssuesCreateLabelParams = z.infer<
    typeof IssuesCreateLabelParamsSchema
  >

  export type IssuesCreateLabelResponse = undefined

  export const IssuesGetLabelParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string()
  })
  export type IssuesGetLabelParams = z.infer<typeof IssuesGetLabelParamsSchema>

  export const IssuesGetLabelResponseSchema = LabelSchema
  export type IssuesGetLabelResponse = z.infer<
    typeof IssuesGetLabelResponseSchema
  >

  export const IssuesDeleteLabelParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string()
  })
  export type IssuesDeleteLabelParams = z.infer<
    typeof IssuesDeleteLabelParamsSchema
  >

  export type IssuesDeleteLabelResponse = undefined

  export const IssuesUpdateLabelParamsSchema = z.object({
    new_name: z
      .string()
      .describe(
        'The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."'
      )
      .optional(),
    color: z
      .string()
      .describe(
        'The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.'
      )
      .optional(),
    description: z
      .string()
      .describe(
        'A short description of the label. Must be 100 characters or fewer.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    name: z.string()
  })
  export type IssuesUpdateLabelParams = z.infer<
    typeof IssuesUpdateLabelParamsSchema
  >

  export const IssuesUpdateLabelResponseSchema = LabelSchema
  export type IssuesUpdateLabelResponse = z.infer<
    typeof IssuesUpdateLabelResponseSchema
  >

  export const ReposListLanguagesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposListLanguagesParams = z.infer<
    typeof ReposListLanguagesParamsSchema
  >

  export const ReposListLanguagesResponseSchema = LanguageSchema
  export type ReposListLanguagesResponse = z.infer<
    typeof ReposListLanguagesResponseSchema
  >

  export const LicensesGetForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .any()
      .describe(
        'The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.'
      )
      .optional()
  })
  export type LicensesGetForRepoParams = z.infer<
    typeof LicensesGetForRepoParamsSchema
  >

  export const LicensesGetForRepoResponseSchema = LicenseContentSchema
  export type LicensesGetForRepoResponse = z.infer<
    typeof LicensesGetForRepoResponseSchema
  >

  export const ReposMergeUpstreamParamsSchema = z.object({
    branch: z
      .string()
      .describe(
        'The name of the branch which should be updated to match upstream.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposMergeUpstreamParams = z.infer<
    typeof ReposMergeUpstreamParamsSchema
  >

  export const ReposMergeUpstreamResponseSchema = MergedUpstreamSchema
  export type ReposMergeUpstreamResponse = z.infer<
    typeof ReposMergeUpstreamResponseSchema
  >

  export const ReposMergeParamsSchema = z.object({
    base: z
      .string()
      .describe(
        'The name of the base branch that the head will be merged into.'
      ),
    head: z
      .string()
      .describe(
        'The head to merge. This can be a branch name or a commit SHA1.'
      ),
    commit_message: z
      .string()
      .describe(
        'Commit message to use for the merge commit. If omitted, a default message will be used.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposMergeParams = z.infer<typeof ReposMergeParamsSchema>

  export type ReposMergeResponse = undefined

  export const IssuesListMilestonesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe(
        'The state of the milestone. Either `open`, `closed`, or `all`.'
      )
      .default('open'),
    sort: z
      .enum(['due_on', 'completeness'])
      .describe('What to sort results by. Either `due_on` or `completeness`.')
      .default('due_on'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction of the sort. Either `asc` or `desc`.')
      .default('asc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListMilestonesParams = z.infer<
    typeof IssuesListMilestonesParamsSchema
  >

  export const IssuesListMilestonesResponseSchema = z.array(MilestoneSchema)
  export type IssuesListMilestonesResponse = z.infer<
    typeof IssuesListMilestonesResponseSchema
  >

  export const IssuesCreateMilestoneParamsSchema = z.object({
    title: z.string().describe('The title of the milestone.'),
    state: z
      .enum(['open', 'closed'])
      .describe('The state of the milestone. Either `open` or `closed`.')
      .default('open'),
    description: z
      .string()
      .describe('A description of the milestone.')
      .optional(),
    due_on: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type IssuesCreateMilestoneParams = z.infer<
    typeof IssuesCreateMilestoneParamsSchema
  >

  export type IssuesCreateMilestoneResponse = undefined

  export const IssuesGetMilestoneParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    milestone_number: z
      .number()
      .int()
      .describe('The number that identifies the milestone.')
  })
  export type IssuesGetMilestoneParams = z.infer<
    typeof IssuesGetMilestoneParamsSchema
  >

  export const IssuesGetMilestoneResponseSchema = MilestoneSchema
  export type IssuesGetMilestoneResponse = z.infer<
    typeof IssuesGetMilestoneResponseSchema
  >

  export const IssuesDeleteMilestoneParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    milestone_number: z
      .number()
      .int()
      .describe('The number that identifies the milestone.')
  })
  export type IssuesDeleteMilestoneParams = z.infer<
    typeof IssuesDeleteMilestoneParamsSchema
  >

  export type IssuesDeleteMilestoneResponse = undefined

  export const IssuesUpdateMilestoneParamsSchema = z.object({
    title: z.string().describe('The title of the milestone.').optional(),
    state: z
      .enum(['open', 'closed'])
      .describe('The state of the milestone. Either `open` or `closed`.')
      .default('open'),
    description: z
      .string()
      .describe('A description of the milestone.')
      .optional(),
    due_on: z
      .string()
      .datetime({ offset: true })
      .describe(
        'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    milestone_number: z
      .number()
      .int()
      .describe('The number that identifies the milestone.')
  })
  export type IssuesUpdateMilestoneParams = z.infer<
    typeof IssuesUpdateMilestoneParamsSchema
  >

  export const IssuesUpdateMilestoneResponseSchema = MilestoneSchema
  export type IssuesUpdateMilestoneResponse = z.infer<
    typeof IssuesUpdateMilestoneResponseSchema
  >

  export const IssuesListLabelsForMilestoneParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    milestone_number: z
      .number()
      .int()
      .describe('The number that identifies the milestone.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListLabelsForMilestoneParams = z.infer<
    typeof IssuesListLabelsForMilestoneParamsSchema
  >

  export const IssuesListLabelsForMilestoneResponseSchema = z.array(LabelSchema)
  export type IssuesListLabelsForMilestoneResponse = z.infer<
    typeof IssuesListLabelsForMilestoneResponseSchema
  >

  export const ActivityListRepoNotificationsForAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      all: z
        .boolean()
        .describe('If `true`, show notifications marked as read.')
        .default(false),
      participating: z
        .boolean()
        .describe(
          'If `true`, only shows notifications in which the user is directly participating or mentioned.'
        )
        .default(false),
      since: z
        .string()
        .datetime({ offset: true })
        .describe(
          'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      before: z
        .string()
        .datetime({ offset: true })
        .describe(
          'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
        )
        .optional(),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ActivityListRepoNotificationsForAuthenticatedUserParams = z.infer<
    typeof ActivityListRepoNotificationsForAuthenticatedUserParamsSchema
  >

  export const ActivityListRepoNotificationsForAuthenticatedUserResponseSchema =
    z.array(ThreadSchema)
  export type ActivityListRepoNotificationsForAuthenticatedUserResponse =
    z.infer<
      typeof ActivityListRepoNotificationsForAuthenticatedUserResponseSchema
    >

  export const ActivityMarkRepoNotificationsAsReadParamsSchema = z.object({
    last_read_at: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivityMarkRepoNotificationsAsReadParams = z.infer<
    typeof ActivityMarkRepoNotificationsAsReadParamsSchema
  >

  export type ActivityMarkRepoNotificationsAsReadResponse = undefined

  export const ReposGetPagesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetPagesParams = z.infer<typeof ReposGetPagesParamsSchema>

  export const ReposGetPagesResponseSchema = PageSchema
  export type ReposGetPagesResponse = z.infer<
    typeof ReposGetPagesResponseSchema
  >

  export const ReposCreatePagesSiteParamsSchema = z
    .object({
      build_type: z
        .enum(['legacy', 'workflow'])
        .describe(
          'The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`.'
        )
        .optional(),
      source: z
        .object({
          branch: z
            .string()
            .describe(
              "The repository branch used to publish your site's source files."
            ),
          path: z
            .enum(['/', '/docs'])
            .describe(
              'The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`'
            )
            .default('/')
        })
        .describe(
          'The source branch and directory used to publish your Pages site.'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .and(z.union([z.any(), z.any()]))
  export type ReposCreatePagesSiteParams = z.infer<
    typeof ReposCreatePagesSiteParamsSchema
  >

  export type ReposCreatePagesSiteResponse = undefined

  export const ReposUpdateInformationAboutPagesSiteParamsSchema = z
    .object({
      cname: z
        .string()
        .describe(
          'Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)."'
        )
        .optional(),
      https_enforced: z
        .boolean()
        .describe(
          'Specify whether HTTPS should be enforced for the repository.'
        )
        .optional(),
      build_type: z
        .enum(['legacy', 'workflow'])
        .describe(
          'The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.'
        )
        .optional(),
      source: z
        .union([
          z
            .enum(['gh-pages', 'master', 'master /docs'])
            .describe(
              'Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`.'
            ),
          z
            .object({
              branch: z
                .string()
                .describe(
                  "The repository branch used to publish your site's source files."
                ),
              path: z
                .enum(['/', '/docs'])
                .describe(
                  'The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.'
                )
            })
            .describe(
              'Update the source for the repository. Must include the branch name and path.'
            )
        ])
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .and(z.union([z.any(), z.any(), z.any(), z.any(), z.any()]))
  export type ReposUpdateInformationAboutPagesSiteParams = z.infer<
    typeof ReposUpdateInformationAboutPagesSiteParamsSchema
  >

  export type ReposUpdateInformationAboutPagesSiteResponse = undefined

  export const ReposDeletePagesSiteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposDeletePagesSiteParams = z.infer<
    typeof ReposDeletePagesSiteParamsSchema
  >

  export type ReposDeletePagesSiteResponse = undefined

  export const ReposListPagesBuildsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListPagesBuildsParams = z.infer<
    typeof ReposListPagesBuildsParamsSchema
  >

  export const ReposListPagesBuildsResponseSchema = z.array(PageBuildSchema)
  export type ReposListPagesBuildsResponse = z.infer<
    typeof ReposListPagesBuildsResponseSchema
  >

  export const ReposRequestPagesBuildParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposRequestPagesBuildParams = z.infer<
    typeof ReposRequestPagesBuildParamsSchema
  >

  export type ReposRequestPagesBuildResponse = undefined

  export const ReposGetLatestPagesBuildParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetLatestPagesBuildParams = z.infer<
    typeof ReposGetLatestPagesBuildParamsSchema
  >

  export const ReposGetLatestPagesBuildResponseSchema = PageBuildSchema
  export type ReposGetLatestPagesBuildResponse = z.infer<
    typeof ReposGetLatestPagesBuildResponseSchema
  >

  export const ReposGetPagesBuildParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    build_id: z.number().int()
  })
  export type ReposGetPagesBuildParams = z.infer<
    typeof ReposGetPagesBuildParamsSchema
  >

  export const ReposGetPagesBuildResponseSchema = PageBuildSchema
  export type ReposGetPagesBuildResponse = z.infer<
    typeof ReposGetPagesBuildResponseSchema
  >

  export const ReposCreatePagesDeploymentParamsSchema = z.object({
    artifact_id: z
      .number()
      .describe(
        'The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.'
      )
      .optional(),
    artifact_url: z
      .string()
      .describe(
        'The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.'
      )
      .optional(),
    environment: z
      .string()
      .describe('The target environment for this GitHub Pages deployment.')
      .default('github-pages'),
    pages_build_version: z
      .string()
      .describe(
        'A unique string that represents the version of the build for this deployment.'
      )
      .default('GITHUB_SHA'),
    oidc_token: z
      .string()
      .describe(
        'The OIDC token issued by GitHub Actions certifying the origin of the deployment.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreatePagesDeploymentParams = z.infer<
    typeof ReposCreatePagesDeploymentParamsSchema
  >

  export const ReposCreatePagesDeploymentResponseSchema = PageDeploymentSchema
  export type ReposCreatePagesDeploymentResponse = z.infer<
    typeof ReposCreatePagesDeploymentResponseSchema
  >

  export const ReposGetPagesDeploymentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pages_deployment_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the Pages deployment. You can also give the commit SHA of the deployment.'
      )
  })
  export type ReposGetPagesDeploymentParams = z.infer<
    typeof ReposGetPagesDeploymentParamsSchema
  >

  export const ReposGetPagesDeploymentResponseSchema =
    PagesDeploymentStatusSchema
  export type ReposGetPagesDeploymentResponse = z.infer<
    typeof ReposGetPagesDeploymentResponseSchema
  >

  export const ReposCancelPagesDeploymentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pages_deployment_id: z
      .union([z.number().int(), z.string()])
      .describe(
        'The ID of the Pages deployment. You can also give the commit SHA of the deployment.'
      )
  })
  export type ReposCancelPagesDeploymentParams = z.infer<
    typeof ReposCancelPagesDeploymentParamsSchema
  >

  export type ReposCancelPagesDeploymentResponse = undefined

  export const ReposGetPagesHealthCheckParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetPagesHealthCheckParams = z.infer<
    typeof ReposGetPagesHealthCheckParamsSchema
  >

  export const ReposGetPagesHealthCheckResponseSchema = PagesHealthCheckSchema
  export type ReposGetPagesHealthCheckResponse = z.infer<
    typeof ReposGetPagesHealthCheckResponseSchema
  >

  export const ReposCheckPrivateVulnerabilityReportingParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCheckPrivateVulnerabilityReportingParams = z.infer<
    typeof ReposCheckPrivateVulnerabilityReportingParamsSchema
  >

  export const ReposCheckPrivateVulnerabilityReportingResponseSchema = z.object(
    {
      enabled: z
        .boolean()
        .describe(
          'Whether or not private vulnerability reporting is enabled for the repository.'
        )
    }
  )
  export type ReposCheckPrivateVulnerabilityReportingResponse = z.infer<
    typeof ReposCheckPrivateVulnerabilityReportingResponseSchema
  >

  export const ReposEnablePrivateVulnerabilityReportingParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposEnablePrivateVulnerabilityReportingParams = z.infer<
    typeof ReposEnablePrivateVulnerabilityReportingParamsSchema
  >

  export type ReposEnablePrivateVulnerabilityReportingResponse = undefined

  export const ReposDisablePrivateVulnerabilityReportingParamsSchema = z.object(
    {
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    }
  )
  export type ReposDisablePrivateVulnerabilityReportingParams = z.infer<
    typeof ReposDisablePrivateVulnerabilityReportingParamsSchema
  >

  export type ReposDisablePrivateVulnerabilityReportingResponse = undefined

  export const ProjectsListForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the projects to return.')
      .default('open'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListForRepoParams = z.infer<
    typeof ProjectsListForRepoParamsSchema
  >

  export const ProjectsListForRepoResponseSchema = z.array(ProjectSchema)
  export type ProjectsListForRepoResponse = z.infer<
    typeof ProjectsListForRepoResponseSchema
  >

  export const ProjectsCreateForRepoParamsSchema = z.object({
    name: z.string().describe('The name of the project.'),
    body: z.string().describe('The description of the project.').optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ProjectsCreateForRepoParams = z.infer<
    typeof ProjectsCreateForRepoParamsSchema
  >

  export type ProjectsCreateForRepoResponse = undefined

  export const ReposGetCustomPropertiesValuesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetCustomPropertiesValuesParams = z.infer<
    typeof ReposGetCustomPropertiesValuesParamsSchema
  >

  export const ReposGetCustomPropertiesValuesResponseSchema = z.array(
    CustomPropertyValueSchema
  )
  export type ReposGetCustomPropertiesValuesResponse = z.infer<
    typeof ReposGetCustomPropertiesValuesResponseSchema
  >

  export const ReposCreateOrUpdateCustomPropertiesValuesParamsSchema = z.object(
    {
      properties: z
        .array(CustomPropertyValueSchema)
        .describe(
          'A list of custom property names and associated values to apply to the repositories.'
        ),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    }
  )
  export type ReposCreateOrUpdateCustomPropertiesValuesParams = z.infer<
    typeof ReposCreateOrUpdateCustomPropertiesValuesParamsSchema
  >

  export type ReposCreateOrUpdateCustomPropertiesValuesResponse = undefined

  export const PullsListParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Either `open`, `closed`, or `all` to filter by state.')
      .default('open'),
    head: z
      .string()
      .describe(
        'Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.'
      )
      .optional(),
    base: z
      .string()
      .describe('Filter pulls by base branch name. Example: `gh-pages`.')
      .optional(),
    sort: z
      .enum(['created', 'updated', 'popularity', 'long-running'])
      .describe(
        'What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.'
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListParams = z.infer<typeof PullsListParamsSchema>

  export const PullsListResponseSchema = z.array(PullRequestSimpleSchema)
  export type PullsListResponse = z.infer<typeof PullsListResponseSchema>

  export const PullsCreateParamsSchema = z.object({
    title: z
      .string()
      .describe(
        'The title of the new pull request. Required unless `issue` is specified.'
      )
      .optional(),
    head: z
      .string()
      .describe(
        'The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.'
      ),
    head_repo: z
      .string()
      .describe(
        'The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.'
      )
      .optional(),
    base: z
      .string()
      .describe(
        'The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.'
      ),
    body: z.string().describe('The contents of the pull request.').optional(),
    maintainer_can_modify: z
      .boolean()
      .describe(
        'Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.'
      )
      .optional(),
    draft: z
      .boolean()
      .describe(
        'Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more.'
      )
      .optional(),
    issue: z
      .number()
      .int()
      .describe(
        'An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type PullsCreateParams = z.infer<typeof PullsCreateParamsSchema>

  export type PullsCreateResponse = undefined

  export const PullsListReviewCommentsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sort: z.enum(['created', 'updated', 'created_at']).optional(),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The direction to sort results. Ignored without `sort` parameter.'
      )
      .optional(),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListReviewCommentsForRepoParams = z.infer<
    typeof PullsListReviewCommentsForRepoParamsSchema
  >

  export const PullsListReviewCommentsForRepoResponseSchema = z.array(
    PullRequestReviewCommentSchema
  )
  export type PullsListReviewCommentsForRepoResponse = z.infer<
    typeof PullsListReviewCommentsForRepoResponseSchema
  >

  export const PullsGetReviewCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type PullsGetReviewCommentParams = z.infer<
    typeof PullsGetReviewCommentParamsSchema
  >

  export const PullsGetReviewCommentResponseSchema =
    PullRequestReviewCommentSchema
  export type PullsGetReviewCommentResponse = z.infer<
    typeof PullsGetReviewCommentResponseSchema
  >

  export const PullsDeleteReviewCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type PullsDeleteReviewCommentParams = z.infer<
    typeof PullsDeleteReviewCommentParamsSchema
  >

  export type PullsDeleteReviewCommentResponse = undefined

  export const PullsUpdateReviewCommentParamsSchema = z.object({
    body: z.string().describe('The text of the reply to the review comment.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type PullsUpdateReviewCommentParams = z.infer<
    typeof PullsUpdateReviewCommentParamsSchema
  >

  export const PullsUpdateReviewCommentResponseSchema =
    PullRequestReviewCommentSchema
  export type PullsUpdateReviewCommentResponse = z.infer<
    typeof PullsUpdateReviewCommentResponseSchema
  >

  export const ReactionsListForPullRequestReviewCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForPullRequestReviewCommentParams = z.infer<
    typeof ReactionsListForPullRequestReviewCommentParamsSchema
  >

  export const ReactionsListForPullRequestReviewCommentResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForPullRequestReviewCommentResponse = z.infer<
    typeof ReactionsListForPullRequestReviewCommentResponseSchema
  >

  export const ReactionsCreateForPullRequestReviewCommentParamsSchema =
    z.object({
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe(
          'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.'
        ),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      comment_id: z
        .number()
        .int()
        .describe('The unique identifier of the comment.')
    })
  export type ReactionsCreateForPullRequestReviewCommentParams = z.infer<
    typeof ReactionsCreateForPullRequestReviewCommentParamsSchema
  >

  export const ReactionsCreateForPullRequestReviewCommentResponseSchema =
    ReactionSchema
  export type ReactionsCreateForPullRequestReviewCommentResponse = z.infer<
    typeof ReactionsCreateForPullRequestReviewCommentResponseSchema
  >

  export const ReactionsDeleteForPullRequestCommentParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForPullRequestCommentParams = z.infer<
    typeof ReactionsDeleteForPullRequestCommentParamsSchema
  >

  export type ReactionsDeleteForPullRequestCommentResponse = undefined

  export const PullsGetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsGetParams = z.infer<typeof PullsGetParamsSchema>

  export const PullsGetResponseSchema = PullRequestSchema
  export type PullsGetResponse = z.infer<typeof PullsGetResponseSchema>

  export const PullsUpdateParamsSchema = z.object({
    title: z.string().describe('The title of the pull request.').optional(),
    body: z.string().describe('The contents of the pull request.').optional(),
    state: z
      .enum(['open', 'closed'])
      .describe('State of this Pull Request. Either `open` or `closed`.')
      .optional(),
    base: z
      .string()
      .describe(
        'The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.'
      )
      .optional(),
    maintainer_can_modify: z
      .boolean()
      .describe(
        'Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsUpdateParams = z.infer<typeof PullsUpdateParamsSchema>

  export const PullsUpdateResponseSchema = PullRequestSchema
  export type PullsUpdateResponse = z.infer<typeof PullsUpdateResponseSchema>

  export const CodespacesCreateWithPrForAuthenticatedUserParamsSchema =
    z.object({
      location: z
        .string()
        .describe(
          'The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.'
        )
        .optional(),
      geo: z
        .enum(['EuropeWest', 'SoutheastAsia', 'UsEast', 'UsWest'])
        .describe(
          'The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.'
        )
        .optional(),
      client_ip: z
        .string()
        .describe('IP for location auto-detection when proxying a request')
        .optional(),
      machine: z
        .string()
        .describe('Machine type to use for this codespace')
        .optional(),
      devcontainer_path: z
        .string()
        .describe('Path to devcontainer.json config to use for this codespace')
        .optional(),
      multi_repo_permissions_opt_out: z
        .boolean()
        .describe(
          'Whether to authorize requested permissions from devcontainer.json'
        )
        .optional(),
      working_directory: z
        .string()
        .describe('Working directory for this codespace')
        .optional(),
      idle_timeout_minutes: z
        .number()
        .int()
        .describe('Time in minutes before codespace stops from inactivity')
        .optional(),
      display_name: z
        .string()
        .describe('Display name for this codespace')
        .optional(),
      retention_period_minutes: z
        .number()
        .int()
        .describe(
          'Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).'
        )
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      pull_number: z
        .number()
        .int()
        .describe('The number that identifies the pull request.')
    })
  export type CodespacesCreateWithPrForAuthenticatedUserParams = z.infer<
    typeof CodespacesCreateWithPrForAuthenticatedUserParamsSchema
  >

  export type CodespacesCreateWithPrForAuthenticatedUserResponse = undefined

  export const PullsListReviewCommentsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    sort: z
      .enum(['created', 'updated'])
      .describe('The property to sort the results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The direction to sort results. Ignored without `sort` parameter.'
      )
      .optional(),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListReviewCommentsParams = z.infer<
    typeof PullsListReviewCommentsParamsSchema
  >

  export const PullsListReviewCommentsResponseSchema = z.array(
    PullRequestReviewCommentSchema
  )
  export type PullsListReviewCommentsResponse = z.infer<
    typeof PullsListReviewCommentsResponseSchema
  >

  export const PullsCreateReviewCommentParamsSchema = z.object({
    body: z.string().describe('The text of the review comment.'),
    commit_id: z
      .string()
      .describe(
        'The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.'
      ),
    path: z
      .string()
      .describe('The relative path to the file that necessitates a comment.'),
    position: z
      .number()
      .int()
      .describe(
        '**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.'
      )
      .optional(),
    side: z
      .enum(['LEFT', 'RIGHT'])
      .describe(
        'In a split diff view, the side of the diff that the pull request\'s changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation.'
      )
      .optional(),
    line: z
      .number()
      .int()
      .describe(
        '**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.'
      )
      .optional(),
    start_line: z
      .number()
      .int()
      .describe(
        '**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation.'
      )
      .optional(),
    start_side: z
      .enum(['LEFT', 'RIGHT', 'side'])
      .describe(
        '**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.'
      )
      .optional(),
    in_reply_to: z
      .number()
      .int()
      .describe(
        'The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.'
      )
      .optional(),
    subject_type: z
      .enum(['line', 'file'])
      .describe('The level at which the comment is targeted.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsCreateReviewCommentParams = z.infer<
    typeof PullsCreateReviewCommentParamsSchema
  >

  export type PullsCreateReviewCommentResponse = undefined

  export const PullsCreateReplyForReviewCommentParamsSchema = z.object({
    body: z.string().describe('The text of the review comment.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    comment_id: z
      .number()
      .int()
      .describe('The unique identifier of the comment.')
  })
  export type PullsCreateReplyForReviewCommentParams = z.infer<
    typeof PullsCreateReplyForReviewCommentParamsSchema
  >

  export type PullsCreateReplyForReviewCommentResponse = undefined

  export const PullsListCommitsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListCommitsParams = z.infer<
    typeof PullsListCommitsParamsSchema
  >

  export const PullsListCommitsResponseSchema = z.array(CommitSchema)
  export type PullsListCommitsResponse = z.infer<
    typeof PullsListCommitsResponseSchema
  >

  export const PullsListFilesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListFilesParams = z.infer<typeof PullsListFilesParamsSchema>

  export const PullsListFilesResponseSchema = z.array(DiffEntrySchema)
  export type PullsListFilesResponse = z.infer<
    typeof PullsListFilesResponseSchema
  >

  export const PullsCheckIfMergedParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsCheckIfMergedParams = z.infer<
    typeof PullsCheckIfMergedParamsSchema
  >

  export type PullsCheckIfMergedResponse = undefined

  export const PullsMergeParamsSchema = z.object({
    commit_title: z
      .string()
      .describe('Title for the automatic commit message.')
      .optional(),
    commit_message: z
      .string()
      .describe('Extra detail to append to automatic commit message.')
      .optional(),
    sha: z
      .string()
      .describe('SHA that pull request head must match to allow merge.')
      .optional(),
    merge_method: z
      .enum(['merge', 'squash', 'rebase'])
      .describe('The merge method to use.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsMergeParams = z.infer<typeof PullsMergeParamsSchema>

  export const PullsMergeResponseSchema = PullRequestMergeResultSchema
  export type PullsMergeResponse = z.infer<typeof PullsMergeResponseSchema>

  export const PullsListRequestedReviewersParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsListRequestedReviewersParams = z.infer<
    typeof PullsListRequestedReviewersParamsSchema
  >

  export const PullsListRequestedReviewersResponseSchema =
    PullRequestReviewRequestSchema
  export type PullsListRequestedReviewersResponse = z.infer<
    typeof PullsListRequestedReviewersResponseSchema
  >

  export const PullsRequestReviewersParamsSchema = z
    .object({
      reviewers: z
        .array(z.string())
        .describe('An array of user `login`s that will be requested.')
        .optional(),
      team_reviewers: z
        .array(z.string())
        .describe('An array of team `slug`s that will be requested.')
        .optional(),
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      pull_number: z
        .number()
        .int()
        .describe('The number that identifies the pull request.')
    })
    .and(z.union([z.any(), z.any()]))
  export type PullsRequestReviewersParams = z.infer<
    typeof PullsRequestReviewersParamsSchema
  >

  export type PullsRequestReviewersResponse = undefined

  export const PullsRemoveRequestedReviewersParamsSchema = z.object({
    reviewers: z
      .array(z.string())
      .describe('An array of user `login`s that will be removed.'),
    team_reviewers: z
      .array(z.string())
      .describe('An array of team `slug`s that will be removed.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsRemoveRequestedReviewersParams = z.infer<
    typeof PullsRemoveRequestedReviewersParamsSchema
  >

  export const PullsRemoveRequestedReviewersResponseSchema =
    PullRequestSimpleSchema
  export type PullsRemoveRequestedReviewersResponse = z.infer<
    typeof PullsRemoveRequestedReviewersResponseSchema
  >

  export const PullsListReviewsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListReviewsParams = z.infer<
    typeof PullsListReviewsParamsSchema
  >

  export const PullsListReviewsResponseSchema = z.array(PullRequestReviewSchema)
  export type PullsListReviewsResponse = z.infer<
    typeof PullsListReviewsResponseSchema
  >

  export const PullsCreateReviewParamsSchema = z.object({
    commit_id: z
      .string()
      .describe(
        'The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.'
      )
      .optional(),
    body: z
      .string()
      .describe(
        '**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.'
      )
      .optional(),
    event: z
      .enum(['APPROVE', 'REQUEST_CHANGES', 'COMMENT'])
      .describe(
        'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.'
      )
      .optional(),
    comments: z
      .array(
        z.object({
          path: z
            .string()
            .describe(
              'The relative path to the file that necessitates a review comment.'
            ),
          position: z
            .number()
            .int()
            .describe(
              'The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.'
            )
            .optional(),
          body: z.string().describe('Text of the review comment.'),
          line: z.number().int().optional(),
          side: z.string().optional(),
          start_line: z.number().int().optional(),
          start_side: z.string().optional()
        })
      )
      .describe(
        'Use the following table to specify the location, destination, and contents of the draft review comment.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsCreateReviewParams = z.infer<
    typeof PullsCreateReviewParamsSchema
  >

  export const PullsCreateReviewResponseSchema = PullRequestReviewSchema
  export type PullsCreateReviewResponse = z.infer<
    typeof PullsCreateReviewResponseSchema
  >

  export const PullsGetReviewParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z.number().int().describe('The unique identifier of the review.')
  })
  export type PullsGetReviewParams = z.infer<typeof PullsGetReviewParamsSchema>

  export const PullsGetReviewResponseSchema = PullRequestReviewSchema
  export type PullsGetReviewResponse = z.infer<
    typeof PullsGetReviewResponseSchema
  >

  export const PullsUpdateReviewParamsSchema = z.object({
    body: z.string().describe('The body text of the pull request review.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z.number().int().describe('The unique identifier of the review.')
  })
  export type PullsUpdateReviewParams = z.infer<
    typeof PullsUpdateReviewParamsSchema
  >

  export const PullsUpdateReviewResponseSchema = PullRequestReviewSchema
  export type PullsUpdateReviewResponse = z.infer<
    typeof PullsUpdateReviewResponseSchema
  >

  export const PullsDeletePendingReviewParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z.number().int().describe('The unique identifier of the review.')
  })
  export type PullsDeletePendingReviewParams = z.infer<
    typeof PullsDeletePendingReviewParamsSchema
  >

  export const PullsDeletePendingReviewResponseSchema = PullRequestReviewSchema
  export type PullsDeletePendingReviewResponse = z.infer<
    typeof PullsDeletePendingReviewResponseSchema
  >

  export const PullsListCommentsForReviewParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z
      .number()
      .int()
      .describe('The unique identifier of the review.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type PullsListCommentsForReviewParams = z.infer<
    typeof PullsListCommentsForReviewParamsSchema
  >

  export const PullsListCommentsForReviewResponseSchema =
    z.array(ReviewCommentSchema)
  export type PullsListCommentsForReviewResponse = z.infer<
    typeof PullsListCommentsForReviewResponseSchema
  >

  export const PullsDismissReviewParamsSchema = z.object({
    message: z
      .string()
      .describe('The message for the pull request review dismissal'),
    event: z.literal('DISMISS').optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z.number().int().describe('The unique identifier of the review.')
  })
  export type PullsDismissReviewParams = z.infer<
    typeof PullsDismissReviewParamsSchema
  >

  export const PullsDismissReviewResponseSchema = PullRequestReviewSchema
  export type PullsDismissReviewResponse = z.infer<
    typeof PullsDismissReviewResponseSchema
  >

  export const PullsSubmitReviewParamsSchema = z.object({
    body: z
      .string()
      .describe('The body text of the pull request review')
      .optional(),
    event: z
      .enum(['APPROVE', 'REQUEST_CHANGES', 'COMMENT'])
      .describe(
        'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.'),
    review_id: z.number().int().describe('The unique identifier of the review.')
  })
  export type PullsSubmitReviewParams = z.infer<
    typeof PullsSubmitReviewParamsSchema
  >

  export const PullsSubmitReviewResponseSchema = PullRequestReviewSchema
  export type PullsSubmitReviewResponse = z.infer<
    typeof PullsSubmitReviewResponseSchema
  >

  export const PullsUpdateBranchParamsSchema = z.object({
    expected_head_sha: z
      .string()
      .describe(
        "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref."
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    pull_number: z
      .number()
      .int()
      .describe('The number that identifies the pull request.')
  })
  export type PullsUpdateBranchParams = z.infer<
    typeof PullsUpdateBranchParamsSchema
  >

  export type PullsUpdateBranchResponse = undefined

  export const ReposGetReadmeParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The name of the commit/branch/tag. Default: the repository’s default branch.'
      )
      .optional()
  })
  export type ReposGetReadmeParams = z.infer<typeof ReposGetReadmeParamsSchema>

  export const ReposGetReadmeResponseSchema = ContentFileSchema
  export type ReposGetReadmeResponse = z.infer<
    typeof ReposGetReadmeResponseSchema
  >

  export const ReposGetReadmeInDirectoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    dir: z.string().describe('The alternate path to look for a README file'),
    ref: z
      .string()
      .describe(
        'The name of the commit/branch/tag. Default: the repository’s default branch.'
      )
      .optional()
  })
  export type ReposGetReadmeInDirectoryParams = z.infer<
    typeof ReposGetReadmeInDirectoryParamsSchema
  >

  export const ReposGetReadmeInDirectoryResponseSchema = ContentFileSchema
  export type ReposGetReadmeInDirectoryResponse = z.infer<
    typeof ReposGetReadmeInDirectoryResponseSchema
  >

  export const ReposListReleasesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListReleasesParams = z.infer<
    typeof ReposListReleasesParamsSchema
  >

  export const ReposListReleasesResponseSchema = z.array(ReleaseSchema)
  export type ReposListReleasesResponse = z.infer<
    typeof ReposListReleasesResponseSchema
  >

  export const ReposCreateReleaseParamsSchema = z.object({
    tag_name: z.string().describe('The name of the tag.'),
    target_commitish: z
      .string()
      .describe(
        "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."
      )
      .optional(),
    name: z.string().describe('The name of the release.').optional(),
    body: z
      .string()
      .describe('Text describing the contents of the tag.')
      .optional(),
    draft: z
      .boolean()
      .describe(
        '`true` to create a draft (unpublished) release, `false` to create a published one.'
      )
      .default(false),
    prerelease: z
      .boolean()
      .describe(
        '`true` to identify the release as a prerelease. `false` to identify the release as a full release.'
      )
      .default(false),
    discussion_category_name: z
      .string()
      .describe(
        'If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."'
      )
      .optional(),
    generate_release_notes: z
      .boolean()
      .describe(
        'Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.'
      )
      .default(false),
    make_latest: z
      .enum(['true', 'false', 'legacy'])
      .describe(
        'Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.'
      )
      .default('true'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateReleaseParams = z.infer<
    typeof ReposCreateReleaseParamsSchema
  >

  export type ReposCreateReleaseResponse = undefined

  export const ReposGetReleaseAssetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    asset_id: z.number().int().describe('The unique identifier of the asset.')
  })
  export type ReposGetReleaseAssetParams = z.infer<
    typeof ReposGetReleaseAssetParamsSchema
  >

  export const ReposGetReleaseAssetResponseSchema = ReleaseAssetSchema
  export type ReposGetReleaseAssetResponse = z.infer<
    typeof ReposGetReleaseAssetResponseSchema
  >

  export const ReposDeleteReleaseAssetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    asset_id: z.number().int().describe('The unique identifier of the asset.')
  })
  export type ReposDeleteReleaseAssetParams = z.infer<
    typeof ReposDeleteReleaseAssetParamsSchema
  >

  export type ReposDeleteReleaseAssetResponse = undefined

  export const ReposUpdateReleaseAssetParamsSchema = z.object({
    name: z.string().describe('The file name of the asset.').optional(),
    label: z
      .string()
      .describe(
        'An alternate short description of the asset. Used in place of the filename.'
      )
      .optional(),
    state: z.string().optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    asset_id: z.number().int().describe('The unique identifier of the asset.')
  })
  export type ReposUpdateReleaseAssetParams = z.infer<
    typeof ReposUpdateReleaseAssetParamsSchema
  >

  export const ReposUpdateReleaseAssetResponseSchema = ReleaseAssetSchema
  export type ReposUpdateReleaseAssetResponse = z.infer<
    typeof ReposUpdateReleaseAssetResponseSchema
  >

  export const ReposGenerateReleaseNotesParamsSchema = z.object({
    tag_name: z
      .string()
      .describe(
        'The tag name for the release. This can be an existing tag or a new one.'
      ),
    target_commitish: z
      .string()
      .describe(
        "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists."
      )
      .optional(),
    previous_tag_name: z
      .string()
      .describe(
        'The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.'
      )
      .optional(),
    configuration_file_path: z
      .string()
      .describe(
        "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used."
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGenerateReleaseNotesParams = z.infer<
    typeof ReposGenerateReleaseNotesParamsSchema
  >

  export const ReposGenerateReleaseNotesResponseSchema =
    ReleaseNotesContentSchema
  export type ReposGenerateReleaseNotesResponse = z.infer<
    typeof ReposGenerateReleaseNotesResponseSchema
  >

  export const ReposGetLatestReleaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetLatestReleaseParams = z.infer<
    typeof ReposGetLatestReleaseParamsSchema
  >

  export const ReposGetLatestReleaseResponseSchema = ReleaseSchema
  export type ReposGetLatestReleaseResponse = z.infer<
    typeof ReposGetLatestReleaseResponseSchema
  >

  export const ReposGetReleaseByTagParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tag: z.string().describe('tag parameter')
  })
  export type ReposGetReleaseByTagParams = z.infer<
    typeof ReposGetReleaseByTagParamsSchema
  >

  export const ReposGetReleaseByTagResponseSchema = ReleaseSchema
  export type ReposGetReleaseByTagResponse = z.infer<
    typeof ReposGetReleaseByTagResponseSchema
  >

  export const ReposGetReleaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.')
  })
  export type ReposGetReleaseParams = z.infer<
    typeof ReposGetReleaseParamsSchema
  >

  export const ReposGetReleaseResponseSchema = ReleaseSchema
  export type ReposGetReleaseResponse = z.infer<
    typeof ReposGetReleaseResponseSchema
  >

  export const ReposDeleteReleaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.')
  })
  export type ReposDeleteReleaseParams = z.infer<
    typeof ReposDeleteReleaseParamsSchema
  >

  export type ReposDeleteReleaseResponse = undefined

  export const ReposUpdateReleaseParamsSchema = z.object({
    tag_name: z.string().describe('The name of the tag.').optional(),
    target_commitish: z
      .string()
      .describe(
        "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch."
      )
      .optional(),
    name: z.string().describe('The name of the release.').optional(),
    body: z
      .string()
      .describe('Text describing the contents of the tag.')
      .optional(),
    draft: z
      .boolean()
      .describe(
        '`true` makes the release a draft, and `false` publishes the release.'
      )
      .optional(),
    prerelease: z
      .boolean()
      .describe(
        '`true` to identify the release as a prerelease, `false` to identify the release as a full release.'
      )
      .optional(),
    make_latest: z
      .enum(['true', 'false', 'legacy'])
      .describe(
        'Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.'
      )
      .default('true'),
    discussion_category_name: z
      .string()
      .describe(
        'If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)."'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.')
  })
  export type ReposUpdateReleaseParams = z.infer<
    typeof ReposUpdateReleaseParamsSchema
  >

  export const ReposUpdateReleaseResponseSchema = ReleaseSchema
  export type ReposUpdateReleaseResponse = z.infer<
    typeof ReposUpdateReleaseResponseSchema
  >

  export const ReposListReleaseAssetsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListReleaseAssetsParams = z.infer<
    typeof ReposListReleaseAssetsParamsSchema
  >

  export const ReposListReleaseAssetsResponseSchema =
    z.array(ReleaseAssetSchema)
  export type ReposListReleaseAssetsResponse = z.infer<
    typeof ReposListReleaseAssetsResponseSchema
  >

  export const ReposUploadReleaseAssetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.'),
    name: z.string(),
    label: z.string().optional()
  })
  export type ReposUploadReleaseAssetParams = z.infer<
    typeof ReposUploadReleaseAssetParamsSchema
  >

  export type ReposUploadReleaseAssetResponse = undefined

  export const ReactionsListForReleaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.'),
    content: z
      .enum(['+1', 'laugh', 'heart', 'hooray', 'rocket', 'eyes'])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForReleaseParams = z.infer<
    typeof ReactionsListForReleaseParamsSchema
  >

  export const ReactionsListForReleaseResponseSchema = z.array(ReactionSchema)
  export type ReactionsListForReleaseResponse = z.infer<
    typeof ReactionsListForReleaseResponseSchema
  >

  export const ReactionsCreateForReleaseParamsSchema = z.object({
    content: z
      .enum(['+1', 'laugh', 'heart', 'hooray', 'rocket', 'eyes'])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.')
  })
  export type ReactionsCreateForReleaseParams = z.infer<
    typeof ReactionsCreateForReleaseParamsSchema
  >

  export const ReactionsCreateForReleaseResponseSchema = ReactionSchema
  export type ReactionsCreateForReleaseResponse = z.infer<
    typeof ReactionsCreateForReleaseResponseSchema
  >

  export const ReactionsDeleteForReleaseParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    release_id: z
      .number()
      .int()
      .describe('The unique identifier of the release.'),
    reaction_id: z
      .number()
      .int()
      .describe('The unique identifier of the reaction.')
  })
  export type ReactionsDeleteForReleaseParams = z.infer<
    typeof ReactionsDeleteForReleaseParamsSchema
  >

  export type ReactionsDeleteForReleaseResponse = undefined

  export const ReposGetBranchRulesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    branch: z
      .string()
      .describe(
        'The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetBranchRulesParams = z.infer<
    typeof ReposGetBranchRulesParamsSchema
  >

  export const ReposGetBranchRulesResponseSchema = z.array(
    RepositoryRuleDetailedSchema
  )
  export type ReposGetBranchRulesResponse = z.infer<
    typeof ReposGetBranchRulesResponseSchema
  >

  export const ReposGetRepoRulesetsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    includes_parents: z
      .boolean()
      .describe(
        'Include rulesets configured at higher levels that apply to this repository'
      )
      .default(true),
    targets: z
      .string()
      .describe(
        'A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n'
      )
      .optional()
  })
  export type ReposGetRepoRulesetsParams = z.infer<
    typeof ReposGetRepoRulesetsParamsSchema
  >

  export const ReposGetRepoRulesetsResponseSchema = z.array(
    RepositoryRulesetSchema
  )
  export type ReposGetRepoRulesetsResponse = z.infer<
    typeof ReposGetRepoRulesetsResponseSchema
  >

  export const ReposCreateRepoRulesetParamsSchema = z.object({
    name: z.string().describe('The name of the ruleset.'),
    target: z
      .enum(['branch', 'tag', 'push'])
      .describe('The target of the ruleset')
      .default('branch'),
    enforcement: RepositoryRuleEnforcementSchema,
    bypass_actors: z
      .array(RepositoryRulesetBypassActorSchema)
      .describe('The actors that can bypass the rules in this ruleset')
      .optional(),
    conditions: RepositoryRulesetConditionsSchema.optional(),
    rules: z
      .array(RepositoryRuleSchema)
      .describe('An array of rules within the ruleset.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateRepoRulesetParams = z.infer<
    typeof ReposCreateRepoRulesetParamsSchema
  >

  export type ReposCreateRepoRulesetResponse = undefined

  export const ReposGetRepoRuleSuitesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z
      .string()
      .describe(
        'The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.'
      )
      .optional(),
    time_period: z
      .enum(['hour', 'day', 'week', 'month'])
      .describe(
        'The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).'
      )
      .default('day'),
    actor_name: z
      .string()
      .describe(
        'The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.'
      )
      .optional(),
    rule_suite_result: z
      .enum(['pass', 'fail', 'bypass', 'all'])
      .describe(
        'The rule results to filter on. When specified, only suites with this result will be returned.'
      )
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetRepoRuleSuitesParams = z.infer<
    typeof ReposGetRepoRuleSuitesParamsSchema
  >

  export const ReposGetRepoRuleSuitesResponseSchema = RuleSuitesSchema
  export type ReposGetRepoRuleSuitesResponse = z.infer<
    typeof ReposGetRepoRuleSuitesResponseSchema
  >

  export const ReposGetRepoRuleSuiteParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    rule_suite_id: z
      .number()
      .int()
      .describe(
        'The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.'
      )
  })
  export type ReposGetRepoRuleSuiteParams = z.infer<
    typeof ReposGetRepoRuleSuiteParamsSchema
  >

  export const ReposGetRepoRuleSuiteResponseSchema = RuleSuiteSchema
  export type ReposGetRepoRuleSuiteResponse = z.infer<
    typeof ReposGetRepoRuleSuiteResponseSchema
  >

  export const ReposGetRepoRulesetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ruleset_id: z.number().int().describe('The ID of the ruleset.'),
    includes_parents: z
      .boolean()
      .describe(
        'Include rulesets configured at higher levels that apply to this repository'
      )
      .default(true)
  })
  export type ReposGetRepoRulesetParams = z.infer<
    typeof ReposGetRepoRulesetParamsSchema
  >

  export const ReposGetRepoRulesetResponseSchema = RepositoryRulesetSchema
  export type ReposGetRepoRulesetResponse = z.infer<
    typeof ReposGetRepoRulesetResponseSchema
  >

  export const ReposUpdateRepoRulesetParamsSchema = z.object({
    name: z.string().describe('The name of the ruleset.').optional(),
    target: z
      .enum(['branch', 'tag', 'push'])
      .describe('The target of the ruleset')
      .optional(),
    enforcement: RepositoryRuleEnforcementSchema.optional(),
    bypass_actors: z
      .array(RepositoryRulesetBypassActorSchema)
      .describe('The actors that can bypass the rules in this ruleset')
      .optional(),
    conditions: RepositoryRulesetConditionsSchema.optional(),
    rules: z
      .array(RepositoryRuleSchema)
      .describe('An array of rules within the ruleset.')
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ruleset_id: z.number().int().describe('The ID of the ruleset.')
  })
  export type ReposUpdateRepoRulesetParams = z.infer<
    typeof ReposUpdateRepoRulesetParamsSchema
  >

  export const ReposUpdateRepoRulesetResponseSchema = RepositoryRulesetSchema
  export type ReposUpdateRepoRulesetResponse = z.infer<
    typeof ReposUpdateRepoRulesetResponseSchema
  >

  export const ReposDeleteRepoRulesetParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ruleset_id: z.number().int().describe('The ID of the ruleset.')
  })
  export type ReposDeleteRepoRulesetParams = z.infer<
    typeof ReposDeleteRepoRulesetParamsSchema
  >

  export type ReposDeleteRepoRulesetResponse = undefined

  export const ReposGetRepoRulesetHistoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ruleset_id: z.number().int().describe('The ID of the ruleset.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposGetRepoRulesetHistoryParams = z.infer<
    typeof ReposGetRepoRulesetHistoryParamsSchema
  >

  export const ReposGetRepoRulesetHistoryResponseSchema =
    z.array(RulesetVersionSchema)
  export type ReposGetRepoRulesetHistoryResponse = z.infer<
    typeof ReposGetRepoRulesetHistoryResponseSchema
  >

  export const ReposGetRepoRulesetVersionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ruleset_id: z.number().int().describe('The ID of the ruleset.'),
    version_id: z.number().int().describe('The ID of the version')
  })
  export type ReposGetRepoRulesetVersionParams = z.infer<
    typeof ReposGetRepoRulesetVersionParamsSchema
  >

  export const ReposGetRepoRulesetVersionResponseSchema =
    RulesetVersionWithStateSchema
  export type ReposGetRepoRulesetVersionResponse = z.infer<
    typeof ReposGetRepoRulesetVersionResponseSchema
  >

  export const SecretScanningListAlertsForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    state: z
      .enum(['open', 'resolved'])
      .describe(
        'Set to `open` or `resolved` to only list secret scanning alerts in a specific state.'
      )
      .optional(),
    secret_type: z
      .string()
      .describe(
        'A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.'
      )
      .optional(),
    resolution: z
      .string()
      .describe(
        'A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated'])
      .describe(
        'The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.'
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.  To receive an initial cursor on your first request, include an empty "after" query string.'
      )
      .optional(),
    validity: z
      .string()
      .describe(
        'A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.'
      )
      .optional(),
    is_publicly_leaked: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.'
      )
      .default(false),
    is_multi_repo: z
      .boolean()
      .describe(
        'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.'
      )
      .default(false)
  })
  export type SecretScanningListAlertsForRepoParams = z.infer<
    typeof SecretScanningListAlertsForRepoParamsSchema
  >

  export const SecretScanningListAlertsForRepoResponseSchema = z.array(
    SecretScanningAlertSchema
  )
  export type SecretScanningListAlertsForRepoResponse = z.infer<
    typeof SecretScanningListAlertsForRepoResponseSchema
  >

  export const SecretScanningGetAlertParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type SecretScanningGetAlertParams = z.infer<
    typeof SecretScanningGetAlertParamsSchema
  >

  export const SecretScanningGetAlertResponseSchema = SecretScanningAlertSchema
  export type SecretScanningGetAlertResponse = z.infer<
    typeof SecretScanningGetAlertResponseSchema
  >

  export const SecretScanningUpdateAlertParamsSchema = z.object({
    state: SecretScanningAlertStateSchema,
    resolution: SecretScanningAlertResolutionSchema.optional(),
    resolution_comment: SecretScanningAlertResolutionCommentSchema.optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      )
  })
  export type SecretScanningUpdateAlertParams = z.infer<
    typeof SecretScanningUpdateAlertParamsSchema
  >

  export const SecretScanningUpdateAlertResponseSchema =
    SecretScanningAlertSchema
  export type SecretScanningUpdateAlertResponse = z.infer<
    typeof SecretScanningUpdateAlertResponseSchema
  >

  export const SecretScanningListLocationsForAlertParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    alert_number: z
      .any()
      .describe(
        'The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.'
      ),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type SecretScanningListLocationsForAlertParams = z.infer<
    typeof SecretScanningListLocationsForAlertParamsSchema
  >

  export const SecretScanningListLocationsForAlertResponseSchema = z
    .array(SecretScanningLocationSchema)
    .describe('List of locations where the secret was detected')
  export type SecretScanningListLocationsForAlertResponse = z.infer<
    typeof SecretScanningListLocationsForAlertResponseSchema
  >

  export const SecretScanningCreatePushProtectionBypassParamsSchema = z.object({
    reason: SecretScanningPushProtectionBypassReasonSchema,
    placeholder_id: SecretScanningPushProtectionBypassPlaceholderIdSchema,
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type SecretScanningCreatePushProtectionBypassParams = z.infer<
    typeof SecretScanningCreatePushProtectionBypassParamsSchema
  >

  export const SecretScanningCreatePushProtectionBypassResponseSchema =
    SecretScanningPushProtectionBypassSchema
  export type SecretScanningCreatePushProtectionBypassResponse = z.infer<
    typeof SecretScanningCreatePushProtectionBypassResponseSchema
  >

  export const SecretScanningGetScanHistoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type SecretScanningGetScanHistoryParams = z.infer<
    typeof SecretScanningGetScanHistoryParamsSchema
  >

  export const SecretScanningGetScanHistoryResponseSchema =
    SecretScanningScanHistorySchema
  export type SecretScanningGetScanHistoryResponse = z.infer<
    typeof SecretScanningGetScanHistoryResponseSchema
  >

  export const SecurityAdvisoriesListRepositoryAdvisoriesParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      direction: z
        .enum(['asc', 'desc'])
        .describe('The direction to sort the results by.')
        .default('desc'),
      sort: z
        .enum(['created', 'updated', 'published'])
        .describe('The property to sort the results by.')
        .default('created'),
      before: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      after: z
        .string()
        .describe(
          'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .optional(),
      per_page: z
        .number()
        .int()
        .gte(1)
        .lte(100)
        .describe(
          'The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      state: z
        .enum(['triage', 'draft', 'published', 'closed'])
        .describe(
          'Filter by state of the repository advisories. Only advisories of this state will be returned.'
        )
        .optional()
    })
  export type SecurityAdvisoriesListRepositoryAdvisoriesParams = z.infer<
    typeof SecurityAdvisoriesListRepositoryAdvisoriesParamsSchema
  >

  export const SecurityAdvisoriesListRepositoryAdvisoriesResponseSchema =
    z.array(RepositoryAdvisorySchema)
  export type SecurityAdvisoriesListRepositoryAdvisoriesResponse = z.infer<
    typeof SecurityAdvisoriesListRepositoryAdvisoriesResponseSchema
  >

  export const SecurityAdvisoriesCreateRepositoryAdvisoryParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
    .merge(RepositoryAdvisoryCreateSchema)
  export type SecurityAdvisoriesCreateRepositoryAdvisoryParams = z.infer<
    typeof SecurityAdvisoriesCreateRepositoryAdvisoryParamsSchema
  >

  export type SecurityAdvisoriesCreateRepositoryAdvisoryResponse = undefined

  export const SecurityAdvisoriesCreatePrivateVulnerabilityReportParamsSchema =
    z
      .object({
        owner: z
          .string()
          .describe(
            'The account owner of the repository. The name is not case sensitive.'
          ),
        repo: z
          .string()
          .describe(
            'The name of the repository without the `.git` extension. The name is not case sensitive.'
          )
      })
      .merge(PrivateVulnerabilityReportCreateSchema)
  export type SecurityAdvisoriesCreatePrivateVulnerabilityReportParams =
    z.infer<
      typeof SecurityAdvisoriesCreatePrivateVulnerabilityReportParamsSchema
    >

  export type SecurityAdvisoriesCreatePrivateVulnerabilityReportResponse =
    undefined

  export const SecurityAdvisoriesGetRepositoryAdvisoryParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ghsa_id: z
      .string()
      .describe(
        'The GHSA (GitHub Security Advisory) identifier of the advisory.'
      )
  })
  export type SecurityAdvisoriesGetRepositoryAdvisoryParams = z.infer<
    typeof SecurityAdvisoriesGetRepositoryAdvisoryParamsSchema
  >

  export const SecurityAdvisoriesGetRepositoryAdvisoryResponseSchema =
    RepositoryAdvisorySchema
  export type SecurityAdvisoriesGetRepositoryAdvisoryResponse = z.infer<
    typeof SecurityAdvisoriesGetRepositoryAdvisoryResponseSchema
  >

  export const SecurityAdvisoriesUpdateRepositoryAdvisoryParamsSchema = z
    .object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      ghsa_id: z
        .string()
        .describe(
          'The GHSA (GitHub Security Advisory) identifier of the advisory.'
        )
    })
    .merge(RepositoryAdvisoryUpdateSchema)
  export type SecurityAdvisoriesUpdateRepositoryAdvisoryParams = z.infer<
    typeof SecurityAdvisoriesUpdateRepositoryAdvisoryParamsSchema
  >

  export const SecurityAdvisoriesUpdateRepositoryAdvisoryResponseSchema =
    RepositoryAdvisorySchema
  export type SecurityAdvisoriesUpdateRepositoryAdvisoryResponse = z.infer<
    typeof SecurityAdvisoriesUpdateRepositoryAdvisoryResponseSchema
  >

  export const SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        ),
      ghsa_id: z
        .string()
        .describe(
          'The GHSA (GitHub Security Advisory) identifier of the advisory.'
        )
    })
  export type SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestParams =
    z.infer<
      typeof SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestParamsSchema
    >

  export type SecurityAdvisoriesCreateRepositoryAdvisoryCveRequestResponse =
    undefined

  export const SecurityAdvisoriesCreateForkParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ghsa_id: z
      .string()
      .describe(
        'The GHSA (GitHub Security Advisory) identifier of the advisory.'
      )
  })
  export type SecurityAdvisoriesCreateForkParams = z.infer<
    typeof SecurityAdvisoriesCreateForkParamsSchema
  >

  export type SecurityAdvisoriesCreateForkResponse = undefined

  export const ActivityListStargazersForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListStargazersForRepoParams = z.infer<
    typeof ActivityListStargazersForRepoParamsSchema
  >

  export const ActivityListStargazersForRepoResponseSchema = z.union([
    z.array(SimpleUserSchema),
    z.array(StargazerSchema)
  ])
  export type ActivityListStargazersForRepoResponse = z.infer<
    typeof ActivityListStargazersForRepoResponseSchema
  >

  export const ReposGetCodeFrequencyStatsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetCodeFrequencyStatsParams = z.infer<
    typeof ReposGetCodeFrequencyStatsParamsSchema
  >

  export const ReposGetCodeFrequencyStatsResponseSchema = z.array(
    CodeFrequencyStatSchema
  )
  export type ReposGetCodeFrequencyStatsResponse = z.infer<
    typeof ReposGetCodeFrequencyStatsResponseSchema
  >

  export const ReposGetCommitActivityStatsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetCommitActivityStatsParams = z.infer<
    typeof ReposGetCommitActivityStatsParamsSchema
  >

  export const ReposGetCommitActivityStatsResponseSchema =
    z.array(CommitActivitySchema)
  export type ReposGetCommitActivityStatsResponse = z.infer<
    typeof ReposGetCommitActivityStatsResponseSchema
  >

  export const ReposGetContributorsStatsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetContributorsStatsParams = z.infer<
    typeof ReposGetContributorsStatsParamsSchema
  >

  export const ReposGetContributorsStatsResponseSchema = z.array(
    ContributorActivitySchema
  )
  export type ReposGetContributorsStatsResponse = z.infer<
    typeof ReposGetContributorsStatsResponseSchema
  >

  export const ReposGetParticipationStatsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetParticipationStatsParams = z.infer<
    typeof ReposGetParticipationStatsParamsSchema
  >

  export const ReposGetParticipationStatsResponseSchema =
    ParticipationStatsSchema
  export type ReposGetParticipationStatsResponse = z.infer<
    typeof ReposGetParticipationStatsResponseSchema
  >

  export const ReposGetPunchCardStatsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetPunchCardStatsParams = z.infer<
    typeof ReposGetPunchCardStatsParamsSchema
  >

  export const ReposGetPunchCardStatsResponseSchema = z.array(
    CodeFrequencyStatSchema
  )
  export type ReposGetPunchCardStatsResponse = z.infer<
    typeof ReposGetPunchCardStatsResponseSchema
  >

  export const ReposCreateCommitStatusParamsSchema = z.object({
    state: z
      .enum(['error', 'failure', 'pending', 'success'])
      .describe('The state of the status.'),
    target_url: z
      .string()
      .describe(
        'The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.  \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:  \n`http://ci.example.com/user/repo/build/sha`'
      )
      .optional(),
    description: z
      .string()
      .describe('A short description of the status.')
      .optional(),
    context: z
      .string()
      .describe(
        'A string label to differentiate this status from the status of other systems. This field is case-insensitive.'
      )
      .default('default'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    sha: z.string()
  })
  export type ReposCreateCommitStatusParams = z.infer<
    typeof ReposCreateCommitStatusParamsSchema
  >

  export type ReposCreateCommitStatusResponse = undefined

  export const ActivityListWatchersForRepoParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListWatchersForRepoParams = z.infer<
    typeof ActivityListWatchersForRepoParamsSchema
  >

  export const ActivityListWatchersForRepoResponseSchema =
    z.array(SimpleUserSchema)
  export type ActivityListWatchersForRepoResponse = z.infer<
    typeof ActivityListWatchersForRepoResponseSchema
  >

  export const ActivityGetRepoSubscriptionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivityGetRepoSubscriptionParams = z.infer<
    typeof ActivityGetRepoSubscriptionParamsSchema
  >

  export const ActivityGetRepoSubscriptionResponseSchema =
    RepositorySubscriptionSchema
  export type ActivityGetRepoSubscriptionResponse = z.infer<
    typeof ActivityGetRepoSubscriptionResponseSchema
  >

  export const ActivitySetRepoSubscriptionParamsSchema = z.object({
    subscribed: z
      .boolean()
      .describe(
        'Determines if notifications should be received from this repository.'
      )
      .optional(),
    ignored: z
      .boolean()
      .describe(
        'Determines if all notifications should be blocked from this repository.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivitySetRepoSubscriptionParams = z.infer<
    typeof ActivitySetRepoSubscriptionParamsSchema
  >

  export const ActivitySetRepoSubscriptionResponseSchema =
    RepositorySubscriptionSchema
  export type ActivitySetRepoSubscriptionResponse = z.infer<
    typeof ActivitySetRepoSubscriptionResponseSchema
  >

  export const ActivityDeleteRepoSubscriptionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivityDeleteRepoSubscriptionParams = z.infer<
    typeof ActivityDeleteRepoSubscriptionParamsSchema
  >

  export type ActivityDeleteRepoSubscriptionResponse = undefined

  export const ReposListTagsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListTagsParams = z.infer<typeof ReposListTagsParamsSchema>

  export const ReposListTagsResponseSchema = z.array(TagSchema)
  export type ReposListTagsResponse = z.infer<
    typeof ReposListTagsResponseSchema
  >

  export const ReposListTagProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposListTagProtectionParams = z.infer<
    typeof ReposListTagProtectionParamsSchema
  >

  export const ReposListTagProtectionResponseSchema =
    z.array(TagProtectionSchema)
  export type ReposListTagProtectionResponse = z.infer<
    typeof ReposListTagProtectionResponseSchema
  >

  export const ReposCreateTagProtectionParamsSchema = z.object({
    pattern: z
      .string()
      .describe(
        'An optional glob pattern to match against when enforcing tag protection.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateTagProtectionParams = z.infer<
    typeof ReposCreateTagProtectionParamsSchema
  >

  export type ReposCreateTagProtectionResponse = undefined

  export const ReposDeleteTagProtectionParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    tag_protection_id: z
      .number()
      .int()
      .describe('The unique identifier of the tag protection.')
  })
  export type ReposDeleteTagProtectionParams = z.infer<
    typeof ReposDeleteTagProtectionParamsSchema
  >

  export type ReposDeleteTagProtectionResponse = undefined

  export const ReposDownloadTarballArchiveParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z.string()
  })
  export type ReposDownloadTarballArchiveParams = z.infer<
    typeof ReposDownloadTarballArchiveParamsSchema
  >

  export type ReposDownloadTarballArchiveResponse = undefined

  export const ReposListTeamsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListTeamsParams = z.infer<typeof ReposListTeamsParamsSchema>

  export const ReposListTeamsResponseSchema = z.array(TeamSchema)
  export type ReposListTeamsResponse = z.infer<
    typeof ReposListTeamsResponseSchema
  >

  export const ReposGetAllTopicsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type ReposGetAllTopicsParams = z.infer<
    typeof ReposGetAllTopicsParamsSchema
  >

  export const ReposGetAllTopicsResponseSchema = TopicSchema
  export type ReposGetAllTopicsResponse = z.infer<
    typeof ReposGetAllTopicsResponseSchema
  >

  export const ReposReplaceAllTopicsParamsSchema = z.object({
    names: z
      .array(z.string())
      .describe(
        'An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.'
      ),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposReplaceAllTopicsParams = z.infer<
    typeof ReposReplaceAllTopicsParamsSchema
  >

  export const ReposReplaceAllTopicsResponseSchema = TopicSchema
  export type ReposReplaceAllTopicsResponse = z.infer<
    typeof ReposReplaceAllTopicsResponseSchema
  >

  export const ReposGetClonesParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per: z
      .enum(['day', 'week'])
      .describe('The time frame to display results for.')
      .default('day')
  })
  export type ReposGetClonesParams = z.infer<typeof ReposGetClonesParamsSchema>

  export const ReposGetClonesResponseSchema = CloneTrafficSchema
  export type ReposGetClonesResponse = z.infer<
    typeof ReposGetClonesResponseSchema
  >

  export const ReposGetTopPathsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetTopPathsParams = z.infer<
    typeof ReposGetTopPathsParamsSchema
  >

  export const ReposGetTopPathsResponseSchema = z.array(ContentTrafficSchema)
  export type ReposGetTopPathsResponse = z.infer<
    typeof ReposGetTopPathsResponseSchema
  >

  export const ReposGetTopReferrersParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposGetTopReferrersParams = z.infer<
    typeof ReposGetTopReferrersParamsSchema
  >

  export const ReposGetTopReferrersResponseSchema = z.array(
    ReferrerTrafficSchema
  )
  export type ReposGetTopReferrersResponse = z.infer<
    typeof ReposGetTopReferrersResponseSchema
  >

  export const ReposGetViewsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    per: z
      .enum(['day', 'week'])
      .describe('The time frame to display results for.')
      .default('day')
  })
  export type ReposGetViewsParams = z.infer<typeof ReposGetViewsParamsSchema>

  export const ReposGetViewsResponseSchema = ViewTrafficSchema
  export type ReposGetViewsResponse = z.infer<
    typeof ReposGetViewsResponseSchema
  >

  export const ReposTransferParamsSchema = z.object({
    new_owner: z
      .string()
      .describe(
        'The username or organization name the repository will be transferred to.'
      ),
    new_name: z
      .string()
      .describe('The new name to be given to the repository.')
      .optional(),
    team_ids: z
      .array(z.number().int())
      .describe(
        'ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.'
      )
      .optional(),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposTransferParams = z.infer<typeof ReposTransferParamsSchema>

  export type ReposTransferResponse = undefined

  export const ReposCheckVulnerabilityAlertsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCheckVulnerabilityAlertsParams = z.infer<
    typeof ReposCheckVulnerabilityAlertsParamsSchema
  >

  export type ReposCheckVulnerabilityAlertsResponse = undefined

  export const ReposEnableVulnerabilityAlertsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposEnableVulnerabilityAlertsParams = z.infer<
    typeof ReposEnableVulnerabilityAlertsParamsSchema
  >

  export type ReposEnableVulnerabilityAlertsResponse = undefined

  export const ReposDisableVulnerabilityAlertsParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposDisableVulnerabilityAlertsParams = z.infer<
    typeof ReposDisableVulnerabilityAlertsParamsSchema
  >

  export type ReposDisableVulnerabilityAlertsResponse = undefined

  export const ReposDownloadZipballArchiveParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      ),
    ref: z.string()
  })
  export type ReposDownloadZipballArchiveParams = z.infer<
    typeof ReposDownloadZipballArchiveParamsSchema
  >

  export type ReposDownloadZipballArchiveResponse = undefined

  export const ReposCreateUsingTemplateParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.'
      )
      .optional(),
    name: z.string().describe('The name of the new repository.'),
    description: z
      .string()
      .describe('A short description of the new repository.')
      .optional(),
    include_all_branches: z
      .boolean()
      .describe(
        'Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.'
      )
      .default(false),
    private: z
      .boolean()
      .describe(
        'Either `true` to create a new private repository or `false` to create a new public one.'
      )
      .default(false),
    template_owner: z
      .string()
      .describe(
        'The account owner of the template repository. The name is not case sensitive.'
      ),
    template_repo: z
      .string()
      .describe(
        'The name of the template repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ReposCreateUsingTemplateParams = z.infer<
    typeof ReposCreateUsingTemplateParamsSchema
  >

  export type ReposCreateUsingTemplateResponse = undefined

  export const ReposListPublicParamsSchema = z.object({
    since: z
      .number()
      .int()
      .describe(
        'A repository ID. Only return repositories with an ID greater than this ID.'
      )
      .optional()
  })
  export type ReposListPublicParams = z.infer<
    typeof ReposListPublicParamsSchema
  >

  export const ReposListPublicResponseSchema = z.array(MinimalRepositorySchema)
  export type ReposListPublicResponse = z.infer<
    typeof ReposListPublicResponseSchema
  >

  export const SearchCodeParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers.'
      ),
    sort: z
      .literal('indexed')
      .describe(
        '**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        '**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. '
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchCodeParams = z.infer<typeof SearchCodeParamsSchema>

  export const SearchCodeResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(CodeSearchResultItemSchema)
  })
  export type SearchCodeResponse = z.infer<typeof SearchCodeResponseSchema>

  export const SearchCommitsParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers.'
      ),
    sort: z
      .enum(['author-date', 'committer-date'])
      .describe(
        'Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchCommitsParams = z.infer<typeof SearchCommitsParamsSchema>

  export const SearchCommitsResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(CommitSearchResultItemSchema)
  })
  export type SearchCommitsResponse = z.infer<
    typeof SearchCommitsResponseSchema
  >

  export const SearchIssuesAndPullRequestsParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers.'
      ),
    sort: z
      .enum([
        'comments',
        'reactions',
        'reactions-+1',
        'reactions--1',
        'reactions-smile',
        'reactions-thinking_face',
        'reactions-heart',
        'reactions-tada',
        'interactions',
        'created',
        'updated'
      ])
      .describe(
        'Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    advanced_search: z
      .string()
      .describe(
        'Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`'
      )
      .optional()
  })
  export type SearchIssuesAndPullRequestsParams = z.infer<
    typeof SearchIssuesAndPullRequestsParamsSchema
  >

  export const SearchIssuesAndPullRequestsResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(IssueSearchResultItemSchema)
  })
  export type SearchIssuesAndPullRequestsResponse = z.infer<
    typeof SearchIssuesAndPullRequestsResponseSchema
  >

  export const SearchLabelsParamsSchema = z.object({
    repository_id: z.number().int().describe('The id of the repository.'),
    q: z
      .string()
      .describe(
        'The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).'
      ),
    sort: z
      .enum(['created', 'updated'])
      .describe(
        'Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchLabelsParams = z.infer<typeof SearchLabelsParamsSchema>

  export const SearchLabelsResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(LabelSearchResultItemSchema)
  })
  export type SearchLabelsResponse = z.infer<typeof SearchLabelsResponseSchema>

  export const SearchReposParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.'
      ),
    sort: z
      .enum(['stars', 'forks', 'help-wanted-issues', 'updated'])
      .describe(
        'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchReposParams = z.infer<typeof SearchReposParamsSchema>

  export const SearchReposResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(RepoSearchResultItemSchema)
  })
  export type SearchReposResponse = z.infer<typeof SearchReposResponseSchema>

  export const SearchTopicsParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).'
      ),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchTopicsParams = z.infer<typeof SearchTopicsParamsSchema>

  export const SearchTopicsResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(TopicSearchResultItemSchema)
  })
  export type SearchTopicsResponse = z.infer<typeof SearchTopicsResponseSchema>

  export const SearchUsersParamsSchema = z.object({
    q: z
      .string()
      .describe(
        'The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers.'
      ),
    sort: z
      .enum(['followers', 'repositories', 'joined'])
      .describe(
        'Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)'
      )
      .optional(),
    order: z
      .enum(['desc', 'asc'])
      .describe(
        'Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.'
      )
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type SearchUsersParams = z.infer<typeof SearchUsersParamsSchema>

  export const SearchUsersResponseSchema = z.object({
    total_count: z.number().int(),
    incomplete_results: z.boolean(),
    items: z.array(UserSearchResultItemSchema)
  })
  export type SearchUsersResponse = z.infer<typeof SearchUsersResponseSchema>

  export const TeamsGetLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.')
  })
  export type TeamsGetLegacyParams = z.infer<typeof TeamsGetLegacyParamsSchema>

  export const TeamsGetLegacyResponseSchema = TeamFullSchema
  export type TeamsGetLegacyResponse = z.infer<
    typeof TeamsGetLegacyResponseSchema
  >

  export const TeamsDeleteLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.')
  })
  export type TeamsDeleteLegacyParams = z.infer<
    typeof TeamsDeleteLegacyParamsSchema
  >

  export type TeamsDeleteLegacyResponse = undefined

  export const TeamsUpdateLegacyParamsSchema = z.object({
    name: z.string().describe('The name of the team.'),
    description: z.string().describe('The description of the team.').optional(),
    privacy: z
      .enum(['secret', 'closed'])
      .describe(
        'The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are:  \n**For a non-nested team:**  \n * `secret` - only visible to organization owners and members of this team.  \n * `closed` - visible to all members of this organization.  \n**For a parent or child team:**  \n * `closed` - visible to all members of this organization.'
      )
      .optional(),
    notification_setting: z
      .enum(['notifications_enabled', 'notifications_disabled'])
      .describe(
        'The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned.  \n * `notifications_disabled` - no one receives notifications.'
      )
      .optional(),
    permission: z
      .enum(['pull', 'push', 'admin'])
      .describe(
        '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.'
      )
      .default('pull'),
    parent_team_id: z
      .number()
      .int()
      .describe('The ID of a team to set as the parent team.')
      .optional(),
    team_id: z.number().int().describe('The unique identifier of the team.')
  })
  export type TeamsUpdateLegacyParams = z.infer<
    typeof TeamsUpdateLegacyParamsSchema
  >

  export const TeamsUpdateLegacyResponseSchema = TeamFullSchema
  export type TeamsUpdateLegacyResponse = z.infer<
    typeof TeamsUpdateLegacyResponseSchema
  >

  export const TeamsListDiscussionsLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListDiscussionsLegacyParams = z.infer<
    typeof TeamsListDiscussionsLegacyParamsSchema
  >

  export const TeamsListDiscussionsLegacyResponseSchema =
    z.array(TeamDiscussionSchema)
  export type TeamsListDiscussionsLegacyResponse = z.infer<
    typeof TeamsListDiscussionsLegacyResponseSchema
  >

  export const TeamsCreateDiscussionLegacyParamsSchema = z.object({
    title: z.string().describe("The discussion post's title."),
    body: z.string().describe("The discussion post's body text."),
    private: z
      .boolean()
      .describe(
        'Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.'
      )
      .default(false),
    team_id: z.number().int().describe('The unique identifier of the team.')
  })
  export type TeamsCreateDiscussionLegacyParams = z.infer<
    typeof TeamsCreateDiscussionLegacyParamsSchema
  >

  export type TeamsCreateDiscussionLegacyResponse = undefined

  export const TeamsGetDiscussionLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsGetDiscussionLegacyParams = z.infer<
    typeof TeamsGetDiscussionLegacyParamsSchema
  >

  export const TeamsGetDiscussionLegacyResponseSchema = TeamDiscussionSchema
  export type TeamsGetDiscussionLegacyResponse = z.infer<
    typeof TeamsGetDiscussionLegacyResponseSchema
  >

  export const TeamsDeleteDiscussionLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsDeleteDiscussionLegacyParams = z.infer<
    typeof TeamsDeleteDiscussionLegacyParamsSchema
  >

  export type TeamsDeleteDiscussionLegacyResponse = undefined

  export const TeamsUpdateDiscussionLegacyParamsSchema = z.object({
    title: z.string().describe("The discussion post's title.").optional(),
    body: z.string().describe("The discussion post's body text.").optional(),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsUpdateDiscussionLegacyParams = z.infer<
    typeof TeamsUpdateDiscussionLegacyParamsSchema
  >

  export const TeamsUpdateDiscussionLegacyResponseSchema = TeamDiscussionSchema
  export type TeamsUpdateDiscussionLegacyResponse = z.infer<
    typeof TeamsUpdateDiscussionLegacyResponseSchema
  >

  export const TeamsListDiscussionCommentsLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListDiscussionCommentsLegacyParams = z.infer<
    typeof TeamsListDiscussionCommentsLegacyParamsSchema
  >

  export const TeamsListDiscussionCommentsLegacyResponseSchema = z.array(
    TeamDiscussionCommentSchema
  )
  export type TeamsListDiscussionCommentsLegacyResponse = z.infer<
    typeof TeamsListDiscussionCommentsLegacyResponseSchema
  >

  export const TeamsCreateDiscussionCommentLegacyParamsSchema = z.object({
    body: z.string().describe("The discussion comment's body text."),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type TeamsCreateDiscussionCommentLegacyParams = z.infer<
    typeof TeamsCreateDiscussionCommentLegacyParamsSchema
  >

  export type TeamsCreateDiscussionCommentLegacyResponse = undefined

  export const TeamsGetDiscussionCommentLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsGetDiscussionCommentLegacyParams = z.infer<
    typeof TeamsGetDiscussionCommentLegacyParamsSchema
  >

  export const TeamsGetDiscussionCommentLegacyResponseSchema =
    TeamDiscussionCommentSchema
  export type TeamsGetDiscussionCommentLegacyResponse = z.infer<
    typeof TeamsGetDiscussionCommentLegacyResponseSchema
  >

  export const TeamsDeleteDiscussionCommentLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsDeleteDiscussionCommentLegacyParams = z.infer<
    typeof TeamsDeleteDiscussionCommentLegacyParamsSchema
  >

  export type TeamsDeleteDiscussionCommentLegacyResponse = undefined

  export const TeamsUpdateDiscussionCommentLegacyParamsSchema = z.object({
    body: z.string().describe("The discussion comment's body text."),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    comment_number: z
      .number()
      .int()
      .describe('The number that identifies the comment.')
  })
  export type TeamsUpdateDiscussionCommentLegacyParams = z.infer<
    typeof TeamsUpdateDiscussionCommentLegacyParamsSchema
  >

  export const TeamsUpdateDiscussionCommentLegacyResponseSchema =
    TeamDiscussionCommentSchema
  export type TeamsUpdateDiscussionCommentLegacyResponse = z.infer<
    typeof TeamsUpdateDiscussionCommentLegacyResponseSchema
  >

  export const ReactionsListForTeamDiscussionCommentLegacyParamsSchema =
    z.object({
      team_id: z.number().int().describe('The unique identifier of the team.'),
      discussion_number: z
        .number()
        .int()
        .describe('The number that identifies the discussion.'),
      comment_number: z
        .number()
        .int()
        .describe('The number that identifies the comment.'),
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe(
          'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.'
        )
        .optional(),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ReactionsListForTeamDiscussionCommentLegacyParams = z.infer<
    typeof ReactionsListForTeamDiscussionCommentLegacyParamsSchema
  >

  export const ReactionsListForTeamDiscussionCommentLegacyResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForTeamDiscussionCommentLegacyResponse = z.infer<
    typeof ReactionsListForTeamDiscussionCommentLegacyResponseSchema
  >

  export const ReactionsCreateForTeamDiscussionCommentLegacyParamsSchema =
    z.object({
      content: z
        .enum([
          '+1',
          '-1',
          'laugh',
          'confused',
          'heart',
          'hooray',
          'rocket',
          'eyes'
        ])
        .describe(
          'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.'
        ),
      team_id: z.number().int().describe('The unique identifier of the team.'),
      discussion_number: z
        .number()
        .int()
        .describe('The number that identifies the discussion.'),
      comment_number: z
        .number()
        .int()
        .describe('The number that identifies the comment.')
    })
  export type ReactionsCreateForTeamDiscussionCommentLegacyParams = z.infer<
    typeof ReactionsCreateForTeamDiscussionCommentLegacyParamsSchema
  >

  export type ReactionsCreateForTeamDiscussionCommentLegacyResponse = undefined

  export const ReactionsListForTeamDiscussionLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.'),
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReactionsListForTeamDiscussionLegacyParams = z.infer<
    typeof ReactionsListForTeamDiscussionLegacyParamsSchema
  >

  export const ReactionsListForTeamDiscussionLegacyResponseSchema =
    z.array(ReactionSchema)
  export type ReactionsListForTeamDiscussionLegacyResponse = z.infer<
    typeof ReactionsListForTeamDiscussionLegacyResponseSchema
  >

  export const ReactionsCreateForTeamDiscussionLegacyParamsSchema = z.object({
    content: z
      .enum([
        '+1',
        '-1',
        'laugh',
        'confused',
        'heart',
        'hooray',
        'rocket',
        'eyes'
      ])
      .describe(
        'The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.'
      ),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    discussion_number: z
      .number()
      .int()
      .describe('The number that identifies the discussion.')
  })
  export type ReactionsCreateForTeamDiscussionLegacyParams = z.infer<
    typeof ReactionsCreateForTeamDiscussionLegacyParamsSchema
  >

  export type ReactionsCreateForTeamDiscussionLegacyResponse = undefined

  export const TeamsListPendingInvitationsLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListPendingInvitationsLegacyParams = z.infer<
    typeof TeamsListPendingInvitationsLegacyParamsSchema
  >

  export const TeamsListPendingInvitationsLegacyResponseSchema = z.array(
    OrganizationInvitationSchema
  )
  export type TeamsListPendingInvitationsLegacyResponse = z.infer<
    typeof TeamsListPendingInvitationsLegacyResponseSchema
  >

  export const TeamsListMembersLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    role: z
      .enum(['member', 'maintainer', 'all'])
      .describe('Filters members returned by their role in the team.')
      .default('all'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListMembersLegacyParams = z.infer<
    typeof TeamsListMembersLegacyParamsSchema
  >

  export const TeamsListMembersLegacyResponseSchema = z.array(SimpleUserSchema)
  export type TeamsListMembersLegacyResponse = z.infer<
    typeof TeamsListMembersLegacyResponseSchema
  >

  export const TeamsGetMemberLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsGetMemberLegacyParams = z.infer<
    typeof TeamsGetMemberLegacyParamsSchema
  >

  export type TeamsGetMemberLegacyResponse = undefined

  export const TeamsAddMemberLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsAddMemberLegacyParams = z.infer<
    typeof TeamsAddMemberLegacyParamsSchema
  >

  export type TeamsAddMemberLegacyResponse = undefined

  export const TeamsRemoveMemberLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsRemoveMemberLegacyParams = z.infer<
    typeof TeamsRemoveMemberLegacyParamsSchema
  >

  export type TeamsRemoveMemberLegacyResponse = undefined

  export const TeamsGetMembershipForUserLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsGetMembershipForUserLegacyParams = z.infer<
    typeof TeamsGetMembershipForUserLegacyParamsSchema
  >

  export const TeamsGetMembershipForUserLegacyResponseSchema =
    TeamMembershipSchema
  export type TeamsGetMembershipForUserLegacyResponse = z.infer<
    typeof TeamsGetMembershipForUserLegacyResponseSchema
  >

  export const TeamsAddOrUpdateMembershipForUserLegacyParamsSchema = z.object({
    role: z
      .enum(['member', 'maintainer'])
      .describe('The role that this user should have in the team.')
      .default('member'),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsAddOrUpdateMembershipForUserLegacyParams = z.infer<
    typeof TeamsAddOrUpdateMembershipForUserLegacyParamsSchema
  >

  export const TeamsAddOrUpdateMembershipForUserLegacyResponseSchema =
    TeamMembershipSchema
  export type TeamsAddOrUpdateMembershipForUserLegacyResponse = z.infer<
    typeof TeamsAddOrUpdateMembershipForUserLegacyResponseSchema
  >

  export const TeamsRemoveMembershipForUserLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type TeamsRemoveMembershipForUserLegacyParams = z.infer<
    typeof TeamsRemoveMembershipForUserLegacyParamsSchema
  >

  export type TeamsRemoveMembershipForUserLegacyResponse = undefined

  export const TeamsListProjectsLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListProjectsLegacyParams = z.infer<
    typeof TeamsListProjectsLegacyParamsSchema
  >

  export const TeamsListProjectsLegacyResponseSchema =
    z.array(TeamProjectSchema)
  export type TeamsListProjectsLegacyResponse = z.infer<
    typeof TeamsListProjectsLegacyResponseSchema
  >

  export const TeamsCheckPermissionsForProjectLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsCheckPermissionsForProjectLegacyParams = z.infer<
    typeof TeamsCheckPermissionsForProjectLegacyParamsSchema
  >

  export const TeamsCheckPermissionsForProjectLegacyResponseSchema =
    TeamProjectSchema
  export type TeamsCheckPermissionsForProjectLegacyResponse = z.infer<
    typeof TeamsCheckPermissionsForProjectLegacyResponseSchema
  >

  export const TeamsAddOrUpdateProjectPermissionsLegacyParamsSchema = z.object({
    permission: z
      .enum(['read', 'write', 'admin'])
      .describe(
        'The permission to grant to the team for this project. Default: the team\'s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you\'ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."'
      )
      .optional(),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsAddOrUpdateProjectPermissionsLegacyParams = z.infer<
    typeof TeamsAddOrUpdateProjectPermissionsLegacyParamsSchema
  >

  export type TeamsAddOrUpdateProjectPermissionsLegacyResponse = undefined

  export const TeamsRemoveProjectLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    project_id: z
      .number()
      .int()
      .describe('The unique identifier of the project.')
  })
  export type TeamsRemoveProjectLegacyParams = z.infer<
    typeof TeamsRemoveProjectLegacyParamsSchema
  >

  export type TeamsRemoveProjectLegacyResponse = undefined

  export const TeamsListReposLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListReposLegacyParams = z.infer<
    typeof TeamsListReposLegacyParamsSchema
  >

  export const TeamsListReposLegacyResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type TeamsListReposLegacyResponse = z.infer<
    typeof TeamsListReposLegacyResponseSchema
  >

  export const TeamsCheckPermissionsForRepoLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsCheckPermissionsForRepoLegacyParams = z.infer<
    typeof TeamsCheckPermissionsForRepoLegacyParamsSchema
  >

  export const TeamsCheckPermissionsForRepoLegacyResponseSchema =
    TeamRepositorySchema
  export type TeamsCheckPermissionsForRepoLegacyResponse = z.infer<
    typeof TeamsCheckPermissionsForRepoLegacyResponseSchema
  >

  export const TeamsAddOrUpdateRepoPermissionsLegacyParamsSchema = z.object({
    permission: z
      .enum(['pull', 'push', 'admin'])
      .describe(
        "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository."
      )
      .optional(),
    team_id: z.number().int().describe('The unique identifier of the team.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsAddOrUpdateRepoPermissionsLegacyParams = z.infer<
    typeof TeamsAddOrUpdateRepoPermissionsLegacyParamsSchema
  >

  export type TeamsAddOrUpdateRepoPermissionsLegacyResponse = undefined

  export const TeamsRemoveRepoLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type TeamsRemoveRepoLegacyParams = z.infer<
    typeof TeamsRemoveRepoLegacyParamsSchema
  >

  export type TeamsRemoveRepoLegacyResponse = undefined

  export const TeamsListChildLegacyParamsSchema = z.object({
    team_id: z.number().int().describe('The unique identifier of the team.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListChildLegacyParams = z.infer<
    typeof TeamsListChildLegacyParamsSchema
  >

  export const TeamsListChildLegacyResponseSchema = z.array(TeamSchema)
  export type TeamsListChildLegacyResponse = z.infer<
    typeof TeamsListChildLegacyResponseSchema
  >

  export const UsersGetAuthenticatedParamsSchema = z.object({})
  export type UsersGetAuthenticatedParams = z.infer<
    typeof UsersGetAuthenticatedParamsSchema
  >

  export const UsersGetAuthenticatedResponseSchema = z.union([
    PrivateUserSchema,
    PublicUserSchema
  ])
  export type UsersGetAuthenticatedResponse = z.infer<
    typeof UsersGetAuthenticatedResponseSchema
  >

  export const UsersUpdateAuthenticatedParamsSchema = z.object({
    name: z.string().describe('The new name of the user.').optional(),
    email: z
      .string()
      .describe('The publicly visible email address of the user.')
      .optional(),
    blog: z.string().describe('The new blog URL of the user.').optional(),
    twitter_username: z
      .string()
      .describe('The new Twitter username of the user.')
      .optional(),
    company: z.string().describe('The new company of the user.').optional(),
    location: z.string().describe('The new location of the user.').optional(),
    hireable: z
      .boolean()
      .describe('The new hiring availability of the user.')
      .optional(),
    bio: z.string().describe('The new short biography of the user.').optional()
  })
  export type UsersUpdateAuthenticatedParams = z.infer<
    typeof UsersUpdateAuthenticatedParamsSchema
  >

  export const UsersUpdateAuthenticatedResponseSchema = PrivateUserSchema
  export type UsersUpdateAuthenticatedResponse = z.infer<
    typeof UsersUpdateAuthenticatedResponseSchema
  >

  export const UsersListBlockedByAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListBlockedByAuthenticatedUserParams = z.infer<
    typeof UsersListBlockedByAuthenticatedUserParamsSchema
  >

  export const UsersListBlockedByAuthenticatedUserResponseSchema =
    z.array(SimpleUserSchema)
  export type UsersListBlockedByAuthenticatedUserResponse = z.infer<
    typeof UsersListBlockedByAuthenticatedUserResponseSchema
  >

  export const UsersCheckBlockedParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersCheckBlockedParams = z.infer<
    typeof UsersCheckBlockedParamsSchema
  >

  export type UsersCheckBlockedResponse = undefined

  export const UsersBlockParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersBlockParams = z.infer<typeof UsersBlockParamsSchema>

  export type UsersBlockResponse = undefined

  export const UsersUnblockParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersUnblockParams = z.infer<typeof UsersUnblockParamsSchema>

  export type UsersUnblockResponse = undefined

  export const CodespacesListForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    repository_id: z
      .number()
      .int()
      .describe('ID of the Repository to filter on')
      .optional()
  })
  export type CodespacesListForAuthenticatedUserParams = z.infer<
    typeof CodespacesListForAuthenticatedUserParamsSchema
  >

  export const CodespacesListForAuthenticatedUserResponseSchema = z.object({
    total_count: z.number().int(),
    codespaces: z.array(CodespaceSchema)
  })
  export type CodespacesListForAuthenticatedUserResponse = z.infer<
    typeof CodespacesListForAuthenticatedUserResponseSchema
  >

  export const CodespacesCreateForAuthenticatedUserParamsSchema = z
    .object({})
    .and(
      z.union([
        z.object({
          repository_id: z
            .number()
            .int()
            .describe('Repository id for this codespace'),
          ref: z
            .string()
            .describe('Git ref (typically a branch name) for this codespace')
            .optional(),
          location: z
            .string()
            .describe(
              'The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.'
            )
            .optional(),
          geo: z
            .enum(['EuropeWest', 'SoutheastAsia', 'UsEast', 'UsWest'])
            .describe(
              'The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.'
            )
            .optional(),
          client_ip: z
            .string()
            .describe('IP for location auto-detection when proxying a request')
            .optional(),
          machine: z
            .string()
            .describe('Machine type to use for this codespace')
            .optional(),
          devcontainer_path: z
            .string()
            .describe(
              'Path to devcontainer.json config to use for this codespace'
            )
            .optional(),
          multi_repo_permissions_opt_out: z
            .boolean()
            .describe(
              'Whether to authorize requested permissions from devcontainer.json'
            )
            .optional(),
          working_directory: z
            .string()
            .describe('Working directory for this codespace')
            .optional(),
          idle_timeout_minutes: z
            .number()
            .int()
            .describe('Time in minutes before codespace stops from inactivity')
            .optional(),
          display_name: z
            .string()
            .describe('Display name for this codespace')
            .optional(),
          retention_period_minutes: z
            .number()
            .int()
            .describe(
              'Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).'
            )
            .optional()
        }),
        z.object({
          pull_request: z
            .object({
              pull_request_number: z
                .number()
                .int()
                .describe('Pull request number'),
              repository_id: z
                .number()
                .int()
                .describe('Repository id for this codespace')
            })
            .describe('Pull request number for this codespace'),
          location: z
            .string()
            .describe(
              'The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.'
            )
            .optional(),
          geo: z
            .enum(['EuropeWest', 'SoutheastAsia', 'UsEast', 'UsWest'])
            .describe(
              'The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.'
            )
            .optional(),
          machine: z
            .string()
            .describe('Machine type to use for this codespace')
            .optional(),
          devcontainer_path: z
            .string()
            .describe(
              'Path to devcontainer.json config to use for this codespace'
            )
            .optional(),
          working_directory: z
            .string()
            .describe('Working directory for this codespace')
            .optional(),
          idle_timeout_minutes: z
            .number()
            .int()
            .describe('Time in minutes before codespace stops from inactivity')
            .optional()
        })
      ])
    )
  export type CodespacesCreateForAuthenticatedUserParams = z.infer<
    typeof CodespacesCreateForAuthenticatedUserParamsSchema
  >

  export type CodespacesCreateForAuthenticatedUserResponse = undefined

  export const CodespacesListSecretsForAuthenticatedUserParamsSchema = z.object(
    {
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type CodespacesListSecretsForAuthenticatedUserParams = z.infer<
    typeof CodespacesListSecretsForAuthenticatedUserParamsSchema
  >

  export const CodespacesListSecretsForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      secrets: z.array(CodespacesSecretSchema)
    })
  export type CodespacesListSecretsForAuthenticatedUserResponse = z.infer<
    typeof CodespacesListSecretsForAuthenticatedUserResponseSchema
  >

  export const CodespacesGetPublicKeyForAuthenticatedUserParamsSchema =
    z.object({})
  export type CodespacesGetPublicKeyForAuthenticatedUserParams = z.infer<
    typeof CodespacesGetPublicKeyForAuthenticatedUserParamsSchema
  >

  export const CodespacesGetPublicKeyForAuthenticatedUserResponseSchema =
    CodespacesUserPublicKeySchema
  export type CodespacesGetPublicKeyForAuthenticatedUserResponse = z.infer<
    typeof CodespacesGetPublicKeyForAuthenticatedUserResponseSchema
  >

  export const CodespacesGetSecretForAuthenticatedUserParamsSchema = z.object({
    secret_name: z.string().describe('The name of the secret.')
  })
  export type CodespacesGetSecretForAuthenticatedUserParams = z.infer<
    typeof CodespacesGetSecretForAuthenticatedUserParamsSchema
  >

  export const CodespacesGetSecretForAuthenticatedUserResponseSchema =
    CodespacesSecretSchema
  export type CodespacesGetSecretForAuthenticatedUserResponse = z.infer<
    typeof CodespacesGetSecretForAuthenticatedUserResponseSchema
  >

  export const CodespacesCreateOrUpdateSecretForAuthenticatedUserParamsSchema =
    z.object({
      encrypted_value: z
        .string()
        .regex(
          new RegExp(
            '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$'
          )
        )
        .describe(
          'Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.'
        )
        .optional(),
      key_id: z
        .string()
        .describe('ID of the key you used to encrypt the secret.'),
      selected_repository_ids: z
        .array(z.union([z.number().int(), z.string()]))
        .describe(
          'An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.'
        )
        .optional(),
      secret_name: z.string().describe('The name of the secret.')
    })
  export type CodespacesCreateOrUpdateSecretForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesCreateOrUpdateSecretForAuthenticatedUserParamsSchema
    >

  export type CodespacesCreateOrUpdateSecretForAuthenticatedUserResponse =
    undefined

  export const CodespacesDeleteSecretForAuthenticatedUserParamsSchema =
    z.object({ secret_name: z.string().describe('The name of the secret.') })
  export type CodespacesDeleteSecretForAuthenticatedUserParams = z.infer<
    typeof CodespacesDeleteSecretForAuthenticatedUserParamsSchema
  >

  export type CodespacesDeleteSecretForAuthenticatedUserResponse = undefined

  export const CodespacesListRepositoriesForSecretForAuthenticatedUserParamsSchema =
    z.object({ secret_name: z.string().describe('The name of the secret.') })
  export type CodespacesListRepositoriesForSecretForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesListRepositoriesForSecretForAuthenticatedUserParamsSchema
    >

  export const CodespacesListRepositoriesForSecretForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      repositories: z.array(MinimalRepositorySchema)
    })
  export type CodespacesListRepositoriesForSecretForAuthenticatedUserResponse =
    z.infer<
      typeof CodespacesListRepositoriesForSecretForAuthenticatedUserResponseSchema
    >

  export const CodespacesSetRepositoriesForSecretForAuthenticatedUserParamsSchema =
    z.object({
      selected_repository_ids: z
        .array(z.number().int())
        .describe(
          'An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.'
        ),
      secret_name: z.string().describe('The name of the secret.')
    })
  export type CodespacesSetRepositoriesForSecretForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesSetRepositoriesForSecretForAuthenticatedUserParamsSchema
    >

  export type CodespacesSetRepositoriesForSecretForAuthenticatedUserResponse =
    undefined

  export const CodespacesAddRepositoryForSecretForAuthenticatedUserParamsSchema =
    z.object({
      secret_name: z.string().describe('The name of the secret.'),
      repository_id: z.number().int()
    })
  export type CodespacesAddRepositoryForSecretForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesAddRepositoryForSecretForAuthenticatedUserParamsSchema
    >

  export type CodespacesAddRepositoryForSecretForAuthenticatedUserResponse =
    undefined

  export const CodespacesRemoveRepositoryForSecretForAuthenticatedUserParamsSchema =
    z.object({
      secret_name: z.string().describe('The name of the secret.'),
      repository_id: z.number().int()
    })
  export type CodespacesRemoveRepositoryForSecretForAuthenticatedUserParams =
    z.infer<
      typeof CodespacesRemoveRepositoryForSecretForAuthenticatedUserParamsSchema
    >

  export type CodespacesRemoveRepositoryForSecretForAuthenticatedUserResponse =
    undefined

  export const CodespacesGetForAuthenticatedUserParamsSchema = z.object({
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesGetForAuthenticatedUserParams = z.infer<
    typeof CodespacesGetForAuthenticatedUserParamsSchema
  >

  export const CodespacesGetForAuthenticatedUserResponseSchema = CodespaceSchema
  export type CodespacesGetForAuthenticatedUserResponse = z.infer<
    typeof CodespacesGetForAuthenticatedUserResponseSchema
  >

  export const CodespacesDeleteForAuthenticatedUserParamsSchema = z.object({
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesDeleteForAuthenticatedUserParams = z.infer<
    typeof CodespacesDeleteForAuthenticatedUserParamsSchema
  >

  export type CodespacesDeleteForAuthenticatedUserResponse = undefined

  export const CodespacesUpdateForAuthenticatedUserParamsSchema = z.object({
    machine: z
      .string()
      .describe('A valid machine to transition this codespace to.')
      .optional(),
    display_name: z
      .string()
      .describe('Display name for this codespace')
      .optional(),
    recent_folders: z
      .array(z.string())
      .describe(
        'Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.'
      )
      .optional(),
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesUpdateForAuthenticatedUserParams = z.infer<
    typeof CodespacesUpdateForAuthenticatedUserParamsSchema
  >

  export const CodespacesUpdateForAuthenticatedUserResponseSchema =
    CodespaceSchema
  export type CodespacesUpdateForAuthenticatedUserResponse = z.infer<
    typeof CodespacesUpdateForAuthenticatedUserResponseSchema
  >

  export const CodespacesExportForAuthenticatedUserParamsSchema = z.object({
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesExportForAuthenticatedUserParams = z.infer<
    typeof CodespacesExportForAuthenticatedUserParamsSchema
  >

  export type CodespacesExportForAuthenticatedUserResponse = undefined

  export const CodespacesGetExportDetailsForAuthenticatedUserParamsSchema =
    z.object({
      codespace_name: z.string().describe('The name of the codespace.'),
      export_id: z
        .string()
        .describe(
          'The ID of the export operation, or `latest`. Currently only `latest` is currently supported.'
        )
    })
  export type CodespacesGetExportDetailsForAuthenticatedUserParams = z.infer<
    typeof CodespacesGetExportDetailsForAuthenticatedUserParamsSchema
  >

  export const CodespacesGetExportDetailsForAuthenticatedUserResponseSchema =
    CodespaceExportDetailsSchema
  export type CodespacesGetExportDetailsForAuthenticatedUserResponse = z.infer<
    typeof CodespacesGetExportDetailsForAuthenticatedUserResponseSchema
  >

  export const CodespacesCodespaceMachinesForAuthenticatedUserParamsSchema =
    z.object({
      codespace_name: z.string().describe('The name of the codespace.')
    })
  export type CodespacesCodespaceMachinesForAuthenticatedUserParams = z.infer<
    typeof CodespacesCodespaceMachinesForAuthenticatedUserParamsSchema
  >

  export const CodespacesCodespaceMachinesForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      machines: z.array(CodespaceMachineSchema)
    })
  export type CodespacesCodespaceMachinesForAuthenticatedUserResponse = z.infer<
    typeof CodespacesCodespaceMachinesForAuthenticatedUserResponseSchema
  >

  export const CodespacesPublishForAuthenticatedUserParamsSchema = z.object({
    name: z.string().describe('A name for the new repository.').optional(),
    private: z
      .boolean()
      .describe('Whether the new repository should be private.')
      .default(false),
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesPublishForAuthenticatedUserParams = z.infer<
    typeof CodespacesPublishForAuthenticatedUserParamsSchema
  >

  export type CodespacesPublishForAuthenticatedUserResponse = undefined

  export const CodespacesStartForAuthenticatedUserParamsSchema = z.object({
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesStartForAuthenticatedUserParams = z.infer<
    typeof CodespacesStartForAuthenticatedUserParamsSchema
  >

  export const CodespacesStartForAuthenticatedUserResponseSchema =
    CodespaceSchema
  export type CodespacesStartForAuthenticatedUserResponse = z.infer<
    typeof CodespacesStartForAuthenticatedUserResponseSchema
  >

  export const CodespacesStopForAuthenticatedUserParamsSchema = z.object({
    codespace_name: z.string().describe('The name of the codespace.')
  })
  export type CodespacesStopForAuthenticatedUserParams = z.infer<
    typeof CodespacesStopForAuthenticatedUserParamsSchema
  >

  export const CodespacesStopForAuthenticatedUserResponseSchema =
    CodespaceSchema
  export type CodespacesStopForAuthenticatedUserResponse = z.infer<
    typeof CodespacesStopForAuthenticatedUserResponseSchema
  >

  export const PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserParamsSchema =
    z.object({})
  export type PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserParams =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserParamsSchema
    >

  export const PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserResponseSchema =
    z.array(PackageSchema)
  export type PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserResponse =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForAuthenticatedUserResponseSchema
    >

  export const UsersSetPrimaryEmailVisibilityForAuthenticatedUserParamsSchema =
    z.object({
      visibility: z
        .enum(['public', 'private'])
        .describe('Denotes whether an email is publicly visible.')
    })
  export type UsersSetPrimaryEmailVisibilityForAuthenticatedUserParams =
    z.infer<
      typeof UsersSetPrimaryEmailVisibilityForAuthenticatedUserParamsSchema
    >

  export const UsersSetPrimaryEmailVisibilityForAuthenticatedUserResponseSchema =
    z.array(EmailSchema)
  export type UsersSetPrimaryEmailVisibilityForAuthenticatedUserResponse =
    z.infer<
      typeof UsersSetPrimaryEmailVisibilityForAuthenticatedUserResponseSchema
    >

  export const UsersListEmailsForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListEmailsForAuthenticatedUserParams = z.infer<
    typeof UsersListEmailsForAuthenticatedUserParamsSchema
  >

  export const UsersListEmailsForAuthenticatedUserResponseSchema =
    z.array(EmailSchema)
  export type UsersListEmailsForAuthenticatedUserResponse = z.infer<
    typeof UsersListEmailsForAuthenticatedUserResponseSchema
  >

  export const UsersAddEmailForAuthenticatedUserParamsSchema = z
    .object({})
    .and(
      z.union([
        z.object({
          emails: z
            .array(z.string())
            .min(1)
            .describe(
              'Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.'
            )
        }),
        z.array(z.string()).min(1),
        z.string()
      ])
    )
  export type UsersAddEmailForAuthenticatedUserParams = z.infer<
    typeof UsersAddEmailForAuthenticatedUserParamsSchema
  >

  export type UsersAddEmailForAuthenticatedUserResponse = undefined

  export const UsersDeleteEmailForAuthenticatedUserParamsSchema = z
    .object({})
    .and(
      z.union([
        z
          .object({
            emails: z
              .array(z.string())
              .min(1)
              .describe(
                'Email addresses associated with the GitHub user account.'
              )
          })
          .describe(
            'Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.'
          ),
        z.array(z.string()).min(1),
        z.string()
      ])
    )
  export type UsersDeleteEmailForAuthenticatedUserParams = z.infer<
    typeof UsersDeleteEmailForAuthenticatedUserParamsSchema
  >

  export type UsersDeleteEmailForAuthenticatedUserResponse = undefined

  export const UsersListFollowersForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListFollowersForAuthenticatedUserParams = z.infer<
    typeof UsersListFollowersForAuthenticatedUserParamsSchema
  >

  export const UsersListFollowersForAuthenticatedUserResponseSchema =
    z.array(SimpleUserSchema)
  export type UsersListFollowersForAuthenticatedUserResponse = z.infer<
    typeof UsersListFollowersForAuthenticatedUserResponseSchema
  >

  export const UsersListFollowedByAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListFollowedByAuthenticatedUserParams = z.infer<
    typeof UsersListFollowedByAuthenticatedUserParamsSchema
  >

  export const UsersListFollowedByAuthenticatedUserResponseSchema =
    z.array(SimpleUserSchema)
  export type UsersListFollowedByAuthenticatedUserResponse = z.infer<
    typeof UsersListFollowedByAuthenticatedUserResponseSchema
  >

  export const UsersCheckPersonIsFollowedByAuthenticatedParamsSchema = z.object(
    { username: z.string().describe('The handle for the GitHub user account.') }
  )
  export type UsersCheckPersonIsFollowedByAuthenticatedParams = z.infer<
    typeof UsersCheckPersonIsFollowedByAuthenticatedParamsSchema
  >

  export type UsersCheckPersonIsFollowedByAuthenticatedResponse = undefined

  export const UsersFollowParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersFollowParams = z.infer<typeof UsersFollowParamsSchema>

  export type UsersFollowResponse = undefined

  export const UsersUnfollowParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersUnfollowParams = z.infer<typeof UsersUnfollowParamsSchema>

  export type UsersUnfollowResponse = undefined

  export const UsersListGpgKeysForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListGpgKeysForAuthenticatedUserParams = z.infer<
    typeof UsersListGpgKeysForAuthenticatedUserParamsSchema
  >

  export const UsersListGpgKeysForAuthenticatedUserResponseSchema =
    z.array(GpgKeySchema)
  export type UsersListGpgKeysForAuthenticatedUserResponse = z.infer<
    typeof UsersListGpgKeysForAuthenticatedUserResponseSchema
  >

  export const UsersCreateGpgKeyForAuthenticatedUserParamsSchema = z.object({
    name: z.string().describe('A descriptive name for the new key.').optional(),
    armored_public_key: z
      .string()
      .describe('A GPG key in ASCII-armored format.')
  })
  export type UsersCreateGpgKeyForAuthenticatedUserParams = z.infer<
    typeof UsersCreateGpgKeyForAuthenticatedUserParamsSchema
  >

  export type UsersCreateGpgKeyForAuthenticatedUserResponse = undefined

  export const UsersGetGpgKeyForAuthenticatedUserParamsSchema = z.object({
    gpg_key_id: z
      .number()
      .int()
      .describe('The unique identifier of the GPG key.')
  })
  export type UsersGetGpgKeyForAuthenticatedUserParams = z.infer<
    typeof UsersGetGpgKeyForAuthenticatedUserParamsSchema
  >

  export const UsersGetGpgKeyForAuthenticatedUserResponseSchema = GpgKeySchema
  export type UsersGetGpgKeyForAuthenticatedUserResponse = z.infer<
    typeof UsersGetGpgKeyForAuthenticatedUserResponseSchema
  >

  export const UsersDeleteGpgKeyForAuthenticatedUserParamsSchema = z.object({
    gpg_key_id: z
      .number()
      .int()
      .describe('The unique identifier of the GPG key.')
  })
  export type UsersDeleteGpgKeyForAuthenticatedUserParams = z.infer<
    typeof UsersDeleteGpgKeyForAuthenticatedUserParamsSchema
  >

  export type UsersDeleteGpgKeyForAuthenticatedUserResponse = undefined

  export const AppsListInstallationsForAuthenticatedUserParamsSchema = z.object(
    {
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type AppsListInstallationsForAuthenticatedUserParams = z.infer<
    typeof AppsListInstallationsForAuthenticatedUserParamsSchema
  >

  export const AppsListInstallationsForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      installations: z.array(InstallationSchema)
    })
  export type AppsListInstallationsForAuthenticatedUserResponse = z.infer<
    typeof AppsListInstallationsForAuthenticatedUserResponseSchema
  >

  export const AppsListInstallationReposForAuthenticatedUserParamsSchema =
    z.object({
      installation_id: z
        .number()
        .int()
        .describe('The unique identifier of the installation.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type AppsListInstallationReposForAuthenticatedUserParams = z.infer<
    typeof AppsListInstallationReposForAuthenticatedUserParamsSchema
  >

  export const AppsListInstallationReposForAuthenticatedUserResponseSchema =
    z.object({
      total_count: z.number().int(),
      repository_selection: z.string().optional(),
      repositories: z.array(RepositorySchema)
    })
  export type AppsListInstallationReposForAuthenticatedUserResponse = z.infer<
    typeof AppsListInstallationReposForAuthenticatedUserResponseSchema
  >

  export const AppsAddRepoToInstallationForAuthenticatedUserParamsSchema =
    z.object({
      installation_id: z
        .number()
        .int()
        .describe('The unique identifier of the installation.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type AppsAddRepoToInstallationForAuthenticatedUserParams = z.infer<
    typeof AppsAddRepoToInstallationForAuthenticatedUserParamsSchema
  >

  export type AppsAddRepoToInstallationForAuthenticatedUserResponse = undefined

  export const AppsRemoveRepoFromInstallationForAuthenticatedUserParamsSchema =
    z.object({
      installation_id: z
        .number()
        .int()
        .describe('The unique identifier of the installation.'),
      repository_id: z
        .number()
        .int()
        .describe('The unique identifier of the repository.')
    })
  export type AppsRemoveRepoFromInstallationForAuthenticatedUserParams =
    z.infer<
      typeof AppsRemoveRepoFromInstallationForAuthenticatedUserParamsSchema
    >

  export type AppsRemoveRepoFromInstallationForAuthenticatedUserResponse =
    undefined

  export const InteractionsGetRestrictionsForAuthenticatedUserParamsSchema =
    z.object({})
  export type InteractionsGetRestrictionsForAuthenticatedUserParams = z.infer<
    typeof InteractionsGetRestrictionsForAuthenticatedUserParamsSchema
  >

  export const InteractionsGetRestrictionsForAuthenticatedUserResponseSchema =
    z.union([InteractionLimitResponseSchema, z.object({}).strict()])
  export type InteractionsGetRestrictionsForAuthenticatedUserResponse = z.infer<
    typeof InteractionsGetRestrictionsForAuthenticatedUserResponseSchema
  >

  export const InteractionsSetRestrictionsForAuthenticatedUserParamsSchema = InteractionLimitSchema
  export type InteractionsSetRestrictionsForAuthenticatedUserParams = z.infer<
    typeof InteractionsSetRestrictionsForAuthenticatedUserParamsSchema
  >

  export const InteractionsSetRestrictionsForAuthenticatedUserResponseSchema =
    InteractionLimitResponseSchema
  export type InteractionsSetRestrictionsForAuthenticatedUserResponse = z.infer<
    typeof InteractionsSetRestrictionsForAuthenticatedUserResponseSchema
  >

  export const InteractionsRemoveRestrictionsForAuthenticatedUserParamsSchema =
    z.object({})
  export type InteractionsRemoveRestrictionsForAuthenticatedUserParams =
    z.infer<
      typeof InteractionsRemoveRestrictionsForAuthenticatedUserParamsSchema
    >

  export type InteractionsRemoveRestrictionsForAuthenticatedUserResponse =
    undefined

  export const IssuesListForAuthenticatedUserParamsSchema = z.object({
    filter: z
      .enum(['assigned', 'created', 'mentioned', 'subscribed', 'repos', 'all'])
      .describe(
        "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation."
      )
      .default('assigned'),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the issues to return.')
      .default('open'),
    labels: z
      .string()
      .describe(
        'A list of comma separated label names. Example: `bug,ui,@high`'
      )
      .optional(),
    sort: z
      .enum(['created', 'updated', 'comments'])
      .describe('What to sort results by.')
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type IssuesListForAuthenticatedUserParams = z.infer<
    typeof IssuesListForAuthenticatedUserParamsSchema
  >

  export const IssuesListForAuthenticatedUserResponseSchema =
    z.array(IssueSchema)
  export type IssuesListForAuthenticatedUserResponse = z.infer<
    typeof IssuesListForAuthenticatedUserResponseSchema
  >

  export const UsersListPublicSshKeysForAuthenticatedUserParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type UsersListPublicSshKeysForAuthenticatedUserParams = z.infer<
    typeof UsersListPublicSshKeysForAuthenticatedUserParamsSchema
  >

  export const UsersListPublicSshKeysForAuthenticatedUserResponseSchema =
    z.array(KeySchema)
  export type UsersListPublicSshKeysForAuthenticatedUserResponse = z.infer<
    typeof UsersListPublicSshKeysForAuthenticatedUserResponseSchema
  >

  export const UsersCreatePublicSshKeyForAuthenticatedUserParamsSchema =
    z.object({
      title: z
        .string()
        .describe('A descriptive name for the new key.')
        .optional(),
      key: z
        .string()
        .regex(
          new RegExp('^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ')
        )
        .describe('The public SSH key to add to your GitHub account.')
    })
  export type UsersCreatePublicSshKeyForAuthenticatedUserParams = z.infer<
    typeof UsersCreatePublicSshKeyForAuthenticatedUserParamsSchema
  >

  export type UsersCreatePublicSshKeyForAuthenticatedUserResponse = undefined

  export const UsersGetPublicSshKeyForAuthenticatedUserParamsSchema = z.object({
    key_id: z.number().int().describe('The unique identifier of the key.')
  })
  export type UsersGetPublicSshKeyForAuthenticatedUserParams = z.infer<
    typeof UsersGetPublicSshKeyForAuthenticatedUserParamsSchema
  >

  export const UsersGetPublicSshKeyForAuthenticatedUserResponseSchema =
    KeySchema
  export type UsersGetPublicSshKeyForAuthenticatedUserResponse = z.infer<
    typeof UsersGetPublicSshKeyForAuthenticatedUserResponseSchema
  >

  export const UsersDeletePublicSshKeyForAuthenticatedUserParamsSchema =
    z.object({
      key_id: z.number().int().describe('The unique identifier of the key.')
    })
  export type UsersDeletePublicSshKeyForAuthenticatedUserParams = z.infer<
    typeof UsersDeletePublicSshKeyForAuthenticatedUserParamsSchema
  >

  export type UsersDeletePublicSshKeyForAuthenticatedUserResponse = undefined

  export const AppsListSubscriptionsForAuthenticatedUserParamsSchema = z.object(
    {
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type AppsListSubscriptionsForAuthenticatedUserParams = z.infer<
    typeof AppsListSubscriptionsForAuthenticatedUserParamsSchema
  >

  export const AppsListSubscriptionsForAuthenticatedUserResponseSchema =
    z.array(UserMarketplacePurchaseSchema)
  export type AppsListSubscriptionsForAuthenticatedUserResponse = z.infer<
    typeof AppsListSubscriptionsForAuthenticatedUserResponseSchema
  >

  export const AppsListSubscriptionsForAuthenticatedUserStubbedParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type AppsListSubscriptionsForAuthenticatedUserStubbedParams = z.infer<
    typeof AppsListSubscriptionsForAuthenticatedUserStubbedParamsSchema
  >

  export const AppsListSubscriptionsForAuthenticatedUserStubbedResponseSchema =
    z.array(UserMarketplacePurchaseSchema)
  export type AppsListSubscriptionsForAuthenticatedUserStubbedResponse =
    z.infer<
      typeof AppsListSubscriptionsForAuthenticatedUserStubbedResponseSchema
    >

  export const OrgsListMembershipsForAuthenticatedUserParamsSchema = z.object({
    state: z
      .enum(['active', 'pending'])
      .describe(
        'Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListMembershipsForAuthenticatedUserParams = z.infer<
    typeof OrgsListMembershipsForAuthenticatedUserParamsSchema
  >

  export const OrgsListMembershipsForAuthenticatedUserResponseSchema =
    z.array(OrgMembershipSchema)
  export type OrgsListMembershipsForAuthenticatedUserResponse = z.infer<
    typeof OrgsListMembershipsForAuthenticatedUserResponseSchema
  >

  export const OrgsGetMembershipForAuthenticatedUserParamsSchema = z.object({
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsGetMembershipForAuthenticatedUserParams = z.infer<
    typeof OrgsGetMembershipForAuthenticatedUserParamsSchema
  >

  export const OrgsGetMembershipForAuthenticatedUserResponseSchema =
    OrgMembershipSchema
  export type OrgsGetMembershipForAuthenticatedUserResponse = z.infer<
    typeof OrgsGetMembershipForAuthenticatedUserResponseSchema
  >

  export const OrgsUpdateMembershipForAuthenticatedUserParamsSchema = z.object({
    state: z
      .literal('active')
      .describe(
        'The state that the membership should be in. Only `"active"` will be accepted.'
      ),
    org: z
      .string()
      .describe('The organization name. The name is not case sensitive.')
  })
  export type OrgsUpdateMembershipForAuthenticatedUserParams = z.infer<
    typeof OrgsUpdateMembershipForAuthenticatedUserParamsSchema
  >

  export const OrgsUpdateMembershipForAuthenticatedUserResponseSchema =
    OrgMembershipSchema
  export type OrgsUpdateMembershipForAuthenticatedUserResponse = z.infer<
    typeof OrgsUpdateMembershipForAuthenticatedUserResponseSchema
  >

  export const MigrationsListForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type MigrationsListForAuthenticatedUserParams = z.infer<
    typeof MigrationsListForAuthenticatedUserParamsSchema
  >

  export const MigrationsListForAuthenticatedUserResponseSchema =
    z.array(MigrationSchema)
  export type MigrationsListForAuthenticatedUserResponse = z.infer<
    typeof MigrationsListForAuthenticatedUserResponseSchema
  >

  export const MigrationsStartForAuthenticatedUserParamsSchema = z.object({
    lock_repositories: z
      .boolean()
      .describe(
        'Lock the repositories being migrated at the start of the migration'
      )
      .optional(),
    exclude_metadata: z
      .boolean()
      .describe(
        'Indicates whether metadata should be excluded and only git source should be included for the migration.'
      )
      .optional(),
    exclude_git_data: z
      .boolean()
      .describe(
        'Indicates whether the repository git data should be excluded from the migration.'
      )
      .optional(),
    exclude_attachments: z
      .boolean()
      .describe('Do not include attachments in the migration')
      .optional(),
    exclude_releases: z
      .boolean()
      .describe('Do not include releases in the migration')
      .optional(),
    exclude_owner_projects: z
      .boolean()
      .describe(
        'Indicates whether projects owned by the organization or users should be excluded.'
      )
      .optional(),
    org_metadata_only: z
      .boolean()
      .describe(
        'Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).'
      )
      .default(false),
    exclude: z
      .array(
        z
          .literal('repositories')
          .describe('Allowed values that can be passed to the exclude param.')
      )
      .describe(
        'Exclude attributes from the API response to improve performance'
      )
      .optional(),
    repositories: z.array(
      z.string().describe('Repository path, owner and name')
    )
  })
  export type MigrationsStartForAuthenticatedUserParams = z.infer<
    typeof MigrationsStartForAuthenticatedUserParamsSchema
  >

  export type MigrationsStartForAuthenticatedUserResponse = undefined

  export const MigrationsGetStatusForAuthenticatedUserParamsSchema = z.object({
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    exclude: z.array(z.string()).optional()
  })
  export type MigrationsGetStatusForAuthenticatedUserParams = z.infer<
    typeof MigrationsGetStatusForAuthenticatedUserParamsSchema
  >

  export const MigrationsGetStatusForAuthenticatedUserResponseSchema =
    MigrationSchema
  export type MigrationsGetStatusForAuthenticatedUserResponse = z.infer<
    typeof MigrationsGetStatusForAuthenticatedUserResponseSchema
  >

  export const MigrationsGetArchiveForAuthenticatedUserParamsSchema = z.object({
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.')
  })
  export type MigrationsGetArchiveForAuthenticatedUserParams = z.infer<
    typeof MigrationsGetArchiveForAuthenticatedUserParamsSchema
  >

  export type MigrationsGetArchiveForAuthenticatedUserResponse = undefined

  export const MigrationsDeleteArchiveForAuthenticatedUserParamsSchema =
    z.object({
      migration_id: z
        .number()
        .int()
        .describe('The unique identifier of the migration.')
    })
  export type MigrationsDeleteArchiveForAuthenticatedUserParams = z.infer<
    typeof MigrationsDeleteArchiveForAuthenticatedUserParamsSchema
  >

  export type MigrationsDeleteArchiveForAuthenticatedUserResponse = undefined

  export const MigrationsUnlockRepoForAuthenticatedUserParamsSchema = z.object({
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    repo_name: z.string().describe('repo_name parameter')
  })
  export type MigrationsUnlockRepoForAuthenticatedUserParams = z.infer<
    typeof MigrationsUnlockRepoForAuthenticatedUserParamsSchema
  >

  export type MigrationsUnlockRepoForAuthenticatedUserResponse = undefined

  export const MigrationsListReposForAuthenticatedUserParamsSchema = z.object({
    migration_id: z
      .number()
      .int()
      .describe('The unique identifier of the migration.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type MigrationsListReposForAuthenticatedUserParams = z.infer<
    typeof MigrationsListReposForAuthenticatedUserParamsSchema
  >

  export const MigrationsListReposForAuthenticatedUserResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type MigrationsListReposForAuthenticatedUserResponse = z.infer<
    typeof MigrationsListReposForAuthenticatedUserResponseSchema
  >

  export const OrgsListForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListForAuthenticatedUserParams = z.infer<
    typeof OrgsListForAuthenticatedUserParamsSchema
  >

  export const OrgsListForAuthenticatedUserResponseSchema = z.array(
    OrganizationSimpleSchema
  )
  export type OrgsListForAuthenticatedUserResponse = z.infer<
    typeof OrgsListForAuthenticatedUserResponseSchema
  >

  export const PackagesListPackagesForAuthenticatedUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    visibility: z
      .enum(['public', 'private', 'internal'])
      .describe(
        'The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type PackagesListPackagesForAuthenticatedUserParams = z.infer<
    typeof PackagesListPackagesForAuthenticatedUserParamsSchema
  >

  export const PackagesListPackagesForAuthenticatedUserResponseSchema =
    z.array(PackageSchema)
  export type PackagesListPackagesForAuthenticatedUserResponse = z.infer<
    typeof PackagesListPackagesForAuthenticatedUserResponseSchema
  >

  export const PackagesGetPackageForAuthenticatedUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.')
  })
  export type PackagesGetPackageForAuthenticatedUserParams = z.infer<
    typeof PackagesGetPackageForAuthenticatedUserParamsSchema
  >

  export const PackagesGetPackageForAuthenticatedUserResponseSchema =
    PackageSchema
  export type PackagesGetPackageForAuthenticatedUserResponse = z.infer<
    typeof PackagesGetPackageForAuthenticatedUserResponseSchema
  >

  export const PackagesDeletePackageForAuthenticatedUserParamsSchema = z.object(
    {
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.')
    }
  )
  export type PackagesDeletePackageForAuthenticatedUserParams = z.infer<
    typeof PackagesDeletePackageForAuthenticatedUserParamsSchema
  >

  export type PackagesDeletePackageForAuthenticatedUserResponse = undefined

  export const PackagesRestorePackageForAuthenticatedUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      token: z.string().describe('package token').optional()
    })
  export type PackagesRestorePackageForAuthenticatedUserParams = z.infer<
    typeof PackagesRestorePackageForAuthenticatedUserParamsSchema
  >

  export type PackagesRestorePackageForAuthenticatedUserResponse = undefined

  export const PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      state: z
        .enum(['active', 'deleted'])
        .describe('The state of the package, either active or deleted.')
        .default('active')
    })
  export type PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserParams =
    z.infer<
      typeof PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserParamsSchema
    >

  export const PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserResponseSchema =
    z.array(PackageVersionSchema)
  export type PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserResponse =
    z.infer<
      typeof PackagesGetAllPackageVersionsForPackageOwnedByAuthenticatedUserResponseSchema
    >

  export const PackagesGetPackageVersionForAuthenticatedUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      package_version_id: z
        .number()
        .int()
        .describe('Unique identifier of the package version.')
    })
  export type PackagesGetPackageVersionForAuthenticatedUserParams = z.infer<
    typeof PackagesGetPackageVersionForAuthenticatedUserParamsSchema
  >

  export const PackagesGetPackageVersionForAuthenticatedUserResponseSchema =
    PackageVersionSchema
  export type PackagesGetPackageVersionForAuthenticatedUserResponse = z.infer<
    typeof PackagesGetPackageVersionForAuthenticatedUserResponseSchema
  >

  export const PackagesDeletePackageVersionForAuthenticatedUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      package_version_id: z
        .number()
        .int()
        .describe('Unique identifier of the package version.')
    })
  export type PackagesDeletePackageVersionForAuthenticatedUserParams = z.infer<
    typeof PackagesDeletePackageVersionForAuthenticatedUserParamsSchema
  >

  export type PackagesDeletePackageVersionForAuthenticatedUserResponse =
    undefined

  export const PackagesRestorePackageVersionForAuthenticatedUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      package_version_id: z
        .number()
        .int()
        .describe('Unique identifier of the package version.')
    })
  export type PackagesRestorePackageVersionForAuthenticatedUserParams = z.infer<
    typeof PackagesRestorePackageVersionForAuthenticatedUserParamsSchema
  >

  export type PackagesRestorePackageVersionForAuthenticatedUserResponse =
    undefined

  export const ProjectsCreateForAuthenticatedUserParamsSchema = z.object({
    name: z.string().describe('Name of the project'),
    body: z.string().describe('Body of the project').optional()
  })
  export type ProjectsCreateForAuthenticatedUserParams = z.infer<
    typeof ProjectsCreateForAuthenticatedUserParamsSchema
  >

  export type ProjectsCreateForAuthenticatedUserResponse = undefined

  export const UsersListPublicEmailsForAuthenticatedUserParamsSchema = z.object(
    {
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type UsersListPublicEmailsForAuthenticatedUserParams = z.infer<
    typeof UsersListPublicEmailsForAuthenticatedUserParamsSchema
  >

  export const UsersListPublicEmailsForAuthenticatedUserResponseSchema =
    z.array(EmailSchema)
  export type UsersListPublicEmailsForAuthenticatedUserResponse = z.infer<
    typeof UsersListPublicEmailsForAuthenticatedUserResponseSchema
  >

  export const ReposListForAuthenticatedUserParamsSchema = z.object({
    visibility: z
      .enum(['all', 'public', 'private'])
      .describe('Limit results to repositories with the specified visibility.')
      .default('all'),
    affiliation: z
      .string()
      .describe(
        'Comma-separated list of values. Can include:  \n * `owner`: Repositories that are owned by the authenticated user.  \n * `collaborator`: Repositories that the user has been added to as a collaborator.  \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.'
      )
      .default('owner,collaborator,organization_member'),
    type: z
      .enum(['all', 'owner', 'public', 'private', 'member'])
      .describe(
        'Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.'
      )
      .default('all'),
    sort: z
      .enum(['created', 'updated', 'pushed', 'full_name'])
      .describe('The property to sort the results by.')
      .default('full_name'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    before: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional()
  })
  export type ReposListForAuthenticatedUserParams = z.infer<
    typeof ReposListForAuthenticatedUserParamsSchema
  >

  export const ReposListForAuthenticatedUserResponseSchema =
    z.array(RepositorySchema)
  export type ReposListForAuthenticatedUserResponse = z.infer<
    typeof ReposListForAuthenticatedUserResponseSchema
  >

  export const ReposCreateForAuthenticatedUserParamsSchema = z.object({
    name: z.string().describe('The name of the repository.'),
    description: z
      .string()
      .describe('A short description of the repository.')
      .optional(),
    homepage: z
      .string()
      .describe('A URL with more information about the repository.')
      .optional(),
    private: z
      .boolean()
      .describe('Whether the repository is private.')
      .default(false),
    has_issues: z
      .boolean()
      .describe('Whether issues are enabled.')
      .default(true),
    has_projects: z
      .boolean()
      .describe('Whether projects are enabled.')
      .default(true),
    has_wiki: z
      .boolean()
      .describe('Whether the wiki is enabled.')
      .default(true),
    has_discussions: z
      .boolean()
      .describe('Whether discussions are enabled.')
      .default(false),
    team_id: z
      .number()
      .int()
      .describe(
        'The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.'
      )
      .optional(),
    auto_init: z
      .boolean()
      .describe('Whether the repository is initialized with a minimal README.')
      .default(false),
    gitignore_template: z
      .string()
      .describe('The desired language or platform to apply to the .gitignore.')
      .optional(),
    license_template: z
      .string()
      .describe(
        'The license keyword of the open source license for this repository.'
      )
      .optional(),
    allow_squash_merge: z
      .boolean()
      .describe('Whether to allow squash merges for pull requests.')
      .default(true),
    allow_merge_commit: z
      .boolean()
      .describe('Whether to allow merge commits for pull requests.')
      .default(true),
    allow_rebase_merge: z
      .boolean()
      .describe('Whether to allow rebase merges for pull requests.')
      .default(true),
    allow_auto_merge: z
      .boolean()
      .describe('Whether to allow Auto-merge to be used on pull requests.')
      .default(false),
    delete_branch_on_merge: z
      .boolean()
      .describe('Whether to delete head branches when pull requests are merged')
      .default(false),
    squash_merge_commit_title: z
      .enum(['PR_TITLE', 'COMMIT_OR_PR_TITLE'])
      .describe(
        "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
      )
      .optional(),
    squash_merge_commit_message: z
      .enum(['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'])
      .describe(
        "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    merge_commit_title: z
      .enum(['PR_TITLE', 'MERGE_MESSAGE'])
      .describe(
        "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
      )
      .optional(),
    merge_commit_message: z
      .enum(['PR_BODY', 'PR_TITLE', 'BLANK'])
      .describe(
        "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
      )
      .optional(),
    has_downloads: z
      .boolean()
      .describe('Whether downloads are enabled.')
      .default(true),
    is_template: z
      .boolean()
      .describe(
        'Whether this repository acts as a template that can be used to generate new repositories.'
      )
      .default(false)
  })
  export type ReposCreateForAuthenticatedUserParams = z.infer<
    typeof ReposCreateForAuthenticatedUserParamsSchema
  >

  export type ReposCreateForAuthenticatedUserResponse = undefined

  export const ReposListInvitationsForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListInvitationsForAuthenticatedUserParams = z.infer<
    typeof ReposListInvitationsForAuthenticatedUserParamsSchema
  >

  export const ReposListInvitationsForAuthenticatedUserResponseSchema = z.array(
    RepositoryInvitationSchema
  )
  export type ReposListInvitationsForAuthenticatedUserResponse = z.infer<
    typeof ReposListInvitationsForAuthenticatedUserResponseSchema
  >

  export const ReposDeclineInvitationForAuthenticatedUserParamsSchema =
    z.object({
      invitation_id: z
        .number()
        .int()
        .describe('The unique identifier of the invitation.')
    })
  export type ReposDeclineInvitationForAuthenticatedUserParams = z.infer<
    typeof ReposDeclineInvitationForAuthenticatedUserParamsSchema
  >

  export type ReposDeclineInvitationForAuthenticatedUserResponse = undefined

  export const ReposAcceptInvitationForAuthenticatedUserParamsSchema = z.object(
    {
      invitation_id: z
        .number()
        .int()
        .describe('The unique identifier of the invitation.')
    }
  )
  export type ReposAcceptInvitationForAuthenticatedUserParams = z.infer<
    typeof ReposAcceptInvitationForAuthenticatedUserParamsSchema
  >

  export type ReposAcceptInvitationForAuthenticatedUserResponse = undefined

  export const UsersListSocialAccountsForAuthenticatedUserParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type UsersListSocialAccountsForAuthenticatedUserParams = z.infer<
    typeof UsersListSocialAccountsForAuthenticatedUserParamsSchema
  >

  export const UsersListSocialAccountsForAuthenticatedUserResponseSchema =
    z.array(SocialAccountSchema)
  export type UsersListSocialAccountsForAuthenticatedUserResponse = z.infer<
    typeof UsersListSocialAccountsForAuthenticatedUserResponseSchema
  >

  export const UsersAddSocialAccountForAuthenticatedUserParamsSchema = z.object(
    {
      account_urls: z
        .array(z.string())
        .describe('Full URLs for the social media profiles to add.')
    }
  )
  export type UsersAddSocialAccountForAuthenticatedUserParams = z.infer<
    typeof UsersAddSocialAccountForAuthenticatedUserParamsSchema
  >

  export type UsersAddSocialAccountForAuthenticatedUserResponse = undefined

  export const UsersDeleteSocialAccountForAuthenticatedUserParamsSchema =
    z.object({
      account_urls: z
        .array(z.string())
        .describe('Full URLs for the social media profiles to delete.')
    })
  export type UsersDeleteSocialAccountForAuthenticatedUserParams = z.infer<
    typeof UsersDeleteSocialAccountForAuthenticatedUserParamsSchema
  >

  export type UsersDeleteSocialAccountForAuthenticatedUserResponse = undefined

  export const UsersListSshSigningKeysForAuthenticatedUserParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type UsersListSshSigningKeysForAuthenticatedUserParams = z.infer<
    typeof UsersListSshSigningKeysForAuthenticatedUserParamsSchema
  >

  export const UsersListSshSigningKeysForAuthenticatedUserResponseSchema =
    z.array(SshSigningKeySchema)
  export type UsersListSshSigningKeysForAuthenticatedUserResponse = z.infer<
    typeof UsersListSshSigningKeysForAuthenticatedUserResponseSchema
  >

  export const UsersCreateSshSigningKeyForAuthenticatedUserParamsSchema =
    z.object({
      title: z
        .string()
        .describe('A descriptive name for the new key.')
        .optional(),
      key: z
        .string()
        .regex(
          new RegExp(
            '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com '
          )
        )
        .describe(
          'The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."'
        )
    })
  export type UsersCreateSshSigningKeyForAuthenticatedUserParams = z.infer<
    typeof UsersCreateSshSigningKeyForAuthenticatedUserParamsSchema
  >

  export type UsersCreateSshSigningKeyForAuthenticatedUserResponse = undefined

  export const UsersGetSshSigningKeyForAuthenticatedUserParamsSchema = z.object(
    {
      ssh_signing_key_id: z
        .number()
        .int()
        .describe('The unique identifier of the SSH signing key.')
    }
  )
  export type UsersGetSshSigningKeyForAuthenticatedUserParams = z.infer<
    typeof UsersGetSshSigningKeyForAuthenticatedUserParamsSchema
  >

  export const UsersGetSshSigningKeyForAuthenticatedUserResponseSchema =
    SshSigningKeySchema
  export type UsersGetSshSigningKeyForAuthenticatedUserResponse = z.infer<
    typeof UsersGetSshSigningKeyForAuthenticatedUserResponseSchema
  >

  export const UsersDeleteSshSigningKeyForAuthenticatedUserParamsSchema =
    z.object({
      ssh_signing_key_id: z
        .number()
        .int()
        .describe('The unique identifier of the SSH signing key.')
    })
  export type UsersDeleteSshSigningKeyForAuthenticatedUserParams = z.infer<
    typeof UsersDeleteSshSigningKeyForAuthenticatedUserParamsSchema
  >

  export type UsersDeleteSshSigningKeyForAuthenticatedUserResponse = undefined

  export const ActivityListReposStarredByAuthenticatedUserParamsSchema =
    z.object({
      sort: z
        .enum(['created', 'updated'])
        .describe(
          'The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.'
        )
        .default('created'),
      direction: z
        .enum(['asc', 'desc'])
        .describe('The direction to sort the results by.')
        .default('desc'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ActivityListReposStarredByAuthenticatedUserParams = z.infer<
    typeof ActivityListReposStarredByAuthenticatedUserParamsSchema
  >

  export const ActivityListReposStarredByAuthenticatedUserResponseSchema =
    z.array(RepositorySchema)
  export type ActivityListReposStarredByAuthenticatedUserResponse = z.infer<
    typeof ActivityListReposStarredByAuthenticatedUserResponseSchema
  >

  export const ActivityCheckRepoIsStarredByAuthenticatedUserParamsSchema =
    z.object({
      owner: z
        .string()
        .describe(
          'The account owner of the repository. The name is not case sensitive.'
        ),
      repo: z
        .string()
        .describe(
          'The name of the repository without the `.git` extension. The name is not case sensitive.'
        )
    })
  export type ActivityCheckRepoIsStarredByAuthenticatedUserParams = z.infer<
    typeof ActivityCheckRepoIsStarredByAuthenticatedUserParamsSchema
  >

  export type ActivityCheckRepoIsStarredByAuthenticatedUserResponse = undefined

  export const ActivityStarRepoForAuthenticatedUserParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivityStarRepoForAuthenticatedUserParams = z.infer<
    typeof ActivityStarRepoForAuthenticatedUserParamsSchema
  >

  export type ActivityStarRepoForAuthenticatedUserResponse = undefined

  export const ActivityUnstarRepoForAuthenticatedUserParamsSchema = z.object({
    owner: z
      .string()
      .describe(
        'The account owner of the repository. The name is not case sensitive.'
      ),
    repo: z
      .string()
      .describe(
        'The name of the repository without the `.git` extension. The name is not case sensitive.'
      )
  })
  export type ActivityUnstarRepoForAuthenticatedUserParams = z.infer<
    typeof ActivityUnstarRepoForAuthenticatedUserParamsSchema
  >

  export type ActivityUnstarRepoForAuthenticatedUserResponse = undefined

  export const ActivityListWatchedReposForAuthenticatedUserParamsSchema =
    z.object({
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    })
  export type ActivityListWatchedReposForAuthenticatedUserParams = z.infer<
    typeof ActivityListWatchedReposForAuthenticatedUserParamsSchema
  >

  export const ActivityListWatchedReposForAuthenticatedUserResponseSchema =
    z.array(MinimalRepositorySchema)
  export type ActivityListWatchedReposForAuthenticatedUserResponse = z.infer<
    typeof ActivityListWatchedReposForAuthenticatedUserResponseSchema
  >

  export const TeamsListForAuthenticatedUserParamsSchema = z.object({
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type TeamsListForAuthenticatedUserParams = z.infer<
    typeof TeamsListForAuthenticatedUserParamsSchema
  >

  export const TeamsListForAuthenticatedUserResponseSchema =
    z.array(TeamFullSchema)
  export type TeamsListForAuthenticatedUserResponse = z.infer<
    typeof TeamsListForAuthenticatedUserResponseSchema
  >

  export const UsersGetByIdParamsSchema = z.object({
    account_id: z.number().int().describe('account_id parameter')
  })
  export type UsersGetByIdParams = z.infer<typeof UsersGetByIdParamsSchema>

  export const UsersGetByIdResponseSchema = z.union([
    PrivateUserSchema,
    PublicUserSchema
  ])
  export type UsersGetByIdResponse = z.infer<typeof UsersGetByIdResponseSchema>

  export const UsersListParamsSchema = z.object({
    since: z
      .number()
      .int()
      .describe('A user ID. Only return users with an ID greater than this ID.')
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type UsersListParams = z.infer<typeof UsersListParamsSchema>

  export const UsersListResponseSchema = z.array(SimpleUserSchema)
  export type UsersListResponse = z.infer<typeof UsersListResponseSchema>

  export const UsersGetByUsernameParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type UsersGetByUsernameParams = z.infer<
    typeof UsersGetByUsernameParamsSchema
  >

  export const UsersGetByUsernameResponseSchema = z.union([
    PrivateUserSchema,
    PublicUserSchema
  ])
  export type UsersGetByUsernameResponse = z.infer<
    typeof UsersGetByUsernameResponseSchema
  >

  export const UsersListAttestationsParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    subject_digest: z.string().describe('Subject Digest'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    before: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    after: z
      .string()
      .describe(
        'A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .optional(),
    predicate_type: z
      .string()
      .describe(
        'Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.'
      )
      .optional()
  })
  export type UsersListAttestationsParams = z.infer<
    typeof UsersListAttestationsParamsSchema
  >

  export const UsersListAttestationsResponseSchema = z.object({
    attestations: z
      .array(
        z.object({
          bundle: z
            .object({
              mediaType: z.string().optional(),
              verificationMaterial: z.object({}).catchall(z.any()).optional(),
              dsseEnvelope: z.object({}).catchall(z.any()).optional()
            })
            .describe(
              "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information."
            )
            .optional(),
          repository_id: z.number().int().optional(),
          bundle_url: z.string().optional()
        })
      )
      .optional()
  })
  export type UsersListAttestationsResponse = z.infer<
    typeof UsersListAttestationsResponseSchema
  >

  export const PackagesListDockerMigrationConflictingPackagesForUserParamsSchema =
    z.object({
      username: z.string().describe('The handle for the GitHub user account.')
    })
  export type PackagesListDockerMigrationConflictingPackagesForUserParams =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForUserParamsSchema
    >

  export const PackagesListDockerMigrationConflictingPackagesForUserResponseSchema =
    z.array(PackageSchema)
  export type PackagesListDockerMigrationConflictingPackagesForUserResponse =
    z.infer<
      typeof PackagesListDockerMigrationConflictingPackagesForUserResponseSchema
    >

  export const ActivityListEventsForAuthenticatedUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListEventsForAuthenticatedUserParams = z.infer<
    typeof ActivityListEventsForAuthenticatedUserParamsSchema
  >

  export const ActivityListEventsForAuthenticatedUserResponseSchema =
    z.array(EventSchema)
  export type ActivityListEventsForAuthenticatedUserResponse = z.infer<
    typeof ActivityListEventsForAuthenticatedUserResponseSchema
  >

  export const ActivityListOrgEventsForAuthenticatedUserParamsSchema = z.object(
    {
      username: z.string().describe('The handle for the GitHub user account.'),
      org: z
        .string()
        .describe('The organization name. The name is not case sensitive.'),
      per_page: z
        .number()
        .int()
        .describe(
          'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(30),
      page: z
        .number()
        .int()
        .describe(
          'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
        )
        .default(1)
    }
  )
  export type ActivityListOrgEventsForAuthenticatedUserParams = z.infer<
    typeof ActivityListOrgEventsForAuthenticatedUserParamsSchema
  >

  export const ActivityListOrgEventsForAuthenticatedUserResponseSchema =
    z.array(EventSchema)
  export type ActivityListOrgEventsForAuthenticatedUserResponse = z.infer<
    typeof ActivityListOrgEventsForAuthenticatedUserResponseSchema
  >

  export const ActivityListPublicEventsForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListPublicEventsForUserParams = z.infer<
    typeof ActivityListPublicEventsForUserParamsSchema
  >

  export const ActivityListPublicEventsForUserResponseSchema =
    z.array(EventSchema)
  export type ActivityListPublicEventsForUserResponse = z.infer<
    typeof ActivityListPublicEventsForUserResponseSchema
  >

  export const UsersListFollowersForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListFollowersForUserParams = z.infer<
    typeof UsersListFollowersForUserParamsSchema
  >

  export const UsersListFollowersForUserResponseSchema =
    z.array(SimpleUserSchema)
  export type UsersListFollowersForUserResponse = z.infer<
    typeof UsersListFollowersForUserResponseSchema
  >

  export const UsersListFollowingForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListFollowingForUserParams = z.infer<
    typeof UsersListFollowingForUserParamsSchema
  >

  export const UsersListFollowingForUserResponseSchema =
    z.array(SimpleUserSchema)
  export type UsersListFollowingForUserResponse = z.infer<
    typeof UsersListFollowingForUserResponseSchema
  >

  export const UsersCheckFollowingForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    target_user: z.string()
  })
  export type UsersCheckFollowingForUserParams = z.infer<
    typeof UsersCheckFollowingForUserParamsSchema
  >

  export type UsersCheckFollowingForUserResponse = undefined

  export const GistsListForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    since: z
      .string()
      .datetime({ offset: true })
      .describe(
        'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type GistsListForUserParams = z.infer<
    typeof GistsListForUserParamsSchema
  >

  export const GistsListForUserResponseSchema = z.array(BaseGistSchema)
  export type GistsListForUserResponse = z.infer<
    typeof GistsListForUserResponseSchema
  >

  export const UsersListGpgKeysForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListGpgKeysForUserParams = z.infer<
    typeof UsersListGpgKeysForUserParamsSchema
  >

  export const UsersListGpgKeysForUserResponseSchema = z.array(GpgKeySchema)
  export type UsersListGpgKeysForUserResponse = z.infer<
    typeof UsersListGpgKeysForUserResponseSchema
  >

  export const UsersGetContextForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    subject_type: z
      .enum(['organization', 'repository', 'issue', 'pull_request'])
      .describe(
        "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`."
      )
      .optional(),
    subject_id: z
      .string()
      .describe(
        'Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.'
      )
      .optional()
  })
  export type UsersGetContextForUserParams = z.infer<
    typeof UsersGetContextForUserParamsSchema
  >

  export const UsersGetContextForUserResponseSchema = HovercardSchema
  export type UsersGetContextForUserResponse = z.infer<
    typeof UsersGetContextForUserResponseSchema
  >

  export const AppsGetUserInstallationParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type AppsGetUserInstallationParams = z.infer<
    typeof AppsGetUserInstallationParamsSchema
  >

  export const AppsGetUserInstallationResponseSchema = InstallationSchema
  export type AppsGetUserInstallationResponse = z.infer<
    typeof AppsGetUserInstallationResponseSchema
  >

  export const UsersListPublicKeysForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListPublicKeysForUserParams = z.infer<
    typeof UsersListPublicKeysForUserParamsSchema
  >

  export const UsersListPublicKeysForUserResponseSchema =
    z.array(KeySimpleSchema)
  export type UsersListPublicKeysForUserResponse = z.infer<
    typeof UsersListPublicKeysForUserResponseSchema
  >

  export const OrgsListForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type OrgsListForUserParams = z.infer<
    typeof OrgsListForUserParamsSchema
  >

  export const OrgsListForUserResponseSchema = z.array(OrganizationSimpleSchema)
  export type OrgsListForUserResponse = z.infer<
    typeof OrgsListForUserResponseSchema
  >

  export const PackagesListPackagesForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    visibility: z
      .enum(['public', 'private', 'internal'])
      .describe(
        'The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."'
      )
      .optional(),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30)
  })
  export type PackagesListPackagesForUserParams = z.infer<
    typeof PackagesListPackagesForUserParamsSchema
  >

  export const PackagesListPackagesForUserResponseSchema =
    z.array(PackageSchema)
  export type PackagesListPackagesForUserResponse = z.infer<
    typeof PackagesListPackagesForUserResponseSchema
  >

  export const PackagesGetPackageForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type PackagesGetPackageForUserParams = z.infer<
    typeof PackagesGetPackageForUserParamsSchema
  >

  export const PackagesGetPackageForUserResponseSchema = PackageSchema
  export type PackagesGetPackageForUserResponse = z.infer<
    typeof PackagesGetPackageForUserResponseSchema
  >

  export const PackagesDeletePackageForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type PackagesDeletePackageForUserParams = z.infer<
    typeof PackagesDeletePackageForUserParamsSchema
  >

  export type PackagesDeletePackageForUserResponse = undefined

  export const PackagesRestorePackageForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    token: z.string().describe('package token').optional()
  })
  export type PackagesRestorePackageForUserParams = z.infer<
    typeof PackagesRestorePackageForUserParamsSchema
  >

  export type PackagesRestorePackageForUserResponse = undefined

  export const PackagesGetAllPackageVersionsForPackageOwnedByUserParamsSchema =
    z.object({
      package_type: z
        .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
        .describe(
          "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
        ),
      package_name: z.string().describe('The name of the package.'),
      username: z.string().describe('The handle for the GitHub user account.')
    })
  export type PackagesGetAllPackageVersionsForPackageOwnedByUserParams =
    z.infer<
      typeof PackagesGetAllPackageVersionsForPackageOwnedByUserParamsSchema
    >

  export const PackagesGetAllPackageVersionsForPackageOwnedByUserResponseSchema =
    z.array(PackageVersionSchema)
  export type PackagesGetAllPackageVersionsForPackageOwnedByUserResponse =
    z.infer<
      typeof PackagesGetAllPackageVersionsForPackageOwnedByUserResponseSchema
    >

  export const PackagesGetPackageVersionForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.'),
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type PackagesGetPackageVersionForUserParams = z.infer<
    typeof PackagesGetPackageVersionForUserParamsSchema
  >

  export const PackagesGetPackageVersionForUserResponseSchema =
    PackageVersionSchema
  export type PackagesGetPackageVersionForUserResponse = z.infer<
    typeof PackagesGetPackageVersionForUserResponseSchema
  >

  export const PackagesDeletePackageVersionForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.')
  })
  export type PackagesDeletePackageVersionForUserParams = z.infer<
    typeof PackagesDeletePackageVersionForUserParamsSchema
  >

  export type PackagesDeletePackageVersionForUserResponse = undefined

  export const PackagesRestorePackageVersionForUserParamsSchema = z.object({
    package_type: z
      .enum(['npm', 'maven', 'rubygems', 'docker', 'nuget', 'container'])
      .describe(
        "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry."
      ),
    package_name: z.string().describe('The name of the package.'),
    username: z.string().describe('The handle for the GitHub user account.'),
    package_version_id: z
      .number()
      .int()
      .describe('Unique identifier of the package version.')
  })
  export type PackagesRestorePackageVersionForUserParams = z.infer<
    typeof PackagesRestorePackageVersionForUserParamsSchema
  >

  export type PackagesRestorePackageVersionForUserResponse = undefined

  export const ProjectsListForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    state: z
      .enum(['open', 'closed', 'all'])
      .describe('Indicates the state of the projects to return.')
      .default('open'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ProjectsListForUserParams = z.infer<
    typeof ProjectsListForUserParamsSchema
  >

  export const ProjectsListForUserResponseSchema = z.array(ProjectSchema)
  export type ProjectsListForUserResponse = z.infer<
    typeof ProjectsListForUserResponseSchema
  >

  export const ActivityListReceivedEventsForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListReceivedEventsForUserParams = z.infer<
    typeof ActivityListReceivedEventsForUserParamsSchema
  >

  export const ActivityListReceivedEventsForUserResponseSchema =
    z.array(EventSchema)
  export type ActivityListReceivedEventsForUserResponse = z.infer<
    typeof ActivityListReceivedEventsForUserResponseSchema
  >

  export const ActivityListReceivedPublicEventsForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListReceivedPublicEventsForUserParams = z.infer<
    typeof ActivityListReceivedPublicEventsForUserParamsSchema
  >

  export const ActivityListReceivedPublicEventsForUserResponseSchema =
    z.array(EventSchema)
  export type ActivityListReceivedPublicEventsForUserResponse = z.infer<
    typeof ActivityListReceivedPublicEventsForUserResponseSchema
  >

  export const ReposListForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    type: z
      .enum(['all', 'owner', 'member'])
      .describe('Limit results to repositories of the specified type.')
      .default('owner'),
    sort: z
      .enum(['created', 'updated', 'pushed', 'full_name'])
      .describe('The property to sort the results by.')
      .default('full_name'),
    direction: z
      .enum(['asc', 'desc'])
      .describe(
        'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.'
      )
      .optional(),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ReposListForUserParams = z.infer<
    typeof ReposListForUserParamsSchema
  >

  export const ReposListForUserResponseSchema = z.array(MinimalRepositorySchema)
  export type ReposListForUserResponse = z.infer<
    typeof ReposListForUserResponseSchema
  >

  export const BillingGetGithubActionsBillingUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type BillingGetGithubActionsBillingUserParams = z.infer<
    typeof BillingGetGithubActionsBillingUserParamsSchema
  >

  export const BillingGetGithubActionsBillingUserResponseSchema =
    ActionsBillingUsageSchema
  export type BillingGetGithubActionsBillingUserResponse = z.infer<
    typeof BillingGetGithubActionsBillingUserResponseSchema
  >

  export const BillingGetGithubPackagesBillingUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type BillingGetGithubPackagesBillingUserParams = z.infer<
    typeof BillingGetGithubPackagesBillingUserParamsSchema
  >

  export const BillingGetGithubPackagesBillingUserResponseSchema =
    PackagesBillingUsageSchema
  export type BillingGetGithubPackagesBillingUserResponse = z.infer<
    typeof BillingGetGithubPackagesBillingUserResponseSchema
  >

  export const BillingGetSharedStorageBillingUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.')
  })
  export type BillingGetSharedStorageBillingUserParams = z.infer<
    typeof BillingGetSharedStorageBillingUserParamsSchema
  >

  export const BillingGetSharedStorageBillingUserResponseSchema =
    CombinedBillingUsageSchema
  export type BillingGetSharedStorageBillingUserResponse = z.infer<
    typeof BillingGetSharedStorageBillingUserResponseSchema
  >

  export const UsersListSocialAccountsForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListSocialAccountsForUserParams = z.infer<
    typeof UsersListSocialAccountsForUserParamsSchema
  >

  export const UsersListSocialAccountsForUserResponseSchema =
    z.array(SocialAccountSchema)
  export type UsersListSocialAccountsForUserResponse = z.infer<
    typeof UsersListSocialAccountsForUserResponseSchema
  >

  export const UsersListSshSigningKeysForUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type UsersListSshSigningKeysForUserParams = z.infer<
    typeof UsersListSshSigningKeysForUserParamsSchema
  >

  export const UsersListSshSigningKeysForUserResponseSchema =
    z.array(SshSigningKeySchema)
  export type UsersListSshSigningKeysForUserResponse = z.infer<
    typeof UsersListSshSigningKeysForUserResponseSchema
  >

  export const ActivityListReposStarredByUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    sort: z
      .enum(['created', 'updated'])
      .describe(
        'The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.'
      )
      .default('created'),
    direction: z
      .enum(['asc', 'desc'])
      .describe('The direction to sort the results by.')
      .default('desc'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListReposStarredByUserParams = z.infer<
    typeof ActivityListReposStarredByUserParamsSchema
  >

  export const ActivityListReposStarredByUserResponseSchema = z.union([
    z.array(StarredRepositorySchema),
    z.array(RepositorySchema)
  ])
  export type ActivityListReposStarredByUserResponse = z.infer<
    typeof ActivityListReposStarredByUserResponseSchema
  >

  export const ActivityListReposWatchedByUserParamsSchema = z.object({
    username: z.string().describe('The handle for the GitHub user account.'),
    per_page: z
      .number()
      .int()
      .describe(
        'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(30),
    page: z
      .number()
      .int()
      .describe(
        'The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."'
      )
      .default(1)
  })
  export type ActivityListReposWatchedByUserParams = z.infer<
    typeof ActivityListReposWatchedByUserParamsSchema
  >

  export const ActivityListReposWatchedByUserResponseSchema = z.array(
    MinimalRepositorySchema
  )
  export type ActivityListReposWatchedByUserResponse = z.infer<
    typeof ActivityListReposWatchedByUserResponseSchema
  >

  export const MetaGetAllVersionsParamsSchema = z.object({})
  export type MetaGetAllVersionsParams = z.infer<
    typeof MetaGetAllVersionsParamsSchema
  >

  export const MetaGetAllVersionsResponseSchema = z.array(z.string().date())
  export type MetaGetAllVersionsResponse = z.infer<
    typeof MetaGetAllVersionsResponseSchema
  >

  export const MetaGetZenParamsSchema = z.object({})
  export type MetaGetZenParams = z.infer<typeof MetaGetZenParamsSchema>

  export type MetaGetZenResponse = undefined
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/notion-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { notion } from './notion'

/**
 * Agentic Notion client.
 *
 * API specification for Notion.
 */
export class NotionClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('NOTION_API_KEY'),
    apiBaseUrl = notion.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'NotionClient missing required "apiKey" (defaults to "NOTION_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  /**
   * Get current user.
   */
  @aiFunction({
    name: 'notion_get_self',
    description: `Get current user.`,
    inputSchema: notion.GetSelfParamsSchema
  })
  async getSelf(
    _params: notion.GetSelfParams
  ): Promise<notion.GetSelfResponse> {
    return this.ky.get('/users/me').json<notion.GetSelfResponse>()
  }

  /**
   * Get user.
   */
  @aiFunction({
    name: 'notion_get_user',
    description: `Get user.`,
    inputSchema: notion.GetUserParamsSchema
  })
  async getUser(params: notion.GetUserParams): Promise<notion.GetUserResponse> {
    return this.ky
      .get(`/users/${params.user_id}`)
      .json<notion.GetUserResponse>()
  }

  /**
   * List users.
   */
  @aiFunction({
    name: 'notion_list_users',
    description: `List users.`,
    inputSchema: notion.ListUsersParamsSchema
  })
  async listUsers(
    params: notion.ListUsersParams
  ): Promise<notion.ListUsersResponse> {
    return this.ky
      .get('/users', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListUsersResponse>()
  }

  /**
   * Create page.
   */
  @aiFunction({
    name: 'notion_create_page',
    description: `Create page.`,
    inputSchema: notion.CreatePageParamsSchema
  })
  async createPage(
    params: notion.CreatePageParams
  ): Promise<notion.CreatePageResponse> {
    return this.ky
      .post('/pages', {
        json: pick(params, 'parent', 'properties')
      })
      .json<notion.CreatePageResponse>()
  }

  /**
   * Get page.
   */
  @aiFunction({
    name: 'notion_get_page',
    description: `Get page.`,
    inputSchema: notion.GetPageParamsSchema
  })
  async getPage(params: notion.GetPageParams): Promise<notion.GetPageResponse> {
    return this.ky
      .get(`/pages/${params.page_id}`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties'))
      })
      .json<notion.GetPageResponse>()
  }

  /**
   * Update page.
   */
  @aiFunction({
    name: 'notion_update_page',
    description: `Update page.`,
    inputSchema: notion.UpdatePageParamsSchema
  })
  async updatePage(
    params: notion.UpdatePageParams
  ): Promise<notion.UpdatePageResponse> {
    return this.ky
      .patch(`/pages/${params.page_id}`, {
        json: pick(params, 'properties', 'archived')
      })
      .json<notion.UpdatePageResponse>()
  }

  /**
   * Get page property.
   */
  @aiFunction({
    name: 'notion_get_page_property',
    description: `Get page property.`,
    inputSchema: notion.GetPagePropertyParamsSchema
  })
  async getPageProperty(
    params: notion.GetPagePropertyParams
  ): Promise<notion.GetPagePropertyResponse> {
    return this.ky
      .get(`/pages/${params.page_id}/properties/${params.property_id}`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.GetPagePropertyResponse>()
  }

  /**
   * Get block.
   */
  @aiFunction({
    name: 'notion_get_block',
    description: `Get block.`,
    inputSchema: notion.GetBlockParamsSchema
  })
  async getBlock(
    params: notion.GetBlockParams
  ): Promise<notion.GetBlockResponse> {
    return this.ky
      .get(`/blocks/${params.block_id}`)
      .json<notion.GetBlockResponse>()
  }

  /**
   * Delete block.
   */
  @aiFunction({
    name: 'notion_delete_block',
    description: `Delete block.`,
    inputSchema: notion.DeleteBlockParamsSchema
  })
  async deleteBlock(
    params: notion.DeleteBlockParams
  ): Promise<notion.DeleteBlockResponse> {
    return this.ky
      .delete(`/blocks/${params.block_id}`)
      .json<notion.DeleteBlockResponse>()
  }

  /**
   * Update block.
   */
  @aiFunction({
    name: 'notion_update_block',
    description: `Update block.`,
    inputSchema: notion.UpdateBlockParamsSchema
  })
  async updateBlock(
    params: notion.UpdateBlockParams
  ): Promise<notion.UpdateBlockResponse> {
    return this.ky
      .patch(`/blocks/${params.block_id}`, {
        json: pick(
          params,
          'paragraph',
          'heading_1',
          'heading_2',
          'heading_3',
          'bulleted_list_item',
          'numbered_list_item',
          'quote',
          'to_do',
          'toggle',
          'code',
          'embed',
          'image',
          'video',
          'file',
          'pdf',
          'bookmark',
          'equation',
          'divider',
          'table_of_contents',
          'breadcrumb',
          'column_list',
          'column',
          'link_to_page',
          'table_row',
          'archived'
        )
      })
      .json<notion.UpdateBlockResponse>()
  }

  /**
   * List block children.
   */
  @aiFunction({
    name: 'notion_list_block_children',
    description: `List block children.`,
    inputSchema: notion.ListBlockChildrenParamsSchema
  })
  async listBlockChildren(
    params: notion.ListBlockChildrenParams
  ): Promise<notion.ListBlockChildrenResponse> {
    return this.ky
      .get(`/blocks/${params.block_id}/children`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListBlockChildrenResponse>()
  }

  /**
   * Append block children.
   */
  @aiFunction({
    name: 'notion_append_block_children',
    description: `Append block children.`,
    inputSchema: notion.AppendBlockChildrenParamsSchema
  })
  async appendBlockChildren(
    params: notion.AppendBlockChildrenParams
  ): Promise<notion.AppendBlockChildrenResponse> {
    return this.ky
      .patch(`/blocks/${params.block_id}/children`, {
        json: pick(params, 'children')
      })
      .json<notion.AppendBlockChildrenResponse>()
  }

  /**
   * Get database.
   */
  @aiFunction({
    name: 'notion_get_database',
    description: `Get database.`,
    inputSchema: notion.GetDatabaseParamsSchema
  })
  async getDatabase(
    params: notion.GetDatabaseParams
  ): Promise<notion.GetDatabaseResponse> {
    return this.ky
      .get(`/databases/${params.database_id}`)
      .json<notion.GetDatabaseResponse>()
  }

  /**
   * Update database.
   */
  @aiFunction({
    name: 'notion_update_database',
    description: `Update database.`,
    inputSchema: notion.UpdateDatabaseParamsSchema
  })
  async updateDatabase(
    params: notion.UpdateDatabaseParams
  ): Promise<notion.UpdateDatabaseResponse> {
    return this.ky
      .patch(`/databases/${params.database_id}`, {
        json: pick(
          params,
          'title',
          'description',
          'icon',
          'cover',
          'properties',
          'is_inline',
          'archived'
        )
      })
      .json<notion.UpdateDatabaseResponse>()
  }

  /**
   * Query database.
   */
  @aiFunction({
    name: 'notion_query_database',
    description: `Query database.`,
    inputSchema: notion.QueryDatabaseParamsSchema
  })
  async queryDatabase(
    params: notion.QueryDatabaseParams
  ): Promise<notion.QueryDatabaseResponse> {
    return this.ky
      .post(`/databases/${params.database_id}/query`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties')),
        json: pick(
          params,
          'sorts',
          'filter',
          'start_cursor',
          'page_size',
          'archived'
        )
      })
      .json<notion.QueryDatabaseResponse>()
  }

  /**
   * List databases.
   */
  @aiFunction({
    name: 'notion_list_databases',
    description: `List databases.`,
    inputSchema: notion.ListDatabasesParamsSchema
  })
  async listDatabases(
    params: notion.ListDatabasesParams
  ): Promise<notion.ListDatabasesResponse> {
    return this.ky
      .get('/databases', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListDatabasesResponse>()
  }

  /**
   * Create database.
   */
  @aiFunction({
    name: 'notion_create_database',
    description: `Create database.`,
    inputSchema: notion.CreateDatabaseParamsSchema
  })
  async createDatabase(
    params: notion.CreateDatabaseParams
  ): Promise<notion.CreateDatabaseResponse> {
    return this.ky
      .post('/databases', {
        json: pick(
          params,
          'parent',
          'properties',
          'icon',
          'cover',
          'title',
          'description',
          'is_inline'
        )
      })
      .json<notion.CreateDatabaseResponse>()
  }

  /**
   * Search.
   */
  @aiFunction({
    name: 'notion_search',
    description: `Search.`,
    inputSchema: notion.SearchParamsSchema
  })
  async search(params: notion.SearchParams): Promise<notion.SearchResponse> {
    return this.ky
      .post('/search', {
        json: pick(
          params,
          'query',
          'sort',
          'filter',
          'start_cursor',
          'page_size'
        )
      })
      .json<notion.SearchResponse>()
  }

  /**
   * List comments.
   */
  @aiFunction({
    name: 'notion_list_comments',
    description: `List comments.`,
    inputSchema: notion.ListCommentsParamsSchema
  })
  async listComments(
    params: notion.ListCommentsParams
  ): Promise<notion.ListCommentsResponse> {
    return this.ky
      .get('/comments', {
        searchParams: sanitizeSearchParams(
          pick(params, 'block_id', 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListCommentsResponse>()
  }

  /**
   * Create comment.
   */
  @aiFunction({
    name: 'notion_create_comment',
    description: `Create comment.`,
    // TODO: Improve handling of union params
    inputSchema: notion.CreateCommentParamsSchema as any
  })
  async createComment(
    params: notion.CreateCommentParams
  ): Promise<notion.CreateCommentResponse> {
    return this.ky
      .post('/comments', {
        json: params
      })
      .json<notion.CreateCommentResponse>()
  }

  /**
   * OAuth token.
   */
  @aiFunction({
    name: 'notion_oauth_token',
    description: `OAuth token.`,
    inputSchema: notion.OauthTokenParamsSchema
  })
  async oauthToken(
    params: notion.OauthTokenParams
  ): Promise<notion.OauthTokenResponse> {
    return this.ky
      .post('/oauth/token', {
        json: pick(
          params,
          'grant_type',
          'code',
          'redirect_uri',
          'external_account'
        )
      })
      .json<notion.OauthTokenResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/notion.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace notion {
  export const apiBaseUrl = 'https://api.notion.so'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const UserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string(),
    type: z.enum(['person', 'bot']),
    name: z.string(),
    avatar_url: z.string()
  })
  export type UserObjectResponse = z.infer<typeof UserObjectResponseSchema>

  export const AnnotationRequestSchema = z.object({
    bold: z.boolean().optional(),
    italic: z.boolean().optional(),
    strikethrough: z.boolean().optional(),
    underline: z.boolean().optional(),
    code: z.boolean().optional(),
    color: z
      .enum([
        'default',
        'gray',
        'brown',
        'orange',
        'yellow',
        'green',
        'blue',
        'purple',
        'pink',
        'red',
        'gray_background',
        'brown_background',
        'orange_background',
        'yellow_background',
        'green_background',
        'blue_background',
        'purple_background',
        'pink_background',
        'red_background'
      ])
      .optional()
  })
  export type AnnotationRequest = z.infer<typeof AnnotationRequestSchema>

  export const DateRequestSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]).optional(),
    time_zone: z.union([z.string(), z.null()]).optional()
  })
  export type DateRequest = z.infer<typeof DateRequestSchema>

  export const PageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    archived: z.boolean(),
    url: z.string()
  })
  export type PageObjectResponse = z.infer<typeof PageObjectResponseSchema>

  export const PartialPageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string()
  })
  export type PartialPageObjectResponse = z.infer<
    typeof PartialPageObjectResponseSchema
  >

  export const PropertyItemObjectResponseSchema = z.object({
    type: z.string(),
    id: z.string()
  })
  export type PropertyItemObjectResponse = z.infer<
    typeof PropertyItemObjectResponseSchema
  >

  export const PartialBlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string()
  })
  export type PartialBlockObjectResponse = z.infer<
    typeof PartialBlockObjectResponseSchema
  >

  export const BlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string(),
    type: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    has_children: z.boolean(),
    archived: z.boolean()
  })
  export type BlockObjectResponse = z.infer<typeof BlockObjectResponseSchema>

  export const TitlePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('title'),
    title: z.record(z.any())
  })
  export type TitlePropertyResponse = z.infer<
    typeof TitlePropertyResponseSchema
  >

  export const RichTextPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rich_text'),
    rich_text: z.record(z.any())
  })
  export type RichTextPropertyResponse = z.infer<
    typeof RichTextPropertyResponseSchema
  >

  export const NumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('number'),
    number: z.object({ format: z.string() })
  })
  export type NumberPropertyResponse = z.infer<
    typeof NumberPropertyResponseSchema
  >

  export const SelectOptionSchema = z.object({
    id: z.string(),
    name: z.string(),
    color: z.string()
  })
  export type SelectOption = z.infer<typeof SelectOptionSchema>

  export const DatePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('date'),
    date: z.record(z.any())
  })
  export type DatePropertyResponse = z.infer<typeof DatePropertyResponseSchema>

  export const PeoplePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('people'),
    people: z.record(z.any())
  })
  export type PeoplePropertyResponse = z.infer<
    typeof PeoplePropertyResponseSchema
  >

  export const FilePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('files'),
    files: z.record(z.any())
  })
  export type FilePropertyResponse = z.infer<typeof FilePropertyResponseSchema>

  export const CheckboxPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('checkbox'),
    checkbox: z.record(z.any())
  })
  export type CheckboxPropertyResponse = z.infer<
    typeof CheckboxPropertyResponseSchema
  >

  export const UrlPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('url'),
    url: z.record(z.any())
  })
  export type UrlPropertyResponse = z.infer<typeof UrlPropertyResponseSchema>

  export const EmailPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('email'),
    email: z.record(z.any())
  })
  export type EmailPropertyResponse = z.infer<
    typeof EmailPropertyResponseSchema
  >

  export const PhoneNumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('phone_number'),
    phone_number: z.record(z.any())
  })
  export type PhoneNumberPropertyResponse = z.infer<
    typeof PhoneNumberPropertyResponseSchema
  >

  export const FormulaPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('formula'),
    formula: z.object({ expression: z.string() })
  })
  export type FormulaPropertyResponse = z.infer<
    typeof FormulaPropertyResponseSchema
  >

  export const RelationPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('relation'),
    relation: z.object({
      database_id: z.string(),
      synced_property_name: z.string(),
      synced_property_id: z.string()
    })
  })
  export type RelationPropertyResponse = z.infer<
    typeof RelationPropertyResponseSchema
  >

  export const RollupPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rollup'),
    rollup: z.object({
      relation_property_name: z.string(),
      relation_property_id: z.string(),
      rollup_property_name: z.string(),
      rollup_property_id: z.string(),
      function: z.string()
    })
  })
  export type RollupPropertyResponse = z.infer<
    typeof RollupPropertyResponseSchema
  >

  export const CreatedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_time'),
    created_time: z.record(z.any())
  })
  export type CreatedTimePropertyResponse = z.infer<
    typeof CreatedTimePropertyResponseSchema
  >

  export const CreatedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_by'),
    created_by: z.record(z.any())
  })
  export type CreatedByPropertyResponse = z.infer<
    typeof CreatedByPropertyResponseSchema
  >

  export const LastEditedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_time'),
    last_edited_time: z.record(z.any())
  })
  export type LastEditedTimePropertyResponse = z.infer<
    typeof LastEditedTimePropertyResponseSchema
  >

  export const LastEditedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_by'),
    last_edited_by: z.record(z.any())
  })
  export type LastEditedByPropertyResponse = z.infer<
    typeof LastEditedByPropertyResponseSchema
  >

  export const PartialUserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string()
  })
  export type PartialUserObjectResponse = z.infer<
    typeof PartialUserObjectResponseSchema
  >

  export const AnnotationResponseSchema = z.object({
    bold: z.boolean(),
    italic: z.boolean(),
    strikethrough: z.boolean(),
    underline: z.boolean(),
    code: z.boolean(),
    color: z.enum([
      'default',
      'gray',
      'brown',
      'orange',
      'yellow',
      'green',
      'blue',
      'purple',
      'pink',
      'red',
      'gray_background',
      'brown_background',
      'orange_background',
      'yellow_background',
      'green_background',
      'blue_background',
      'purple_background',
      'pink_background',
      'red_background'
    ])
  })
  export type AnnotationResponse = z.infer<typeof AnnotationResponseSchema>

  export const DateResponseSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]),
    time_zone: z.union([z.string(), z.null()])
  })
  export type DateResponse = z.infer<typeof DateResponseSchema>

  export const PropertyUpdateSchemaSchema = z.object({
    name: z.string().optional(),
    type: z.string().optional()
  })
  export type PropertyUpdateSchema = z.infer<typeof PropertyUpdateSchemaSchema>

  export const TextPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    starts_with: z.string().optional(),
    ends_with: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type TextPropertyFilter = z.infer<typeof TextPropertyFilterSchema>

  export const NumberPropertyFilterSchema = z.object({
    equals: z.number().optional(),
    does_not_equal: z.number().optional(),
    greater_than: z.number().optional(),
    less_than: z.number().optional(),
    greater_than_or_equal_to: z.number().optional(),
    less_than_or_equal_to: z.number().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type NumberPropertyFilter = z.infer<typeof NumberPropertyFilterSchema>

  export const CheckboxPropertyFilterSchema = z.object({
    equals: z.boolean().optional(),
    does_not_equal: z.boolean().optional()
  })
  export type CheckboxPropertyFilter = z.infer<
    typeof CheckboxPropertyFilterSchema
  >

  export const SelectPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type SelectPropertyFilter = z.infer<typeof SelectPropertyFilterSchema>

  export const MultiSelectPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type MultiSelectPropertyFilter = z.infer<
    typeof MultiSelectPropertyFilterSchema
  >

  export const DatePropertyFilterSchema = z.object({
    equals: z.string().optional(),
    before: z.string().optional(),
    after: z.string().optional(),
    on_or_before: z.string().optional(),
    on_or_after: z.string().optional(),
    past_week: z.any().optional(),
    past_month: z.any().optional(),
    past_year: z.any().optional(),
    next_week: z.any().optional(),
    next_month: z.any().optional(),
    next_year: z.any().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type DatePropertyFilter = z.infer<typeof DatePropertyFilterSchema>

  export const PeoplePropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type PeoplePropertyFilter = z.infer<typeof PeoplePropertyFilterSchema>

  export const FilesPropertyFilterSchema = z.object({
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type FilesPropertyFilter = z.infer<typeof FilesPropertyFilterSchema>

  export const RelationPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type RelationPropertyFilter = z.infer<
    typeof RelationPropertyFilterSchema
  >

  export const PropertySchemaSchema = z.object({
    type: z.string(),
    name: z.union([z.string(), z.null()]).optional()
  })
  export type PropertySchema = z.infer<typeof PropertySchemaSchema>

  export const SearchParametersSchema = z.object({
    query: z.string().optional(),
    sort: z
      .object({
        direction: z.enum(['ascending', 'descending']),
        timestamp: z.literal('last_edited_time')
      })
      .optional(),
    filter: z
      .object({
        value: z.enum(['page', 'database']),
        property: z.literal('object')
      })
      .optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type SearchParameters = z.infer<typeof SearchParametersSchema>

  export const PartialCommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string()
  })
  export type PartialCommentObjectResponse = z.infer<
    typeof PartialCommentObjectResponseSchema
  >

  export const OauthTokenParametersSchema = z.object({
    grant_type: z.string(),
    code: z.string(),
    redirect_uri: z.string().optional(),
    external_account: z.object({ key: z.string(), name: z.string() }).optional()
  })
  export type OauthTokenParameters = z.infer<typeof OauthTokenParametersSchema>

  export const ListUsersResponseSchema = z.object({
    results: z.array(UserObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListUsersResponse = z.infer<typeof ListUsersResponseSchema>

  export const PropertyItemListResponseSchema = z.object({
    results: z.array(PropertyItemObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type PropertyItemListResponse = z.infer<
    typeof PropertyItemListResponseSchema
  >

  export const SelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('select'),
    select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type SelectPropertyResponse = z.infer<
    typeof SelectPropertyResponseSchema
  >

  export const MultiSelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('multi_select'),
    multi_select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type MultiSelectPropertyResponse = z.infer<
    typeof MultiSelectPropertyResponseSchema
  >

  export const TextRichTextItemResponseSchema = z.object({
    type: z.literal('text'),
    text: z.object({
      content: z.string(),
      link: z.union([z.object({ url: z.string() }), z.null()])
    }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type TextRichTextItemResponse = z.infer<
    typeof TextRichTextItemResponseSchema
  >

  export const EquationRichTextItemResponseSchema = z.object({
    type: z.literal('equation'),
    equation: z.object({ expression: z.string() }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type EquationRichTextItemResponse = z.infer<
    typeof EquationRichTextItemResponseSchema
  >

  export const ListBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListBlockChildrenResponse = z.infer<
    typeof ListBlockChildrenResponseSchema
  >

  export const AppendBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type AppendBlockChildrenResponse = z.infer<
    typeof AppendBlockChildrenResponseSchema
  >

  export const QueryDatabaseResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PageObjectResponseSchema, PartialPageObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type QueryDatabaseResponse = z.infer<
    typeof QueryDatabaseResponseSchema
  >

  export const OauthTokenResponseSchema = z.object({
    access_token: z.string(),
    token_type: z.literal('bearer'),
    bot_id: z.string(),
    workspace_name: z.union([z.string(), z.null()]),
    workspace_icon: z.union([z.string(), z.null()]),
    workspace_id: z.string(),
    owner: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          UserObjectResponseSchema,
          PartialUserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    duplicated_template_id: z.union([z.string(), z.null()])
  })
  export type OauthTokenResponse = z.infer<typeof OauthTokenResponseSchema>

  export const RichTextItemRequestSchema = z.union([
    z.object({
      text: z.object({
        content: z.string(),
        link: z.union([z.object({ url: z.string() }), z.null()]).optional()
      }),
      type: z.literal('text').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      mention: z.union([
        z.object({
          user: z.union([
            z.object({ id: z.string() }),
            UserObjectResponseSchema
          ])
        }),
        z.object({ page: z.object({ id: z.string() }) }),
        z.object({ database: z.object({ id: z.string() }) }),
        z.object({ date: DateRequestSchema })
      ]),
      type: z.literal('mention').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      equation: z.object({ expression: z.string() }),
      type: z.literal('equation').optional(),
      annotations: AnnotationRequestSchema.optional()
    })
  ])
  export type RichTextItemRequest = z.infer<typeof RichTextItemRequestSchema>

  export const CreatePageParametersSchema = z.object({
    parent: z
      .record(z.any())
      .and(
        z.union([
          z.object({ type: z.literal('page_id'), page_id: z.string() }),
          z.object({ type: z.literal('database_id'), database_id: z.string() })
        ])
      ),
    properties: z.record(
      z.union([
        z.object({ title: z.array(RichTextItemRequestSchema) }),
        z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
        z.object({ number: z.union([z.number(), z.null()]) }),
        z.object({
          select: z.union([z.object({ name: z.string() }), z.null()])
        })
      ])
    )
  })
  export type CreatePageParameters = z.infer<typeof CreatePageParametersSchema>

  export const UpdatePageParametersSchema = z.object({
    properties: z
      .record(
        z.union([
          z.object({ title: z.array(RichTextItemRequestSchema) }),
          z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
          z.object({ number: z.union([z.number(), z.null()]) }),
          z.object({
            select: z.union([z.object({ name: z.string() }), z.null()])
          })
        ])
      )
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdatePageParameters = z.infer<typeof UpdatePageParametersSchema>

  export const UpdateBlockParametersSchema = z.object({
    paragraph: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_1: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_2: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_3: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    bulleted_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    numbered_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    quote: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    to_do: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        checked: z.boolean().optional(),
        color: z.string().optional()
      })
      .optional(),
    toggle: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    code: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        language: z.string().optional()
      })
      .optional(),
    embed: z.object({ url: z.string().optional() }).optional(),
    image: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    video: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    file: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    pdf: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    bookmark: z.object({ url: z.string().optional() }).optional(),
    equation: z.object({ expression: z.string().optional() }).optional(),
    divider: z.record(z.any()).optional(),
    table_of_contents: z.object({ color: z.string().optional() }).optional(),
    breadcrumb: z.record(z.any()).optional(),
    column_list: z.record(z.any()).optional(),
    column: z.record(z.any()).optional(),
    link_to_page: z
      .object({
        type: z.enum(['page_id', 'database_id']).optional(),
        page_id: z.string().optional(),
        database_id: z.string().optional()
      })
      .optional(),
    table_row: z
      .object({ cells: z.array(z.array(RichTextItemRequestSchema)).optional() })
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdateBlockParameters = z.infer<
    typeof UpdateBlockParametersSchema
  >

  export const BlockObjectRequestSchema = z.union([
    z.object({
      object: z.literal('block'),
      type: z.literal('paragraph'),
      paragraph: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_1'),
      heading_1: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_2'),
      heading_2: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_3'),
      heading_3: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bulleted_list_item'),
      bulleted_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('numbered_list_item'),
      numbered_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('to_do'),
      to_do: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        checked: z.boolean(),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('toggle'),
      toggle: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('code'),
      code: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        language: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_page'),
      child_page: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_database'),
      child_database: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('embed'),
      embed: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('image'),
      image: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('video'),
      video: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('file'),
      file: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('pdf'),
      pdf: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bookmark'),
      bookmark: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('equation'),
      equation: z.object({ expression: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('divider'),
      divider: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_of_contents'),
      table_of_contents: z.object({ color: z.string().optional() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column_list'),
      column_list: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column'),
      column: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('link_to_page'),
      link_to_page: z.union([
        z.object({ type: z.literal('page_id'), page_id: z.string() }),
        z.object({ type: z.literal('database_id'), database_id: z.string() })
      ])
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table'),
      table: z.object({
        table_width: z.number().int(),
        has_column_header: z.boolean().optional(),
        has_row_header: z.boolean().optional(),
        children: z.array(
          // TODO: Support recursive types for `BlockObjectRequestSchema`.
          z.any()
        )
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_row'),
      table_row: z.object({
        cells: z.array(z.array(RichTextItemRequestSchema))
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('synced_block'),
      synced_block: z.object({
        synced_from: z
          .union([
            z.object({ type: z.literal('block_id'), block_id: z.string() }),
            z.null()
          ])
          .optional(),
        children: z
          .array(
            // TODO: Support recursive types for `BlockObjectRequestSchema`.
            z.any()
          )
          .optional()
      })
    })
  ])
  export type BlockObjectRequest = z.infer<typeof BlockObjectRequestSchema>

  export const MentionRichTextItemResponseSchema = z.object({
    type: z.literal('mention'),
    mention: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          PartialUserObjectResponseSchema,
          UserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('date'), date: DateResponseSchema }),
      z.object({
        type: z.literal('link_preview'),
        link_preview: z.object({ url: z.string() })
      }),
      z.object({ type: z.literal('page'), page: z.object({ id: z.string() }) }),
      z.object({
        type: z.literal('database'),
        database: z.object({ id: z.string() })
      })
    ]),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type MentionRichTextItemResponse = z.infer<
    typeof MentionRichTextItemResponseSchema
  >

  export const CreateCommentParametersSchema = z.union([
    z.object({
      parent: z.object({
        page_id: z.string(),
        type: z.literal('page_id').optional()
      }),
      rich_text: z.array(RichTextItemRequestSchema)
    }),
    z.object({
      discussion_id: z.string(),
      rich_text: z.array(RichTextItemRequestSchema)
    })
  ])
  export type CreateCommentParameters = z.infer<
    typeof CreateCommentParametersSchema
  >

  export const AppendBlockChildrenParametersSchema = z.object({
    children: z.array(BlockObjectRequestSchema)
  })
  export type AppendBlockChildrenParameters = z.infer<
    typeof AppendBlockChildrenParametersSchema
  >

  export const UpdateDatabaseParametersSchema = z.object({
    title: z.array(RichTextItemRequestSchema).optional(),
    description: z.array(RichTextItemRequestSchema).optional(),
    icon: z
      .union([
        z.object({ emoji: z.string(), type: z.literal('emoji') }),
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    properties: z.record(PropertyUpdateSchemaSchema).optional(),
    is_inline: z.boolean().optional(),
    archived: z.boolean().optional()
  })
  export type UpdateDatabaseParameters = z.infer<
    typeof UpdateDatabaseParametersSchema
  >

  export const CreateDatabaseParametersSchema = z.object({
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('database_id'), database_id: z.string() })
    ]),
    properties: z.record(PropertySchemaSchema),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    title: z.array(RichTextItemRequestSchema),
    description: z.array(RichTextItemRequestSchema).optional(),
    is_inline: z.boolean().optional()
  })
  export type CreateDatabaseParameters = z.infer<
    typeof CreateDatabaseParametersSchema
  >

  export const RichTextItemResponseSchema = z.union([
    TextRichTextItemResponseSchema,
    MentionRichTextItemResponseSchema,
    EquationRichTextItemResponseSchema
  ])
  export type RichTextItemResponse = z.infer<typeof RichTextItemResponseSchema>

  export const CommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string(),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('block_id'), block_id: z.string() })
    ]),
    discussion_id: z.string(),
    rich_text: z.array(RichTextItemResponseSchema),
    created_by: PartialUserObjectResponseSchema,
    created_time: z.string(),
    last_edited_time: z.string()
  })
  export type CommentObjectResponse = z.infer<
    typeof CommentObjectResponseSchema
  >

  export const PropertyFilterSchema = z.union([
    z.object({ property: z.string(), title: TextPropertyFilterSchema }),
    z.object({ property: z.string(), rich_text: TextPropertyFilterSchema }),
    z.object({ property: z.string(), number: NumberPropertyFilterSchema }),
    z.object({ property: z.string(), checkbox: CheckboxPropertyFilterSchema }),
    z.object({ property: z.string(), select: SelectPropertyFilterSchema }),
    z.object({
      property: z.string(),
      multi_select: MultiSelectPropertyFilterSchema
    }),
    z.object({ property: z.string(), date: DatePropertyFilterSchema }),
    z.object({ property: z.string(), people: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), files: FilesPropertyFilterSchema }),
    z.object({ property: z.string(), url: TextPropertyFilterSchema }),
    z.object({ property: z.string(), email: TextPropertyFilterSchema }),
    z.object({ property: z.string(), phone_number: TextPropertyFilterSchema }),
    z.object({ property: z.string(), relation: RelationPropertyFilterSchema }),
    z.object({ property: z.string(), created_by: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), created_time: DatePropertyFilterSchema }),
    z.object({
      property: z.string(),
      last_edited_by: PeoplePropertyFilterSchema
    }),
    z.object({
      property: z.string(),
      last_edited_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      created_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      last_edited_time: DatePropertyFilterSchema
    })
  ])
  export type PropertyFilter = z.infer<typeof PropertyFilterSchema>

  export const ListCommentsResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(CommentObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListCommentsResponse = z.infer<typeof ListCommentsResponseSchema>

  export const CompoundFilterSchema = z.object({
    and: z.array(PropertyFilterSchema).optional(),
    or: z.array(PropertyFilterSchema).optional()
  })
  export type CompoundFilter = z.infer<typeof CompoundFilterSchema>

  export const QueryDatabaseParametersSchema = z.object({
    sorts: z
      .array(
        z.union([
          z.object({
            property: z.string(),
            direction: z.enum(['ascending', 'descending'])
          }),
          z.object({
            timestamp: z.enum(['created_time', 'last_edited_time']),
            direction: z.enum(['ascending', 'descending'])
          })
        ])
      )
      .optional(),
    filter: z.union([PropertyFilterSchema, CompoundFilterSchema]).optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional(),
    archived: z.boolean().optional()
  })
  export type QueryDatabaseParameters = z.infer<
    typeof QueryDatabaseParametersSchema
  >

  export const DatabasePropertyConfigResponseSchema = z.union([
    TitlePropertyResponseSchema,
    RichTextPropertyResponseSchema,
    NumberPropertyResponseSchema,
    SelectPropertyResponseSchema,
    MultiSelectPropertyResponseSchema,
    DatePropertyResponseSchema,
    PeoplePropertyResponseSchema,
    FilePropertyResponseSchema,
    CheckboxPropertyResponseSchema,
    UrlPropertyResponseSchema,
    EmailPropertyResponseSchema,
    PhoneNumberPropertyResponseSchema,
    FormulaPropertyResponseSchema,
    RelationPropertyResponseSchema,
    RollupPropertyResponseSchema,
    CreatedTimePropertyResponseSchema,
    CreatedByPropertyResponseSchema,
    LastEditedTimePropertyResponseSchema,
    LastEditedByPropertyResponseSchema
  ])
  export type DatabasePropertyConfigResponse = z.infer<
    typeof DatabasePropertyConfigResponseSchema
  >

  export const PartialDatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    properties: z.record(DatabasePropertyConfigResponseSchema)
  })
  export type PartialDatabaseObjectResponse = z.infer<
    typeof PartialDatabaseObjectResponseSchema
  >

  export const DatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    created_time: z.string(),
    created_by: PartialUserObjectResponseSchema,
    last_edited_time: z.string(),
    last_edited_by: PartialUserObjectResponseSchema,
    title: z.array(RichTextItemResponseSchema),
    description: z.array(RichTextItemResponseSchema),
    is_inline: z.boolean(),
    properties: z.record(DatabasePropertyConfigResponseSchema),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    url: z.string(),
    archived: z.boolean()
  })
  export type DatabaseObjectResponse = z.infer<
    typeof DatabaseObjectResponseSchema
  >

  export const ListDatabasesResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListDatabasesResponse = z.infer<
    typeof ListDatabasesResponseSchema
  >

  export const SearchResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PageObjectResponseSchema,
        PartialPageObjectResponseSchema,
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type SearchResponse = z.infer<typeof SearchResponseSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetSelfParamsSchema = z.object({})
  export type GetSelfParams = z.infer<typeof GetSelfParamsSchema>

  export const GetSelfResponseSchema = UserObjectResponseSchema
  export type GetSelfResponse = z.infer<typeof GetSelfResponseSchema>

  export const GetUserParamsSchema = z.object({ user_id: z.string() })
  export type GetUserParams = z.infer<typeof GetUserParamsSchema>

  export const GetUserResponseSchema = UserObjectResponseSchema
  export type GetUserResponse = z.infer<typeof GetUserResponseSchema>

  export const ListUsersParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListUsersParams = z.infer<typeof ListUsersParamsSchema>

  export const CreatePageParamsSchema = CreatePageParametersSchema
  export type CreatePageParams = z.infer<typeof CreatePageParamsSchema>

  export const CreatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type CreatePageResponse = z.infer<typeof CreatePageResponseSchema>

  export const GetPageParamsSchema = z.object({
    page_id: z.string(),
    filter_properties: z.array(z.string()).optional()
  })
  export type GetPageParams = z.infer<typeof GetPageParamsSchema>

  export const GetPageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type GetPageResponse = z.infer<typeof GetPageResponseSchema>

  export const UpdatePageParamsSchema = z
    .object({ page_id: z.string() })
    .merge(UpdatePageParametersSchema)
  export type UpdatePageParams = z.infer<typeof UpdatePageParamsSchema>

  export const UpdatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type UpdatePageResponse = z.infer<typeof UpdatePageResponseSchema>

  export const GetPagePropertyParamsSchema = z.object({
    page_id: z.string(),
    property_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type GetPagePropertyParams = z.infer<
    typeof GetPagePropertyParamsSchema
  >

  export const GetPagePropertyResponseSchema = z.union([
    PropertyItemObjectResponseSchema,
    PropertyItemListResponseSchema
  ])
  export type GetPagePropertyResponse = z.infer<
    typeof GetPagePropertyResponseSchema
  >

  export const GetBlockParamsSchema = z.object({ block_id: z.string() })
  export type GetBlockParams = z.infer<typeof GetBlockParamsSchema>

  export const GetBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type GetBlockResponse = z.infer<typeof GetBlockResponseSchema>

  export const DeleteBlockParamsSchema = z.object({ block_id: z.string() })
  export type DeleteBlockParams = z.infer<typeof DeleteBlockParamsSchema>

  export const DeleteBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type DeleteBlockResponse = z.infer<typeof DeleteBlockResponseSchema>

  export const UpdateBlockParamsSchema = z
    .object({ block_id: z.string() })
    .merge(UpdateBlockParametersSchema)
  export type UpdateBlockParams = z.infer<typeof UpdateBlockParamsSchema>

  export const UpdateBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type UpdateBlockResponse = z.infer<typeof UpdateBlockResponseSchema>

  export const ListBlockChildrenParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListBlockChildrenParams = z.infer<
    typeof ListBlockChildrenParamsSchema
  >

  export const AppendBlockChildrenParamsSchema = z
    .object({ block_id: z.string() })
    .merge(AppendBlockChildrenParametersSchema)
  export type AppendBlockChildrenParams = z.infer<
    typeof AppendBlockChildrenParamsSchema
  >

  export const GetDatabaseParamsSchema = z.object({ database_id: z.string() })
  export type GetDatabaseParams = z.infer<typeof GetDatabaseParamsSchema>

  export const GetDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type GetDatabaseResponse = z.infer<typeof GetDatabaseResponseSchema>

  export const UpdateDatabaseParamsSchema = z
    .object({ database_id: z.string() })
    .merge(UpdateDatabaseParametersSchema)
  export type UpdateDatabaseParams = z.infer<typeof UpdateDatabaseParamsSchema>

  export const UpdateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type UpdateDatabaseResponse = z.infer<
    typeof UpdateDatabaseResponseSchema
  >

  export const QueryDatabaseParamsSchema = z
    .object({
      database_id: z.string(),
      filter_properties: z.array(z.string()).optional()
    })
    .merge(QueryDatabaseParametersSchema)
  export type QueryDatabaseParams = z.infer<typeof QueryDatabaseParamsSchema>

  export const ListDatabasesParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListDatabasesParams = z.infer<typeof ListDatabasesParamsSchema>

  export const CreateDatabaseParamsSchema = CreateDatabaseParametersSchema
  export type CreateDatabaseParams = z.infer<typeof CreateDatabaseParamsSchema>

  export const CreateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type CreateDatabaseResponse = z.infer<
    typeof CreateDatabaseResponseSchema
  >

  export const SearchParamsSchema = SearchParametersSchema
  export type SearchParams = z.infer<typeof SearchParamsSchema>

  export const ListCommentsParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListCommentsParams = z.infer<typeof ListCommentsParamsSchema>

  export const CreateCommentParamsSchema = CreateCommentParametersSchema
  export type CreateCommentParams = z.infer<typeof CreateCommentParamsSchema>

  export const CreateCommentResponseSchema = z.union([
    CommentObjectResponseSchema,
    PartialCommentObjectResponseSchema
  ])
  export type CreateCommentResponse = z.infer<
    typeof CreateCommentResponseSchema
  >

  export const OauthTokenParamsSchema = OauthTokenParametersSchema
  export type OauthTokenParams = z.infer<typeof OauthTokenParamsSchema>
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/open-meteo-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  aiFunction,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { openmeteo } from './open-meteo'

/**
 * Agentic OpenMeteo client.
 *
 * Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.
 */
export class OpenMeteoClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * 7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.
   */
  @aiFunction({
    name: 'open_meteo_get_v1_forecast',
    description: `7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.`,
    inputSchema: openmeteo.GetV1ForecastParamsSchema,
    tags: ['Weather Forecast APIs']
  })
  async getV1Forecast(
    params: openmeteo.GetV1ForecastParams
  ): Promise<openmeteo.GetV1ForecastResponse> {
    return this.ky
      .get('/v1/forecast', {
        searchParams: sanitizeSearchParams(
          pick(
            params,
            'hourly',
            'daily',
            'latitude',
            'longitude',
            'current_weather',
            'temperature_unit',
            'wind_speed_unit',
            'timeformat',
            'timezone',
            'past_days'
          )
        )
      })
      .json<openmeteo.GetV1ForecastResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/open-meteo.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace openmeteo {
  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  /** For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps. */
  export const HourlyResponseSchema = z
    .object({
      time: z.array(z.string()),
      temperature_2m: z.array(z.number()).optional(),
      relative_humidity_2m: z.array(z.number()).optional(),
      dew_point_2m: z.array(z.number()).optional(),
      apparent_temperature: z.array(z.number()).optional(),
      pressure_msl: z.array(z.number()).optional(),
      cloud_cover: z.array(z.number()).optional(),
      cloud_cover_low: z.array(z.number()).optional(),
      cloud_cover_mid: z.array(z.number()).optional(),
      cloud_cover_high: z.array(z.number()).optional(),
      wind_speed_10m: z.array(z.number()).optional(),
      wind_speed_80m: z.array(z.number()).optional(),
      wind_speed_120m: z.array(z.number()).optional(),
      wind_speed_180m: z.array(z.number()).optional(),
      wind_direction_10m: z.array(z.number()).optional(),
      wind_direction_80m: z.array(z.number()).optional(),
      wind_direction_120m: z.array(z.number()).optional(),
      wind_direction_180m: z.array(z.number()).optional(),
      wind_gusts_10m: z.array(z.number()).optional(),
      shortwave_radiation: z.array(z.number()).optional(),
      direct_radiation: z.array(z.number()).optional(),
      direct_normal_irradiance: z.array(z.number()).optional(),
      diffuse_radiation: z.array(z.number()).optional(),
      vapour_pressure_deficit: z.array(z.number()).optional(),
      evapotranspiration: z.array(z.number()).optional(),
      precipitation: z.array(z.number()).optional(),
      weather_code: z.array(z.number()).optional(),
      snow_height: z.array(z.number()).optional(),
      freezing_level_height: z.array(z.number()).optional(),
      soil_temperature_0cm: z.array(z.number()).optional(),
      soil_temperature_6cm: z.array(z.number()).optional(),
      soil_temperature_18cm: z.array(z.number()).optional(),
      soil_temperature_54cm: z.array(z.number()).optional(),
      soil_moisture_0_1cm: z.array(z.number()).optional(),
      soil_moisture_1_3cm: z.array(z.number()).optional(),
      soil_moisture_3_9cm: z.array(z.number()).optional(),
      soil_moisture_9_27cm: z.array(z.number()).optional(),
      soil_moisture_27_81cm: z.array(z.number()).optional()
    })
    .describe(
      'For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.'
    )
  export type HourlyResponse = z.infer<typeof HourlyResponseSchema>

  /** For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps. */
  export const DailyResponseSchema = z
    .object({
      time: z.array(z.string()),
      temperature_2m_max: z.array(z.number()).optional(),
      temperature_2m_min: z.array(z.number()).optional(),
      apparent_temperature_max: z.array(z.number()).optional(),
      apparent_temperature_min: z.array(z.number()).optional(),
      precipitation_sum: z.array(z.number()).optional(),
      precipitation_hours: z.array(z.number()).optional(),
      weather_code: z.array(z.number()).optional(),
      sunrise: z.array(z.number()).optional(),
      sunset: z.array(z.number()).optional(),
      wind_speed_10m_max: z.array(z.number()).optional(),
      wind_gusts_10m_max: z.array(z.number()).optional(),
      wind_direction_10m_dominant: z.array(z.number()).optional(),
      shortwave_radiation_sum: z.array(z.number()).optional(),
      uv_index_max: z.array(z.number()).optional(),
      uv_index_clear_sky_max: z.array(z.number()).optional(),
      et0_fao_evapotranspiration: z.array(z.number()).optional()
    })
    .describe(
      'For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.'
    )
  export type DailyResponse = z.infer<typeof DailyResponseSchema>

  /** Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code */
  export const CurrentWeatherSchema = z
    .object({
      time: z.string(),
      temperature: z.number(),
      wind_speed: z.number(),
      wind_direction: z.number(),
      weather_code: z.number().int()
    })
    .describe(
      'Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code'
    )
  export type CurrentWeather = z.infer<typeof CurrentWeatherSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetV1ForecastParamsSchema = z.object({
    hourly: z
      .array(
        z.enum([
          'temperature_2m',
          'relative_humidity_2m',
          'dew_point_2m',
          'apparent_temperature',
          'pressure_msl',
          'cloud_cover',
          'cloud_cover_low',
          'cloud_cover_mid',
          'cloud_cover_high',
          'wind_speed_10m',
          'wind_speed_80m',
          'wind_speed_120m',
          'wind_speed_180m',
          'wind_direction_10m',
          'wind_direction_80m',
          'wind_direction_120m',
          'wind_direction_180m',
          'wind_gusts_10m',
          'shortwave_radiation',
          'direct_radiation',
          'direct_normal_irradiance',
          'diffuse_radiation',
          'vapour_pressure_deficit',
          'evapotranspiration',
          'precipitation',
          'weather_code',
          'snow_height',
          'freezing_level_height',
          'soil_temperature_0cm',
          'soil_temperature_6cm',
          'soil_temperature_18cm',
          'soil_temperature_54cm',
          'soil_moisture_0_1cm',
          'soil_moisture_1_3cm',
          'soil_moisture_3_9cm',
          'soil_moisture_9_27cm',
          'soil_moisture_27_81cm'
        ])
      )
      .optional(),
    daily: z
      .array(
        z.enum([
          'temperature_2m_max',
          'temperature_2m_min',
          'apparent_temperature_max',
          'apparent_temperature_min',
          'precipitation_sum',
          'precipitation_hours',
          'weather_code',
          'sunrise',
          'sunset',
          'wind_speed_10m_max',
          'wind_gusts_10m_max',
          'wind_direction_10m_dominant',
          'shortwave_radiation_sum',
          'uv_index_max',
          'uv_index_clear_sky_max',
          'et0_fao_evapotranspiration'
        ])
      )
      .optional(),
    /** WGS84 coordinate */
    latitude: z.number().describe('WGS84 coordinate'),
    /** WGS84 coordinate */
    longitude: z.number().describe('WGS84 coordinate'),
    current_weather: z.boolean().optional(),
    temperature_unit: z.enum(['celsius', 'fahrenheit']).default('celsius'),
    wind_speed_unit: z.enum(['kmh', 'ms', 'mph', 'kn']).default('kmh'),
    /** If format `unixtime` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply `utc_offset_seconds` again to get the correct date. */
    timeformat: z
      .enum(['iso8601', 'unixtime'])
      .describe(
        'If format `unixtime` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply `utc_offset_seconds` again to get the correct date.'
      )
      .default('iso8601'),
    /** If `timezone` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported. */
    timezone: z
      .string()
      .describe(
        'If `timezone` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.'
      )
      .optional(),
    /** If `past_days` is set, yesterdays or the day before yesterdays data are also returned. */
    past_days: z
      .union([z.literal(1), z.literal(2)])
      .describe(
        'If `past_days` is set, yesterdays or the day before yesterdays data are also returned.'
      )
      .optional()
  })
  export type GetV1ForecastParams = z.infer<typeof GetV1ForecastParamsSchema>

  export const GetV1ForecastResponseSchema = z.object({
    /** WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away. */
    latitude: z
      .number()
      .describe(
        'WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.'
      )
      .optional(),
    /** WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away. */
    longitude: z
      .number()
      .describe(
        'WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.'
      )
      .optional(),
    /** The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect. */
    elevation: z
      .number()
      .describe(
        'The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.'
      )
      .optional(),
    /** Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements. */
    generationtime_ms: z
      .number()
      .describe(
        'Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.'
      )
      .optional(),
    /** Applied timezone offset from the &timezone= parameter. */
    utc_offset_seconds: z
      .number()
      .int()
      .describe('Applied timezone offset from the &timezone= parameter.')
      .optional(),
    hourly: HourlyResponseSchema.optional(),
    /** For each selected weather variable, the unit will be listed here. */
    hourly_units: z
      .record(z.string())
      .describe(
        'For each selected weather variable, the unit will be listed here.'
      )
      .optional(),
    daily: DailyResponseSchema.optional(),
    /** For each selected daily weather variable, the unit will be listed here. */
    daily_units: z
      .record(z.string())
      .describe(
        'For each selected daily weather variable, the unit will be listed here.'
      )
      .optional(),
    current_weather: CurrentWeatherSchema.optional()
  })
  export type GetV1ForecastResponse = z.infer<
    typeof GetV1ForecastResponseSchema
  >
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/pet-store-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  aiFunction,
  AIFunctionsProvider,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { petstore } from './pet-store'

/**
 * Agentic PetStore client.
 */
export class PetStoreClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = petstore.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * List all pets.
   */
  @aiFunction({
    name: 'pet_store_list_pets',
    description: `List all pets.`,
    inputSchema: petstore.ListPetsParamsSchema,
    tags: ['pets']
  })
  async listPets(
    params: petstore.ListPetsParams
  ): Promise<petstore.ListPetsResponse> {
    return this.ky
      .get('/pets', {
        searchParams: sanitizeSearchParams(params)
      })
      .json<petstore.ListPetsResponse>()
  }

  /**
   * Create a pet.
   */
  @aiFunction({
    name: 'pet_store_create_pets',
    description: `Create a pet.`,
    inputSchema: petstore.CreatePetsParamsSchema,
    tags: ['pets']
  })
  async createPets(
    params: petstore.CreatePetsParams
  ): Promise<petstore.CreatePetsResponse> {
    return this.ky
      .post('/pets', {
        json: pick(params, 'id', 'name', 'tag')
      })
      .json<petstore.CreatePetsResponse>()
  }

  /**
   * Info for a specific pet.
   */
  @aiFunction({
    name: 'pet_store_show_pet_by_id',
    description: `Info for a specific pet.`,
    inputSchema: petstore.ShowPetByIdParamsSchema,
    tags: ['pets']
  })
  async showPetById(
    params: petstore.ShowPetByIdParams
  ): Promise<petstore.ShowPetByIdResponse> {
    return this.ky
      .get(`/pets/${params.petId}`)
      .json<petstore.ShowPetByIdResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/pet-store.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace petstore {
  export const apiBaseUrl = 'http://petstore.swagger.io/v1'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const PetSchema = z.object({
    id: z.number().int(),
    name: z.string(),
    tag: z.string().optional()
  })
  export type Pet = z.infer<typeof PetSchema>

  export const PetsSchema = z.array(PetSchema).max(100)
  export type Pets = z.infer<typeof PetsSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const ListPetsParamsSchema = z.object({
    /** How many items to return at one time (max 100) */
    limit: z
      .number()
      .int()
      .lte(100)
      .describe('How many items to return at one time (max 100)')
      .optional()
  })
  export type ListPetsParams = z.infer<typeof ListPetsParamsSchema>

  export const ListPetsResponseSchema = PetsSchema
  export type ListPetsResponse = z.infer<typeof ListPetsResponseSchema>

  export const CreatePetsParamsSchema = PetSchema
  export type CreatePetsParams = z.infer<typeof CreatePetsParamsSchema>

  export type CreatePetsResponse = undefined

  export const ShowPetByIdParamsSchema = z.object({
    /** The id of the pet to retrieve */
    petId: z.string().describe('The id of the pet to retrieve')
  })
  export type ShowPetByIdParams = z.infer<typeof ShowPetByIdParamsSchema>

  export const ShowPetByIdResponseSchema = PetSchema
  export type ShowPetByIdResponse = z.infer<typeof ShowPetByIdResponseSchema>
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/petstore-expanded-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  aiFunction,
  AIFunctionsProvider,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { petstoreexpanded } from './petstore-expanded'

/**
 * Agentic PetstoreExpanded client.
 *
 * A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification.
 */
export class PetstoreExpandedClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = petstoreexpanded.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
 * Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
 */
  @aiFunction({
    name: 'petstore_expanded_find_pets',
    description: `Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.`,
    inputSchema: petstoreexpanded.FindPetsParamsSchema
  })
  async findPets(
    params: petstoreexpanded.FindPetsParams
  ): Promise<petstoreexpanded.FindPetsResponse> {
    return this.ky
      .get('/pets', {
        searchParams: sanitizeSearchParams(pick(params, 'tags', 'limit'))
      })
      .json<petstoreexpanded.FindPetsResponse>()
  }

  /**
   * Creates a new pet in the store. Duplicates are allowed.
   */
  @aiFunction({
    name: 'petstore_expanded_add_pet',
    description: `Creates a new pet in the store. Duplicates are allowed.`,
    inputSchema: petstoreexpanded.AddPetParamsSchema
  })
  async addPet(
    params: petstoreexpanded.AddPetParams
  ): Promise<petstoreexpanded.AddPetResponse> {
    return this.ky
      .post('/pets', {
        json: pick(params, 'name', 'tag')
      })
      .json<petstoreexpanded.AddPetResponse>()
  }

  /**
   * Returns a user based on a single ID, if the user does not have access to the pet.
   */
  @aiFunction({
    name: 'petstore_expanded_find_pet_by_id',
    description: `Returns a user based on a single ID, if the user does not have access to the pet.`,
    inputSchema: petstoreexpanded.FindPetByIdParamsSchema
  })
  async findPetById(
    params: petstoreexpanded.FindPetByIdParams
  ): Promise<petstoreexpanded.FindPetByIdResponse> {
    return this.ky
      .get(`/pets/${params.id}`)
      .json<petstoreexpanded.FindPetByIdResponse>()
  }

  /**
   * deletes a single pet based on the ID supplied.
   */
  @aiFunction({
    name: 'petstore_expanded_delete_pet',
    description: `deletes a single pet based on the ID supplied.`,
    inputSchema: petstoreexpanded.DeletePetParamsSchema
  })
  async deletePet(
    params: petstoreexpanded.DeletePetParams
  ): Promise<petstoreexpanded.DeletePetResponse> {
    return this.ky
      .delete(`/pets/${params.id}`)
      .json<petstoreexpanded.DeletePetResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/petstore-expanded.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace petstoreexpanded {
  export const apiBaseUrl = 'http://petstore.swagger.io/api'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const NewPetSchema = z.object({
    name: z.string(),
    tag: z.string().optional()
  })
  export type NewPet = z.infer<typeof NewPetSchema>

  export const PetSchema = z.intersection(
    NewPetSchema,
    z.object({ id: z.number().int() })
  )
  export type Pet = z.infer<typeof PetSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const FindPetsParamsSchema = z.object({
    /** tags to filter by */
    tags: z.array(z.string()).describe('tags to filter by').optional(),
    /** maximum number of results to return */
    limit: z
      .number()
      .int()
      .describe('maximum number of results to return')
      .optional()
  })
  export type FindPetsParams = z.infer<typeof FindPetsParamsSchema>

  export const FindPetsResponseSchema = z.array(PetSchema)
  export type FindPetsResponse = z.infer<typeof FindPetsResponseSchema>

  export const AddPetParamsSchema = NewPetSchema
  export type AddPetParams = z.infer<typeof AddPetParamsSchema>

  export const AddPetResponseSchema = PetSchema
  export type AddPetResponse = z.infer<typeof AddPetResponseSchema>

  export const FindPetByIdParamsSchema = z.object({
    /** ID of pet to fetch */
    id: z.number().int().describe('ID of pet to fetch')
  })
  export type FindPetByIdParams = z.infer<typeof FindPetByIdParamsSchema>

  export const FindPetByIdResponseSchema = PetSchema
  export type FindPetByIdResponse = z.infer<typeof FindPetByIdResponseSchema>

  export const DeletePetParamsSchema = z.object({
    /** ID of pet to delete */
    id: z.number().int().describe('ID of pet to delete')
  })
  export type DeletePetParams = z.infer<typeof DeletePetParamsSchema>

  export type DeletePetResponse = undefined
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/security-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { aiFunction,AIFunctionsProvider } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

import { security } from './security'

/**
 * Agentic Security client.
 *
 * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject.
 */
export class SecurityClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = security.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * `apiKey` auth will be supplied within an `apiKey` query parameter.
   */
  @aiFunction({
    name: 'security_get_anything_api_key',
    description: `\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.`,
    inputSchema: security.GetAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async getAnythingApiKey(
    _params: security.GetAnythingApiKeyParams
  ): Promise<security.GetAnythingApiKeyResponse> {
    return this.ky
      .get('/anything/apiKey')
      .json<security.GetAnythingApiKeyResponse>()
  }

  /**
   * `apiKey` auth will be supplied within an `api_key` cookie.
   */
  @aiFunction({
    name: 'security_post_anything_api_key',
    description: `\`apiKey\` auth will be supplied within an \`api_key\` cookie.`,
    inputSchema: security.PostAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async postAnythingApiKey(
    _params: security.PostAnythingApiKeyParams
  ): Promise<security.PostAnythingApiKeyResponse> {
    return this.ky
      .post('/anything/apiKey')
      .json<security.PostAnythingApiKeyResponse>()
  }

  /**
   * `apiKey` auth will be supplied within an `X-API-KEY` header.
   */
  @aiFunction({
    name: 'security_put_anything_api_key',
    description: `\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.`,
    inputSchema: security.PutAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async putAnythingApiKey(
    _params: security.PutAnythingApiKeyParams
  ): Promise<security.PutAnythingApiKeyResponse> {
    return this.ky
      .put('/anything/apiKey')
      .json<security.PutAnythingApiKeyResponse>()
  }

  /**
 * Authentication credentials will be supplied within a `Basic` `Authorization` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.
 */
  @aiFunction({
    name: 'security_post_anything_basic',
    description: `Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.`,
    inputSchema: security.PostAnythingBasicParamsSchema,
    tags: ['HTTP']
  })
  async postAnythingBasic(
    _params: security.PostAnythingBasicParams
  ): Promise<security.PostAnythingBasicResponse> {
    return this.ky
      .post('/anything/basic')
      .json<security.PostAnythingBasicResponse>()
  }

  /**
 * Authentication credentials will be supplied within a `Bearer` `Authorization` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.
 */
  @aiFunction({
    name: 'security_post_anything_bearer',
    description: `Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.`,
    inputSchema: security.PostAnythingBearerParamsSchema,
    tags: ['HTTP']
  })
  async postAnythingBearer(
    _params: security.PostAnythingBearerParams
  ): Promise<security.PostAnythingBearerResponse> {
    return this.ky
      .post('/anything/bearer')
      .json<security.PostAnythingBearerResponse>()
  }

  /**
 * Authentication credentials will be supplied within a `Bearer` `Authorization` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard `Bearer` authentication token.
 */
  @aiFunction({
    name: 'security_put_anything_bearer',
    description: `Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.`,
    inputSchema: security.PutAnythingBearerParamsSchema,
    tags: ['HTTP']
  })
  async putAnythingBearer(
    _params: security.PutAnythingBearerParams
  ): Promise<security.PutAnythingBearerResponse> {
    return this.ky
      .put('/anything/bearer')
      .json<security.PutAnythingBearerResponse>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_get_anything_oauth2',
    description: `> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`,
    inputSchema: security.GetAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async getAnythingOauth2(
    _params: security.GetAnythingOauth2Params
  ): Promise<security.GetAnythingOauth2Response> {
    return this.ky
      .get('/anything/oauth2')
      .json<security.GetAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_post_anything_oauth2',
    description: `> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`,
    inputSchema: security.PostAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async postAnythingOauth2(
    _params: security.PostAnythingOauth2Params
  ): Promise<security.PostAnythingOauth2Response> {
    return this.ky
      .post('/anything/oauth2')
      .json<security.PostAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_put_anything_oauth2',
    description: `> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`,
    inputSchema: security.PutAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async putAnythingOauth2(
    _params: security.PutAnythingOauth2Params
  ): Promise<security.PutAnythingOauth2Response> {
    return this.ky
      .put('/anything/oauth2')
      .json<security.PutAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_delete_anything_oauth2',
    description: `> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`,
    inputSchema: security.DeleteAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async deleteAnythingOauth2(
    _params: security.DeleteAnythingOauth2Params
  ): Promise<security.DeleteAnythingOauth2Response> {
    return this.ky
      .delete('/anything/oauth2')
      .json<security.DeleteAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_patch_anything_oauth2',
    description: `> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`,
    inputSchema: security.PatchAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async patchAnythingOauth2(
    _params: security.PatchAnythingOauth2Params
  ): Promise<security.PatchAnythingOauth2Response> {
    return this.ky
      .patch('/anything/oauth2')
      .json<security.PatchAnythingOauth2Response>()
  }

  /**
   * 🚧 This is not supported.
   */
  @aiFunction({
    name: 'security_post_anything_open_id_connect',
    description: `🚧 This is not supported.`,
    inputSchema: security.PostAnythingOpenIdConnectParamsSchema,
    tags: ['OpenID Connect']
  })
  async postAnythingOpenIdConnect(
    _params: security.PostAnythingOpenIdConnectParams
  ): Promise<security.PostAnythingOpenIdConnectResponse> {
    return this.ky
      .post('/anything/openIdConnect')
      .json<security.PostAnythingOpenIdConnectResponse>()
  }

  /**
   * This operation does not have any authentication requirements.
   */
  @aiFunction({
    name: 'security_post_anything_no_auth',
    description: `This operation does not have any authentication requirements.`,
    inputSchema: security.PostAnythingNoAuthParamsSchema,
    tags: ['Other']
  })
  async postAnythingNoAuth(
    _params: security.PostAnythingNoAuthParams
  ): Promise<security.PostAnythingNoAuthResponse> {
    return this.ky
      .post('/anything/no-auth')
      .json<security.PostAnythingNoAuthResponse>()
  }

  /**
 * The `apiKey` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.
 */
  @aiFunction({
    name: 'security_get_anything_optional_auth',
    description: `The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.`,
    inputSchema: security.GetAnythingOptionalAuthParamsSchema,
    tags: ['Other']
  })
  async getAnythingOptionalAuth(
    _params: security.GetAnythingOptionalAuthParams
  ): Promise<security.GetAnythingOptionalAuthResponse> {
    return this.ky
      .get('/anything/optional-auth')
      .json<security.GetAnythingOptionalAuthResponse>()
  }

  /**
   * This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.
   */
  @aiFunction({
    name: 'security_post_status401',
    description: `This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.`,
    inputSchema: security.PostStatus401ParamsSchema,
    tags: ['Other']
  })
  async postStatus401(
    _params: security.PostStatus401Params
  ): Promise<security.PostStatus401Response> {
    return this.ky.post('/status/401').json<security.PostStatus401Response>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/security.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace security {
  export const apiBaseUrl = 'https://httpbin.org'

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetAnythingApiKeyParamsSchema = z.object({})
  export type GetAnythingApiKeyParams = z.infer<
    typeof GetAnythingApiKeyParamsSchema
  >

  export type GetAnythingApiKeyResponse = undefined

  export const PostAnythingApiKeyParamsSchema = z.object({})
  export type PostAnythingApiKeyParams = z.infer<
    typeof PostAnythingApiKeyParamsSchema
  >

  export type PostAnythingApiKeyResponse = undefined

  export const PutAnythingApiKeyParamsSchema = z.object({})
  export type PutAnythingApiKeyParams = z.infer<
    typeof PutAnythingApiKeyParamsSchema
  >

  export type PutAnythingApiKeyResponse = undefined

  export const PostAnythingBasicParamsSchema = z.object({})
  export type PostAnythingBasicParams = z.infer<
    typeof PostAnythingBasicParamsSchema
  >

  export type PostAnythingBasicResponse = undefined

  export const PostAnythingBearerParamsSchema = z.object({})
  export type PostAnythingBearerParams = z.infer<
    typeof PostAnythingBearerParamsSchema
  >

  export type PostAnythingBearerResponse = undefined

  export const PutAnythingBearerParamsSchema = z.object({})
  export type PutAnythingBearerParams = z.infer<
    typeof PutAnythingBearerParamsSchema
  >

  export type PutAnythingBearerResponse = undefined

  export const GetAnythingOauth2ParamsSchema = z.object({})
  export type GetAnythingOauth2Params = z.infer<
    typeof GetAnythingOauth2ParamsSchema
  >

  export type GetAnythingOauth2Response = undefined

  export const PostAnythingOauth2ParamsSchema = z.object({})
  export type PostAnythingOauth2Params = z.infer<
    typeof PostAnythingOauth2ParamsSchema
  >

  export type PostAnythingOauth2Response = undefined

  export const PutAnythingOauth2ParamsSchema = z.object({})
  export type PutAnythingOauth2Params = z.infer<
    typeof PutAnythingOauth2ParamsSchema
  >

  export type PutAnythingOauth2Response = undefined

  export const DeleteAnythingOauth2ParamsSchema = z.object({})
  export type DeleteAnythingOauth2Params = z.infer<
    typeof DeleteAnythingOauth2ParamsSchema
  >

  export type DeleteAnythingOauth2Response = undefined

  export const PatchAnythingOauth2ParamsSchema = z.object({})
  export type PatchAnythingOauth2Params = z.infer<
    typeof PatchAnythingOauth2ParamsSchema
  >

  export type PatchAnythingOauth2Response = undefined

  export const PostAnythingOpenIdConnectParamsSchema = z.object({})
  export type PostAnythingOpenIdConnectParams = z.infer<
    typeof PostAnythingOpenIdConnectParamsSchema
  >

  export type PostAnythingOpenIdConnectResponse = undefined

  export const PostAnythingNoAuthParamsSchema = z.object({})
  export type PostAnythingNoAuthParams = z.infer<
    typeof PostAnythingNoAuthParamsSchema
  >

  export type PostAnythingNoAuthResponse = undefined

  export const GetAnythingOptionalAuthParamsSchema = z.object({})
  export type GetAnythingOptionalAuthParams = z.infer<
    typeof GetAnythingOptionalAuthParamsSchema
  >

  export type GetAnythingOptionalAuthResponse = undefined

  export const PostStatus401ParamsSchema = z.object({})
  export type PostStatus401Params = z.infer<typeof PostStatus401ParamsSchema>

  export type PostStatus401Response = undefined
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/tic-tac-toe-client.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { AIFunctionsProvider, aiFunction } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { tictactoe } from './tic-tac-toe'

/**
 * Agentic TicTacToe client.
 *
 * This API allows writing down marks on a Tic Tac Toe board
and requesting the state of the board or of individual squares.
.
 */
export class TicTacToeClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * Retrieves the current state of the board and the winner.
   */
  @aiFunction({
    name: 'tic_tac_toe_get_board',
    description: `Retrieves the current state of the board and the winner.`,
    inputSchema: tictactoe.GetBoardParamsSchema,
    tags: ['Gameplay']
  })
  async getBoard(
    _params: tictactoe.GetBoardParams
  ): Promise<tictactoe.GetBoardResponse> {
    return this.ky.get('/board').json<tictactoe.GetBoardResponse>()
  }

  /**
   * Retrieves the requested square.
   */
  @aiFunction({
    name: 'tic_tac_toe_get_square',
    description: `Retrieves the requested square.`,
    inputSchema: tictactoe.GetSquareParamsSchema,
    tags: ['Gameplay']
  })
  async getSquare(
    _params: tictactoe.GetSquareParams
  ): Promise<tictactoe.GetSquareResponse> {
    return this.ky
      .get('/board/{row}/{column}')
      .json<tictactoe.GetSquareResponse>()
  }

  /**
   * Places a mark on the board and retrieves the whole board and the winner (if any).
   */
  @aiFunction({
    name: 'tic_tac_toe_put_square',
    description: `Places a mark on the board and retrieves the whole board and the winner (if any).`,
    inputSchema: tictactoe.PutSquareParamsSchema,
    tags: ['Gameplay']
  })
  async putSquare(
    _params: tictactoe.PutSquareParams
  ): Promise<tictactoe.PutSquareResponse> {
    return this.ky
      .put('/board/{row}/{column}')
      .json<tictactoe.PutSquareResponse>()
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/generated/tic-tac-toe.ts
================================================
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace tictactoe {
  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  /** Winner of the game. `.` means nobody has won yet. */
  export const WinnerSchema = z
    .enum(['.', 'X', 'O'])
    .describe('Winner of the game. `.` means nobody has won yet.')
  export type Winner = z.infer<typeof WinnerSchema>

  /** Possible values for a board square. `.` means empty square. */
  export const MarkSchema = z
    .enum(['.', 'X', 'O'])
    .describe('Possible values for a board square. `.` means empty square.')
  export type Mark = z.infer<typeof MarkSchema>

  export const BoardSchema = z
    .array(z.array(MarkSchema).min(3).max(3))
    .min(3)
    .max(3)
  export type Board = z.infer<typeof BoardSchema>

  export const StatusSchema = z.object({
    winner: WinnerSchema.optional(),
    board: BoardSchema.optional()
  })
  export type Status = z.infer<typeof StatusSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetBoardParamsSchema = z.object({})
  export type GetBoardParams = z.infer<typeof GetBoardParamsSchema>

  export const GetBoardResponseSchema = StatusSchema
  export type GetBoardResponse = z.infer<typeof GetBoardResponseSchema>

  export const GetSquareParamsSchema = z.object({})
  export type GetSquareParams = z.infer<typeof GetSquareParamsSchema>

  export const GetSquareResponseSchema = MarkSchema
  export type GetSquareResponse = z.infer<typeof GetSquareResponseSchema>

  export const PutSquareParamsSchema = MarkSchema
  export type PutSquareParams = z.infer<typeof PutSquareParamsSchema>

  export const PutSquareResponseSchema = StatusSchema
  export type PutSquareResponse = z.infer<typeof PutSquareResponseSchema>
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/firecrawl.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "title": "Firecrawl API",
    "version": "1.0.0",
    "description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
    "contact": {
      "name": "Firecrawl Support",
      "url": "https://firecrawl.dev/support",
      "email": "support@firecrawl.dev"
    }
  },
  "servers": [
    {
      "url": "https://api.firecrawl.dev/v0"
    }
  ],
  "paths": {
    "/scrape": {
      "post": {
        "summary": "Scrape a single URL",
        "operationId": "scrape",
        "tags": ["Scraping"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URL to scrape"
                  },
                  "formats": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "markdown",
                        "html",
                        "rawHtml",
                        "links",
                        "screenshot",
                        "screenshot@fullPage"
                      ]
                    },
                    "description": "Specific formats to return.\n\n - markdown: The page in Markdown format.\n - html: The page's HTML, trimmed to include only meaningful content.\n - rawHtml: The page's original HTML.\n - links: The links on the page.\n - screenshot: A screenshot of the top of the page.\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
                    "default": ["markdown"]
                  },
                  "headers": {
                    "type": "object",
                    "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
                  },
                  "includeTags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
                  },
                  "excludeTags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
                  },
                  "onlyMainContent": {
                    "type": "boolean",
                    "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                    "default": true
                  },
                  "timeout": {
                    "type": "integer",
                    "description": "Timeout in milliseconds for the request",
                    "default": 30000
                  },
                  "waitFor": {
                    "type": "integer",
                    "description": "Wait x amount of milliseconds for the page to load to fetch content",
                    "default": 0
                  }
                },
                "required": ["url"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScrapeResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl": {
      "post": {
        "summary": "Crawl multiple URLs based on options",
        "operationId": "crawlUrls",
        "tags": ["Crawling"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "The base URL to start crawling from"
                  },
                  "crawlerOptions": {
                    "type": "object",
                    "properties": {
                      "includes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "URL patterns to include"
                      },
                      "excludes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "URL patterns to exclude"
                      },
                      "generateImgAltText": {
                        "type": "boolean",
                        "description": "Generate alt text for images using LLMs (must have a paid plan)",
                        "default": false
                      },
                      "returnOnlyUrls": {
                        "type": "boolean",
                        "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                        "default": false
                      },
                      "maxDepth": {
                        "type": "integer",
                        "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern."
                      },
                      "mode": {
                        "type": "string",
                        "enum": ["default", "fast"],
                        "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                        "default": "default"
                      },
                      "ignoreSitemap": {
                        "type": "boolean",
                        "description": "Ignore the website sitemap when crawling",
                        "default": false
                      },
                      "limit": {
                        "type": "integer",
                        "description": "Maximum number of pages to crawl",
                        "default": 10000
                      },
                      "allowBackwardCrawling": {
                        "type": "boolean",
                        "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                        "default": false
                      },
                      "allowExternalContentLinks": {
                        "type": "boolean",
                        "description": "Allows the crawler to follow links to external websites.",
                        "default": false
                      }
                    }
                  },
                  "pageOptions": {
                    "type": "object",
                    "properties": {
                      "headers": {
                        "type": "object",
                        "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
                      },
                      "includeHtml": {
                        "type": "boolean",
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "default": false
                      },
                      "includeRawHtml": {
                        "type": "boolean",
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "default": false
                      },
                      "onlyIncludeTags": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
                      },
                      "onlyMainContent": {
                        "type": "boolean",
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "default": false
                      },
                      "removeTags": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
                      },
                      "replaceAllPathsWithAbsolutePaths": {
                        "type": "boolean",
                        "description": "Replace all relative paths with absolute paths for images and links",
                        "default": false
                      },
                      "screenshot": {
                        "type": "boolean",
                        "description": "Include a screenshot of the top of the page that you are scraping.",
                        "default": false
                      },
                      "fullPageScreenshot": {
                        "type": "boolean",
                        "description": "Include a full page screenshot of the page that you are scraping.",
                        "default": false
                      },
                      "waitFor": {
                        "type": "integer",
                        "description": "Wait x amount of milliseconds for the page to load to fetch content",
                        "default": 0
                      }
                    }
                  }
                },
                "required": ["url"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrawlResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/search": {
      "post": {
        "summary": "Search for a keyword in Google, returns top page results with markdown content for each page",
        "operationId": "searchGoogle",
        "tags": ["Search"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string",
                    "format": "uri",
                    "description": "The query to search for"
                  },
                  "pageOptions": {
                    "type": "object",
                    "properties": {
                      "onlyMainContent": {
                        "type": "boolean",
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "default": false
                      },
                      "fetchPageContent": {
                        "type": "boolean",
                        "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                        "default": true
                      },
                      "includeHtml": {
                        "type": "boolean",
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "default": false
                      },
                      "includeRawHtml": {
                        "type": "boolean",
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "default": false
                      }
                    }
                  },
                  "searchOptions": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer",
                        "description": "Maximum number of results. Max is 20 during beta."
                      }
                    }
                  }
                },
                "required": ["query"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl/status/{jobId}": {
      "get": {
        "tags": ["Crawl"],
        "summary": "Get the status of a crawl job",
        "operationId": "getCrawlStatus",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "description": "ID of the crawl job",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Status of the job (completed, active, failed, paused)"
                    },
                    "current": {
                      "type": "integer",
                      "description": "Current page number"
                    },
                    "total": {
                      "type": "integer",
                      "description": "Total number of pages"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                      },
                      "description": "Data returned from the job (null when it is in progress)"
                    },
                    "partial_data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                      },
                      "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in `data`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array."
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl/cancel/{jobId}": {
      "delete": {
        "tags": ["Crawl"],
        "summary": "Cancel a crawl job",
        "operationId": "cancelCrawlJob",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "description": "ID of the crawl job",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Returns cancelled."
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "ScrapeResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "warning": {
            "type": "string",
            "nullable": true,
            "description": "Warning message to let you know of any issues."
          },
          "data": {
            "type": "object",
            "properties": {
              "markdown": {
                "type": "string",
                "nullable": true,
                "description": "Markdown content of the page if the `markdown` format was specified (default)"
              },
              "html": {
                "type": "string",
                "nullable": true,
                "description": "HTML version of the content on page if the `html` format was specified"
              },
              "rawHtml": {
                "type": "string",
                "nullable": true,
                "description": "Raw HTML content of the page if the `rawHtml` format was specified"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "uri"
                },
                "nullable": true,
                "description": "Links on the page if the `links` format was specified"
              },
              "screenshot": {
                "type": "string",
                "nullable": true,
                "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
              },
              "metadata": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceURL": {
                    "type": "string",
                    "format": "uri"
                  },
                  "<any other metadata> ": {
                    "type": "string"
                  },
                  "statusCode": {
                    "type": "integer",
                    "description": "The status code of the page"
                  },
                  "error": {
                    "type": "string",
                    "nullable": true,
                    "description": "The error message of the page"
                  }
                }
              }
            }
          }
        }
      },
      "CrawlStatusResponseObj": {
        "type": "object",
        "properties": {
          "markdown": {
            "type": "string",
            "nullable": true,
            "description": "Markdown content of the page if the `markdown` format was specified (default)"
          },
          "html": {
            "type": "string",
            "nullable": true,
            "description": "HTML version of the content on page if the `html` format was specified"
          },
          "rawHtml": {
            "type": "string",
            "nullable": true,
            "description": "Raw HTML content of the page if the `rawHtml` format was specified"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "nullable": true,
            "description": "Links on the page if the `links` format was specified"
          },
          "screenshot": {
            "type": "string",
            "nullable": true,
            "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
          },
          "metadata": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "language": {
                "type": "string",
                "nullable": true
              },
              "sourceURL": {
                "type": "string",
                "format": "uri"
              },
              "<any other metadata> ": {
                "type": "string"
              },
              "statusCode": {
                "type": "integer",
                "description": "The status code of the page"
              },
              "error": {
                "type": "string",
                "nullable": true,
                "description": "The error message of the page"
              }
            }
          }
        }
      },
      "SearchResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "markdown": {
                "type": "string",
                "nullable": true,
                "description": "Markdown content of the page if the `markdown` format was specified (default)"
              },
              "html": {
                "type": "string",
                "nullable": true,
                "description": "HTML version of the content on page if the `html` format was specified"
              },
              "rawHtml": {
                "type": "string",
                "nullable": true,
                "description": "Raw HTML content of the page if the `rawHtml` format was specified"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "uri"
                },
                "nullable": true,
                "description": "Links on the page if the `links` format was specified"
              },
              "screenshot": {
                "type": "string",
                "nullable": true,
                "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
              },
              "metadata": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceURL": {
                    "type": "string",
                    "format": "uri"
                  },
                  "<any other metadata> ": {
                    "type": "string"
                  },
                  "statusCode": {
                    "type": "integer",
                    "description": "The status code of the page"
                  },
                  "error": {
                    "type": "string",
                    "nullable": true,
                    "description": "The error message of the page"
                  }
                }
              }
            }
          }
        }
      },
      "CrawlResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/github.json
================================================
[File too large to display: 10.7 MB]

================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/notion.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "title": "Notion API",
    "version": "1.0.0",
    "description": "API specification for Notion"
  },
  "servers": [{ "url": "https://api.notion.so" }],
  "security": [{ "oauth2": [] }],

  "paths": {
    "/users/me": {
      "get": {
        "summary": "Get current user",
        "operationId": "getSelf",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse"
                }
              }
            }
          }
        }
      }
    },
    "/users/{user_id}": {
      "get": {
        "summary": "Get user",
        "operationId": "getUser",
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse"
                }
              }
            }
          }
        }
      }
    },
    "/users": {
      "get": {
        "summary": "List users",
        "operationId": "listUsers",
        "parameters": [
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListUsersResponse"
                }
              }
            }
          }
        }
      }
    },
    "/pages": {
      "post": {
        "summary": "Create page",
        "operationId": "createPage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePageParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/pages/{page_id}": {
      "get": {
        "summary": "Get page",
        "operationId": "getPage",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter_properties",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update page",
        "operationId": "updatePage",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePageParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/pages/{page_id}/properties/{property_id}": {
      "get": {
        "summary": "Get page property",
        "operationId": "getPageProperty",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "property_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PropertyItemObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PropertyItemListResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/blocks/{block_id}": {
      "get": {
        "summary": "Get block",
        "operationId": "getBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update block",
        "operationId": "updateBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlockParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete block",
        "operationId": "deleteBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/blocks/{block_id}/children": {
      "get": {
        "summary": "List block children",
        "operationId": "listBlockChildren",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBlockChildrenResponse"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Append block children",
        "operationId": "appendBlockChildren",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppendBlockChildrenParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppendBlockChildrenResponse"
                }
              }
            }
          }
        }
      }
    },
    "/databases/{database_id}": {
      "get": {
        "summary": "Get database",
        "operationId": "getDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update database",
        "operationId": "updateDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/databases/{database_id}/query": {
      "post": {
        "summary": "Query database",
        "operationId": "queryDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter_properties",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QueryDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryDatabaseResponse"
                }
              }
            }
          }
        }
      }
    },
    "/databases": {
      "get": {
        "summary": "List databases",
        "operationId": "listDatabases",
        "parameters": [
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListDatabasesResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create database",
        "operationId": "createDatabase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/search": {
      "post": {
        "summary": "Search",
        "operationId": "search",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          }
        }
      }
    },
    "/comments": {
      "post": {
        "summary": "Create comment",
        "operationId": "createComment",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCommentParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CommentObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialCommentObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "get": {
        "summary": "List comments",
        "operationId": "listComments",
        "parameters": [
          {
            "name": "block_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListCommentsResponse"
                }
              }
            }
          }
        }
      }
    },
    "/oauth/token": {
      "post": {
        "summary": "OAuth token",
        "operationId": "oauthToken",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OauthTokenParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OauthTokenResponse"
                }
              }
            }
          }
        }
      }
    }
  },

  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "scopes": {},
            "authorizationUrl": "https://api.notion.com/v1/oauth/authorize",
            "tokenUrl": "https://api.notion.com/v1/oauth/token"
          }
        }
      }
    },
    "schemas": {
      "UserObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["user"]
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["person", "bot"]
          },
          "name": {
            "type": "string"
          },
          "avatar_url": {
            "type": "string"
          }
        },
        "required": ["object", "id", "type", "name", "avatar_url"]
      },
      "ListUsersResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["results", "next_cursor", "has_more"]
      },
      "CreatePageParameters": {
        "type": "object",
        "properties": {
          "parent": {
            "type": "object",
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database_id"]
                  },
                  "database_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "database_id"]
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["title"]
                },
                {
                  "type": "object",
                  "properties": {
                    "rich_text": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["rich_text"]
                },
                {
                  "type": "object",
                  "properties": {
                    "number": {
                      "type": ["number", "null"]
                    }
                  },
                  "required": ["number"]
                },
                {
                  "type": "object",
                  "properties": {
                    "select": {
                      "type": ["object", "null"],
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": ["name"]
                    }
                  },
                  "required": ["select"]
                }
              ]
            }
          }
        },
        "required": ["parent", "properties"]
      },
      "PageObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["page"]
          },
          "id": {
            "type": "string"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "created_time",
          "last_edited_time",
          "archived",
          "url"
        ]
      },
      "PartialPageObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["page"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "UpdatePageParameters": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "additionalProperties": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["title"]
                },
                {
                  "type": "object",
                  "properties": {
                    "rich_text": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["rich_text"]
                },
                {
                  "type": "object",
                  "properties": {
                    "number": {
                      "type": ["number", "null"]
                    }
                  },
                  "required": ["number"]
                },
                {
                  "type": "object",
                  "properties": {
                    "select": {
                      "type": ["object", "null"],
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": ["name"]
                    }
                  },
                  "required": ["select"]
                }
              ]
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "PropertyItemObjectResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["type", "id"]
      },
      "PropertyItemListResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyItemObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["results", "next_cursor", "has_more"]
      },
      "PartialBlockObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["block"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "BlockObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["block"]
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          },
          "has_children": {
            "type": "boolean"
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "id",
          "type",
          "created_time",
          "last_edited_time",
          "has_children",
          "archived"
        ]
      },
      "UpdateBlockParameters": {
        "type": "object",
        "properties": {
          "paragraph": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_1": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_2": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_3": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "bulleted_list_item": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "numbered_list_item": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "quote": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "to_do": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "checked": {
                "type": "boolean"
              },
              "color": {
                "type": "string"
              }
            }
          },
          "toggle": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "code": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "language": {
                "type": "string"
              }
            }
          },
          "embed": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              }
            }
          },
          "image": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "video": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "file": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "pdf": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "bookmark": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              }
            }
          },
          "equation": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            }
          },
          "divider": {
            "type": "object"
          },
          "table_of_contents": {
            "type": "object",
            "properties": {
              "color": {
                "type": "string"
              }
            }
          },
          "breadcrumb": {
            "type": "object"
          },
          "column_list": {
            "type": "object"
          },
          "column": {
            "type": "object"
          },
          "link_to_page": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": ["page_id", "database_id"]
              },
              "page_id": {
                "type": "string"
              },
              "database_id": {
                "type": "string"
              }
            }
          },
          "table_row": {
            "type": "object",
            "properties": {
              "cells": {
                "type": "array",
                "items": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RichTextItemRequest"
                  }
                }
              }
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "ListBlockChildrenResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "AppendBlockChildrenParameters": {
        "type": "object",
        "properties": {
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BlockObjectRequest"
            }
          }
        },
        "required": ["children"]
      },
      "AppendBlockChildrenResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "PartialDatabaseObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["database"]
          },
          "id": {
            "type": "string"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse"
            }
          }
        },
        "required": ["object", "id", "properties"]
      },
      "DatabaseObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["database"]
          },
          "id": {
            "type": "string"
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  },
                  "emoji": {
                    "type": "string"
                  }
                },
                "required": ["type", "emoji"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "created_time": {
            "type": "string"
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "last_edited_time": {
            "type": "string"
          },
          "last_edited_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "is_inline": {
            "type": "boolean"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse"
            }
          },
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["workspace"]
                  },
                  "workspace": {
                    "type": "boolean",
                    "enum": [true]
                  }
                },
                "required": ["type", "workspace"]
              }
            ]
          },
          "url": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "id",
          "created_time",
          "created_by",
          "last_edited_time",
          "last_edited_by",
          "title",
          "description",
          "is_inline",
          "properties",
          "parent",
          "url",
          "archived"
        ]
      },
      "UpdateDatabaseParameters": {
        "type": "object",
        "properties": {
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "emoji": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  }
                },
                "required": ["emoji", "type"]
              },
              {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  }
                },
                "required": ["external", "type"]
              },
              {
                "type": "null"
              }
            ]
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  }
                },
                "required": ["external", "type"]
              },
              {
                "type": "null"
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertyUpdateSchema"
            }
          },
          "is_inline": {
            "type": "boolean"
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "QueryDatabaseParameters": {
        "type": "object",
        "properties": {
          "sorts": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "property": {
                      "type": "string"
                    },
                    "direction": {
                      "type": "string",
                      "enum": ["ascending", "descending"]
                    }
                  },
                  "required": ["property", "direction"]
                },
                {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "enum": ["created_time", "last_edited_time"]
                    },
                    "direction": {
                      "type": "string",
                      "enum": ["ascending", "descending"]
                    }
                  },
                  "required": ["timestamp", "direction"]
                }
              ]
            }
          },
          "filter": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PropertyFilter"
              },
              {
                "$ref": "#/components/schemas/CompoundFilter"
              }
            ]
          },
          "start_cursor": {
            "type": "string"
          },
          "page_size": {
            "type": "integer"
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "QueryDatabaseResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "ListDatabasesResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "CreateDatabaseParameters": {
        "type": "object",
        "properties": {
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database_id"]
                  },
                  "database_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "database_id"]
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertySchema"
            }
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  },
                  "emoji": {
                    "type": "string"
                  }
                },
                "required": ["type", "emoji"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "is_inline": {
            "type": "boolean"
          }
        },
        "required": ["parent", "properties", "title"]
      },
      "SearchParameters": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string"
          },
          "sort": {
            "type": "object",
            "properties": {
              "direction": {
                "type": "string",
                "enum": ["ascending", "descending"]
              },
              "timestamp": {
                "type": "string",
                "enum": ["last_edited_time"]
              }
            },
            "required": ["direction", "timestamp"]
          },
          "filter": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "enum": ["page", "database"]
              },
              "property": {
                "type": "string",
                "enum": ["object"]
              }
            },
            "required": ["value", "property"]
          },
          "start_cursor": {
            "type": "string"
          },
          "page_size": {
            "type": "integer"
          }
        }
      },
      "SearchResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "CreateCommentParameters": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "parent": {
                "type": "object",
                "properties": {
                  "page_id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  }
                },
                "required": ["page_id"]
              },
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              }
            },
            "required": ["parent", "rich_text"]
          },
          {
            "type": "object",
            "properties": {
              "discussion_id": {
                "type": "string"
              },
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              }
            },
            "required": ["discussion_id", "rich_text"]
          }
        ]
      },
      "CommentObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["comment"]
          },
          "id": {
            "type": "string"
          },
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["block_id"]
                  },
                  "block_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "block_id"]
              }
            ]
          },
          "discussion_id": {
            "type": "string"
          },
          "rich_text": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "parent",
          "discussion_id",
          "rich_text",
          "created_by",
          "created_time",
          "last_edited_time"
        ]
      },
      "PartialCommentObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["comment"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "ListCommentsResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommentObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "OauthTokenParameters": {
        "type": "object",
        "properties": {
          "grant_type": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "redirect_uri": {
            "type": "string"
          },
          "external_account": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": ["key", "name"]
          }
        },
        "required": ["grant_type", "code"]
      },
      "OauthTokenResponse": {
        "type": "object",
        "properties": {
          "access_token": {
            "type": "string"
          },
          "token_type": {
            "type": "string",
            "enum": ["bearer"]
          },
          "bot_id": {
            "type": "string"
          },
          "workspace_name": {
            "type": ["string", "null"]
          },
          "workspace_icon": {
            "type": ["string", "null"]
          },
          "workspace_id": {
            "type": "string"
          },
          "owner": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["user"]
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/UserObjectResponse"
                      },
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse"
                      }
                    ]
                  }
                },
                "required": ["type", "user"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["workspace"]
                  },
                  "workspace": {
                    "type": "boolean",
                    "enum": [true]
                  }
                },
                "required": ["type", "workspace"]
              }
            ]
          },
          "duplicated_template_id": {
            "type": ["string", "null"]
          }
        },
        "required": [
          "access_token",
          "token_type",
          "bot_id",
          "workspace_name",
          "workspace_icon",
          "workspace_id",
          "owner",
          "duplicated_template_id"
        ]
      },
      "RichTextItemRequest": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "text": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "string"
                  },
                  "link": {
                    "type": ["object", "null"],
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["content"]
              },
              "type": {
                "type": "string",
                "enum": ["text"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["text"]
          },
          {
            "type": "object",
            "properties": {
              "mention": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "user": {
                        "oneOf": [
                          {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string"
                              }
                            },
                            "required": ["id"]
                          },
                          {
                            "$ref": "#/components/schemas/UserObjectResponse"
                          }
                        ]
                      }
                    },
                    "required": ["user"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "page": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          }
                        },
                        "required": ["id"]
                      }
                    },
                    "required": ["page"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "database": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          }
                        },
                        "required": ["id"]
                      }
                    },
                    "required": ["database"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "date": {
                        "$ref": "#/components/schemas/DateRequest"
                      }
                    },
                    "required": ["date"]
                  }
                ]
              },
              "type": {
                "type": "string",
                "enum": ["mention"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["mention"]
          },
          {
            "type": "object",
            "properties": {
              "equation": {
                "type": "object",
                "properties": {
                  "expression": {
                    "type": "string"
                  }
                },
                "required": ["expression"]
              },
              "type": {
                "type": "string",
                "enum": ["equation"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["equation"]
          }
        ]
      },
      "RichTextItemResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextRichTextItemResponse"
          },
          {
            "$ref": "#/components/schemas/MentionRichTextItemResponse"
          },
          {
            "$ref": "#/components/schemas/EquationRichTextItemResponse"
          }
        ]
      },
      "AnnotationRequest": {
        "type": "object",
        "properties": {
          "bold": {
            "type": "boolean"
          },
          "italic": {
            "type": "boolean"
          },
          "strikethrough": {
            "type": "boolean"
          },
          "underline": {
            "type": "boolean"
          },
          "code": {
            "type": "boolean"
          },
          "color": {
            "type": "string",
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background"
            ]
          }
        }
      },
      "DateRequest": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string"
          },
          "end": {
            "type": ["string", "null"]
          },
          "time_zone": {
            "type": ["string", "null"]
          }
        },
        "required": ["start"]
      },
      "TextRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["text"]
          },
          "text": {
            "type": "object",
            "properties": {
              "content": {
                "type": "string"
              },
              "link": {
                "type": ["object", "null"],
                "properties": {
                  "url": {
                    "type": "string"
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["content", "link"]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "text", "annotations", "plain_text", "href"]
      },
      "MentionRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["mention"]
          },
          "mention": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["user"]
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse"
                      },
                      {
                        "$ref": "#/components/schemas/UserObjectResponse"
                      }
                    ]
                  }
                },
                "required": ["type", "user"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["date"]
                  },
                  "date": {
                    "$ref": "#/components/schemas/DateResponse"
                  }
                },
                "required": ["type", "date"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["link_preview"]
                  },
                  "link_preview": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "link_preview"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page"]
                  },
                  "page": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": ["id"]
                  }
                },
                "required": ["type", "page"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database"]
                  },
                  "database": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": ["id"]
                  }
                },
                "required": ["type", "database"]
              }
            ]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "mention", "annotations", "plain_text", "href"]
      },
      "EquationRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["equation"]
          },
          "equation": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            },
            "required": ["expression"]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "equation", "annotations", "plain_text", "href"]
      },
      "AnnotationResponse": {
        "type": "object",
        "properties": {
          "bold": {
            "type": "boolean"
          },
          "italic": {
            "type": "boolean"
          },
          "strikethrough": {
            "type": "boolean"
          },
          "underline": {
            "type": "boolean"
          },
          "code": {
            "type": "boolean"
          },
          "color": {
            "type": "string",
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background"
            ]
          }
        },
        "required": [
          "bold",
          "italic",
          "strikethrough",
          "underline",
          "code",
          "color"
        ]
      },
      "DateResponse": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string"
          },
          "end": {
            "type": ["string", "null"]
          },
          "time_zone": {
            "type": ["string", "null"]
          }
        },
        "required": ["start", "end", "time_zone"]
      },
      "PartialUserObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["user"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "DatabasePropertyConfigResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TitlePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RichTextPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/NumberPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/SelectPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/MultiSelectPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/DatePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/PeoplePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/FilePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CheckboxPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/URLPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/EmailPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/PhoneNumberPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/FormulaPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RelationPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RollupPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CreatedTimePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CreatedByPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/LastEditedTimePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/LastEditedByPropertyResponse"
          }
        ]
      },
      "TitlePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["title"]
          },
          "title": {
            "type": "object"
          }
        },
        "required": ["id", "type", "title"]
      },
      "RichTextPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["rich_text"]
          },
          "rich_text": {
            "type": "object"
          }
        },
        "required": ["id", "type", "rich_text"]
      },
      "NumberPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["number"]
          },
          "number": {
            "type": "object",
            "properties": {
              "format": {
                "type": "string"
              }
            },
            "required": ["format"]
          }
        },
        "required": ["id", "type", "number"]
      },
      "SelectPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["select"]
          },
          "select": {
            "type": "object",
            "properties": {
              "options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SelectOption"
                }
              }
            },
            "required": ["options"]
          }
        },
        "required": ["id", "type", "select"]
      },
      "MultiSelectPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["multi_select"]
          },
          "multi_select": {
            "type": "object",
            "properties": {
              "options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SelectOption"
                }
              }
            },
            "required": ["options"]
          }
        },
        "required": ["id", "type", "multi_select"]
      },
      "DatePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["date"]
          },
          "date": {
            "type": "object"
          }
        },
        "required": ["id", "type", "date"]
      },
      "PeoplePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["people"]
          },
          "people": {
            "type": "object"
          }
        },
        "required": ["id", "type", "people"]
      },
      "FilePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["files"]
          },
          "files": {
            "type": "object"
          }
        },
        "required": ["id", "type", "files"]
      },
      "CheckboxPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["checkbox"]
          },
          "checkbox": {
            "type": "object"
          }
        },
        "required": ["id", "type", "checkbox"]
      },
      "URLPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["url"]
          },
          "url": {
            "type": "object"
          }
        },
        "required": ["id", "type", "url"]
      },
      "EmailPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["email"]
          },
          "email": {
            "type": "object"
          }
        },
        "required": ["id", "type", "email"]
      },
      "PhoneNumberPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["phone_number"]
          },
          "phone_number": {
            "type": "object"
          }
        },
        "required": ["id", "type", "phone_number"]
      },
      "FormulaPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["formula"]
          },
          "formula": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            },
            "required": ["expression"]
          }
        },
        "required": ["id", "type", "formula"]
      },
      "RelationPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["relation"]
          },
          "relation": {
            "type": "object",
            "properties": {
              "database_id": {
                "type": "string"
              },
              "synced_property_name": {
                "type": "string"
              },
              "synced_property_id": {
                "type": "string"
              }
            },
            "required": [
              "database_id",
              "synced_property_name",
              "synced_property_id"
            ]
          }
        },
        "required": ["id", "type", "relation"]
      },
      "RollupPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["rollup"]
          },
          "rollup": {
            "type": "object",
            "properties": {
              "relation_property_name": {
                "type": "string"
              },
              "relation_property_id": {
                "type": "string"
              },
              "rollup_property_name": {
                "type": "string"
              },
              "rollup_property_id": {
                "type": "string"
              },
              "function": {
                "type": "string"
              }
            },
            "required": [
              "relation_property_name",
              "relation_property_id",
              "rollup_property_name",

              "rollup_property_id",
              "function"
            ]
          }
        },
        "required": ["id", "type", "rollup"]
      },
      "CreatedTimePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["created_time"]
          },
          "created_time": {
            "type": "object"
          }
        },
        "required": ["id", "type", "created_time"]
      },
      "CreatedByPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["created_by"]
          },
          "created_by": {
            "type": "object"
          }
        },
        "required": ["id", "type", "created_by"]
      },
      "LastEditedTimePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["last_edited_time"]
          },
          "last_edited_time": {
            "type": "object"
          }
        },
        "required": ["id", "type", "last_edited_time"]
      },
      "LastEditedByPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["last_edited_by"]
          },
          "last_edited_by": {
            "type": "object"
          }
        },
        "required": ["id", "type", "last_edited_by"]
      },
      "SelectOption": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "color": {
            "type": "string"
          }
        },
        "required": ["id", "name", "color"]
      },
      "PropertyUpdateSchema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      },
      "PropertySchema": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "name": {
            "type": ["string", "null"]
          }
        },
        "required": ["type"]
      },
      "PropertyFilter": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "title": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "title"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "rich_text": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "rich_text"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "number": {
                "$ref": "#/components/schemas/NumberPropertyFilter"
              }
            },
            "required": ["property", "number"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "checkbox": {
                "$ref": "#/components/schemas/CheckboxPropertyFilter"
              }
            },
            "required": ["property", "checkbox"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "select": {
                "$ref": "#/components/schemas/SelectPropertyFilter"
              }
            },
            "required": ["property", "select"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "multi_select": {
                "$ref": "#/components/schemas/MultiSelectPropertyFilter"
              }
            },
            "required": ["property", "multi_select"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "date": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "date"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "people": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "people"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "files": {
                "$ref": "#/components/schemas/FilesPropertyFilter"
              }
            },
            "required": ["property", "files"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "url": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "url"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "email": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "email"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "phone_number": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "phone_number"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "relation": {
                "$ref": "#/components/schemas/RelationPropertyFilter"
              }
            },
            "required": ["property", "relation"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "created_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "created_by"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "created_time"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "last_edited_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "last_edited_by"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "last_edited_time"]
          },
          {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "string",
                "enum": ["created_time", "last_edited_time"]
              },
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["timestamp", "created_time"]
          },
          {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "string",
                "enum": ["created_time", "last_edited_time"]
              },
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["timestamp", "last_edited_time"]
          }
        ]
      },
      "TextPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "does_not_equal": {
            "type": "string"
          },
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "starts_with": {
            "type": "string"
          },
          "ends_with": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "NumberPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "number"
          },
          "does_not_equal": {
            "type": "number"
          },
          "greater_than": {
            "type": "number"
          },
          "less_than": {
            "type": "number"
          },
          "greater_than_or_equal_to": {
            "type": "number"
          },
          "less_than_or_equal_to": {
            "type": "number"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "CheckboxPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "boolean"
          },
          "does_not_equal": {
            "type": "boolean"
          }
        }
      },
      "SelectPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "does_not_equal": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "MultiSelectPropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "DatePropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "before": {
            "type": "string"
          },
          "after": {
            "type": "string"
          },
          "on_or_before": {
            "type": "string"
          },
          "on_or_after": {
            "type": "string"
          },
          "past_week": {},
          "past_month": {},
          "past_year": {},
          "next_week": {},
          "next_month": {},
          "next_year": {},
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "PeoplePropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "FilesPropertyFilter": {
        "type": "object",
        "properties": {
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "RelationPropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "CompoundFilter": {
        "type": "object",
        "properties": {
          "and": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyFilter"
            }
          },
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyFilter"
            }
          }
        }
      },
      "BlockObjectRequest": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["paragraph"]
              },
              "paragraph": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "paragraph"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_1"]
              },
              "heading_1": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_1"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_2"]
              },
              "heading_2": {
                "type": "object",

                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_2"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_3"]
              },
              "heading_3": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_3"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["bulleted_list_item"]
              },
              "bulleted_list_item": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "bulleted_list_item"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["numbered_list_item"]
              },
              "numbered_list_item": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "numbered_list_item"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["to_do"]
              },
              "to_do": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "checked": {
                    "type": "boolean"
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text", "checked"]
              }
            },
            "required": ["object", "type", "to_do"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["toggle"]
              },
              "toggle": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "toggle"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["code"]
              },
              "code": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "language": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["rich_text", "language"]
              }
            },
            "required": ["object", "type", "code"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["child_page"]
              },
              "child_page": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  }
                },
                "required": ["title"]
              }
            },
            "required": ["object", "type", "child_page"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["child_database"]
              },
              "child_database": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  }
                },
                "required": ["title"]
              }
            },
            "required": ["object", "type", "child_database"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["embed"]
              },
              "embed": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["object", "type", "embed"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["image"]
              },
              "image": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "image"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["video"]
              },
              "video": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "video"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["file"]
              },
              "file": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "file"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["pdf"]
              },
              "pdf": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "pdf"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["bookmark"]
              },
              "bookmark": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["object", "type", "bookmark"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["equation"]
              },
              "equation": {
                "type": "object",
                "properties": {
                  "expression": {
                    "type": "string"
                  }
                },
                "required": ["expression"]
              }
            },
            "required": ["object", "type", "equation"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["divider"]
              },
              "divider": {
                "type": "object"
              }
            },
            "required": ["object", "type", "divider"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table_of_contents"]
              },
              "table_of_contents": {
                "type": "object",
                "properties": {
                  "color": {
                    "type": "string"
                  }
                }
              }
            },
            "required": ["object", "type", "table_of_contents"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["column_list"]
              },
              "column_list": {
                "type": "object"
              }
            },
            "required": ["object", "type", "column_list"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["column"]
              },
              "column": {
                "type": "object"
              }
            },
            "required": ["object", "type", "column"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["link_to_page"]
              },
              "link_to_page": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": ["page_id"]
                      },
                      "page_id": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "page_id"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": ["database_id"]
                      },
                      "database_id": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "database_id"]
                  }
                ]
              }
            },
            "required": ["object", "type", "link_to_page"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table"]
              },
              "table": {
                "type": "object",
                "properties": {
                  "table_width": {
                    "type": "integer"
                  },
                  "has_column_header": {
                    "type": "boolean"
                  },
                  "has_row_header": {
                    "type": "boolean"
                  },
                  "children": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest"
                    }
                  }
                },
                "required": ["table_width", "children"]
              }
            },
            "required": ["object", "type", "table"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table_row"]
              },
              "table_row": {
                "type": "object",
                "properties": {
                  "cells": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  }
                },
                "required": ["cells"]
              }
            },
            "required": ["object", "type", "table_row"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["synced_block"]
              },
              "synced_block": {
                "type": "object",
                "properties": {
                  "synced_from": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": ["block_id"]
                          },
                          "block_id": {
                            "type": "string"
                          }
                        },
                        "required": ["type", "block_id"]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "children": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest"
                    }
                  }
                }
              }
            },
            "required": ["object", "type", "synced_block"]
          }
        ]
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/open-meteo.yaml
================================================
openapi: 3.0.0
info:
  title: Open-Meteo APIs
  description: 'Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.'
  version: '1.0'
  contact:
    name: Open-Meteo
    url: https://open-meteo.com
    email: info@open-meteo.com
  license:
    name: Attribution 4.0 International (CC BY 4.0)
    url: https://creativecommons.org/licenses/by/4.0/
  termsOfService: https://open-meteo.com/en/features#terms
paths:
  /v1/forecast:
    servers:
      - url: https://api.open-meteo.com
    get:
      tags:
        - Weather Forecast APIs
      summary: 7 day weather forecast for coordinates
      description: 7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.
      parameters:
        - name: hourly
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - temperature_2m
                - relative_humidity_2m
                - dew_point_2m
                - apparent_temperature
                - pressure_msl
                - cloud_cover
                - cloud_cover_low
                - cloud_cover_mid
                - cloud_cover_high
                - wind_speed_10m
                - wind_speed_80m
                - wind_speed_120m
                - wind_speed_180m
                - wind_direction_10m
                - wind_direction_80m
                - wind_direction_120m
                - wind_direction_180m
                - wind_gusts_10m
                - shortwave_radiation
                - direct_radiation
                - direct_normal_irradiance
                - diffuse_radiation
                - vapour_pressure_deficit
                - evapotranspiration
                - precipitation
                - weather_code
                - snow_height
                - freezing_level_height
                - soil_temperature_0cm
                - soil_temperature_6cm
                - soil_temperature_18cm
                - soil_temperature_54cm
                - soil_moisture_0_1cm
                - soil_moisture_1_3cm
                - soil_moisture_3_9cm
                - soil_moisture_9_27cm
                - soil_moisture_27_81cm
        - name: daily
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - temperature_2m_max
                - temperature_2m_min
                - apparent_temperature_max
                - apparent_temperature_min
                - precipitation_sum
                - precipitation_hours
                - weather_code
                - sunrise
                - sunset
                - wind_speed_10m_max
                - wind_gusts_10m_max
                - wind_direction_10m_dominant
                - shortwave_radiation_sum
                - uv_index_max
                - uv_index_clear_sky_max
                - et0_fao_evapotranspiration
        - name: latitude
          in: query
          required: true
          description: 'WGS84 coordinate'
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          required: true
          description: 'WGS84 coordinate'
          schema:
            type: number
            format: double
        - name: current_weather
          in: query
          schema:
            type: boolean
        - name: temperature_unit
          in: query
          schema:
            type: string
            default: celsius
            enum:
              - celsius
              - fahrenheit
        - name: wind_speed_unit
          in: query
          schema:
            type: string
            default: kmh
            enum:
              - kmh
              - ms
              - mph
              - kn
        - name: timeformat
          in: query
          description: If format `unixtime` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply `utc_offset_seconds` again to get the correct date.
          schema:
            type: string
            default: iso8601
            enum:
              - iso8601
              - unixtime
        - name: timezone
          in: query
          description: If `timezone` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.
          schema:
            type: string
        - name: past_days
          in: query
          description: If `past_days` is set, yesterdays or the day before yesterdays data are also returned.
          schema:
            type: integer
            enum:
              - 1
              - 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  latitude:
                    type: number
                    example: 52.52
                    description: WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.
                  longitude:
                    type: number
                    example: 13.419.52
                    description: WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.
                  elevation:
                    type: number
                    example: 44.812
                    description: The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.
                  generationtime_ms:
                    type: number
                    example: 2.2119
                    description: Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.
                  utc_offset_seconds:
                    type: integer
                    example: 3600
                    description: Applied timezone offset from the &timezone= parameter.
                  hourly:
                    $ref: '#/components/schemas/HourlyResponse'
                  hourly_units:
                    type: object
                    additionalProperties:
                      type: string
                    description: For each selected weather variable, the unit will be listed here.
                  daily:
                    $ref: '#/components/schemas/DailyResponse'
                  daily_units:
                    type: object
                    additionalProperties:
                      type: string
                    description: For each selected daily weather variable, the unit will be listed here.
                  current_weather:
                    $ref: '#/components/schemas/CurrentWeather'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    description: Always set true for errors
                  reason:
                    type: string
                    description: Description of the error
                    example: 'Latitude must be in range of -90 to 90°. Given: 300'
components:
  schemas:
    HourlyResponse:
      type: object
      description: For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.
      required:
        - time
      properties:
        time:
          type: array
          items:
            type: string
        temperature_2m:
          type: array
          items:
            type: number
        relative_humidity_2m:
          type: array
          items:
            type: number
        dew_point_2m:
          type: array
          items:
            type: number
        apparent_temperature:
          type: array
          items:
            type: number
        pressure_msl:
          type: array
          items:
            type: number
        cloud_cover:
          type: array
          items:
            type: number
        cloud_cover_low:
          type: array
          items:
            type: number
        cloud_cover_mid:
          type: array
          items:
            type: number
        cloud_cover_high:
          type: array
          items:
            type: number
        wind_speed_10m:
          type: array
          items:
            type: number
        wind_speed_80m:
          type: array
          items:
            type: number
        wind_speed_120m:
          type: array
          items:
            type: number
        wind_speed_180m:
          type: array
          items:
            type: number
        wind_direction_10m:
          type: array
          items:
            type: number
        wind_direction_80m:
          type: array
          items:
            type: number
        wind_direction_120m:
          type: array
          items:
            type: number
        wind_direction_180m:
          type: array
          items:
            type: number
        wind_gusts_10m:
          type: array
          items:
            type: number
        shortwave_radiation:
          type: array
          items:
            type: number
        direct_radiation:
          type: array
          items:
            type: number
        direct_normal_irradiance:
          type: array
          items:
            type: number
        diffuse_radiation:
          type: array
          items:
            type: number
        vapour_pressure_deficit:
          type: array
          items:
            type: number
        evapotranspiration:
          type: array
          items:
            type: number
        precipitation:
          type: array
          items:
            type: number
        weather_code:
          type: array
          items:
            type: number
        snow_height:
          type: array
          items:
            type: number
        freezing_level_height:
          type: array
          items:
            type: number
        soil_temperature_0cm:
          type: array
          items:
            type: number
        soil_temperature_6cm:
          type: array
          items:
            type: number
        soil_temperature_18cm:
          type: array
          items:
            type: number
        soil_temperature_54cm:
          type: array
          items:
            type: number
        soil_moisture_0_1cm:
          type: array
          items:
            type: number
        soil_moisture_1_3cm:
          type: array
          items:
            type: number
        soil_moisture_3_9cm:
          type: array
          items:
            type: number
        soil_moisture_9_27cm:
          type: array
          items:
            type: number
        soil_moisture_27_81cm:
          type: array
          items:
            type: number
    DailyResponse:
      type: object
      description: For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.
      properties:
        time:
          type: array
          items:
            type: string
        temperature_2m_max:
          type: array
          items:
            type: number
        temperature_2m_min:
          type: array
          items:
            type: number
        apparent_temperature_max:
          type: array
          items:
            type: number
        apparent_temperature_min:
          type: array
          items:
            type: number
        precipitation_sum:
          type: array
          items:
            type: number
        precipitation_hours:
          type: array
          items:
            type: number
        weather_code:
          type: array
          items:
            type: number
        sunrise:
          type: array
          items:
            type: number
        sunset:
          type: array
          items:
            type: number
        wind_speed_10m_max:
          type: array
          items:
            type: number
        wind_gusts_10m_max:
          type: array
          items:
            type: number
        wind_direction_10m_dominant:
          type: array
          items:
            type: number
        shortwave_radiation_sum:
          type: array
          items:
            type: number
        uv_index_max:
          type: array
          items:
            type: number
        uv_index_clear_sky_max:
          type: array
          items:
            type: number
        et0_fao_evapotranspiration:
          type: array
          items:
            type: number
      required:
        - time
    CurrentWeather:
      type: object
      description: 'Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code'
      properties:
        time:
          type: string
        temperature:
          type: number
        wind_speed:
          type: number
        wind_direction:
          type: number
        weather_code:
          type: integer
      required:
        - time
        - temperature
        - wind_speed
        - wind_direction
        - weather_code


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/pet-store.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger Petstore",
    "license": {
      "name": "MIT"
    }
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1"
    }
  ],
  "paths": {
    "/pets": {
      "get": {
        "summary": "List all pets",
        "operationId": "listPets",
        "tags": ["pets"],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "How many items to return at one time (max 100)",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A paged array of pets",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pets"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a pet",
        "operationId": "createPets",
        "tags": ["pets"],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Pet"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Null response"
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/pets/{petId}": {
      "get": {
        "summary": "Info for a specific pet",
        "operationId": "showPetById",
        "tags": ["pets"],
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "required": true,
            "description": "The id of the pet to retrieve",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Expected response to a valid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Pet": {
        "type": "object",
        "required": ["id", "name"],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        }
      },
      "Pets": {
        "type": "array",
        "maxItems": 100,
        "items": {
          "$ref": "#/components/schemas/Pet"
        }
      },
      "Error": {
        "type": "object",
        "required": ["code", "message"],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/petstore-expanded.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger Petstore",
    "description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "name": "Swagger API Team",
      "email": "apiteam@swagger.io",
      "url": "http://swagger.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/api"
    }
  ],
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
        "operationId": "findPets",
        "parameters": [
          {
            "name": "tags",
            "in": "query",
            "description": "tags to filter by",
            "required": false,
            "style": "form",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "maximum number of results to return",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed",
        "operationId": "addPet",
        "requestBody": {
          "description": "Pet to add to the store",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPet"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/pets/{id}": {
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
        "operationId": "find pet by id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of pet to fetch",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "delete": {
        "description": "deletes a single pet based on the ID supplied",
        "operationId": "deletePet",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of pet to delete",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "pet deleted"
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Pet": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewPet"
          },
          {
            "type": "object",
            "required": ["id"],
            "properties": {
              "id": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ]
      },
      "NewPet": {
        "type": "object",
        "required": ["name"],
        "properties": {
          "name": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": ["code", "message"],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/readme.json
================================================
{
  "openapi": "3.0.2",
  "info": {
    "description": "Create beautiful product and API documentation with our developer friendly platform.",
    "version": "4.355.0",
    "title": "ReadMe API 🦉",
    "contact": {
      "name": "API Support",
      "url": "https://docs.readme.com/main/docs/need-more-support",
      "email": "support@readme.io"
    }
  },
  "servers": [
    {
      "url": "https://dash.readme.com/api/v1"
    }
  ],
  "tags": [
    {
      "name": "API Registry"
    },
    {
      "name": "API Specification"
    },
    {
      "name": "Apply to ReadMe"
    },
    {
      "name": "Categories"
    },
    {
      "name": "Changelog"
    },
    {
      "name": "Custom Pages"
    },
    {
      "name": "Docs"
    },
    {
      "name": "Errors"
    },
    {
      "name": "Projects"
    },
    {
      "name": "Version"
    }
  ],
  "paths": {
    "/api-registry/{uuid}": {
      "get": {
        "operationId": "getAPIRegistry",
        "summary": "Retrieve an entry from the API Registry",
        "description": "Get an API definition file that's been uploaded to ReadMe.",
        "tags": ["API Registry"],
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "An API Registry UUID. This can be found by navigating to your API Reference page and viewing code snippets for Node with the `api` library.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved API registry entry.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/error_REGISTRY_NOTFOUND"
          }
        }
      }
    },
    "/api-specification": {
      "get": {
        "operationId": "getAPISpecification",
        "summary": "Get metadata",
        "description": "Get API specification metadata.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved API specification metadata.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_EMPTY"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "uploadAPISpecification",
        "summary": "Upload specification",
        "description": "Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/main/docs/rdme.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "spec": {
                    "description": "OpenAPI/Swagger file. We accept JSON or YAML.",
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The API specification was successfully uploaded."
          },
          "400": {
            "description": "There was a validation error during upload.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "408": {
            "$ref": "#/components/responses/error_SPEC_TIMEOUT"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/api-specification/{id}": {
      "put": {
        "operationId": "updateAPISpecification",
        "summary": "Update specification",
        "description": "Update an API specification in ReadMe.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "spec": {
                    "description": "OpenAPI/Swagger file. We accept JSON or YAML.",
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The API specification was updated."
          },
          "400": {
            "description": "There was a validation error during upload.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_ID_DUPLICATE"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_ID_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "description": "There is no API specification with that ID."
          },
          "408": {
            "$ref": "#/components/responses/error_SPEC_TIMEOUT"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteAPISpecification",
        "summary": "Delete specification",
        "description": "Delete an API specification in ReadMe.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "The API specification was deleted."
          },
          "400": {
            "$ref": "#/components/responses/error_SPEC_ID_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_SPEC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/apply": {
      "get": {
        "operationId": "getOpenRoles",
        "summary": "Get open roles",
        "description": "Returns all the roles we're hiring for at ReadMe!",
        "tags": ["Apply to ReadMe"],
        "responses": {
          "200": {
            "description": "All the roles that we're hiring for.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/jobOpening"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "applyToReadMe",
        "summary": "Submit your application!",
        "description": "This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI!",
        "tags": ["Apply to ReadMe"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/apply"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "You did it!"
          }
        }
      }
    },
    "/categories": {
      "get": {
        "operationId": "getCategories",
        "summary": "Get all categories",
        "description": "Returns all the categories for a specified version.",
        "tags": ["Categories"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of categories.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createCategory",
        "summary": "Create category",
        "description": "Create a new category inside of this project.",
        "tags": ["Categories"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/category"
                  },
                  {
                    "required": ["title"]
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The category has successfully been created."
          },
          "400": {
            "$ref": "#/components/responses/error_CATEGORY_INVALID"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/categories/{slug}": {
      "get": {
        "operationId": "getCategory",
        "summary": "Get category",
        "description": "Returns the category with this slug.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The category exists and has been returned."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateCategory",
        "summary": "Update category",
        "description": "Change the properties of a category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/category"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The category was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_CATEGORY_INVALID"
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteCategory",
        "summary": "Delete category",
        "description": "Delete the category with this slug.\n>⚠️Heads Up!\n> This will also delete all of the docs within this category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "204": {
            "description": "The category was deleted."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/categories/{slug}/docs": {
      "get": {
        "operationId": "getCategoryDocs",
        "summary": "Get docs for category",
        "description": "Returns the docs and children docs within this category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The category exists and all of the docs have been returned."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/changelogs": {
      "get": {
        "operationId": "getChangelogs",
        "summary": "Get changelogs",
        "description": "Returns a list of changelogs.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of changelogs.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createChangelog",
        "summary": "Create changelog",
        "description": "Create a new changelog entry.",
        "tags": ["Changelog"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/changelog"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The changelog was successfully created."
          },
          "400": {
            "description": "There was a validation error during creation."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/changelogs/{slug}": {
      "get": {
        "operationId": "getChangelog",
        "summary": "Get changelog",
        "description": "Returns the changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Update\", enter the slug \"owlet-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The changelog exists and has been returned."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateChangelog",
        "summary": "Update changelog",
        "description": "Update a changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/changelog"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The changelog was successfully updated."
          },
          "400": {
            "description": "There was a validation error during update."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteChangelog",
        "summary": "Delete changelog",
        "description": "Delete the changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The changelog was successfully updated."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/custompages": {
      "get": {
        "operationId": "getCustomPages",
        "summary": "Get custom pages",
        "description": "Returns a list of custom pages.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of custom pages.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createCustomPage",
        "summary": "Create custom page",
        "description": "Create a new custom page inside of this project.",
        "tags": ["Custom Pages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customPage"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The custom page was successfully created."
          },
          "400": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/custompages/{slug}": {
      "get": {
        "operationId": "getCustomPage",
        "summary": "Get custom page",
        "description": "Returns the custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "responses": {
          "200": {
            "description": "The custom page exists and has been returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateCustomPage",
        "summary": "Update custom page",
        "description": "Update a custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customPage"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The custom page was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteCustomPage",
        "summary": "Delete custom page",
        "description": "Delete the custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "responses": {
          "204": {
            "description": "The custom page was successfully updated."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/{slug}": {
      "get": {
        "operationId": "getDoc",
        "summary": "Get doc",
        "description": "Returns the doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The doc exists and has been returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateDoc",
        "summary": "Update doc",
        "description": "Update a doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/docSchemaPut"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The doc was successfully updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_DOC_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteDoc",
        "summary": "Delete doc",
        "description": "Delete the doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "204": {
            "description": "The doc was successfully updated."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/{slug}/production": {
      "get": {
        "operationId": "getProductionDoc",
        "summary": "Get production doc",
        "description": "This is intended for use by enterprise users with staging enabled. This endpoint will return the live version of your document, whereas the standard endpoint will always return staging.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The doc exists and has been returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs": {
      "post": {
        "operationId": "createDoc",
        "summary": "Create doc",
        "description": "Create a new doc inside of this project.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/docSchemaPost"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The doc was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_DOC_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/search": {
      "post": {
        "operationId": "searchDocs",
        "summary": "Search docs",
        "description": "Returns all docs that match the search.",
        "tags": ["Docs"],
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "description": "Search string to look for.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The search was successful and results were returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/": {
      "get": {
        "operationId": "getProject",
        "summary": "Get metadata about the current project",
        "description": "Returns project data for the API key.",
        "tags": ["Projects"],
        "responses": {
          "200": {
            "description": "Project data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/condensedProjectData"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/schema": {
      "get": {
        "operationId": "getAPISchema",
        "summary": "Get our OpenAPI Definition",
        "description": "Returns a copy of our OpenAPI Definition.",
        "tags": ["API Specification"],
        "responses": {
          "200": {
            "description": "OpenAPI Definition data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/version": {
      "get": {
        "operationId": "getVersions",
        "summary": "Get versions",
        "description": "Retrieve a list of versions associated with a project API key.",
        "tags": ["Version"],
        "responses": {
          "200": {
            "description": "A list of versions."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createVersion",
        "summary": "Create version",
        "description": "Create a new version.",
        "tags": ["Version"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/version"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The version was successfully created."
          },
          "400": {
            "description": "There was a validation error during creation.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_VERSION_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_VERSION_DUPLICATE"
                    },
                    {
                      "$ref": "#/components/schemas/error_VERSION_FORK_EMPTY"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_FORK_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/version/{versionId}": {
      "get": {
        "operationId": "getVersion",
        "summary": "Get version",
        "description": "Returns the version with this version ID.",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The version exists and has been returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateVersion",
        "summary": "Update version",
        "description": "Update an existing version.",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/version"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The version was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_CANT_DEMOTE_STABLE"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteVersion",
        "summary": "Delete version",
        "description": "Delete a version",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The version was successfully deleted."
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_CANT_REMOVE_STABLE"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "headers": {
      "link": {
        "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.",
        "schema": {
          "type": "string"
        }
      },
      "x-total-count": {
        "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.",
        "schema": {
          "type": "string"
        }
      }
    },
    "parameters": {
      "slug": {
        "name": "slug",
        "in": "path",
        "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "description": "Used to specify further pages (starts at 1).",
        "schema": {
          "type": "integer",
          "default": 1,
          "minimum": 1
        }
      },
      "perPage": {
        "name": "perPage",
        "in": "query",
        "description": "Number of items to include in pagination (up to 100, defaults to 10).",
        "schema": {
          "type": "integer",
          "default": 10,
          "minimum": 1,
          "maximum": 100
        }
      },
      "x-readme-version": {
        "in": "header",
        "name": "x-readme-version",
        "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.",
        "example": "v3.0",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "versionId": {
        "name": "versionId",
        "in": "path",
        "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).",
        "example": "v1.0.0",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "authForbidden": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/error_APIKEY_MISMATCH"
                }
              ]
            }
          }
        }
      },
      "authUnauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/error_APIKEY_EMPTY"
                },
                {
                  "$ref": "#/components/schemas/error_APIKEY_NOTFOUND"
                }
              ]
            }
          }
        }
      },
      "error_APIKEY_EMPTY": {
        "description": "An API key was not supplied.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_EMPTY"
            }
          }
        }
      },
      "error_APIKEY_MISMATCH": {
        "description": "The API key doesn't match the project.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_MISMATCH"
            }
          }
        }
      },
      "error_APIKEY_NOTFOUND": {
        "description": "The API key couldn't be located.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_NOTFOUND"
            }
          }
        }
      },
      "error_APPLY_INVALID_EMAIL": {
        "description": "You need to provide a valid email.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_EMAIL"
            }
          }
        }
      },
      "error_APPLY_INVALID_JOB": {
        "description": "You need to provide a job.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_JOB"
            }
          }
        }
      },
      "error_APPLY_INVALID_NAME": {
        "description": "You need to provide a name.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_NAME"
            }
          }
        }
      },
      "error_CATEGORY_INVALID": {
        "description": "The category couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CATEGORY_INVALID"
            }
          }
        }
      },
      "error_CATEGORY_NOTFOUND": {
        "description": "The category couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CATEGORY_NOTFOUND"
            }
          }
        }
      },
      "error_CHANGELOG_INVALID": {
        "description": "The changelog couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CHANGELOG_INVALID"
            }
          }
        }
      },
      "error_CHANGELOG_NOTFOUND": {
        "description": "The changelog couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CHANGELOG_NOTFOUND"
            }
          }
        }
      },
      "error_CUSTOMPAGE_INVALID": {
        "description": "The page couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CUSTOMPAGE_INVALID"
            }
          }
        }
      },
      "error_CUSTOMPAGE_NOTFOUND": {
        "description": "The custom page couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CUSTOMPAGE_NOTFOUND"
            }
          }
        }
      },
      "error_DOC_INVALID": {
        "description": "The doc couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_DOC_INVALID"
            }
          }
        }
      },
      "error_DOC_NOTFOUND": {
        "description": "The doc couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_DOC_NOTFOUND"
            }
          }
        }
      },
      "error_ENDPOINT_NOTFOUND": {
        "description": "The endpoint doesn't exist.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_ENDPOINT_NOTFOUND"
            }
          }
        }
      },
      "error_INTERNAL_ERROR": {
        "description": "An unknown error has occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_INTERNAL_ERROR"
            }
          }
        }
      },
      "error_PROJECT_NEEDSSTAGING": {
        "description": "The project does not have staging enabled.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_PROJECT_NEEDSSTAGING"
            }
          }
        }
      },
      "error_PROJECT_NOTFOUND": {
        "description": "The project couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_PROJECT_NOTFOUND"
            }
          }
        }
      },
      "error_RATE_LIMITED": {
        "description": "The request has been rate limited.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_RATE_LIMITED"
            }
          }
        }
      },
      "error_REGISTRY_INVALID": {
        "description": "The registry entry couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_REGISTRY_INVALID"
            }
          }
        }
      },
      "error_REGISTRY_NOTFOUND": {
        "description": "The registry entry couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_REGISTRY_NOTFOUND"
            }
          }
        }
      },
      "error_SPEC_FILE_EMPTY": {
        "description": "A spec file wasn't included.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
            }
          }
        }
      },
      "error_SPEC_ID_DUPLICATE": {
        "description": "The spec ID already tied to another version.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_ID_DUPLICATE"
            }
          }
        }
      },
      "error_SPEC_ID_INVALID": {
        "description": "The spec ID isn't valid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_ID_INVALID"
            }
          }
        }
      },
      "error_SPEC_INVALID": {
        "description": "The uploaded spec isn't valid JSON or YAML.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_INVALID"
            }
          }
        }
      },
      "error_SPEC_INVALID_SCHEMA": {
        "description": "The uploaded spec has OpenAPI validation errors.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
            }
          }
        }
      },
      "error_SPEC_NOTFOUND": {
        "description": "The spec couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_NOTFOUND"
            }
          }
        }
      },
      "error_SPEC_TIMEOUT": {
        "description": "The spec upload timed out.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_TIMEOUT"
            }
          }
        }
      },
      "error_SPEC_VERSION_NOTFOUND": {
        "description": "The spec version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
            }
          }
        }
      },
      "error_UNEXPECTED_ERROR": {
        "description": "An unknown error has occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_UNEXPECTED_ERROR"
            }
          }
        }
      },
      "error_VERSION_CANT_DEMOTE_STABLE": {
        "description": "A stable version can't be demoted.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_CANT_DEMOTE_STABLE"
            }
          }
        }
      },
      "error_VERSION_CANT_REMOVE_STABLE": {
        "description": "A stable version can't be removed.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_CANT_REMOVE_STABLE"
            }
          }
        }
      },
      "error_VERSION_DUPLICATE": {
        "description": "The version already exists.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_DUPLICATE"
            }
          }
        }
      },
      "error_VERSION_EMPTY": {
        "description": "No version was supplied.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_EMPTY"
            }
          }
        }
      },
      "error_VERSION_FORK_EMPTY": {
        "description": "New versions need to be forked from an existing version.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_FORK_EMPTY"
            }
          }
        }
      },
      "error_VERSION_FORK_NOTFOUND": {
        "description": "The version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_FORK_NOTFOUND"
            }
          }
        }
      },
      "error_VERSION_INVALID": {
        "description": "The version is invalid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_INVALID"
            }
          }
        }
      },
      "error_VERSION_NOTFOUND": {
        "description": "The version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_NOTFOUND"
            }
          }
        }
      }
    },
    "schemas": {
      "baseError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "An error code unique to the error received."
          },
          "message": {
            "type": "string",
            "description": "The reason why the error occured."
          },
          "suggestion": {
            "type": "string",
            "description": "A helpful suggestion for how to alleviate the error."
          },
          "docs": {
            "type": "string",
            "format": "url",
            "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.",
            "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"
          },
          "help": {
            "type": "string",
            "description": "Information on where you can receive additional assistance from our wonderful support team.",
            "example": "If you need help, email support@readme.io"
          },
          "poem": {
            "type": "array",
            "description": "A short poem we wrote you about your error.",
            "items": {
              "type": "string"
            },
            "example": [
              "If you're seeing this error,",
              "Things didn't quite go the way we hoped.",
              "When we tried to process your request,",
              "Maybe trying again it'll work—who knows!"
            ]
          }
        }
      },
      "apply": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Your full name",
            "default": "Your Name"
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "A valid email we can reach you at.",
            "default": "you@example.com"
          },
          "job": {
            "type": "string",
            "description": "The job you're looking to apply for (https://readme.com/careers).",
            "enum": [
              "Front End Engineer",
              "Full Stack Engineer",
              "Head of Product",
              "Head of Solutions Engineering",
              "Product Designer"
            ],
            "default": "Front End Engineer"
          },
          "pronouns": {
            "type": "string",
            "description": "Learn more at https://lgbtlifecenter.org/pronouns/"
          },
          "linkedin": {
            "type": "string",
            "format": "url",
            "description": "What have you been up to the past few years?"
          },
          "github": {
            "type": "string",
            "description": "Or Bitbucket, Gitlab or anywhere else your code is hosted!",
            "format": "url"
          },
          "coverLetter": {
            "type": "string",
            "format": "blob",
            "description": "What should we know about you?"
          },
          "dontReallyApply": {
            "type": "boolean",
            "description": "Want to play with the API but not actually apply? Set this to true.",
            "default": false
          }
        },
        "required": ["name", "email", "job"]
      },
      "category": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "A short title for the category. This is what will show in the sidebar."
          },
          "type": {
            "type": "string",
            "enum": ["reference", "guide"],
            "default": "guide",
            "description": "A category can be part of your reference or guide documentation, which is determined by this field."
          }
        }
      },
      "changelog": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the changelog."
          },
          "type": {
            "type": "string",
            "default": "",
            "enum": ["", "added", "fixed", "improved", "deprecated", "removed"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the changelog."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the changelog.",
            "default": true
          }
        },
        "required": ["title", "body"]
      },
      "condensedProjectData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "subdomain": {
            "type": "string"
          },
          "jwtSecret": {
            "type": "string"
          },
          "baseUrl": {
            "type": "string",
            "format": "url",
            "description": "The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`."
          },
          "plan": {
            "type": "string"
          }
        }
      },
      "customPage": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the custom page."
          },
          "body": {
            "type": "string",
            "description": "Body formatted in Markdown (displayed by default)."
          },
          "html": {
            "type": "string",
            "description": "Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)."
          },
          "htmlmode": {
            "type": "boolean",
            "description": "**true** if `html` should be displayed, **false** if `body` should be displayed.",
            "default": false
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the custom page.",
            "default": true
          }
        },
        "required": ["title"]
      },
      "docSchemaPost": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          },
          "categorySlug": {
            "type": "string",
            "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."
          },
          "parentDocSlug": {
            "type": "string",
            "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."
          }
        },
        "oneOf": [
          {
            "required": ["title", "category"],
            "title": "`category` Parameter"
          },
          {
            "required": ["title", "categorySlug"],
            "title": "`categorySlug` Parameter"
          }
        ],
        "additionalProperties": true
      },
      "docSchemaPut": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          },
          "categorySlug": {
            "type": "string",
            "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."
          },
          "parentDocSlug": {
            "type": "string",
            "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."
          }
        },
        "additionalProperties": true
      },
      "docSchemaResponse": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          }
        },
        "additionalProperties": true
      },
      "version": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "description": "Semantic Version"
          },
          "codename": {
            "type": "string",
            "description": "Dubbed name of version."
          },
          "from": {
            "type": "string",
            "description": "Semantic Version to use as the base fork."
          },
          "is_stable": {
            "type": "boolean",
            "description": "Should this be the **main** version?"
          },
          "is_beta": {
            "type": "boolean",
            "default": true
          },
          "is_hidden": {
            "type": "boolean",
            "description": "Should this be publically accessible?"
          },
          "is_deprecated": {
            "type": "boolean",
            "description": "Should this be deprecated? Only allowed in PUT operations."
          }
        },
        "required": ["version", "from"]
      },
      "jobOpening": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "description": "A slugified version of the job opening title.",
            "example": "api-engineer"
          },
          "title": {
            "type": "string",
            "description": "The job opening position.",
            "example": "API Engineer"
          },
          "description": {
            "type": "string",
            "description": "The description for this open position. This content is formatted as HTML."
          },
          "pullquote": {
            "type": "string",
            "description": "A short pullquote for the open position.",
            "example": "Deeply knowledgeable of the web, HTTP, and the API space."
          },
          "location": {
            "type": "string",
            "description": "Where this position is located at.",
            "example": "Remote"
          },
          "department": {
            "type": "string",
            "description": "The internal organization you'll be working in.",
            "example": "Engineering"
          },
          "url": {
            "type": "string",
            "format": "url",
            "description": "The place where you can apply for the position!"
          }
        }
      },
      "error_APIKEY_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_EMPTY"
              }
            }
          }
        ]
      },
      "error_APIKEY_MISMATCH": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_MISMATCH"
              }
            }
          }
        ]
      },
      "error_APIKEY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_EMAIL": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_EMAIL"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_JOB": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_JOB"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_NAME": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_NAME"
              }
            }
          }
        ]
      },
      "error_CATEGORY_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CATEGORY_INVALID"
              }
            }
          }
        ]
      },
      "error_CATEGORY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CATEGORY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_CHANGELOG_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CHANGELOG_INVALID"
              }
            }
          }
        ]
      },
      "error_CHANGELOG_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CHANGELOG_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_CUSTOMPAGE_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CUSTOMPAGE_INVALID"
              }
            }
          }
        ]
      },
      "error_CUSTOMPAGE_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CUSTOMPAGE_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_DOC_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "DOC_INVALID"
              }
            }
          }
        ]
      },
      "error_DOC_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "DOC_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_ENDPOINT_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "ENDPOINT_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_INTERNAL_ERROR": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "INTERNAL_ERROR"
              }
            }
          }
        ]
      },
      "error_PROJECT_NEEDSSTAGING": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "PROJECT_NEEDSSTAGING"
              }
            }
          }
        ]
      },
      "error_PROJECT_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "PROJECT_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_RATE_LIMITED": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "RATE_LIMITED"
              }
            }
          }
        ]
      },
      "error_REGISTRY_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "REGISTRY_INVALID"
              }
            }
          }
        ]
      },
      "error_REGISTRY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "REGISTRY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_SPEC_FILE_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_FILE_EMPTY"
              }
            }
          }
        ]
      },
      "error_SPEC_ID_DUPLICATE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_ID_DUPLICATE"
              }
            }
          }
        ]
      },
      "error_SPEC_ID_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_ID_INVALID"
              }
            }
          }
        ]
      },
      "error_SPEC_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_INVALID"
              }
            }
          }
        ]
      },
      "error_SPEC_INVALID_SCHEMA": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_INVALID_SCHEMA"
              }
            }
          }
        ]
      },
      "error_SPEC_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_SPEC_TIMEOUT": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_TIMEOUT"
              }
            }
          }
        ]
      },
      "error_SPEC_VERSION_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_VERSION_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_UNEXPECTED_ERROR": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "UNEXPECTED_ERROR"
              }
            }
          }
        ]
      },
      "error_VERSION_CANT_DEMOTE_STABLE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_CANT_DEMOTE_STABLE"
              }
            }
          }
        ]
      },
      "error_VERSION_CANT_REMOVE_STABLE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_CANT_REMOVE_STABLE"
              }
            }
          }
        ]
      },
      "error_VERSION_DUPLICATE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_DUPLICATE"
              }
            }
          }
        ]
      },
      "error_VERSION_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_EMPTY"
              }
            }
          }
        ]
      },
      "error_VERSION_FORK_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_FORK_EMPTY"
              }
            }
          }
        ]
      },
      "error_VERSION_FORK_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_FORK_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_VERSION_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_INVALID"
              }
            }
          }
        ]
      },
      "error_VERSION_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_NOTFOUND"
              }
            }
          }
        ]
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/security.json
================================================
{
  "openapi": "3.0.3",
  "info": {
    "version": "1.0.0",
    "title": "Support for different security types",
    "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject"
  },
  "servers": [
    {
      "url": "https://httpbin.org"
    }
  ],
  "tags": [
    {
      "name": "API Key"
    },
    {
      "name": "HTTP"
    },
    {
      "name": "OAuth 2"
    },
    {
      "name": "OpenID Connect"
    },
    {
      "name": "Other"
    }
  ],
  "paths": {
    "/anything/apiKey": {
      "get": {
        "summary": "Query parameter",
        "description": "`apiKey` auth will be supplied within an `apiKey` query parameter.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_query": []
          }
        ]
      },
      "post": {
        "summary": "Cookie",
        "description": "`apiKey` auth will be supplied within an `api_key` cookie.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_cookie": []
          }
        ]
      },
      "put": {
        "summary": "Header",
        "description": "`apiKey` auth will be supplied within an `X-API-KEY` header.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_header": []
          }
        ]
      }
    },
    "/anything/basic": {
      "post": {
        "summary": "Basic",
        "description": "Authentication credentials will be supplied within a `Basic` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "basic": []
          }
        ]
      }
    },
    "/anything/bearer": {
      "post": {
        "summary": "Bearer",
        "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "summary": "Bearer (`jwt` format)",
        "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header, but its data should be controlled as a JWT.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample\n\n> ℹ️\n> We currently do not support any special handling for this so they're handled as a standard `Bearer` authentication token.",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "bearer_jwt": []
          }
        ]
      }
    },
    "/anything/oauth2": {
      "post": {
        "summary": "General support (all flow types)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2": ["write:things"]
          }
        ]
      },
      "get": {
        "summary": "General support (authorizationCode flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_authorizationCode": ["write:things"]
          }
        ]
      },
      "put": {
        "summary": "General support (clientCredentials flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_clientCredentials": ["write:things"]
          }
        ]
      },
      "patch": {
        "summary": "General support (implicit flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_implicit": ["write:things"]
          }
        ]
      },
      "delete": {
        "summary": "General support (password flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_password": ["write:things"]
          }
        ]
      }
    },
    "/anything/openIdConnect": {
      "post": {
        "summary": "General support",
        "description": "🚧 This is not supported.",
        "tags": ["OpenID Connect"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "openIdConnect": []
          }
        ]
      }
    },
    "/anything/no-auth": {
      "post": {
        "summary": "No auth requirements",
        "description": "This operation does not have any authentication requirements.",
        "tags": ["Other"],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/anything/optional-auth": {
      "get": {
        "summary": "Optional auth",
        "description": "The `apiKey` query parameter auth on this operation is optional.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
        "tags": ["Other"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_query": []
          },
          {}
        ]
      }
    },
    "/status/401": {
      "post": {
        "summary": "Forced invalid authentication",
        "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
        "tags": ["Other"],
        "responses": {
          "401": {
            "description": "Unauthorized"
          }
        },
        "security": [
          {
            "apiKey_header": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey_cookie": {
        "type": "apiKey",
        "in": "cookie",
        "name": "api_key",
        "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "apiKey_header": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "apiKey_query": {
        "type": "apiKey",
        "in": "query",
        "name": "apiKey",
        "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "basic": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic auth that takes a base64'd combination of `user:password`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
      },
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "description": "A bearer token that will be supplied within an `Authentication` header as `bearer <token>`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
      },
      "bearer_jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "A bearer token that will be supplied within an `Authentication` header as `bearer <token>`. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample"
      },
      "oauth2": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "clientCredentials": {
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "implicit": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "password": {
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_authorizationCode": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `authorizationCode` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_clientCredentials": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `clientCredentials` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_implicit": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `implicit` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "implicit": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_password": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `password` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "password": {
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "openIdConnect": {
        "type": "openIdConnect",
        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
        "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23"
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/stripe.json
================================================
{
  "components": {
    "schemas": {
      "account": {
        "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).",
        "properties": {
          "business_profile": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/account_business_profile"
              }
            ],
            "description": "Business information about the account.",
            "nullable": true
          },
          "business_type": {
            "description": "The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
            "enum": [
              "company",
              "government_entity",
              "individual",
              "non_profit"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "capabilities": {
            "$ref": "#/components/schemas/account_capabilities"
          },
          "charges_enabled": {
            "description": "Whether the account can process charges.",
            "type": "boolean"
          },
          "company": {
            "$ref": "#/components/schemas/legal_entity_company"
          },
          "controller": {
            "$ref": "#/components/schemas/account_unification_account_controller"
          },
          "country": {
            "description": "The account's country.",
            "maxLength": 5000,
            "type": "string"
          },
          "created": {
            "description": "Time at which the account was connected. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "default_currency": {
            "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).",
            "maxLength": 5000,
            "type": "string"
          },
          "details_submitted": {
            "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.",
            "type": "boolean"
          },
          "email": {
            "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "external_accounts": {
            "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.",
            "properties": {
              "data": {
                "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.",
                "items": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/bank_account"
                    },
                    {
                      "$ref": "#/components/schemas/card"
                    }
                  ],
                  "title": "Polymorphic",
                  "x-stripeBypassValidation": true
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "ExternalAccountList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "future_requirements": {
            "$ref": "#/components/schemas/account_future_requirements"
          },
          "groups": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/account_group_membership"
              }
            ],
            "description": "The groups associated with the account.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "individual": {
            "$ref": "#/components/schemas/person"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["account"],
            "type": "string"
          },
          "payouts_enabled": {
            "description": "Whether the funds in this account can be paid out.",
            "type": "boolean"
          },
          "requirements": {
            "$ref": "#/components/schemas/account_requirements"
          },
          "settings": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/account_settings"
              }
            ],
            "description": "Options for customizing how the account functions within Stripe.",
            "nullable": true
          },
          "tos_acceptance": {
            "$ref": "#/components/schemas/account_tos_acceptance"
          },
          "type": {
            "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.",
            "enum": ["custom", "express", "none", "standard"],
            "type": "string"
          }
        },
        "required": ["id", "object"],
        "title": "Account",
        "type": "object",
        "x-expandableFields": [
          "business_profile",
          "capabilities",
          "company",
          "controller",
          "external_accounts",
          "future_requirements",
          "groups",
          "individual",
          "requirements",
          "settings",
          "tos_acceptance"
        ],
        "x-resourceId": "account"
      },
      "account_annual_revenue": {
        "description": "",
        "properties": {
          "amount": {
            "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).",
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "fiscal_year_end": {
            "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountAnnualRevenue",
        "type": "object",
        "x-expandableFields": []
      },
      "account_bacs_debit_payments_settings": {
        "description": "",
        "properties": {
          "display_name": {
            "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "service_user_number": {
            "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountBacsDebitPaymentsSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "account_branding_settings": {
        "description": "",
        "properties": {
          "icon": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "logo": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "primary_color": {
            "description": "A CSS hex color value representing the primary branding color for this account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "secondary_color": {
            "description": "A CSS hex color value representing the secondary branding color for this account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountBrandingSettings",
        "type": "object",
        "x-expandableFields": ["icon", "logo"]
      },
      "account_business_profile": {
        "description": "",
        "properties": {
          "annual_revenue": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/account_annual_revenue"
              }
            ],
            "description": "The applicant's gross annual revenue for its preceding fiscal year.",
            "nullable": true
          },
          "estimated_worker_count": {
            "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.",
            "nullable": true,
            "type": "integer"
          },
          "mcc": {
            "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "monthly_estimated_revenue": {
            "$ref": "#/components/schemas/account_monthly_estimated_revenue"
          },
          "name": {
            "description": "The customer-facing business name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.",
            "maxLength": 40000,
            "nullable": true,
            "type": "string"
          },
          "support_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "A publicly available mailing address for sending support issues to.",
            "nullable": true
          },
          "support_email": {
            "description": "A publicly available email address for sending support issues to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "support_phone": {
            "description": "A publicly available phone number to call with support issues.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "support_url": {
            "description": "A publicly available website for handling support issues.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The business's publicly available website.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountBusinessProfile",
        "type": "object",
        "x-expandableFields": [
          "annual_revenue",
          "monthly_estimated_revenue",
          "support_address"
        ]
      },
      "account_capabilities": {
        "description": "",
        "properties": {
          "acss_debit_payments": {
            "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "affirm_payments": {
            "description": "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "afterpay_clearpay_payments": {
            "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "alma_payments": {
            "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "amazon_pay_payments": {
            "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "au_becs_debit_payments": {
            "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "bacs_debit_payments": {
            "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "bancontact_payments": {
            "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "bank_transfer_payments": {
            "description": "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "blik_payments": {
            "description": "The status of the blik payments capability of the account, or whether the account can directly process blik charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "boleto_payments": {
            "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "card_issuing": {
            "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "card_payments": {
            "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "cartes_bancaires_payments": {
            "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "cashapp_payments": {
            "description": "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "eps_payments": {
            "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "fpx_payments": {
            "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "gb_bank_transfer_payments": {
            "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "giropay_payments": {
            "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "grabpay_payments": {
            "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "ideal_payments": {
            "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "india_international_payments": {
            "description": "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "jcb_payments": {
            "description": "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "jp_bank_transfer_payments": {
            "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "kakao_pay_payments": {
            "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "klarna_payments": {
            "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "konbini_payments": {
            "description": "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "kr_card_payments": {
            "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "legacy_payments": {
            "description": "The status of the legacy payments capability of the account.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "link_payments": {
            "description": "The status of the link_payments capability of the account, or whether the account can directly process Link charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "mobilepay_payments": {
            "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "multibanco_payments": {
            "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "mx_bank_transfer_payments": {
            "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "naver_pay_payments": {
            "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "oxxo_payments": {
            "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "p24_payments": {
            "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "pay_by_bank_payments": {
            "description": "The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "payco_payments": {
            "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "paynow_payments": {
            "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "promptpay_payments": {
            "description": "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "revolut_pay_payments": {
            "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "samsung_pay_payments": {
            "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "sepa_bank_transfer_payments": {
            "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "sepa_debit_payments": {
            "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "sofort_payments": {
            "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "swish_payments": {
            "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "tax_reporting_us_1099_k": {
            "description": "The status of the tax reporting 1099-K (US) capability of the account.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "tax_reporting_us_1099_misc": {
            "description": "The status of the tax reporting 1099-MISC (US) capability of the account.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "transfers": {
            "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "treasury": {
            "description": "The status of the banking capability, or whether the account can have bank accounts.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "twint_payments": {
            "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "us_bank_account_ach_payments": {
            "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "us_bank_transfer_payments": {
            "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "zip_payments": {
            "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          }
        },
        "title": "AccountCapabilities",
        "type": "object",
        "x-expandableFields": []
      },
      "account_capability_future_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "current_deadline": {
            "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "disabled_reason": {
            "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.",
            "enum": [
              "other",
              "paused.inactivity",
              "pending.onboarding",
              "pending.review",
              "platform_disabled",
              "platform_paused",
              "rejected.inactivity",
              "rejected.other",
              "rejected.unsupported_business",
              "requirements.fields_needed"
            ],
            "nullable": true,
            "type": "string"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "currently_due",
          "errors",
          "eventually_due",
          "past_due",
          "pending_verification"
        ],
        "title": "AccountCapabilityFutureRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "account_capability_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "current_deadline": {
            "description": "Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "disabled_reason": {
            "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).",
            "enum": [
              "other",
              "paused.inactivity",
              "pending.onboarding",
              "pending.review",
              "platform_disabled",
              "platform_paused",
              "rejected.inactivity",
              "rejected.other",
              "rejected.unsupported_business",
              "requirements.fields_needed"
            ],
            "nullable": true,
            "type": "string"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "currently_due",
          "errors",
          "eventually_due",
          "past_due",
          "pending_verification"
        ],
        "title": "AccountCapabilityRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "account_card_issuing_settings": {
        "description": "",
        "properties": {
          "tos_acceptance": {
            "$ref": "#/components/schemas/card_issuing_account_terms_of_service"
          }
        },
        "title": "AccountCardIssuingSettings",
        "type": "object",
        "x-expandableFields": ["tos_acceptance"]
      },
      "account_card_payments_settings": {
        "description": "",
        "properties": {
          "decline_on": {
            "$ref": "#/components/schemas/account_decline_charge_on"
          },
          "statement_descriptor_prefix": {
            "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_prefix_kana": {
            "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_prefix_kanji": {
            "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountCardPaymentsSettings",
        "type": "object",
        "x-expandableFields": ["decline_on"]
      },
      "account_dashboard_settings": {
        "description": "",
        "properties": {
          "display_name": {
            "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "timezone": {
            "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountDashboardSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "account_decline_charge_on": {
        "description": "",
        "properties": {
          "avs_failure": {
            "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.",
            "type": "boolean"
          },
          "cvc_failure": {
            "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.",
            "type": "boolean"
          }
        },
        "required": ["avs_failure", "cvc_failure"],
        "title": "AccountDeclineChargeOn",
        "type": "object",
        "x-expandableFields": []
      },
      "account_future_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "current_deadline": {
            "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "disabled_reason": {
            "description": "This is typed as an enum for consistency with `requirements.disabled_reason`.",
            "enum": [
              "action_required.requested_capabilities",
              "listed",
              "other",
              "platform_paused",
              "rejected.fraud",
              "rejected.incomplete_verification",
              "rejected.listed",
              "rejected.other",
              "rejected.platform_fraud",
              "rejected.platform_other",
              "rejected.platform_terms_of_service",
              "rejected.terms_of_service",
              "requirements.past_due",
              "requirements.pending_verification",
              "under_review"
            ],
            "nullable": true,
            "type": "string"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "nullable": true,
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "AccountFutureRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "account_group_membership": {
        "description": "",
        "properties": {
          "payments_pricing": {
            "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountGroupMembership",
        "type": "object",
        "x-expandableFields": []
      },
      "account_invoices_settings": {
        "description": "",
        "properties": {
          "default_account_tax_ids": {
            "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "AccountInvoicesSettings",
        "type": "object",
        "x-expandableFields": ["default_account_tax_ids"]
      },
      "account_link": {
        "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expires_at": {
            "description": "The timestamp at which this account link will expire.",
            "format": "unix-time",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["account_link"],
            "type": "string"
          },
          "url": {
            "description": "The URL for the account link.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["created", "expires_at", "object", "url"],
        "title": "AccountLink",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "account_link"
      },
      "account_monthly_estimated_revenue": {
        "description": "",
        "properties": {
          "amount": {
            "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          }
        },
        "required": ["amount", "currency"],
        "title": "AccountMonthlyEstimatedRevenue",
        "type": "object",
        "x-expandableFields": []
      },
      "account_payments_settings": {
        "description": "",
        "properties": {
          "statement_descriptor": {
            "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_kana": {
            "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_kanji": {
            "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountPaymentsSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "account_payout_settings": {
        "description": "",
        "properties": {
          "debit_negative_balances": {
            "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.",
            "type": "boolean"
          },
          "schedule": {
            "$ref": "#/components/schemas/transfer_schedule"
          },
          "statement_descriptor": {
            "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["debit_negative_balances", "schedule"],
        "title": "AccountPayoutSettings",
        "type": "object",
        "x-expandableFields": ["schedule"]
      },
      "account_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "current_deadline": {
            "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "disabled_reason": {
            "description": "If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).",
            "enum": [
              "action_required.requested_capabilities",
              "listed",
              "other",
              "platform_paused",
              "rejected.fraud",
              "rejected.incomplete_verification",
              "rejected.listed",
              "rejected.other",
              "rejected.platform_fraud",
              "rejected.platform_other",
              "rejected.platform_terms_of_service",
              "rejected.terms_of_service",
              "requirements.past_due",
              "requirements.pending_verification",
              "under_review"
            ],
            "nullable": true,
            "type": "string"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "nullable": true,
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "AccountRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "account_requirements_alternative": {
        "description": "",
        "properties": {
          "alternative_fields_due": {
            "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "original_fields_due": {
            "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["alternative_fields_due", "original_fields_due"],
        "title": "AccountRequirementsAlternative",
        "type": "object",
        "x-expandableFields": []
      },
      "account_requirements_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "The code for the type of error.",
            "enum": [
              "invalid_address_city_state_postal_code",
              "invalid_address_highway_contract_box",
              "invalid_address_private_mailbox",
              "invalid_business_profile_name",
              "invalid_business_profile_name_denylisted",
              "invalid_company_name_denylisted",
              "invalid_dob_age_over_maximum",
              "invalid_dob_age_under_18",
              "invalid_dob_age_under_minimum",
              "invalid_product_description_length",
              "invalid_product_description_url_match",
              "invalid_representative_country",
              "invalid_statement_descriptor_business_mismatch",
              "invalid_statement_descriptor_denylisted",
              "invalid_statement_descriptor_length",
              "invalid_statement_descriptor_prefix_denylisted",
              "invalid_statement_descriptor_prefix_mismatch",
              "invalid_street_address",
              "invalid_tax_id",
              "invalid_tax_id_format",
              "invalid_tos_acceptance",
              "invalid_url_denylisted",
              "invalid_url_format",
              "invalid_url_web_presence_detected",
              "invalid_url_website_business_information_mismatch",
              "invalid_url_website_empty",
              "invalid_url_website_inaccessible",
              "invalid_url_website_inaccessible_geoblocked",
              "invalid_url_website_inaccessible_password_protected",
              "invalid_url_website_incomplete",
              "invalid_url_website_incomplete_cancellation_policy",
              "invalid_url_website_incomplete_customer_service_details",
              "invalid_url_website_incomplete_legal_restrictions",
              "invalid_url_website_incomplete_refund_policy",
              "invalid_url_website_incomplete_return_policy",
              "invalid_url_website_incomplete_terms_and_conditions",
              "invalid_url_website_incomplete_under_construction",
              "invalid_url_website_other",
              "invalid_value_other",
              "verification_directors_mismatch",
              "verification_document_address_mismatch",
              "verification_document_address_missing",
              "verification_document_corrupt",
              "verification_document_country_not_supported",
              "verification_document_directors_mismatch",
              "verification_document_dob_mismatch",
              "verification_document_duplicate_type",
              "verification_document_expired",
              "verification_document_failed_copy",
              "verification_document_failed_greyscale",
              "verification_document_failed_other",
              "verification_document_failed_test_mode",
              "verification_document_fraudulent",
              "verification_document_id_number_mismatch",
              "verification_document_id_number_missing",
              "verification_document_incomplete",
              "verification_document_invalid",
              "verification_document_issue_or_expiry_date_missing",
              "verification_document_manipulated",
              "verification_document_missing_back",
              "verification_document_missing_front",
              "verification_document_name_mismatch",
              "verification_document_name_missing",
              "verification_document_nationality_mismatch",
              "verification_document_not_readable",
              "verification_document_not_signed",
              "verification_document_not_uploaded",
              "verification_document_photo_mismatch",
              "verification_document_too_large",
              "verification_document_type_not_supported",
              "verification_extraneous_directors",
              "verification_failed_address_match",
              "verification_failed_business_iec_number",
              "verification_failed_document_match",
              "verification_failed_id_number_match",
              "verification_failed_keyed_identity",
              "verification_failed_keyed_match",
              "verification_failed_name_match",
              "verification_failed_other",
              "verification_failed_representative_authority",
              "verification_failed_residential_address",
              "verification_failed_tax_id_match",
              "verification_failed_tax_id_not_issued",
              "verification_missing_directors",
              "verification_missing_executives",
              "verification_missing_owners",
              "verification_requires_additional_memorandum_of_associations",
              "verification_requires_additional_proof_of_registration",
              "verification_supportability"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "reason": {
            "description": "An informative message that indicates the error type and provides additional details about the error.",
            "maxLength": 5000,
            "type": "string"
          },
          "requirement": {
            "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["code", "reason", "requirement"],
        "title": "AccountRequirementsError",
        "type": "object",
        "x-expandableFields": []
      },
      "account_sepa_debit_payments_settings": {
        "description": "",
        "properties": {
          "creditor_id": {
            "description": "SEPA creditor identifier that identifies the company making the payment.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "AccountSepaDebitPaymentsSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "account_session": {
        "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)",
        "properties": {
          "account": {
            "description": "The ID of the account the AccountSession was created for",
            "maxLength": 5000,
            "type": "string"
          },
          "client_secret": {
            "description": "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.",
            "maxLength": 5000,
            "type": "string"
          },
          "components": {
            "$ref": "#/components/schemas/connect_embedded_account_session_create_components"
          },
          "expires_at": {
            "description": "The timestamp at which this AccountSession will expire.",
            "format": "unix-time",
            "type": "integer"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["account_session"],
            "type": "string"
          }
        },
        "required": [
          "account",
          "client_secret",
          "components",
          "expires_at",
          "livemode",
          "object"
        ],
        "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession",
        "type": "object",
        "x-expandableFields": ["components"],
        "x-resourceId": "account_session"
      },
      "account_settings": {
        "description": "",
        "properties": {
          "bacs_debit_payments": {
            "$ref": "#/components/schemas/account_bacs_debit_payments_settings"
          },
          "branding": {
            "$ref": "#/components/schemas/account_branding_settings"
          },
          "card_issuing": {
            "$ref": "#/components/schemas/account_card_issuing_settings"
          },
          "card_payments": {
            "$ref": "#/components/schemas/account_card_payments_settings"
          },
          "dashboard": {
            "$ref": "#/components/schemas/account_dashboard_settings"
          },
          "invoices": {
            "$ref": "#/components/schemas/account_invoices_settings"
          },
          "payments": {
            "$ref": "#/components/schemas/account_payments_settings"
          },
          "payouts": {
            "$ref": "#/components/schemas/account_payout_settings"
          },
          "sepa_debit_payments": {
            "$ref": "#/components/schemas/account_sepa_debit_payments_settings"
          },
          "treasury": {
            "$ref": "#/components/schemas/account_treasury_settings"
          }
        },
        "required": ["branding", "card_payments", "dashboard", "payments"],
        "title": "AccountSettings",
        "type": "object",
        "x-expandableFields": [
          "bacs_debit_payments",
          "branding",
          "card_issuing",
          "card_payments",
          "dashboard",
          "invoices",
          "payments",
          "payouts",
          "sepa_debit_payments",
          "treasury"
        ]
      },
      "account_terms_of_service": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the account representative accepted the service agreement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the account representative accepted the service agreement.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "AccountTermsOfService",
        "type": "object",
        "x-expandableFields": []
      },
      "account_tos_acceptance": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the account representative accepted their service agreement",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the account representative accepted their service agreement",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "service_agreement": {
            "description": "The user's service agreement type",
            "maxLength": 5000,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the account representative accepted their service agreement",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "AccountTOSAcceptance",
        "type": "object",
        "x-expandableFields": []
      },
      "account_treasury_settings": {
        "description": "",
        "properties": {
          "tos_acceptance": {
            "$ref": "#/components/schemas/account_terms_of_service"
          }
        },
        "title": "AccountTreasurySettings",
        "type": "object",
        "x-expandableFields": ["tos_acceptance"]
      },
      "account_unification_account_controller": {
        "description": "",
        "properties": {
          "fees": {
            "$ref": "#/components/schemas/account_unification_account_controller_fees"
          },
          "is_controller": {
            "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.",
            "type": "boolean"
          },
          "losses": {
            "$ref": "#/components/schemas/account_unification_account_controller_losses"
          },
          "requirement_collection": {
            "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.",
            "enum": ["application", "stripe"],
            "type": "string"
          },
          "stripe_dashboard": {
            "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard"
          },
          "type": {
            "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.",
            "enum": ["account", "application"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "AccountUnificationAccountController",
        "type": "object",
        "x-expandableFields": ["fees", "losses", "stripe_dashboard"]
      },
      "account_unification_account_controller_fees": {
        "description": "",
        "properties": {
          "payer": {
            "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).",
            "enum": [
              "account",
              "application",
              "application_custom",
              "application_express"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["payer"],
        "title": "AccountUnificationAccountControllerFees",
        "type": "object",
        "x-expandableFields": []
      },
      "account_unification_account_controller_losses": {
        "description": "",
        "properties": {
          "payments": {
            "description": "A value indicating who is liable when this account can't pay back negative balances from payments.",
            "enum": ["application", "stripe"],
            "type": "string"
          }
        },
        "required": ["payments"],
        "title": "AccountUnificationAccountControllerLosses",
        "type": "object",
        "x-expandableFields": []
      },
      "account_unification_account_controller_stripe_dashboard": {
        "description": "",
        "properties": {
          "type": {
            "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application.",
            "enum": ["express", "full", "none"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "AccountUnificationAccountControllerStripeDashboard",
        "type": "object",
        "x-expandableFields": []
      },
      "address": {
        "description": "",
        "properties": {
          "city": {
            "description": "City, district, suburb, town, or village.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line1": {
            "description": "Address line 1 (e.g., street, PO Box, or company name).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line2": {
            "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "postal_code": {
            "description": "ZIP or postal code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "State, county, province, or region.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Address",
        "type": "object",
        "x-expandableFields": []
      },
      "amazon_pay_underlying_payment_method_funding_details": {
        "description": "",
        "properties": {
          "card": {
            "$ref": "#/components/schemas/payment_method_details_passthrough_card"
          },
          "type": {
            "description": "funding type of the underlying payment method.",
            "enum": ["card"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "amazon_pay_underlying_payment_method_funding_details",
        "type": "object",
        "x-expandableFields": ["card"]
      },
      "api_errors": {
        "description": "",
        "properties": {
          "advice_code": {
            "description": "For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.",
            "maxLength": 5000,
            "type": "string"
          },
          "charge": {
            "description": "For card errors, the ID of the failed charge.",
            "maxLength": 5000,
            "type": "string"
          },
          "code": {
            "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.",
            "maxLength": 5000,
            "type": "string"
          },
          "decline_code": {
            "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.",
            "maxLength": 5000,
            "type": "string"
          },
          "doc_url": {
            "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.",
            "maxLength": 5000,
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.",
            "maxLength": 40000,
            "type": "string"
          },
          "network_advice_code": {
            "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.",
            "maxLength": 5000,
            "type": "string"
          },
          "network_decline_code": {
            "description": "For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.",
            "maxLength": 5000,
            "type": "string"
          },
          "param": {
            "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_intent": {
            "$ref": "#/components/schemas/payment_intent"
          },
          "payment_method": {
            "$ref": "#/components/schemas/payment_method"
          },
          "payment_method_type": {
            "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.",
            "maxLength": 5000,
            "type": "string"
          },
          "request_log_url": {
            "description": "A URL to the request log entry in your dashboard.",
            "maxLength": 5000,
            "type": "string"
          },
          "setup_intent": {
            "$ref": "#/components/schemas/setup_intent"
          },
          "source": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "description": "The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source.",
            "x-stripeBypassValidation": true
          },
          "type": {
            "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`",
            "enum": [
              "api_error",
              "card_error",
              "idempotency_error",
              "invalid_request_error"
            ],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "APIErrors",
        "type": "object",
        "x-expandableFields": [
          "payment_intent",
          "payment_method",
          "setup_intent",
          "source"
        ]
      },
      "apple_pay_domain": {
        "description": "",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "domain_name": {
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["apple_pay_domain"],
            "type": "string"
          }
        },
        "required": ["created", "domain_name", "id", "livemode", "object"],
        "title": "ApplePayDomain",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "apple_pay_domain"
      },
      "application": {
        "description": "",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "The name of the application.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["application"],
            "type": "string"
          }
        },
        "required": ["id", "object"],
        "title": "Application",
        "type": "object",
        "x-expandableFields": []
      },
      "application_fee": {
        "description": "",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "ID of the Stripe account this fee was taken from.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "amount": {
            "description": "Amount earned, in cents (or local equivalent).",
            "type": "integer"
          },
          "amount_refunded": {
            "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)",
            "type": "integer"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "ID of the Connect application that earned the fee.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the charge that the application fee was taken from.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "fee_source": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/platform_earning_fee_source"
              }
            ],
            "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["application_fee"],
            "type": "string"
          },
          "originating_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "refunded": {
            "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.",
            "type": "boolean"
          },
          "refunds": {
            "description": "A list of refunds that have been applied to the fee.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/fee_refund"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "FeeRefundList",
            "type": "object",
            "x-expandableFields": ["data"]
          }
        },
        "required": [
          "account",
          "amount",
          "amount_refunded",
          "application",
          "charge",
          "created",
          "currency",
          "id",
          "livemode",
          "object",
          "refunded",
          "refunds"
        ],
        "title": "PlatformFee",
        "type": "object",
        "x-expandableFields": [
          "account",
          "application",
          "balance_transaction",
          "charge",
          "fee_source",
          "originating_transaction",
          "refunds"
        ],
        "x-resourceId": "application_fee"
      },
      "apps.secret": {
        "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "deleted": {
            "description": "If true, indicates that this secret has been deleted",
            "type": "boolean"
          },
          "expires_at": {
            "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "name": {
            "description": "A name for the secret that's unique within the scope.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["apps.secret"],
            "type": "string"
          },
          "payload": {
            "description": "The plaintext secret value to be stored.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "scope": {
            "$ref": "#/components/schemas/secret_service_resource_scope"
          }
        },
        "required": ["created", "id", "livemode", "name", "object", "scope"],
        "title": "SecretServiceResourceSecret",
        "type": "object",
        "x-expandableFields": ["scope"],
        "x-resourceId": "apps.secret"
      },
      "automatic_tax": {
        "description": "",
        "properties": {
          "disabled_reason": {
            "description": "If Stripe disabled automatic tax, this enum describes why.",
            "enum": [
              "finalization_requires_location_inputs",
              "finalization_system_error"
            ],
            "nullable": true,
            "type": "string"
          },
          "enabled": {
            "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          },
          "status": {
            "description": "The status of the most recent automated tax calculation for this invoice.",
            "enum": ["complete", "failed", "requires_location_inputs"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["enabled"],
        "title": "AutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "balance": {
        "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)",
        "properties": {
          "available": {
            "description": "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.",
            "items": {
              "$ref": "#/components/schemas/balance_amount"
            },
            "type": "array"
          },
          "connect_reserved": {
            "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.",
            "items": {
              "$ref": "#/components/schemas/balance_amount"
            },
            "type": "array"
          },
          "instant_available": {
            "description": "Funds that you can pay out using Instant Payouts.",
            "items": {
              "$ref": "#/components/schemas/balance_amount_net"
            },
            "type": "array"
          },
          "issuing": {
            "$ref": "#/components/schemas/balance_detail"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["balance"],
            "type": "string"
          },
          "pending": {
            "description": "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.",
            "items": {
              "$ref": "#/components/schemas/balance_amount"
            },
            "type": "array"
          }
        },
        "required": ["available", "livemode", "object", "pending"],
        "title": "Balance",
        "type": "object",
        "x-expandableFields": [
          "available",
          "connect_reserved",
          "instant_available",
          "issuing",
          "pending"
        ],
        "x-resourceId": "balance"
      },
      "balance_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Balance amount.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "source_types": {
            "$ref": "#/components/schemas/balance_amount_by_source_type"
          }
        },
        "required": ["amount", "currency"],
        "title": "BalanceAmount",
        "type": "object",
        "x-expandableFields": ["source_types"]
      },
      "balance_amount_by_source_type": {
        "description": "",
        "properties": {
          "bank_account": {
            "description": "Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).",
            "type": "integer"
          },
          "card": {
            "description": "Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).",
            "type": "integer"
          },
          "fpx": {
            "description": "Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.",
            "type": "integer"
          }
        },
        "title": "BalanceAmountBySourceType",
        "type": "object",
        "x-expandableFields": []
      },
      "balance_amount_net": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Balance amount.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "net_available": {
            "description": "Breakdown of balance by destination.",
            "items": {
              "$ref": "#/components/schemas/balance_net_available"
            },
            "type": "array"
          },
          "source_types": {
            "$ref": "#/components/schemas/balance_amount_by_source_type"
          }
        },
        "required": ["amount", "currency"],
        "title": "BalanceAmountNet",
        "type": "object",
        "x-expandableFields": ["net_available", "source_types"]
      },
      "balance_detail": {
        "description": "",
        "properties": {
          "available": {
            "description": "Funds that are available for use.",
            "items": {
              "$ref": "#/components/schemas/balance_amount"
            },
            "type": "array"
          }
        },
        "required": ["available"],
        "title": "BalanceDetail",
        "type": "object",
        "x-expandableFields": ["available"]
      },
      "balance_net_available": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Net balance amount, subtracting fees from platform-set pricing.",
            "type": "integer"
          },
          "destination": {
            "description": "ID of the external account for this net balance (not expandable).",
            "maxLength": 5000,
            "type": "string"
          },
          "source_types": {
            "$ref": "#/components/schemas/balance_amount_by_source_type"
          }
        },
        "required": ["amount", "destination"],
        "title": "BalanceNetAvailable",
        "type": "object",
        "x-expandableFields": ["source_types"]
      },
      "balance_transaction": {
        "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)",
        "properties": {
          "amount": {
            "description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.",
            "type": "integer"
          },
          "available_on": {
            "description": "The date that the transaction's net funds become available in the Stripe balance.",
            "format": "unix-time",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exchange_rate": {
            "description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.",
            "nullable": true,
            "type": "number"
          },
          "fee": {
            "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.",
            "type": "integer"
          },
          "fee_details": {
            "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.",
            "items": {
              "$ref": "#/components/schemas/fee"
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "net": {
            "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["balance_transaction"],
            "type": "string"
          },
          "reporting_category": {
            "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.",
            "maxLength": 5000,
            "type": "string"
          },
          "source": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application_fee"
              },
              {
                "$ref": "#/components/schemas/charge"
              },
              {
                "$ref": "#/components/schemas/connect_collection_transfer"
              },
              {
                "$ref": "#/components/schemas/customer_cash_balance_transaction"
              },
              {
                "$ref": "#/components/schemas/dispute"
              },
              {
                "$ref": "#/components/schemas/fee_refund"
              },
              {
                "$ref": "#/components/schemas/issuing.authorization"
              },
              {
                "$ref": "#/components/schemas/issuing.dispute"
              },
              {
                "$ref": "#/components/schemas/issuing.transaction"
              },
              {
                "$ref": "#/components/schemas/payout"
              },
              {
                "$ref": "#/components/schemas/refund"
              },
              {
                "$ref": "#/components/schemas/reserve_transaction"
              },
              {
                "$ref": "#/components/schemas/tax_deducted_at_source"
              },
              {
                "$ref": "#/components/schemas/topup"
              },
              {
                "$ref": "#/components/schemas/transfer"
              },
              {
                "$ref": "#/components/schemas/transfer_reversal"
              }
            ],
            "description": "This transaction relates to the Stripe object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application_fee"
                },
                {
                  "$ref": "#/components/schemas/charge"
                },
                {
                  "$ref": "#/components/schemas/connect_collection_transfer"
                },
                {
                  "$ref": "#/components/schemas/customer_cash_balance_transaction"
                },
                {
                  "$ref": "#/components/schemas/dispute"
                },
                {
                  "$ref": "#/components/schemas/fee_refund"
                },
                {
                  "$ref": "#/components/schemas/issuing.authorization"
                },
                {
                  "$ref": "#/components/schemas/issuing.dispute"
                },
                {
                  "$ref": "#/components/schemas/issuing.transaction"
                },
                {
                  "$ref": "#/components/schemas/payout"
                },
                {
                  "$ref": "#/components/schemas/refund"
                },
                {
                  "$ref": "#/components/schemas/reserve_transaction"
                },
                {
                  "$ref": "#/components/schemas/tax_deducted_at_source"
                },
                {
                  "$ref": "#/components/schemas/topup"
                },
                {
                  "$ref": "#/components/schemas/transfer"
                },
                {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              ]
            },
            "x-stripeBypassValidation": true
          },
          "status": {
            "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
            "enum": [
              "adjustment",
              "advance",
              "advance_funding",
              "anticipation_repayment",
              "application_fee",
              "application_fee_refund",
              "charge",
              "climate_order_purchase",
              "climate_order_refund",
              "connect_collection_transfer",
              "contribution",
              "issuing_authorization_hold",
              "issuing_authorization_release",
              "issuing_dispute",
              "issuing_transaction",
              "obligation_outbound",
              "obligation_reversal_inbound",
              "payment",
              "payment_failure_refund",
              "payment_network_reserve_hold",
              "payment_network_reserve_release",
              "payment_refund",
              "payment_reversal",
              "payment_unreconciled",
              "payout",
              "payout_cancel",
              "payout_failure",
              "payout_minimum_balance_hold",
              "payout_minimum_balance_release",
              "refund",
              "refund_failure",
              "reserve_transaction",
              "reserved_funds",
              "stripe_fee",
              "stripe_fx_fee",
              "tax_fee",
              "topup",
              "topup_reversal",
              "transfer",
              "transfer_cancel",
              "transfer_failure",
              "transfer_refund"
            ],
            "type": "string"
          }
        },
        "required": [
          "amount",
          "available_on",
          "created",
          "currency",
          "fee",
          "fee_details",
          "id",
          "net",
          "object",
          "reporting_category",
          "status",
          "type"
        ],
        "title": "BalanceTransaction",
        "type": "object",
        "x-expandableFields": ["fee_details", "source"],
        "x-resourceId": "balance_transaction"
      },
      "bank_account": {
        "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The ID of the account that the bank account is associated with.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "account_holder_name": {
            "description": "The name of the person or business that owns the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_holder_type": {
            "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "available_payout_methods": {
            "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.",
            "items": {
              "enum": ["instant", "standard"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "bank_name": {
            "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "type": "string"
          },
          "currency": {
            "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer that the bank account is associated with.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "default_for_currency": {
            "description": "Whether this bank account is the default external account for its currency.",
            "nullable": true,
            "type": "boolean"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "future_requirements": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/external_account_requirements"
              }
            ],
            "description": "Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the bank account number.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["bank_account"],
            "type": "string"
          },
          "requirements": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/external_account_requirements"
              }
            ],
            "description": "Information about the requirements for the bank account, including what information needs to be collected.",
            "nullable": true
          },
          "routing_number": {
            "description": "The routing transit number for the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["country", "currency", "id", "last4", "object", "status"],
        "title": "BankAccount",
        "type": "object",
        "x-expandableFields": [
          "account",
          "customer",
          "future_requirements",
          "requirements"
        ],
        "x-resourceId": "bank_account"
      },
      "bank_connections_resource_accountholder": {
        "description": "",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "type": {
            "description": "Type of account holder that this account belongs to.",
            "enum": ["account", "customer"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "BankConnectionsResourceAccountholder",
        "type": "object",
        "x-expandableFields": ["account", "customer"]
      },
      "bank_connections_resource_balance": {
        "description": "",
        "properties": {
          "as_of": {
            "description": "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "cash": {
            "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance"
          },
          "credit": {
            "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance"
          },
          "current": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
            "type": "object"
          },
          "type": {
            "description": "The `type` of the balance. An additional hash is included on the balance with a name matching this value.",
            "enum": ["cash", "credit"],
            "type": "string"
          }
        },
        "required": ["as_of", "current", "type"],
        "title": "BankConnectionsResourceBalance",
        "type": "object",
        "x-expandableFields": ["cash", "credit"]
      },
      "bank_connections_resource_balance_api_resource_cash_balance": {
        "description": "",
        "properties": {
          "available": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
            "nullable": true,
            "type": "object"
          }
        },
        "title": "BankConnectionsResourceBalanceAPIResourceCashBalance",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_balance_api_resource_credit_balance": {
        "description": "",
        "properties": {
          "used": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
            "nullable": true,
            "type": "object"
          }
        },
        "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_balance_refresh": {
        "description": "",
        "properties": {
          "last_attempted_at": {
            "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "next_refresh_available_at": {
            "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "description": "The status of the last refresh attempt.",
            "enum": ["failed", "pending", "succeeded"],
            "type": "string"
          }
        },
        "required": ["last_attempted_at", "status"],
        "title": "BankConnectionsResourceBalanceRefresh",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_link_account_session_filters": {
        "description": "",
        "properties": {
          "account_subcategories": {
            "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.",
            "items": {
              "enum": [
                "checking",
                "credit_card",
                "line_of_credit",
                "mortgage",
                "savings"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "countries": {
            "description": "List of countries from which to filter accounts.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "BankConnectionsResourceLinkAccountSessionFilters",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_ownership_refresh": {
        "description": "",
        "properties": {
          "last_attempted_at": {
            "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "next_refresh_available_at": {
            "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "description": "The status of the last refresh attempt.",
            "enum": ["failed", "pending", "succeeded"],
            "type": "string"
          }
        },
        "required": ["last_attempted_at", "status"],
        "title": "BankConnectionsResourceOwnershipRefresh",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_transaction_refresh": {
        "description": "",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last_attempted_at": {
            "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "next_refresh_available_at": {
            "description": "Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "description": "The status of the last refresh attempt.",
            "enum": ["failed", "pending", "succeeded"],
            "type": "string"
          }
        },
        "required": ["id", "last_attempted_at", "status"],
        "title": "BankConnectionsResourceTransactionRefresh",
        "type": "object",
        "x-expandableFields": []
      },
      "bank_connections_resource_transaction_resource_status_transitions": {
        "description": "",
        "properties": {
          "posted_at": {
            "description": "Time at which this transaction posted. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "void_at": {
            "description": "Time at which this transaction was voided. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "BankConnectionsResourceTransactionResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "billing.alert": {
        "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.",
        "properties": {
          "alert_type": {
            "description": "Defines the type of the alert.",
            "enum": ["usage_threshold"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.alert"],
            "type": "string"
          },
          "status": {
            "description": "Status of the alert. This can be active, inactive or archived.",
            "enum": ["active", "archived", "inactive"],
            "nullable": true,
            "type": "string"
          },
          "title": {
            "description": "Title of the alert.",
            "maxLength": 5000,
            "type": "string"
          },
          "usage_threshold": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config"
              }
            ],
            "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).",
            "nullable": true
          }
        },
        "required": ["alert_type", "id", "livemode", "object", "title"],
        "title": "ThresholdsResourceAlert",
        "type": "object",
        "x-expandableFields": ["usage_threshold"],
        "x-resourceId": "billing.alert"
      },
      "billing.credit_balance_summary": {
        "description": "Indicates the billing credit balance for billing credits granted to a customer.",
        "properties": {
          "balances": {
            "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.",
            "items": {
              "$ref": "#/components/schemas/credit_balance"
            },
            "type": "array"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The customer the balance is for.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.credit_balance_summary"],
            "type": "string"
          }
        },
        "required": ["balances", "customer", "livemode", "object"],
        "title": "CreditBalanceSummary",
        "type": "object",
        "x-expandableFields": ["balances", "customer"],
        "x-resourceId": "billing.credit_balance_summary"
      },
      "billing.credit_balance_transaction": {
        "description": "A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "credit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit"
              }
            ],
            "description": "Credit details for this credit balance transaction. Only present if type is `credit`.",
            "nullable": true
          },
          "credit_grant": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/billing.credit_grant"
              }
            ],
            "description": "The credit grant associated with this credit balance transaction.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              ]
            }
          },
          "debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit"
              }
            ],
            "description": "Debit details for this credit balance transaction. Only present if type is `debit`.",
            "nullable": true
          },
          "effective_at": {
            "description": "The effective time of this credit balance transaction.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.credit_balance_transaction"],
            "type": "string"
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this credit balance transaction belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "type": {
            "description": "The type of credit balance transaction (credit or debit).",
            "enum": ["credit", "debit"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "created",
          "credit_grant",
          "effective_at",
          "id",
          "livemode",
          "object"
        ],
        "title": "CreditBalanceTransaction",
        "type": "object",
        "x-expandableFields": ["credit", "credit_grant", "debit", "test_clock"],
        "x-resourceId": "billing.credit_balance_transaction"
      },
      "billing.credit_grant": {
        "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)",
        "properties": {
          "amount": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
          },
          "applicability_config": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config"
          },
          "category": {
            "description": "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.",
            "enum": ["paid", "promotional"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the customer receiving the billing credits.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "effective_at": {
            "description": "The time when the billing credits become effective-when they're eligible for use.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "description": "The time when the billing credits expire. If not present, the billing credits don't expire.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "A descriptive name shown in dashboard.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.credit_grant"],
            "type": "string"
          },
          "priority": {
            "description": "The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.",
            "nullable": true,
            "type": "integer"
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this credit grant belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "updated": {
            "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "voided_at": {
            "description": "The time when this credit grant was voided. If not present, the credit grant hasn't been voided.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "applicability_config",
          "category",
          "created",
          "customer",
          "id",
          "livemode",
          "metadata",
          "object",
          "updated"
        ],
        "title": "CreditGrant",
        "type": "object",
        "x-expandableFields": [
          "amount",
          "applicability_config",
          "customer",
          "test_clock"
        ],
        "x-resourceId": "billing.credit_grant"
      },
      "billing.meter": {
        "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer_mapping": {
            "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings"
          },
          "default_aggregation": {
            "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings"
          },
          "display_name": {
            "description": "The meter's name.",
            "maxLength": 5000,
            "type": "string"
          },
          "event_name": {
            "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.",
            "maxLength": 5000,
            "type": "string"
          },
          "event_time_window": {
            "description": "The time window to pre-aggregate meter events for, if any.",
            "enum": ["day", "hour"],
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.meter"],
            "type": "string"
          },
          "status": {
            "description": "The meter's status.",
            "enum": ["active", "inactive"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions"
          },
          "updated": {
            "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "value_settings": {
            "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value"
          }
        },
        "required": [
          "created",
          "customer_mapping",
          "default_aggregation",
          "display_name",
          "event_name",
          "id",
          "livemode",
          "object",
          "status",
          "status_transitions",
          "updated",
          "value_settings"
        ],
        "title": "BillingMeter",
        "type": "object",
        "x-expandableFields": [
          "customer_mapping",
          "default_aggregation",
          "status_transitions",
          "value_settings"
        ],
        "x-resourceId": "billing.meter"
      },
      "billing.meter_event": {
        "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "event_name": {
            "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
            "maxLength": 100,
            "type": "string"
          },
          "identifier": {
            "description": "A unique identifier for the event.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.meter_event"],
            "type": "string"
          },
          "payload": {
            "additionalProperties": {
              "maxLength": 100,
              "type": "string"
            },
            "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).",
            "type": "object"
          },
          "timestamp": {
            "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "created",
          "event_name",
          "identifier",
          "livemode",
          "object",
          "payload",
          "timestamp"
        ],
        "title": "BillingMeterEvent",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "billing.meter_event"
      },
      "billing.meter_event_adjustment": {
        "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.",
        "properties": {
          "cancel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel"
              }
            ],
            "description": "Specifies which event to cancel.",
            "nullable": true
          },
          "event_name": {
            "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
            "maxLength": 100,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.meter_event_adjustment"],
            "type": "string"
          },
          "status": {
            "description": "The meter event adjustment's status.",
            "enum": ["complete", "pending"],
            "type": "string"
          },
          "type": {
            "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.",
            "enum": ["cancel"],
            "type": "string"
          }
        },
        "required": ["event_name", "livemode", "object", "status", "type"],
        "title": "BillingMeterEventAdjustment",
        "type": "object",
        "x-expandableFields": ["cancel"],
        "x-resourceId": "billing.meter_event_adjustment"
      },
      "billing.meter_event_summary": {
        "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.\n\nNote: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.",
        "properties": {
          "aggregated_value": {
            "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.",
            "type": "number"
          },
          "end_time": {
            "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "meter": {
            "description": "The meter associated with this event summary.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing.meter_event_summary"],
            "type": "string"
          },
          "start_time": {
            "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "aggregated_value",
          "end_time",
          "id",
          "livemode",
          "meter",
          "object",
          "start_time"
        ],
        "title": "BillingMeterEventSummary",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "billing.meter_event_summary"
      },
      "billing_clocks_resource_status_details_advancing_status_details": {
        "description": "",
        "properties": {
          "target_frozen_time": {
            "description": "The `frozen_time` that the Test Clock is advancing towards.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": ["target_frozen_time"],
        "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_clocks_resource_status_details_status_details": {
        "description": "",
        "properties": {
          "advancing": {
            "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
          }
        },
        "title": "BillingClocksResourceStatusDetailsStatusDetails",
        "type": "object",
        "x-expandableFields": ["advancing"]
      },
      "billing_credit_grants_resource_amount": {
        "description": "",
        "properties": {
          "monetary": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_credit_grants_resource_monetary_amount"
              }
            ],
            "description": "The monetary amount.",
            "nullable": true
          },
          "type": {
            "description": "The type of this amount. We currently only support `monetary` billing credits.",
            "enum": ["monetary"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "BillingCreditGrantsResourceAmount",
        "type": "object",
        "x-expandableFields": ["monetary"]
      },
      "billing_credit_grants_resource_applicability_config": {
        "description": "",
        "properties": {
          "scope": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_scope"
          }
        },
        "required": ["scope"],
        "title": "BillingCreditGrantsResourceApplicabilityConfig",
        "type": "object",
        "x-expandableFields": ["scope"]
      },
      "billing_credit_grants_resource_applicable_price": {
        "description": "",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "BillingCreditGrantsResourceApplicablePrice",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_credit_grants_resource_balance_credit": {
        "description": "",
        "properties": {
          "amount": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
          },
          "credits_application_invoice_voided": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided"
              }
            ],
            "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.",
            "nullable": true
          },
          "type": {
            "description": "The type of credit transaction.",
            "enum": ["credits_application_invoice_voided", "credits_granted"],
            "type": "string"
          }
        },
        "required": ["amount", "type"],
        "title": "BillingCreditGrantsResourceBalanceCredit",
        "type": "object",
        "x-expandableFields": ["amount", "credits_application_invoice_voided"]
      },
      "billing_credit_grants_resource_balance_credits_application_invoice_voided": {
        "description": "",
        "properties": {
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The invoice to which the reinstated billing credits were originally applied.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "invoice_line_item": {
            "description": "The invoice line item to which the reinstated billing credits were originally applied.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["invoice", "invoice_line_item"],
        "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided",
        "type": "object",
        "x-expandableFields": ["invoice"]
      },
      "billing_credit_grants_resource_balance_credits_applied": {
        "description": "",
        "properties": {
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The invoice to which the billing credits were applied.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "invoice_line_item": {
            "description": "The invoice line item to which the billing credits were applied.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["invoice", "invoice_line_item"],
        "title": "BillingCreditGrantsResourceBalanceCreditsApplied",
        "type": "object",
        "x-expandableFields": ["invoice"]
      },
      "billing_credit_grants_resource_balance_debit": {
        "description": "",
        "properties": {
          "amount": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
          },
          "credits_applied": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied"
              }
            ],
            "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.",
            "nullable": true
          },
          "type": {
            "description": "The type of debit transaction.",
            "enum": ["credits_applied", "credits_expired", "credits_voided"],
            "type": "string"
          }
        },
        "required": ["amount", "type"],
        "title": "BillingCreditGrantsResourceBalanceDebit",
        "type": "object",
        "x-expandableFields": ["amount", "credits_applied"]
      },
      "billing_credit_grants_resource_monetary_amount": {
        "description": "",
        "properties": {
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "A positive integer representing the amount.",
            "type": "integer"
          }
        },
        "required": ["currency", "value"],
        "title": "BillingCreditGrantsResourceMonetaryAmount",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_credit_grants_resource_scope": {
        "description": "",
        "properties": {
          "price_type": {
            "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.",
            "enum": ["metered"],
            "type": "string"
          },
          "prices": {
            "description": "The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.",
            "items": {
              "$ref": "#/components/schemas/billing_credit_grants_resource_applicable_price"
            },
            "type": "array"
          }
        },
        "title": "BillingCreditGrantsResourceScope",
        "type": "object",
        "x-expandableFields": ["prices"]
      },
      "billing_details": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Billing address.",
            "nullable": true
          },
          "email": {
            "description": "Email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Full name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "phone": {
            "description": "Billing phone number (including extension).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "billing_details",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "billing_meter_resource_aggregation_settings": {
        "description": "",
        "properties": {
          "formula": {
            "description": "Specifies how events are aggregated.",
            "enum": ["count", "sum"],
            "type": "string"
          }
        },
        "required": ["formula"],
        "title": "BillingMeterResourceAggregationSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_meter_resource_billing_meter_event_adjustment_cancel": {
        "description": "",
        "properties": {
          "identifier": {
            "description": "Unique identifier for the event.",
            "maxLength": 100,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_meter_resource_billing_meter_status_transitions": {
        "description": "",
        "properties": {
          "deactivated_at": {
            "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "BillingMeterResourceBillingMeterStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_meter_resource_billing_meter_value": {
        "description": "",
        "properties": {
          "event_payload_key": {
            "description": "The key in the meter event payload to use as the value for this meter.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["event_payload_key"],
        "title": "BillingMeterResourceBillingMeterValue",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_meter_resource_customer_mapping_settings": {
        "description": "",
        "properties": {
          "event_payload_key": {
            "description": "The key in the meter event payload to use for mapping the event to a customer.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The method for mapping a meter event to a customer.",
            "enum": ["by_id"],
            "type": "string"
          }
        },
        "required": ["event_payload_key", "type"],
        "title": "BillingMeterResourceCustomerMappingSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "billing_portal.configuration": {
        "description": "A portal configuration describes the functionality and behavior of a portal session.",
        "properties": {
          "active": {
            "description": "Whether the configuration is active and can be used to create portal sessions.",
            "type": "boolean"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "ID of the Connect Application that created the configuration.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "business_profile": {
            "$ref": "#/components/schemas/portal_business_profile"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "default_return_url": {
            "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "features": {
            "$ref": "#/components/schemas/portal_features"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "is_default": {
            "description": "Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.",
            "type": "boolean"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "login_page": {
            "$ref": "#/components/schemas/portal_login_page"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing_portal.configuration"],
            "type": "string"
          },
          "updated": {
            "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "active",
          "business_profile",
          "created",
          "features",
          "id",
          "is_default",
          "livemode",
          "login_page",
          "object",
          "updated"
        ],
        "title": "PortalConfiguration",
        "type": "object",
        "x-expandableFields": [
          "application",
          "business_profile",
          "features",
          "login_page"
        ],
        "x-resourceId": "billing_portal.configuration"
      },
      "billing_portal.session": {
        "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)",
        "properties": {
          "configuration": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/billing_portal.configuration"
              }
            ],
            "description": "The configuration used by this session, describing the features available.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/billing_portal.configuration"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "description": "The ID of the customer for this session.",
            "maxLength": 5000,
            "type": "string"
          },
          "flow": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_flow"
              }
            ],
            "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "locale": {
            "description": "The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.",
            "enum": [
              "auto",
              "bg",
              "cs",
              "da",
              "de",
              "el",
              "en",
              "en-AU",
              "en-CA",
              "en-GB",
              "en-IE",
              "en-IN",
              "en-NZ",
              "en-SG",
              "es",
              "es-419",
              "et",
              "fi",
              "fil",
              "fr",
              "fr-CA",
              "hr",
              "hu",
              "id",
              "it",
              "ja",
              "ko",
              "lt",
              "lv",
              "ms",
              "mt",
              "nb",
              "nl",
              "pl",
              "pt",
              "pt-BR",
              "ro",
              "ru",
              "sk",
              "sl",
              "sv",
              "th",
              "tr",
              "vi",
              "zh",
              "zh-HK",
              "zh-TW"
            ],
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["billing_portal.session"],
            "type": "string"
          },
          "on_behalf_of": {
            "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "return_url": {
            "description": "The URL to redirect customers to when they click on the portal's link to return to your website.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The short-lived URL of the session that gives customers access to the customer portal.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "configuration",
          "created",
          "customer",
          "id",
          "livemode",
          "object",
          "url"
        ],
        "title": "PortalSession",
        "type": "object",
        "x-expandableFields": ["configuration", "flow"],
        "x-resourceId": "billing_portal.session"
      },
      "cancellation_details": {
        "description": "",
        "properties": {
          "comment": {
            "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "feedback": {
            "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
            "enum": [
              "customer_service",
              "low_quality",
              "missing_features",
              "other",
              "switched_service",
              "too_complex",
              "too_expensive",
              "unused"
            ],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "Why this subscription was canceled.",
            "enum": [
              "cancellation_requested",
              "payment_disputed",
              "payment_failed"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CancellationDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "capability": {
        "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account for which the capability enables functionality.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "future_requirements": {
            "$ref": "#/components/schemas/account_capability_future_requirements"
          },
          "id": {
            "description": "The identifier for the capability.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["capability"],
            "type": "string"
          },
          "requested": {
            "description": "Whether the capability has been requested.",
            "type": "boolean"
          },
          "requested_at": {
            "description": "Time at which the capability was requested. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "requirements": {
            "$ref": "#/components/schemas/account_capability_requirements"
          },
          "status": {
            "description": "The status of the capability.",
            "enum": [
              "active",
              "disabled",
              "inactive",
              "pending",
              "unrequested"
            ],
            "type": "string"
          }
        },
        "required": ["account", "id", "object", "requested", "status"],
        "title": "AccountCapability",
        "type": "object",
        "x-expandableFields": [
          "account",
          "future_requirements",
          "requirements"
        ],
        "x-resourceId": "capability"
      },
      "card": {
        "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "address_city": {
            "description": "City/District/Suburb/Town/Village.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_country": {
            "description": "Billing address country, if provided when creating card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_line1": {
            "description": "Address line 1 (Street address/PO Box/Company name).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_line1_check": {
            "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_line2": {
            "description": "Address line 2 (Apartment/Suite/Unit/Building).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_state": {
            "description": "State/County/Province/Region.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_zip": {
            "description": "ZIP or postal code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_zip_check": {
            "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "allow_redisplay": {
            "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.",
            "enum": ["always", "limited", "unspecified"],
            "nullable": true,
            "type": "string"
          },
          "available_payout_methods": {
            "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.",
            "items": {
              "enum": ["instant", "standard"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "brand": {
            "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "currency": {
            "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "cvc_check": {
            "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "default_for_currency": {
            "description": "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
            "nullable": true,
            "type": "boolean"
          },
          "dynamic_last4": {
            "description": "(For tokenized numbers only.) The last four digits of the device account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "iin": {
            "description": "Issuer identification number of the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "name": {
            "description": "Cardholder name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "networks": {
            "$ref": "#/components/schemas/token_card_networks"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["card"],
            "type": "string"
          },
          "regulated_status": {
            "description": "Status of a card based on the card issuer.",
            "enum": ["regulated", "unregulated"],
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tokenization_method": {
            "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "brand",
          "exp_month",
          "exp_year",
          "funding",
          "id",
          "last4",
          "object"
        ],
        "title": "Card",
        "type": "object",
        "x-expandableFields": ["account", "customer", "networks"],
        "x-resourceId": "card"
      },
      "card_generated_from_payment_method_details": {
        "description": "",
        "properties": {
          "card_present": {
            "$ref": "#/components/schemas/payment_method_details_card_present"
          },
          "type": {
            "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "card_generated_from_payment_method_details",
        "type": "object",
        "x-expandableFields": ["card_present"]
      },
      "card_issuing_account_terms_of_service": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the account representative accepted the service agreement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the account representative accepted the service agreement.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "CardIssuingAccountTermsOfService",
        "type": "object",
        "x-expandableFields": []
      },
      "card_mandate_payment_method_details": {
        "description": "",
        "properties": {},
        "title": "card_mandate_payment_method_details",
        "type": "object",
        "x-expandableFields": []
      },
      "cash_balance": {
        "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.",
        "properties": {
          "available": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true,
            "type": "object"
          },
          "customer": {
            "description": "The ID of the customer whose cash balance this object represents.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["cash_balance"],
            "type": "string"
          },
          "settings": {
            "$ref": "#/components/schemas/customer_balance_customer_balance_settings"
          }
        },
        "required": ["customer", "livemode", "object", "settings"],
        "title": "cash_balance",
        "type": "object",
        "x-expandableFields": ["settings"],
        "x-resourceId": "cash_balance"
      },
      "charge": {
        "description": "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but transferring\nmoney to a different Stripe account through Connect also creates Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations.",
        "properties": {
          "amount": {
            "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
            "type": "integer"
          },
          "amount_captured": {
            "description": "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).",
            "type": "integer"
          },
          "amount_refunded": {
            "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).",
            "type": "integer"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "ID of the Connect application that created the charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "application_fee": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application_fee"
              }
            ],
            "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application_fee"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.",
            "nullable": true,
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "billing_details": {
            "$ref": "#/components/schemas/billing_details"
          },
          "calculated_statement_descriptor": {
            "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "captured": {
            "description": "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the customer this charge is for if one exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 40000,
            "nullable": true,
            "type": "string"
          },
          "disputed": {
            "description": "Whether the charge has been disputed.",
            "type": "boolean"
          },
          "failure_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "failure_code": {
            "description": "Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "failure_message": {
            "description": "Message to user further explaining reason for charge failure if available.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fraud_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/charge_fraud_details"
              }
            ],
            "description": "Information on fraud assessments for the charge.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "ID of the invoice this charge is for if one exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["charge"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "outcome": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/charge_outcome"
              }
            ],
            "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.",
            "nullable": true
          },
          "paid": {
            "description": "`true` if the charge succeeded, or was successfully authorized for later capture.",
            "type": "boolean"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "ID of the PaymentIntent associated with this charge, if one exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "payment_method": {
            "description": "ID of the payment method used in this charge.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_method_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details"
              }
            ],
            "description": "Details about the payment method at the time of the transaction.",
            "nullable": true
          },
          "radar_options": {
            "$ref": "#/components/schemas/radar_radar_options"
          },
          "receipt_email": {
            "description": "This is the email address that the receipt for this charge was sent to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "receipt_number": {
            "description": "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "receipt_url": {
            "description": "This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "refunded": {
            "description": "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.",
            "type": "boolean"
          },
          "refunds": {
            "description": "A list of refunds that have been applied to the charge.",
            "nullable": true,
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/refund"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "RefundList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "review": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/review"
              }
            ],
            "description": "ID of the review associated with this charge if one exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/review"
                }
              ]
            }
          },
          "shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Shipping information for the charge.",
            "nullable": true
          },
          "source_transfer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/transfer"
              }
            ],
            "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/transfer"
                }
              ]
            }
          },
          "statement_descriptor": {
            "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_suffix": {
            "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The status of the payment is either `succeeded`, `pending`, or `failed`.",
            "enum": ["failed", "pending", "succeeded"],
            "type": "string"
          },
          "transfer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/transfer"
              }
            ],
            "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/transfer"
                }
              ]
            }
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/charge_transfer_data"
              }
            ],
            "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
            "nullable": true
          },
          "transfer_group": {
            "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "amount_captured",
          "amount_refunded",
          "billing_details",
          "captured",
          "created",
          "currency",
          "disputed",
          "id",
          "livemode",
          "metadata",
          "object",
          "paid",
          "refunded",
          "status"
        ],
        "title": "Charge",
        "type": "object",
        "x-expandableFields": [
          "application",
          "application_fee",
          "balance_transaction",
          "billing_details",
          "customer",
          "failure_balance_transaction",
          "fraud_details",
          "invoice",
          "on_behalf_of",
          "outcome",
          "payment_intent",
          "payment_method_details",
          "radar_options",
          "refunds",
          "review",
          "shipping",
          "source_transfer",
          "transfer",
          "transfer_data"
        ],
        "x-resourceId": "charge"
      },
      "charge_fraud_details": {
        "description": "",
        "properties": {
          "stripe_report": {
            "description": "Assessments from Stripe. If set, the value is `fraudulent`.",
            "maxLength": 5000,
            "type": "string"
          },
          "user_report": {
            "description": "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "ChargeFraudDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "charge_outcome": {
        "description": "",
        "properties": {
          "advice_code": {
            "description": "An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).",
            "enum": [
              "confirm_card_data",
              "do_not_try_again",
              "try_again_later"
            ],
            "nullable": true,
            "type": "string"
          },
          "network_advice_code": {
            "description": "For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_decline_code": {
            "description": "For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_status": {
            "description": "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "risk_level": {
            "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.",
            "maxLength": 5000,
            "type": "string"
          },
          "risk_score": {
            "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.",
            "type": "integer"
          },
          "rule": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/rule"
              }
            ],
            "description": "The ID of the Radar rule that matched the payment, if applicable.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/rule"
                }
              ]
            }
          },
          "seller_message": {
            "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "ChargeOutcome",
        "type": "object",
        "x-expandableFields": ["rule"]
      },
      "charge_transfer_data": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.",
            "nullable": true,
            "type": "integer"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "ChargeTransferData",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "checkout.session": {
        "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)",
        "properties": {
          "adaptive_pricing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_adaptive_pricing"
              }
            ],
            "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).",
            "nullable": true
          },
          "after_expiration": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration"
              }
            ],
            "description": "When set, provides configuration for actions to take if this Checkout Session expires.",
            "nullable": true
          },
          "allow_promotion_codes": {
            "description": "Enables user redeemable promotion codes.",
            "nullable": true,
            "type": "boolean"
          },
          "amount_subtotal": {
            "description": "Total of all items before discounts or taxes are applied.",
            "nullable": true,
            "type": "integer"
          },
          "amount_total": {
            "description": "Total of all items after discounts and taxes are applied.",
            "nullable": true,
            "type": "integer"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax"
          },
          "billing_address_collection": {
            "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.",
            "enum": ["auto", "required"],
            "nullable": true,
            "type": "string"
          },
          "cancel_url": {
            "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "client_reference_id": {
            "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "client_secret": {
            "description": "Client secret to be used when initializing Stripe.js embedded checkout.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "collected_information": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information"
              }
            ],
            "description": "Information about the customer collected within the Checkout Session.",
            "nullable": true
          },
          "consent": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_consent"
              }
            ],
            "description": "Results of `consent_collection` for this session.",
            "nullable": true
          },
          "consent_collection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_consent_collection"
              }
            ],
            "description": "When set, provides configuration for the Checkout Session to gather active consent from customers.",
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "currency_conversion": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_currency_conversion"
              }
            ],
            "description": "Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions",
            "nullable": true
          },
          "custom_fields": {
            "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.",
            "items": {
              "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields"
            },
            "type": "array"
          },
          "custom_text": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "customer_creation": {
            "description": "Configure whether a Checkout Session creates a Customer when the Checkout Session completes.",
            "enum": ["always", "if_required"],
            "nullable": true,
            "type": "string"
          },
          "customer_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_customer_details"
              }
            ],
            "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.",
            "nullable": true
          },
          "customer_email": {
            "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discounts": {
            "description": "List of coupons and promotion codes attached to the Checkout Session.",
            "items": {
              "$ref": "#/components/schemas/payment_pages_checkout_session_discount"
            },
            "nullable": true,
            "type": "array"
          },
          "expires_at": {
            "description": "The timestamp at which the Checkout Session will expire.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "ID of the invoice created by the Checkout Session, if it exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "invoice_creation": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_creation"
              }
            ],
            "description": "Details on the state of invoice creation for the Checkout Session.",
            "nullable": true
          },
          "line_items": {
            "description": "The line items purchased by the customer.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "PaymentPagesCheckoutSessionListLineItems",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "locale": {
            "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
            "enum": [
              "auto",
              "bg",
              "cs",
              "da",
              "de",
              "el",
              "en",
              "en-GB",
              "es",
              "es-419",
              "et",
              "fi",
              "fil",
              "fr",
              "fr-CA",
              "hr",
              "hu",
              "id",
              "it",
              "ja",
              "ko",
              "lt",
              "lv",
              "ms",
              "mt",
              "nb",
              "nl",
              "pl",
              "pt",
              "pt-BR",
              "ro",
              "ru",
              "sk",
              "sl",
              "sv",
              "th",
              "tr",
              "vi",
              "zh",
              "zh-HK",
              "zh-TW"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "mode": {
            "description": "The mode of the Checkout Session.",
            "enum": ["payment", "setup", "subscription"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["checkout.session"],
            "type": "string"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "payment_link": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_link"
              }
            ],
            "description": "The ID of the Payment Link that created this Session.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_link"
                }
              ]
            }
          },
          "payment_method_collection": {
            "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.",
            "enum": ["always", "if_required"],
            "nullable": true,
            "type": "string"
          },
          "payment_method_configuration_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
              }
            ],
            "description": "Information about the payment method configuration used for this Checkout session if using dynamic payment methods.",
            "nullable": true
          },
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/checkout_session_payment_method_options"
              }
            ],
            "description": "Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.",
            "nullable": true
          },
          "payment_method_types": {
            "description": "A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "payment_status": {
            "description": "The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order.",
            "enum": ["no_payment_required", "paid", "unpaid"],
            "type": "string"
          },
          "phone_number_collection": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection"
          },
          "recovered_from": {
            "description": "The ID of the original expired Checkout Session that triggered the recovery flow.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "redirect_on_completion": {
            "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
            "enum": ["always", "if_required", "never"],
            "type": "string"
          },
          "return_url": {
            "description": "Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.",
            "maxLength": 5000,
            "type": "string"
          },
          "saved_payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options"
              }
            ],
            "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.",
            "nullable": true
          },
          "setup_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_intent"
              }
            ],
            "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_intent"
                }
              ]
            }
          },
          "shipping_address_collection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_address_collection"
              }
            ],
            "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.",
            "nullable": true
          },
          "shipping_cost": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_cost"
              }
            ],
            "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate.",
            "nullable": true
          },
          "shipping_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Shipping information for this Checkout Session.",
            "nullable": true
          },
          "shipping_options": {
            "description": "The shipping rate options applied to this Session.",
            "items": {
              "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_option"
            },
            "type": "array"
          },
          "status": {
            "description": "The status of the Checkout Session, one of `open`, `complete`, or `expired`.",
            "enum": ["complete", "expired", "open"],
            "nullable": true,
            "type": "string"
          },
          "submit_type": {
            "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.",
            "enum": ["auto", "book", "donate", "pay", "subscribe"],
            "nullable": true,
            "type": "string"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "The ID of the subscription for Checkout Sessions in `subscription` mode.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "success_url": {
            "description": "The URL the customer will be directed to after the payment or\nsubscription creation is successful.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_id_collection": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id_collection"
          },
          "total_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_total_details"
              }
            ],
            "description": "Tax and discount details for the computed total amount.",
            "nullable": true
          },
          "ui_mode": {
            "description": "The UI mode of the Session. Defaults to `hosted`.",
            "enum": ["embedded", "hosted"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "url": {
            "description": "The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "automatic_tax",
          "created",
          "custom_fields",
          "custom_text",
          "expires_at",
          "id",
          "livemode",
          "mode",
          "object",
          "payment_method_types",
          "payment_status",
          "shipping_options"
        ],
        "title": "Session",
        "type": "object",
        "x-expandableFields": [
          "adaptive_pricing",
          "after_expiration",
          "automatic_tax",
          "collected_information",
          "consent",
          "consent_collection",
          "currency_conversion",
          "custom_fields",
          "custom_text",
          "customer",
          "customer_details",
          "discounts",
          "invoice",
          "invoice_creation",
          "line_items",
          "payment_intent",
          "payment_link",
          "payment_method_configuration_details",
          "payment_method_options",
          "phone_number_collection",
          "saved_payment_method_options",
          "setup_intent",
          "shipping_address_collection",
          "shipping_cost",
          "shipping_details",
          "shipping_options",
          "subscription",
          "tax_id_collection",
          "total_details"
        ],
        "x-resourceId": "checkout.session"
      },
      "checkout_acss_debit_mandate_options": {
        "description": "",
        "properties": {
          "custom_mandate_url": {
            "description": "A URL for custom mandate text",
            "maxLength": 5000,
            "type": "string"
          },
          "default_for": {
            "description": "List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.",
            "items": {
              "enum": ["invoice", "subscription"],
              "type": "string"
            },
            "type": "array"
          },
          "interval_description": {
            "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_schedule": {
            "description": "Payment schedule for the mandate.",
            "enum": ["combined", "interval", "sporadic"],
            "nullable": true,
            "type": "string"
          },
          "transaction_type": {
            "description": "Transaction type of the mandate.",
            "enum": ["business", "personal"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CheckoutAcssDebitMandateOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_acss_debit_payment_method_options": {
        "description": "",
        "properties": {
          "currency": {
            "description": "Currency supported by the bank account. Returned when the Session is in `setup` mode.",
            "enum": ["cad", "usd"],
            "type": "string"
          },
          "mandate_options": {
            "$ref": "#/components/schemas/checkout_acss_debit_mandate_options"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "CheckoutAcssDebitPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "checkout_affirm_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutAffirmPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_afterpay_clearpay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutAfterpayClearpayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_alipay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutAlipayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_amazon_pay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutAmazonPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_au_becs_debit_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "CheckoutAuBecsDebitPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_bacs_debit_payment_method_options": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_bacs_debit"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "CheckoutBacsDebitPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "checkout_bancontact_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutBancontactPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_boleto_payment_method_options": {
        "description": "",
        "properties": {
          "expires_after_days": {
            "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.",
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          }
        },
        "required": ["expires_after_days"],
        "title": "CheckoutBoletoPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_card_installments_options": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates if installments are enabled",
            "type": "boolean"
          }
        },
        "title": "CheckoutCardInstallmentsOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_card_payment_method_options": {
        "description": "",
        "properties": {
          "installments": {
            "$ref": "#/components/schemas/checkout_card_installments_options"
          },
          "request_extended_authorization": {
            "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_incremental_authorization": {
            "description": "Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_multicapture": {
            "description": "Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_overcapture": {
            "description": "Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_three_d_secure": {
            "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
            "enum": ["any", "automatic", "challenge"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "restrictions": {
            "$ref": "#/components/schemas/payment_pages_private_card_payment_method_options_resource_restrictions"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "statement_descriptor_suffix_kana": {
            "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "statement_descriptor_suffix_kanji": {
            "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["request_three_d_secure"],
        "title": "CheckoutCardPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["installments", "restrictions"]
      },
      "checkout_cashapp_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutCashappPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_customer_balance_bank_transfer_payment_method_options": {
        "description": "",
        "properties": {
          "eu_bank_transfer": {
            "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
          },
          "requested_address_types": {
            "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
            "items": {
              "enum": [
                "aba",
                "iban",
                "sepa",
                "sort_code",
                "spei",
                "swift",
                "zengin"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "type": {
            "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
            "enum": [
              "eu_bank_transfer",
              "gb_bank_transfer",
              "jp_bank_transfer",
              "mx_bank_transfer",
              "us_bank_transfer"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "CheckoutCustomerBalanceBankTransferPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["eu_bank_transfer"]
      },
      "checkout_customer_balance_payment_method_options": {
        "description": "",
        "properties": {
          "bank_transfer": {
            "$ref": "#/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options"
          },
          "funding_type": {
            "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
            "enum": ["bank_transfer"],
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutCustomerBalancePaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["bank_transfer"]
      },
      "checkout_eps_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutEpsPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_fpx_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutFpxPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_giropay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutGiropayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_grab_pay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutGrabPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_ideal_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutIdealPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_kakao_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutKakaoPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_klarna_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          }
        },
        "title": "CheckoutKlarnaPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_konbini_payment_method_options": {
        "description": "",
        "properties": {
          "expires_after_days": {
            "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.",
            "nullable": true,
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutKonbiniPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_kr_card_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutKrCardPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_link_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutLinkPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_mobilepay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutMobilepayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_multibanco_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutMultibancoPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_naver_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "CheckoutNaverPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_oxxo_payment_method_options": {
        "description": "",
        "properties": {
          "expires_after_days": {
            "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.",
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "required": ["expires_after_days"],
        "title": "CheckoutOxxoPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_p24_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutP24PaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_payco_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "CheckoutPaycoPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_payment_method_options_mandate_options_bacs_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "checkout_payment_method_options_mandate_options_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_payment_method_options_mandate_options_sepa_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "checkout_payment_method_options_mandate_options_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_paynow_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutPaynowPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_paypal_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "preferred_locale": {
            "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutPaypalPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_pix_payment_method_options": {
        "description": "",
        "properties": {
          "expires_after_seconds": {
            "description": "The number of seconds after which Pix payment will expire.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "CheckoutPixPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_revolut_pay_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "CheckoutRevolutPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_samsung_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "CheckoutSamsungPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_sepa_debit_payment_method_options": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "CheckoutSepaDebitPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "checkout_session_payment_method_options": {
        "description": "",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/checkout_acss_debit_payment_method_options"
          },
          "affirm": {
            "$ref": "#/components/schemas/checkout_affirm_payment_method_options"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/checkout_afterpay_clearpay_payment_method_options"
          },
          "alipay": {
            "$ref": "#/components/schemas/checkout_alipay_payment_method_options"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/checkout_bacs_debit_payment_method_options"
          },
          "bancontact": {
            "$ref": "#/components/schemas/checkout_bancontact_payment_method_options"
          },
          "boleto": {
            "$ref": "#/components/schemas/checkout_boleto_payment_method_options"
          },
          "card": {
            "$ref": "#/components/schemas/checkout_card_payment_method_options"
          },
          "cashapp": {
            "$ref": "#/components/schemas/checkout_cashapp_payment_method_options"
          },
          "customer_balance": {
            "$ref": "#/components/schemas/checkout_customer_balance_payment_method_options"
          },
          "eps": {
            "$ref": "#/components/schemas/checkout_eps_payment_method_options"
          },
          "fpx": {
            "$ref": "#/components/schemas/checkout_fpx_payment_method_options"
          },
          "giropay": {
            "$ref": "#/components/schemas/checkout_giropay_payment_method_options"
          },
          "grabpay": {
            "$ref": "#/components/schemas/checkout_grab_pay_payment_method_options"
          },
          "ideal": {
            "$ref": "#/components/schemas/checkout_ideal_payment_method_options"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/checkout_kakao_pay_payment_method_options"
          },
          "klarna": {
            "$ref": "#/components/schemas/checkout_klarna_payment_method_options"
          },
          "konbini": {
            "$ref": "#/components/schemas/checkout_konbini_payment_method_options"
          },
          "kr_card": {
            "$ref": "#/components/schemas/checkout_kr_card_payment_method_options"
          },
          "link": {
            "$ref": "#/components/schemas/checkout_link_payment_method_options"
          },
          "mobilepay": {
            "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options"
          },
          "multibanco": {
            "$ref": "#/components/schemas/checkout_multibanco_payment_method_options"
          },
          "naver_pay": {
            "$ref": "#/components/schemas/checkout_naver_pay_payment_method_options"
          },
          "oxxo": {
            "$ref": "#/components/schemas/checkout_oxxo_payment_method_options"
          },
          "p24": {
            "$ref": "#/components/schemas/checkout_p24_payment_method_options"
          },
          "payco": {
            "$ref": "#/components/schemas/checkout_payco_payment_method_options"
          },
          "paynow": {
            "$ref": "#/components/schemas/checkout_paynow_payment_method_options"
          },
          "paypal": {
            "$ref": "#/components/schemas/checkout_paypal_payment_method_options"
          },
          "pix": {
            "$ref": "#/components/schemas/checkout_pix_payment_method_options"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/checkout_samsung_pay_payment_method_options"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options"
          },
          "sofort": {
            "$ref": "#/components/schemas/checkout_sofort_payment_method_options"
          },
          "swish": {
            "$ref": "#/components/schemas/checkout_swish_payment_method_options"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options"
          }
        },
        "title": "CheckoutSessionPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "boleto",
          "card",
          "cashapp",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "oxxo",
          "p24",
          "payco",
          "paynow",
          "paypal",
          "pix",
          "revolut_pay",
          "samsung_pay",
          "sepa_debit",
          "sofort",
          "swish",
          "us_bank_account"
        ]
      },
      "checkout_sofort_payment_method_options": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "CheckoutSofortPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_swish_payment_method_options": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CheckoutSwishPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "checkout_us_bank_account_payment_method_options": {
        "description": "",
        "properties": {
          "financial_connections": {
            "$ref": "#/components/schemas/linked_account_options_us_bank_account"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "CheckoutUsBankAccountPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["financial_connections"]
      },
      "climate.order": {
        "description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.",
        "properties": {
          "amount_fees": {
            "description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.",
            "type": "integer"
          },
          "amount_subtotal": {
            "description": "Total amount of the carbon removal in the currency's smallest unit.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total amount of the order including fees in the currency's smallest unit.",
            "type": "integer"
          },
          "beneficiary": {
            "$ref": "#/components/schemas/climate_removals_beneficiary"
          },
          "canceled_at": {
            "description": "Time at which the order was canceled. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancellation_reason": {
            "description": "Reason for the cancellation of this order.",
            "enum": ["expired", "product_unavailable", "requested"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "certificate": {
            "description": "For delivered orders, a URL to a delivery certificate for the order.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "confirmed_at": {
            "description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.",
            "maxLength": 5000,
            "type": "string"
          },
          "delayed_at": {
            "description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "delivered_at": {
            "description": "Time at which the order was delivered. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "delivery_details": {
            "description": "Details about the delivery of carbon removal for this order.",
            "items": {
              "$ref": "#/components/schemas/climate_removals_order_deliveries"
            },
            "type": "array"
          },
          "expected_delivery_year": {
            "description": "The year this order is expected to be delivered.",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "metric_tons": {
            "description": "Quantity of carbon removal that is included in this order.",
            "format": "decimal",
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["climate.order"],
            "type": "string"
          },
          "product": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/climate.product"
              }
            ],
            "description": "Unique ID for the Climate `Product` this order is purchasing.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/climate.product"
                }
              ]
            }
          },
          "product_substituted_at": {
            "description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "status": {
            "description": "The current status of this order.",
            "enum": [
              "awaiting_funds",
              "canceled",
              "confirmed",
              "delivered",
              "open"
            ],
            "type": "string"
          }
        },
        "required": [
          "amount_fees",
          "amount_subtotal",
          "amount_total",
          "created",
          "currency",
          "delivery_details",
          "expected_delivery_year",
          "id",
          "livemode",
          "metadata",
          "metric_tons",
          "object",
          "product",
          "status"
        ],
        "title": "ClimateRemovalsOrders",
        "type": "object",
        "x-expandableFields": ["beneficiary", "delivery_details", "product"],
        "x-resourceId": "climate.order"
      },
      "climate.product": {
        "description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "current_prices_per_metric_ton": {
            "additionalProperties": {
              "$ref": "#/components/schemas/climate_removals_products_price"
            },
            "description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.",
            "type": "object"
          },
          "delivery_year": {
            "description": "The year in which the carbon removal is expected to be delivered.",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metric_tons_available": {
            "description": "The quantity of metric tons available for reservation.",
            "format": "decimal",
            "type": "string"
          },
          "name": {
            "description": "The Climate product's name.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["climate.product"],
            "type": "string"
          },
          "suppliers": {
            "description": "The carbon removal suppliers that fulfill orders for this Climate product.",
            "items": {
              "$ref": "#/components/schemas/climate.supplier"
            },
            "type": "array"
          }
        },
        "required": [
          "created",
          "current_prices_per_metric_ton",
          "id",
          "livemode",
          "metric_tons_available",
          "name",
          "object",
          "suppliers"
        ],
        "title": "ClimateRemovalsProducts",
        "type": "object",
        "x-expandableFields": ["current_prices_per_metric_ton", "suppliers"],
        "x-resourceId": "climate.product"
      },
      "climate.supplier": {
        "description": "A supplier of carbon removal.",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "info_url": {
            "description": "Link to a webpage to learn more about the supplier.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "locations": {
            "description": "The locations in which this supplier operates.",
            "items": {
              "$ref": "#/components/schemas/climate_removals_location"
            },
            "type": "array"
          },
          "name": {
            "description": "Name of this carbon removal supplier.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object’s type. Objects of the same type share the same value.",
            "enum": ["climate.supplier"],
            "type": "string"
          },
          "removal_pathway": {
            "description": "The scientific pathway used for carbon removal.",
            "enum": [
              "biomass_carbon_removal_and_storage",
              "direct_air_capture",
              "enhanced_weathering"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": [
          "id",
          "info_url",
          "livemode",
          "locations",
          "name",
          "object",
          "removal_pathway"
        ],
        "title": "ClimateRemovalsSuppliers",
        "type": "object",
        "x-expandableFields": ["locations"],
        "x-resourceId": "climate.supplier"
      },
      "climate_removals_beneficiary": {
        "description": "",
        "properties": {
          "public_name": {
            "description": "Publicly displayable name for the end beneficiary of carbon removal.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["public_name"],
        "title": "ClimateRemovalsBeneficiary",
        "type": "object",
        "x-expandableFields": []
      },
      "climate_removals_location": {
        "description": "",
        "properties": {
          "city": {
            "description": "The city where the supplier is located.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country where the supplier is located.",
            "maxLength": 5000,
            "type": "string"
          },
          "latitude": {
            "description": "The geographic latitude where the supplier is located.",
            "nullable": true,
            "type": "number"
          },
          "longitude": {
            "description": "The geographic longitude where the supplier is located.",
            "nullable": true,
            "type": "number"
          },
          "region": {
            "description": "The state/county/province/region where the supplier is located.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["country"],
        "title": "ClimateRemovalsLocation",
        "type": "object",
        "x-expandableFields": []
      },
      "climate_removals_order_deliveries": {
        "description": "The delivery of a specified quantity of carbon for an order.",
        "properties": {
          "delivered_at": {
            "description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "location": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/climate_removals_location"
              }
            ],
            "description": "Specific location of this delivery.",
            "nullable": true
          },
          "metric_tons": {
            "description": "Quantity of carbon removal supplied by this delivery.",
            "maxLength": 5000,
            "type": "string"
          },
          "registry_url": {
            "description": "Once retired, a URL to the registry entry for the tons from this delivery.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "supplier": {
            "$ref": "#/components/schemas/climate.supplier"
          }
        },
        "required": ["delivered_at", "metric_tons", "supplier"],
        "title": "ClimateRemovalsOrderDeliveries",
        "type": "object",
        "x-expandableFields": ["location", "supplier"]
      },
      "climate_removals_products_price": {
        "description": "",
        "properties": {
          "amount_fees": {
            "description": "Fees for one metric ton of carbon removal in the currency's smallest unit.",
            "type": "integer"
          },
          "amount_subtotal": {
            "description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.",
            "type": "integer"
          }
        },
        "required": ["amount_fees", "amount_subtotal", "amount_total"],
        "title": "ClimateRemovalsProductsPrice",
        "type": "object",
        "x-expandableFields": []
      },
      "confirmation_token": {
        "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expires_at": {
            "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "mandate_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data"
              }
            ],
            "description": "Data used for generating a Mandate.",
            "nullable": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["confirmation_token"],
            "type": "string"
          },
          "payment_intent": {
            "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options"
              }
            ],
            "description": "Payment-method-specific configuration for this ConfirmationToken.",
            "nullable": true
          },
          "payment_method_preview": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview"
              }
            ],
            "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.",
            "nullable": true
          },
          "return_url": {
            "description": "Return URL used to confirm the Intent.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.",
            "enum": ["off_session", "on_session"],
            "nullable": true,
            "type": "string"
          },
          "setup_intent": {
            "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_shipping"
              }
            ],
            "description": "Shipping information collected on this ConfirmationToken.",
            "nullable": true
          },
          "use_stripe_sdk": {
            "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.",
            "type": "boolean"
          }
        },
        "required": ["created", "id", "livemode", "object", "use_stripe_sdk"],
        "title": "ConfirmationTokensResourceConfirmationToken",
        "type": "object",
        "x-expandableFields": [
          "mandate_data",
          "payment_method_options",
          "payment_method_preview",
          "shipping"
        ],
        "x-resourceId": "confirmation_token"
      },
      "confirmation_tokens_resource_mandate_data": {
        "description": "Data used for generating a Mandate.",
        "properties": {
          "customer_acceptance": {
            "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance"
          }
        },
        "required": ["customer_acceptance"],
        "title": "ConfirmationTokensResourceMandateData",
        "type": "object",
        "x-expandableFields": ["customer_acceptance"]
      },
      "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": {
        "description": "This hash contains details about the customer acceptance of the Mandate.",
        "properties": {
          "online": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"
              }
            ],
            "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
            "nullable": true
          },
          "type": {
            "description": "The type of customer acceptance information included with the Mandate.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance",
        "type": "object",
        "x-expandableFields": ["online"]
      },
      "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": {
        "description": "This hash contains details about the online acceptance.",
        "properties": {
          "ip_address": {
            "description": "The IP address from which the Mandate was accepted by the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline",
        "type": "object",
        "x-expandableFields": []
      },
      "confirmation_tokens_resource_payment_method_options": {
        "description": "Payment-method-specific configuration",
        "properties": {
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card"
              }
            ],
            "description": "This hash contains the card payment method options.",
            "nullable": true
          }
        },
        "title": "ConfirmationTokensResourcePaymentMethodOptions",
        "type": "object",
        "x-expandableFields": ["card"]
      },
      "confirmation_tokens_resource_payment_method_options_resource_card": {
        "description": "This hash contains the card payment method options.",
        "properties": {
          "cvc_token": {
            "description": "The `cvc_update` Token collected from the Payment Element.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard",
        "type": "object",
        "x-expandableFields": []
      },
      "confirmation_tokens_resource_payment_method_preview": {
        "description": "Details of the PaymentMethod collected by Payment Element",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/payment_method_acss_debit"
          },
          "affirm": {
            "$ref": "#/components/schemas/payment_method_affirm"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
          },
          "alipay": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
          },
          "allow_redisplay": {
            "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.",
            "enum": ["always", "limited", "unspecified"],
            "type": "string"
          },
          "alma": {
            "$ref": "#/components/schemas/payment_method_alma"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/payment_method_amazon_pay"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/payment_method_au_becs_debit"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/payment_method_bacs_debit"
          },
          "bancontact": {
            "$ref": "#/components/schemas/payment_method_bancontact"
          },
          "billing_details": {
            "$ref": "#/components/schemas/billing_details"
          },
          "blik": {
            "$ref": "#/components/schemas/payment_method_blik"
          },
          "boleto": {
            "$ref": "#/components/schemas/payment_method_boleto"
          },
          "card": {
            "$ref": "#/components/schemas/payment_method_card"
          },
          "card_present": {
            "$ref": "#/components/schemas/payment_method_card_present"
          },
          "cashapp": {
            "$ref": "#/components/schemas/payment_method_cashapp"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "customer_balance": {
            "$ref": "#/components/schemas/payment_method_customer_balance"
          },
          "eps": {
            "$ref": "#/components/schemas/payment_method_eps"
          },
          "fpx": {
            "$ref": "#/components/schemas/payment_method_fpx"
          },
          "giropay": {
            "$ref": "#/components/schemas/payment_method_giropay"
          },
          "grabpay": {
            "$ref": "#/components/schemas/payment_method_grabpay"
          },
          "ideal": {
            "$ref": "#/components/schemas/payment_method_ideal"
          },
          "interac_present": {
            "$ref": "#/components/schemas/payment_method_interac_present"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/payment_method_kakao_pay"
          },
          "klarna": {
            "$ref": "#/components/schemas/payment_method_klarna"
          },
          "konbini": {
            "$ref": "#/components/schemas/payment_method_konbini"
          },
          "kr_card": {
            "$ref": "#/components/schemas/payment_method_kr_card"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_link"
          },
          "mobilepay": {
            "$ref": "#/components/schemas/payment_method_mobilepay"
          },
          "multibanco": {
            "$ref": "#/components/schemas/payment_method_multibanco"
          },
          "naver_pay": {
            "$ref": "#/components/schemas/payment_method_naver_pay"
          },
          "oxxo": {
            "$ref": "#/components/schemas/payment_method_oxxo"
          },
          "p24": {
            "$ref": "#/components/schemas/payment_method_p24"
          },
          "pay_by_bank": {
            "$ref": "#/components/schemas/payment_method_pay_by_bank"
          },
          "payco": {
            "$ref": "#/components/schemas/payment_method_payco"
          },
          "paynow": {
            "$ref": "#/components/schemas/payment_method_paynow"
          },
          "paypal": {
            "$ref": "#/components/schemas/payment_method_paypal"
          },
          "pix": {
            "$ref": "#/components/schemas/payment_method_pix"
          },
          "promptpay": {
            "$ref": "#/components/schemas/payment_method_promptpay"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/payment_method_revolut_pay"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/payment_method_samsung_pay"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/payment_method_sepa_debit"
          },
          "sofort": {
            "$ref": "#/components/schemas/payment_method_sofort"
          },
          "swish": {
            "$ref": "#/components/schemas/payment_method_swish"
          },
          "twint": {
            "$ref": "#/components/schemas/payment_method_twint"
          },
          "type": {
            "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
            "enum": [
              "acss_debit",
              "affirm",
              "afterpay_clearpay",
              "alipay",
              "alma",
              "amazon_pay",
              "au_becs_debit",
              "bacs_debit",
              "bancontact",
              "blik",
              "boleto",
              "card",
              "card_present",
              "cashapp",
              "customer_balance",
              "eps",
              "fpx",
              "giropay",
              "grabpay",
              "ideal",
              "interac_present",
              "kakao_pay",
              "klarna",
              "konbini",
              "kr_card",
              "link",
              "mobilepay",
              "multibanco",
              "naver_pay",
              "oxxo",
              "p24",
              "pay_by_bank",
              "payco",
              "paynow",
              "paypal",
              "pix",
              "promptpay",
              "revolut_pay",
              "samsung_pay",
              "sepa_debit",
              "sofort",
              "swish",
              "twint",
              "us_bank_account",
              "wechat_pay",
              "zip"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/payment_method_us_bank_account"
          },
          "wechat_pay": {
            "$ref": "#/components/schemas/payment_method_wechat_pay"
          },
          "zip": {
            "$ref": "#/components/schemas/payment_method_zip"
          }
        },
        "required": ["billing_details", "type"],
        "title": "ConfirmationTokensResourcePaymentMethodPreview",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "billing_details",
          "blik",
          "boleto",
          "card",
          "card_present",
          "cashapp",
          "customer",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "interac_present",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "pix",
          "promptpay",
          "revolut_pay",
          "samsung_pay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ]
      },
      "confirmation_tokens_resource_shipping": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "name": {
            "description": "Recipient name.",
            "maxLength": 5000,
            "type": "string"
          },
          "phone": {
            "description": "Recipient phone (including extension).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["address", "name"],
        "title": "ConfirmationTokensResourceShipping",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "connect_account_reference": {
        "description": "",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The connected account being referenced when `type` is `account`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "type": {
            "description": "Type of the account referenced.",
            "enum": ["account", "self"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "ConnectAccountReference",
        "type": "object",
        "x-expandableFields": ["account"]
      },
      "connect_collection_transfer": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount transferred, in cents (or local equivalent).",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "ID of the account that funds are being collected for.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["connect_collection_transfer"],
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "destination",
          "id",
          "livemode",
          "object"
        ],
        "title": "ConnectCollectionTransfer",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "connect_embedded_account_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_account_features_claim"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedAccountConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_account_features_claim": {
        "description": "",
        "properties": {
          "disable_stripe_user_authentication": {
            "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.",
            "type": "boolean"
          },
          "external_account_collection": {
            "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.",
            "type": "boolean"
          }
        },
        "required": [
          "disable_stripe_user_authentication",
          "external_account_collection"
        ],
        "title": "ConnectEmbeddedAccountFeaturesClaim",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_account_session_create_components": {
        "description": "",
        "properties": {
          "account_management": {
            "$ref": "#/components/schemas/connect_embedded_account_config_claim"
          },
          "account_onboarding": {
            "$ref": "#/components/schemas/connect_embedded_account_config_claim"
          },
          "balances": {
            "$ref": "#/components/schemas/connect_embedded_payouts_config"
          },
          "documents": {
            "$ref": "#/components/schemas/connect_embedded_base_config_claim"
          },
          "financial_account": {
            "$ref": "#/components/schemas/connect_embedded_financial_account_config_claim"
          },
          "financial_account_transactions": {
            "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_config_claim"
          },
          "issuing_card": {
            "$ref": "#/components/schemas/connect_embedded_issuing_card_config_claim"
          },
          "issuing_cards_list": {
            "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_config_claim"
          },
          "notification_banner": {
            "$ref": "#/components/schemas/connect_embedded_account_config_claim"
          },
          "payment_details": {
            "$ref": "#/components/schemas/connect_embedded_payments_config_claim"
          },
          "payments": {
            "$ref": "#/components/schemas/connect_embedded_payments_config_claim"
          },
          "payouts": {
            "$ref": "#/components/schemas/connect_embedded_payouts_config"
          },
          "payouts_list": {
            "$ref": "#/components/schemas/connect_embedded_base_config_claim"
          },
          "tax_registrations": {
            "$ref": "#/components/schemas/connect_embedded_base_config_claim"
          },
          "tax_settings": {
            "$ref": "#/components/schemas/connect_embedded_base_config_claim"
          }
        },
        "required": [
          "account_management",
          "account_onboarding",
          "balances",
          "documents",
          "financial_account",
          "financial_account_transactions",
          "issuing_card",
          "issuing_cards_list",
          "notification_banner",
          "payment_details",
          "payments",
          "payouts",
          "payouts_list",
          "tax_registrations",
          "tax_settings"
        ],
        "title": "ConnectEmbeddedAccountSessionCreateComponents",
        "type": "object",
        "x-expandableFields": [
          "account_management",
          "account_onboarding",
          "balances",
          "documents",
          "financial_account",
          "financial_account_transactions",
          "issuing_card",
          "issuing_cards_list",
          "notification_banner",
          "payment_details",
          "payments",
          "payouts",
          "payouts_list",
          "tax_registrations",
          "tax_settings"
        ]
      },
      "connect_embedded_base_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_base_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedBaseConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_base_features": {
        "description": "",
        "properties": {},
        "title": "ConnectEmbeddedBaseFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_financial_account_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_financial_account_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedFinancialAccountConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_financial_account_features": {
        "description": "",
        "properties": {
          "disable_stripe_user_authentication": {
            "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.",
            "type": "boolean"
          },
          "external_account_collection": {
            "description": "Whether to allow external accounts to be linked for money transfer.",
            "type": "boolean"
          },
          "send_money": {
            "description": "Whether to allow sending money.",
            "type": "boolean"
          },
          "transfer_balance": {
            "description": "Whether to allow transferring balance.",
            "type": "boolean"
          }
        },
        "required": [
          "disable_stripe_user_authentication",
          "external_account_collection",
          "send_money",
          "transfer_balance"
        ],
        "title": "ConnectEmbeddedFinancialAccountFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_financial_account_transactions_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedFinancialAccountTransactionsConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_financial_account_transactions_features": {
        "description": "",
        "properties": {
          "card_spend_dispute_management": {
            "description": "Whether to allow card spend dispute management features.",
            "type": "boolean"
          }
        },
        "required": ["card_spend_dispute_management"],
        "title": "ConnectEmbeddedFinancialAccountTransactionsFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_issuing_card_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_issuing_card_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedIssuingCardConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_issuing_card_features": {
        "description": "",
        "properties": {
          "card_management": {
            "description": "Whether to allow card management features.",
            "type": "boolean"
          },
          "card_spend_dispute_management": {
            "description": "Whether to allow card spend dispute management features.",
            "type": "boolean"
          },
          "cardholder_management": {
            "description": "Whether to allow cardholder management features.",
            "type": "boolean"
          },
          "spend_control_management": {
            "description": "Whether to allow spend control management features.",
            "type": "boolean"
          }
        },
        "required": [
          "card_management",
          "card_spend_dispute_management",
          "cardholder_management",
          "spend_control_management"
        ],
        "title": "ConnectEmbeddedIssuingCardFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_issuing_cards_list_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedIssuingCardsListConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_issuing_cards_list_features": {
        "description": "",
        "properties": {
          "card_management": {
            "description": "Whether to allow card management features.",
            "type": "boolean"
          },
          "card_spend_dispute_management": {
            "description": "Whether to allow card spend dispute management features.",
            "type": "boolean"
          },
          "cardholder_management": {
            "description": "Whether to allow cardholder management features.",
            "type": "boolean"
          },
          "disable_stripe_user_authentication": {
            "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts.",
            "type": "boolean"
          },
          "spend_control_management": {
            "description": "Whether to allow spend control management features.",
            "type": "boolean"
          }
        },
        "required": [
          "card_management",
          "card_spend_dispute_management",
          "cardholder_management",
          "disable_stripe_user_authentication",
          "spend_control_management"
        ],
        "title": "ConnectEmbeddedIssuingCardsListFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_payments_config_claim": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_payments_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedPaymentsConfigClaim",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_payments_features": {
        "description": "",
        "properties": {
          "capture_payments": {
            "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
            "type": "boolean"
          },
          "destination_on_behalf_of_charge_management": {
            "description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.",
            "type": "boolean"
          },
          "dispute_management": {
            "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
            "type": "boolean"
          },
          "refund_management": {
            "description": "Whether to allow sending refunds. This is `true` by default.",
            "type": "boolean"
          }
        },
        "required": [
          "capture_payments",
          "destination_on_behalf_of_charge_management",
          "dispute_management",
          "refund_management"
        ],
        "title": "ConnectEmbeddedPaymentsFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "connect_embedded_payouts_config": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the embedded component is enabled.",
            "type": "boolean"
          },
          "features": {
            "$ref": "#/components/schemas/connect_embedded_payouts_features"
          }
        },
        "required": ["enabled", "features"],
        "title": "ConnectEmbeddedPayoutsConfig",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "connect_embedded_payouts_features": {
        "description": "",
        "properties": {
          "disable_stripe_user_authentication": {
            "description": "Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.",
            "type": "boolean"
          },
          "edit_payout_schedule": {
            "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
            "type": "boolean"
          },
          "external_account_collection": {
            "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.",
            "type": "boolean"
          },
          "instant_payouts": {
            "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
            "type": "boolean"
          },
          "standard_payouts": {
            "description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
            "type": "boolean"
          }
        },
        "required": [
          "disable_stripe_user_authentication",
          "edit_payout_schedule",
          "external_account_collection",
          "instant_payouts",
          "standard_payouts"
        ],
        "title": "ConnectEmbeddedPayoutsFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "country_spec": {
        "description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).",
        "properties": {
          "default_currency": {
            "description": "The default currency for this country. This applies to both payment methods and bank accounts.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object. Represented as the ISO country code for this country.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["country_spec"],
            "type": "string"
          },
          "supported_bank_account_currencies": {
            "additionalProperties": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "description": "Currencies that can be accepted in the specific country (for transfers).",
            "type": "object"
          },
          "supported_payment_currencies": {
            "description": "Currencies that can be accepted in the specified country (for payments).",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "supported_payment_methods": {
            "description": "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "supported_transfer_countries": {
            "description": "Countries that can accept transfers from the specified country.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "verification_fields": {
            "$ref": "#/components/schemas/country_spec_verification_fields"
          }
        },
        "required": [
          "default_currency",
          "id",
          "object",
          "supported_bank_account_currencies",
          "supported_payment_currencies",
          "supported_payment_methods",
          "supported_transfer_countries",
          "verification_fields"
        ],
        "title": "CountrySpec",
        "type": "object",
        "x-expandableFields": ["verification_fields"],
        "x-resourceId": "country_spec"
      },
      "country_spec_verification_field_details": {
        "description": "",
        "properties": {
          "additional": {
            "description": "Additional fields which are only required for some users.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "minimum": {
            "description": "Fields which every account must eventually provide.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["additional", "minimum"],
        "title": "CountrySpecVerificationFieldDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "country_spec_verification_fields": {
        "description": "",
        "properties": {
          "company": {
            "$ref": "#/components/schemas/country_spec_verification_field_details"
          },
          "individual": {
            "$ref": "#/components/schemas/country_spec_verification_field_details"
          }
        },
        "required": ["company", "individual"],
        "title": "CountrySpecVerificationFields",
        "type": "object",
        "x-expandableFields": ["company", "individual"]
      },
      "coupon": {
        "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),\n[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).",
        "properties": {
          "amount_off": {
            "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.",
            "nullable": true,
            "type": "integer"
          },
          "applies_to": {
            "$ref": "#/components/schemas/coupon_applies_to"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "currency_options": {
            "additionalProperties": {
              "$ref": "#/components/schemas/coupon_currency_option"
            },
            "description": "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
            "type": "object"
          },
          "duration": {
            "description": "One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount.",
            "enum": ["forever", "once", "repeating"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "duration_in_months": {
            "description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "max_redemptions": {
            "description": "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.",
            "nullable": true,
            "type": "integer"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "name": {
            "description": "Name of the coupon displayed to customers on for instance invoices or receipts.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["coupon"],
            "type": "string"
          },
          "percent_off": {
            "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.",
            "nullable": true,
            "type": "number"
          },
          "redeem_by": {
            "description": "Date after which the coupon can no longer be redeemed.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "times_redeemed": {
            "description": "Number of times this coupon has been applied to a customer.",
            "type": "integer"
          },
          "valid": {
            "description": "Taking account of the above properties, whether this coupon can still be applied to a customer.",
            "type": "boolean"
          }
        },
        "required": [
          "created",
          "duration",
          "id",
          "livemode",
          "object",
          "times_redeemed",
          "valid"
        ],
        "title": "Coupon",
        "type": "object",
        "x-expandableFields": ["applies_to", "currency_options"],
        "x-resourceId": "coupon"
      },
      "coupon_applies_to": {
        "description": "",
        "properties": {
          "products": {
            "description": "A list of product IDs this coupon applies to",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["products"],
        "title": "CouponAppliesTo",
        "type": "object",
        "x-expandableFields": []
      },
      "coupon_currency_option": {
        "description": "",
        "properties": {
          "amount_off": {
            "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.",
            "type": "integer"
          }
        },
        "required": ["amount_off"],
        "title": "CouponCurrencyOption",
        "type": "object",
        "x-expandableFields": []
      },
      "credit_balance": {
        "description": "",
        "properties": {
          "available_balance": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
          },
          "ledger_balance": {
            "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
          }
        },
        "required": ["available_balance", "ledger_balance"],
        "title": "CreditBalance",
        "type": "object",
        "x-expandableFields": ["available_balance", "ledger_balance"]
      },
      "credit_note": {
        "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)",
        "properties": {
          "amount": {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.",
            "type": "integer"
          },
          "amount_shipping": {
            "description": "This is the sum of all the shipping amounts.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the customer.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "customer_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer_balance_transaction"
              }
            ],
            "description": "Customer balance transaction related to this credit note.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer_balance_transaction"
                }
              ]
            }
          },
          "discount_amount": {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.",
            "type": "integer"
          },
          "discount_amounts": {
            "description": "The aggregate amounts calculated per discount for all line items.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_discount_amount"
            },
            "type": "array"
          },
          "effective_at": {
            "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "ID of the invoice.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "lines": {
            "description": "Line items that make up the credit note",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/credit_note_line_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "CreditNoteLinesList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "memo": {
            "description": "Customer-facing text that appears on the credit note PDF.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "number": {
            "description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["credit_note"],
            "type": "string"
          },
          "out_of_band_amount": {
            "description": "Amount that was credited outside of Stripe.",
            "nullable": true,
            "type": "integer"
          },
          "pdf": {
            "description": "The link to download the PDF of the credit note.",
            "maxLength": 5000,
            "type": "string"
          },
          "pretax_credit_amounts": {
            "description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items.",
            "items": {
              "$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
            },
            "type": "array"
          },
          "reason": {
            "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`",
            "enum": [
              "duplicate",
              "fraudulent",
              "order_change",
              "product_unsatisfactory"
            ],
            "nullable": true,
            "type": "string"
          },
          "refund": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/refund"
              }
            ],
            "description": "Refund related to this credit note.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/refund"
                }
              ]
            }
          },
          "shipping_cost": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_shipping_cost"
              }
            ],
            "description": "The details of the cost of shipping, including the ShippingRate applied to the invoice.",
            "nullable": true
          },
          "status": {
            "description": "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).",
            "enum": ["issued", "void"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "subtotal": {
            "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.",
            "type": "integer"
          },
          "subtotal_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.",
            "nullable": true,
            "type": "integer"
          },
          "tax_amounts": {
            "description": "The aggregate amounts calculated per tax rate for all line items.",
            "items": {
              "$ref": "#/components/schemas/credit_note_tax_amount"
            },
            "type": "array"
          },
          "total": {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.",
            "type": "integer"
          },
          "total_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.",
            "nullable": true,
            "type": "integer"
          },
          "type": {
            "description": "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.",
            "enum": ["post_payment", "pre_payment"],
            "type": "string"
          },
          "voided_at": {
            "description": "The time that the credit note was voided.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "amount_shipping",
          "created",
          "currency",
          "customer",
          "discount_amount",
          "discount_amounts",
          "id",
          "invoice",
          "lines",
          "livemode",
          "number",
          "object",
          "pdf",
          "pretax_credit_amounts",
          "status",
          "subtotal",
          "tax_amounts",
          "total",
          "type"
        ],
        "title": "CreditNote",
        "type": "object",
        "x-expandableFields": [
          "customer",
          "customer_balance_transaction",
          "discount_amounts",
          "invoice",
          "lines",
          "pretax_credit_amounts",
          "refund",
          "shipping_cost",
          "tax_amounts"
        ],
        "x-resourceId": "credit_note"
      },
      "credit_note_line_item": {
        "description": "The credit note line item object",
        "properties": {
          "amount": {
            "description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.",
            "type": "integer"
          },
          "amount_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.",
            "nullable": true,
            "type": "integer"
          },
          "description": {
            "description": "Description of the item being credited.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discount_amount": {
            "description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item.",
            "type": "integer"
          },
          "discount_amounts": {
            "description": "The amount of discount calculated per discount for this line item",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_discount_amount"
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice_line_item": {
            "description": "ID of the invoice line item being credited",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["credit_note_line_item"],
            "type": "string"
          },
          "pretax_credit_amounts": {
            "description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item.",
            "items": {
              "$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
            },
            "type": "array"
          },
          "quantity": {
            "description": "The number of units of product being credited.",
            "nullable": true,
            "type": "integer"
          },
          "tax_amounts": {
            "description": "The amount of tax calculated per tax rate for this line item",
            "items": {
              "$ref": "#/components/schemas/credit_note_tax_amount"
            },
            "type": "array"
          },
          "tax_rates": {
            "description": "The tax rates which apply to the line item.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "type": "array"
          },
          "type": {
            "description": "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.",
            "enum": ["custom_line_item", "invoice_line_item"],
            "type": "string"
          },
          "unit_amount": {
            "description": "The cost of each unit of product being credited.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "unit_amount_excluding_tax": {
            "description": "The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "discount_amount",
          "discount_amounts",
          "id",
          "livemode",
          "object",
          "pretax_credit_amounts",
          "tax_amounts",
          "tax_rates",
          "type"
        ],
        "title": "CreditNoteLineItem",
        "type": "object",
        "x-expandableFields": [
          "discount_amounts",
          "pretax_credit_amounts",
          "tax_amounts",
          "tax_rates"
        ],
        "x-resourceId": "credit_note_line_item"
      },
      "credit_note_tax_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent), of the tax.",
            "type": "integer"
          },
          "inclusive": {
            "description": "Whether this tax amount is inclusive or exclusive.",
            "type": "boolean"
          },
          "tax_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/tax_rate"
              }
            ],
            "description": "The tax rate that was applied to get this tax amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/tax_rate"
                }
              ]
            }
          },
          "taxability_reason": {
            "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
            "enum": [
              "customer_exempt",
              "not_collecting",
              "not_subject_to_tax",
              "not_supported",
              "portion_product_exempt",
              "portion_reduced_rated",
              "portion_standard_rated",
              "product_exempt",
              "product_exempt_holiday",
              "proportionally_rated",
              "reduced_rated",
              "reverse_charge",
              "standard_rated",
              "taxable_basis_reduced",
              "zero_rated"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "taxable_amount": {
            "description": "The amount on which tax is calculated, in cents (or local equivalent).",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["amount", "inclusive", "tax_rate"],
        "title": "CreditNoteTaxAmount",
        "type": "object",
        "x-expandableFields": ["tax_rate"]
      },
      "credit_notes_pretax_credit_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent), of the pretax credit amount.",
            "type": "integer"
          },
          "credit_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/billing.credit_balance_transaction"
              }
            ],
            "description": "The credit balance transaction that was applied to get this pretax credit amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/billing.credit_balance_transaction"
                }
              ]
            }
          },
          "discount": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/discount"
              },
              {
                "$ref": "#/components/schemas/deleted_discount"
              }
            ],
            "description": "The discount that was applied to get this pretax credit amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/discount"
                },
                {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              ]
            }
          },
          "type": {
            "description": "Type of the pretax credit amount referenced.",
            "enum": ["credit_balance_transaction", "discount"],
            "type": "string"
          }
        },
        "required": ["amount", "type"],
        "title": "CreditNotesPretaxCreditAmount",
        "type": "object",
        "x-expandableFields": ["credit_balance_transaction", "discount"]
      },
      "currency_option": {
        "description": "",
        "properties": {
          "custom_unit_amount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/custom_unit_amount"
              }
            ],
            "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.",
            "nullable": true
          },
          "tax_behavior": {
            "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
            "enum": ["exclusive", "inclusive", "unspecified"],
            "nullable": true,
            "type": "string"
          },
          "tiers": {
            "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
            "items": {
              "$ref": "#/components/schemas/price_tier"
            },
            "type": "array"
          },
          "unit_amount": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CurrencyOption",
        "type": "object",
        "x-expandableFields": ["custom_unit_amount", "tiers"]
      },
      "custom_unit_amount": {
        "description": "",
        "properties": {
          "maximum": {
            "description": "The maximum unit amount the customer can specify for this item.",
            "nullable": true,
            "type": "integer"
          },
          "minimum": {
            "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.",
            "nullable": true,
            "type": "integer"
          },
          "preset": {
            "description": "The starting unit amount which can be updated by the customer.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "CustomUnitAmount",
        "type": "object",
        "x-expandableFields": []
      },
      "customer": {
        "description": "This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,\nand track payments that belong to the same customer.",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "The customer's address.",
            "nullable": true
          },
          "balance": {
            "description": "The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.",
            "type": "integer"
          },
          "cash_balance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/cash_balance"
              }
            ],
            "description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.",
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "default_source": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "description": "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/bank_account"
                },
                {
                  "$ref": "#/components/schemas/card"
                },
                {
                  "$ref": "#/components/schemas/source"
                }
              ]
            },
            "x-stripeBypassValidation": true
          },
          "delinquent": {
            "description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.",
            "nullable": true,
            "type": "boolean"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/discount"
              }
            ],
            "description": "Describes the current discount active on the customer, if there is one.",
            "nullable": true
          },
          "email": {
            "description": "The customer's email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice_credit_balance": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.",
            "type": "object"
          },
          "invoice_prefix": {
            "description": "The prefix for the customer used to generate unique invoice numbers.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_settings": {
            "$ref": "#/components/schemas/invoice_setting_customer_setting"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "The customer's full name or business name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "next_invoice_sequence": {
            "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["customer"],
            "type": "string"
          },
          "phone": {
            "description": "The customer's phone number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_locales": {
            "description": "The customer's preferred locales (languages), ordered by preference.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer.",
            "nullable": true
          },
          "sources": {
            "description": "The customer's payment sources, if any.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/bank_account"
                    },
                    {
                      "$ref": "#/components/schemas/card"
                    },
                    {
                      "$ref": "#/components/schemas/source"
                    }
                  ],
                  "title": "Polymorphic",
                  "x-stripeBypassValidation": true
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "ApmsSourcesSourceList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "subscriptions": {
            "description": "The customer's current subscriptions, if any.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/subscription"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "SubscriptionList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "tax": {
            "$ref": "#/components/schemas/customer_tax"
          },
          "tax_exempt": {
            "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.",
            "enum": ["exempt", "none", "reverse"],
            "nullable": true,
            "type": "string"
          },
          "tax_ids": {
            "description": "The customer's tax IDs.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/tax_id"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "TaxIDsList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock that this customer belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          }
        },
        "required": ["created", "id", "livemode", "object"],
        "title": "Customer",
        "type": "object",
        "x-expandableFields": [
          "address",
          "cash_balance",
          "default_source",
          "discount",
          "invoice_settings",
          "shipping",
          "sources",
          "subscriptions",
          "tax",
          "tax_ids",
          "test_clock"
        ],
        "x-resourceId": "customer"
      },
      "customer_acceptance": {
        "description": "",
        "properties": {
          "accepted_at": {
            "description": "The time that the customer accepts the mandate.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "offline": {
            "$ref": "#/components/schemas/offline_acceptance"
          },
          "online": {
            "$ref": "#/components/schemas/online_acceptance"
          },
          "type": {
            "description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`.",
            "enum": ["offline", "online"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "customer_acceptance",
        "type": "object",
        "x-expandableFields": ["offline", "online"]
      },
      "customer_balance_customer_balance_settings": {
        "description": "",
        "properties": {
          "reconciliation_mode": {
            "description": "The configuration for how funds that land in the customer cash balance are reconciled.",
            "enum": ["automatic", "manual"],
            "type": "string"
          },
          "using_merchant_default": {
            "description": "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance",
            "type": "boolean"
          }
        },
        "required": ["reconciliation_mode", "using_merchant_default"],
        "title": "CustomerBalanceCustomerBalanceSettings",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": {
        "description": "",
        "properties": {
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "linked_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer_cash_balance_transaction"
              }
            ],
            "description": "The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer_cash_balance_transaction"
                }
              ]
            }
          }
        },
        "required": ["balance_transaction", "linked_transaction"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft",
        "type": "object",
        "x-expandableFields": ["balance_transaction", "linked_transaction"]
      },
      "customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction": {
        "description": "",
        "properties": {
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          }
        },
        "required": ["payment_intent"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction",
        "type": "object",
        "x-expandableFields": ["payment_intent"]
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction": {
        "description": "",
        "properties": {
          "bank_transfer": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
          }
        },
        "required": ["bank_transfer"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction",
        "type": "object",
        "x-expandableFields": ["bank_transfer"]
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": {
        "description": "",
        "properties": {
          "eu_bank_transfer": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"
          },
          "gb_bank_transfer": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"
          },
          "jp_bank_transfer": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"
          },
          "reference": {
            "description": "The user-supplied reference field on the bank transfer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
            "enum": [
              "eu_bank_transfer",
              "gb_bank_transfer",
              "jp_bank_transfer",
              "mx_bank_transfer",
              "us_bank_transfer"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_transfer": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer"
          }
        },
        "required": ["type"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer",
        "type": "object",
        "x-expandableFields": [
          "eu_bank_transfer",
          "gb_bank_transfer",
          "jp_bank_transfer",
          "us_bank_transfer"
        ]
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": {
        "description": "",
        "properties": {
          "bic": {
            "description": "The BIC of the bank of the sender of the funding.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "iban_last4": {
            "description": "The last 4 digits of the IBAN of the sender of the funding.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sender_name": {
            "description": "The full name of the sender, as supplied by the sending bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": {
        "description": "",
        "properties": {
          "account_number_last4": {
            "description": "The last 4 digits of the account number of the sender of the funding.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sender_name": {
            "description": "The full name of the sender, as supplied by the sending bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sort_code": {
            "description": "The sort code of the bank of the sender of the funding",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": {
        "description": "",
        "properties": {
          "sender_bank": {
            "description": "The name of the bank of the sender of the funding.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sender_branch": {
            "description": "The name of the bank branch of the sender of the funding.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sender_name": {
            "description": "The full name of the sender, as supplied by the sending bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": {
        "description": "",
        "properties": {
          "network": {
            "description": "The banking network used for this funding.",
            "enum": ["ach", "domestic_wire_us", "swift"],
            "type": "string"
          },
          "sender_name": {
            "description": "The full name of the sender, as supplied by the sending bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": {
        "description": "",
        "properties": {
          "refund": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/refund"
              }
            ],
            "description": "The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/refund"
                }
              ]
            }
          }
        },
        "required": ["refund"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction",
        "type": "object",
        "x-expandableFields": ["refund"]
      },
      "customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance": {
        "description": "",
        "properties": {
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          }
        },
        "required": ["balance_transaction"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance",
        "type": "object",
        "x-expandableFields": ["balance_transaction"]
      },
      "customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction": {
        "description": "",
        "properties": {
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          }
        },
        "required": ["payment_intent"],
        "title": "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction",
        "type": "object",
        "x-expandableFields": ["payment_intent"]
      },
      "customer_balance_transaction": {
        "description": "Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)",
        "properties": {
          "amount": {
            "description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "credit_note": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/credit_note"
              }
            ],
            "description": "The ID of the credit note (if any) related to the transaction.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/credit_note"
                }
              ]
            }
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The ID of the customer the transaction belongs to.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "ending_balance": {
            "description": "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The ID of the invoice (if any) related to the transaction.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["customer_balance_transaction"],
            "type": "string"
          },
          "type": {
            "description": "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.",
            "enum": [
              "adjustment",
              "applied_to_invoice",
              "credit_note",
              "initial",
              "invoice_overpaid",
              "invoice_too_large",
              "invoice_too_small",
              "migration",
              "unapplied_from_invoice",
              "unspent_receiver_credit"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "customer",
          "ending_balance",
          "id",
          "livemode",
          "object",
          "type"
        ],
        "title": "CustomerBalanceTransaction",
        "type": "object",
        "x-expandableFields": ["credit_note", "customer", "invoice"],
        "x-resourceId": "customer_balance_transaction"
      },
      "customer_cash_balance_transaction": {
        "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.",
        "properties": {
          "adjusted_for_overdraft": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"
          },
          "applied_to_payment": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The customer whose available cash balance changed as a result of this transaction.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "ending_balance": {
            "description": "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "funded": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "net_amount": {
            "description": "The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["customer_cash_balance_transaction"],
            "type": "string"
          },
          "refunded_from_payment": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"
          },
          "transferred_to_balance": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"
          },
          "type": {
            "description": "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.",
            "enum": [
              "adjusted_for_overdraft",
              "applied_to_payment",
              "funded",
              "funding_reversed",
              "refunded_from_payment",
              "return_canceled",
              "return_initiated",
              "transferred_to_balance",
              "unapplied_from_payment"
            ],
            "type": "string"
          },
          "unapplied_from_payment": {
            "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"
          }
        },
        "required": [
          "created",
          "currency",
          "customer",
          "ending_balance",
          "id",
          "livemode",
          "net_amount",
          "object",
          "type"
        ],
        "title": "CustomerCashBalanceTransaction",
        "type": "object",
        "x-expandableFields": [
          "adjusted_for_overdraft",
          "applied_to_payment",
          "customer",
          "funded",
          "refunded_from_payment",
          "transferred_to_balance",
          "unapplied_from_payment"
        ],
        "x-resourceId": "customer_cash_balance_transaction"
      },
      "customer_session": {
        "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
        "properties": {
          "client_secret": {
            "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
            "maxLength": 5000,
            "type": "string"
          },
          "components": {
            "$ref": "#/components/schemas/customer_session_resource_components"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The Customer the Customer Session was created for.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "expires_at": {
            "description": "The timestamp at which this Customer Session will expire.",
            "format": "unix-time",
            "type": "integer"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["customer_session"],
            "type": "string"
          }
        },
        "required": [
          "client_secret",
          "created",
          "customer",
          "expires_at",
          "livemode",
          "object"
        ],
        "title": "CustomerSessionResourceCustomerSession",
        "type": "object",
        "x-expandableFields": ["components", "customer"],
        "x-resourceId": "customer_session"
      },
      "customer_session_resource_components": {
        "description": "Configuration for the components supported by this Customer Session.",
        "properties": {
          "buy_button": {
            "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
          },
          "payment_element": {
            "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element"
          },
          "pricing_table": {
            "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table"
          }
        },
        "required": ["buy_button", "payment_element", "pricing_table"],
        "title": "CustomerSessionResourceComponents",
        "type": "object",
        "x-expandableFields": ["buy_button", "payment_element", "pricing_table"]
      },
      "customer_session_resource_components_resource_buy_button": {
        "description": "This hash contains whether the buy button is enabled.",
        "properties": {
          "enabled": {
            "description": "Whether the buy button is enabled.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "CustomerSessionResourceComponentsResourceBuyButton",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_session_resource_components_resource_payment_element": {
        "description": "This hash contains whether the Payment Element is enabled and the features it supports.",
        "properties": {
          "enabled": {
            "description": "Whether the Payment Element is enabled.",
            "type": "boolean"
          },
          "features": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features"
              }
            ],
            "description": "This hash defines whether the Payment Element supports certain features.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "CustomerSessionResourceComponentsResourcePaymentElement",
        "type": "object",
        "x-expandableFields": ["features"]
      },
      "customer_session_resource_components_resource_payment_element_resource_features": {
        "description": "This hash contains the features the Payment Element supports.",
        "properties": {
          "payment_method_allow_redisplay_filters": {
            "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].",
            "items": {
              "enum": ["always", "limited", "unspecified"],
              "type": "string"
            },
            "type": "array"
          },
          "payment_method_redisplay": {
            "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.",
            "enum": ["disabled", "enabled"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "payment_method_redisplay_limit": {
            "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.",
            "nullable": true,
            "type": "integer"
          },
          "payment_method_remove": {
            "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
            "enum": ["disabled", "enabled"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "payment_method_save": {
            "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
            "enum": ["disabled", "enabled"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "payment_method_save_usage": {
            "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.",
            "enum": ["off_session", "on_session"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "payment_method_allow_redisplay_filters",
          "payment_method_redisplay",
          "payment_method_remove",
          "payment_method_save"
        ],
        "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_session_resource_components_resource_pricing_table": {
        "description": "This hash contains whether the pricing table is enabled.",
        "properties": {
          "enabled": {
            "description": "Whether the pricing table is enabled.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "CustomerSessionResourceComponentsResourcePricingTable",
        "type": "object",
        "x-expandableFields": []
      },
      "customer_tax": {
        "description": "",
        "properties": {
          "automatic_tax": {
            "description": "Surfaces if automatic tax computation is possible given the current customer location information.",
            "enum": [
              "failed",
              "not_collecting",
              "supported",
              "unrecognized_location"
            ],
            "type": "string"
          },
          "ip_address": {
            "description": "A recent IP address of the customer used for tax reporting and tax location inference.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "location": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/customer_tax_location"
              }
            ],
            "description": "The customer's location as identified by Stripe Tax.",
            "nullable": true
          }
        },
        "required": ["automatic_tax"],
        "title": "CustomerTax",
        "type": "object",
        "x-expandableFields": ["location"]
      },
      "customer_tax_location": {
        "description": "",
        "properties": {
          "country": {
            "description": "The customer's country as identified by Stripe Tax.",
            "maxLength": 5000,
            "type": "string"
          },
          "source": {
            "description": "The data source used to infer the customer's location.",
            "enum": [
              "billing_address",
              "ip_address",
              "payment_method",
              "shipping_destination"
            ],
            "type": "string"
          },
          "state": {
            "description": "The customer's state, county, province, or region as identified by Stripe Tax.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["country", "source"],
        "title": "CustomerTaxLocation",
        "type": "object",
        "x-expandableFields": []
      },
      "deleted_account": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["account"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedAccount",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_account"
      },
      "deleted_apple_pay_domain": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["apple_pay_domain"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedApplePayDomain",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_apple_pay_domain"
      },
      "deleted_application": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "The name of the application.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["application"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedApplication",
        "type": "object",
        "x-expandableFields": []
      },
      "deleted_bank_account": {
        "description": "",
        "properties": {
          "currency": {
            "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["bank_account"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedBankAccount",
        "type": "object",
        "x-expandableFields": []
      },
      "deleted_card": {
        "description": "",
        "properties": {
          "currency": {
            "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["card"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedCard",
        "type": "object",
        "x-expandableFields": []
      },
      "deleted_coupon": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["coupon"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedCoupon",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_coupon"
      },
      "deleted_customer": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["customer"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedCustomer",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_customer"
      },
      "deleted_discount": {
        "description": "",
        "properties": {
          "checkout_session": {
            "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "coupon": {
            "$ref": "#/components/schemas/coupon"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer associated with this discount.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_item": {
            "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["discount"],
            "type": "string"
          },
          "promotion_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/promotion_code"
              }
            ],
            "description": "The promotion code applied to create this discount.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/promotion_code"
                }
              ]
            }
          },
          "start": {
            "description": "Date that the coupon was applied.",
            "format": "unix-time",
            "type": "integer"
          },
          "subscription": {
            "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "subscription_item": {
            "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["coupon", "deleted", "id", "object", "start"],
        "title": "DeletedDiscount",
        "type": "object",
        "x-expandableFields": ["coupon", "customer", "promotion_code"],
        "x-resourceId": "deleted_discount"
      },
      "deleted_external_account": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/deleted_bank_account"
          },
          {
            "$ref": "#/components/schemas/deleted_card"
          }
        ],
        "title": "Polymorphic",
        "x-resourceId": "deleted_external_account",
        "x-stripeBypassValidation": true
      },
      "deleted_invoice": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["invoice"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedInvoice",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_invoice"
      },
      "deleted_invoiceitem": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["invoiceitem"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedInvoiceItem",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_invoiceitem"
      },
      "deleted_payment_source": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/deleted_bank_account"
          },
          {
            "$ref": "#/components/schemas/deleted_card"
          }
        ],
        "title": "Polymorphic",
        "x-resourceId": "deleted_payment_source",
        "x-stripeBypassValidation": true
      },
      "deleted_person": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["person"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedPerson",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_person"
      },
      "deleted_plan": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["plan"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedPlan",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_plan"
      },
      "deleted_price": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["price"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedPrice",
        "type": "object",
        "x-expandableFields": []
      },
      "deleted_product": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["product"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedProduct",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_product"
      },
      "deleted_product_feature": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["product_feature"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedProductFeature",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_product_feature"
      },
      "deleted_radar.value_list": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["radar.value_list"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "RadarListDeletedList",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_radar.value_list"
      },
      "deleted_radar.value_list_item": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["radar.value_list_item"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "RadarListDeletedListItem",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_radar.value_list_item"
      },
      "deleted_subscription_item": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["subscription_item"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedSubscriptionItem",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_subscription_item"
      },
      "deleted_tax_id": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax_id"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "deleted_tax_id",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_tax_id"
      },
      "deleted_terminal.configuration": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.configuration"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "TerminalConfigurationDeletedConfiguration",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_terminal.configuration"
      },
      "deleted_terminal.location": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.location"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "TerminalLocationDeletedLocation",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_terminal.location"
      },
      "deleted_terminal.reader": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.reader"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "TerminalReaderDeletedReader",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_terminal.reader"
      },
      "deleted_test_helpers.test_clock": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["test_helpers.test_clock"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "DeletedTestClock",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_test_helpers.test_clock"
      },
      "deleted_webhook_endpoint": {
        "description": "",
        "properties": {
          "deleted": {
            "description": "Always true for a deleted object",
            "enum": [true],
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["webhook_endpoint"],
            "type": "string"
          }
        },
        "required": ["deleted", "id", "object"],
        "title": "NotificationWebhookEndpointDeleted",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "deleted_webhook_endpoint"
      },
      "destination_details_unimplemented": {
        "description": "",
        "properties": {},
        "title": "destination_details_unimplemented",
        "type": "object",
        "x-expandableFields": []
      },
      "discount": {
        "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)",
        "properties": {
          "checkout_session": {
            "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "coupon": {
            "$ref": "#/components/schemas/coupon"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer associated with this discount.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "end": {
            "description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_item": {
            "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["discount"],
            "type": "string"
          },
          "promotion_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/promotion_code"
              }
            ],
            "description": "The promotion code applied to create this discount.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/promotion_code"
                }
              ]
            }
          },
          "start": {
            "description": "Date that the coupon was applied.",
            "format": "unix-time",
            "type": "integer"
          },
          "subscription": {
            "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "subscription_item": {
            "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["coupon", "id", "object", "start"],
        "title": "Discount",
        "type": "object",
        "x-expandableFields": ["coupon", "customer", "promotion_code"],
        "x-resourceId": "discount"
      },
      "discounts_resource_discount_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent), of the discount.",
            "type": "integer"
          },
          "discount": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/discount"
              },
              {
                "$ref": "#/components/schemas/deleted_discount"
              }
            ],
            "description": "The discount that was applied to get this discount amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/discount"
                },
                {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              ]
            }
          }
        },
        "required": ["amount", "discount"],
        "title": "DiscountsResourceDiscountAmount",
        "type": "object",
        "x-expandableFields": ["discount"]
      },
      "discounts_resource_stackable_discount": {
        "description": "",
        "properties": {
          "coupon": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/coupon"
              }
            ],
            "description": "ID of the coupon to create a new discount for.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/coupon"
                }
              ]
            }
          },
          "discount": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/discount"
              }
            ],
            "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/discount"
                }
              ]
            }
          },
          "promotion_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/promotion_code"
              }
            ],
            "description": "ID of the promotion code to create a new discount for.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/promotion_code"
                }
              ]
            }
          }
        },
        "title": "DiscountsResourceStackableDiscount",
        "type": "object",
        "x-expandableFields": ["coupon", "discount", "promotion_code"]
      },
      "dispute": {
        "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)",
        "properties": {
          "amount": {
            "description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).",
            "type": "integer"
          },
          "balance_transactions": {
            "description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.",
            "items": {
              "$ref": "#/components/schemas/balance_transaction"
            },
            "type": "array"
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the charge that's disputed.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "enhanced_eligibility_types": {
            "description": "List of eligibility types that are included in `enhanced_evidence`.",
            "items": {
              "enum": ["visa_compelling_evidence_3"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "evidence": {
            "$ref": "#/components/schemas/dispute_evidence"
          },
          "evidence_details": {
            "$ref": "#/components/schemas/dispute_evidence_details"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "is_charge_refundable": {
            "description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.",
            "type": "boolean"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["dispute"],
            "type": "string"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "ID of the PaymentIntent that's disputed.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "payment_method_details": {
            "$ref": "#/components/schemas/dispute_payment_method_details"
          },
          "reason": {
            "description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.",
            "enum": [
              "lost",
              "needs_response",
              "under_review",
              "warning_closed",
              "warning_needs_response",
              "warning_under_review",
              "won"
            ],
            "type": "string"
          }
        },
        "required": [
          "amount",
          "balance_transactions",
          "charge",
          "created",
          "currency",
          "enhanced_eligibility_types",
          "evidence",
          "evidence_details",
          "id",
          "is_charge_refundable",
          "livemode",
          "metadata",
          "object",
          "reason",
          "status"
        ],
        "title": "Dispute",
        "type": "object",
        "x-expandableFields": [
          "balance_transactions",
          "charge",
          "evidence",
          "evidence_details",
          "payment_intent",
          "payment_method_details"
        ],
        "x-resourceId": "dispute"
      },
      "dispute_enhanced_eligibility": {
        "description": "",
        "properties": {
          "visa_compelling_evidence_3": {
            "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3"
          },
          "visa_compliance": {
            "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance"
          }
        },
        "title": "DisputeEnhancedEligibility",
        "type": "object",
        "x-expandableFields": ["visa_compelling_evidence_3", "visa_compliance"]
      },
      "dispute_enhanced_eligibility_visa_compelling_evidence3": {
        "description": "",
        "properties": {
          "required_actions": {
            "description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.",
            "items": {
              "enum": [
                "missing_customer_identifiers",
                "missing_disputed_transaction_description",
                "missing_merchandise_or_services",
                "missing_prior_undisputed_transaction_description",
                "missing_prior_undisputed_transactions"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "status": {
            "description": "Visa Compelling Evidence 3.0 eligibility status.",
            "enum": ["not_qualified", "qualified", "requires_action"],
            "type": "string"
          }
        },
        "required": ["required_actions", "status"],
        "title": "DisputeEnhancedEligibilityVisaCompellingEvidence3",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_enhanced_eligibility_visa_compliance": {
        "description": "",
        "properties": {
          "status": {
            "description": "Visa compliance eligibility status.",
            "enum": ["fee_acknowledged", "requires_fee_acknowledgement"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "DisputeEnhancedEligibilityVisaCompliance",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_enhanced_evidence": {
        "description": "",
        "properties": {
          "visa_compelling_evidence_3": {
            "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3"
          },
          "visa_compliance": {
            "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance"
          }
        },
        "title": "DisputeEnhancedEvidence",
        "type": "object",
        "x-expandableFields": ["visa_compelling_evidence_3", "visa_compliance"]
      },
      "dispute_enhanced_evidence_visa_compelling_evidence3": {
        "description": "",
        "properties": {
          "disputed_transaction": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction"
              }
            ],
            "description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.",
            "nullable": true
          },
          "prior_undisputed_transactions": {
            "description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.",
            "items": {
              "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction"
            },
            "type": "array"
          }
        },
        "required": ["prior_undisputed_transactions"],
        "title": "DisputeEnhancedEvidenceVisaCompellingEvidence3",
        "type": "object",
        "x-expandableFields": [
          "disputed_transaction",
          "prior_undisputed_transactions"
        ]
      },
      "dispute_enhanced_evidence_visa_compliance": {
        "description": "",
        "properties": {
          "fee_acknowledged": {
            "description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.",
            "type": "boolean"
          }
        },
        "required": ["fee_acknowledged"],
        "title": "DisputeEnhancedEvidenceVisaCompliance",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_evidence": {
        "description": "",
        "properties": {
          "access_activity_log": {
            "description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "billing_address": {
            "description": "The billing address provided by the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cancellation_policy": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "cancellation_policy_disclosure": {
            "description": "An explanation of how and when the customer was shown your refund policy prior to purchase.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "cancellation_rebuttal": {
            "description": "A justification for why the customer's subscription was not canceled.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "customer_communication": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "customer_email_address": {
            "description": "The email address of the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_name": {
            "description": "The name of the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_purchase_ip": {
            "description": "The IP address that the customer used when making the purchase.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_signature": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "duplicate_charge_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "duplicate_charge_explanation": {
            "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "duplicate_charge_id": {
            "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "enhanced_evidence": {
            "$ref": "#/components/schemas/dispute_enhanced_evidence"
          },
          "product_description": {
            "description": "A description of the product or service that was sold.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "receipt": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "refund_policy": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "refund_policy_disclosure": {
            "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "refund_refusal_explanation": {
            "description": "A justification for why the customer is not entitled to a refund.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "service_date": {
            "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "service_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "shipping_address": {
            "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_carrier": {
            "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_date": {
            "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "shipping_tracking_number": {
            "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "uncategorized_file": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "uncategorized_text": {
            "description": "Any additional evidence or statements.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["enhanced_evidence"],
        "title": "DisputeEvidence",
        "type": "object",
        "x-expandableFields": [
          "cancellation_policy",
          "customer_communication",
          "customer_signature",
          "duplicate_charge_documentation",
          "enhanced_evidence",
          "receipt",
          "refund_policy",
          "service_documentation",
          "shipping_documentation",
          "uncategorized_file"
        ]
      },
      "dispute_evidence_details": {
        "description": "",
        "properties": {
          "due_by": {
            "description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "enhanced_eligibility": {
            "$ref": "#/components/schemas/dispute_enhanced_eligibility"
          },
          "has_evidence": {
            "description": "Whether evidence has been staged for this dispute.",
            "type": "boolean"
          },
          "past_due": {
            "description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.",
            "type": "boolean"
          },
          "submission_count": {
            "description": "The number of times evidence has been submitted. Typically, you may only submit evidence once.",
            "type": "integer"
          }
        },
        "required": [
          "enhanced_eligibility",
          "has_evidence",
          "past_due",
          "submission_count"
        ],
        "title": "DisputeEvidenceDetails",
        "type": "object",
        "x-expandableFields": ["enhanced_eligibility"]
      },
      "dispute_payment_method_details": {
        "description": "",
        "properties": {
          "amazon_pay": {
            "$ref": "#/components/schemas/dispute_payment_method_details_amazon_pay"
          },
          "card": {
            "$ref": "#/components/schemas/dispute_payment_method_details_card"
          },
          "klarna": {
            "$ref": "#/components/schemas/dispute_payment_method_details_klarna"
          },
          "paypal": {
            "$ref": "#/components/schemas/dispute_payment_method_details_paypal"
          },
          "type": {
            "description": "Payment method type.",
            "enum": ["amazon_pay", "card", "klarna", "paypal"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "DisputePaymentMethodDetails",
        "type": "object",
        "x-expandableFields": ["amazon_pay", "card", "klarna", "paypal"]
      },
      "dispute_payment_method_details_amazon_pay": {
        "description": "",
        "properties": {
          "dispute_type": {
            "description": "The AmazonPay dispute type, chargeback or claim",
            "enum": ["chargeback", "claim"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "DisputePaymentMethodDetailsAmazonPay",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_payment_method_details_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "case_type": {
            "description": "The type of dispute opened. Different case types may have varying fees and financial impact.",
            "enum": ["chargeback", "inquiry"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "network_reason_code": {
            "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["brand", "case_type"],
        "title": "DisputePaymentMethodDetailsCard",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_payment_method_details_klarna": {
        "description": "",
        "properties": {
          "reason_code": {
            "description": "The reason for the dispute as defined by Klarna",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "DisputePaymentMethodDetailsKlarna",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_payment_method_details_paypal": {
        "description": "",
        "properties": {
          "case_id": {
            "description": "The ID of the dispute in PayPal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reason_code": {
            "description": "The reason for the dispute as defined by PayPal",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "DisputePaymentMethodDetailsPaypal",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_transaction_shipping_address": {
        "description": "",
        "properties": {
          "city": {
            "description": "City, district, suburb, town, or village.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line1": {
            "description": "Address line 1 (e.g., street, PO Box, or company name).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line2": {
            "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "postal_code": {
            "description": "ZIP or postal code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "State, county, province, or region.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "DisputeTransactionShippingAddress",
        "type": "object",
        "x-expandableFields": []
      },
      "dispute_visa_compelling_evidence3_disputed_transaction": {
        "description": "",
        "properties": {
          "customer_account_id": {
            "description": "User Account ID used to log into business platform. Must be recognizable by the user.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_device_fingerprint": {
            "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_device_id": {
            "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_email_address": {
            "description": "The email address of the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_purchase_ip": {
            "description": "The IP address that the customer used when making the purchase.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "merchandise_or_services": {
            "description": "Categorization of disputed payment.",
            "enum": ["merchandise", "services"],
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "A description of the product or service that was sold.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/dispute_transaction_shipping_address"
              }
            ],
            "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.",
            "nullable": true
          }
        },
        "title": "DisputeVisaCompellingEvidence3DisputedTransaction",
        "type": "object",
        "x-expandableFields": ["shipping_address"]
      },
      "dispute_visa_compelling_evidence3_prior_undisputed_transaction": {
        "description": "",
        "properties": {
          "charge": {
            "description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.",
            "maxLength": 5000,
            "type": "string"
          },
          "customer_account_id": {
            "description": "User Account ID used to log into business platform. Must be recognizable by the user.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_device_fingerprint": {
            "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_device_id": {
            "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_email_address": {
            "description": "The email address of the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_purchase_ip": {
            "description": "The IP address that the customer used when making the purchase.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "A description of the product or service that was sold.",
            "maxLength": 150000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/dispute_transaction_shipping_address"
              }
            ],
            "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.",
            "nullable": true
          }
        },
        "required": ["charge"],
        "title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction",
        "type": "object",
        "x-expandableFields": ["shipping_address"]
      },
      "email_sent": {
        "description": "",
        "properties": {
          "email_sent_at": {
            "description": "The timestamp when the email was sent.",
            "format": "unix-time",
            "type": "integer"
          },
          "email_sent_to": {
            "description": "The recipient's email address.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["email_sent_at", "email_sent_to"],
        "title": "EmailSent",
        "type": "object",
        "x-expandableFields": []
      },
      "entitlements.active_entitlement": {
        "description": "An active entitlement describes access to a feature for a customer.",
        "properties": {
          "feature": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/entitlements.feature"
              }
            ],
            "description": "The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/entitlements.feature"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "lookup_key": {
            "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["entitlements.active_entitlement"],
            "type": "string"
          }
        },
        "required": ["feature", "id", "livemode", "lookup_key", "object"],
        "title": "ActiveEntitlement",
        "type": "object",
        "x-expandableFields": ["feature"],
        "x-resourceId": "entitlements.active_entitlement"
      },
      "entitlements.feature": {
        "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.",
        "properties": {
          "active": {
            "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.",
            "type": "boolean"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "lookup_key": {
            "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.",
            "maxLength": 80,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["entitlements.feature"],
            "type": "string"
          }
        },
        "required": [
          "active",
          "id",
          "livemode",
          "lookup_key",
          "metadata",
          "name",
          "object"
        ],
        "title": "Feature",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "entitlements.feature"
      },
      "ephemeral_key": {
        "description": "",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expires": {
            "description": "Time at which the key will expire. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["ephemeral_key"],
            "type": "string"
          },
          "secret": {
            "description": "The key's secret. You can use this value to make authorized requests to the Stripe API.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["created", "expires", "id", "livemode", "object"],
        "title": "EphemeralKey",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "ephemeral_key"
      },
      "error": {
        "description": "An error response from the Stripe API",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/api_errors"
          }
        },
        "required": ["error"],
        "type": "object"
      },
      "event": {
        "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://docs.stripe.com/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://docs.stripe.com/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.",
        "properties": {
          "account": {
            "description": "The connected account that originates the event.",
            "maxLength": 5000,
            "type": "string"
          },
          "api_version": {
            "description": "The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "data": {
            "$ref": "#/components/schemas/notification_event_data"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["event"],
            "type": "string"
          },
          "pending_webhooks": {
            "description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.",
            "type": "integer"
          },
          "request": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/notification_event_request"
              }
            ],
            "description": "Information on the API request that triggers the event.",
            "nullable": true
          },
          "type": {
            "description": "Description of the event (for example, `invoice.created` or `charge.refunded`).",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "data",
          "id",
          "livemode",
          "object",
          "pending_webhooks",
          "type"
        ],
        "title": "NotificationEvent",
        "type": "object",
        "x-expandableFields": ["data", "request"],
        "x-resourceId": "event"
      },
      "exchange_rate": {
        "description": "`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.\n\n-----\n\n&nbsp;\n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*",
        "properties": {
          "id": {
            "description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["exchange_rate"],
            "type": "string"
          },
          "rates": {
            "additionalProperties": {
              "type": "number"
            },
            "description": "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.",
            "type": "object"
          }
        },
        "required": ["id", "object", "rates"],
        "title": "ExchangeRate",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "exchange_rate"
      },
      "external_account": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          }
        ],
        "title": "Polymorphic",
        "x-resourceId": "external_account",
        "x-stripeBypassValidation": true
      },
      "external_account_requirements": {
        "description": "",
        "properties": {
          "currently_due": {
            "description": "Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "nullable": true,
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "ExternalAccountRequirements",
        "type": "object",
        "x-expandableFields": ["errors"]
      },
      "fee": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount of the fee, in cents.",
            "type": "integer"
          },
          "application": {
            "description": "ID of the Connect application that earned the fee.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["amount", "currency", "type"],
        "title": "Fee",
        "type": "object",
        "x-expandableFields": []
      },
      "fee_refund": {
        "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)",
        "properties": {
          "amount": {
            "description": "Amount, in cents (or local equivalent).",
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "Balance transaction that describes the impact on your account balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "fee": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application_fee"
              }
            ],
            "description": "ID of the application fee that was refunded.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application_fee"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["fee_refund"],
            "type": "string"
          }
        },
        "required": ["amount", "created", "currency", "fee", "id", "object"],
        "title": "FeeRefund",
        "type": "object",
        "x-expandableFields": ["balance_transaction", "fee"],
        "x-resourceId": "fee_refund"
      },
      "file": {
        "description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expires_at": {
            "description": "The file expires and isn't available at this time in epoch seconds.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "filename": {
            "description": "The suitable name for saving the file to a filesystem.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "links": {
            "description": "A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.",
            "nullable": true,
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/file_link"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "pattern": "^/v1/file_links",
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "FileResourceFileLinkList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["file"],
            "type": "string"
          },
          "purpose": {
            "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.",
            "enum": [
              "account_requirement",
              "additional_verification",
              "business_icon",
              "business_logo",
              "customer_signature",
              "dispute_evidence",
              "document_provider_identity_document",
              "finance_report_run",
              "financial_account_statement",
              "identity_document",
              "identity_document_downloadable",
              "issuing_regulatory_reporting",
              "pci_document",
              "selfie",
              "sigma_scheduled_query",
              "tax_document_user_upload",
              "terminal_reader_splashscreen"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "size": {
            "description": "The size of the file object in bytes.",
            "type": "integer"
          },
          "title": {
            "description": "A suitable title for the document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "Use your live secret API key to download the file from this URL.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["created", "id", "object", "purpose", "size"],
        "title": "File",
        "type": "object",
        "x-expandableFields": ["links"],
        "x-resourceId": "file"
      },
      "file_link": {
        "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expired": {
            "description": "Returns if the link is already expired.",
            "type": "boolean"
          },
          "expires_at": {
            "description": "Time that the link expires.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "file": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The file object this link points to.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["file_link"],
            "type": "string"
          },
          "url": {
            "description": "The publicly accessible URL to download the file.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "created",
          "expired",
          "file",
          "id",
          "livemode",
          "metadata",
          "object"
        ],
        "title": "FileLink",
        "type": "object",
        "x-expandableFields": ["file"],
        "x-resourceId": "file_link"
      },
      "financial_connections.account": {
        "description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.",
        "properties": {
          "account_holder": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_accountholder"
              }
            ],
            "description": "The account holder that this account belongs to.",
            "nullable": true
          },
          "balance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_balance"
              }
            ],
            "description": "The most recent information about the account's balance.",
            "nullable": true
          },
          "balance_refresh": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_balance_refresh"
              }
            ],
            "description": "The state of the most recent attempt to refresh the account balance.",
            "nullable": true
          },
          "category": {
            "description": "The type of the account. Account category is further divided in `subcategory`.",
            "enum": ["cash", "credit", "investment", "other"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "display_name": {
            "description": "A human-readable name that has been assigned to this account, either by the account holder or by the institution.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "institution_name": {
            "description": "The name of the institution that holds this account.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "The last 4 digits of the account number. If present, this will be 4 numeric characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["financial_connections.account"],
            "type": "string"
          },
          "ownership": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/financial_connections.account_ownership"
              }
            ],
            "description": "The most recent information about the account's owners.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/financial_connections.account_ownership"
                }
              ]
            }
          },
          "ownership_refresh": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_ownership_refresh"
              }
            ],
            "description": "The state of the most recent attempt to refresh the account owners.",
            "nullable": true
          },
          "permissions": {
            "description": "The list of permissions granted by this account.",
            "items": {
              "enum": [
                "balances",
                "ownership",
                "payment_method",
                "transactions"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "status": {
            "description": "The status of the link to the account.",
            "enum": ["active", "disconnected", "inactive"],
            "type": "string"
          },
          "subcategory": {
            "description": "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`.",
            "enum": [
              "checking",
              "credit_card",
              "line_of_credit",
              "mortgage",
              "other",
              "savings"
            ],
            "type": "string"
          },
          "subscriptions": {
            "description": "The list of data refresh subscriptions requested on this account.",
            "items": {
              "enum": ["transactions"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "supported_payment_method_types": {
            "description": "The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.",
            "items": {
              "enum": ["link", "us_bank_account"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "transaction_refresh": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_transaction_refresh"
              }
            ],
            "description": "The state of the most recent attempt to refresh the account transactions.",
            "nullable": true
          }
        },
        "required": [
          "category",
          "created",
          "id",
          "institution_name",
          "livemode",
          "object",
          "status",
          "subcategory",
          "supported_payment_method_types"
        ],
        "title": "BankConnectionsResourceLinkedAccount",
        "type": "object",
        "x-expandableFields": [
          "account_holder",
          "balance",
          "balance_refresh",
          "ownership",
          "ownership_refresh",
          "transaction_refresh"
        ],
        "x-resourceId": "financial_connections.account"
      },
      "financial_connections.account_owner": {
        "description": "Describes an owner of an account.",
        "properties": {
          "email": {
            "description": "The email address of the owner.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "The full name of the owner.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["financial_connections.account_owner"],
            "type": "string"
          },
          "ownership": {
            "description": "The ownership object that this owner belongs to.",
            "maxLength": 5000,
            "type": "string"
          },
          "phone": {
            "description": "The raw phone number of the owner.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "raw_address": {
            "description": "The raw physical address of the owner.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "refreshed_at": {
            "description": "The timestamp of the refresh that updated this owner.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["id", "name", "object", "ownership"],
        "title": "BankConnectionsResourceOwner",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "financial_connections.account_owner"
      },
      "financial_connections.account_ownership": {
        "description": "Describes a snapshot of the owners of an account at a particular point in time.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["financial_connections.account_ownership"],
            "type": "string"
          },
          "owners": {
            "description": "A paginated list of owners for this account.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/financial_connections.account_owner"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "BankConnectionsResourceOwnerList",
            "type": "object",
            "x-expandableFields": ["data"]
          }
        },
        "required": ["created", "id", "object", "owners"],
        "title": "BankConnectionsResourceOwnership",
        "type": "object",
        "x-expandableFields": ["owners"]
      },
      "financial_connections.session": {
        "description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.",
        "properties": {
          "account_holder": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_connections_resource_accountholder"
              }
            ],
            "description": "The account holder for whom accounts are collected in this session.",
            "nullable": true
          },
          "accounts": {
            "description": "The accounts that were collected as part of this Session.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/financial_connections.account"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "pattern": "^/v1/financial_connections/accounts",
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "BankConnectionsResourceLinkedAccountList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "client_secret": {
            "description": "A value that will be passed to the client to launch the authentication flow.",
            "maxLength": 5000,
            "type": "string"
          },
          "filters": {
            "$ref": "#/components/schemas/bank_connections_resource_link_account_session_filters"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["financial_connections.session"],
            "type": "string"
          },
          "permissions": {
            "description": "Permissions requested for accounts collected during this session.",
            "items": {
              "enum": [
                "balances",
                "ownership",
                "payment_method",
                "transactions"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "prefetch": {
            "description": "Data features requested to be retrieved upon account creation.",
            "items": {
              "enum": ["balances", "ownership", "transactions"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "return_url": {
            "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "accounts",
          "client_secret",
          "id",
          "livemode",
          "object",
          "permissions"
        ],
        "title": "BankConnectionsResourceLinkAccountSession",
        "type": "object",
        "x-expandableFields": ["account_holder", "accounts", "filters"],
        "x-resourceId": "financial_connections.session"
      },
      "financial_connections.transaction": {
        "description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.",
        "properties": {
          "account": {
            "description": "The ID of the Financial Connections Account this transaction belongs to.",
            "maxLength": 5000,
            "type": "string"
          },
          "amount": {
            "description": "The amount of this transaction, in cents (or local equivalent).",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "description": {
            "description": "The description of this transaction.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["financial_connections.transaction"],
            "type": "string"
          },
          "status": {
            "description": "The status of the transaction.",
            "enum": ["pending", "posted", "void"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions"
          },
          "transacted_at": {
            "description": "Time at which the transaction was transacted. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "transaction_refresh": {
            "description": "The token of the transaction refresh that last updated or created this transaction.",
            "maxLength": 5000,
            "type": "string"
          },
          "updated": {
            "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "account",
          "amount",
          "currency",
          "description",
          "id",
          "livemode",
          "object",
          "status",
          "status_transitions",
          "transacted_at",
          "transaction_refresh",
          "updated"
        ],
        "title": "BankConnectionsResourceTransaction",
        "type": "object",
        "x-expandableFields": ["status_transitions"],
        "x-resourceId": "financial_connections.transaction"
      },
      "financial_reporting_finance_report_run_run_parameters": {
        "description": "",
        "properties": {
          "columns": {
            "description": "The set of output columns requested for inclusion in the report run.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "connected_account": {
            "description": "Connected account ID by which to filter the report run.",
            "maxLength": 5000,
            "type": "string"
          },
          "currency": {
            "description": "Currency of objects to be included in the report run.",
            "format": "currency",
            "type": "string"
          },
          "interval_end": {
            "description": "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.",
            "format": "unix-time",
            "type": "integer"
          },
          "interval_start": {
            "description": "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.",
            "format": "unix-time",
            "type": "integer"
          },
          "payout": {
            "description": "Payout ID by which to filter the report run.",
            "maxLength": 5000,
            "type": "string"
          },
          "reporting_category": {
            "description": "Category of balance transactions to be included in the report run.",
            "maxLength": 5000,
            "type": "string"
          },
          "timezone": {
            "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "FinancialReportingFinanceReportRunRunParameters",
        "type": "object",
        "x-expandableFields": []
      },
      "forwarded_request_context": {
        "description": "Metadata about the forwarded request.",
        "properties": {
          "destination_duration": {
            "description": "The time it took in milliseconds for the destination endpoint to respond.",
            "type": "integer"
          },
          "destination_ip_address": {
            "description": "The IP address of the destination.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["destination_duration", "destination_ip_address"],
        "title": "ForwardedRequestContext",
        "type": "object",
        "x-expandableFields": []
      },
      "forwarded_request_details": {
        "description": "Details about the request forwarded to the destination endpoint.",
        "properties": {
          "body": {
            "description": "The body payload to send to the destination endpoint.",
            "maxLength": 5000,
            "type": "string"
          },
          "headers": {
            "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.",
            "items": {
              "$ref": "#/components/schemas/forwarded_request_header"
            },
            "type": "array"
          },
          "http_method": {
            "description": "The HTTP method used to call the destination endpoint.",
            "enum": ["POST"],
            "type": "string"
          }
        },
        "required": ["body", "headers", "http_method"],
        "title": "ForwardedRequestDetails",
        "type": "object",
        "x-expandableFields": ["headers"]
      },
      "forwarded_request_header": {
        "description": "Header data.",
        "properties": {
          "name": {
            "description": "The header name.",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "The header value.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["name", "value"],
        "title": "ForwardedRequestHeader",
        "type": "object",
        "x-expandableFields": []
      },
      "forwarded_response_details": {
        "description": "Details about the response from the destination endpoint.",
        "properties": {
          "body": {
            "description": "The response body from the destination endpoint to Stripe.",
            "maxLength": 5000,
            "type": "string"
          },
          "headers": {
            "description": "HTTP headers that the destination endpoint returned.",
            "items": {
              "$ref": "#/components/schemas/forwarded_request_header"
            },
            "type": "array"
          },
          "status": {
            "description": "The HTTP status code that the destination endpoint returned.",
            "type": "integer"
          }
        },
        "required": ["body", "headers", "status"],
        "title": "ForwardedResponseDetails",
        "type": "object",
        "x-expandableFields": ["headers"]
      },
      "forwarding.request": {
        "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["forwarding.request"],
            "type": "string"
          },
          "payment_method": {
            "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.",
            "maxLength": 5000,
            "type": "string"
          },
          "replacements": {
            "description": "The field kinds to be replaced in the forwarded request.",
            "items": {
              "enum": [
                "card_cvc",
                "card_expiry",
                "card_number",
                "cardholder_name",
                "request_signature"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "request_context": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/forwarded_request_context"
              }
            ],
            "description": "Context about the request from Stripe's servers to the destination endpoint.",
            "nullable": true
          },
          "request_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/forwarded_request_details"
              }
            ],
            "description": "The request that was sent to the destination endpoint. We redact any sensitive fields.",
            "nullable": true
          },
          "response_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/forwarded_response_details"
              }
            ],
            "description": "The response that the destination endpoint returned to us. We redact any sensitive fields.",
            "nullable": true
          },
          "url": {
            "description": "The destination URL for the forwarded request. Must be supported by the config.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "payment_method",
          "replacements"
        ],
        "title": "ForwardingRequest",
        "type": "object",
        "x-expandableFields": [
          "request_context",
          "request_details",
          "response_details"
        ],
        "x-resourceId": "forwarding.request"
      },
      "funding_instructions": {
        "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)",
        "properties": {
          "bank_transfer": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "funding_type": {
            "description": "The `funding_type` of the returned instructions",
            "enum": ["bank_transfer"],
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["funding_instructions"],
            "type": "string"
          }
        },
        "required": [
          "bank_transfer",
          "currency",
          "funding_type",
          "livemode",
          "object"
        ],
        "title": "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions",
        "type": "object",
        "x-expandableFields": ["bank_transfer"],
        "x-resourceId": "funding_instructions"
      },
      "funding_instructions_bank_transfer": {
        "description": "",
        "properties": {
          "country": {
            "description": "The country of the bank account to fund",
            "maxLength": 5000,
            "type": "string"
          },
          "financial_addresses": {
            "description": "A list of financial addresses that can be used to fund a particular balance",
            "items": {
              "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
            },
            "type": "array"
          },
          "type": {
            "description": "The bank_transfer type",
            "enum": ["eu_bank_transfer", "jp_bank_transfer"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["country", "financial_addresses", "type"],
        "title": "FundingInstructionsBankTransfer",
        "type": "object",
        "x-expandableFields": ["financial_addresses"]
      },
      "funding_instructions_bank_transfer_aba_record": {
        "description": "ABA Records contain U.S. bank account details per the ABA format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The account holder name",
            "maxLength": 5000,
            "type": "string"
          },
          "account_number": {
            "description": "The ABA account number",
            "maxLength": 5000,
            "type": "string"
          },
          "account_type": {
            "description": "The account type",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "bank_name": {
            "description": "The bank name",
            "maxLength": 5000,
            "type": "string"
          },
          "routing_number": {
            "description": "The ABA routing number",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_address",
          "account_holder_name",
          "account_number",
          "account_type",
          "bank_address",
          "bank_name",
          "routing_number"
        ],
        "title": "FundingInstructionsBankTransferABARecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "funding_instructions_bank_transfer_financial_address": {
        "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
        "properties": {
          "aba": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record"
          },
          "iban": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record"
          },
          "sort_code": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_sort_code_record"
          },
          "spei": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_spei_record"
          },
          "supported_networks": {
            "description": "The payment networks supported by this FinancialAddress",
            "items": {
              "enum": [
                "ach",
                "bacs",
                "domestic_wire_us",
                "fps",
                "sepa",
                "spei",
                "swift",
                "zengin"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "swift": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record"
          },
          "type": {
            "description": "The type of financial address",
            "enum": ["aba", "iban", "sort_code", "spei", "swift", "zengin"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "zengin": {
            "$ref": "#/components/schemas/funding_instructions_bank_transfer_zengin_record"
          }
        },
        "required": ["type"],
        "title": "FundingInstructionsBankTransferFinancialAddress",
        "type": "object",
        "x-expandableFields": [
          "aba",
          "iban",
          "sort_code",
          "spei",
          "swift",
          "zengin"
        ]
      },
      "funding_instructions_bank_transfer_iban_record": {
        "description": "Iban Records contain E.U. bank account details per the SEPA format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The name of the person or business that owns the bank account",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "bic": {
            "description": "The BIC/SWIFT code of the account.",
            "maxLength": 5000,
            "type": "string"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "iban": {
            "description": "The IBAN of the account.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_address",
          "account_holder_name",
          "bank_address",
          "bic",
          "country",
          "iban"
        ],
        "title": "FundingInstructionsBankTransferIbanRecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "funding_instructions_bank_transfer_sort_code_record": {
        "description": "Sort Code Records contain U.K. bank account details per the sort code format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The name of the person or business that owns the bank account",
            "maxLength": 5000,
            "type": "string"
          },
          "account_number": {
            "description": "The account number",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "sort_code": {
            "description": "The six-digit sort code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_address",
          "account_holder_name",
          "account_number",
          "bank_address",
          "sort_code"
        ],
        "title": "FundingInstructionsBankTransferSortCodeRecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "funding_instructions_bank_transfer_spei_record": {
        "description": "SPEI Records contain Mexico bank account details per the SPEI format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The account holder name",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "bank_code": {
            "description": "The three-digit bank code",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_name": {
            "description": "The short banking institution name",
            "maxLength": 5000,
            "type": "string"
          },
          "clabe": {
            "description": "The CLABE number",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_address",
          "account_holder_name",
          "bank_address",
          "bank_code",
          "bank_name",
          "clabe"
        ],
        "title": "FundingInstructionsBankTransferSpeiRecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "funding_instructions_bank_transfer_swift_record": {
        "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The account holder name",
            "maxLength": 5000,
            "type": "string"
          },
          "account_number": {
            "description": "The account number",
            "maxLength": 5000,
            "type": "string"
          },
          "account_type": {
            "description": "The account type",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "bank_name": {
            "description": "The bank name",
            "maxLength": 5000,
            "type": "string"
          },
          "swift_code": {
            "description": "The SWIFT code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_address",
          "account_holder_name",
          "account_number",
          "account_type",
          "bank_address",
          "bank_name",
          "swift_code"
        ],
        "title": "FundingInstructionsBankTransferSwiftRecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "funding_instructions_bank_transfer_zengin_record": {
        "description": "Zengin Records contain Japan bank account details per the Zengin format.",
        "properties": {
          "account_holder_address": {
            "$ref": "#/components/schemas/address"
          },
          "account_holder_name": {
            "description": "The account holder name",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_number": {
            "description": "The account number",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "The bank account type. In Japan, this can only be `futsu` or `toza`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_address": {
            "$ref": "#/components/schemas/address"
          },
          "bank_code": {
            "description": "The bank code of the account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "The bank name of the account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "branch_code": {
            "description": "The branch code of the account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "branch_name": {
            "description": "The branch name of the account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["account_holder_address", "bank_address"],
        "title": "FundingInstructionsBankTransferZenginRecord",
        "type": "object",
        "x-expandableFields": ["account_holder_address", "bank_address"]
      },
      "gelato_data_document_report_date_of_birth": {
        "description": "Point in Time",
        "properties": {
          "day": {
            "description": "Numerical day between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "Numerical month between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "GelatoDataDocumentReportDateOfBirth",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_data_document_report_expiration_date": {
        "description": "Point in Time",
        "properties": {
          "day": {
            "description": "Numerical day between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "Numerical month between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "GelatoDataDocumentReportExpirationDate",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_data_document_report_issued_date": {
        "description": "Point in Time",
        "properties": {
          "day": {
            "description": "Numerical day between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "Numerical month between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "GelatoDataDocumentReportIssuedDate",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_data_id_number_report_date": {
        "description": "Point in Time",
        "properties": {
          "day": {
            "description": "Numerical day between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "Numerical month between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "GelatoDataIdNumberReportDate",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_data_verified_outputs_date": {
        "description": "Point in Time",
        "properties": {
          "day": {
            "description": "Numerical day between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "Numerical month between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "GelatoDataVerifiedOutputsDate",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_document_report": {
        "description": "Result from a document check",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Address as it appears in the document.",
            "nullable": true
          },
          "dob": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_data_document_report_date_of_birth"
              }
            ],
            "description": "Date of birth as it appears in the document.",
            "nullable": true
          },
          "error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_document_report_error"
              }
            ],
            "description": "Details on the verification error. Present when status is `unverified`.",
            "nullable": true
          },
          "expiration_date": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_data_document_report_expiration_date"
              }
            ],
            "description": "Expiration date of the document.",
            "nullable": true
          },
          "files": {
            "description": "Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "first_name": {
            "description": "First name as it appears in the document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issued_date": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_data_document_report_issued_date"
              }
            ],
            "description": "Issued date of the document.",
            "nullable": true
          },
          "issuing_country": {
            "description": "Issuing country of the document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last_name": {
            "description": "Last name as it appears in the document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "number": {
            "description": "Document ID number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this `document` check.",
            "enum": ["unverified", "verified"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "type": {
            "description": "Type of the document.",
            "enum": ["driving_license", "id_card", "passport"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "GelatoDocumentReport",
        "type": "object",
        "x-expandableFields": [
          "address",
          "dob",
          "error",
          "expiration_date",
          "issued_date"
        ]
      },
      "gelato_document_report_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification failure.",
            "enum": [
              "document_expired",
              "document_type_not_supported",
              "document_unverified_other"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "reason": {
            "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoDocumentReportError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_email_report": {
        "description": "Result from a email check",
        "properties": {
          "email": {
            "description": "Email to be verified.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_email_report_error"
              }
            ],
            "description": "Details on the verification error. Present when status is `unverified`.",
            "nullable": true
          },
          "status": {
            "description": "Status of this `email` check.",
            "enum": ["unverified", "verified"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["status"],
        "title": "GelatoEmailReport",
        "type": "object",
        "x-expandableFields": ["error"]
      },
      "gelato_email_report_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification failure.",
            "enum": ["email_unverified_other", "email_verification_declined"],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoEmailReportError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_id_number_report": {
        "description": "Result from an id_number check",
        "properties": {
          "dob": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_data_id_number_report_date"
              }
            ],
            "description": "Date of birth.",
            "nullable": true
          },
          "error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_id_number_report_error"
              }
            ],
            "description": "Details on the verification error. Present when status is `unverified`.",
            "nullable": true
          },
          "first_name": {
            "description": "First name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id_number": {
            "description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id_number_type": {
            "description": "Type of ID number.",
            "enum": ["br_cpf", "sg_nric", "us_ssn"],
            "nullable": true,
            "type": "string"
          },
          "last_name": {
            "description": "Last name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this `id_number` check.",
            "enum": ["unverified", "verified"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["status"],
        "title": "GelatoIdNumberReport",
        "type": "object",
        "x-expandableFields": ["dob", "error"]
      },
      "gelato_id_number_report_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification failure.",
            "enum": [
              "id_number_insufficient_document_data",
              "id_number_mismatch",
              "id_number_unverified_other"
            ],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoIdNumberReportError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_phone_report": {
        "description": "Result from a phone check",
        "properties": {
          "error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_phone_report_error"
              }
            ],
            "description": "Details on the verification error. Present when status is `unverified`.",
            "nullable": true
          },
          "phone": {
            "description": "Phone to be verified.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this `phone` check.",
            "enum": ["unverified", "verified"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["status"],
        "title": "GelatoPhoneReport",
        "type": "object",
        "x-expandableFields": ["error"]
      },
      "gelato_phone_report_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification failure.",
            "enum": ["phone_unverified_other", "phone_verification_declined"],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoPhoneReportError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_provided_details": {
        "description": "",
        "properties": {
          "email": {
            "description": "Email of user being verified",
            "maxLength": 5000,
            "type": "string"
          },
          "phone": {
            "description": "Phone number of user being verified",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "GelatoProvidedDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_report_document_options": {
        "description": "",
        "properties": {
          "allowed_types": {
            "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.",
            "items": {
              "enum": ["driving_license", "id_card", "passport"],
              "type": "string"
            },
            "type": "array"
          },
          "require_id_number": {
            "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.",
            "type": "boolean"
          },
          "require_live_capture": {
            "description": "Disable image uploads, identity document images have to be captured using the device’s camera.",
            "type": "boolean"
          },
          "require_matching_selfie": {
            "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).",
            "type": "boolean"
          }
        },
        "title": "GelatoReportDocumentOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_report_id_number_options": {
        "description": "",
        "properties": {},
        "title": "GelatoReportIdNumberOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_selfie_report": {
        "description": "Result from a selfie check",
        "properties": {
          "document": {
            "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_selfie_report_error"
              }
            ],
            "description": "Details on the verification error. Present when status is `unverified`.",
            "nullable": true
          },
          "selfie": {
            "description": "ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this `selfie` check.",
            "enum": ["unverified", "verified"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["status"],
        "title": "GelatoSelfieReport",
        "type": "object",
        "x-expandableFields": ["error"]
      },
      "gelato_selfie_report_error": {
        "description": "",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification failure.",
            "enum": [
              "selfie_document_missing_photo",
              "selfie_face_mismatch",
              "selfie_manipulated",
              "selfie_unverified_other"
            ],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoSelfieReportError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_session_document_options": {
        "description": "",
        "properties": {
          "allowed_types": {
            "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.",
            "items": {
              "enum": ["driving_license", "id_card", "passport"],
              "type": "string"
            },
            "type": "array"
          },
          "require_id_number": {
            "description": "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.",
            "type": "boolean"
          },
          "require_live_capture": {
            "description": "Disable image uploads, identity document images have to be captured using the device’s camera.",
            "type": "boolean"
          },
          "require_matching_selfie": {
            "description": "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).",
            "type": "boolean"
          }
        },
        "title": "GelatoSessionDocumentOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_session_email_options": {
        "description": "",
        "properties": {
          "require_verification": {
            "description": "Request one time password verification of `provided_details.email`.",
            "type": "boolean"
          }
        },
        "title": "GelatoSessionEmailOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_session_id_number_options": {
        "description": "",
        "properties": {},
        "title": "GelatoSessionIdNumberOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_session_last_error": {
        "description": "Shows last VerificationSession error",
        "properties": {
          "code": {
            "description": "A short machine-readable string giving the reason for the verification or user-session failure.",
            "enum": [
              "abandoned",
              "consent_declined",
              "country_not_supported",
              "device_not_supported",
              "document_expired",
              "document_type_not_supported",
              "document_unverified_other",
              "email_unverified_other",
              "email_verification_declined",
              "id_number_insufficient_document_data",
              "id_number_mismatch",
              "id_number_unverified_other",
              "phone_unverified_other",
              "phone_verification_declined",
              "selfie_document_missing_photo",
              "selfie_face_mismatch",
              "selfie_manipulated",
              "selfie_unverified_other",
              "under_supported_age"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "reason": {
            "description": "A message that explains the reason for verification or user-session failure.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoSessionLastError",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_session_phone_options": {
        "description": "",
        "properties": {
          "require_verification": {
            "description": "Request one time password verification of `provided_details.phone`.",
            "type": "boolean"
          }
        },
        "title": "GelatoSessionPhoneOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "gelato_verification_report_options": {
        "description": "",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/gelato_report_document_options"
          },
          "id_number": {
            "$ref": "#/components/schemas/gelato_report_id_number_options"
          }
        },
        "title": "GelatoVerificationReportOptions",
        "type": "object",
        "x-expandableFields": ["document", "id_number"]
      },
      "gelato_verification_session_options": {
        "description": "",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/gelato_session_document_options"
          },
          "email": {
            "$ref": "#/components/schemas/gelato_session_email_options"
          },
          "id_number": {
            "$ref": "#/components/schemas/gelato_session_id_number_options"
          },
          "phone": {
            "$ref": "#/components/schemas/gelato_session_phone_options"
          }
        },
        "title": "GelatoVerificationSessionOptions",
        "type": "object",
        "x-expandableFields": ["document", "email", "id_number", "phone"]
      },
      "gelato_verified_outputs": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "The user's verified address.",
            "nullable": true
          },
          "dob": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_data_verified_outputs_date"
              }
            ],
            "description": "The user’s verified date of birth.",
            "nullable": true
          },
          "email": {
            "description": "The user's verified email address",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "first_name": {
            "description": "The user's verified first name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id_number": {
            "description": "The user's verified id number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id_number_type": {
            "description": "The user's verified id number type.",
            "enum": ["br_cpf", "sg_nric", "us_ssn"],
            "nullable": true,
            "type": "string"
          },
          "last_name": {
            "description": "The user's verified last name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "phone": {
            "description": "The user's verified phone number",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "GelatoVerifiedOutputs",
        "type": "object",
        "x-expandableFields": ["address", "dob"]
      },
      "identity.verification_report": {
        "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).",
        "properties": {
          "client_reference_id": {
            "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "document": {
            "$ref": "#/components/schemas/gelato_document_report"
          },
          "email": {
            "$ref": "#/components/schemas/gelato_email_report"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "id_number": {
            "$ref": "#/components/schemas/gelato_id_number_report"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["identity.verification_report"],
            "type": "string"
          },
          "options": {
            "$ref": "#/components/schemas/gelato_verification_report_options"
          },
          "phone": {
            "$ref": "#/components/schemas/gelato_phone_report"
          },
          "selfie": {
            "$ref": "#/components/schemas/gelato_selfie_report"
          },
          "type": {
            "description": "Type of report.",
            "enum": ["document", "id_number", "verification_flow"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "verification_flow": {
            "description": "The configuration token of a verification flow from the dashboard.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification_session": {
            "description": "ID of the VerificationSession that created this report.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["created", "id", "livemode", "object", "type"],
        "title": "GelatoVerificationReport",
        "type": "object",
        "x-expandableFields": [
          "document",
          "email",
          "id_number",
          "options",
          "phone",
          "selfie"
        ],
        "x-resourceId": "identity.verification_report"
      },
      "identity.verification_session": {
        "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)",
        "properties": {
          "client_reference_id": {
            "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "client_secret": {
            "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last_error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_session_last_error"
              }
            ],
            "description": "If present, this property tells you the last error encountered when processing the verification.",
            "nullable": true
          },
          "last_verification_report": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/identity.verification_report"
              }
            ],
            "description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/identity.verification_report"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["identity.verification_session"],
            "type": "string"
          },
          "options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_verification_session_options"
              }
            ],
            "description": "A set of options for the session’s verification checks.",
            "nullable": true
          },
          "provided_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_provided_details"
              }
            ],
            "description": "Details provided about the user being verified. These details may be shown to the user.",
            "nullable": true
          },
          "redaction": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/verification_session_redaction"
              }
            ],
            "description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.",
            "nullable": true
          },
          "related_customer": {
            "description": "Token referencing a Customer resource.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).",
            "enum": ["canceled", "processing", "requires_input", "verified"],
            "type": "string"
          },
          "type": {
            "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.",
            "enum": ["document", "id_number", "verification_flow"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "url": {
            "description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verification_flow": {
            "description": "The configuration token of a verification flow from the dashboard.",
            "maxLength": 5000,
            "type": "string"
          },
          "verified_outputs": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/gelato_verified_outputs"
              }
            ],
            "description": "The user’s verified data.",
            "nullable": true
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "metadata",
          "object",
          "status",
          "type"
        ],
        "title": "GelatoVerificationSession",
        "type": "object",
        "x-expandableFields": [
          "last_error",
          "last_verification_report",
          "options",
          "provided_details",
          "redaction",
          "verified_outputs"
        ],
        "x-resourceId": "identity.verification_session"
      },
      "inbound_transfers": {
        "description": "",
        "properties": {
          "billing_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
          },
          "type": {
            "description": "The type of the payment method used in the InboundTransfer.",
            "enum": ["us_bank_account"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account"
          }
        },
        "required": ["billing_details", "type"],
        "title": "InboundTransfers",
        "type": "object",
        "x-expandableFields": ["billing_details", "us_bank_account"]
      },
      "inbound_transfers_payment_method_details_us_bank_account": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Account holder type: individual or company.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "Account type: checkings or savings. Defaults to checking if omitted.",
            "enum": ["checking", "savings"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the mandate used to make this payment.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "network": {
            "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
            "enum": ["ach"],
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["network"],
        "title": "inbound_transfers_payment_method_details_us_bank_account",
        "type": "object",
        "x-expandableFields": ["mandate"]
      },
      "internal_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Brand of the card used in the transaction",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two digit number representing the card's expiration month",
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "description": "Two digit number representing the card's expiration year",
            "nullable": true,
            "type": "integer"
          },
          "last4": {
            "description": "The last 4 digits of the card",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "internal_card",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice": {
        "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)",
        "properties": {
          "account_country": {
            "description": "The country of the business associated with this invoice, most often the business creating the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_name": {
            "description": "The public name of the business associated with this invoice, most often the business creating the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_tax_ids": {
            "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "amount_due": {
            "description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.",
            "type": "integer"
          },
          "amount_paid": {
            "description": "The amount, in cents (or local equivalent), that was paid.",
            "type": "integer"
          },
          "amount_remaining": {
            "description": "The difference between amount_due and amount_paid, in cents (or local equivalent).",
            "type": "integer"
          },
          "amount_shipping": {
            "description": "This is the sum of all the shipping amounts.",
            "type": "integer"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "ID of the Connect Application that created the invoice.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.",
            "nullable": true,
            "type": "integer"
          },
          "attempt_count": {
            "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.",
            "type": "integer"
          },
          "attempted": {
            "description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.",
            "type": "boolean"
          },
          "auto_advance": {
            "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
            "type": "boolean"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/automatic_tax"
          },
          "automatically_finalizes_at": {
            "description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "billing_reason": {
            "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.",
            "enum": [
              "automatic_pending_invoice_item_invoice",
              "manual",
              "quote_accept",
              "subscription",
              "subscription_create",
              "subscription_cycle",
              "subscription_threshold",
              "subscription_update",
              "upcoming"
            ],
            "nullable": true,
            "type": "string"
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the latest charge generated for this invoice, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "collection_method": {
            "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.",
            "enum": ["charge_automatically", "send_invoice"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "custom_fields": {
            "description": "Custom fields displayed on the invoice.",
            "items": {
              "$ref": "#/components/schemas/invoice_setting_custom_field"
            },
            "nullable": true,
            "type": "array"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer who will be billed.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "customer_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.",
            "nullable": true
          },
          "customer_email": {
            "description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_name": {
            "description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_phone": {
            "description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.",
            "nullable": true
          },
          "customer_tax_exempt": {
            "description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.",
            "enum": ["exempt", "none", "reverse"],
            "nullable": true,
            "type": "string"
          },
          "customer_tax_ids": {
            "description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.",
            "items": {
              "$ref": "#/components/schemas/invoices_resource_invoice_tax_id"
            },
            "nullable": true,
            "type": "array"
          },
          "default_payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "default_source": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/bank_account"
                },
                {
                  "$ref": "#/components/schemas/card"
                },
                {
                  "$ref": "#/components/schemas/source"
                }
              ]
            },
            "x-stripeBypassValidation": true
          },
          "default_tax_rates": {
            "description": "The tax rates applied to this invoice, if any.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "type": "array"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/discount"
              }
            ],
            "description": "Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.",
            "nullable": true
          },
          "discounts": {
            "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                },
                {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_discount"
                  }
                ]
              }
            },
            "type": "array"
          },
          "due_date": {
            "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "effective_at": {
            "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ending_balance": {
            "description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.",
            "nullable": true,
            "type": "integer"
          },
          "footer": {
            "description": "Footer displayed on the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "from_invoice": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_from_invoice"
              }
            ],
            "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.",
            "nullable": true
          },
          "hosted_invoice_url": {
            "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice_pdf": {
            "description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "$ref": "#/components/schemas/connect_account_reference"
          },
          "last_finalization_error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/api_errors"
              }
            ],
            "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.",
            "nullable": true
          },
          "latest_revision": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The ID of the most recent non-draft revision of this invoice",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "lines": {
            "description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/line_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "InvoiceLinesList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "next_payment_attempt": {
            "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "number": {
            "description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["invoice"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "paid": {
            "description": "Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.",
            "type": "boolean"
          },
          "paid_out_of_band": {
            "description": "Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.",
            "type": "boolean"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "payment_settings": {
            "$ref": "#/components/schemas/invoices_payment_settings"
          },
          "period_end": {
            "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.",
            "format": "unix-time",
            "type": "integer"
          },
          "period_start": {
            "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.",
            "format": "unix-time",
            "type": "integer"
          },
          "post_payment_credit_notes_amount": {
            "description": "Total amount of all post-payment credit notes issued for this invoice.",
            "type": "integer"
          },
          "pre_payment_credit_notes_amount": {
            "description": "Total amount of all pre-payment credit notes issued for this invoice.",
            "type": "integer"
          },
          "quote": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/quote"
              }
            ],
            "description": "The quote this invoice was generated from.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/quote"
                }
              ]
            }
          },
          "receipt_number": {
            "description": "This is the transaction number that appears on email receipts sent for this invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "rendering": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_invoice_rendering"
              }
            ],
            "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
            "nullable": true
          },
          "shipping_cost": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_shipping_cost"
              }
            ],
            "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.",
            "nullable": true
          },
          "shipping_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.",
            "nullable": true
          },
          "starting_balance": {
            "description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.",
            "type": "integer"
          },
          "statement_descriptor": {
            "description": "Extra information about an invoice for the customer's credit card statement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)",
            "enum": ["draft", "open", "paid", "uncollectible", "void"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "status_transitions": {
            "$ref": "#/components/schemas/invoices_resource_status_transitions"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "The subscription that this invoice was prepared for, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "subscription_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_details_data"
              }
            ],
            "description": "Details about the subscription that created this invoice.",
            "nullable": true
          },
          "subscription_proration_date": {
            "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.",
            "type": "integer"
          },
          "subtotal": {
            "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated",
            "type": "integer"
          },
          "subtotal_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated",
            "nullable": true,
            "type": "integer"
          },
          "tax": {
            "description": "The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.",
            "nullable": true,
            "type": "integer"
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this invoice belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "threshold_reason": {
            "$ref": "#/components/schemas/invoice_threshold_reason"
          },
          "total": {
            "description": "Total after discounts and taxes.",
            "type": "integer"
          },
          "total_discount_amounts": {
            "description": "The aggregate amounts calculated per discount across all line items.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_discount_amount"
            },
            "nullable": true,
            "type": "array"
          },
          "total_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.",
            "nullable": true,
            "type": "integer"
          },
          "total_pretax_credit_amounts": {
            "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.",
            "items": {
              "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount"
            },
            "nullable": true,
            "type": "array"
          },
          "total_tax_amounts": {
            "description": "The aggregate amounts calculated per tax rate for all line items.",
            "items": {
              "$ref": "#/components/schemas/invoice_tax_amount"
            },
            "type": "array"
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_transfer_data"
              }
            ],
            "description": "The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.",
            "nullable": true
          },
          "webhooks_delivered_at": {
            "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "amount_due",
          "amount_paid",
          "amount_remaining",
          "amount_shipping",
          "attempt_count",
          "attempted",
          "automatic_tax",
          "collection_method",
          "created",
          "currency",
          "default_tax_rates",
          "discounts",
          "issuer",
          "lines",
          "livemode",
          "object",
          "paid",
          "paid_out_of_band",
          "payment_settings",
          "period_end",
          "period_start",
          "post_payment_credit_notes_amount",
          "pre_payment_credit_notes_amount",
          "starting_balance",
          "status_transitions",
          "subtotal",
          "total",
          "total_tax_amounts"
        ],
        "title": "Invoice",
        "type": "object",
        "x-expandableFields": [
          "account_tax_ids",
          "application",
          "automatic_tax",
          "charge",
          "custom_fields",
          "customer",
          "customer_address",
          "customer_shipping",
          "customer_tax_ids",
          "default_payment_method",
          "default_source",
          "default_tax_rates",
          "discount",
          "discounts",
          "from_invoice",
          "issuer",
          "last_finalization_error",
          "latest_revision",
          "lines",
          "on_behalf_of",
          "payment_intent",
          "payment_settings",
          "quote",
          "rendering",
          "shipping_cost",
          "shipping_details",
          "status_transitions",
          "subscription",
          "subscription_details",
          "test_clock",
          "threshold_reason",
          "total_discount_amounts",
          "total_pretax_credit_amounts",
          "total_tax_amounts",
          "transfer_data"
        ],
        "x-resourceId": "invoice"
      },
      "invoice_installments_card": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether Installments are enabled for this Invoice.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "invoice_installments_card",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_item_threshold_reason": {
        "description": "",
        "properties": {
          "line_item_ids": {
            "description": "The IDs of the line items that triggered the threshold invoice.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "usage_gte": {
            "description": "The quantity threshold boundary that applied to the given line item.",
            "type": "integer"
          }
        },
        "required": ["line_item_ids", "usage_gte"],
        "title": "InvoiceItemThresholdReason",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_line_item_period": {
        "description": "",
        "properties": {
          "end": {
            "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.",
            "format": "unix-time",
            "type": "integer"
          },
          "start": {
            "description": "The start of the period. This value is inclusive.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": ["end", "start"],
        "title": "InvoiceLineItemPeriod",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_mandate_options_card": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount to be charged for future payments.",
            "nullable": true,
            "type": "integer"
          },
          "amount_type": {
            "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.",
            "enum": ["fixed", "maximum"],
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_mandate_options_card",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_acss_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "invoice_payment_method_options_acss_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "invoice_payment_method_options_acss_debit_mandate_options": {
        "description": "",
        "properties": {
          "transaction_type": {
            "description": "Transaction type of the mandate.",
            "enum": ["business", "personal"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_payment_method_options_acss_debit_mandate_options",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_bancontact": {
        "description": "",
        "properties": {
          "preferred_language": {
            "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
            "enum": ["de", "en", "fr", "nl"],
            "type": "string"
          }
        },
        "required": ["preferred_language"],
        "title": "invoice_payment_method_options_bancontact",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_card": {
        "description": "",
        "properties": {
          "installments": {
            "$ref": "#/components/schemas/invoice_installments_card"
          },
          "request_three_d_secure": {
            "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
            "enum": ["any", "automatic", "challenge"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_payment_method_options_card",
        "type": "object",
        "x-expandableFields": ["installments"]
      },
      "invoice_payment_method_options_customer_balance": {
        "description": "",
        "properties": {
          "bank_transfer": {
            "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer"
          },
          "funding_type": {
            "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
            "enum": ["bank_transfer"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_payment_method_options_customer_balance",
        "type": "object",
        "x-expandableFields": ["bank_transfer"]
      },
      "invoice_payment_method_options_customer_balance_bank_transfer": {
        "description": "",
        "properties": {
          "eu_bank_transfer": {
            "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"
          },
          "type": {
            "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_payment_method_options_customer_balance_bank_transfer",
        "type": "object",
        "x-expandableFields": ["eu_bank_transfer"]
      },
      "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": {
        "description": "",
        "properties": {
          "country": {
            "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.",
            "enum": ["BE", "DE", "ES", "FR", "IE", "NL"],
            "type": "string"
          }
        },
        "required": ["country"],
        "title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_konbini": {
        "description": "",
        "properties": {},
        "title": "invoice_payment_method_options_konbini",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_sepa_debit": {
        "description": "",
        "properties": {},
        "title": "invoice_payment_method_options_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_payment_method_options_us_bank_account": {
        "description": "",
        "properties": {
          "financial_connections": {
            "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "invoice_payment_method_options_us_bank_account",
        "type": "object",
        "x-expandableFields": ["financial_connections"]
      },
      "invoice_payment_method_options_us_bank_account_linked_account_options": {
        "description": "",
        "properties": {
          "filters": {
            "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters"
          },
          "permissions": {
            "description": "The list of permissions to request. The `payment_method` permission must be included.",
            "items": {
              "enum": [
                "balances",
                "ownership",
                "payment_method",
                "transactions"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "prefetch": {
            "description": "Data features requested to be retrieved upon account creation.",
            "items": {
              "enum": ["balances", "ownership", "transactions"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "invoice_payment_method_options_us_bank_account_linked_account_options",
        "type": "object",
        "x-expandableFields": ["filters"]
      },
      "invoice_payment_method_options_us_bank_account_linked_account_options_filters": {
        "description": "",
        "properties": {
          "account_subcategories": {
            "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.",
            "items": {
              "enum": ["checking", "savings"],
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_rendering_pdf": {
        "description": "",
        "properties": {
          "page_size": {
            "description": "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.",
            "enum": ["a4", "auto", "letter"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "InvoiceRenderingPdf",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_rendering_template": {
        "description": "Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates\ncan be created from within the Dashboard, and they can be used over the API when creating invoices.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "nickname": {
            "description": "A brief description of the template, hidden from customers",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["invoice_rendering_template"],
            "type": "string"
          },
          "status": {
            "description": "The status of the template, one of `active` or `archived`.",
            "enum": ["active", "archived"],
            "type": "string"
          },
          "version": {
            "description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering",
            "type": "integer"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "status",
          "version"
        ],
        "title": "InvoiceRenderingTemplate",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "invoice_rendering_template"
      },
      "invoice_setting_checkout_rendering_options": {
        "description": "",
        "properties": {
          "amount_tax_display": {
            "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "invoice_setting_checkout_rendering_options",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_setting_custom_field": {
        "description": "",
        "properties": {
          "name": {
            "description": "The name of the custom field.",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["name", "value"],
        "title": "InvoiceSettingCustomField",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_setting_customer_rendering_options": {
        "description": "",
        "properties": {
          "amount_tax_display": {
            "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "template": {
            "description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "InvoiceSettingCustomerRenderingOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "invoice_setting_customer_setting": {
        "description": "",
        "properties": {
          "custom_fields": {
            "description": "Default custom fields to be displayed on invoices for this customer.",
            "items": {
              "$ref": "#/components/schemas/invoice_setting_custom_field"
            },
            "nullable": true,
            "type": "array"
          },
          "default_payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "footer": {
            "description": "Default footer to be displayed on invoices for this customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "rendering_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_setting_customer_rendering_options"
              }
            ],
            "description": "Default options for invoice PDF rendering for this customer.",
            "nullable": true
          }
        },
        "title": "InvoiceSettingCustomerSetting",
        "type": "object",
        "x-expandableFields": [
          "custom_fields",
          "default_payment_method",
          "rendering_options"
        ]
      },
      "invoice_setting_quote_setting": {
        "description": "",
        "properties": {
          "days_until_due": {
            "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.",
            "nullable": true,
            "type": "integer"
          },
          "issuer": {
            "$ref": "#/components/schemas/connect_account_reference"
          }
        },
        "required": ["issuer"],
        "title": "InvoiceSettingQuoteSetting",
        "type": "object",
        "x-expandableFields": ["issuer"]
      },
      "invoice_setting_subscription_schedule_phase_setting": {
        "description": "",
        "properties": {
          "account_tax_ids": {
            "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "days_until_due": {
            "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
            "nullable": true,
            "type": "integer"
          },
          "issuer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
            "nullable": true
          }
        },
        "title": "InvoiceSettingSubscriptionSchedulePhaseSetting",
        "type": "object",
        "x-expandableFields": ["account_tax_ids", "issuer"]
      },
      "invoice_setting_subscription_schedule_setting": {
        "description": "",
        "properties": {
          "account_tax_ids": {
            "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "days_until_due": {
            "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.",
            "nullable": true,
            "type": "integer"
          },
          "issuer": {
            "$ref": "#/components/schemas/connect_account_reference"
          }
        },
        "required": ["issuer"],
        "title": "InvoiceSettingSubscriptionScheduleSetting",
        "type": "object",
        "x-expandableFields": ["account_tax_ids", "issuer"]
      },
      "invoice_tax_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent), of the tax.",
            "type": "integer"
          },
          "inclusive": {
            "description": "Whether this tax amount is inclusive or exclusive.",
            "type": "boolean"
          },
          "tax_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/tax_rate"
              }
            ],
            "description": "The tax rate that was applied to get this tax amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/tax_rate"
                }
              ]
            }
          },
          "taxability_reason": {
            "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
            "enum": [
              "customer_exempt",
              "not_collecting",
              "not_subject_to_tax",
              "not_supported",
              "portion_product_exempt",
              "portion_reduced_rated",
              "portion_standard_rated",
              "product_exempt",
              "product_exempt_holiday",
              "proportionally_rated",
              "reduced_rated",
              "reverse_charge",
              "standard_rated",
              "taxable_basis_reduced",
              "zero_rated"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "taxable_amount": {
            "description": "The amount on which tax is calculated, in cents (or local equivalent).",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["amount", "inclusive", "tax_rate"],
        "title": "InvoiceTaxAmount",
        "type": "object",
        "x-expandableFields": ["tax_rate"]
      },
      "invoice_threshold_reason": {
        "description": "",
        "properties": {
          "amount_gte": {
            "description": "The total invoice amount threshold boundary if it triggered the threshold invoice.",
            "nullable": true,
            "type": "integer"
          },
          "item_reasons": {
            "description": "Indicates which line items triggered a threshold invoice.",
            "items": {
              "$ref": "#/components/schemas/invoice_item_threshold_reason"
            },
            "type": "array"
          }
        },
        "required": ["item_reasons"],
        "title": "InvoiceThresholdReason",
        "type": "object",
        "x-expandableFields": ["item_reasons"]
      },
      "invoice_transfer_data": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.",
            "nullable": true,
            "type": "integer"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account where funds from the payment will be transferred to upon payment success.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "InvoiceTransferData",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "invoiceitem": {
        "description": "Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an\ninvoice by creating or updating it with an `invoice` field, at which point it will be included as\n[an invoice line item](https://stripe.com/docs/api/invoices/line_item) within\n[invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).",
        "properties": {
          "amount": {
            "description": "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The ID of the customer who will be billed when this invoice item is billed.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "date": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discountable": {
            "description": "If true, discounts will apply to this invoice item. Always false for prorations.",
            "type": "boolean"
          },
          "discounts": {
            "description": "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The ID of the invoice this invoice item belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["invoiceitem"],
            "type": "string"
          },
          "period": {
            "$ref": "#/components/schemas/invoice_line_item_period"
          },
          "price": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/price"
              }
            ],
            "description": "The price of the invoice item.",
            "nullable": true
          },
          "proration": {
            "description": "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.",
            "type": "boolean"
          },
          "quantity": {
            "description": "Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.",
            "type": "integer"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "The subscription that this invoice item has been created for, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "subscription_item": {
            "description": "The subscription item that this invoice item has been created for, if any.",
            "maxLength": 5000,
            "type": "string"
          },
          "tax_rates": {
            "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this invoice item belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "unit_amount": {
            "description": "Unit amount (in the `currency` specified) of the invoice item.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "customer",
          "date",
          "discountable",
          "id",
          "livemode",
          "object",
          "period",
          "proration",
          "quantity"
        ],
        "title": "InvoiceItem",
        "type": "object",
        "x-expandableFields": [
          "customer",
          "discounts",
          "invoice",
          "period",
          "price",
          "subscription",
          "tax_rates",
          "test_clock"
        ],
        "x-resourceId": "invoiceitem"
      },
      "invoices_payment_method_options": {
        "description": "",
        "properties": {
          "acss_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
              }
            ],
            "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "bancontact": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
              }
            ],
            "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_card"
              }
            ],
            "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "customer_balance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
              }
            ],
            "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "konbini": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_konbini"
              }
            ],
            "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "sepa_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
              }
            ],
            "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "us_bank_account": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
              }
            ],
            "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.",
            "nullable": true
          }
        },
        "title": "InvoicesPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "bancontact",
          "card",
          "customer_balance",
          "konbini",
          "sepa_debit",
          "us_bank_account"
        ]
      },
      "invoices_payment_settings": {
        "description": "",
        "properties": {
          "default_mandate": {
            "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_payment_method_options"
              }
            ],
            "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
            "nullable": true
          },
          "payment_method_types": {
            "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).",
            "items": {
              "enum": [
                "ach_credit_transfer",
                "ach_debit",
                "acss_debit",
                "amazon_pay",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "boleto",
                "card",
                "cashapp",
                "customer_balance",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "jp_credit_transfer",
                "kakao_pay",
                "konbini",
                "kr_card",
                "link",
                "multibanco",
                "naver_pay",
                "p24",
                "payco",
                "paynow",
                "paypal",
                "promptpay",
                "revolut_pay",
                "sepa_credit_transfer",
                "sepa_debit",
                "sofort",
                "swish",
                "us_bank_account",
                "wechat_pay"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "InvoicesPaymentSettings",
        "type": "object",
        "x-expandableFields": ["payment_method_options"]
      },
      "invoices_resource_from_invoice": {
        "description": "",
        "properties": {
          "action": {
            "description": "The relation between this invoice and the cloned invoice",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The invoice that was cloned.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          }
        },
        "required": ["action", "invoice"],
        "title": "InvoicesResourceFromInvoice",
        "type": "object",
        "x-expandableFields": ["invoice"]
      },
      "invoices_resource_invoice_rendering": {
        "description": "",
        "properties": {
          "amount_tax_display": {
            "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "pdf": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_rendering_pdf"
              }
            ],
            "description": "Invoice pdf rendering options",
            "nullable": true
          },
          "template": {
            "description": "ID of the rendering template that the invoice is formatted by.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "template_version": {
            "description": "Version of the rendering template that the invoice is using.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "InvoicesResourceInvoiceRendering",
        "type": "object",
        "x-expandableFields": ["pdf"]
      },
      "invoices_resource_invoice_tax_id": {
        "description": "",
        "properties": {
          "type": {
            "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`",
            "enum": [
              "ad_nrt",
              "ae_trn",
              "al_tin",
              "am_tin",
              "ao_tin",
              "ar_cuit",
              "au_abn",
              "au_arn",
              "ba_tin",
              "bb_tin",
              "bg_uic",
              "bh_vat",
              "bo_tin",
              "br_cnpj",
              "br_cpf",
              "bs_tin",
              "by_tin",
              "ca_bn",
              "ca_gst_hst",
              "ca_pst_bc",
              "ca_pst_mb",
              "ca_pst_sk",
              "ca_qst",
              "cd_nif",
              "ch_uid",
              "ch_vat",
              "cl_tin",
              "cn_tin",
              "co_nit",
              "cr_tin",
              "de_stn",
              "do_rcn",
              "ec_ruc",
              "eg_tin",
              "es_cif",
              "eu_oss_vat",
              "eu_vat",
              "gb_vat",
              "ge_vat",
              "gn_nif",
              "hk_br",
              "hr_oib",
              "hu_tin",
              "id_npwp",
              "il_vat",
              "in_gst",
              "is_vat",
              "jp_cn",
              "jp_rn",
              "jp_trn",
              "ke_pin",
              "kh_tin",
              "kr_brn",
              "kz_bin",
              "li_uid",
              "li_vat",
              "ma_vat",
              "md_vat",
              "me_pib",
              "mk_vat",
              "mr_nif",
              "mx_rfc",
              "my_frp",
              "my_itn",
              "my_sst",
              "ng_tin",
              "no_vat",
              "no_voec",
              "np_pan",
              "nz_gst",
              "om_vat",
              "pe_ruc",
              "ph_tin",
              "ro_tin",
              "rs_pib",
              "ru_inn",
              "ru_kpp",
              "sa_vat",
              "sg_gst",
              "sg_uen",
              "si_tin",
              "sn_ninea",
              "sr_fin",
              "sv_nit",
              "th_vat",
              "tj_tin",
              "tr_tin",
              "tw_vat",
              "tz_vat",
              "ua_vat",
              "ug_tin",
              "unknown",
              "us_ein",
              "uy_ruc",
              "uz_tin",
              "uz_vat",
              "ve_rif",
              "vn_tin",
              "za_vat",
              "zm_tin",
              "zw_tin"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the tax ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "InvoicesResourceInvoiceTaxID",
        "type": "object",
        "x-expandableFields": []
      },
      "invoices_resource_line_items_credited_items": {
        "description": "",
        "properties": {
          "invoice": {
            "description": "Invoice containing the credited invoice line items",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice_line_items": {
            "description": "Credited invoice line items",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["invoice", "invoice_line_items"],
        "title": "InvoicesResourceLineItemsCreditedItems",
        "type": "object",
        "x-expandableFields": []
      },
      "invoices_resource_line_items_proration_details": {
        "description": "",
        "properties": {
          "credited_items": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_line_items_credited_items"
              }
            ],
            "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies.",
            "nullable": true
          }
        },
        "title": "InvoicesResourceLineItemsProrationDetails",
        "type": "object",
        "x-expandableFields": ["credited_items"]
      },
      "invoices_resource_pretax_credit_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent), of the pretax credit amount.",
            "type": "integer"
          },
          "credit_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/billing.credit_balance_transaction"
              }
            ],
            "description": "The credit balance transaction that was applied to get this pretax credit amount.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/billing.credit_balance_transaction"
                }
              ]
            }
          },
          "discount": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/discount"
              },
              {
                "$ref": "#/components/schemas/deleted_discount"
              }
            ],
            "description": "The discount that was applied to get this pretax credit amount.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/discount"
                },
                {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              ]
            }
          },
          "type": {
            "description": "Type of the pretax credit amount referenced.",
            "enum": ["credit_balance_transaction", "discount"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["amount", "type"],
        "title": "InvoicesResourcePretaxCreditAmount",
        "type": "object",
        "x-expandableFields": ["credit_balance_transaction", "discount"]
      },
      "invoices_resource_shipping_cost": {
        "description": "",
        "properties": {
          "amount_subtotal": {
            "description": "Total shipping cost before any taxes are applied.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total shipping cost after taxes are applied.",
            "type": "integer"
          },
          "shipping_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/shipping_rate"
              }
            ],
            "description": "The ID of the ShippingRate for this invoice.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              ]
            }
          },
          "taxes": {
            "description": "The taxes applied to the shipping rate.",
            "items": {
              "$ref": "#/components/schemas/line_items_tax_amount"
            },
            "type": "array"
          }
        },
        "required": ["amount_subtotal", "amount_tax", "amount_total"],
        "title": "InvoicesResourceShippingCost",
        "type": "object",
        "x-expandableFields": ["shipping_rate", "taxes"]
      },
      "invoices_resource_status_transitions": {
        "description": "",
        "properties": {
          "finalized_at": {
            "description": "The time that the invoice draft was finalized.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "marked_uncollectible_at": {
            "description": "The time that the invoice was marked uncollectible.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "paid_at": {
            "description": "The time that the invoice was paid.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "voided_at": {
            "description": "The time that the invoice was voided.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "InvoicesResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing.authorization": {
        "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)",
        "properties": {
          "amount": {
            "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.",
            "type": "integer"
          },
          "amount_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_amount_details"
              }
            ],
            "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true
          },
          "approved": {
            "description": "Whether the authorization has been approved.",
            "type": "boolean"
          },
          "authorization_method": {
            "description": "How the card details were provided.",
            "enum": ["chip", "contactless", "keyed_in", "online", "swipe"],
            "type": "string"
          },
          "balance_transactions": {
            "description": "List of balance transactions associated with this authorization.",
            "items": {
              "$ref": "#/components/schemas/balance_transaction"
            },
            "type": "array"
          },
          "card": {
            "$ref": "#/components/schemas/issuing.card"
          },
          "cardholder": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.cardholder"
              }
            ],
            "description": "The cardholder to whom this authorization belongs.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.cardholder"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "fleet": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_data"
              }
            ],
            "description": "Fleet-specific information for authorizations using Fleet cards.",
            "nullable": true
          },
          "fraud_challenges": {
            "description": "Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.",
            "items": {
              "$ref": "#/components/schemas/issuing_authorization_fraud_challenge"
            },
            "nullable": true,
            "type": "array"
          },
          "fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fuel_data"
              }
            ],
            "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "merchant_amount": {
            "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.",
            "type": "integer"
          },
          "merchant_currency": {
            "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "merchant_data": {
            "$ref": "#/components/schemas/issuing_authorization_merchant_data"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "network_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_network_data"
              }
            ],
            "description": "Details about the authorization, such as identifiers, set by the card network.",
            "nullable": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.authorization"],
            "type": "string"
          },
          "pending_request": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_pending_request"
              }
            ],
            "description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.",
            "nullable": true
          },
          "request_history": {
            "description": "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.",
            "items": {
              "$ref": "#/components/schemas/issuing_authorization_request"
            },
            "type": "array"
          },
          "status": {
            "description": "The current status of the authorization in its lifecycle.",
            "enum": ["closed", "pending", "reversed"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "token": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.token"
              }
            ],
            "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.token"
                }
              ]
            }
          },
          "transactions": {
            "description": "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.",
            "items": {
              "$ref": "#/components/schemas/issuing.transaction"
            },
            "type": "array"
          },
          "treasury": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_treasury"
              }
            ],
            "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).",
            "nullable": true
          },
          "verification_data": {
            "$ref": "#/components/schemas/issuing_authorization_verification_data"
          },
          "verified_by_fraud_challenge": {
            "description": "Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.",
            "nullable": true,
            "type": "boolean"
          },
          "wallet": {
            "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "approved",
          "authorization_method",
          "balance_transactions",
          "card",
          "created",
          "currency",
          "id",
          "livemode",
          "merchant_amount",
          "merchant_currency",
          "merchant_data",
          "metadata",
          "object",
          "request_history",
          "status",
          "transactions",
          "verification_data"
        ],
        "title": "IssuingAuthorization",
        "type": "object",
        "x-expandableFields": [
          "amount_details",
          "balance_transactions",
          "card",
          "cardholder",
          "fleet",
          "fraud_challenges",
          "fuel",
          "merchant_data",
          "network_data",
          "pending_request",
          "request_history",
          "token",
          "transactions",
          "treasury",
          "verification_data"
        ],
        "x-resourceId": "issuing.authorization"
      },
      "issuing.card": {
        "description": "You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.",
        "properties": {
          "brand": {
            "description": "The brand of the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "cancellation_reason": {
            "description": "The reason why the card was canceled.",
            "enum": ["design_rejected", "lost", "stolen"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "cardholder": {
            "$ref": "#/components/schemas/issuing.cardholder"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.",
            "format": "currency",
            "type": "string"
          },
          "cvc": {
            "description": "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.",
            "maxLength": 5000,
            "type": "string"
          },
          "exp_month": {
            "description": "The expiration month of the card.",
            "type": "integer"
          },
          "exp_year": {
            "description": "The expiration year of the card.",
            "type": "integer"
          },
          "financial_account": {
            "description": "The financial account this card is attached to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "The last 4 digits of the card number.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "number": {
            "description": "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.card"],
            "type": "string"
          },
          "personalization_design": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.personalization_design"
              }
            ],
            "description": "The personalization design object belonging to this card.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              ]
            }
          },
          "replaced_by": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.card"
              }
            ],
            "description": "The latest card that replaces this card, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.card"
                }
              ]
            }
          },
          "replacement_for": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.card"
              }
            ],
            "description": "The card this card replaces, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.card"
                }
              ]
            }
          },
          "replacement_reason": {
            "description": "The reason why the previous card needed to be replaced.",
            "enum": ["damaged", "expired", "lost", "stolen"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_card_shipping"
              }
            ],
            "description": "Where and how the card will be shipped.",
            "nullable": true
          },
          "spending_controls": {
            "$ref": "#/components/schemas/issuing_card_authorization_controls"
          },
          "status": {
            "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.",
            "enum": ["active", "canceled", "inactive"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "type": {
            "description": "The type of the card.",
            "enum": ["physical", "virtual"],
            "type": "string"
          },
          "wallets": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_card_wallets"
              }
            ],
            "description": "Information relating to digital wallets (like Apple Pay and Google Pay).",
            "nullable": true
          }
        },
        "required": [
          "brand",
          "cardholder",
          "created",
          "currency",
          "exp_month",
          "exp_year",
          "id",
          "last4",
          "livemode",
          "metadata",
          "object",
          "spending_controls",
          "status",
          "type"
        ],
        "title": "IssuingCard",
        "type": "object",
        "x-expandableFields": [
          "cardholder",
          "personalization_design",
          "replaced_by",
          "replacement_for",
          "shipping",
          "spending_controls",
          "wallets"
        ],
        "x-resourceId": "issuing.card"
      },
      "issuing.cardholder": {
        "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder)",
        "properties": {
          "billing": {
            "$ref": "#/components/schemas/issuing_cardholder_address"
          },
          "company": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_company"
              }
            ],
            "description": "Additional information about a `company` cardholder.",
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "email": {
            "description": "The cardholder's email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "individual": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_individual"
              }
            ],
            "description": "Additional information about an `individual` cardholder.",
            "nullable": true
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "The cardholder's name. This will be printed on cards issued to them.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.cardholder"],
            "type": "string"
          },
          "phone_number": {
            "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_locales": {
            "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.",
            "items": {
              "enum": ["de", "en", "es", "fr", "it"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "requirements": {
            "$ref": "#/components/schemas/issuing_cardholder_requirements"
          },
          "spending_controls": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_authorization_controls"
              }
            ],
            "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
            "nullable": true
          },
          "status": {
            "description": "Specifies whether to permit authorizations on this cardholder's cards.",
            "enum": ["active", "blocked", "inactive"],
            "type": "string"
          },
          "type": {
            "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.",
            "enum": ["company", "individual"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": [
          "billing",
          "created",
          "id",
          "livemode",
          "metadata",
          "name",
          "object",
          "requirements",
          "status",
          "type"
        ],
        "title": "IssuingCardholder",
        "type": "object",
        "x-expandableFields": [
          "billing",
          "company",
          "individual",
          "requirements",
          "spending_controls"
        ],
        "x-resourceId": "issuing.cardholder"
      },
      "issuing.dispute": {
        "description": "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)",
        "properties": {
          "amount": {
            "description": "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).",
            "type": "integer"
          },
          "balance_transactions": {
            "description": "List of balance transactions associated with the dispute.",
            "items": {
              "$ref": "#/components/schemas/balance_transaction"
            },
            "nullable": true,
            "type": "array"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "The currency the `transaction` was made in.",
            "format": "currency",
            "type": "string"
          },
          "evidence": {
            "$ref": "#/components/schemas/issuing_dispute_evidence"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "loss_reason": {
            "description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.",
            "enum": [
              "cardholder_authentication_issuer_liability",
              "eci5_token_transaction_with_tavv",
              "excess_disputes_in_timeframe",
              "has_not_met_the_minimum_dispute_amount_requirements",
              "invalid_duplicate_dispute",
              "invalid_incorrect_amount_dispute",
              "invalid_no_authorization",
              "invalid_use_of_disputes",
              "merchandise_delivered_or_shipped",
              "merchandise_or_service_as_described",
              "not_cancelled",
              "other",
              "refund_issued",
              "submitted_beyond_allowable_time_limit",
              "transaction_3ds_required",
              "transaction_approved_after_prior_fraud_dispute",
              "transaction_authorized",
              "transaction_electronically_read",
              "transaction_qualifies_for_visa_easy_payment_service",
              "transaction_unattended"
            ],
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.dispute"],
            "type": "string"
          },
          "status": {
            "description": "Current status of the dispute.",
            "enum": ["expired", "lost", "submitted", "unsubmitted", "won"],
            "type": "string"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.transaction"
              }
            ],
            "description": "The transaction being disputed.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              ]
            }
          },
          "treasury": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_dispute_treasury"
              }
            ],
            "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts",
            "nullable": true
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "evidence",
          "id",
          "livemode",
          "metadata",
          "object",
          "status",
          "transaction"
        ],
        "title": "IssuingDispute",
        "type": "object",
        "x-expandableFields": [
          "balance_transactions",
          "evidence",
          "transaction",
          "treasury"
        ],
        "x-resourceId": "issuing.dispute"
      },
      "issuing.personalization_design": {
        "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.",
        "properties": {
          "card_logo": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "carrier_text": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_personalization_design_carrier_text"
              }
            ],
            "description": "Hash containing carrier text, for use with physical bundles that support carrier text.",
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "lookup_key": {
            "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "Friendly display name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.personalization_design"],
            "type": "string"
          },
          "physical_bundle": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.physical_bundle"
              }
            ],
            "description": "The physical bundle object belonging to this personalization design.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.physical_bundle"
                }
              ]
            }
          },
          "preferences": {
            "$ref": "#/components/schemas/issuing_personalization_design_preferences"
          },
          "rejection_reasons": {
            "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons"
          },
          "status": {
            "description": "Whether this personalization design can be used to create cards.",
            "enum": ["active", "inactive", "rejected", "review"],
            "type": "string"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "metadata",
          "object",
          "physical_bundle",
          "preferences",
          "rejection_reasons",
          "status"
        ],
        "title": "IssuingPersonalizationDesign",
        "type": "object",
        "x-expandableFields": [
          "card_logo",
          "carrier_text",
          "physical_bundle",
          "preferences",
          "rejection_reasons"
        ],
        "x-resourceId": "issuing.personalization_design"
      },
      "issuing.physical_bundle": {
        "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.",
        "properties": {
          "features": {
            "$ref": "#/components/schemas/issuing_physical_bundle_features"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "name": {
            "description": "Friendly display name.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.physical_bundle"],
            "type": "string"
          },
          "status": {
            "description": "Whether this physical bundle can be used to create cards.",
            "enum": ["active", "inactive", "review"],
            "type": "string"
          },
          "type": {
            "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you.",
            "enum": ["custom", "standard"],
            "type": "string"
          }
        },
        "required": [
          "features",
          "id",
          "livemode",
          "name",
          "object",
          "status",
          "type"
        ],
        "title": "IssuingPhysicalBundle",
        "type": "object",
        "x-expandableFields": ["features"],
        "x-resourceId": "issuing.physical_bundle"
      },
      "issuing.settlement": {
        "description": "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.",
        "properties": {
          "bin": {
            "description": "The Bank Identification Number reflecting this settlement record.",
            "maxLength": 5000,
            "type": "string"
          },
          "clearing_date": {
            "description": "The date that the transactions are cleared and posted to user's accounts.",
            "format": "unix-time",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "interchange_fees": {
            "description": "The total interchange received as reimbursement for the transactions.",
            "type": "integer"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "net_total": {
            "description": "The total net amount required to settle with the network.",
            "type": "integer"
          },
          "network": {
            "description": "The card network for this settlement report. One of [\"visa\", \"maestro\"]",
            "enum": ["maestro", "visa"],
            "type": "string"
          },
          "network_fees": {
            "description": "The total amount of fees owed to the network.",
            "type": "integer"
          },
          "network_settlement_identifier": {
            "description": "The Settlement Identification Number assigned by the network.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.settlement"],
            "type": "string"
          },
          "settlement_service": {
            "description": "One of `international` or `uk_national_net`.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "The current processing status of this settlement.",
            "enum": ["complete", "pending"],
            "type": "string"
          },
          "transaction_count": {
            "description": "The total number of transactions reflected in this settlement.",
            "type": "integer"
          },
          "transaction_volume": {
            "description": "The total transaction amount reflected in this settlement.",
            "type": "integer"
          }
        },
        "required": [
          "bin",
          "clearing_date",
          "created",
          "currency",
          "id",
          "interchange_fees",
          "livemode",
          "metadata",
          "net_total",
          "network",
          "network_fees",
          "network_settlement_identifier",
          "object",
          "settlement_service",
          "status",
          "transaction_count",
          "transaction_volume"
        ],
        "title": "IssuingSettlement",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "issuing.settlement"
      },
      "issuing.token": {
        "description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.",
        "properties": {
          "card": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.card"
              }
            ],
            "description": "Card associated with this token.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.card"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "device_fingerprint": {
            "description": "The hashed ID derived from the device ID from the card network associated with the token.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the token.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "network": {
            "description": "The token service provider / card network associated with the token.",
            "enum": ["mastercard", "visa"],
            "type": "string"
          },
          "network_data": {
            "$ref": "#/components/schemas/issuing_network_token_network_data"
          },
          "network_updated_at": {
            "description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.token"],
            "type": "string"
          },
          "status": {
            "description": "The usage state of the token.",
            "enum": ["active", "deleted", "requested", "suspended"],
            "type": "string"
          },
          "wallet_provider": {
            "description": "The digital wallet for this token, if one was used.",
            "enum": ["apple_pay", "google_pay", "samsung_pay"],
            "type": "string"
          }
        },
        "required": [
          "card",
          "created",
          "id",
          "livemode",
          "network",
          "network_updated_at",
          "object",
          "status"
        ],
        "title": "IssuingNetworkToken",
        "type": "object",
        "x-expandableFields": ["card", "network_data"],
        "x-resourceId": "issuing.token"
      },
      "issuing.transaction": {
        "description": "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)",
        "properties": {
          "amount": {
            "description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "amount_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_amount_details"
              }
            ],
            "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true
          },
          "authorization": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.authorization"
              }
            ],
            "description": "The `Authorization` object that led to this transaction.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              ]
            }
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "card": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.card"
              }
            ],
            "description": "The card used to make this transaction.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.card"
                }
              ]
            }
          },
          "cardholder": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.cardholder"
              }
            ],
            "description": "The cardholder to whom this transaction belongs.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.cardholder"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "dispute": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.dispute"
              }
            ],
            "description": "If you've disputed the transaction, the ID of the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.dispute"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "merchant_amount": {
            "description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.",
            "type": "integer"
          },
          "merchant_currency": {
            "description": "The currency with which the merchant is taking payment.",
            "format": "currency",
            "type": "string"
          },
          "merchant_data": {
            "$ref": "#/components/schemas/issuing_authorization_merchant_data"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "network_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_network_data"
              }
            ],
            "description": "Details about the transaction, such as processing dates, set by the card network.",
            "nullable": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["issuing.transaction"],
            "type": "string"
          },
          "purchase_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_purchase_details"
              }
            ],
            "description": "Additional purchase information that is optionally provided by the merchant.",
            "nullable": true
          },
          "token": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/issuing.token"
              }
            ],
            "description": "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/issuing.token"
                }
              ]
            }
          },
          "treasury": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_treasury"
              }
            ],
            "description": "[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts",
            "nullable": true
          },
          "type": {
            "description": "The nature of the transaction.",
            "enum": ["capture", "refund"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "wallet": {
            "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.",
            "enum": ["apple_pay", "google_pay", "samsung_pay"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "card",
          "created",
          "currency",
          "id",
          "livemode",
          "merchant_amount",
          "merchant_currency",
          "merchant_data",
          "metadata",
          "object",
          "type"
        ],
        "title": "IssuingTransaction",
        "type": "object",
        "x-expandableFields": [
          "amount_details",
          "authorization",
          "balance_transaction",
          "card",
          "cardholder",
          "dispute",
          "merchant_data",
          "network_data",
          "purchase_details",
          "token",
          "treasury"
        ],
        "x-resourceId": "issuing.transaction"
      },
      "issuing_authorization_amount_details": {
        "description": "",
        "properties": {
          "atm_fee": {
            "description": "The fee charged by the ATM for the cash withdrawal.",
            "nullable": true,
            "type": "integer"
          },
          "cashback_amount": {
            "description": "The amount of cash requested by the cardholder.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingAuthorizationAmountDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_authentication_exemption": {
        "description": "",
        "properties": {
          "claimed_by": {
            "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.",
            "enum": ["acquirer", "issuer"],
            "type": "string"
          },
          "type": {
            "description": "The specific exemption claimed for this authorization.",
            "enum": [
              "low_value_transaction",
              "transaction_risk_analysis",
              "unknown"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["claimed_by", "type"],
        "title": "IssuingAuthorizationAuthenticationExemption",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fleet_cardholder_prompt_data": {
        "description": "",
        "properties": {
          "alphanumeric_id": {
            "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "driver_id": {
            "description": "Driver ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "odometer": {
            "description": "Odometer reading.",
            "nullable": true,
            "type": "integer"
          },
          "unspecified_id": {
            "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_id": {
            "description": "User ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "vehicle_number": {
            "description": "Vehicle number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFleetCardholderPromptData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fleet_data": {
        "description": "",
        "properties": {
          "cardholder_prompt_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data"
              }
            ],
            "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.",
            "nullable": true
          },
          "purchase_type": {
            "description": "The type of purchase.",
            "enum": [
              "fuel_and_non_fuel_purchase",
              "fuel_purchase",
              "non_fuel_purchase"
            ],
            "nullable": true,
            "type": "string"
          },
          "reported_breakdown": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown"
              }
            ],
            "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
            "nullable": true
          },
          "service_type": {
            "description": "The type of fuel service.",
            "enum": ["full_service", "non_fuel_transaction", "self_service"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFleetData",
        "type": "object",
        "x-expandableFields": ["cardholder_prompt_data", "reported_breakdown"]
      },
      "issuing_authorization_fleet_fuel_price_data": {
        "description": "",
        "properties": {
          "gross_amount_decimal": {
            "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFleetFuelPriceData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fleet_non_fuel_price_data": {
        "description": "",
        "properties": {
          "gross_amount_decimal": {
            "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFleetNonFuelPriceData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fleet_reported_breakdown": {
        "description": "",
        "properties": {
          "fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data"
              }
            ],
            "description": "Breakdown of fuel portion of the purchase.",
            "nullable": true
          },
          "non_fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data"
              }
            ],
            "description": "Breakdown of non-fuel portion of the purchase.",
            "nullable": true
          },
          "tax": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data"
              }
            ],
            "description": "Information about tax included in this transaction.",
            "nullable": true
          }
        },
        "title": "IssuingAuthorizationFleetReportedBreakdown",
        "type": "object",
        "x-expandableFields": ["fuel", "non_fuel", "tax"]
      },
      "issuing_authorization_fleet_tax_data": {
        "description": "",
        "properties": {
          "local_amount_decimal": {
            "description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "national_amount_decimal": {
            "description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFleetTaxData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fraud_challenge": {
        "description": "",
        "properties": {
          "channel": {
            "description": "The method by which the fraud challenge was delivered to the cardholder.",
            "enum": ["sms"],
            "type": "string"
          },
          "status": {
            "description": "The status of the fraud challenge.",
            "enum": [
              "expired",
              "pending",
              "rejected",
              "undeliverable",
              "verified"
            ],
            "type": "string"
          },
          "undeliverable_reason": {
            "description": "If the challenge is not deliverable, the reason why.",
            "enum": ["no_phone_number", "unsupported_phone_number"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["channel", "status"],
        "title": "IssuingAuthorizationFraudChallenge",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_fuel_data": {
        "description": "",
        "properties": {
          "industry_product_code": {
            "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity_decimal": {
            "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The type of fuel that was purchased.",
            "enum": [
              "diesel",
              "other",
              "unleaded_plus",
              "unleaded_regular",
              "unleaded_super"
            ],
            "nullable": true,
            "type": "string"
          },
          "unit": {
            "description": "The units for `quantity_decimal`.",
            "enum": [
              "charging_minute",
              "imperial_gallon",
              "kilogram",
              "kilowatt_hour",
              "liter",
              "other",
              "pound",
              "us_gallon"
            ],
            "nullable": true,
            "type": "string"
          },
          "unit_cost_decimal": {
            "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationFuelData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_merchant_data": {
        "description": "",
        "properties": {
          "category": {
            "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.",
            "maxLength": 5000,
            "type": "string"
          },
          "category_code": {
            "description": "The merchant category code for the seller’s business",
            "maxLength": 5000,
            "type": "string"
          },
          "city": {
            "description": "City where the seller is located",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Country where the seller is located",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Name of the seller",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_id": {
            "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
            "maxLength": 5000,
            "type": "string"
          },
          "postal_code": {
            "description": "Postal code where the seller is located",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "State where the seller is located",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_id": {
            "description": "The seller's tax identification number. Currently populated for French merchants only.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "terminal_id": {
            "description": "An ID assigned by the seller to the location of the sale.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "URL provided by the merchant on a 3DS request",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["category", "category_code", "network_id"],
        "title": "IssuingAuthorizationMerchantData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_network_data": {
        "description": "",
        "properties": {
          "acquiring_institution_id": {
            "description": "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "system_trace_audit_number": {
            "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingAuthorizationNetworkData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_pending_request": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "amount_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_amount_details"
              }
            ],
            "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "is_amount_controllable": {
            "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.",
            "type": "boolean"
          },
          "merchant_amount": {
            "description": "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "merchant_currency": {
            "description": "The local currency the merchant is requesting to authorize.",
            "format": "currency",
            "type": "string"
          },
          "network_risk_score": {
            "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "currency",
          "is_amount_controllable",
          "merchant_amount",
          "merchant_currency"
        ],
        "title": "IssuingAuthorizationPendingRequest",
        "type": "object",
        "x-expandableFields": ["amount_details"]
      },
      "issuing_authorization_request": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.",
            "type": "integer"
          },
          "amount_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_amount_details"
              }
            ],
            "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true
          },
          "approved": {
            "description": "Whether this request was approved.",
            "type": "boolean"
          },
          "authorization_code": {
            "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "merchant_amount": {
            "description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "merchant_currency": {
            "description": "The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "network_risk_score": {
            "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.",
            "nullable": true,
            "type": "integer"
          },
          "reason": {
            "description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.",
            "enum": [
              "account_disabled",
              "card_active",
              "card_canceled",
              "card_expired",
              "card_inactive",
              "cardholder_blocked",
              "cardholder_inactive",
              "cardholder_verification_required",
              "insecure_authorization_method",
              "insufficient_funds",
              "not_allowed",
              "pin_blocked",
              "spending_controls",
              "suspected_fraud",
              "verification_failed",
              "webhook_approved",
              "webhook_declined",
              "webhook_error",
              "webhook_timeout"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "reason_message": {
            "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "requested_at": {
            "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "approved",
          "created",
          "currency",
          "merchant_amount",
          "merchant_currency",
          "reason"
        ],
        "title": "IssuingAuthorizationRequest",
        "type": "object",
        "x-expandableFields": ["amount_details"]
      },
      "issuing_authorization_three_d_secure": {
        "description": "",
        "properties": {
          "result": {
            "description": "The outcome of the 3D Secure authentication request.",
            "enum": [
              "attempt_acknowledged",
              "authenticated",
              "failed",
              "required"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["result"],
        "title": "IssuingAuthorizationThreeDSecure",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_treasury": {
        "description": "",
        "properties": {
          "received_credits": {
            "description": "The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "received_debits": {
            "description": "The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "transaction": {
            "description": "The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["received_credits", "received_debits"],
        "title": "IssuingAuthorizationTreasury",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_authorization_verification_data": {
        "description": "",
        "properties": {
          "address_line1_check": {
            "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.",
            "enum": ["match", "mismatch", "not_provided"],
            "type": "string"
          },
          "address_postal_code_check": {
            "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.",
            "enum": ["match", "mismatch", "not_provided"],
            "type": "string"
          },
          "authentication_exemption": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_authentication_exemption"
              }
            ],
            "description": "The exemption applied to this authorization.",
            "nullable": true
          },
          "cvc_check": {
            "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
            "enum": ["match", "mismatch", "not_provided"],
            "type": "string"
          },
          "expiry_check": {
            "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.",
            "enum": ["match", "mismatch", "not_provided"],
            "type": "string"
          },
          "postal_code": {
            "description": "The postal code submitted as part of the authorization used for postal code verification.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "three_d_secure": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_authorization_three_d_secure"
              }
            ],
            "description": "3D Secure details.",
            "nullable": true
          }
        },
        "required": [
          "address_line1_check",
          "address_postal_code_check",
          "cvc_check",
          "expiry_check"
        ],
        "title": "IssuingAuthorizationVerificationData",
        "type": "object",
        "x-expandableFields": ["authentication_exemption", "three_d_secure"]
      },
      "issuing_card_apple_pay": {
        "description": "",
        "properties": {
          "eligible": {
            "description": "Apple Pay Eligibility",
            "type": "boolean"
          },
          "ineligible_reason": {
            "description": "Reason the card is ineligible for Apple Pay",
            "enum": [
              "missing_agreement",
              "missing_cardholder_contact",
              "unsupported_region"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["eligible"],
        "title": "IssuingCardApplePay",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_card_authorization_controls": {
        "description": "",
        "properties": {
          "allowed_categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "allowed_merchant_countries": {
            "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "blocked_categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "blocked_merchant_countries": {
            "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "spending_limits": {
            "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).",
            "items": {
              "$ref": "#/components/schemas/issuing_card_spending_limit"
            },
            "nullable": true,
            "type": "array"
          },
          "spending_limits_currency": {
            "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card.",
            "format": "currency",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingCardAuthorizationControls",
        "type": "object",
        "x-expandableFields": ["spending_limits"]
      },
      "issuing_card_google_pay": {
        "description": "",
        "properties": {
          "eligible": {
            "description": "Google Pay Eligibility",
            "type": "boolean"
          },
          "ineligible_reason": {
            "description": "Reason the card is ineligible for Google Pay",
            "enum": [
              "missing_agreement",
              "missing_cardholder_contact",
              "unsupported_region"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["eligible"],
        "title": "IssuingCardGooglePay",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_card_shipping": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "address_validation": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_card_shipping_address_validation"
              }
            ],
            "description": "Address validation details for the shipment.",
            "nullable": true
          },
          "carrier": {
            "description": "The delivery company that shipped a card.",
            "enum": ["dhl", "fedex", "royal_mail", "usps"],
            "nullable": true,
            "type": "string"
          },
          "customs": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_card_shipping_customs"
              }
            ],
            "description": "Additional information that may be required for clearing customs.",
            "nullable": true
          },
          "eta": {
            "description": "A unix timestamp representing a best estimate of when the card will be delivered.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "name": {
            "description": "Recipient name.",
            "maxLength": 5000,
            "type": "string"
          },
          "phone_number": {
            "description": "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "require_signature": {
            "description": "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.",
            "nullable": true,
            "type": "boolean"
          },
          "service": {
            "description": "Shipment service, such as `standard` or `express`.",
            "enum": ["express", "priority", "standard"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "status": {
            "description": "The delivery status of the card.",
            "enum": [
              "canceled",
              "delivered",
              "failure",
              "pending",
              "returned",
              "shipped",
              "submitted"
            ],
            "nullable": true,
            "type": "string"
          },
          "tracking_number": {
            "description": "A tracking number for a card shipment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tracking_url": {
            "description": "A link to the shipping carrier's site where you can view detailed information about a card shipment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "Packaging options.",
            "enum": ["bulk", "individual"],
            "type": "string"
          }
        },
        "required": ["address", "name", "service", "type"],
        "title": "IssuingCardShipping",
        "type": "object",
        "x-expandableFields": ["address", "address_validation", "customs"]
      },
      "issuing_card_shipping_address_validation": {
        "description": "",
        "properties": {
          "mode": {
            "description": "The address validation capabilities to use.",
            "enum": [
              "disabled",
              "normalization_only",
              "validation_and_normalization"
            ],
            "type": "string"
          },
          "normalized_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "The normalized shipping address.",
            "nullable": true
          },
          "result": {
            "description": "The validation result for the shipping address.",
            "enum": [
              "indeterminate",
              "likely_deliverable",
              "likely_undeliverable"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["mode"],
        "title": "IssuingCardShippingAddressValidation",
        "type": "object",
        "x-expandableFields": ["normalized_address"]
      },
      "issuing_card_shipping_customs": {
        "description": "",
        "properties": {
          "eori_number": {
            "description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingCardShippingCustoms",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_card_spending_limit": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "interval": {
            "description": "Interval (or event) to which the amount applies.",
            "enum": [
              "all_time",
              "daily",
              "monthly",
              "per_authorization",
              "weekly",
              "yearly"
            ],
            "type": "string"
          }
        },
        "required": ["amount", "interval"],
        "title": "IssuingCardSpendingLimit",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_card_wallets": {
        "description": "",
        "properties": {
          "apple_pay": {
            "$ref": "#/components/schemas/issuing_card_apple_pay"
          },
          "google_pay": {
            "$ref": "#/components/schemas/issuing_card_google_pay"
          },
          "primary_account_identifier": {
            "description": "Unique identifier for a card used with digital wallets",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["apple_pay", "google_pay"],
        "title": "IssuingCardWallets",
        "type": "object",
        "x-expandableFields": ["apple_pay", "google_pay"]
      },
      "issuing_cardholder_address": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          }
        },
        "required": ["address"],
        "title": "IssuingCardholderAddress",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "issuing_cardholder_authorization_controls": {
        "description": "",
        "properties": {
          "allowed_categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "allowed_merchant_countries": {
            "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "blocked_categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "blocked_merchant_countries": {
            "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "spending_limits": {
            "description": "Limit spending with amount-based rules that apply across this cardholder's cards.",
            "items": {
              "$ref": "#/components/schemas/issuing_cardholder_spending_limit"
            },
            "nullable": true,
            "type": "array"
          },
          "spending_limits_currency": {
            "description": "Currency of the amounts within `spending_limits`.",
            "format": "currency",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingCardholderAuthorizationControls",
        "type": "object",
        "x-expandableFields": ["spending_limits"]
      },
      "issuing_cardholder_card_issuing": {
        "description": "",
        "properties": {
          "user_terms_acceptance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_user_terms_acceptance"
              }
            ],
            "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.",
            "nullable": true
          }
        },
        "title": "IssuingCardholderCardIssuing",
        "type": "object",
        "x-expandableFields": ["user_terms_acceptance"]
      },
      "issuing_cardholder_company": {
        "description": "",
        "properties": {
          "tax_id_provided": {
            "description": "Whether the company's business ID number was provided.",
            "type": "boolean"
          }
        },
        "required": ["tax_id_provided"],
        "title": "IssuingCardholderCompany",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_cardholder_id_document": {
        "description": "",
        "properties": {
          "back": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "front": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          }
        },
        "title": "IssuingCardholderIdDocument",
        "type": "object",
        "x-expandableFields": ["back", "front"]
      },
      "issuing_cardholder_individual": {
        "description": "",
        "properties": {
          "card_issuing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_card_issuing"
              }
            ],
            "description": "Information related to the card_issuing program for this cardholder.",
            "nullable": true
          },
          "dob": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_individual_dob"
              }
            ],
            "description": "The date of birth of this cardholder.",
            "nullable": true
          },
          "first_name": {
            "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last_name": {
            "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verification": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_verification"
              }
            ],
            "description": "Government-issued ID document for this cardholder.",
            "nullable": true
          }
        },
        "title": "IssuingCardholderIndividual",
        "type": "object",
        "x-expandableFields": ["card_issuing", "dob", "verification"]
      },
      "issuing_cardholder_individual_dob": {
        "description": "",
        "properties": {
          "day": {
            "description": "The day of birth, between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "The month of birth, between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year of birth.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingCardholderIndividualDOB",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_cardholder_requirements": {
        "description": "",
        "properties": {
          "disabled_reason": {
            "description": "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.",
            "enum": [
              "listed",
              "rejected.listed",
              "requirements.past_due",
              "under_review"
            ],
            "nullable": true,
            "type": "string"
          },
          "past_due": {
            "description": "Array of fields that need to be collected in order to verify and re-enable the cardholder.",
            "items": {
              "enum": [
                "company.tax_id",
                "individual.card_issuing.user_terms_acceptance.date",
                "individual.card_issuing.user_terms_acceptance.ip",
                "individual.dob.day",
                "individual.dob.month",
                "individual.dob.year",
                "individual.first_name",
                "individual.last_name",
                "individual.verification.document"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "IssuingCardholderRequirements",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_cardholder_spending_limit": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "categories": {
            "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.",
            "items": {
              "enum": [
                "ac_refrigeration_repair",
                "accounting_bookkeeping_services",
                "advertising_services",
                "agricultural_cooperative",
                "airlines_air_carriers",
                "airports_flying_fields",
                "ambulance_services",
                "amusement_parks_carnivals",
                "antique_reproductions",
                "antique_shops",
                "aquariums",
                "architectural_surveying_services",
                "art_dealers_and_galleries",
                "artists_supply_and_craft_shops",
                "auto_and_home_supply_stores",
                "auto_body_repair_shops",
                "auto_paint_shops",
                "auto_service_shops",
                "automated_cash_disburse",
                "automated_fuel_dispensers",
                "automobile_associations",
                "automotive_parts_and_accessories_stores",
                "automotive_tire_stores",
                "bail_and_bond_payments",
                "bakeries",
                "bands_orchestras",
                "barber_and_beauty_shops",
                "betting_casino_gambling",
                "bicycle_shops",
                "billiard_pool_establishments",
                "boat_dealers",
                "boat_rentals_and_leases",
                "book_stores",
                "books_periodicals_and_newspapers",
                "bowling_alleys",
                "bus_lines",
                "business_secretarial_schools",
                "buying_shopping_services",
                "cable_satellite_and_other_pay_television_and_radio",
                "camera_and_photographic_supply_stores",
                "candy_nut_and_confectionery_stores",
                "car_and_truck_dealers_new_used",
                "car_and_truck_dealers_used_only",
                "car_rental_agencies",
                "car_washes",
                "carpentry_services",
                "carpet_upholstery_cleaning",
                "caterers",
                "charitable_and_social_service_organizations_fundraising",
                "chemicals_and_allied_products",
                "child_care_services",
                "childrens_and_infants_wear_stores",
                "chiropodists_podiatrists",
                "chiropractors",
                "cigar_stores_and_stands",
                "civic_social_fraternal_associations",
                "cleaning_and_maintenance",
                "clothing_rental",
                "colleges_universities",
                "commercial_equipment",
                "commercial_footwear",
                "commercial_photography_art_and_graphics",
                "commuter_transport_and_ferries",
                "computer_network_services",
                "computer_programming",
                "computer_repair",
                "computer_software_stores",
                "computers_peripherals_and_software",
                "concrete_work_services",
                "construction_materials",
                "consulting_public_relations",
                "correspondence_schools",
                "cosmetic_stores",
                "counseling_services",
                "country_clubs",
                "courier_services",
                "court_costs",
                "credit_reporting_agencies",
                "cruise_lines",
                "dairy_products_stores",
                "dance_hall_studios_schools",
                "dating_escort_services",
                "dentists_orthodontists",
                "department_stores",
                "detective_agencies",
                "digital_goods_applications",
                "digital_goods_games",
                "digital_goods_large_volume",
                "digital_goods_media",
                "direct_marketing_catalog_merchant",
                "direct_marketing_combination_catalog_and_retail_merchant",
                "direct_marketing_inbound_telemarketing",
                "direct_marketing_insurance_services",
                "direct_marketing_other",
                "direct_marketing_outbound_telemarketing",
                "direct_marketing_subscription",
                "direct_marketing_travel",
                "discount_stores",
                "doctors",
                "door_to_door_sales",
                "drapery_window_covering_and_upholstery_stores",
                "drinking_places",
                "drug_stores_and_pharmacies",
                "drugs_drug_proprietaries_and_druggist_sundries",
                "dry_cleaners",
                "durable_goods",
                "duty_free_stores",
                "eating_places_restaurants",
                "educational_services",
                "electric_razor_stores",
                "electric_vehicle_charging",
                "electrical_parts_and_equipment",
                "electrical_services",
                "electronics_repair_shops",
                "electronics_stores",
                "elementary_secondary_schools",
                "emergency_services_gcas_visa_use_only",
                "employment_temp_agencies",
                "equipment_rental",
                "exterminating_services",
                "family_clothing_stores",
                "fast_food_restaurants",
                "financial_institutions",
                "fines_government_administrative_entities",
                "fireplace_fireplace_screens_and_accessories_stores",
                "floor_covering_stores",
                "florists",
                "florists_supplies_nursery_stock_and_flowers",
                "freezer_and_locker_meat_provisioners",
                "fuel_dealers_non_automotive",
                "funeral_services_crematories",
                "furniture_home_furnishings_and_equipment_stores_except_appliances",
                "furniture_repair_refinishing",
                "furriers_and_fur_shops",
                "general_services",
                "gift_card_novelty_and_souvenir_shops",
                "glass_paint_and_wallpaper_stores",
                "glassware_crystal_stores",
                "golf_courses_public",
                "government_licensed_horse_dog_racing_us_region_only",
                "government_licensed_online_casions_online_gambling_us_region_only",
                "government_owned_lotteries_non_us_region",
                "government_owned_lotteries_us_region_only",
                "government_services",
                "grocery_stores_supermarkets",
                "hardware_equipment_and_supplies",
                "hardware_stores",
                "health_and_beauty_spas",
                "hearing_aids_sales_and_supplies",
                "heating_plumbing_a_c",
                "hobby_toy_and_game_shops",
                "home_supply_warehouse_stores",
                "hospitals",
                "hotels_motels_and_resorts",
                "household_appliance_stores",
                "industrial_supplies",
                "information_retrieval_services",
                "insurance_default",
                "insurance_underwriting_premiums",
                "intra_company_purchases",
                "jewelry_stores_watches_clocks_and_silverware_stores",
                "landscaping_services",
                "laundries",
                "laundry_cleaning_services",
                "legal_services_attorneys",
                "luggage_and_leather_goods_stores",
                "lumber_building_materials_stores",
                "manual_cash_disburse",
                "marinas_service_and_supplies",
                "marketplaces",
                "masonry_stonework_and_plaster",
                "massage_parlors",
                "medical_and_dental_labs",
                "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                "medical_services",
                "membership_organizations",
                "mens_and_boys_clothing_and_accessories_stores",
                "mens_womens_clothing_stores",
                "metal_service_centers",
                "miscellaneous",
                "miscellaneous_apparel_and_accessory_shops",
                "miscellaneous_auto_dealers",
                "miscellaneous_business_services",
                "miscellaneous_food_stores",
                "miscellaneous_general_merchandise",
                "miscellaneous_general_services",
                "miscellaneous_home_furnishing_specialty_stores",
                "miscellaneous_publishing_and_printing",
                "miscellaneous_recreation_services",
                "miscellaneous_repair_shops",
                "miscellaneous_specialty_retail",
                "mobile_home_dealers",
                "motion_picture_theaters",
                "motor_freight_carriers_and_trucking",
                "motor_homes_dealers",
                "motor_vehicle_supplies_and_new_parts",
                "motorcycle_shops_and_dealers",
                "motorcycle_shops_dealers",
                "music_stores_musical_instruments_pianos_and_sheet_music",
                "news_dealers_and_newsstands",
                "non_fi_money_orders",
                "non_fi_stored_value_card_purchase_load",
                "nondurable_goods",
                "nurseries_lawn_and_garden_supply_stores",
                "nursing_personal_care",
                "office_and_commercial_furniture",
                "opticians_eyeglasses",
                "optometrists_ophthalmologist",
                "orthopedic_goods_prosthetic_devices",
                "osteopaths",
                "package_stores_beer_wine_and_liquor",
                "paints_varnishes_and_supplies",
                "parking_lots_garages",
                "passenger_railways",
                "pawn_shops",
                "pet_shops_pet_food_and_supplies",
                "petroleum_and_petroleum_products",
                "photo_developing",
                "photographic_photocopy_microfilm_equipment_and_supplies",
                "photographic_studios",
                "picture_video_production",
                "piece_goods_notions_and_other_dry_goods",
                "plumbing_heating_equipment_and_supplies",
                "political_organizations",
                "postal_services_government_only",
                "precious_stones_and_metals_watches_and_jewelry",
                "professional_services",
                "public_warehousing_and_storage",
                "quick_copy_repro_and_blueprint",
                "railroads",
                "real_estate_agents_and_managers_rentals",
                "record_stores",
                "recreational_vehicle_rentals",
                "religious_goods_stores",
                "religious_organizations",
                "roofing_siding_sheet_metal",
                "secretarial_support_services",
                "security_brokers_dealers",
                "service_stations",
                "sewing_needlework_fabric_and_piece_goods_stores",
                "shoe_repair_hat_cleaning",
                "shoe_stores",
                "small_appliance_repair",
                "snowmobile_dealers",
                "special_trade_services",
                "specialty_cleaning",
                "sporting_goods_stores",
                "sporting_recreation_camps",
                "sports_and_riding_apparel_stores",
                "sports_clubs_fields",
                "stamp_and_coin_stores",
                "stationary_office_supplies_printing_and_writing_paper",
                "stationery_stores_office_and_school_supply_stores",
                "swimming_pools_sales",
                "t_ui_travel_germany",
                "tailors_alterations",
                "tax_payments_government_agencies",
                "tax_preparation_services",
                "taxicabs_limousines",
                "telecommunication_equipment_and_telephone_sales",
                "telecommunication_services",
                "telegraph_services",
                "tent_and_awning_shops",
                "testing_laboratories",
                "theatrical_ticket_agencies",
                "timeshares",
                "tire_retreading_and_repair",
                "tolls_bridge_fees",
                "tourist_attractions_and_exhibits",
                "towing_services",
                "trailer_parks_campgrounds",
                "transportation_services",
                "travel_agencies_tour_operators",
                "truck_stop_iteration",
                "truck_utility_trailer_rentals",
                "typesetting_plate_making_and_related_services",
                "typewriter_stores",
                "u_s_federal_government_agencies_or_departments",
                "uniforms_commercial_clothing",
                "used_merchandise_and_secondhand_stores",
                "utilities",
                "variety_stores",
                "veterinary_services",
                "video_amusement_game_supplies",
                "video_game_arcades",
                "video_tape_rental_stores",
                "vocational_trade_schools",
                "watch_jewelry_repair",
                "welding_repair",
                "wholesale_clubs",
                "wig_and_toupee_stores",
                "wires_money_orders",
                "womens_accessory_and_specialty_shops",
                "womens_ready_to_wear_stores",
                "wrecking_and_salvage_yards"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "interval": {
            "description": "Interval (or event) to which the amount applies.",
            "enum": [
              "all_time",
              "daily",
              "monthly",
              "per_authorization",
              "weekly",
              "yearly"
            ],
            "type": "string"
          }
        },
        "required": ["amount", "interval"],
        "title": "IssuingCardholderSpendingLimit",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_cardholder_user_terms_acceptance": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the cardholder accepted the Authorized User Terms.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingCardholderUserTermsAcceptance",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_cardholder_verification": {
        "description": "",
        "properties": {
          "document": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_cardholder_id_document"
              }
            ],
            "description": "An identifying document, either a passport or local ID card.",
            "nullable": true
          }
        },
        "title": "IssuingCardholderVerification",
        "type": "object",
        "x-expandableFields": ["document"]
      },
      "issuing_dispute_canceled_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "canceled_at": {
            "description": "Date when order was canceled.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancellation_policy_provided": {
            "description": "Whether the cardholder was provided with a cancellation policy.",
            "nullable": true,
            "type": "boolean"
          },
          "cancellation_reason": {
            "description": "Reason for canceling the order.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "expected_at": {
            "description": "Date when the cardholder expected to receive the product.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "Description of the merchandise or service that was purchased.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_type": {
            "description": "Whether the product was a merchandise or service.",
            "enum": ["merchandise", "service"],
            "nullable": true,
            "type": "string"
          },
          "return_status": {
            "description": "Result of cardholder's attempt to return the product.",
            "enum": ["merchant_rejected", "successful"],
            "nullable": true,
            "type": "string"
          },
          "returned_at": {
            "description": "Date when the product was returned or attempted to be returned.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingDisputeCanceledEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_duplicate_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "card_statement": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "cash_receipt": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "check_image": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "original_transaction": {
            "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingDisputeDuplicateEvidence",
        "type": "object",
        "x-expandableFields": [
          "additional_documentation",
          "card_statement",
          "cash_receipt",
          "check_image"
        ]
      },
      "issuing_dispute_evidence": {
        "description": "",
        "properties": {
          "canceled": {
            "$ref": "#/components/schemas/issuing_dispute_canceled_evidence"
          },
          "duplicate": {
            "$ref": "#/components/schemas/issuing_dispute_duplicate_evidence"
          },
          "fraudulent": {
            "$ref": "#/components/schemas/issuing_dispute_fraudulent_evidence"
          },
          "merchandise_not_as_described": {
            "$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence"
          },
          "no_valid_authorization": {
            "$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence"
          },
          "not_received": {
            "$ref": "#/components/schemas/issuing_dispute_not_received_evidence"
          },
          "other": {
            "$ref": "#/components/schemas/issuing_dispute_other_evidence"
          },
          "reason": {
            "description": "The reason for filing the dispute. Its value will match the field containing the evidence.",
            "enum": [
              "canceled",
              "duplicate",
              "fraudulent",
              "merchandise_not_as_described",
              "no_valid_authorization",
              "not_received",
              "other",
              "service_not_as_described"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "service_not_as_described": {
            "$ref": "#/components/schemas/issuing_dispute_service_not_as_described_evidence"
          }
        },
        "required": ["reason"],
        "title": "IssuingDisputeEvidence",
        "type": "object",
        "x-expandableFields": [
          "canceled",
          "duplicate",
          "fraudulent",
          "merchandise_not_as_described",
          "no_valid_authorization",
          "not_received",
          "other",
          "service_not_as_described"
        ]
      },
      "issuing_dispute_fraudulent_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingDisputeFraudulentEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_merchandise_not_as_described_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "received_at": {
            "description": "Date when the product was received.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "return_description": {
            "description": "Description of the cardholder's attempt to return the product.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "return_status": {
            "description": "Result of cardholder's attempt to return the product.",
            "enum": ["merchant_rejected", "successful"],
            "nullable": true,
            "type": "string"
          },
          "returned_at": {
            "description": "Date when the product was returned or attempted to be returned.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingDisputeMerchandiseNotAsDescribedEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_no_valid_authorization_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingDisputeNoValidAuthorizationEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_not_received_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "expected_at": {
            "description": "Date when the cardholder expected to receive the product.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "Description of the merchandise or service that was purchased.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_type": {
            "description": "Whether the product was a merchandise or service.",
            "enum": ["merchandise", "service"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingDisputeNotReceivedEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_other_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_description": {
            "description": "Description of the merchandise or service that was purchased.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "product_type": {
            "description": "Whether the product was a merchandise or service.",
            "enum": ["merchandise", "service"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingDisputeOtherEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_service_not_as_described_evidence": {
        "description": "",
        "properties": {
          "additional_documentation": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "canceled_at": {
            "description": "Date when order was canceled.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancellation_reason": {
            "description": "Reason for canceling the order.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "explanation": {
            "description": "Explanation of why the cardholder is disputing this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "received_at": {
            "description": "Date when the product was received.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingDisputeServiceNotAsDescribedEvidence",
        "type": "object",
        "x-expandableFields": ["additional_documentation"]
      },
      "issuing_dispute_treasury": {
        "description": "",
        "properties": {
          "debit_reversal": {
            "description": "The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "received_debit": {
            "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["received_debit"],
        "title": "IssuingDisputeTreasury",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_network_token_address": {
        "description": "",
        "properties": {
          "line1": {
            "description": "The street address of the cardholder tokenizing the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "postal_code": {
            "description": "The postal code of the cardholder tokenizing the card.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["line1", "postal_code"],
        "title": "IssuingNetworkTokenAddress",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_network_token_device": {
        "description": "",
        "properties": {
          "device_fingerprint": {
            "description": "An obfuscated ID derived from the device ID.",
            "maxLength": 5000,
            "type": "string"
          },
          "ip_address": {
            "description": "The IP address of the device at provisioning time.",
            "maxLength": 5000,
            "type": "string"
          },
          "location": {
            "description": "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "The name of the device used for tokenization.",
            "maxLength": 5000,
            "type": "string"
          },
          "phone_number": {
            "description": "The phone number of the device used for tokenization.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The type of device used for tokenization.",
            "enum": ["other", "phone", "watch"],
            "type": "string"
          }
        },
        "title": "IssuingNetworkTokenDevice",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_network_token_mastercard": {
        "description": "",
        "properties": {
          "card_reference_id": {
            "description": "A unique reference ID from MasterCard to represent the card account number.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_reference_id": {
            "description": "The network-unique identifier for the token.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_requestor_id": {
            "description": "The ID of the entity requesting tokenization, specific to MasterCard.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_requestor_name": {
            "description": "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["token_reference_id", "token_requestor_id"],
        "title": "IssuingNetworkTokenMastercard",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_network_token_network_data": {
        "description": "",
        "properties": {
          "device": {
            "$ref": "#/components/schemas/issuing_network_token_device"
          },
          "mastercard": {
            "$ref": "#/components/schemas/issuing_network_token_mastercard"
          },
          "type": {
            "description": "The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.",
            "enum": ["mastercard", "visa"],
            "type": "string"
          },
          "visa": {
            "$ref": "#/components/schemas/issuing_network_token_visa"
          },
          "wallet_provider": {
            "$ref": "#/components/schemas/issuing_network_token_wallet_provider"
          }
        },
        "required": ["type"],
        "title": "IssuingNetworkTokenNetworkData",
        "type": "object",
        "x-expandableFields": [
          "device",
          "mastercard",
          "visa",
          "wallet_provider"
        ]
      },
      "issuing_network_token_visa": {
        "description": "",
        "properties": {
          "card_reference_id": {
            "description": "A unique reference ID from Visa to represent the card account number.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_reference_id": {
            "description": "The network-unique identifier for the token.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_requestor_id": {
            "description": "The ID of the entity requesting tokenization, specific to Visa.",
            "maxLength": 5000,
            "type": "string"
          },
          "token_risk_score": {
            "description": "Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "card_reference_id",
          "token_reference_id",
          "token_requestor_id"
        ],
        "title": "IssuingNetworkTokenVisa",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_network_token_wallet_provider": {
        "description": "",
        "properties": {
          "account_id": {
            "description": "The wallet provider-given account ID of the digital wallet the token belongs to.",
            "maxLength": 5000,
            "type": "string"
          },
          "account_trust_score": {
            "description": "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.",
            "type": "integer"
          },
          "card_number_source": {
            "description": "The method used for tokenizing a card.",
            "enum": ["app", "manual", "on_file", "other"],
            "type": "string"
          },
          "cardholder_address": {
            "$ref": "#/components/schemas/issuing_network_token_address"
          },
          "cardholder_name": {
            "description": "The name of the cardholder tokenizing the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "device_trust_score": {
            "description": "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.",
            "type": "integer"
          },
          "hashed_account_email_address": {
            "description": "The hashed email address of the cardholder's account with the wallet provider.",
            "maxLength": 5000,
            "type": "string"
          },
          "reason_codes": {
            "description": "The reasons for suggested tokenization given by the card network.",
            "items": {
              "enum": [
                "account_card_too_new",
                "account_recently_changed",
                "account_too_new",
                "account_too_new_since_launch",
                "additional_device",
                "data_expired",
                "defer_id_v_decision",
                "device_recently_lost",
                "good_activity_history",
                "has_suspended_tokens",
                "high_risk",
                "inactive_account",
                "long_account_tenure",
                "low_account_score",
                "low_device_score",
                "low_phone_number_score",
                "network_service_error",
                "outside_home_territory",
                "provisioning_cardholder_mismatch",
                "provisioning_device_and_cardholder_mismatch",
                "provisioning_device_mismatch",
                "same_device_no_prior_authentication",
                "same_device_successful_prior_authentication",
                "software_update",
                "suspicious_activity",
                "too_many_different_cardholders",
                "too_many_recent_attempts",
                "too_many_recent_tokens"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "suggested_decision": {
            "description": "The recommendation on responding to the tokenization request.",
            "enum": ["approve", "decline", "require_auth"],
            "type": "string"
          },
          "suggested_decision_version": {
            "description": "The version of the standard for mapping reason codes followed by the wallet provider.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "IssuingNetworkTokenWalletProvider",
        "type": "object",
        "x-expandableFields": ["cardholder_address"]
      },
      "issuing_personalization_design_carrier_text": {
        "description": "",
        "properties": {
          "footer_body": {
            "description": "The footer body text of the carrier letter.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "footer_title": {
            "description": "The footer title text of the carrier letter.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "header_body": {
            "description": "The header body text of the carrier letter.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "header_title": {
            "description": "The header title text of the carrier letter.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingPersonalizationDesignCarrierText",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_personalization_design_preferences": {
        "description": "",
        "properties": {
          "is_default": {
            "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.",
            "type": "boolean"
          },
          "is_platform_default": {
            "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "required": ["is_default"],
        "title": "IssuingPersonalizationDesignPreferences",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_personalization_design_rejection_reasons": {
        "description": "",
        "properties": {
          "card_logo": {
            "description": "The reason(s) the card logo was rejected.",
            "items": {
              "enum": [
                "geographic_location",
                "inappropriate",
                "network_name",
                "non_binary_image",
                "non_fiat_currency",
                "other",
                "other_entity",
                "promotional_material"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "carrier_text": {
            "description": "The reason(s) the carrier text was rejected.",
            "items": {
              "enum": [
                "geographic_location",
                "inappropriate",
                "network_name",
                "non_fiat_currency",
                "other",
                "other_entity",
                "promotional_material"
              ],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "IssuingPersonalizationDesignRejectionReasons",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_physical_bundle_features": {
        "description": "",
        "properties": {
          "card_logo": {
            "description": "The policy for how to use card logo images in a card design with this physical bundle.",
            "enum": ["optional", "required", "unsupported"],
            "type": "string"
          },
          "carrier_text": {
            "description": "The policy for how to use carrier letter text in a card design with this physical bundle.",
            "enum": ["optional", "required", "unsupported"],
            "type": "string"
          },
          "second_line": {
            "description": "The policy for how to use a second line on a card with this physical bundle.",
            "enum": ["optional", "required", "unsupported"],
            "type": "string"
          }
        },
        "required": ["card_logo", "carrier_text", "second_line"],
        "title": "IssuingPhysicalBundleFeatures",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_amount_details": {
        "description": "",
        "properties": {
          "atm_fee": {
            "description": "The fee charged by the ATM for the cash withdrawal.",
            "nullable": true,
            "type": "integer"
          },
          "cashback_amount": {
            "description": "The amount of cash requested by the cardholder.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingTransactionAmountDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_fleet_cardholder_prompt_data": {
        "description": "",
        "properties": {
          "driver_id": {
            "description": "Driver ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "odometer": {
            "description": "Odometer reading.",
            "nullable": true,
            "type": "integer"
          },
          "unspecified_id": {
            "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_id": {
            "description": "User ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "vehicle_number": {
            "description": "Vehicle number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFleetCardholderPromptData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_fleet_data": {
        "description": "",
        "properties": {
          "cardholder_prompt_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data"
              }
            ],
            "description": "Answers to prompts presented to cardholder at point of sale.",
            "nullable": true
          },
          "purchase_type": {
            "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reported_breakdown": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown"
              }
            ],
            "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.",
            "nullable": true
          },
          "service_type": {
            "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFleetData",
        "type": "object",
        "x-expandableFields": ["cardholder_prompt_data", "reported_breakdown"]
      },
      "issuing_transaction_fleet_fuel_price_data": {
        "description": "",
        "properties": {
          "gross_amount_decimal": {
            "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFleetFuelPriceData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_fleet_non_fuel_price_data": {
        "description": "",
        "properties": {
          "gross_amount_decimal": {
            "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFleetNonFuelPriceData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_fleet_reported_breakdown": {
        "description": "",
        "properties": {
          "fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data"
              }
            ],
            "description": "Breakdown of fuel portion of the purchase.",
            "nullable": true
          },
          "non_fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data"
              }
            ],
            "description": "Breakdown of non-fuel portion of the purchase.",
            "nullable": true
          },
          "tax": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data"
              }
            ],
            "description": "Information about tax included in this transaction.",
            "nullable": true
          }
        },
        "title": "IssuingTransactionFleetReportedBreakdown",
        "type": "object",
        "x-expandableFields": ["fuel", "non_fuel", "tax"]
      },
      "issuing_transaction_fleet_tax_data": {
        "description": "",
        "properties": {
          "local_amount_decimal": {
            "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "national_amount_decimal": {
            "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFleetTaxData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_flight_data": {
        "description": "",
        "properties": {
          "departure_at": {
            "description": "The time that the flight departed.",
            "nullable": true,
            "type": "integer"
          },
          "passenger_name": {
            "description": "The name of the passenger.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "refundable": {
            "description": "Whether the ticket is refundable.",
            "nullable": true,
            "type": "boolean"
          },
          "segments": {
            "description": "The legs of the trip.",
            "items": {
              "$ref": "#/components/schemas/issuing_transaction_flight_data_leg"
            },
            "nullable": true,
            "type": "array"
          },
          "travel_agency": {
            "description": "The travel agency that issued the ticket.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionFlightData",
        "type": "object",
        "x-expandableFields": ["segments"]
      },
      "issuing_transaction_flight_data_leg": {
        "description": "",
        "properties": {
          "arrival_airport_code": {
            "description": "The three-letter IATA airport code of the flight's destination.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "carrier": {
            "description": "The airline carrier code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "departure_airport_code": {
            "description": "The three-letter IATA airport code that the flight departed from.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "flight_number": {
            "description": "The flight number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "service_class": {
            "description": "The flight's service class.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "stopover_allowed": {
            "description": "Whether a stopover is allowed on this flight.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "IssuingTransactionFlightDataLeg",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_fuel_data": {
        "description": "",
        "properties": {
          "industry_product_code": {
            "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity_decimal": {
            "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
            "maxLength": 5000,
            "type": "string"
          },
          "unit": {
            "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.",
            "maxLength": 5000,
            "type": "string"
          },
          "unit_cost_decimal": {
            "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
            "format": "decimal",
            "type": "string"
          }
        },
        "required": ["type", "unit", "unit_cost_decimal"],
        "title": "IssuingTransactionFuelData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_lodging_data": {
        "description": "",
        "properties": {
          "check_in_at": {
            "description": "The time of checking into the lodging.",
            "nullable": true,
            "type": "integer"
          },
          "nights": {
            "description": "The number of nights stayed at the lodging.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingTransactionLodgingData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_network_data": {
        "description": "",
        "properties": {
          "authorization_code": {
            "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "processing_date": {
            "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionNetworkData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_purchase_details": {
        "description": "",
        "properties": {
          "fleet": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fleet_data"
              }
            ],
            "description": "Fleet-specific information for transactions using Fleet cards.",
            "nullable": true
          },
          "flight": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_flight_data"
              }
            ],
            "description": "Information about the flight that was purchased with this transaction.",
            "nullable": true
          },
          "fuel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_fuel_data"
              }
            ],
            "description": "Information about fuel that was purchased with this transaction.",
            "nullable": true
          },
          "lodging": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/issuing_transaction_lodging_data"
              }
            ],
            "description": "Information about lodging that was purchased with this transaction.",
            "nullable": true
          },
          "receipt": {
            "description": "The line items in the purchase.",
            "items": {
              "$ref": "#/components/schemas/issuing_transaction_receipt_data"
            },
            "nullable": true,
            "type": "array"
          },
          "reference": {
            "description": "A merchant-specific order number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionPurchaseDetails",
        "type": "object",
        "x-expandableFields": ["fleet", "flight", "fuel", "lodging", "receipt"]
      },
      "issuing_transaction_receipt_data": {
        "description": "",
        "properties": {
          "description": {
            "description": "The description of the item. The maximum length of this field is 26 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "description": "The quantity of the item.",
            "nullable": true,
            "type": "number"
          },
          "total": {
            "description": "The total for this line item in cents.",
            "nullable": true,
            "type": "integer"
          },
          "unit_cost": {
            "description": "The unit cost of the item in cents.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "IssuingTransactionReceiptData",
        "type": "object",
        "x-expandableFields": []
      },
      "issuing_transaction_treasury": {
        "description": "",
        "properties": {
          "received_credit": {
            "description": "The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "received_debit": {
            "description": "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "IssuingTransactionTreasury",
        "type": "object",
        "x-expandableFields": []
      },
      "item": {
        "description": "A line item.",
        "properties": {
          "amount_discount": {
            "description": "Total discount amount applied. If no discounts were applied, defaults to 0.",
            "type": "integer"
          },
          "amount_subtotal": {
            "description": "Total before any discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "Total tax amount applied. If no tax was applied, defaults to 0.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total after discounts and taxes.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discounts": {
            "description": "The discounts applied to the line item.",
            "items": {
              "$ref": "#/components/schemas/line_items_discount_amount"
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["item"],
            "type": "string"
          },
          "price": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/price"
              }
            ],
            "description": "The price used to generate the line item.",
            "nullable": true
          },
          "quantity": {
            "description": "The quantity of products being purchased.",
            "nullable": true,
            "type": "integer"
          },
          "taxes": {
            "description": "The taxes applied to the line item.",
            "items": {
              "$ref": "#/components/schemas/line_items_tax_amount"
            },
            "type": "array"
          }
        },
        "required": [
          "amount_discount",
          "amount_subtotal",
          "amount_tax",
          "amount_total",
          "currency",
          "id",
          "object"
        ],
        "title": "LineItem",
        "type": "object",
        "x-expandableFields": ["discounts", "price", "taxes"],
        "x-resourceId": "item"
      },
      "klarna_address": {
        "description": "",
        "properties": {
          "country": {
            "description": "The payer address country",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "klarna_address",
        "type": "object",
        "x-expandableFields": []
      },
      "klarna_payer_details": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/klarna_address"
              }
            ],
            "description": "The payer's address",
            "nullable": true
          }
        },
        "title": "klarna_payer_details",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "legal_entity_company": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "address_kana": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_japan_address"
              }
            ],
            "description": "The Kana variation of the company's primary address (Japan only).",
            "nullable": true
          },
          "address_kanji": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_japan_address"
              }
            ],
            "description": "The Kanji variation of the company's primary address (Japan only).",
            "nullable": true
          },
          "directors_provided": {
            "description": "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).",
            "type": "boolean"
          },
          "directorship_declaration": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_directorship_declaration"
              }
            ],
            "description": "This hash is used to attest that the director information provided to Stripe is both current and correct.",
            "nullable": true
          },
          "executives_provided": {
            "description": "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.",
            "type": "boolean"
          },
          "export_license_id": {
            "description": "The export license ID number of the company, also referred as Import Export Code (India only).",
            "maxLength": 5000,
            "type": "string"
          },
          "export_purpose_code": {
            "description": "The purpose code to use for export transactions (India only).",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "The company's legal name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name_kana": {
            "description": "The Kana variation of the company's legal name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name_kanji": {
            "description": "The Kanji variation of the company's legal name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "owners_provided": {
            "description": "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).",
            "type": "boolean"
          },
          "ownership_declaration": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_ubo_declaration"
              }
            ],
            "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.",
            "nullable": true
          },
          "ownership_exemption_reason": {
            "enum": [
              "qualified_entity_exceeds_ownership_threshold",
              "qualifies_as_financial_institution"
            ],
            "type": "string"
          },
          "phone": {
            "description": "The company's phone number (used for verification).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "structure": {
            "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.",
            "enum": [
              "free_zone_establishment",
              "free_zone_llc",
              "government_instrumentality",
              "governmental_unit",
              "incorporated_non_profit",
              "incorporated_partnership",
              "limited_liability_partnership",
              "llc",
              "multi_member_llc",
              "private_company",
              "private_corporation",
              "private_partnership",
              "public_company",
              "public_corporation",
              "public_partnership",
              "registered_charity",
              "single_member_llc",
              "sole_establishment",
              "sole_proprietorship",
              "tax_exempt_government_instrumentality",
              "unincorporated_association",
              "unincorporated_non_profit",
              "unincorporated_partnership"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "tax_id_provided": {
            "description": "Whether the company's business ID number was provided.",
            "type": "boolean"
          },
          "tax_id_registrar": {
            "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only).",
            "maxLength": 5000,
            "type": "string"
          },
          "vat_id_provided": {
            "description": "Whether the company's business VAT number was provided.",
            "type": "boolean"
          },
          "verification": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_company_verification"
              }
            ],
            "description": "Information on the verification state of the company.",
            "nullable": true
          }
        },
        "title": "LegalEntityCompany",
        "type": "object",
        "x-expandableFields": [
          "address",
          "address_kana",
          "address_kanji",
          "directorship_declaration",
          "ownership_declaration",
          "verification"
        ]
      },
      "legal_entity_company_verification": {
        "description": "",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/legal_entity_company_verification_document"
          }
        },
        "required": ["document"],
        "title": "LegalEntityCompanyVerification",
        "type": "object",
        "x-expandableFields": ["document"]
      },
      "legal_entity_company_verification_document": {
        "description": "",
        "properties": {
          "back": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "details": {
            "description": "A user-displayable string describing the verification state of this document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "details_code": {
            "description": "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "front": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          }
        },
        "title": "LegalEntityCompanyVerificationDocument",
        "type": "object",
        "x-expandableFields": ["back", "front"]
      },
      "legal_entity_directorship_declaration": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the directorship declaration attestation was made.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the directorship declaration attestation was made.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user-agent string from the browser where the directorship declaration attestation was made.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "LegalEntityDirectorshipDeclaration",
        "type": "object",
        "x-expandableFields": []
      },
      "legal_entity_dob": {
        "description": "",
        "properties": {
          "day": {
            "description": "The day of birth, between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "The month of birth, between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year of birth.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "LegalEntityDOB",
        "type": "object",
        "x-expandableFields": []
      },
      "legal_entity_japan_address": {
        "description": "",
        "properties": {
          "city": {
            "description": "City/Ward.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line1": {
            "description": "Block/Building number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line2": {
            "description": "Building details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "postal_code": {
            "description": "ZIP or postal code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "Prefecture.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "town": {
            "description": "Town/cho-me.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "LegalEntityJapanAddress",
        "type": "object",
        "x-expandableFields": []
      },
      "legal_entity_person_verification": {
        "description": "",
        "properties": {
          "additional_document": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_person_verification_document"
              }
            ],
            "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.",
            "nullable": true
          },
          "details": {
            "description": "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\".",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "details_code": {
            "description": "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "document": {
            "$ref": "#/components/schemas/legal_entity_person_verification_document"
          },
          "status": {
            "description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "LegalEntityPersonVerification",
        "type": "object",
        "x-expandableFields": ["additional_document", "document"]
      },
      "legal_entity_person_verification_document": {
        "description": "",
        "properties": {
          "back": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          },
          "details": {
            "description": "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\".",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "details_code": {
            "description": "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "front": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          }
        },
        "title": "LegalEntityPersonVerificationDocument",
        "type": "object",
        "x-expandableFields": ["back", "front"]
      },
      "legal_entity_ubo_declaration": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the beneficial owner attestation was made.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the beneficial owner attestation was made.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user-agent string from the browser where the beneficial owner attestation was made.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "LegalEntityUBODeclaration",
        "type": "object",
        "x-expandableFields": []
      },
      "line_item": {
        "description": "Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).",
        "properties": {
          "amount": {
            "description": "The amount, in cents (or local equivalent).",
            "type": "integer"
          },
          "amount_excluding_tax": {
            "description": "The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.",
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discount_amounts": {
            "description": "The amount of discount calculated per discount for this line item.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_discount_amount"
            },
            "nullable": true,
            "type": "array"
          },
          "discountable": {
            "description": "If true, discounts will apply to this line item. Always false for prorations.",
            "type": "boolean"
          },
          "discounts": {
            "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  }
                ]
              }
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "description": "The ID of the invoice that contains this line item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_item": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoiceitem"
              }
            ],
            "description": "The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoiceitem"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["line_item"],
            "type": "string"
          },
          "period": {
            "$ref": "#/components/schemas/invoice_line_item_period"
          },
          "pretax_credit_amounts": {
            "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.",
            "items": {
              "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount"
            },
            "nullable": true,
            "type": "array"
          },
          "price": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/price"
              }
            ],
            "description": "The price of the line item.",
            "nullable": true
          },
          "proration": {
            "description": "Whether this is a proration.",
            "type": "boolean"
          },
          "proration_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoices_resource_line_items_proration_details"
              }
            ],
            "description": "Additional details for proration line items",
            "nullable": true
          },
          "quantity": {
            "description": "The quantity of the subscription, if the line item is a subscription or a proration.",
            "nullable": true,
            "type": "integer"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "The subscription that the invoice item pertains to, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "subscription_item": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription_item"
              }
            ],
            "description": "The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription_item"
                }
              ]
            }
          },
          "tax_amounts": {
            "description": "The amount of tax calculated per tax rate for this line item",
            "items": {
              "$ref": "#/components/schemas/invoice_tax_amount"
            },
            "type": "array"
          },
          "tax_rates": {
            "description": "The tax rates which apply to the line item.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "type": "array"
          },
          "type": {
            "description": "A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.",
            "enum": ["invoiceitem", "subscription"],
            "type": "string"
          },
          "unit_amount_excluding_tax": {
            "description": "The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "currency",
          "discountable",
          "discounts",
          "id",
          "livemode",
          "metadata",
          "object",
          "period",
          "proration",
          "tax_amounts",
          "tax_rates",
          "type"
        ],
        "title": "InvoiceLineItem",
        "type": "object",
        "x-expandableFields": [
          "discount_amounts",
          "discounts",
          "invoice_item",
          "period",
          "pretax_credit_amounts",
          "price",
          "proration_details",
          "subscription",
          "subscription_item",
          "tax_amounts",
          "tax_rates"
        ],
        "x-resourceId": "line_item"
      },
      "line_items_discount_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount discounted.",
            "type": "integer"
          },
          "discount": {
            "$ref": "#/components/schemas/discount"
          }
        },
        "required": ["amount", "discount"],
        "title": "LineItemsDiscountAmount",
        "type": "object",
        "x-expandableFields": ["discount"]
      },
      "line_items_tax_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount of tax applied for this rate.",
            "type": "integer"
          },
          "rate": {
            "$ref": "#/components/schemas/tax_rate"
          },
          "taxability_reason": {
            "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
            "enum": [
              "customer_exempt",
              "not_collecting",
              "not_subject_to_tax",
              "not_supported",
              "portion_product_exempt",
              "portion_reduced_rated",
              "portion_standard_rated",
              "product_exempt",
              "product_exempt_holiday",
              "proportionally_rated",
              "reduced_rated",
              "reverse_charge",
              "standard_rated",
              "taxable_basis_reduced",
              "zero_rated"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "taxable_amount": {
            "description": "The amount on which tax is calculated, in cents (or local equivalent).",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["amount", "rate"],
        "title": "LineItemsTaxAmount",
        "type": "object",
        "x-expandableFields": ["rate"]
      },
      "linked_account_options_us_bank_account": {
        "description": "",
        "properties": {
          "filters": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters"
          },
          "permissions": {
            "description": "The list of permissions to request. The `payment_method` permission must be included.",
            "items": {
              "enum": [
                "balances",
                "ownership",
                "payment_method",
                "transactions"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "prefetch": {
            "description": "Data features requested to be retrieved upon account creation.",
            "items": {
              "enum": ["balances", "ownership", "transactions"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "return_url": {
            "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "linked_account_options_us_bank_account",
        "type": "object",
        "x-expandableFields": ["filters"]
      },
      "login_link": {
        "description": "Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["login_link"],
            "type": "string"
          },
          "url": {
            "description": "The URL for the login link.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["created", "object", "url"],
        "title": "LoginLink",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "login_link"
      },
      "mandate": {
        "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.",
        "properties": {
          "customer_acceptance": {
            "$ref": "#/components/schemas/customer_acceptance"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "multi_use": {
            "$ref": "#/components/schemas/mandate_multi_use"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["mandate"],
            "type": "string"
          },
          "on_behalf_of": {
            "description": "The account (if any) that the mandate is intended for.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the payment method associated with this mandate.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "payment_method_details": {
            "$ref": "#/components/schemas/mandate_payment_method_details"
          },
          "single_use": {
            "$ref": "#/components/schemas/mandate_single_use"
          },
          "status": {
            "description": "The mandate status indicates whether or not you can use it to initiate a payment.",
            "enum": ["active", "inactive", "pending"],
            "type": "string"
          },
          "type": {
            "description": "The type of the mandate.",
            "enum": ["multi_use", "single_use"],
            "type": "string"
          }
        },
        "required": [
          "customer_acceptance",
          "id",
          "livemode",
          "object",
          "payment_method",
          "payment_method_details",
          "status",
          "type"
        ],
        "title": "Mandate",
        "type": "object",
        "x-expandableFields": [
          "customer_acceptance",
          "multi_use",
          "payment_method",
          "payment_method_details",
          "single_use"
        ],
        "x-resourceId": "mandate"
      },
      "mandate_acss_debit": {
        "description": "",
        "properties": {
          "default_for": {
            "description": "List of Stripe products where this mandate can be selected automatically.",
            "items": {
              "enum": ["invoice", "subscription"],
              "type": "string"
            },
            "type": "array"
          },
          "interval_description": {
            "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_schedule": {
            "description": "Payment schedule for the mandate.",
            "enum": ["combined", "interval", "sporadic"],
            "type": "string"
          },
          "transaction_type": {
            "description": "Transaction type of the mandate.",
            "enum": ["business", "personal"],
            "type": "string"
          }
        },
        "required": ["payment_schedule", "transaction_type"],
        "title": "mandate_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_amazon_pay": {
        "description": "",
        "properties": {},
        "title": "mandate_amazon_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_au_becs_debit": {
        "description": "",
        "properties": {
          "url": {
            "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["url"],
        "title": "mandate_au_becs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_bacs_debit": {
        "description": "",
        "properties": {
          "network_status": {
            "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.",
            "enum": ["accepted", "pending", "refused", "revoked"],
            "type": "string"
          },
          "reference": {
            "description": "The unique reference identifying the mandate on the Bacs network.",
            "maxLength": 5000,
            "type": "string"
          },
          "revocation_reason": {
            "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation.",
            "enum": [
              "account_closed",
              "bank_account_restricted",
              "bank_ownership_changed",
              "could_not_process",
              "debit_not_authorized"
            ],
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The URL that will contain the mandate that the customer has signed.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["network_status", "reference", "url"],
        "title": "mandate_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_cashapp": {
        "description": "",
        "properties": {},
        "title": "mandate_cashapp",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_kakao_pay": {
        "description": "",
        "properties": {},
        "title": "mandate_kakao_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_kr_card": {
        "description": "",
        "properties": {},
        "title": "mandate_kr_card",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_link": {
        "description": "",
        "properties": {},
        "title": "mandate_link",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_multi_use": {
        "description": "",
        "properties": {},
        "title": "mandate_multi_use",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_payment_method_details": {
        "description": "",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/mandate_acss_debit"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/mandate_amazon_pay"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/mandate_au_becs_debit"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/mandate_bacs_debit"
          },
          "card": {
            "$ref": "#/components/schemas/card_mandate_payment_method_details"
          },
          "cashapp": {
            "$ref": "#/components/schemas/mandate_cashapp"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/mandate_kakao_pay"
          },
          "kr_card": {
            "$ref": "#/components/schemas/mandate_kr_card"
          },
          "link": {
            "$ref": "#/components/schemas/mandate_link"
          },
          "paypal": {
            "$ref": "#/components/schemas/mandate_paypal"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/mandate_revolut_pay"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/mandate_sepa_debit"
          },
          "type": {
            "description": "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.",
            "maxLength": 5000,
            "type": "string"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/mandate_us_bank_account"
          }
        },
        "required": ["type"],
        "title": "mandate_payment_method_details",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "card",
          "cashapp",
          "kakao_pay",
          "kr_card",
          "link",
          "paypal",
          "revolut_pay",
          "sepa_debit",
          "us_bank_account"
        ]
      },
      "mandate_paypal": {
        "description": "",
        "properties": {
          "billing_agreement_id": {
            "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_id": {
            "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "mandate_paypal",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_revolut_pay": {
        "description": "",
        "properties": {},
        "title": "mandate_revolut_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_sepa_debit": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The unique reference of the mandate.",
            "maxLength": 5000,
            "type": "string"
          },
          "url": {
            "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["reference", "url"],
        "title": "mandate_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_single_use": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount of the payment on a single use mandate.",
            "type": "integer"
          },
          "currency": {
            "description": "The currency of the payment on a single use mandate.",
            "format": "currency",
            "type": "string"
          }
        },
        "required": ["amount", "currency"],
        "title": "mandate_single_use",
        "type": "object",
        "x-expandableFields": []
      },
      "mandate_us_bank_account": {
        "description": "",
        "properties": {
          "collection_method": {
            "description": "Mandate collection method",
            "enum": ["paper"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "mandate_us_bank_account",
        "type": "object",
        "x-expandableFields": []
      },
      "networks": {
        "description": "",
        "properties": {
          "available": {
            "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "preferred": {
            "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["available"],
        "title": "networks",
        "type": "object",
        "x-expandableFields": []
      },
      "notification_event_data": {
        "description": "",
        "properties": {
          "object": {
            "description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.",
            "type": "object"
          },
          "previous_attributes": {
            "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.",
            "type": "object"
          }
        },
        "required": ["object"],
        "title": "NotificationEventData",
        "type": "object",
        "x-expandableFields": []
      },
      "notification_event_request": {
        "description": "",
        "properties": {
          "id": {
            "description": "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "idempotency_key": {
            "description": "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "NotificationEventRequest",
        "type": "object",
        "x-expandableFields": []
      },
      "offline_acceptance": {
        "description": "",
        "properties": {},
        "title": "offline_acceptance",
        "type": "object",
        "x-expandableFields": []
      },
      "online_acceptance": {
        "description": "",
        "properties": {
          "ip_address": {
            "description": "The customer accepts the mandate from this IP address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The customer accepts the mandate using the user agent of the browser.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "online_acceptance",
        "type": "object",
        "x-expandableFields": []
      },
      "outbound_payments_payment_method_details": {
        "description": "",
        "properties": {
          "billing_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
          },
          "financial_account": {
            "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account"
          },
          "type": {
            "description": "The type of the payment method used in the OutboundPayment.",
            "enum": ["financial_account", "us_bank_account"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"
          }
        },
        "required": ["billing_details", "type"],
        "title": "OutboundPaymentsPaymentMethodDetails",
        "type": "object",
        "x-expandableFields": [
          "billing_details",
          "financial_account",
          "us_bank_account"
        ]
      },
      "outbound_payments_payment_method_details_financial_account": {
        "description": "",
        "properties": {
          "id": {
            "description": "Token of the FinancialAccount.",
            "maxLength": 5000,
            "type": "string"
          },
          "network": {
            "description": "The rails used to send funds.",
            "enum": ["stripe"],
            "type": "string"
          }
        },
        "required": ["id", "network"],
        "title": "outbound_payments_payment_method_details_financial_account",
        "type": "object",
        "x-expandableFields": []
      },
      "outbound_payments_payment_method_details_us_bank_account": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Account holder type: individual or company.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "Account type: checkings or savings. Defaults to checking if omitted.",
            "enum": ["checking", "savings"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the mandate used to make this payment.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "network": {
            "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
            "enum": ["ach", "us_domestic_wire"],
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["network"],
        "title": "outbound_payments_payment_method_details_us_bank_account",
        "type": "object",
        "x-expandableFields": ["mandate"]
      },
      "outbound_transfers_payment_method_details": {
        "description": "",
        "properties": {
          "billing_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
          },
          "financial_account": {
            "$ref": "#/components/schemas/outbound_transfers_payment_method_details_financial_account"
          },
          "type": {
            "description": "The type of the payment method used in the OutboundTransfer.",
            "enum": ["financial_account", "us_bank_account"],
            "type": "string"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"
          }
        },
        "required": ["billing_details", "type"],
        "title": "OutboundTransfersPaymentMethodDetails",
        "type": "object",
        "x-expandableFields": [
          "billing_details",
          "financial_account",
          "us_bank_account"
        ]
      },
      "outbound_transfers_payment_method_details_financial_account": {
        "description": "",
        "properties": {
          "id": {
            "description": "Token of the FinancialAccount.",
            "maxLength": 5000,
            "type": "string"
          },
          "network": {
            "description": "The rails used to send funds.",
            "enum": ["stripe"],
            "type": "string"
          }
        },
        "required": ["id", "network"],
        "title": "outbound_transfers_payment_method_details_financial_account",
        "type": "object",
        "x-expandableFields": []
      },
      "outbound_transfers_payment_method_details_us_bank_account": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Account holder type: individual or company.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "Account type: checkings or savings. Defaults to checking if omitted.",
            "enum": ["checking", "savings"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the mandate used to make this payment.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "network": {
            "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
            "enum": ["ach", "us_domestic_wire"],
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["network"],
        "title": "outbound_transfers_payment_method_details_us_bank_account",
        "type": "object",
        "x-expandableFields": ["mandate"]
      },
      "package_dimensions": {
        "description": "",
        "properties": {
          "height": {
            "description": "Height, in inches.",
            "type": "number"
          },
          "length": {
            "description": "Length, in inches.",
            "type": "number"
          },
          "weight": {
            "description": "Weight, in ounces.",
            "type": "number"
          },
          "width": {
            "description": "Width, in inches.",
            "type": "number"
          }
        },
        "required": ["height", "length", "weight", "width"],
        "title": "PackageDimensions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_amount_details": {
        "description": "",
        "properties": {
          "tip": {
            "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
          }
        },
        "title": "PaymentFlowsAmountDetails",
        "type": "object",
        "x-expandableFields": ["tip"]
      },
      "payment_flows_amount_details_client": {
        "description": "",
        "properties": {
          "tip": {
            "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
          }
        },
        "title": "PaymentFlowsAmountDetailsClient",
        "type": "object",
        "x-expandableFields": ["tip"]
      },
      "payment_flows_amount_details_client_resource_tip": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Portion of the amount that corresponds to a tip.",
            "type": "integer"
          }
        },
        "title": "PaymentFlowsAmountDetailsClientResourceTip",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_automatic_payment_methods_payment_intent": {
        "description": "",
        "properties": {
          "allow_redirects": {
            "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.",
            "enum": ["always", "never"],
            "type": "string"
          },
          "enabled": {
            "description": "Automatically calculates compatible payment methods",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_automatic_payment_methods_setup_intent": {
        "description": "",
        "properties": {
          "allow_redirects": {
            "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.",
            "enum": ["always", "never"],
            "type": "string"
          },
          "enabled": {
            "description": "Automatically calculates compatible payment methods",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_installment_options": {
        "description": "",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "plan": {
            "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
          }
        },
        "required": ["enabled"],
        "title": "PaymentFlowsInstallmentOptions",
        "type": "object",
        "x-expandableFields": ["plan"]
      },
      "payment_flows_private_payment_methods_alipay": {
        "description": "",
        "properties": {},
        "title": "PaymentFlowsPrivatePaymentMethodsAlipay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_alipay_details": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
            "maxLength": 5000,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "Transaction ID of this particular Alipay transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": {
        "description": "",
        "properties": {
          "status": {
            "description": "Indicates whether or not the capture window is extended beyond the standard authorization.",
            "enum": ["disabled", "enabled"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": {
        "description": "",
        "properties": {
          "status": {
            "description": "Indicates whether or not the incremental authorization feature is supported.",
            "enum": ["available", "unavailable"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": {
        "description": "",
        "properties": {
          "maximum_amount_capturable": {
            "description": "The maximum amount that can be captured.",
            "type": "integer"
          },
          "status": {
            "description": "Indicates whether or not the authorized amount can be over-captured.",
            "enum": ["available", "unavailable"],
            "type": "string"
          }
        },
        "required": ["maximum_amount_capturable", "status"],
        "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_card_details_api_resource_multicapture": {
        "description": "",
        "properties": {
          "status": {
            "description": "Indicates whether or not multiple captures are supported.",
            "enum": ["available", "unavailable"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_card_present_common_wallet": {
        "description": "",
        "properties": {
          "type": {
            "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.",
            "enum": ["apple_pay", "google_pay", "samsung_pay", "unknown"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_kakao_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_klarna_dob": {
        "description": "",
        "properties": {
          "day": {
            "description": "The day of birth, between 1 and 31.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "The month of birth, between 1 and 12.",
            "nullable": true,
            "type": "integer"
          },
          "year": {
            "description": "The four-digit year of birth.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_naver_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_payco_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_samsung_pay_payment_method_options": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": {
        "description": "",
        "properties": {
          "account_subcategories": {
            "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.",
            "items": {
              "enum": ["checking", "savings"],
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent": {
        "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)",
        "properties": {
          "amount": {
            "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
            "type": "integer"
          },
          "amount_capturable": {
            "description": "Amount that can be captured from this PaymentIntent.",
            "type": "integer"
          },
          "amount_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_amount_details"
              },
              {
                "$ref": "#/components/schemas/payment_flows_amount_details_client"
              }
            ]
          },
          "amount_received": {
            "description": "Amount that this PaymentIntent collects.",
            "type": "integer"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "ID of the Connect application that created the PaymentIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
            "nullable": true,
            "type": "integer"
          },
          "automatic_payment_methods": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"
              }
            ],
            "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)",
            "nullable": true
          },
          "canceled_at": {
            "description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancellation_reason": {
            "description": "Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).",
            "enum": [
              "abandoned",
              "automatic",
              "duplicate",
              "failed_invoice",
              "fraudulent",
              "requested_by_customer",
              "void_invoice"
            ],
            "nullable": true,
            "type": "string"
          },
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["automatic", "automatic_async", "manual"],
            "type": "string"
          },
          "client_secret": {
            "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "confirmation_method": {
            "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.",
            "enum": ["automatic", "manual"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "ID of the invoice that created this PaymentIntent, if it exists.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "last_payment_error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/api_errors"
              }
            ],
            "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.",
            "nullable": true
          },
          "latest_charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
            "type": "object"
          },
          "next_action": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_next_action"
              }
            ],
            "description": "If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.",
            "nullable": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payment_intent"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the payment method used in this PaymentIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "payment_method_configuration_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
              }
            ],
            "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.",
            "nullable": true
          },
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options"
              }
            ],
            "description": "Payment-method-specific configuration for this PaymentIntent.",
            "nullable": true
          },
          "payment_method_types": {
            "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "processing": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_processing"
              }
            ],
            "description": "If present, this property tells you about the processing state of the payment.",
            "nullable": true
          },
          "receipt_email": {
            "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "review": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/review"
              }
            ],
            "description": "ID of the review associated with this PaymentIntent, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/review"
                }
              ]
            }
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["off_session", "on_session"],
            "nullable": true,
            "type": "string"
          },
          "shipping": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Shipping information for this PaymentIntent.",
            "nullable": true
          },
          "statement_descriptor": {
            "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_suffix": {
            "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).",
            "enum": [
              "canceled",
              "processing",
              "requires_action",
              "requires_capture",
              "requires_confirmation",
              "requires_payment_method",
              "succeeded"
            ],
            "type": "string"
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/transfer_data"
              }
            ],
            "description": "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
            "nullable": true
          },
          "transfer_group": {
            "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "capture_method",
          "confirmation_method",
          "created",
          "currency",
          "id",
          "livemode",
          "object",
          "payment_method_types",
          "status"
        ],
        "title": "PaymentIntent",
        "type": "object",
        "x-expandableFields": [
          "amount_details",
          "application",
          "automatic_payment_methods",
          "customer",
          "invoice",
          "last_payment_error",
          "latest_charge",
          "next_action",
          "on_behalf_of",
          "payment_method",
          "payment_method_configuration_details",
          "payment_method_options",
          "processing",
          "review",
          "shipping",
          "transfer_data"
        ],
        "x-resourceId": "payment_intent"
      },
      "payment_intent_card_processing": {
        "description": "",
        "properties": {
          "customer_notification": {
            "$ref": "#/components/schemas/payment_intent_processing_customer_notification"
          }
        },
        "title": "PaymentIntentCardProcessing",
        "type": "object",
        "x-expandableFields": ["customer_notification"]
      },
      "payment_intent_next_action": {
        "description": "",
        "properties": {
          "alipay_handle_redirect": {
            "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"
          },
          "boleto_display_details": {
            "$ref": "#/components/schemas/payment_intent_next_action_boleto"
          },
          "card_await_notification": {
            "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification"
          },
          "cashapp_handle_redirect_or_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
          },
          "display_bank_transfer_instructions": {
            "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"
          },
          "konbini_display_details": {
            "$ref": "#/components/schemas/payment_intent_next_action_konbini"
          },
          "multibanco_display_details": {
            "$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details"
          },
          "oxxo_display_details": {
            "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details"
          },
          "paynow_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"
          },
          "pix_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code"
          },
          "promptpay_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"
          },
          "redirect_to_url": {
            "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
          },
          "swish_handle_redirect_or_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code"
          },
          "type": {
            "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.",
            "maxLength": 5000,
            "type": "string"
          },
          "use_stripe_sdk": {
            "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.",
            "type": "object"
          },
          "verify_with_microdeposits": {
            "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"
          },
          "wechat_pay_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"
          },
          "wechat_pay_redirect_to_android_app": {
            "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"
          },
          "wechat_pay_redirect_to_ios_app": {
            "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"
          }
        },
        "required": ["type"],
        "title": "PaymentIntentNextAction",
        "type": "object",
        "x-expandableFields": [
          "alipay_handle_redirect",
          "boleto_display_details",
          "card_await_notification",
          "cashapp_handle_redirect_or_display_qr_code",
          "display_bank_transfer_instructions",
          "konbini_display_details",
          "multibanco_display_details",
          "oxxo_display_details",
          "paynow_display_qr_code",
          "pix_display_qr_code",
          "promptpay_display_qr_code",
          "redirect_to_url",
          "swish_handle_redirect_or_display_qr_code",
          "verify_with_microdeposits",
          "wechat_pay_display_qr_code",
          "wechat_pay_redirect_to_android_app",
          "wechat_pay_redirect_to_ios_app"
        ]
      },
      "payment_intent_next_action_alipay_handle_redirect": {
        "description": "",
        "properties": {
          "native_data": {
            "description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "native_url": {
            "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "return_url": {
            "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The URL you must redirect your customer to in order to authenticate the payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentIntentNextActionAlipayHandleRedirect",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_boleto": {
        "description": "",
        "properties": {
          "expires_at": {
            "description": "The timestamp after which the boleto expires.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "hosted_voucher_url": {
            "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "number": {
            "description": "The boleto number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "pdf": {
            "description": "The URL to the downloadable boleto voucher PDF.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_intent_next_action_boleto",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_card_await_notification": {
        "description": "",
        "properties": {
          "charge_attempt_at": {
            "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "customer_approval_required": {
            "description": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "PaymentIntentNextActionCardAwaitNotification",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code": {
        "description": "",
        "properties": {
          "hosted_instructions_url": {
            "description": "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.",
            "maxLength": 5000,
            "type": "string"
          },
          "mobile_auth_url": {
            "description": "The url for mobile redirect based auth",
            "maxLength": 5000,
            "type": "string"
          },
          "qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_cashapp_qr_code"
          }
        },
        "required": ["hosted_instructions_url", "mobile_auth_url", "qr_code"],
        "title": "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode",
        "type": "object",
        "x-expandableFields": ["qr_code"]
      },
      "payment_intent_next_action_cashapp_qr_code": {
        "description": "",
        "properties": {
          "expires_at": {
            "description": "The date (unix timestamp) when the QR code expires.",
            "format": "unix-time",
            "type": "integer"
          },
          "image_url_png": {
            "description": "The image_url_png string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The image_url_svg string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["expires_at", "image_url_png", "image_url_svg"],
        "title": "PaymentIntentNextActionCashappQRCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_display_bank_transfer_instructions": {
        "description": "",
        "properties": {
          "amount_remaining": {
            "description": "The remaining amount that needs to be transferred to complete the payment.",
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "financial_addresses": {
            "description": "A list of financial addresses that can be used to fund the customer balance",
            "items": {
              "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
            },
            "type": "array"
          },
          "hosted_instructions_url": {
            "description": "A link to a hosted page that guides your customer through completing the transfer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "Type of bank transfer",
            "enum": [
              "eu_bank_transfer",
              "gb_bank_transfer",
              "jp_bank_transfer",
              "mx_bank_transfer",
              "us_bank_transfer"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["type"],
        "title": "PaymentIntentNextActionDisplayBankTransferInstructions",
        "type": "object",
        "x-expandableFields": ["financial_addresses"]
      },
      "payment_intent_next_action_display_multibanco_details": {
        "description": "",
        "properties": {
          "entity": {
            "description": "Entity number associated with this Multibanco payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "expires_at": {
            "description": "The timestamp at which the Multibanco voucher expires.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "hosted_voucher_url": {
            "description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "Reference number associated with this Multibanco payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentIntentNextActionDisplayMultibancoDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_display_oxxo_details": {
        "description": "",
        "properties": {
          "expires_after": {
            "description": "The timestamp after which the OXXO voucher expires.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "hosted_voucher_url": {
            "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "number": {
            "description": "OXXO reference number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentIntentNextActionDisplayOxxoDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_konbini": {
        "description": "",
        "properties": {
          "expires_at": {
            "description": "The timestamp at which the pending Konbini payment expires.",
            "format": "unix-time",
            "type": "integer"
          },
          "hosted_voucher_url": {
            "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "stores": {
            "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores"
          }
        },
        "required": ["expires_at", "stores"],
        "title": "payment_intent_next_action_konbini",
        "type": "object",
        "x-expandableFields": ["stores"]
      },
      "payment_intent_next_action_konbini_familymart": {
        "description": "",
        "properties": {
          "confirmation_number": {
            "description": "The confirmation number.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_code": {
            "description": "The payment code.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["payment_code"],
        "title": "payment_intent_next_action_konbini_familymart",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_konbini_lawson": {
        "description": "",
        "properties": {
          "confirmation_number": {
            "description": "The confirmation number.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_code": {
            "description": "The payment code.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["payment_code"],
        "title": "payment_intent_next_action_konbini_lawson",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_konbini_ministop": {
        "description": "",
        "properties": {
          "confirmation_number": {
            "description": "The confirmation number.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_code": {
            "description": "The payment code.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["payment_code"],
        "title": "payment_intent_next_action_konbini_ministop",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_konbini_seicomart": {
        "description": "",
        "properties": {
          "confirmation_number": {
            "description": "The confirmation number.",
            "maxLength": 5000,
            "type": "string"
          },
          "payment_code": {
            "description": "The payment code.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["payment_code"],
        "title": "payment_intent_next_action_konbini_seicomart",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_konbini_stores": {
        "description": "",
        "properties": {
          "familymart": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart"
              }
            ],
            "description": "FamilyMart instruction details.",
            "nullable": true
          },
          "lawson": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson"
              }
            ],
            "description": "Lawson instruction details.",
            "nullable": true
          },
          "ministop": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop"
              }
            ],
            "description": "Ministop instruction details.",
            "nullable": true
          },
          "seicomart": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart"
              }
            ],
            "description": "Seicomart instruction details.",
            "nullable": true
          }
        },
        "title": "payment_intent_next_action_konbini_stores",
        "type": "object",
        "x-expandableFields": ["familymart", "lawson", "ministop", "seicomart"]
      },
      "payment_intent_next_action_paynow_display_qr_code": {
        "description": "",
        "properties": {
          "data": {
            "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_instructions_url": {
            "description": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "image_url_png": {
            "description": "The image_url_png string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The image_url_svg string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["data", "image_url_png", "image_url_svg"],
        "title": "PaymentIntentNextActionPaynowDisplayQrCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_pix_display_qr_code": {
        "description": "",
        "properties": {
          "data": {
            "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
            "maxLength": 5000,
            "type": "string"
          },
          "expires_at": {
            "description": "The date (unix timestamp) when the PIX expires.",
            "type": "integer"
          },
          "hosted_instructions_url": {
            "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_png": {
            "description": "The image_url_png string used to render png QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The image_url_svg string used to render svg QR code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "PaymentIntentNextActionPixDisplayQrCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_promptpay_display_qr_code": {
        "description": "",
        "properties": {
          "data": {
            "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_instructions_url": {
            "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_png": {
            "description": "The PNG path used to render the QR code, can be used as the source in an HTML img tag",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The SVG path used to render the QR code, can be used as the source in an HTML img tag",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "data",
          "hosted_instructions_url",
          "image_url_png",
          "image_url_svg"
        ],
        "title": "PaymentIntentNextActionPromptpayDisplayQrCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_redirect_to_url": {
        "description": "",
        "properties": {
          "return_url": {
            "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The URL you must redirect your customer to in order to authenticate the payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentIntentNextActionRedirectToUrl",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_swish_handle_redirect_or_display_qr_code": {
        "description": "",
        "properties": {
          "hosted_instructions_url": {
            "description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code.",
            "maxLength": 5000,
            "type": "string"
          },
          "qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code"
          }
        },
        "required": ["hosted_instructions_url", "qr_code"],
        "title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode",
        "type": "object",
        "x-expandableFields": ["qr_code"]
      },
      "payment_intent_next_action_swish_qr_code": {
        "description": "",
        "properties": {
          "data": {
            "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_png": {
            "description": "The image_url_png string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The image_url_svg string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["data", "image_url_png", "image_url_svg"],
        "title": "PaymentIntentNextActionSwishQRCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_verify_with_microdeposits": {
        "description": "",
        "properties": {
          "arrival_date": {
            "description": "The timestamp when the microdeposits are expected to land.",
            "format": "unix-time",
            "type": "integer"
          },
          "hosted_verification_url": {
            "description": "The URL for the hosted verification page, which allows customers to verify their bank account.",
            "maxLength": 5000,
            "type": "string"
          },
          "microdeposit_type": {
            "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.",
            "enum": ["amounts", "descriptor_code"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["arrival_date", "hosted_verification_url"],
        "title": "PaymentIntentNextActionVerifyWithMicrodeposits",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_wechat_pay_display_qr_code": {
        "description": "",
        "properties": {
          "data": {
            "description": "The data being used to generate QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_instructions_url": {
            "description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.",
            "maxLength": 5000,
            "type": "string"
          },
          "image_data_url": {
            "description": "The base64 image data for a pre-generated QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_png": {
            "description": "The image_url_png string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          },
          "image_url_svg": {
            "description": "The image_url_svg string used to render QR code",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "data",
          "hosted_instructions_url",
          "image_data_url",
          "image_url_png",
          "image_url_svg"
        ],
        "title": "PaymentIntentNextActionWechatPayDisplayQrCode",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_wechat_pay_redirect_to_android_app": {
        "description": "",
        "properties": {
          "app_id": {
            "description": "app_id is the APP ID registered on WeChat open platform",
            "maxLength": 5000,
            "type": "string"
          },
          "nonce_str": {
            "description": "nonce_str is a random string",
            "maxLength": 5000,
            "type": "string"
          },
          "package": {
            "description": "package is static value",
            "maxLength": 5000,
            "type": "string"
          },
          "partner_id": {
            "description": "an unique merchant ID assigned by WeChat Pay",
            "maxLength": 5000,
            "type": "string"
          },
          "prepay_id": {
            "description": "an unique trading ID assigned by WeChat Pay",
            "maxLength": 5000,
            "type": "string"
          },
          "sign": {
            "description": "A signature",
            "maxLength": 5000,
            "type": "string"
          },
          "timestamp": {
            "description": "Specifies the current time in epoch format",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "app_id",
          "nonce_str",
          "package",
          "partner_id",
          "prepay_id",
          "sign",
          "timestamp"
        ],
        "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_next_action_wechat_pay_redirect_to_ios_app": {
        "description": "",
        "properties": {
          "native_url": {
            "description": "An universal link that redirect to WeChat Pay app",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["native_url"],
        "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options": {
        "description": "",
        "properties": {
          "acss_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "affirm": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_affirm"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "afterpay_clearpay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "alipay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_alipay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "alma": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_alma"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "amazon_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_amazon_pay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "au_becs_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "bacs_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "bancontact": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_bancontact"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "blik": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "boleto": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_boleto"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "card_present": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_card_present"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "cashapp": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_cashapp"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "customer_balance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_customer_balance"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "eps": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "fpx": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_fpx"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "giropay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_giropay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "grabpay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_grabpay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "ideal": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_ideal"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "interac_present": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_interac_present"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "kakao_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "klarna": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_klarna"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "konbini": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_konbini"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "kr_card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_kr_card"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "link": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "mobilepay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "multibanco": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_multibanco"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "naver_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "oxxo": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_oxxo"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "p24": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_p24"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "pay_by_bank": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_pay_by_bank"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "payco": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "paynow": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_paynow"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "paypal": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_paypal"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "pix": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_pix"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "promptpay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_promptpay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "revolut_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_revolut_pay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "samsung_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "sepa_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "sofort": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_sofort"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "swish": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_swish"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "twint": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_twint"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "us_bank_account": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "wechat_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_wechat_pay"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "zip": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_zip"
              },
              {
                "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
              }
            ]
          }
        },
        "title": "PaymentIntentPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "blik",
          "boleto",
          "card",
          "card_present",
          "cashapp",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "interac_present",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "pix",
          "promptpay",
          "revolut_pay",
          "samsung_pay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ]
      },
      "payment_intent_payment_method_options_acss_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_intent_payment_method_options_acss_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "payment_intent_payment_method_options_au_becs_debit": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_au_becs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_bacs_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_bacs_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "payment_intent_payment_method_options_blik": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_intent_payment_method_options_blik",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_card": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "installments": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_card_installments"
              }
            ],
            "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
            "nullable": true
          },
          "mandate_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_options_card_mandate_options"
              }
            ],
            "description": "Configuration options for setting up an eMandate for cards issued in India.",
            "nullable": true
          },
          "network": {
            "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.",
            "enum": [
              "amex",
              "cartes_bancaires",
              "diners",
              "discover",
              "eftpos_au",
              "girocard",
              "interac",
              "jcb",
              "link",
              "mastercard",
              "unionpay",
              "unknown",
              "visa"
            ],
            "nullable": true,
            "type": "string"
          },
          "request_extended_authorization": {
            "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_incremental_authorization": {
            "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_multicapture": {
            "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_overcapture": {
            "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
            "enum": ["if_available", "never"],
            "type": "string"
          },
          "request_three_d_secure": {
            "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
            "enum": ["any", "automatic", "challenge"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "require_cvc_recollection": {
            "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).",
            "type": "boolean"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "statement_descriptor_suffix_kana": {
            "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "statement_descriptor_suffix_kanji": {
            "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_card",
        "type": "object",
        "x-expandableFields": ["installments", "mandate_options"]
      },
      "payment_intent_payment_method_options_eps": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_eps",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_link": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_link",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_mandate_options_acss_debit": {
        "description": "",
        "properties": {
          "custom_mandate_url": {
            "description": "A URL for custom mandate text",
            "maxLength": 5000,
            "type": "string"
          },
          "interval_description": {
            "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_schedule": {
            "description": "Payment schedule for the mandate.",
            "enum": ["combined", "interval", "sporadic"],
            "nullable": true,
            "type": "string"
          },
          "transaction_type": {
            "description": "Transaction type of the mandate.",
            "enum": ["business", "personal"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_mandate_options_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_mandate_options_bacs_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_mandate_options_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_mandate_options_sepa_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_mandate_options_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_mobilepay": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_mobilepay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_sepa_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_sepa_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "payment_intent_payment_method_options_swish": {
        "description": "",
        "properties": {
          "reference": {
            "description": "A reference for this payment to be displayed in the Swish app.",
            "maxLength": 35,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_intent_payment_method_options_swish",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_payment_method_options_us_bank_account": {
        "description": "",
        "properties": {
          "financial_connections": {
            "$ref": "#/components/schemas/linked_account_options_us_bank_account"
          },
          "mandate_options": {
            "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
          },
          "preferred_settlement_speed": {
            "description": "Preferred transaction settlement speed",
            "enum": ["fastest", "standard"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "target_date": {
            "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_intent_payment_method_options_us_bank_account",
        "type": "object",
        "x-expandableFields": ["financial_connections", "mandate_options"]
      },
      "payment_intent_processing": {
        "description": "",
        "properties": {
          "card": {
            "$ref": "#/components/schemas/payment_intent_card_processing"
          },
          "type": {
            "description": "Type of the payment method for which payment is in `processing` state, one of `card`.",
            "enum": ["card"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentIntentProcessing",
        "type": "object",
        "x-expandableFields": ["card"]
      },
      "payment_intent_processing_customer_notification": {
        "description": "",
        "properties": {
          "approval_requested": {
            "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.",
            "nullable": true,
            "type": "boolean"
          },
          "completes_at": {
            "description": "If customer approval is required, they need to provide approval before this time.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PaymentIntentProcessingCustomerNotification",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_intent_type_specific_payment_method_options_client": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual", "manual_preferred"],
            "type": "string"
          },
          "installments": {
            "$ref": "#/components/schemas/payment_flows_installment_options"
          },
          "request_incremental_authorization_support": {
            "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
            "type": "boolean"
          },
          "require_cvc_recollection": {
            "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).",
            "type": "boolean"
          },
          "routing": {
            "$ref": "#/components/schemas/payment_method_options_card_present_routing"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
        "type": "object",
        "x-expandableFields": ["installments", "routing"]
      },
      "payment_link": {
        "description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)",
        "properties": {
          "active": {
            "description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.",
            "type": "boolean"
          },
          "after_completion": {
            "$ref": "#/components/schemas/payment_links_resource_after_completion"
          },
          "allow_promotion_codes": {
            "description": "Whether user redeemable promotion codes are enabled.",
            "type": "boolean"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "The ID of the Connect application that created the Payment Link.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.",
            "nullable": true,
            "type": "integer"
          },
          "application_fee_percent": {
            "description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.",
            "nullable": true,
            "type": "number"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/payment_links_resource_automatic_tax"
          },
          "billing_address_collection": {
            "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.",
            "enum": ["auto", "required"],
            "type": "string"
          },
          "consent_collection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_consent_collection"
              }
            ],
            "description": "When set, provides configuration to gather active consent from customers.",
            "nullable": true
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "custom_fields": {
            "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.",
            "items": {
              "$ref": "#/components/schemas/payment_links_resource_custom_fields"
            },
            "type": "array"
          },
          "custom_text": {
            "$ref": "#/components/schemas/payment_links_resource_custom_text"
          },
          "customer_creation": {
            "description": "Configuration for Customer creation during checkout.",
            "enum": ["always", "if_required"],
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "inactive_message": {
            "description": "The custom message to be displayed to a customer when a payment link is no longer active.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_creation": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_invoice_creation"
              }
            ],
            "description": "Configuration for creating invoice for payment mode payment links.",
            "nullable": true
          },
          "line_items": {
            "description": "The line items representing what is being sold.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "PaymentLinksResourceListLineItems",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payment_link"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "payment_intent_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_payment_intent_data"
              }
            ],
            "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout.",
            "nullable": true
          },
          "payment_method_collection": {
            "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.",
            "enum": ["always", "if_required"],
            "type": "string"
          },
          "payment_method_types": {
            "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
            "items": {
              "enum": [
                "affirm",
                "afterpay_clearpay",
                "alipay",
                "alma",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "blik",
                "boleto",
                "card",
                "cashapp",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "klarna",
                "konbini",
                "link",
                "mobilepay",
                "multibanco",
                "oxxo",
                "p24",
                "pay_by_bank",
                "paynow",
                "paypal",
                "pix",
                "promptpay",
                "sepa_debit",
                "sofort",
                "swish",
                "twint",
                "us_bank_account",
                "wechat_pay",
                "zip"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "phone_number_collection": {
            "$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
          },
          "restrictions": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_restrictions"
              }
            ],
            "description": "Settings that restrict the usage of a payment link.",
            "nullable": true
          },
          "shipping_address_collection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection"
              }
            ],
            "description": "Configuration for collecting the customer's shipping address.",
            "nullable": true
          },
          "shipping_options": {
            "description": "The shipping rate options applied to the session.",
            "items": {
              "$ref": "#/components/schemas/payment_links_resource_shipping_option"
            },
            "type": "array"
          },
          "submit_type": {
            "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.",
            "enum": ["auto", "book", "donate", "pay", "subscribe"],
            "type": "string"
          },
          "subscription_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_subscription_data"
              }
            ],
            "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.",
            "nullable": true
          },
          "tax_id_collection": {
            "$ref": "#/components/schemas/payment_links_resource_tax_id_collection"
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_transfer_data"
              }
            ],
            "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.",
            "nullable": true
          },
          "url": {
            "description": "The public URL that can be shared with customers.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "active",
          "after_completion",
          "allow_promotion_codes",
          "automatic_tax",
          "billing_address_collection",
          "currency",
          "custom_fields",
          "custom_text",
          "customer_creation",
          "id",
          "livemode",
          "metadata",
          "object",
          "payment_method_collection",
          "phone_number_collection",
          "shipping_options",
          "submit_type",
          "tax_id_collection",
          "url"
        ],
        "title": "PaymentLink",
        "type": "object",
        "x-expandableFields": [
          "after_completion",
          "application",
          "automatic_tax",
          "consent_collection",
          "custom_fields",
          "custom_text",
          "invoice_creation",
          "line_items",
          "on_behalf_of",
          "payment_intent_data",
          "phone_number_collection",
          "restrictions",
          "shipping_address_collection",
          "shipping_options",
          "subscription_data",
          "tax_id_collection",
          "transfer_data"
        ],
        "x-resourceId": "payment_link"
      },
      "payment_links_resource_after_completion": {
        "description": "",
        "properties": {
          "hosted_confirmation": {
            "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"
          },
          "redirect": {
            "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect"
          },
          "type": {
            "description": "The specified behavior after the purchase is complete.",
            "enum": ["hosted_confirmation", "redirect"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentLinksResourceAfterCompletion",
        "type": "object",
        "x-expandableFields": ["hosted_confirmation", "redirect"]
      },
      "payment_links_resource_automatic_tax": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "If `true`, tax will be calculated automatically using the customer's location.",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "PaymentLinksResourceAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "payment_links_resource_completed_sessions": {
        "description": "",
        "properties": {
          "count": {
            "description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.",
            "type": "integer"
          },
          "limit": {
            "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.",
            "type": "integer"
          }
        },
        "required": ["count", "limit"],
        "title": "PaymentLinksResourceCompletedSessions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_completion_behavior_confirmation_page": {
        "description": "",
        "properties": {
          "custom_message": {
            "description": "The custom message that is displayed to the customer after the purchase is complete.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_completion_behavior_redirect": {
        "description": "",
        "properties": {
          "url": {
            "description": "The URL the customer will be redirected to after the purchase is complete.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["url"],
        "title": "PaymentLinksResourceCompletionBehaviorRedirect",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_consent_collection": {
        "description": "",
        "properties": {
          "payment_method_reuse_agreement": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement"
              }
            ],
            "description": "Settings related to the payment method reuse text shown in the Checkout UI.",
            "nullable": true
          },
          "promotions": {
            "description": "If set to `auto`, enables the collection of customer consent for promotional communications.",
            "enum": ["auto", "none"],
            "nullable": true,
            "type": "string"
          },
          "terms_of_service": {
            "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.",
            "enum": ["none", "required"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentLinksResourceConsentCollection",
        "type": "object",
        "x-expandableFields": ["payment_method_reuse_agreement"]
      },
      "payment_links_resource_custom_fields": {
        "description": "",
        "properties": {
          "dropdown": {
            "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown"
          },
          "key": {
            "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "label": {
            "$ref": "#/components/schemas/payment_links_resource_custom_fields_label"
          },
          "numeric": {
            "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric"
          },
          "optional": {
            "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
            "type": "boolean"
          },
          "text": {
            "$ref": "#/components/schemas/payment_links_resource_custom_fields_text"
          },
          "type": {
            "description": "The type of the field.",
            "enum": ["dropdown", "numeric", "text"],
            "type": "string"
          }
        },
        "required": ["key", "label", "optional", "type"],
        "title": "PaymentLinksResourceCustomFields",
        "type": "object",
        "x-expandableFields": ["dropdown", "label", "numeric", "text"]
      },
      "payment_links_resource_custom_fields_dropdown": {
        "description": "",
        "properties": {
          "options": {
            "description": "The options available for the customer to select. Up to 200 options allowed.",
            "items": {
              "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown_option"
            },
            "type": "array"
          }
        },
        "required": ["options"],
        "title": "PaymentLinksResourceCustomFieldsDropdown",
        "type": "object",
        "x-expandableFields": ["options"]
      },
      "payment_links_resource_custom_fields_dropdown_option": {
        "description": "",
        "properties": {
          "label": {
            "description": "The label for the option, displayed to the customer. Up to 100 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["label", "value"],
        "title": "PaymentLinksResourceCustomFieldsDropdownOption",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_custom_fields_label": {
        "description": "",
        "properties": {
          "custom": {
            "description": "Custom text for the label, displayed to the customer. Up to 50 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The type of the label.",
            "enum": ["custom"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentLinksResourceCustomFieldsLabel",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_custom_fields_numeric": {
        "description": "",
        "properties": {
          "maximum_length": {
            "description": "The maximum character length constraint for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "minimum_length": {
            "description": "The minimum character length requirement for the customer's input.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PaymentLinksResourceCustomFieldsNumeric",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_custom_fields_text": {
        "description": "",
        "properties": {
          "maximum_length": {
            "description": "The maximum character length constraint for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "minimum_length": {
            "description": "The minimum character length requirement for the customer's input.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PaymentLinksResourceCustomFieldsText",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_custom_text": {
        "description": "",
        "properties": {
          "after_submit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed after the payment confirmation button.",
            "nullable": true
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed alongside shipping address collection.",
            "nullable": true
          },
          "submit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed alongside the payment confirmation button.",
            "nullable": true
          },
          "terms_of_service_acceptance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
            "nullable": true
          }
        },
        "title": "PaymentLinksResourceCustomText",
        "type": "object",
        "x-expandableFields": [
          "after_submit",
          "shipping_address",
          "submit",
          "terms_of_service_acceptance"
        ]
      },
      "payment_links_resource_custom_text_position": {
        "description": "",
        "properties": {
          "message": {
            "description": "Text may be up to 1200 characters in length.",
            "maxLength": 500,
            "type": "string"
          }
        },
        "required": ["message"],
        "title": "PaymentLinksResourceCustomTextPosition",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_invoice_creation": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Enable creating an invoice on successful payment.",
            "type": "boolean"
          },
          "invoice_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_links_resource_invoice_settings"
              }
            ],
            "description": "Configuration for the invoice. Default invoice values will be used if unspecified.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "PaymentLinksResourceInvoiceCreation",
        "type": "object",
        "x-expandableFields": ["invoice_data"]
      },
      "payment_links_resource_invoice_settings": {
        "description": "",
        "properties": {
          "account_tax_ids": {
            "description": "The account tax IDs associated with the invoice.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "custom_fields": {
            "description": "A list of up to 4 custom fields to be displayed on the invoice.",
            "items": {
              "$ref": "#/components/schemas/invoice_setting_custom_field"
            },
            "nullable": true,
            "type": "array"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "footer": {
            "description": "Footer to be displayed on the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
            "nullable": true
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "rendering_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options"
              }
            ],
            "description": "Options for invoice PDF rendering.",
            "nullable": true
          }
        },
        "title": "PaymentLinksResourceInvoiceSettings",
        "type": "object",
        "x-expandableFields": [
          "account_tax_ids",
          "custom_fields",
          "issuer",
          "rendering_options"
        ]
      },
      "payment_links_resource_payment_intent_data": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Indicates when the funds will be captured from the customer's account.",
            "enum": ["automatic", "automatic_async", "manual"],
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.",
            "type": "object"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with the payment method collected during checkout.",
            "enum": ["off_session", "on_session"],
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor_suffix": {
            "description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transfer_group": {
            "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["metadata"],
        "title": "PaymentLinksResourcePaymentIntentData",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_payment_method_reuse_agreement": {
        "description": "",
        "properties": {
          "position": {
            "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
            "enum": ["auto", "hidden"],
            "type": "string"
          }
        },
        "required": ["position"],
        "title": "PaymentLinksResourcePaymentMethodReuseAgreement",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_phone_number_collection": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "If `true`, a phone number will be collected during checkout.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PaymentLinksResourcePhoneNumberCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_restrictions": {
        "description": "",
        "properties": {
          "completed_sessions": {
            "$ref": "#/components/schemas/payment_links_resource_completed_sessions"
          }
        },
        "required": ["completed_sessions"],
        "title": "PaymentLinksResourceRestrictions",
        "type": "object",
        "x-expandableFields": ["completed_sessions"]
      },
      "payment_links_resource_shipping_address_collection": {
        "description": "",
        "properties": {
          "allowed_countries": {
            "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.",
            "items": {
              "enum": [
                "AC",
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CV",
                "CW",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SZ",
                "TA",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VN",
                "VU",
                "WF",
                "WS",
                "XK",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "ZZ"
              ],
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["allowed_countries"],
        "title": "PaymentLinksResourceShippingAddressCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_shipping_option": {
        "description": "",
        "properties": {
          "shipping_amount": {
            "description": "A non-negative integer in cents representing how much to charge.",
            "type": "integer"
          },
          "shipping_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/shipping_rate"
              }
            ],
            "description": "The ID of the Shipping Rate to use for this shipping option.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              ]
            }
          }
        },
        "required": ["shipping_amount", "shipping_rate"],
        "title": "PaymentLinksResourceShippingOption",
        "type": "object",
        "x-expandableFields": ["shipping_rate"]
      },
      "payment_links_resource_subscription_data": {
        "description": "",
        "properties": {
          "description": {
            "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_settings": {
            "$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.",
            "type": "object"
          },
          "trial_period_days": {
            "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
            "nullable": true,
            "type": "integer"
          },
          "trial_settings": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings"
              }
            ],
            "description": "Settings related to subscription trials.",
            "nullable": true
          }
        },
        "required": ["invoice_settings", "metadata"],
        "title": "PaymentLinksResourceSubscriptionData",
        "type": "object",
        "x-expandableFields": ["invoice_settings", "trial_settings"]
      },
      "payment_links_resource_subscription_data_invoice_settings": {
        "description": "",
        "properties": {
          "issuer": {
            "$ref": "#/components/schemas/connect_account_reference"
          }
        },
        "required": ["issuer"],
        "title": "PaymentLinksResourceSubscriptionDataInvoiceSettings",
        "type": "object",
        "x-expandableFields": ["issuer"]
      },
      "payment_links_resource_tax_id_collection": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates whether tax ID collection is enabled for the session.",
            "type": "boolean"
          },
          "required": {
            "enum": ["if_supported", "never"],
            "type": "string"
          }
        },
        "required": ["enabled", "required"],
        "title": "PaymentLinksResourceTaxIdCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_links_resource_transfer_data": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
            "nullable": true,
            "type": "integer"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The connected account receiving the transfer.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "PaymentLinksResourceTransferData",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "payment_method": {
        "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/payment_method_acss_debit"
          },
          "affirm": {
            "$ref": "#/components/schemas/payment_method_affirm"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
          },
          "alipay": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
          },
          "allow_redisplay": {
            "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.",
            "enum": ["always", "limited", "unspecified"],
            "type": "string"
          },
          "alma": {
            "$ref": "#/components/schemas/payment_method_alma"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/payment_method_amazon_pay"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/payment_method_au_becs_debit"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/payment_method_bacs_debit"
          },
          "bancontact": {
            "$ref": "#/components/schemas/payment_method_bancontact"
          },
          "billing_details": {
            "$ref": "#/components/schemas/billing_details"
          },
          "blik": {
            "$ref": "#/components/schemas/payment_method_blik"
          },
          "boleto": {
            "$ref": "#/components/schemas/payment_method_boleto"
          },
          "card": {
            "$ref": "#/components/schemas/payment_method_card"
          },
          "card_present": {
            "$ref": "#/components/schemas/payment_method_card_present"
          },
          "cashapp": {
            "$ref": "#/components/schemas/payment_method_cashapp"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "customer_balance": {
            "$ref": "#/components/schemas/payment_method_customer_balance"
          },
          "eps": {
            "$ref": "#/components/schemas/payment_method_eps"
          },
          "fpx": {
            "$ref": "#/components/schemas/payment_method_fpx"
          },
          "giropay": {
            "$ref": "#/components/schemas/payment_method_giropay"
          },
          "grabpay": {
            "$ref": "#/components/schemas/payment_method_grabpay"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "ideal": {
            "$ref": "#/components/schemas/payment_method_ideal"
          },
          "interac_present": {
            "$ref": "#/components/schemas/payment_method_interac_present"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/payment_method_kakao_pay"
          },
          "klarna": {
            "$ref": "#/components/schemas/payment_method_klarna"
          },
          "konbini": {
            "$ref": "#/components/schemas/payment_method_konbini"
          },
          "kr_card": {
            "$ref": "#/components/schemas/payment_method_kr_card"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_link"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "mobilepay": {
            "$ref": "#/components/schemas/payment_method_mobilepay"
          },
          "multibanco": {
            "$ref": "#/components/schemas/payment_method_multibanco"
          },
          "naver_pay": {
            "$ref": "#/components/schemas/payment_method_naver_pay"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payment_method"],
            "type": "string"
          },
          "oxxo": {
            "$ref": "#/components/schemas/payment_method_oxxo"
          },
          "p24": {
            "$ref": "#/components/schemas/payment_method_p24"
          },
          "pay_by_bank": {
            "$ref": "#/components/schemas/payment_method_pay_by_bank"
          },
          "payco": {
            "$ref": "#/components/schemas/payment_method_payco"
          },
          "paynow": {
            "$ref": "#/components/schemas/payment_method_paynow"
          },
          "paypal": {
            "$ref": "#/components/schemas/payment_method_paypal"
          },
          "pix": {
            "$ref": "#/components/schemas/payment_method_pix"
          },
          "promptpay": {
            "$ref": "#/components/schemas/payment_method_promptpay"
          },
          "radar_options": {
            "$ref": "#/components/schemas/radar_radar_options"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/payment_method_revolut_pay"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/payment_method_samsung_pay"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/payment_method_sepa_debit"
          },
          "sofort": {
            "$ref": "#/components/schemas/payment_method_sofort"
          },
          "swish": {
            "$ref": "#/components/schemas/payment_method_swish"
          },
          "twint": {
            "$ref": "#/components/schemas/payment_method_twint"
          },
          "type": {
            "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
            "enum": [
              "acss_debit",
              "affirm",
              "afterpay_clearpay",
              "alipay",
              "alma",
              "amazon_pay",
              "au_becs_debit",
              "bacs_debit",
              "bancontact",
              "blik",
              "boleto",
              "card",
              "card_present",
              "cashapp",
              "customer_balance",
              "eps",
              "fpx",
              "giropay",
              "grabpay",
              "ideal",
              "interac_present",
              "kakao_pay",
              "klarna",
              "konbini",
              "kr_card",
              "link",
              "mobilepay",
              "multibanco",
              "naver_pay",
              "oxxo",
              "p24",
              "pay_by_bank",
              "payco",
              "paynow",
              "paypal",
              "pix",
              "promptpay",
              "revolut_pay",
              "samsung_pay",
              "sepa_debit",
              "sofort",
              "swish",
              "twint",
              "us_bank_account",
              "wechat_pay",
              "zip"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/payment_method_us_bank_account"
          },
          "wechat_pay": {
            "$ref": "#/components/schemas/payment_method_wechat_pay"
          },
          "zip": {
            "$ref": "#/components/schemas/payment_method_zip"
          }
        },
        "required": [
          "billing_details",
          "created",
          "id",
          "livemode",
          "object",
          "type"
        ],
        "title": "PaymentMethod",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "billing_details",
          "blik",
          "boleto",
          "card",
          "card_present",
          "cashapp",
          "customer",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "interac_present",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "pix",
          "promptpay",
          "radar_options",
          "revolut_pay",
          "samsung_pay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ],
        "x-resourceId": "payment_method"
      },
      "payment_method_acss_debit": {
        "description": "",
        "properties": {
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "institution_number": {
            "description": "Institution number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transit_number": {
            "description": "Transit number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_affirm": {
        "description": "",
        "properties": {},
        "title": "payment_method_affirm",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_afterpay_clearpay": {
        "description": "",
        "properties": {},
        "title": "payment_method_afterpay_clearpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_alma": {
        "description": "",
        "properties": {},
        "title": "payment_method_alma",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_amazon_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_amazon_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_au_becs_debit": {
        "description": "",
        "properties": {
          "bsb_number": {
            "description": "Six-digit number identifying bank and branch associated with this bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_au_becs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_bacs_debit": {
        "description": "",
        "properties": {
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sort_code": {
            "description": "Sort code of the bank account. (e.g., `10-20-30`)",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_bancontact": {
        "description": "",
        "properties": {},
        "title": "payment_method_bancontact",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_blik": {
        "description": "",
        "properties": {},
        "title": "payment_method_blik",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_boleto": {
        "description": "",
        "properties": {
          "tax_id": {
            "description": "Uniquely identifies the customer tax id (CNPJ or CPF)",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["tax_id"],
        "title": "payment_method_boleto",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "checks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_card_checks"
              }
            ],
            "description": "Checks on Card address and CVC if provided.",
            "nullable": true
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "display_brand": {
            "description": "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "generated_from": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_card_generated_card"
              }
            ],
            "description": "Details of the original PaymentMethod that created this object.",
            "nullable": true
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "type": "string"
          },
          "networks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/networks"
              }
            ],
            "description": "Contains information about card networks that can be used to process the payment.",
            "nullable": true
          },
          "regulated_status": {
            "description": "Status of a card based on the card issuer.",
            "enum": ["regulated", "unregulated"],
            "nullable": true,
            "type": "string"
          },
          "three_d_secure_usage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/three_d_secure_usage"
              }
            ],
            "description": "Contains details on how this Card may be used for 3D Secure authentication.",
            "nullable": true
          },
          "wallet": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_card_wallet"
              }
            ],
            "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
            "nullable": true
          }
        },
        "required": ["brand", "exp_month", "exp_year", "funding", "last4"],
        "title": "payment_method_card",
        "type": "object",
        "x-expandableFields": [
          "checks",
          "generated_from",
          "networks",
          "three_d_secure_usage",
          "wallet"
        ]
      },
      "payment_method_card_checks": {
        "description": "",
        "properties": {
          "address_line1_check": {
            "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_postal_code_check": {
            "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cvc_check": {
            "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_card_checks",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_generated_card": {
        "description": "",
        "properties": {
          "charge": {
            "description": "The charge that created this object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_method_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/card_generated_from_payment_method_details"
              }
            ],
            "description": "Transaction-specific details of the payment method used in the payment.",
            "nullable": true
          },
          "setup_attempt": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_attempt"
              }
            ],
            "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_attempt"
                }
              ]
            }
          }
        },
        "title": "payment_method_card_generated_card",
        "type": "object",
        "x-expandableFields": ["payment_method_details", "setup_attempt"]
      },
      "payment_method_card_present": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "brand_product": {
            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cardholder_name": {
            "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "A high-level description of the type of cards issued in this range.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "description": "The name of the card's issuing bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "networks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_card_present_networks"
              }
            ],
            "description": "Contains information about card networks that can be used to process the payment.",
            "nullable": true
          },
          "offline": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_present_offline"
              }
            ],
            "description": "Details about payment methods collected offline.",
            "nullable": true
          },
          "preferred_locales": {
            "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "read_method": {
            "description": "How card details were read in this transaction.",
            "enum": [
              "contact_emv",
              "contactless_emv",
              "contactless_magstripe_mode",
              "magnetic_stripe_fallback",
              "magnetic_stripe_track2"
            ],
            "nullable": true,
            "type": "string"
          },
          "wallet": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
          }
        },
        "required": ["exp_month", "exp_year"],
        "title": "payment_method_card_present",
        "type": "object",
        "x-expandableFields": ["networks", "offline", "wallet"]
      },
      "payment_method_card_present_networks": {
        "description": "",
        "properties": {
          "available": {
            "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "preferred": {
            "description": "The preferred network for the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["available"],
        "title": "payment_method_card_present_networks",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet": {
        "description": "",
        "properties": {
          "amex_express_checkout": {
            "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
          },
          "apple_pay": {
            "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
          },
          "dynamic_last4": {
            "description": "(For tokenized numbers only.) The last four digits of the device account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "google_pay": {
            "$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_card_wallet_link"
          },
          "masterpass": {
            "$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
          },
          "type": {
            "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
            "enum": [
              "amex_express_checkout",
              "apple_pay",
              "google_pay",
              "link",
              "masterpass",
              "samsung_pay",
              "visa_checkout"
            ],
            "type": "string"
          },
          "visa_checkout": {
            "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
          }
        },
        "required": ["type"],
        "title": "payment_method_card_wallet",
        "type": "object",
        "x-expandableFields": [
          "amex_express_checkout",
          "apple_pay",
          "google_pay",
          "link",
          "masterpass",
          "samsung_pay",
          "visa_checkout"
        ]
      },
      "payment_method_card_wallet_amex_express_checkout": {
        "description": "",
        "properties": {},
        "title": "payment_method_card_wallet_amex_express_checkout",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet_apple_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_card_wallet_apple_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet_google_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_card_wallet_google_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet_link": {
        "description": "",
        "properties": {},
        "title": "payment_method_card_wallet_link",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet_masterpass": {
        "description": "",
        "properties": {
          "billing_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          },
          "email": {
            "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          }
        },
        "title": "payment_method_card_wallet_masterpass",
        "type": "object",
        "x-expandableFields": ["billing_address", "shipping_address"]
      },
      "payment_method_card_wallet_samsung_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_card_wallet_samsung_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_card_wallet_visa_checkout": {
        "description": "",
        "properties": {
          "billing_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          },
          "email": {
            "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          }
        },
        "title": "payment_method_card_wallet_visa_checkout",
        "type": "object",
        "x-expandableFields": ["billing_address", "shipping_address"]
      },
      "payment_method_cashapp": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique and immutable identifier assigned by Cash App to every buyer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cashtag": {
            "description": "A public identifier for buyers using Cash App.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_cashapp",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_config_biz_payment_method_configuration_details": {
        "description": "",
        "properties": {
          "id": {
            "description": "ID of the payment method configuration used.",
            "maxLength": 5000,
            "type": "string"
          },
          "parent": {
            "description": "ID of the parent payment method configuration used.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["id"],
        "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_config_resource_display_preference": {
        "description": "",
        "properties": {
          "overridable": {
            "description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.",
            "nullable": true,
            "type": "boolean"
          },
          "preference": {
            "description": "The account's display preference.",
            "enum": ["none", "off", "on"],
            "type": "string"
          },
          "value": {
            "description": "The effective display preference value.",
            "enum": ["off", "on"],
            "type": "string"
          }
        },
        "required": ["preference", "value"],
        "title": "PaymentMethodConfigResourceDisplayPreference",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_config_resource_payment_method_properties": {
        "description": "",
        "properties": {
          "available": {
            "description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.",
            "type": "boolean"
          },
          "display_preference": {
            "$ref": "#/components/schemas/payment_method_config_resource_display_preference"
          }
        },
        "required": ["available", "display_preference"],
        "title": "PaymentMethodConfigResourcePaymentMethodProperties",
        "type": "object",
        "x-expandableFields": ["display_preference"]
      },
      "payment_method_configuration": {
        "description": "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "active": {
            "description": "Whether the configuration can be used for new payments.",
            "type": "boolean"
          },
          "affirm": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "alipay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "alma": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "apple_pay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "application": {
            "description": "For child configs, the Connect application associated with the configuration.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "bancontact": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "blik": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "boleto": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "card": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "cartes_bancaires": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "cashapp": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "customer_balance": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "eps": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "fpx": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "giropay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "google_pay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "grabpay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "ideal": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "is_default": {
            "description": "The default configuration is used whenever a payment method configuration is not specified.",
            "type": "boolean"
          },
          "jcb": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "klarna": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "konbini": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "mobilepay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "multibanco": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "name": {
            "description": "The configuration's name.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payment_method_configuration"],
            "type": "string"
          },
          "oxxo": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "p24": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "parent": {
            "description": "For child configs, the configuration's parent configuration.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "pay_by_bank": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "paynow": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "paypal": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "promptpay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "sofort": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "swish": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "twint": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "wechat_pay": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          },
          "zip": {
            "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
          }
        },
        "required": [
          "active",
          "id",
          "is_default",
          "livemode",
          "name",
          "object"
        ],
        "title": "PaymentMethodConfigResourcePaymentMethodConfiguration",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "apple_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "blik",
          "boleto",
          "card",
          "cartes_bancaires",
          "cashapp",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "google_pay",
          "grabpay",
          "ideal",
          "jcb",
          "klarna",
          "konbini",
          "link",
          "mobilepay",
          "multibanco",
          "oxxo",
          "p24",
          "pay_by_bank",
          "paynow",
          "paypal",
          "promptpay",
          "revolut_pay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ],
        "x-resourceId": "payment_method_configuration"
      },
      "payment_method_customer_balance": {
        "description": "",
        "properties": {},
        "title": "payment_method_customer_balance",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details": {
        "description": "",
        "properties": {
          "ach_credit_transfer": {
            "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
          },
          "ach_debit": {
            "$ref": "#/components/schemas/payment_method_details_ach_debit"
          },
          "acss_debit": {
            "$ref": "#/components/schemas/payment_method_details_acss_debit"
          },
          "affirm": {
            "$ref": "#/components/schemas/payment_method_details_affirm"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay"
          },
          "alipay": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
          },
          "alma": {
            "$ref": "#/components/schemas/payment_method_details_alma"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/payment_method_details_amazon_pay"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/payment_method_details_au_becs_debit"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/payment_method_details_bacs_debit"
          },
          "bancontact": {
            "$ref": "#/components/schemas/payment_method_details_bancontact"
          },
          "blik": {
            "$ref": "#/components/schemas/payment_method_details_blik"
          },
          "boleto": {
            "$ref": "#/components/schemas/payment_method_details_boleto"
          },
          "card": {
            "$ref": "#/components/schemas/payment_method_details_card"
          },
          "card_present": {
            "$ref": "#/components/schemas/payment_method_details_card_present"
          },
          "cashapp": {
            "$ref": "#/components/schemas/payment_method_details_cashapp"
          },
          "customer_balance": {
            "$ref": "#/components/schemas/payment_method_details_customer_balance"
          },
          "eps": {
            "$ref": "#/components/schemas/payment_method_details_eps"
          },
          "fpx": {
            "$ref": "#/components/schemas/payment_method_details_fpx"
          },
          "giropay": {
            "$ref": "#/components/schemas/payment_method_details_giropay"
          },
          "grabpay": {
            "$ref": "#/components/schemas/payment_method_details_grabpay"
          },
          "ideal": {
            "$ref": "#/components/schemas/payment_method_details_ideal"
          },
          "interac_present": {
            "$ref": "#/components/schemas/payment_method_details_interac_present"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/payment_method_details_kakao_pay"
          },
          "klarna": {
            "$ref": "#/components/schemas/payment_method_details_klarna"
          },
          "konbini": {
            "$ref": "#/components/schemas/payment_method_details_konbini"
          },
          "kr_card": {
            "$ref": "#/components/schemas/payment_method_details_kr_card"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_details_link"
          },
          "mobilepay": {
            "$ref": "#/components/schemas/payment_method_details_mobilepay"
          },
          "multibanco": {
            "$ref": "#/components/schemas/payment_method_details_multibanco"
          },
          "naver_pay": {
            "$ref": "#/components/schemas/payment_method_details_naver_pay"
          },
          "oxxo": {
            "$ref": "#/components/schemas/payment_method_details_oxxo"
          },
          "p24": {
            "$ref": "#/components/schemas/payment_method_details_p24"
          },
          "pay_by_bank": {
            "$ref": "#/components/schemas/payment_method_details_pay_by_bank"
          },
          "payco": {
            "$ref": "#/components/schemas/payment_method_details_payco"
          },
          "paynow": {
            "$ref": "#/components/schemas/payment_method_details_paynow"
          },
          "paypal": {
            "$ref": "#/components/schemas/payment_method_details_paypal"
          },
          "pix": {
            "$ref": "#/components/schemas/payment_method_details_pix"
          },
          "promptpay": {
            "$ref": "#/components/schemas/payment_method_details_promptpay"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/payment_method_details_revolut_pay"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/payment_method_details_samsung_pay"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/payment_method_details_sepa_debit"
          },
          "sofort": {
            "$ref": "#/components/schemas/payment_method_details_sofort"
          },
          "stripe_account": {
            "$ref": "#/components/schemas/payment_method_details_stripe_account"
          },
          "swish": {
            "$ref": "#/components/schemas/payment_method_details_swish"
          },
          "twint": {
            "$ref": "#/components/schemas/payment_method_details_twint"
          },
          "type": {
            "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.",
            "maxLength": 5000,
            "type": "string"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/payment_method_details_us_bank_account"
          },
          "wechat": {
            "$ref": "#/components/schemas/payment_method_details_wechat"
          },
          "wechat_pay": {
            "$ref": "#/components/schemas/payment_method_details_wechat_pay"
          },
          "zip": {
            "$ref": "#/components/schemas/payment_method_details_zip"
          }
        },
        "required": ["type"],
        "title": "payment_method_details",
        "type": "object",
        "x-expandableFields": [
          "ach_credit_transfer",
          "ach_debit",
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "blik",
          "boleto",
          "card",
          "card_present",
          "cashapp",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "interac_present",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "pix",
          "promptpay",
          "revolut_pay",
          "samsung_pay",
          "sepa_debit",
          "sofort",
          "stripe_account",
          "swish",
          "twint",
          "us_bank_account",
          "wechat",
          "wechat_pay",
          "zip"
        ]
      },
      "payment_method_details_ach_credit_transfer": {
        "description": "",
        "properties": {
          "account_number": {
            "description": "Account number to transfer funds to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the routing number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "description": "Routing transit number for the bank account to transfer funds to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "swift_code": {
            "description": "SWIFT code of the bank associated with the routing number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_ach_credit_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_ach_debit": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Type of entity that holds the account. This can be either `individual` or `company`.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "description": "Routing transit number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_ach_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_acss_debit": {
        "description": "",
        "properties": {
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "institution_number": {
            "description": "Institution number of the bank account",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "description": "ID of the mandate used to make this payment.",
            "maxLength": 5000,
            "type": "string"
          },
          "transit_number": {
            "description": "Transit number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_affirm": {
        "description": "",
        "properties": {
          "transaction_id": {
            "description": "The Affirm transaction ID associated with this payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_affirm",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_afterpay_clearpay": {
        "description": "",
        "properties": {
          "order_id": {
            "description": "The Afterpay order ID associated with this payment intent.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "Order identifier shown to the merchant in Afterpay’s online portal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_afterpay_clearpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_alma": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_alma",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_amazon_pay": {
        "description": "",
        "properties": {
          "funding": {
            "$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details"
          }
        },
        "title": "payment_method_details_amazon_pay",
        "type": "object",
        "x-expandableFields": ["funding"]
      },
      "payment_method_details_au_becs_debit": {
        "description": "",
        "properties": {
          "bsb_number": {
            "description": "Bank-State-Branch number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "description": "ID of the mandate used to make this payment.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "payment_method_details_au_becs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_bacs_debit": {
        "description": "",
        "properties": {
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "description": "ID of the mandate used to make this payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "sort_code": {
            "description": "Sort code of the bank account. (e.g., `10-20-30`)",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_bancontact": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "Bank Identifier Code of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`",
            "enum": ["de", "en", "fr", "nl"],
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_bancontact",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "payment_method_details_blik": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique and immutable identifier assigned by BLIK to every buyer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_blik",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_boleto": {
        "description": "",
        "properties": {
          "tax_id": {
            "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["tax_id"],
        "title": "payment_method_details_boleto",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card": {
        "description": "",
        "properties": {
          "amount_authorized": {
            "description": "The authorized amount.",
            "nullable": true,
            "type": "integer"
          },
          "authorization_code": {
            "description": "Authorization code on the charge.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "capture_before": {
            "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.",
            "format": "unix-time",
            "type": "integer"
          },
          "checks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_checks"
              }
            ],
            "description": "Check results by Card networks on Card address and CVC at time of payment.",
            "nullable": true
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "extended_authorization": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "incremental_authorization": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"
          },
          "installments": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_installments"
              }
            ],
            "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
            "nullable": true
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "description": "ID of the mandate used to make this payment or created by it.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "multicapture": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture"
          },
          "network": {
            "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_token": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_network_token"
              }
            ],
            "description": "If this card has network token credentials, this contains the details of the network token credentials.",
            "nullable": true
          },
          "network_transaction_id": {
            "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "overcapture": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"
          },
          "regulated_status": {
            "description": "Status of a card based on the card issuer.",
            "enum": ["regulated", "unregulated"],
            "nullable": true,
            "type": "string"
          },
          "three_d_secure": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/three_d_secure_details_charge"
              }
            ],
            "description": "Populated if this transaction used 3D Secure authentication.",
            "nullable": true
          },
          "wallet": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_wallet"
              }
            ],
            "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
            "nullable": true
          }
        },
        "required": ["exp_month", "exp_year"],
        "title": "payment_method_details_card",
        "type": "object",
        "x-expandableFields": [
          "checks",
          "extended_authorization",
          "incremental_authorization",
          "installments",
          "multicapture",
          "network_token",
          "overcapture",
          "three_d_secure",
          "wallet"
        ]
      },
      "payment_method_details_card_checks": {
        "description": "",
        "properties": {
          "address_line1_check": {
            "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_postal_code_check": {
            "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cvc_check": {
            "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_card_checks",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_installments": {
        "description": "",
        "properties": {
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
              }
            ],
            "description": "Installment plan selected for the payment.",
            "nullable": true
          }
        },
        "title": "payment_method_details_card_installments",
        "type": "object",
        "x-expandableFields": ["plan"]
      },
      "payment_method_details_card_installments_plan": {
        "description": "",
        "properties": {
          "count": {
            "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
            "nullable": true,
            "type": "integer"
          },
          "interval": {
            "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
            "enum": ["month"],
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "Type of installment plan, one of `fixed_count`.",
            "enum": ["fixed_count"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["type"],
        "title": "payment_method_details_card_installments_plan",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_network_token": {
        "description": "",
        "properties": {
          "used": {
            "description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.",
            "type": "boolean"
          }
        },
        "required": ["used"],
        "title": "payment_method_details_card_network_token",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_present": {
        "description": "",
        "properties": {
          "amount_authorized": {
            "description": "The authorized amount",
            "nullable": true,
            "type": "integer"
          },
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "brand_product": {
            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "capture_before": {
            "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.",
            "format": "unix-time",
            "type": "integer"
          },
          "cardholder_name": {
            "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "A high-level description of the type of cards issued in this range.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "emv_auth_data": {
            "description": "Authorization response cryptogram.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_card": {
            "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "incremental_authorization_supported": {
            "description": "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).",
            "type": "boolean"
          },
          "issuer": {
            "description": "The name of the card's issuing bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network": {
            "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_transaction_id": {
            "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "offline": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_present_offline"
              }
            ],
            "description": "Details about payments collected offline.",
            "nullable": true
          },
          "overcapture_supported": {
            "description": "Defines whether the authorized amount can be over-captured or not",
            "type": "boolean"
          },
          "preferred_locales": {
            "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "read_method": {
            "description": "How card details were read in this transaction.",
            "enum": [
              "contact_emv",
              "contactless_emv",
              "contactless_magstripe_mode",
              "magnetic_stripe_fallback",
              "magnetic_stripe_track2"
            ],
            "nullable": true,
            "type": "string"
          },
          "receipt": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_present_receipt"
              }
            ],
            "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
            "nullable": true
          },
          "wallet": {
            "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
          }
        },
        "required": [
          "exp_month",
          "exp_year",
          "incremental_authorization_supported",
          "overcapture_supported"
        ],
        "title": "payment_method_details_card_present",
        "type": "object",
        "x-expandableFields": ["offline", "receipt", "wallet"]
      },
      "payment_method_details_card_present_offline": {
        "description": "",
        "properties": {
          "stored_at": {
            "description": "Time at which the payment was collected while offline",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "type": {
            "description": "The method used to process this payment method offline. Only deferred is allowed.",
            "enum": ["deferred"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_card_present_offline",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_present_receipt": {
        "description": "",
        "properties": {
          "account_type": {
            "description": "The type of account being debited or credited",
            "enum": ["checking", "credit", "prepaid", "unknown"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "application_cryptogram": {
            "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "application_preferred_name": {
            "description": "Mnenomic of the Application Identifier.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "authorization_code": {
            "description": "Identifier for this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "authorization_response_code": {
            "description": "EMV tag 8A. A code returned by the card issuer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cardholder_verification_method": {
            "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "dedicated_file_name": {
            "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "terminal_verification_results": {
            "description": "The outcome of a series of EMV functions performed by the card reader.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_status_information": {
            "description": "An indication of various EMV functions performed during the transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_card_present_receipt",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet": {
        "description": "",
        "properties": {
          "amex_express_checkout": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
          },
          "apple_pay": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
          },
          "dynamic_last4": {
            "description": "(For tokenized numbers only.) The last four digits of the device account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "google_pay": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_link"
          },
          "masterpass": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
          },
          "samsung_pay": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
          },
          "type": {
            "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
            "enum": [
              "amex_express_checkout",
              "apple_pay",
              "google_pay",
              "link",
              "masterpass",
              "samsung_pay",
              "visa_checkout"
            ],
            "type": "string"
          },
          "visa_checkout": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
          }
        },
        "required": ["type"],
        "title": "payment_method_details_card_wallet",
        "type": "object",
        "x-expandableFields": [
          "amex_express_checkout",
          "apple_pay",
          "google_pay",
          "link",
          "masterpass",
          "samsung_pay",
          "visa_checkout"
        ]
      },
      "payment_method_details_card_wallet_amex_express_checkout": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_card_wallet_amex_express_checkout",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet_apple_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_card_wallet_apple_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet_google_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_card_wallet_google_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet_link": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_card_wallet_link",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet_masterpass": {
        "description": "",
        "properties": {
          "billing_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          },
          "email": {
            "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          }
        },
        "title": "payment_method_details_card_wallet_masterpass",
        "type": "object",
        "x-expandableFields": ["billing_address", "shipping_address"]
      },
      "payment_method_details_card_wallet_samsung_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_card_wallet_samsung_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_card_wallet_visa_checkout": {
        "description": "",
        "properties": {
          "billing_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          },
          "email": {
            "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          }
        },
        "title": "payment_method_details_card_wallet_visa_checkout",
        "type": "object",
        "x-expandableFields": ["billing_address", "shipping_address"]
      },
      "payment_method_details_cashapp": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique and immutable identifier assigned by Cash App to every buyer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cashtag": {
            "description": "A public identifier for buyers using Cash App.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_cashapp",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_customer_balance": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_customer_balance",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_eps": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.",
            "enum": [
              "arzte_und_apotheker_bank",
              "austrian_anadi_bank_ag",
              "bank_austria",
              "bankhaus_carl_spangler",
              "bankhaus_schelhammer_und_schattera_ag",
              "bawag_psk_ag",
              "bks_bank_ag",
              "brull_kallmus_bank_ag",
              "btv_vier_lander_bank",
              "capital_bank_grawe_gruppe_ag",
              "deutsche_bank_ag",
              "dolomitenbank",
              "easybank_ag",
              "erste_bank_und_sparkassen",
              "hypo_alpeadriabank_international_ag",
              "hypo_bank_burgenland_aktiengesellschaft",
              "hypo_noe_lb_fur_niederosterreich_u_wien",
              "hypo_oberosterreich_salzburg_steiermark",
              "hypo_tirol_bank_ag",
              "hypo_vorarlberg_bank_ag",
              "marchfelder_bank",
              "oberbank_ag",
              "raiffeisen_bankengruppe_osterreich",
              "schoellerbank_ag",
              "sparda_bank_wien",
              "volksbank_gruppe",
              "volkskreditbank_ag",
              "vr_bank_braunau"
            ],
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_eps",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_fpx": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
            "enum": [
              "affin_bank",
              "agrobank",
              "alliance_bank",
              "ambank",
              "bank_islam",
              "bank_muamalat",
              "bank_of_china",
              "bank_rakyat",
              "bsn",
              "cimb",
              "deutsche_bank",
              "hong_leong_bank",
              "hsbc",
              "kfh",
              "maybank2e",
              "maybank2u",
              "ocbc",
              "pb_enterprise",
              "public_bank",
              "rhb",
              "standard_chartered",
              "uob"
            ],
            "type": "string"
          },
          "transaction_id": {
            "description": "Unique transaction id generated by FPX for every request from the merchant",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["bank"],
        "title": "payment_method_details_fpx",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_giropay": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "Bank Identifier Code of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_giropay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_grabpay": {
        "description": "",
        "properties": {
          "transaction_id": {
            "description": "Unique transaction id generated by GrabPay",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_grabpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_ideal": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
            "enum": [
              "abn_amro",
              "asn_bank",
              "bunq",
              "handelsbanken",
              "ing",
              "knab",
              "moneyou",
              "n26",
              "nn",
              "rabobank",
              "regiobank",
              "revolut",
              "sns_bank",
              "triodos_bank",
              "van_lanschot",
              "yoursafe"
            ],
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "The Bank Identifier Code of the customer's bank.",
            "enum": [
              "ABNANL2A",
              "ASNBNL21",
              "BITSNL2A",
              "BUNQNL2A",
              "FVLBNL22",
              "HANDNL2A",
              "INGBNL2A",
              "KNABNL2H",
              "MOYONL21",
              "NNBANL2G",
              "NTSBDEB1",
              "RABONL2U",
              "RBRBNL21",
              "REVOIE23",
              "REVOLT21",
              "SNSBNL2A",
              "TRIONL2U"
            ],
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_ideal",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "payment_method_details_interac_present": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `interac`, `mastercard` or `visa`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cardholder_name": {
            "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "A high-level description of the type of cards issued in this range.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "emv_auth_data": {
            "description": "Authorization response cryptogram.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_card": {
            "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "description": "The name of the card's issuing bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network": {
            "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network_transaction_id": {
            "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_locales": {
            "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "read_method": {
            "description": "How card details were read in this transaction.",
            "enum": [
              "contact_emv",
              "contactless_emv",
              "contactless_magstripe_mode",
              "magnetic_stripe_fallback",
              "magnetic_stripe_track2"
            ],
            "nullable": true,
            "type": "string"
          },
          "receipt": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
              }
            ],
            "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
            "nullable": true
          }
        },
        "required": ["exp_month", "exp_year"],
        "title": "payment_method_details_interac_present",
        "type": "object",
        "x-expandableFields": ["receipt"]
      },
      "payment_method_details_interac_present_receipt": {
        "description": "",
        "properties": {
          "account_type": {
            "description": "The type of account being debited or credited",
            "enum": ["checking", "savings", "unknown"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "application_cryptogram": {
            "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "application_preferred_name": {
            "description": "Mnenomic of the Application Identifier.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "authorization_code": {
            "description": "Identifier for this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "authorization_response_code": {
            "description": "EMV tag 8A. A code returned by the card issuer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cardholder_verification_method": {
            "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "dedicated_file_name": {
            "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "terminal_verification_results": {
            "description": "The outcome of a series of EMV functions performed by the card reader.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_status_information": {
            "description": "An indication of various EMV functions performed during the transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_interac_present_receipt",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_kakao_pay": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique identifier for the buyer as determined by the local payment processor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_kakao_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_klarna": {
        "description": "",
        "properties": {
          "payer_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/klarna_payer_details"
              }
            ],
            "description": "The payer details for this transaction.",
            "nullable": true
          },
          "payment_method_category": {
            "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_locale": {
            "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_klarna",
        "type": "object",
        "x-expandableFields": ["payer_details"]
      },
      "payment_method_details_konbini": {
        "description": "",
        "properties": {
          "store": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_konbini_store"
              }
            ],
            "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed.",
            "nullable": true
          }
        },
        "title": "payment_method_details_konbini",
        "type": "object",
        "x-expandableFields": ["store"]
      },
      "payment_method_details_konbini_store": {
        "description": "",
        "properties": {
          "chain": {
            "description": "The name of the convenience store chain where the payment was completed.",
            "enum": ["familymart", "lawson", "ministop", "seicomart"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_konbini_store",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_kr_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "The local credit or debit card brand.",
            "enum": [
              "bc",
              "citi",
              "hana",
              "hyundai",
              "jeju",
              "jeonbuk",
              "kakaobank",
              "kbank",
              "kdbbank",
              "kookmin",
              "kwangju",
              "lotte",
              "mg",
              "nh",
              "post",
              "samsung",
              "savingsbank",
              "shinhan",
              "shinhyup",
              "suhyup",
              "tossbank",
              "woori"
            ],
            "nullable": true,
            "type": "string"
          },
          "buyer_id": {
            "description": "A unique identifier for the buyer as determined by the local payment processor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card. This may not be present for American Express cards.",
            "maxLength": 4,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_kr_card",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_link": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_link",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_mobilepay": {
        "description": "",
        "properties": {
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/internal_card"
              }
            ],
            "description": "Internal card details",
            "nullable": true
          }
        },
        "title": "payment_method_details_mobilepay",
        "type": "object",
        "x-expandableFields": ["card"]
      },
      "payment_method_details_multibanco": {
        "description": "",
        "properties": {
          "entity": {
            "description": "Entity number associated with this Multibanco payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "Reference number associated with this Multibanco payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_multibanco",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_naver_pay": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique identifier for the buyer as determined by the local payment processor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_naver_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_oxxo": {
        "description": "",
        "properties": {
          "number": {
            "description": "OXXO reference number",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_oxxo",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_p24": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.",
            "enum": [
              "alior_bank",
              "bank_millennium",
              "bank_nowy_bfg_sa",
              "bank_pekao_sa",
              "banki_spbdzielcze",
              "blik",
              "bnp_paribas",
              "boz",
              "citi_handlowy",
              "credit_agricole",
              "envelobank",
              "etransfer_pocztowy24",
              "getin_bank",
              "ideabank",
              "ing",
              "inteligo",
              "mbank_mtransfer",
              "nest_przelew",
              "noble_pay",
              "pbac_z_ipko",
              "plus_bank",
              "santander_przelew24",
              "tmobile_usbugi_bankowe",
              "toyota_bank",
              "velobank",
              "volkswagen_bank"
            ],
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "Unique reference for this Przelewy24 payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_p24",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_passthrough_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "nullable": true,
            "type": "integer"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_passthrough_card",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_pay_by_bank": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_pay_by_bank",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_payco": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique identifier for the buyer as determined by the local payment processor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_payco",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_paynow": {
        "description": "",
        "properties": {
          "reference": {
            "description": "Reference number associated with this PayNow payment",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_paynow",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_paypal": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_email": {
            "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_id": {
            "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_name": {
            "description": "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "seller_protection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/paypal_seller_protection"
              }
            ],
            "description": "The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.",
            "nullable": true
          },
          "transaction_id": {
            "description": "A unique ID generated by PayPal for this transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_paypal",
        "type": "object",
        "x-expandableFields": ["seller_protection"]
      },
      "payment_method_details_pix": {
        "description": "",
        "properties": {
          "bank_transaction_id": {
            "description": "Unique transaction id generated by BCB",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_pix",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_promptpay": {
        "description": "",
        "properties": {
          "reference": {
            "description": "Bill reference generated by PromptPay",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_promptpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_revolut_pay": {
        "description": "",
        "properties": {
          "funding": {
            "$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details"
          }
        },
        "title": "payment_method_details_revolut_pay",
        "type": "object",
        "x-expandableFields": ["funding"]
      },
      "payment_method_details_samsung_pay": {
        "description": "",
        "properties": {
          "buyer_id": {
            "description": "A unique identifier for the buyer as determined by the local payment processor.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_samsung_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_sepa_debit": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "branch_code": {
            "description": "Branch code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_sofort": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "Bank Identifier Code of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`",
            "enum": ["de", "en", "es", "fr", "it", "nl", "pl"],
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_sofort",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "payment_method_details_stripe_account": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_stripe_account",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_swish": {
        "description": "",
        "properties": {
          "fingerprint": {
            "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_reference": {
            "description": "Payer bank reference number for the payment",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_phone_last4": {
            "description": "The last four digits of the Swish account phone number",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_swish",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_twint": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_twint",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_us_bank_account": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Account holder type: individual or company.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "Account type: checkings or savings. Defaults to checking if omitted.",
            "enum": ["checking", "savings"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the mandate used to make this payment.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "payment_reference": {
            "description": "Reference number to locate ACH payments with customer's bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_us_bank_account",
        "type": "object",
        "x-expandableFields": ["mandate"]
      },
      "payment_method_details_wechat": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_wechat",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_wechat_pay": {
        "description": "",
        "properties": {
          "fingerprint": {
            "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "Transaction ID of this particular WeChat Pay transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_details_wechat_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_details_zip": {
        "description": "",
        "properties": {},
        "title": "payment_method_details_zip",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_domain": {
        "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).",
        "properties": {
          "amazon_pay": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
          },
          "apple_pay": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "domain_name": {
            "description": "The domain name that this payment method domain object represents.",
            "maxLength": 5000,
            "type": "string"
          },
          "enabled": {
            "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.",
            "type": "boolean"
          },
          "google_pay": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "link": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payment_method_domain"],
            "type": "string"
          },
          "paypal": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
          }
        },
        "required": [
          "amazon_pay",
          "apple_pay",
          "created",
          "domain_name",
          "enabled",
          "google_pay",
          "id",
          "link",
          "livemode",
          "object",
          "paypal"
        ],
        "title": "PaymentMethodDomainResourcePaymentMethodDomain",
        "type": "object",
        "x-expandableFields": [
          "amazon_pay",
          "apple_pay",
          "google_pay",
          "link",
          "paypal"
        ],
        "x-resourceId": "payment_method_domain"
      },
      "payment_method_domain_resource_payment_method_status": {
        "description": "Indicates the status of a specific payment method on a payment method domain.",
        "properties": {
          "status": {
            "description": "The status of the payment method on the domain.",
            "enum": ["active", "inactive"],
            "type": "string"
          },
          "status_details": {
            "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details"
          }
        },
        "required": ["status"],
        "title": "PaymentMethodDomainResourcePaymentMethodStatus",
        "type": "object",
        "x-expandableFields": ["status_details"]
      },
      "payment_method_domain_resource_payment_method_status_details": {
        "description": "Contains additional details about the status of a payment method for a specific payment method domain.",
        "properties": {
          "error_message": {
            "description": "The error message associated with the status of the payment method on the domain.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["error_message"],
        "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_eps": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.",
            "enum": [
              "arzte_und_apotheker_bank",
              "austrian_anadi_bank_ag",
              "bank_austria",
              "bankhaus_carl_spangler",
              "bankhaus_schelhammer_und_schattera_ag",
              "bawag_psk_ag",
              "bks_bank_ag",
              "brull_kallmus_bank_ag",
              "btv_vier_lander_bank",
              "capital_bank_grawe_gruppe_ag",
              "deutsche_bank_ag",
              "dolomitenbank",
              "easybank_ag",
              "erste_bank_und_sparkassen",
              "hypo_alpeadriabank_international_ag",
              "hypo_bank_burgenland_aktiengesellschaft",
              "hypo_noe_lb_fur_niederosterreich_u_wien",
              "hypo_oberosterreich_salzburg_steiermark",
              "hypo_tirol_bank_ag",
              "hypo_vorarlberg_bank_ag",
              "marchfelder_bank",
              "oberbank_ag",
              "raiffeisen_bankengruppe_osterreich",
              "schoellerbank_ag",
              "sparda_bank_wien",
              "volksbank_gruppe",
              "volkskreditbank_ag",
              "vr_bank_braunau"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_eps",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_fpx": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
            "enum": [
              "affin_bank",
              "agrobank",
              "alliance_bank",
              "ambank",
              "bank_islam",
              "bank_muamalat",
              "bank_of_china",
              "bank_rakyat",
              "bsn",
              "cimb",
              "deutsche_bank",
              "hong_leong_bank",
              "hsbc",
              "kfh",
              "maybank2e",
              "maybank2u",
              "ocbc",
              "pb_enterprise",
              "public_bank",
              "rhb",
              "standard_chartered",
              "uob"
            ],
            "type": "string"
          }
        },
        "required": ["bank"],
        "title": "payment_method_fpx",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_giropay": {
        "description": "",
        "properties": {},
        "title": "payment_method_giropay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_grabpay": {
        "description": "",
        "properties": {},
        "title": "payment_method_grabpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_ideal": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
            "enum": [
              "abn_amro",
              "asn_bank",
              "bunq",
              "handelsbanken",
              "ing",
              "knab",
              "moneyou",
              "n26",
              "nn",
              "rabobank",
              "regiobank",
              "revolut",
              "sns_bank",
              "triodos_bank",
              "van_lanschot",
              "yoursafe"
            ],
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "The Bank Identifier Code of the customer's bank, if the bank was provided.",
            "enum": [
              "ABNANL2A",
              "ASNBNL21",
              "BITSNL2A",
              "BUNQNL2A",
              "FVLBNL22",
              "HANDNL2A",
              "INGBNL2A",
              "KNABNL2H",
              "MOYONL21",
              "NNBANL2G",
              "NTSBDEB1",
              "RABONL2U",
              "RBRBNL21",
              "REVOIE23",
              "REVOLT21",
              "SNSBNL2A",
              "TRIONL2U"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_ideal",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_interac_present": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `interac`, `mastercard` or `visa`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cardholder_name": {
            "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "A high-level description of the type of cards issued in this range.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "description": "The name of the card's issuing bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "networks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_card_present_networks"
              }
            ],
            "description": "Contains information about card networks that can be used to process the payment.",
            "nullable": true
          },
          "preferred_locales": {
            "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "read_method": {
            "description": "How card details were read in this transaction.",
            "enum": [
              "contact_emv",
              "contactless_emv",
              "contactless_magstripe_mode",
              "magnetic_stripe_fallback",
              "magnetic_stripe_track2"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["exp_month", "exp_year"],
        "title": "payment_method_interac_present",
        "type": "object",
        "x-expandableFields": ["networks"]
      },
      "payment_method_kakao_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_kakao_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_klarna": {
        "description": "",
        "properties": {
          "dob": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"
              }
            ],
            "description": "The customer's date of birth, if provided.",
            "nullable": true
          }
        },
        "title": "payment_method_klarna",
        "type": "object",
        "x-expandableFields": ["dob"]
      },
      "payment_method_konbini": {
        "description": "",
        "properties": {},
        "title": "payment_method_konbini",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_kr_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "The local credit or debit card brand.",
            "enum": [
              "bc",
              "citi",
              "hana",
              "hyundai",
              "jeju",
              "jeonbuk",
              "kakaobank",
              "kbank",
              "kdbbank",
              "kookmin",
              "kwangju",
              "lotte",
              "mg",
              "nh",
              "post",
              "samsung",
              "savingsbank",
              "shinhan",
              "shinhyup",
              "suhyup",
              "tossbank",
              "woori"
            ],
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card. This may not be present for American Express cards.",
            "maxLength": 4,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_kr_card",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_link": {
        "description": "",
        "properties": {
          "email": {
            "description": "Account owner's email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_link",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_mobilepay": {
        "description": "",
        "properties": {},
        "title": "payment_method_mobilepay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_multibanco": {
        "description": "",
        "properties": {},
        "title": "payment_method_multibanco",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_naver_pay": {
        "description": "",
        "properties": {
          "funding": {
            "description": "Whether to fund this transaction with Naver Pay points or a card.",
            "enum": ["card", "points"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["funding"],
        "title": "payment_method_naver_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_affirm": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "preferred_locale": {
            "description": "Preferred language of the Affirm authorization page that the customer is redirected to.",
            "maxLength": 30,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_affirm",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_afterpay_clearpay": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "reference": {
            "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_method_options_afterpay_clearpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_alipay": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_alipay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_alma": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          }
        },
        "title": "payment_method_options_alma",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_amazon_pay": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_amazon_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_bancontact": {
        "description": "",
        "properties": {
          "preferred_language": {
            "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
            "enum": ["de", "en", "fr", "nl"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "required": ["preferred_language"],
        "title": "payment_method_options_bancontact",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_boleto": {
        "description": "",
        "properties": {
          "expires_after_days": {
            "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.",
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          }
        },
        "required": ["expires_after_days"],
        "title": "payment_method_options_boleto",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_card_installments": {
        "description": "",
        "properties": {
          "available_plans": {
            "description": "Installment plans that may be selected for this PaymentIntent.",
            "items": {
              "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
            },
            "nullable": true,
            "type": "array"
          },
          "enabled": {
            "description": "Whether Installments are enabled for this PaymentIntent.",
            "type": "boolean"
          },
          "plan": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
              }
            ],
            "description": "Installment plan selected for this PaymentIntent.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "payment_method_options_card_installments",
        "type": "object",
        "x-expandableFields": ["available_plans", "plan"]
      },
      "payment_method_options_card_mandate_options": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount to be charged for future payments.",
            "type": "integer"
          },
          "amount_type": {
            "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.",
            "enum": ["fixed", "maximum"],
            "type": "string"
          },
          "description": {
            "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
          },
          "end_date": {
            "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "interval": {
            "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
            "enum": ["day", "month", "sporadic", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.",
            "nullable": true,
            "type": "integer"
          },
          "reference": {
            "description": "Unique identifier for the mandate or subscription.",
            "maxLength": 80,
            "type": "string"
          },
          "start_date": {
            "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
            "format": "unix-time",
            "type": "integer"
          },
          "supported_types": {
            "description": "Specifies the type of mandates supported. Possible values are `india`.",
            "items": {
              "enum": ["india"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "required": [
          "amount",
          "amount_type",
          "interval",
          "reference",
          "start_date"
        ],
        "title": "payment_method_options_card_mandate_options",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_card_present": {
        "description": "",
        "properties": {
          "request_extended_authorization": {
            "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
            "nullable": true,
            "type": "boolean"
          },
          "request_incremental_authorization_support": {
            "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
            "nullable": true,
            "type": "boolean"
          },
          "routing": {
            "$ref": "#/components/schemas/payment_method_options_card_present_routing"
          }
        },
        "title": "payment_method_options_card_present",
        "type": "object",
        "x-expandableFields": ["routing"]
      },
      "payment_method_options_card_present_routing": {
        "description": "",
        "properties": {
          "requested_priority": {
            "description": "Requested routing priority",
            "enum": ["domestic", "international"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_options_card_present_routing",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_cashapp": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session", "on_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_cashapp",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_customer_balance": {
        "description": "",
        "properties": {
          "bank_transfer": {
            "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
          },
          "funding_type": {
            "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
            "enum": ["bank_transfer"],
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_customer_balance",
        "type": "object",
        "x-expandableFields": ["bank_transfer"]
      },
      "payment_method_options_customer_balance_bank_transfer": {
        "description": "",
        "properties": {
          "eu_bank_transfer": {
            "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
          },
          "requested_address_types": {
            "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
            "items": {
              "enum": [
                "aba",
                "iban",
                "sepa",
                "sort_code",
                "spei",
                "swift",
                "zengin"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "type": {
            "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
            "enum": [
              "eu_bank_transfer",
              "gb_bank_transfer",
              "jp_bank_transfer",
              "mx_bank_transfer",
              "us_bank_transfer"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_method_options_customer_balance_bank_transfer",
        "type": "object",
        "x-expandableFields": ["eu_bank_transfer"]
      },
      "payment_method_options_customer_balance_eu_bank_account": {
        "description": "",
        "properties": {
          "country": {
            "description": "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.",
            "enum": ["BE", "DE", "ES", "FR", "IE", "NL"],
            "type": "string"
          }
        },
        "required": ["country"],
        "title": "payment_method_options_customer_balance_eu_bank_account",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_fpx": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_fpx",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_giropay": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_giropay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_grabpay": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_grabpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_ideal": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_ideal",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_interac_present": {
        "description": "",
        "properties": {},
        "title": "payment_method_options_interac_present",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_klarna": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "preferred_locale": {
            "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_method_options_klarna",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_konbini": {
        "description": "",
        "properties": {
          "confirmation_number": {
            "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "expires_after_days": {
            "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.",
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "product_description": {
            "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_konbini",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_kr_card": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_kr_card",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_multibanco": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_multibanco",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_oxxo": {
        "description": "",
        "properties": {
          "expires_after_days": {
            "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.",
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "required": ["expires_after_days"],
        "title": "payment_method_options_oxxo",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_p24": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_p24",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_pay_by_bank": {
        "description": "",
        "properties": {},
        "title": "payment_method_options_pay_by_bank",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_paynow": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_paynow",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_paypal": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "preferred_locale": {
            "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_paypal",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_pix": {
        "description": "",
        "properties": {
          "expires_after_seconds": {
            "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.",
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "description": "The timestamp at which the Pix expires.",
            "nullable": true,
            "type": "integer"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_pix",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_promptpay": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_promptpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_revolut_pay": {
        "description": "",
        "properties": {
          "capture_method": {
            "description": "Controls when the funds will be captured from the customer's account.",
            "enum": ["manual"],
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_revolut_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_sofort": {
        "description": "",
        "properties": {
          "preferred_language": {
            "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.",
            "enum": ["de", "en", "es", "fr", "it", "nl", "pl"],
            "nullable": true,
            "type": "string"
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none", "off_session"],
            "type": "string"
          }
        },
        "title": "payment_method_options_sofort",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_twint": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_twint",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_us_bank_account_mandate_options": {
        "description": "",
        "properties": {
          "collection_method": {
            "description": "Mandate collection method",
            "enum": ["paper"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_method_options_us_bank_account_mandate_options",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_wechat_pay": {
        "description": "",
        "properties": {
          "app_id": {
            "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "client": {
            "description": "The client type that the end customer will pay from",
            "enum": ["android", "ios", "web"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_wechat_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_options_zip": {
        "description": "",
        "properties": {
          "setup_future_usage": {
            "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
            "enum": ["none"],
            "type": "string"
          }
        },
        "title": "payment_method_options_zip",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_oxxo": {
        "description": "",
        "properties": {},
        "title": "payment_method_oxxo",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_p24": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank, if provided.",
            "enum": [
              "alior_bank",
              "bank_millennium",
              "bank_nowy_bfg_sa",
              "bank_pekao_sa",
              "banki_spbdzielcze",
              "blik",
              "bnp_paribas",
              "boz",
              "citi_handlowy",
              "credit_agricole",
              "envelobank",
              "etransfer_pocztowy24",
              "getin_bank",
              "ideabank",
              "ing",
              "inteligo",
              "mbank_mtransfer",
              "nest_przelew",
              "noble_pay",
              "pbac_z_ipko",
              "plus_bank",
              "santander_przelew24",
              "tmobile_usbugi_bankowe",
              "toyota_bank",
              "velobank",
              "volkswagen_bank"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "payment_method_p24",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_pay_by_bank": {
        "description": "",
        "properties": {},
        "title": "payment_method_pay_by_bank",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_payco": {
        "description": "",
        "properties": {},
        "title": "payment_method_payco",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_paynow": {
        "description": "",
        "properties": {},
        "title": "payment_method_paynow",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_paypal": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_email": {
            "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payer_id": {
            "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_paypal",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_pix": {
        "description": "",
        "properties": {},
        "title": "payment_method_pix",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_promptpay": {
        "description": "",
        "properties": {},
        "title": "payment_method_promptpay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_revolut_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_revolut_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_samsung_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_samsung_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_sepa_debit": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "branch_code": {
            "description": "Branch code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_from": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/sepa_debit_generated_from"
              }
            ],
            "description": "Information about the object that generated this PaymentMethod.",
            "nullable": true
          },
          "last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_sepa_debit",
        "type": "object",
        "x-expandableFields": ["generated_from"]
      },
      "payment_method_sofort": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter ISO code representing the country the bank account is located in.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_sofort",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_swish": {
        "description": "",
        "properties": {},
        "title": "payment_method_swish",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_twint": {
        "description": "",
        "properties": {},
        "title": "payment_method_twint",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_us_bank_account": {
        "description": "",
        "properties": {
          "account_holder_type": {
            "description": "Account holder type: individual or company.",
            "enum": ["company", "individual"],
            "nullable": true,
            "type": "string"
          },
          "account_type": {
            "description": "Account type: checkings or savings. Defaults to checking if omitted.",
            "enum": ["checking", "savings"],
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "The name of the bank.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "financial_connections_account": {
            "description": "The ID of the Financial Connections Account used to create the payment method.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "Last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "networks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/us_bank_account_networks"
              }
            ],
            "description": "Contains information about US bank account networks that can be used.",
            "nullable": true
          },
          "routing_number": {
            "description": "Routing number of the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_us_bank_account_status_details"
              }
            ],
            "description": "Contains information about the future reusability of this PaymentMethod.",
            "nullable": true
          }
        },
        "title": "payment_method_us_bank_account",
        "type": "object",
        "x-expandableFields": ["networks", "status_details"]
      },
      "payment_method_us_bank_account_blocked": {
        "description": "",
        "properties": {
          "network_code": {
            "description": "The ACH network code that resulted in this block.",
            "enum": [
              "R02",
              "R03",
              "R04",
              "R05",
              "R07",
              "R08",
              "R10",
              "R11",
              "R16",
              "R20",
              "R29",
              "R31"
            ],
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "The reason why this PaymentMethod's fingerprint has been blocked",
            "enum": [
              "bank_account_closed",
              "bank_account_frozen",
              "bank_account_invalid_details",
              "bank_account_restricted",
              "bank_account_unusable",
              "debit_not_authorized"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "payment_method_us_bank_account_blocked",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_us_bank_account_status_details": {
        "description": "",
        "properties": {
          "blocked": {
            "$ref": "#/components/schemas/payment_method_us_bank_account_blocked"
          }
        },
        "title": "payment_method_us_bank_account_status_details",
        "type": "object",
        "x-expandableFields": ["blocked"]
      },
      "payment_method_wechat_pay": {
        "description": "",
        "properties": {},
        "title": "payment_method_wechat_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_method_zip": {
        "description": "",
        "properties": {},
        "title": "payment_method_zip",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_adaptive_pricing": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether Adaptive Pricing is enabled.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PaymentPagesCheckoutSessionAdaptivePricing",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_after_expiration": {
        "description": "",
        "properties": {
          "recovery": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"
              }
            ],
            "description": "When set, configuration used to recover the Checkout Session on expiry.",
            "nullable": true
          }
        },
        "title": "PaymentPagesCheckoutSessionAfterExpiration",
        "type": "object",
        "x-expandableFields": ["recovery"]
      },
      "payment_pages_checkout_session_after_expiration_recovery": {
        "description": "",
        "properties": {
          "allow_promotion_codes": {
            "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`",
            "type": "boolean"
          },
          "enabled": {
            "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.",
            "type": "boolean"
          },
          "expires_at": {
            "description": "The timestamp at which the recovery URL will expire.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "url": {
            "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["allow_promotion_codes", "enabled"],
        "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_automatic_tax": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates whether automatic tax is enabled for the session",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          },
          "status": {
            "description": "The status of the most recent automated tax calculation for this session.",
            "enum": ["complete", "failed", "requires_location_inputs"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["enabled"],
        "title": "PaymentPagesCheckoutSessionAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "payment_pages_checkout_session_collected_information": {
        "description": "",
        "properties": {
          "shipping_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping"
              }
            ],
            "description": "Shipping information for this Checkout Session.",
            "nullable": true
          }
        },
        "title": "PaymentPagesCheckoutSessionCollectedInformation",
        "type": "object",
        "x-expandableFields": ["shipping_details"]
      },
      "payment_pages_checkout_session_consent": {
        "description": "",
        "properties": {
          "promotions": {
            "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.",
            "enum": ["opt_in", "opt_out"],
            "nullable": true,
            "type": "string"
          },
          "terms_of_service": {
            "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.",
            "enum": ["accepted"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "PaymentPagesCheckoutSessionConsent",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_consent_collection": {
        "description": "",
        "properties": {
          "payment_method_reuse_agreement": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement"
              }
            ],
            "description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method.",
            "nullable": true
          },
          "promotions": {
            "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
            "enum": ["auto", "none"],
            "nullable": true,
            "type": "string"
          },
          "terms_of_service": {
            "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay.",
            "enum": ["none", "required"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentPagesCheckoutSessionConsentCollection",
        "type": "object",
        "x-expandableFields": ["payment_method_reuse_agreement"]
      },
      "payment_pages_checkout_session_currency_conversion": {
        "description": "",
        "properties": {
          "amount_subtotal": {
            "description": "Total of all items in source currency before discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total of all items in source currency after discounts and taxes are applied.",
            "type": "integer"
          },
          "fx_rate": {
            "description": "Exchange rate used to convert source currency amounts to customer currency amounts",
            "format": "decimal",
            "type": "string"
          },
          "source_currency": {
            "description": "Creation currency of the CheckoutSession before localization",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "amount_subtotal",
          "amount_total",
          "fx_rate",
          "source_currency"
        ],
        "title": "PaymentPagesCheckoutSessionCurrencyConversion",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_custom_fields": {
        "description": "",
        "properties": {
          "dropdown": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"
          },
          "key": {
            "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "label": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label"
          },
          "numeric": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"
          },
          "optional": {
            "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
            "type": "boolean"
          },
          "text": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text"
          },
          "type": {
            "description": "The type of the field.",
            "enum": ["dropdown", "numeric", "text"],
            "type": "string"
          }
        },
        "required": ["key", "label", "optional", "type"],
        "title": "PaymentPagesCheckoutSessionCustomFields",
        "type": "object",
        "x-expandableFields": ["dropdown", "label", "numeric", "text"]
      },
      "payment_pages_checkout_session_custom_fields_dropdown": {
        "description": "",
        "properties": {
          "default_value": {
            "description": "The value that will pre-fill on the payment page.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "options": {
            "description": "The options available for the customer to select. Up to 200 options allowed.",
            "items": {
              "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_option"
            },
            "type": "array"
          },
          "value": {
            "description": "The option selected by the customer. This will be the `value` for the option.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["options"],
        "title": "PaymentPagesCheckoutSessionCustomFieldsDropdown",
        "type": "object",
        "x-expandableFields": ["options"]
      },
      "payment_pages_checkout_session_custom_fields_label": {
        "description": "",
        "properties": {
          "custom": {
            "description": "Custom text for the label, displayed to the customer. Up to 50 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "type": {
            "description": "The type of the label.",
            "enum": ["custom"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentPagesCheckoutSessionCustomFieldsLabel",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_custom_fields_numeric": {
        "description": "",
        "properties": {
          "default_value": {
            "description": "The value that will pre-fill the field on the payment page.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "maximum_length": {
            "description": "The maximum character length constraint for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "minimum_length": {
            "description": "The minimum character length requirement for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "value": {
            "description": "The value entered by the customer, containing only digits.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_custom_fields_option": {
        "description": "",
        "properties": {
          "label": {
            "description": "The label for the option, displayed to the customer. Up to 100 characters.",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["label", "value"],
        "title": "PaymentPagesCheckoutSessionCustomFieldsOption",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_custom_fields_text": {
        "description": "",
        "properties": {
          "default_value": {
            "description": "The value that will pre-fill the field on the payment page.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "maximum_length": {
            "description": "The maximum character length constraint for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "minimum_length": {
            "description": "The minimum character length requirement for the customer's input.",
            "nullable": true,
            "type": "integer"
          },
          "value": {
            "description": "The value entered by the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentPagesCheckoutSessionCustomFieldsText",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_custom_text": {
        "description": "",
        "properties": {
          "after_submit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed after the payment confirmation button.",
            "nullable": true
          },
          "shipping_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed alongside shipping address collection.",
            "nullable": true
          },
          "submit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed alongside the payment confirmation button.",
            "nullable": true
          },
          "terms_of_service_acceptance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
              }
            ],
            "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
            "nullable": true
          }
        },
        "title": "PaymentPagesCheckoutSessionCustomText",
        "type": "object",
        "x-expandableFields": [
          "after_submit",
          "shipping_address",
          "submit",
          "terms_of_service_acceptance"
        ]
      },
      "payment_pages_checkout_session_custom_text_position": {
        "description": "",
        "properties": {
          "message": {
            "description": "Text may be up to 1200 characters in length.",
            "maxLength": 500,
            "type": "string"
          }
        },
        "required": ["message"],
        "title": "PaymentPagesCheckoutSessionCustomTextPosition",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_customer_details": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
            "nullable": true
          },
          "email": {
            "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "phone": {
            "description": "The customer's phone number after a completed Checkout Session.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_exempt": {
            "description": "The customer’s tax exempt status after a completed Checkout Session.",
            "enum": ["exempt", "none", "reverse"],
            "nullable": true,
            "type": "string"
          },
          "tax_ids": {
            "description": "The customer’s tax IDs after a completed Checkout Session.",
            "items": {
              "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "PaymentPagesCheckoutSessionCustomerDetails",
        "type": "object",
        "x-expandableFields": ["address", "tax_ids"]
      },
      "payment_pages_checkout_session_discount": {
        "description": "",
        "properties": {
          "coupon": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/coupon"
              }
            ],
            "description": "Coupon attached to the Checkout Session.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/coupon"
                }
              ]
            }
          },
          "promotion_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/promotion_code"
              }
            ],
            "description": "Promotion code attached to the Checkout Session.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/promotion_code"
                }
              ]
            }
          }
        },
        "title": "PaymentPagesCheckoutSessionDiscount",
        "type": "object",
        "x-expandableFields": ["coupon", "promotion_code"]
      },
      "payment_pages_checkout_session_invoice_creation": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates whether invoice creation is enabled for the Checkout Session.",
            "type": "boolean"
          },
          "invoice_data": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_settings"
          }
        },
        "required": ["enabled", "invoice_data"],
        "title": "PaymentPagesCheckoutSessionInvoiceCreation",
        "type": "object",
        "x-expandableFields": ["invoice_data"]
      },
      "payment_pages_checkout_session_invoice_settings": {
        "description": "",
        "properties": {
          "account_tax_ids": {
            "description": "The account tax IDs associated with the invoice.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "custom_fields": {
            "description": "Custom fields displayed on the invoice.",
            "items": {
              "$ref": "#/components/schemas/invoice_setting_custom_field"
            },
            "nullable": true,
            "type": "array"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "footer": {
            "description": "Footer displayed on the invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
            "nullable": true
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "rendering_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options"
              }
            ],
            "description": "Options for invoice PDF rendering.",
            "nullable": true
          }
        },
        "title": "PaymentPagesCheckoutSessionInvoiceSettings",
        "type": "object",
        "x-expandableFields": [
          "account_tax_ids",
          "custom_fields",
          "issuer",
          "rendering_options"
        ]
      },
      "payment_pages_checkout_session_payment_method_reuse_agreement": {
        "description": "",
        "properties": {
          "position": {
            "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
            "enum": ["auto", "hidden"],
            "type": "string"
          }
        },
        "required": ["position"],
        "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_phone_number_collection": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates whether phone number collection is enabled for the session",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PaymentPagesCheckoutSessionPhoneNumberCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_saved_payment_method_options": {
        "description": "",
        "properties": {
          "allow_redisplay_filters": {
            "description": "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.",
            "items": {
              "enum": ["always", "limited", "unspecified"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "payment_method_remove": {
            "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.",
            "enum": ["disabled", "enabled"],
            "nullable": true,
            "type": "string"
          },
          "payment_method_save": {
            "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.",
            "enum": ["disabled", "enabled"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_shipping_address_collection": {
        "description": "",
        "properties": {
          "allowed_countries": {
            "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.",
            "items": {
              "enum": [
                "AC",
                "AD",
                "AE",
                "AF",
                "AG",
                "AI",
                "AL",
                "AM",
                "AO",
                "AQ",
                "AR",
                "AT",
                "AU",
                "AW",
                "AX",
                "AZ",
                "BA",
                "BB",
                "BD",
                "BE",
                "BF",
                "BG",
                "BH",
                "BI",
                "BJ",
                "BL",
                "BM",
                "BN",
                "BO",
                "BQ",
                "BR",
                "BS",
                "BT",
                "BV",
                "BW",
                "BY",
                "BZ",
                "CA",
                "CD",
                "CF",
                "CG",
                "CH",
                "CI",
                "CK",
                "CL",
                "CM",
                "CN",
                "CO",
                "CR",
                "CV",
                "CW",
                "CY",
                "CZ",
                "DE",
                "DJ",
                "DK",
                "DM",
                "DO",
                "DZ",
                "EC",
                "EE",
                "EG",
                "EH",
                "ER",
                "ES",
                "ET",
                "FI",
                "FJ",
                "FK",
                "FO",
                "FR",
                "GA",
                "GB",
                "GD",
                "GE",
                "GF",
                "GG",
                "GH",
                "GI",
                "GL",
                "GM",
                "GN",
                "GP",
                "GQ",
                "GR",
                "GS",
                "GT",
                "GU",
                "GW",
                "GY",
                "HK",
                "HN",
                "HR",
                "HT",
                "HU",
                "ID",
                "IE",
                "IL",
                "IM",
                "IN",
                "IO",
                "IQ",
                "IS",
                "IT",
                "JE",
                "JM",
                "JO",
                "JP",
                "KE",
                "KG",
                "KH",
                "KI",
                "KM",
                "KN",
                "KR",
                "KW",
                "KY",
                "KZ",
                "LA",
                "LB",
                "LC",
                "LI",
                "LK",
                "LR",
                "LS",
                "LT",
                "LU",
                "LV",
                "LY",
                "MA",
                "MC",
                "MD",
                "ME",
                "MF",
                "MG",
                "MK",
                "ML",
                "MM",
                "MN",
                "MO",
                "MQ",
                "MR",
                "MS",
                "MT",
                "MU",
                "MV",
                "MW",
                "MX",
                "MY",
                "MZ",
                "NA",
                "NC",
                "NE",
                "NG",
                "NI",
                "NL",
                "NO",
                "NP",
                "NR",
                "NU",
                "NZ",
                "OM",
                "PA",
                "PE",
                "PF",
                "PG",
                "PH",
                "PK",
                "PL",
                "PM",
                "PN",
                "PR",
                "PS",
                "PT",
                "PY",
                "QA",
                "RE",
                "RO",
                "RS",
                "RU",
                "RW",
                "SA",
                "SB",
                "SC",
                "SD",
                "SE",
                "SG",
                "SH",
                "SI",
                "SJ",
                "SK",
                "SL",
                "SM",
                "SN",
                "SO",
                "SR",
                "SS",
                "ST",
                "SV",
                "SX",
                "SZ",
                "TA",
                "TC",
                "TD",
                "TF",
                "TG",
                "TH",
                "TJ",
                "TK",
                "TL",
                "TM",
                "TN",
                "TO",
                "TR",
                "TT",
                "TV",
                "TW",
                "TZ",
                "UA",
                "UG",
                "US",
                "UY",
                "UZ",
                "VA",
                "VC",
                "VE",
                "VG",
                "VN",
                "VU",
                "WF",
                "WS",
                "XK",
                "YE",
                "YT",
                "ZA",
                "ZM",
                "ZW",
                "ZZ"
              ],
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["allowed_countries"],
        "title": "PaymentPagesCheckoutSessionShippingAddressCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_shipping_cost": {
        "description": "",
        "properties": {
          "amount_subtotal": {
            "description": "Total shipping cost before any discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total shipping cost after discounts and taxes are applied.",
            "type": "integer"
          },
          "shipping_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/shipping_rate"
              }
            ],
            "description": "The ID of the ShippingRate for this order.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              ]
            }
          },
          "taxes": {
            "description": "The taxes applied to the shipping rate.",
            "items": {
              "$ref": "#/components/schemas/line_items_tax_amount"
            },
            "type": "array"
          }
        },
        "required": ["amount_subtotal", "amount_tax", "amount_total"],
        "title": "PaymentPagesCheckoutSessionShippingCost",
        "type": "object",
        "x-expandableFields": ["shipping_rate", "taxes"]
      },
      "payment_pages_checkout_session_shipping_option": {
        "description": "",
        "properties": {
          "shipping_amount": {
            "description": "A non-negative integer in cents representing how much to charge.",
            "type": "integer"
          },
          "shipping_rate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/shipping_rate"
              }
            ],
            "description": "The shipping rate.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              ]
            }
          }
        },
        "required": ["shipping_amount", "shipping_rate"],
        "title": "PaymentPagesCheckoutSessionShippingOption",
        "type": "object",
        "x-expandableFields": ["shipping_rate"]
      },
      "payment_pages_checkout_session_tax_id": {
        "description": "",
        "properties": {
          "type": {
            "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`",
            "enum": [
              "ad_nrt",
              "ae_trn",
              "al_tin",
              "am_tin",
              "ao_tin",
              "ar_cuit",
              "au_abn",
              "au_arn",
              "ba_tin",
              "bb_tin",
              "bg_uic",
              "bh_vat",
              "bo_tin",
              "br_cnpj",
              "br_cpf",
              "bs_tin",
              "by_tin",
              "ca_bn",
              "ca_gst_hst",
              "ca_pst_bc",
              "ca_pst_mb",
              "ca_pst_sk",
              "ca_qst",
              "cd_nif",
              "ch_uid",
              "ch_vat",
              "cl_tin",
              "cn_tin",
              "co_nit",
              "cr_tin",
              "de_stn",
              "do_rcn",
              "ec_ruc",
              "eg_tin",
              "es_cif",
              "eu_oss_vat",
              "eu_vat",
              "gb_vat",
              "ge_vat",
              "gn_nif",
              "hk_br",
              "hr_oib",
              "hu_tin",
              "id_npwp",
              "il_vat",
              "in_gst",
              "is_vat",
              "jp_cn",
              "jp_rn",
              "jp_trn",
              "ke_pin",
              "kh_tin",
              "kr_brn",
              "kz_bin",
              "li_uid",
              "li_vat",
              "ma_vat",
              "md_vat",
              "me_pib",
              "mk_vat",
              "mr_nif",
              "mx_rfc",
              "my_frp",
              "my_itn",
              "my_sst",
              "ng_tin",
              "no_vat",
              "no_voec",
              "np_pan",
              "nz_gst",
              "om_vat",
              "pe_ruc",
              "ph_tin",
              "ro_tin",
              "rs_pib",
              "ru_inn",
              "ru_kpp",
              "sa_vat",
              "sg_gst",
              "sg_uen",
              "si_tin",
              "sn_ninea",
              "sr_fin",
              "sv_nit",
              "th_vat",
              "tj_tin",
              "tr_tin",
              "tw_vat",
              "tz_vat",
              "ua_vat",
              "ug_tin",
              "unknown",
              "us_ein",
              "uy_ruc",
              "uz_tin",
              "uz_vat",
              "ve_rif",
              "vn_tin",
              "za_vat",
              "zm_tin",
              "zw_tin"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the tax ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PaymentPagesCheckoutSessionTaxID",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_tax_id_collection": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Indicates whether tax ID collection is enabled for the session",
            "type": "boolean"
          },
          "required": {
            "description": "Indicates whether a tax ID is required on the payment page",
            "enum": ["if_supported", "never"],
            "type": "string"
          }
        },
        "required": ["enabled", "required"],
        "title": "PaymentPagesCheckoutSessionTaxIDCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_pages_checkout_session_total_details": {
        "description": "",
        "properties": {
          "amount_discount": {
            "description": "This is the sum of all the discounts.",
            "type": "integer"
          },
          "amount_shipping": {
            "description": "This is the sum of all the shipping amounts.",
            "nullable": true,
            "type": "integer"
          },
          "amount_tax": {
            "description": "This is the sum of all the tax amounts.",
            "type": "integer"
          },
          "breakdown": {
            "$ref": "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown"
          }
        },
        "required": ["amount_discount", "amount_tax"],
        "title": "PaymentPagesCheckoutSessionTotalDetails",
        "type": "object",
        "x-expandableFields": ["breakdown"]
      },
      "payment_pages_checkout_session_total_details_resource_breakdown": {
        "description": "",
        "properties": {
          "discounts": {
            "description": "The aggregated discounts.",
            "items": {
              "$ref": "#/components/schemas/line_items_discount_amount"
            },
            "type": "array"
          },
          "taxes": {
            "description": "The aggregated tax amounts by rate.",
            "items": {
              "$ref": "#/components/schemas/line_items_tax_amount"
            },
            "type": "array"
          }
        },
        "required": ["discounts", "taxes"],
        "title": "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown",
        "type": "object",
        "x-expandableFields": ["discounts", "taxes"]
      },
      "payment_pages_private_card_payment_method_options_resource_restrictions": {
        "description": "",
        "properties": {
          "brands_blocked": {
            "description": "Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.",
            "items": {
              "enum": [
                "american_express",
                "discover_global_network",
                "mastercard",
                "visa"
              ],
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions",
        "type": "object",
        "x-expandableFields": []
      },
      "payment_source": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/account"
          },
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          },
          {
            "$ref": "#/components/schemas/source"
          }
        ],
        "title": "Polymorphic",
        "x-resourceId": "payment_source",
        "x-stripeBypassValidation": true
      },
      "payout": {
        "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://stripe.com/docs/payouts)",
        "properties": {
          "amount": {
            "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.",
            "type": "integer"
          },
          "application_fee": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application_fee"
              }
            ],
            "description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application_fee"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
            "nullable": true,
            "type": "integer"
          },
          "arrival_date": {
            "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.",
            "format": "unix-time",
            "type": "integer"
          },
          "automatic": {
            "description": "Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).",
            "type": "boolean"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "ID of the balance transaction that describes the impact of this payout on your account balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/deleted_bank_account"
              },
              {
                "$ref": "#/components/schemas/deleted_card"
              }
            ],
            "description": "ID of the bank account or card the payout is sent to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/bank_account"
                },
                {
                  "$ref": "#/components/schemas/card"
                },
                {
                  "$ref": "#/components/schemas/deleted_bank_account"
                },
                {
                  "$ref": "#/components/schemas/deleted_card"
                }
              ]
            },
            "x-stripeBypassValidation": true
          },
          "failure_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "failure_code": {
            "description": "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "failure_message": {
            "description": "Message that provides the reason for a payout failure, if available.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "method": {
            "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["payout"],
            "type": "string"
          },
          "original_payout": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payout"
              }
            ],
            "description": "If the payout reverses another, this is the ID of the original payout.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payout"
                }
              ]
            }
          },
          "reconciliation_status": {
            "description": "If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.",
            "enum": ["completed", "in_progress", "not_applicable"],
            "type": "string"
          },
          "reversed_by": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payout"
              }
            ],
            "description": "If the payout reverses, this is the ID of the payout that reverses this payout.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payout"
                }
              ]
            }
          },
          "source_type": {
            "description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.",
            "maxLength": 5000,
            "type": "string"
          },
          "statement_descriptor": {
            "description": "Extra information about a payout that displays on the user's bank statement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.",
            "maxLength": 5000,
            "type": "string"
          },
          "trace_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payouts_trace_id"
              }
            ],
            "description": "A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a \"reference number\" or something similar.",
            "nullable": true
          },
          "type": {
            "description": "Can be `bank_account` or `card`.",
            "enum": ["bank_account", "card"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": [
          "amount",
          "arrival_date",
          "automatic",
          "created",
          "currency",
          "id",
          "livemode",
          "method",
          "object",
          "reconciliation_status",
          "source_type",
          "status",
          "type"
        ],
        "title": "Payout",
        "type": "object",
        "x-expandableFields": [
          "application_fee",
          "balance_transaction",
          "destination",
          "failure_balance_transaction",
          "original_payout",
          "reversed_by",
          "trace_id"
        ],
        "x-resourceId": "payout"
      },
      "payouts_trace_id": {
        "description": "",
        "properties": {
          "status": {
            "description": "Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.",
            "maxLength": 5000,
            "type": "string"
          },
          "value": {
            "description": "The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "PayoutsTraceID",
        "type": "object",
        "x-expandableFields": []
      },
      "paypal_seller_protection": {
        "description": "",
        "properties": {
          "dispute_categories": {
            "description": "An array of conditions that are covered for the transaction, if applicable.",
            "items": {
              "enum": ["fraudulent", "product_not_received"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "status": {
            "description": "Indicates whether the transaction is eligible for PayPal's seller protection.",
            "enum": ["eligible", "not_eligible", "partially_eligible"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "paypal_seller_protection",
        "type": "object",
        "x-expandableFields": []
      },
      "period": {
        "description": "",
        "properties": {
          "end": {
            "description": "The end date of this usage period. All usage up to and including this point in time is included.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "start": {
            "description": "The start date of this usage period. All usage after this point in time is included.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "Period",
        "type": "object",
        "x-expandableFields": []
      },
      "person": {
        "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).",
        "properties": {
          "account": {
            "description": "The account the person is associated with.",
            "maxLength": 5000,
            "type": "string"
          },
          "additional_tos_acceptances": {
            "$ref": "#/components/schemas/person_additional_tos_acceptances"
          },
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "address_kana": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_japan_address"
              }
            ],
            "nullable": true
          },
          "address_kanji": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/legal_entity_japan_address"
              }
            ],
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "dob": {
            "$ref": "#/components/schemas/legal_entity_dob"
          },
          "email": {
            "description": "The person's email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "first_name": {
            "description": "The person's first name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "first_name_kana": {
            "description": "The Kana variation of the person's first name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "first_name_kanji": {
            "description": "The Kanji variation of the person's first name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "full_name_aliases": {
            "description": "A list of alternate names or aliases that the person is known by.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "future_requirements": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/person_future_requirements"
              }
            ],
            "nullable": true
          },
          "gender": {
            "description": "The person's gender.",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "id_number_provided": {
            "description": "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).",
            "type": "boolean"
          },
          "id_number_secondary_provided": {
            "description": "Whether the person's `id_number_secondary` was provided.",
            "type": "boolean"
          },
          "last_name": {
            "description": "The person's last name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last_name_kana": {
            "description": "The Kana variation of the person's last name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last_name_kanji": {
            "description": "The Kanji variation of the person's last name (Japan only).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "maiden_name": {
            "description": "The person's maiden name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "nationality": {
            "description": "The country where the person is a national.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["person"],
            "type": "string"
          },
          "phone": {
            "description": "The person's phone number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "political_exposure": {
            "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.",
            "enum": ["existing", "none"],
            "type": "string"
          },
          "registered_address": {
            "$ref": "#/components/schemas/address"
          },
          "relationship": {
            "$ref": "#/components/schemas/person_relationship"
          },
          "requirements": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/person_requirements"
              }
            ],
            "nullable": true
          },
          "ssn_last_4_provided": {
            "description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only).",
            "type": "boolean"
          },
          "verification": {
            "$ref": "#/components/schemas/legal_entity_person_verification"
          }
        },
        "required": ["account", "created", "id", "object"],
        "title": "Person",
        "type": "object",
        "x-expandableFields": [
          "additional_tos_acceptances",
          "address",
          "address_kana",
          "address_kanji",
          "dob",
          "future_requirements",
          "registered_address",
          "relationship",
          "requirements",
          "verification"
        ],
        "x-resourceId": "person"
      },
      "person_additional_tos_acceptance": {
        "description": "",
        "properties": {
          "date": {
            "description": "The Unix timestamp marking when the legal guardian accepted the service agreement.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "ip": {
            "description": "The IP address from which the legal guardian accepted the service agreement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "user_agent": {
            "description": "The user agent of the browser from which the legal guardian accepted the service agreement.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PersonAdditionalTOSAcceptance",
        "type": "object",
        "x-expandableFields": []
      },
      "person_additional_tos_acceptances": {
        "description": "",
        "properties": {
          "account": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/person_additional_tos_acceptance"
              }
            ],
            "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
            "nullable": true
          }
        },
        "title": "PersonAdditionalTOSAcceptances",
        "type": "object",
        "x-expandableFields": ["account"]
      },
      "person_future_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "currently_due",
          "errors",
          "eventually_due",
          "past_due",
          "pending_verification"
        ],
        "title": "PersonFutureRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "person_relationship": {
        "description": "",
        "properties": {
          "authorizer": {
            "description": "Whether the person is the authorizer of the account's representative.",
            "nullable": true,
            "type": "boolean"
          },
          "director": {
            "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.",
            "nullable": true,
            "type": "boolean"
          },
          "executive": {
            "description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
            "nullable": true,
            "type": "boolean"
          },
          "legal_guardian": {
            "description": "Whether the person is the legal guardian of the account's representative.",
            "nullable": true,
            "type": "boolean"
          },
          "owner": {
            "description": "Whether the person is an owner of the account’s legal entity.",
            "nullable": true,
            "type": "boolean"
          },
          "percent_ownership": {
            "description": "The percent owned by the person of the account's legal entity.",
            "nullable": true,
            "type": "number"
          },
          "representative": {
            "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.",
            "nullable": true,
            "type": "boolean"
          },
          "title": {
            "description": "The person's title (e.g., CEO, Support Engineer).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PersonRelationship",
        "type": "object",
        "x-expandableFields": []
      },
      "person_requirements": {
        "description": "",
        "properties": {
          "alternatives": {
            "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_alternative"
            },
            "nullable": true,
            "type": "array"
          },
          "currently_due": {
            "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "errors": {
            "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.",
            "items": {
              "$ref": "#/components/schemas/account_requirements_error"
            },
            "type": "array"
          },
          "eventually_due": {
            "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "past_due": {
            "description": "Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "pending_verification": {
            "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "currently_due",
          "errors",
          "eventually_due",
          "past_due",
          "pending_verification"
        ],
        "title": "PersonRequirements",
        "type": "object",
        "x-expandableFields": ["alternatives", "errors"]
      },
      "plan": {
        "description": "You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).",
        "properties": {
          "active": {
            "description": "Whether the plan can be used for new purchases.",
            "type": "boolean"
          },
          "aggregate_usage": {
            "description": "Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.",
            "enum": ["last_during_period", "last_ever", "max", "sum"],
            "nullable": true,
            "type": "string"
          },
          "amount": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
            "nullable": true,
            "type": "integer"
          },
          "amount_decimal": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "billing_scheme": {
            "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
            "enum": ["per_unit", "tiered"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "interval": {
            "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.",
            "enum": ["day", "month", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.",
            "type": "integer"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "meter": {
            "description": "The meter tracking the usage of a metered price",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "nickname": {
            "description": "A brief description of the plan, hidden from customers.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["plan"],
            "type": "string"
          },
          "product": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/product"
              },
              {
                "$ref": "#/components/schemas/deleted_product"
              }
            ],
            "description": "The product whose pricing this plan determines.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/product"
                },
                {
                  "$ref": "#/components/schemas/deleted_product"
                }
              ]
            }
          },
          "tiers": {
            "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
            "items": {
              "$ref": "#/components/schemas/plan_tier"
            },
            "type": "array"
          },
          "tiers_mode": {
            "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.",
            "enum": ["graduated", "volume"],
            "nullable": true,
            "type": "string"
          },
          "transform_usage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/transform_usage"
              }
            ],
            "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.",
            "nullable": true
          },
          "trial_period_days": {
            "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).",
            "nullable": true,
            "type": "integer"
          },
          "usage_type": {
            "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.",
            "enum": ["licensed", "metered"],
            "type": "string"
          }
        },
        "required": [
          "active",
          "billing_scheme",
          "created",
          "currency",
          "id",
          "interval",
          "interval_count",
          "livemode",
          "object",
          "usage_type"
        ],
        "title": "Plan",
        "type": "object",
        "x-expandableFields": ["product", "tiers", "transform_usage"],
        "x-resourceId": "plan"
      },
      "plan_tier": {
        "description": "",
        "properties": {
          "flat_amount": {
            "description": "Price for the entire tier.",
            "nullable": true,
            "type": "integer"
          },
          "flat_amount_decimal": {
            "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "unit_amount": {
            "description": "Per unit price for units relevant to the tier.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "up_to": {
            "description": "Up to and including to this quantity will be contained in the tier.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PlanTier",
        "type": "object",
        "x-expandableFields": []
      },
      "platform_earning_fee_source": {
        "description": "",
        "properties": {
          "charge": {
            "description": "Charge ID that created this application fee.",
            "maxLength": 5000,
            "type": "string"
          },
          "payout": {
            "description": "Payout ID that created this application fee.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "Type of object that created the application fee, either `charge` or `payout`.",
            "enum": ["charge", "payout"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PlatformEarningFeeSource",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_business_profile": {
        "description": "",
        "properties": {
          "headline": {
            "description": "The messaging shown to customers in the portal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "privacy_policy_url": {
            "description": "A link to the business’s publicly available privacy policy.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "terms_of_service_url": {
            "description": "A link to the business’s publicly available terms of service.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PortalBusinessProfile",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_customer_update": {
        "description": "",
        "properties": {
          "allowed_updates": {
            "description": "The types of customer updates that are supported. When empty, customers are not updateable.",
            "items": {
              "enum": [
                "address",
                "email",
                "name",
                "phone",
                "shipping",
                "tax_id"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          }
        },
        "required": ["allowed_updates", "enabled"],
        "title": "PortalCustomerUpdate",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_features": {
        "description": "",
        "properties": {
          "customer_update": {
            "$ref": "#/components/schemas/portal_customer_update"
          },
          "invoice_history": {
            "$ref": "#/components/schemas/portal_invoice_list"
          },
          "payment_method_update": {
            "$ref": "#/components/schemas/portal_payment_method_update"
          },
          "subscription_cancel": {
            "$ref": "#/components/schemas/portal_subscription_cancel"
          },
          "subscription_update": {
            "$ref": "#/components/schemas/portal_subscription_update"
          }
        },
        "required": [
          "customer_update",
          "invoice_history",
          "payment_method_update",
          "subscription_cancel",
          "subscription_update"
        ],
        "title": "PortalFeatures",
        "type": "object",
        "x-expandableFields": [
          "customer_update",
          "invoice_history",
          "payment_method_update",
          "subscription_cancel",
          "subscription_update"
        ]
      },
      "portal_flows_after_completion_hosted_confirmation": {
        "description": "",
        "properties": {
          "custom_message": {
            "description": "A custom message to display to the customer after the flow is completed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PortalFlowsAfterCompletionHostedConfirmation",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_flows_after_completion_redirect": {
        "description": "",
        "properties": {
          "return_url": {
            "description": "The URL the customer will be redirected to after the flow is completed.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["return_url"],
        "title": "PortalFlowsAfterCompletionRedirect",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_flows_coupon_offer": {
        "description": "",
        "properties": {
          "coupon": {
            "description": "The ID of the coupon to be offered.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["coupon"],
        "title": "PortalFlowsCouponOffer",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_flows_flow": {
        "description": "",
        "properties": {
          "after_completion": {
            "$ref": "#/components/schemas/portal_flows_flow_after_completion"
          },
          "subscription_cancel": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_flow_subscription_cancel"
              }
            ],
            "description": "Configuration when `flow.type=subscription_cancel`.",
            "nullable": true
          },
          "subscription_update": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_flow_subscription_update"
              }
            ],
            "description": "Configuration when `flow.type=subscription_update`.",
            "nullable": true
          },
          "subscription_update_confirm": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm"
              }
            ],
            "description": "Configuration when `flow.type=subscription_update_confirm`.",
            "nullable": true
          },
          "type": {
            "description": "Type of flow that the customer will go through.",
            "enum": [
              "payment_method_update",
              "subscription_cancel",
              "subscription_update",
              "subscription_update_confirm"
            ],
            "type": "string"
          }
        },
        "required": ["after_completion", "type"],
        "title": "PortalFlowsFlow",
        "type": "object",
        "x-expandableFields": [
          "after_completion",
          "subscription_cancel",
          "subscription_update",
          "subscription_update_confirm"
        ]
      },
      "portal_flows_flow_after_completion": {
        "description": "",
        "properties": {
          "hosted_confirmation": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_after_completion_hosted_confirmation"
              }
            ],
            "description": "Configuration when `after_completion.type=hosted_confirmation`.",
            "nullable": true
          },
          "redirect": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_after_completion_redirect"
              }
            ],
            "description": "Configuration when `after_completion.type=redirect`.",
            "nullable": true
          },
          "type": {
            "description": "The specified type of behavior after the flow is completed.",
            "enum": ["hosted_confirmation", "portal_homepage", "redirect"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PortalFlowsFlowAfterCompletion",
        "type": "object",
        "x-expandableFields": ["hosted_confirmation", "redirect"]
      },
      "portal_flows_flow_subscription_cancel": {
        "description": "",
        "properties": {
          "retention": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_retention"
              }
            ],
            "description": "Specify a retention strategy to be used in the cancellation flow.",
            "nullable": true
          },
          "subscription": {
            "description": "The ID of the subscription to be canceled.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["subscription"],
        "title": "PortalFlowsFlowSubscriptionCancel",
        "type": "object",
        "x-expandableFields": ["retention"]
      },
      "portal_flows_flow_subscription_update": {
        "description": "",
        "properties": {
          "subscription": {
            "description": "The ID of the subscription to be updated.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["subscription"],
        "title": "PortalFlowsFlowSubscriptionUpdate",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_flows_flow_subscription_update_confirm": {
        "description": "",
        "properties": {
          "discounts": {
            "description": "The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.",
            "items": {
              "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_discount"
            },
            "nullable": true,
            "type": "array"
          },
          "items": {
            "description": "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.",
            "items": {
              "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_item"
            },
            "type": "array"
          },
          "subscription": {
            "description": "The ID of the subscription to be updated.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["items", "subscription"],
        "title": "PortalFlowsFlowSubscriptionUpdateConfirm",
        "type": "object",
        "x-expandableFields": ["discounts", "items"]
      },
      "portal_flows_retention": {
        "description": "",
        "properties": {
          "coupon_offer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/portal_flows_coupon_offer"
              }
            ],
            "description": "Configuration when `retention.type=coupon_offer`.",
            "nullable": true
          },
          "type": {
            "description": "Type of retention strategy that will be used.",
            "enum": ["coupon_offer"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PortalFlowsRetention",
        "type": "object",
        "x-expandableFields": ["coupon_offer"]
      },
      "portal_flows_subscription_update_confirm_discount": {
        "description": "",
        "properties": {
          "coupon": {
            "description": "The ID of the coupon to apply to this subscription update.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "promotion_code": {
            "description": "The ID of a promotion code to apply to this subscription update.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "PortalFlowsSubscriptionUpdateConfirmDiscount",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_flows_subscription_update_confirm_item": {
        "description": "",
        "properties": {
          "id": {
            "description": "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "price": {
            "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "description": "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.",
            "type": "integer"
          }
        },
        "title": "PortalFlowsSubscriptionUpdateConfirmItem",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_invoice_list": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PortalInvoiceList",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_login_page": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated.",
            "type": "boolean"
          },
          "url": {
            "description": "A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["enabled"],
        "title": "PortalLoginPage",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_payment_method_update": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          }
        },
        "required": ["enabled"],
        "title": "PortalPaymentMethodUpdate",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_resource_schedule_update_at_period_end": {
        "description": "",
        "properties": {
          "conditions": {
            "description": "List of conditions. When any condition is true, an update will be scheduled at the end of the current period.",
            "items": {
              "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end_condition"
            },
            "type": "array"
          }
        },
        "required": ["conditions"],
        "title": "PortalResourceScheduleUpdateAtPeriodEnd",
        "type": "object",
        "x-expandableFields": ["conditions"]
      },
      "portal_resource_schedule_update_at_period_end_condition": {
        "description": "",
        "properties": {
          "type": {
            "description": "The type of condition.",
            "enum": ["decreasing_item_amount", "shortening_interval"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "PortalResourceScheduleUpdateAtPeriodEndCondition",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_subscription_cancel": {
        "description": "",
        "properties": {
          "cancellation_reason": {
            "$ref": "#/components/schemas/portal_subscription_cancellation_reason"
          },
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          },
          "mode": {
            "description": "Whether to cancel subscriptions immediately or at the end of the billing period.",
            "enum": ["at_period_end", "immediately"],
            "type": "string"
          },
          "proration_behavior": {
            "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.",
            "enum": ["always_invoice", "create_prorations", "none"],
            "type": "string"
          }
        },
        "required": [
          "cancellation_reason",
          "enabled",
          "mode",
          "proration_behavior"
        ],
        "title": "PortalSubscriptionCancel",
        "type": "object",
        "x-expandableFields": ["cancellation_reason"]
      },
      "portal_subscription_cancellation_reason": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          },
          "options": {
            "description": "Which cancellation reasons will be given as options to the customer.",
            "items": {
              "enum": [
                "customer_service",
                "low_quality",
                "missing_features",
                "other",
                "switched_service",
                "too_complex",
                "too_expensive",
                "unused"
              ],
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["enabled", "options"],
        "title": "PortalSubscriptionCancellationReason",
        "type": "object",
        "x-expandableFields": []
      },
      "portal_subscription_update": {
        "description": "",
        "properties": {
          "default_allowed_updates": {
            "description": "The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.",
            "items": {
              "enum": ["price", "promotion_code", "quantity"],
              "type": "string"
            },
            "type": "array"
          },
          "enabled": {
            "description": "Whether the feature is enabled.",
            "type": "boolean"
          },
          "products": {
            "description": "The list of up to 10 products that support subscription updates.",
            "items": {
              "$ref": "#/components/schemas/portal_subscription_update_product"
            },
            "nullable": true,
            "type": "array"
          },
          "proration_behavior": {
            "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.",
            "enum": ["always_invoice", "create_prorations", "none"],
            "type": "string"
          },
          "schedule_at_period_end": {
            "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end"
          }
        },
        "required": [
          "default_allowed_updates",
          "enabled",
          "proration_behavior",
          "schedule_at_period_end"
        ],
        "title": "PortalSubscriptionUpdate",
        "type": "object",
        "x-expandableFields": ["products", "schedule_at_period_end"]
      },
      "portal_subscription_update_product": {
        "description": "",
        "properties": {
          "prices": {
            "description": "The list of price IDs which, when subscribed to, a subscription can be updated.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "product": {
            "description": "The product ID.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["prices", "product"],
        "title": "PortalSubscriptionUpdateProduct",
        "type": "object",
        "x-expandableFields": []
      },
      "price": {
        "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).",
        "properties": {
          "active": {
            "description": "Whether the price can be used for new purchases.",
            "type": "boolean"
          },
          "billing_scheme": {
            "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
            "enum": ["per_unit", "tiered"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "currency_options": {
            "additionalProperties": {
              "$ref": "#/components/schemas/currency_option"
            },
            "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
            "type": "object"
          },
          "custom_unit_amount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/custom_unit_amount"
              }
            ],
            "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "lookup_key": {
            "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "nickname": {
            "description": "A brief description of the price, hidden from customers.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["price"],
            "type": "string"
          },
          "product": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/product"
              },
              {
                "$ref": "#/components/schemas/deleted_product"
              }
            ],
            "description": "The ID of the product this price is associated with.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/product"
                },
                {
                  "$ref": "#/components/schemas/deleted_product"
                }
              ]
            }
          },
          "recurring": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/recurring"
              }
            ],
            "description": "The recurring components of a price such as `interval` and `usage_type`.",
            "nullable": true
          },
          "tax_behavior": {
            "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
            "enum": ["exclusive", "inclusive", "unspecified"],
            "nullable": true,
            "type": "string"
          },
          "tiers": {
            "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
            "items": {
              "$ref": "#/components/schemas/price_tier"
            },
            "type": "array"
          },
          "tiers_mode": {
            "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.",
            "enum": ["graduated", "volume"],
            "nullable": true,
            "type": "string"
          },
          "transform_quantity": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/transform_quantity"
              }
            ],
            "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.",
            "nullable": true
          },
          "type": {
            "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.",
            "enum": ["one_time", "recurring"],
            "type": "string"
          },
          "unit_amount": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "active",
          "billing_scheme",
          "created",
          "currency",
          "id",
          "livemode",
          "metadata",
          "object",
          "product",
          "type"
        ],
        "title": "Price",
        "type": "object",
        "x-expandableFields": [
          "currency_options",
          "custom_unit_amount",
          "product",
          "recurring",
          "tiers",
          "transform_quantity"
        ],
        "x-resourceId": "price"
      },
      "price_tier": {
        "description": "",
        "properties": {
          "flat_amount": {
            "description": "Price for the entire tier.",
            "nullable": true,
            "type": "integer"
          },
          "flat_amount_decimal": {
            "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "unit_amount": {
            "description": "Per unit price for units relevant to the tier.",
            "nullable": true,
            "type": "integer"
          },
          "unit_amount_decimal": {
            "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.",
            "format": "decimal",
            "nullable": true,
            "type": "string"
          },
          "up_to": {
            "description": "Up to and including to this quantity will be contained in the tier.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "PriceTier",
        "type": "object",
        "x-expandableFields": []
      },
      "product": {
        "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)",
        "properties": {
          "active": {
            "description": "Whether the product is currently available for purchase.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "default_price": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/price"
              }
            ],
            "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/price"
                }
              ]
            }
          },
          "description": {
            "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "images": {
            "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "marketing_features": {
            "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).",
            "items": {
              "$ref": "#/components/schemas/product_marketing_feature"
            },
            "type": "array"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "The product's name, meant to be displayable to the customer.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["product"],
            "type": "string"
          },
          "package_dimensions": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/package_dimensions"
              }
            ],
            "description": "The dimensions of this product for shipping purposes.",
            "nullable": true
          },
          "shippable": {
            "description": "Whether this product is shipped (i.e., physical goods).",
            "nullable": true,
            "type": "boolean"
          },
          "statement_descriptor": {
            "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/tax_code"
              }
            ],
            "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/tax_code"
                }
              ]
            }
          },
          "unit_label": {
            "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "updated": {
            "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "url": {
            "description": "A URL of a publicly-accessible webpage for this product.",
            "maxLength": 2048,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "active",
          "created",
          "id",
          "images",
          "livemode",
          "marketing_features",
          "metadata",
          "name",
          "object",
          "updated"
        ],
        "title": "Product",
        "type": "object",
        "x-expandableFields": [
          "default_price",
          "marketing_features",
          "package_dimensions",
          "tax_code"
        ],
        "x-resourceId": "product"
      },
      "product_feature": {
        "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.",
        "properties": {
          "entitlement_feature": {
            "$ref": "#/components/schemas/entitlements.feature"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["product_feature"],
            "type": "string"
          }
        },
        "required": ["entitlement_feature", "id", "livemode", "object"],
        "title": "ProductFeature",
        "type": "object",
        "x-expandableFields": ["entitlement_feature"],
        "x-resourceId": "product_feature"
      },
      "product_marketing_feature": {
        "description": "",
        "properties": {
          "name": {
            "description": "The marketing feature name. Up to 80 characters long.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "ProductMarketingFeature",
        "type": "object",
        "x-expandableFields": []
      },
      "promotion_code": {
        "description": "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to\ncreate multiple codes for a single coupon.",
        "properties": {
          "active": {
            "description": "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.",
            "type": "boolean"
          },
          "code": {
            "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).",
            "maxLength": 5000,
            "type": "string"
          },
          "coupon": {
            "$ref": "#/components/schemas/coupon"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The customer that this promotion code can be used by.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "expires_at": {
            "description": "Date at which the promotion code can no longer be redeemed.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "max_redemptions": {
            "description": "Maximum number of times this promotion code can be redeemed.",
            "nullable": true,
            "type": "integer"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["promotion_code"],
            "type": "string"
          },
          "restrictions": {
            "$ref": "#/components/schemas/promotion_codes_resource_restrictions"
          },
          "times_redeemed": {
            "description": "Number of times this promotion code has been used.",
            "type": "integer"
          }
        },
        "required": [
          "active",
          "code",
          "coupon",
          "created",
          "id",
          "livemode",
          "object",
          "restrictions",
          "times_redeemed"
        ],
        "title": "PromotionCode",
        "type": "object",
        "x-expandableFields": ["coupon", "customer", "restrictions"],
        "x-resourceId": "promotion_code"
      },
      "promotion_code_currency_option": {
        "description": "",
        "properties": {
          "minimum_amount": {
            "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).",
            "type": "integer"
          }
        },
        "required": ["minimum_amount"],
        "title": "PromotionCodeCurrencyOption",
        "type": "object",
        "x-expandableFields": []
      },
      "promotion_codes_resource_restrictions": {
        "description": "",
        "properties": {
          "currency_options": {
            "additionalProperties": {
              "$ref": "#/components/schemas/promotion_code_currency_option"
            },
            "description": "Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
            "type": "object"
          },
          "first_time_transaction": {
            "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices",
            "type": "boolean"
          },
          "minimum_amount": {
            "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).",
            "nullable": true,
            "type": "integer"
          },
          "minimum_amount_currency": {
            "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["first_time_transaction"],
        "title": "PromotionCodesResourceRestrictions",
        "type": "object",
        "x-expandableFields": ["currency_options"]
      },
      "quote": {
        "description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.",
        "properties": {
          "amount_subtotal": {
            "description": "Total before any discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total after discounts and taxes are applied.",
            "type": "integer"
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "ID of the Connect Application that created the quote.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "application_fee_amount": {
            "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.",
            "nullable": true,
            "type": "integer"
          },
          "application_fee_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.",
            "nullable": true,
            "type": "number"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/quotes_resource_automatic_tax"
          },
          "collection_method": {
            "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
            "enum": ["charge_automatically", "send_invoice"],
            "type": "string"
          },
          "computed": {
            "$ref": "#/components/schemas/quotes_resource_computed"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "default_tax_rates": {
            "description": "The tax rates applied to this quote.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_rate"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_rate"
                  }
                ]
              }
            },
            "type": "array"
          },
          "description": {
            "description": "A description that will be displayed on the quote PDF.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discounts": {
            "description": "The discounts applied to this quote.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  }
                ]
              }
            },
            "type": "array"
          },
          "expires_at": {
            "description": "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "footer": {
            "description": "A footer that will be displayed on the quote PDF.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "from_quote": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/quotes_resource_from_quote"
              }
            ],
            "description": "Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.",
            "nullable": true
          },
          "header": {
            "description": "A header that will be displayed on the quote PDF.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              },
              {
                "$ref": "#/components/schemas/deleted_invoice"
              }
            ],
            "description": "The invoice that was created from this quote.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                },
                {
                  "$ref": "#/components/schemas/deleted_invoice"
                }
              ]
            }
          },
          "invoice_settings": {
            "$ref": "#/components/schemas/invoice_setting_quote_setting"
          },
          "line_items": {
            "description": "A list of items the customer is being quoted for.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "QuotesResourceListLineItems",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "number": {
            "description": "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["quote"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "status": {
            "description": "The status of the quote.",
            "enum": ["accepted", "canceled", "draft", "open"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "status_transitions": {
            "$ref": "#/components/schemas/quotes_resource_status_transitions"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "The subscription that was created or updated from this quote.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "subscription_data": {
            "$ref": "#/components/schemas/quotes_resource_subscription_data_subscription_data"
          },
          "subscription_schedule": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription_schedule"
              }
            ],
            "description": "The subscription schedule that was created or updated from this quote.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              ]
            }
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this quote belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "total_details": {
            "$ref": "#/components/schemas/quotes_resource_total_details"
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/quotes_resource_transfer_data"
              }
            ],
            "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.",
            "nullable": true
          }
        },
        "required": [
          "amount_subtotal",
          "amount_total",
          "automatic_tax",
          "collection_method",
          "computed",
          "created",
          "discounts",
          "expires_at",
          "id",
          "invoice_settings",
          "livemode",
          "metadata",
          "object",
          "status",
          "status_transitions",
          "subscription_data",
          "total_details"
        ],
        "title": "Quote",
        "type": "object",
        "x-expandableFields": [
          "application",
          "automatic_tax",
          "computed",
          "customer",
          "default_tax_rates",
          "discounts",
          "from_quote",
          "invoice",
          "invoice_settings",
          "line_items",
          "on_behalf_of",
          "status_transitions",
          "subscription",
          "subscription_data",
          "subscription_schedule",
          "test_clock",
          "total_details",
          "transfer_data"
        ],
        "x-resourceId": "quote"
      },
      "quotes_resource_automatic_tax": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Automatically calculate taxes",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          },
          "status": {
            "description": "The status of the most recent automated tax calculation for this quote.",
            "enum": ["complete", "failed", "requires_location_inputs"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["enabled"],
        "title": "QuotesResourceAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "quotes_resource_computed": {
        "description": "",
        "properties": {
          "recurring": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/quotes_resource_recurring"
              }
            ],
            "description": "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.",
            "nullable": true
          },
          "upfront": {
            "$ref": "#/components/schemas/quotes_resource_upfront"
          }
        },
        "required": ["upfront"],
        "title": "QuotesResourceComputed",
        "type": "object",
        "x-expandableFields": ["recurring", "upfront"]
      },
      "quotes_resource_from_quote": {
        "description": "",
        "properties": {
          "is_revision": {
            "description": "Whether this quote is a revision of a different quote.",
            "type": "boolean"
          },
          "quote": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/quote"
              }
            ],
            "description": "The quote that was cloned.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/quote"
                }
              ]
            }
          }
        },
        "required": ["is_revision", "quote"],
        "title": "QuotesResourceFromQuote",
        "type": "object",
        "x-expandableFields": ["quote"]
      },
      "quotes_resource_recurring": {
        "description": "",
        "properties": {
          "amount_subtotal": {
            "description": "Total before any discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total after discounts and taxes are applied.",
            "type": "integer"
          },
          "interval": {
            "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.",
            "enum": ["day", "month", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.",
            "type": "integer"
          },
          "total_details": {
            "$ref": "#/components/schemas/quotes_resource_total_details"
          }
        },
        "required": [
          "amount_subtotal",
          "amount_total",
          "interval",
          "interval_count",
          "total_details"
        ],
        "title": "QuotesResourceRecurring",
        "type": "object",
        "x-expandableFields": ["total_details"]
      },
      "quotes_resource_status_transitions": {
        "description": "",
        "properties": {
          "accepted_at": {
            "description": "The time that the quote was accepted. Measured in seconds since Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "canceled_at": {
            "description": "The time that the quote was canceled. Measured in seconds since Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "finalized_at": {
            "description": "The time that the quote was finalized. Measured in seconds since Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "QuotesResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "quotes_resource_subscription_data_subscription_data": {
        "description": "",
        "properties": {
          "description": {
            "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "effective_date": {
            "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
            "nullable": true,
            "type": "object"
          },
          "trial_period_days": {
            "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "QuotesResourceSubscriptionDataSubscriptionData",
        "type": "object",
        "x-expandableFields": []
      },
      "quotes_resource_total_details": {
        "description": "",
        "properties": {
          "amount_discount": {
            "description": "This is the sum of all the discounts.",
            "type": "integer"
          },
          "amount_shipping": {
            "description": "This is the sum of all the shipping amounts.",
            "nullable": true,
            "type": "integer"
          },
          "amount_tax": {
            "description": "This is the sum of all the tax amounts.",
            "type": "integer"
          },
          "breakdown": {
            "$ref": "#/components/schemas/quotes_resource_total_details_resource_breakdown"
          }
        },
        "required": ["amount_discount", "amount_tax"],
        "title": "QuotesResourceTotalDetails",
        "type": "object",
        "x-expandableFields": ["breakdown"]
      },
      "quotes_resource_total_details_resource_breakdown": {
        "description": "",
        "properties": {
          "discounts": {
            "description": "The aggregated discounts.",
            "items": {
              "$ref": "#/components/schemas/line_items_discount_amount"
            },
            "type": "array"
          },
          "taxes": {
            "description": "The aggregated tax amounts by rate.",
            "items": {
              "$ref": "#/components/schemas/line_items_tax_amount"
            },
            "type": "array"
          }
        },
        "required": ["discounts", "taxes"],
        "title": "QuotesResourceTotalDetailsResourceBreakdown",
        "type": "object",
        "x-expandableFields": ["discounts", "taxes"]
      },
      "quotes_resource_transfer_data": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.",
            "nullable": true,
            "type": "integer"
          },
          "amount_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.",
            "nullable": true,
            "type": "number"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account where funds from the payment will be transferred to upon payment success.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "QuotesResourceTransferData",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "quotes_resource_upfront": {
        "description": "",
        "properties": {
          "amount_subtotal": {
            "description": "Total before any discounts or taxes are applied.",
            "type": "integer"
          },
          "amount_total": {
            "description": "Total after discounts and taxes are applied.",
            "type": "integer"
          },
          "line_items": {
            "description": "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "QuotesResourceListLineItems",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "total_details": {
            "$ref": "#/components/schemas/quotes_resource_total_details"
          }
        },
        "required": ["amount_subtotal", "amount_total", "total_details"],
        "title": "QuotesResourceUpfront",
        "type": "object",
        "x-expandableFields": ["line_items", "total_details"]
      },
      "radar.early_fraud_warning": {
        "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)",
        "properties": {
          "actionable": {
            "description": "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.",
            "type": "boolean"
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the charge this early fraud warning is for, optionally expanded.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "fraud_type": {
            "description": "The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["radar.early_fraud_warning"],
            "type": "string"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "ID of the Payment Intent this early fraud warning is for, optionally expanded.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          }
        },
        "required": [
          "actionable",
          "charge",
          "created",
          "fraud_type",
          "id",
          "livemode",
          "object"
        ],
        "title": "RadarEarlyFraudWarning",
        "type": "object",
        "x-expandableFields": ["charge", "payment_intent"],
        "x-resourceId": "radar.early_fraud_warning"
      },
      "radar.value_list": {
        "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)",
        "properties": {
          "alias": {
            "description": "The name of the value list for use in rules.",
            "maxLength": 5000,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "created_by": {
            "description": "The name or email address of the user who created this value list.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "item_type": {
            "description": "The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`.",
            "enum": [
              "card_bin",
              "card_fingerprint",
              "case_sensitive_string",
              "country",
              "customer_id",
              "email",
              "ip_address",
              "sepa_debit_fingerprint",
              "string",
              "us_bank_account_fingerprint"
            ],
            "type": "string"
          },
          "list_items": {
            "description": "List of items contained within this value list.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/radar.value_list_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "RadarListListItemList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "name": {
            "description": "The name of the value list.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["radar.value_list"],
            "type": "string"
          }
        },
        "required": [
          "alias",
          "created",
          "created_by",
          "id",
          "item_type",
          "list_items",
          "livemode",
          "metadata",
          "name",
          "object"
        ],
        "title": "RadarListList",
        "type": "object",
        "x-expandableFields": ["list_items"],
        "x-resourceId": "radar.value_list"
      },
      "radar.value_list_item": {
        "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "created_by": {
            "description": "The name or email address of the user who added this item to the value list.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["radar.value_list_item"],
            "type": "string"
          },
          "value": {
            "description": "The value of the item.",
            "maxLength": 5000,
            "type": "string"
          },
          "value_list": {
            "description": "The identifier of the value list this item belongs to.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "created_by",
          "id",
          "livemode",
          "object",
          "value",
          "value_list"
        ],
        "title": "RadarListListItem",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "radar.value_list_item"
      },
      "radar_radar_options": {
        "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
        "properties": {
          "session": {
            "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "RadarRadarOptions",
        "type": "object",
        "x-expandableFields": []
      },
      "radar_review_resource_location": {
        "description": "",
        "properties": {
          "city": {
            "description": "The city where the payment originated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter ISO code representing the country where the payment originated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "latitude": {
            "description": "The geographic latitude where the payment originated.",
            "nullable": true,
            "type": "number"
          },
          "longitude": {
            "description": "The geographic longitude where the payment originated.",
            "nullable": true,
            "type": "number"
          },
          "region": {
            "description": "The state/county/province/region where the payment originated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "RadarReviewResourceLocation",
        "type": "object",
        "x-expandableFields": []
      },
      "radar_review_resource_session": {
        "description": "",
        "properties": {
          "browser": {
            "description": "The browser used in this browser session (e.g., `Chrome`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "device": {
            "description": "Information about the device used for the browser session (e.g., `Samsung SM-G930T`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "platform": {
            "description": "The platform for the browser session (e.g., `Macintosh`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "version": {
            "description": "The version for the browser session (e.g., `61.0.3163.100`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "RadarReviewResourceSession",
        "type": "object",
        "x-expandableFields": []
      },
      "received_payment_method_details_financial_account": {
        "description": "",
        "properties": {
          "id": {
            "description": "The FinancialAccount ID.",
            "maxLength": 5000,
            "type": "string"
          },
          "network": {
            "description": "The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.",
            "enum": ["stripe"],
            "type": "string"
          }
        },
        "required": ["id", "network"],
        "title": "received_payment_method_details_financial_account",
        "type": "object",
        "x-expandableFields": []
      },
      "recurring": {
        "description": "",
        "properties": {
          "aggregate_usage": {
            "description": "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.",
            "enum": ["last_during_period", "last_ever", "max", "sum"],
            "nullable": true,
            "type": "string"
          },
          "interval": {
            "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.",
            "enum": ["day", "month", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.",
            "type": "integer"
          },
          "meter": {
            "description": "The meter tracking the usage of a metered price",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "usage_type": {
            "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.",
            "enum": ["licensed", "metered"],
            "type": "string"
          }
        },
        "required": ["interval", "interval_count", "usage_type"],
        "title": "Recurring",
        "type": "object",
        "x-expandableFields": []
      },
      "refund": {
        "description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)",
        "properties": {
          "amount": {
            "description": "Amount, in cents (or local equivalent).",
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "Balance transaction that describes the impact on your account balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the charge that's refunded.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).",
            "maxLength": 5000,
            "type": "string"
          },
          "destination_details": {
            "$ref": "#/components/schemas/refund_destination_details"
          },
          "failure_balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "failure_reason": {
            "description": "Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "instructions_email": {
            "description": "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "next_action": {
            "$ref": "#/components/schemas/refund_next_action"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["refund"],
            "type": "string"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "ID of the PaymentIntent that's refunded.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "reason": {
            "description": "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).",
            "enum": [
              "duplicate",
              "expired_uncaptured_charge",
              "fraudulent",
              "requested_by_customer"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "receipt_number": {
            "description": "This is the transaction number that appears on email receipts sent for this refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "source_transfer_reversal": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/transfer_reversal"
              }
            ],
            "description": "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              ]
            }
          },
          "status": {
            "description": "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "transfer_reversal": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/transfer_reversal"
              }
            ],
            "description": "This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              ]
            }
          }
        },
        "required": ["amount", "created", "currency", "id", "object"],
        "title": "Refund",
        "type": "object",
        "x-expandableFields": [
          "balance_transaction",
          "charge",
          "destination_details",
          "failure_balance_transaction",
          "next_action",
          "payment_intent",
          "source_transfer_reversal",
          "transfer_reversal"
        ],
        "x-resourceId": "refund"
      },
      "refund_destination_details": {
        "description": "",
        "properties": {
          "affirm": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "afterpay_clearpay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "alipay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "alma": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "au_bank_transfer": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "blik": {
            "$ref": "#/components/schemas/refund_destination_details_blik"
          },
          "br_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_br_bank_transfer"
          },
          "card": {
            "$ref": "#/components/schemas/refund_destination_details_card"
          },
          "cashapp": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "customer_cash_balance": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "eps": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "eu_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_eu_bank_transfer"
          },
          "gb_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_gb_bank_transfer"
          },
          "giropay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "grabpay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "jp_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_jp_bank_transfer"
          },
          "klarna": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "multibanco": {
            "$ref": "#/components/schemas/refund_destination_details_multibanco"
          },
          "mx_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_mx_bank_transfer"
          },
          "p24": {
            "$ref": "#/components/schemas/refund_destination_details_p24"
          },
          "paynow": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "paypal": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "pix": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "revolut": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "sofort": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "swish": {
            "$ref": "#/components/schemas/refund_destination_details_swish"
          },
          "th_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_th_bank_transfer"
          },
          "type": {
            "description": "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.",
            "maxLength": 5000,
            "type": "string"
          },
          "us_bank_transfer": {
            "$ref": "#/components/schemas/refund_destination_details_us_bank_transfer"
          },
          "wechat_pay": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          },
          "zip": {
            "$ref": "#/components/schemas/destination_details_unimplemented"
          }
        },
        "required": ["type"],
        "title": "refund_destination_details",
        "type": "object",
        "x-expandableFields": [
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_bank_transfer",
          "blik",
          "br_bank_transfer",
          "card",
          "cashapp",
          "customer_cash_balance",
          "eps",
          "eu_bank_transfer",
          "gb_bank_transfer",
          "giropay",
          "grabpay",
          "jp_bank_transfer",
          "klarna",
          "multibanco",
          "mx_bank_transfer",
          "p24",
          "paynow",
          "paypal",
          "pix",
          "revolut",
          "sofort",
          "swish",
          "th_bank_transfer",
          "us_bank_transfer",
          "wechat_pay",
          "zip"
        ]
      },
      "refund_destination_details_blik": {
        "description": "",
        "properties": {
          "network_decline_code": {
            "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_blik",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_br_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_br_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_card": {
        "description": "",
        "properties": {
          "reference": {
            "description": "Value of the reference number assigned to the refund.",
            "maxLength": 5000,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "type": "string"
          },
          "reference_type": {
            "description": "Type of the reference number assigned to the refund.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The type of refund. This can be `refund`, `reversal`, or `pending`.",
            "enum": ["pending", "refund", "reversal"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "refund_destination_details_card",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_eu_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_eu_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_gb_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_gb_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_jp_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_jp_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_multibanco": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_multibanco",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_mx_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_mx_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_p24": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_p24",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_swish": {
        "description": "",
        "properties": {
          "network_decline_code": {
            "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_swish",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_th_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_th_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_destination_details_us_bank_transfer": {
        "description": "",
        "properties": {
          "reference": {
            "description": "The reference assigned to the refund.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "reference_status": {
            "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "refund_destination_details_us_bank_transfer",
        "type": "object",
        "x-expandableFields": []
      },
      "refund_next_action": {
        "description": "",
        "properties": {
          "display_details": {
            "$ref": "#/components/schemas/refund_next_action_display_details"
          },
          "type": {
            "description": "Type of the next action to perform.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "RefundNextAction",
        "type": "object",
        "x-expandableFields": ["display_details"]
      },
      "refund_next_action_display_details": {
        "description": "",
        "properties": {
          "email_sent": {
            "$ref": "#/components/schemas/email_sent"
          },
          "expires_at": {
            "description": "The expiry timestamp.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": ["email_sent", "expires_at"],
        "title": "RefundNextActionDisplayDetails",
        "type": "object",
        "x-expandableFields": ["email_sent"]
      },
      "reporting.report_run": {
        "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "error": {
            "description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "`true` if the report is run on live mode data and `false` if it is run on test mode data.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["reporting.report_run"],
            "type": "string"
          },
          "parameters": {
            "$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters"
          },
          "report_type": {
            "description": "The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.",
            "maxLength": 5000,
            "type": "string"
          },
          "result": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The file object representing the result of the report run (populated when\n `status=succeeded`).",
            "nullable": true
          },
          "status": {
            "description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.",
            "maxLength": 5000,
            "type": "string"
          },
          "succeeded_at": {
            "description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "parameters",
          "report_type",
          "status"
        ],
        "title": "reporting_report_run",
        "type": "object",
        "x-expandableFields": ["parameters", "result"],
        "x-resourceId": "reporting.report_run"
      },
      "reporting.report_type": {
        "description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).",
        "properties": {
          "data_available_end": {
            "description": "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "data_available_start": {
            "description": "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "default_columns": {
            "description": "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "id": {
            "description": "The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "name": {
            "description": "Human-readable name of the Report Type",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["reporting.report_type"],
            "type": "string"
          },
          "updated": {
            "description": "When this Report Type was latest updated. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "version": {
            "description": "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.",
            "type": "integer"
          }
        },
        "required": [
          "data_available_end",
          "data_available_start",
          "id",
          "livemode",
          "name",
          "object",
          "updated",
          "version"
        ],
        "title": "reporting_report_type",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "reporting.report_type"
      },
      "reserve_transaction": {
        "description": "",
        "properties": {
          "amount": {
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["reserve_transaction"],
            "type": "string"
          }
        },
        "required": ["amount", "currency", "id", "object"],
        "title": "ReserveTransaction",
        "type": "object",
        "x-expandableFields": []
      },
      "review": {
        "description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews).",
        "properties": {
          "billing_zip": {
            "description": "The ZIP or postal code of the card used, if applicable.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "The charge associated with this review.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "closed_reason": {
            "description": "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.",
            "enum": [
              "approved",
              "disputed",
              "redacted",
              "refunded",
              "refunded_as_fraud"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "ip_address": {
            "description": "The IP address where the payment originated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "ip_address_location": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/radar_review_resource_location"
              }
            ],
            "description": "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.",
            "nullable": true
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["review"],
            "type": "string"
          },
          "open": {
            "description": "If `true`, the review needs action.",
            "type": "boolean"
          },
          "opened_reason": {
            "description": "The reason the review was opened. One of `rule` or `manual`.",
            "enum": ["manual", "rule"],
            "type": "string"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "The PaymentIntent ID associated with this review, if one exists.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "reason": {
            "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.",
            "maxLength": 5000,
            "type": "string"
          },
          "session": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/radar_review_resource_session"
              }
            ],
            "description": "Information related to the browsing session of the user who initiated the payment.",
            "nullable": true
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "open",
          "opened_reason",
          "reason"
        ],
        "title": "RadarReview",
        "type": "object",
        "x-expandableFields": [
          "charge",
          "ip_address_location",
          "payment_intent",
          "session"
        ],
        "x-resourceId": "review"
      },
      "revolut_pay_underlying_payment_method_funding_details": {
        "description": "",
        "properties": {
          "card": {
            "$ref": "#/components/schemas/payment_method_details_passthrough_card"
          },
          "type": {
            "description": "funding type of the underlying payment method.",
            "enum": ["card"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "revolut_pay_underlying_payment_method_funding_details",
        "type": "object",
        "x-expandableFields": ["card"]
      },
      "rule": {
        "description": "",
        "properties": {
          "action": {
            "description": "The action taken on the payment.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "predicate": {
            "description": "The predicate to evaluate the payment against.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["action", "id", "predicate"],
        "title": "RadarRule",
        "type": "object",
        "x-expandableFields": []
      },
      "scheduled_query_run": {
        "description": "If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "data_load_time": {
            "description": "When the query was run, Sigma contained a snapshot of your Stripe data at this time.",
            "format": "unix-time",
            "type": "integer"
          },
          "error": {
            "$ref": "#/components/schemas/sigma_scheduled_query_run_error"
          },
          "file": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "The file object representing the results of the query.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["scheduled_query_run"],
            "type": "string"
          },
          "result_available_until": {
            "description": "Time at which the result expires and is no longer available for download.",
            "format": "unix-time",
            "type": "integer"
          },
          "sql": {
            "description": "SQL for the query.",
            "maxLength": 100000,
            "type": "string"
          },
          "status": {
            "description": "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.",
            "maxLength": 5000,
            "type": "string"
          },
          "title": {
            "description": "Title of the query.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "data_load_time",
          "id",
          "livemode",
          "object",
          "result_available_until",
          "sql",
          "status",
          "title"
        ],
        "title": "ScheduledQueryRun",
        "type": "object",
        "x-expandableFields": ["error", "file"],
        "x-resourceId": "scheduled_query_run"
      },
      "schedules_phase_automatic_tax": {
        "description": "",
        "properties": {
          "disabled_reason": {
            "description": "If Stripe disabled automatic tax, this enum describes why.",
            "enum": ["requires_location_inputs"],
            "nullable": true,
            "type": "string"
          },
          "enabled": {
            "description": "Whether Stripe automatically computes tax on invoices created during this phase.",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "SchedulesPhaseAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "secret_service_resource_scope": {
        "description": "",
        "properties": {
          "type": {
            "description": "The secret scope type.",
            "enum": ["account", "user"],
            "type": "string"
          },
          "user": {
            "description": "The user ID, if type is set to \"user\"",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "SecretServiceResourceScope",
        "type": "object",
        "x-expandableFields": []
      },
      "sepa_debit_generated_from": {
        "description": "",
        "properties": {
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "The ID of the Charge that generated this PaymentMethod, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "setup_attempt": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_attempt"
              }
            ],
            "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_attempt"
                }
              ]
            }
          }
        },
        "title": "sepa_debit_generated_from",
        "type": "object",
        "x-expandableFields": ["charge", "setup_attempt"]
      },
      "setup_attempt": {
        "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.",
        "properties": {
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "attach_to_self": {
            "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "flow_directions": {
            "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.",
            "items": {
              "enum": ["inbound", "outbound"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["setup_attempt"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the payment method used with this SetupAttempt.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "payment_method_details": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details"
          },
          "setup_error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/api_errors"
              }
            ],
            "description": "The error encountered during this attempt to confirm the SetupIntent, if any.",
            "nullable": true
          },
          "setup_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_intent"
              }
            ],
            "description": "ID of the SetupIntent that this attempt belongs to.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_intent"
                }
              ]
            }
          },
          "status": {
            "description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.",
            "maxLength": 5000,
            "type": "string"
          },
          "usage": {
            "description": "The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "payment_method",
          "payment_method_details",
          "setup_intent",
          "status",
          "usage"
        ],
        "title": "PaymentFlowsSetupIntentSetupAttempt",
        "type": "object",
        "x-expandableFields": [
          "application",
          "customer",
          "on_behalf_of",
          "payment_method",
          "payment_method_details",
          "setup_error",
          "setup_intent"
        ],
        "x-resourceId": "setup_attempt"
      },
      "setup_attempt_payment_method_details": {
        "description": "",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit"
          },
          "amazon_pay": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_bacs_debit"
          },
          "bancontact": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact"
          },
          "boleto": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto"
          },
          "card": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_card"
          },
          "card_present": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_present"
          },
          "cashapp": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_cashapp"
          },
          "ideal": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal"
          },
          "kakao_pay": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay"
          },
          "klarna": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna"
          },
          "kr_card": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card"
          },
          "link": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_link"
          },
          "paypal": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal"
          },
          "revolut_pay": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit"
          },
          "sofort": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_sofort"
          },
          "type": {
            "description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.",
            "maxLength": 5000,
            "type": "string"
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/setup_attempt_payment_method_details_us_bank_account"
          }
        },
        "required": ["type"],
        "title": "SetupAttemptPaymentMethodDetails",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "boleto",
          "card",
          "card_present",
          "cashapp",
          "ideal",
          "kakao_pay",
          "klarna",
          "kr_card",
          "link",
          "paypal",
          "revolut_pay",
          "sepa_debit",
          "sofort",
          "us_bank_account"
        ]
      },
      "setup_attempt_payment_method_details_acss_debit": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_amazon_pay": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_amazon_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_au_becs_debit": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_au_becs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_bacs_debit": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_bancontact": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "Bank Identifier Code of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`",
            "enum": ["de", "en", "fr", "nl"],
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_attempt_payment_method_details_bancontact",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "setup_attempt_payment_method_details_boleto": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_boleto",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_card": {
        "description": "",
        "properties": {
          "brand": {
            "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "checks": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks"
              }
            ],
            "description": "Check results by Card networks on Card address and CVC at the time of authorization",
            "nullable": true
          },
          "country": {
            "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "description": "Two-digit number representing the card's expiration month.",
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "description": "Four-digit number representing the card's expiration year.",
            "nullable": true,
            "type": "integer"
          },
          "fingerprint": {
            "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "funding": {
            "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "network": {
            "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "three_d_secure": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/three_d_secure_details"
              }
            ],
            "description": "Populated if this authorization used 3D Secure authentication.",
            "nullable": true
          },
          "wallet": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet"
              }
            ],
            "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
            "nullable": true
          }
        },
        "title": "setup_attempt_payment_method_details_card",
        "type": "object",
        "x-expandableFields": ["checks", "three_d_secure", "wallet"]
      },
      "setup_attempt_payment_method_details_card_checks": {
        "description": "",
        "properties": {
          "address_line1_check": {
            "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "address_postal_code_check": {
            "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "cvc_check": {
            "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_attempt_payment_method_details_card_checks",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_card_present": {
        "description": "",
        "properties": {
          "generated_card": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "offline": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_details_card_present_offline"
              }
            ],
            "description": "Details about payments collected offline.",
            "nullable": true
          }
        },
        "title": "setup_attempt_payment_method_details_card_present",
        "type": "object",
        "x-expandableFields": ["generated_card", "offline"]
      },
      "setup_attempt_payment_method_details_card_wallet": {
        "description": "",
        "properties": {
          "apple_pay": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
          },
          "google_pay": {
            "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
          },
          "type": {
            "description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
            "enum": ["apple_pay", "google_pay", "link"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "setup_attempt_payment_method_details_card_wallet",
        "type": "object",
        "x-expandableFields": ["apple_pay", "google_pay"]
      },
      "setup_attempt_payment_method_details_cashapp": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_cashapp",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_ideal": {
        "description": "",
        "properties": {
          "bank": {
            "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
            "enum": [
              "abn_amro",
              "asn_bank",
              "bunq",
              "handelsbanken",
              "ing",
              "knab",
              "moneyou",
              "n26",
              "nn",
              "rabobank",
              "regiobank",
              "revolut",
              "sns_bank",
              "triodos_bank",
              "van_lanschot",
              "yoursafe"
            ],
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "The Bank Identifier Code of the customer's bank.",
            "enum": [
              "ABNANL2A",
              "ASNBNL21",
              "BITSNL2A",
              "BUNQNL2A",
              "FVLBNL22",
              "HANDNL2A",
              "INGBNL2A",
              "KNABNL2H",
              "MOYONL21",
              "NNBANL2G",
              "NTSBDEB1",
              "RABONL2U",
              "RBRBNL21",
              "REVOIE23",
              "REVOLT21",
              "SNSBNL2A",
              "TRIONL2U"
            ],
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_attempt_payment_method_details_ideal",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "setup_attempt_payment_method_details_kakao_pay": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_kakao_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_klarna": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_klarna",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_kr_card": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_kr_card",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_link": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_link",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_paypal": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_paypal",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_revolut_pay": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_revolut_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_sepa_debit": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_attempt_payment_method_details_sofort": {
        "description": "",
        "properties": {
          "bank_code": {
            "description": "Bank code of bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "description": "Bank Identifier Code of the bank associated with the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "generated_sepa_debit": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "generated_sepa_debit_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "iban_last4": {
            "description": "Last four characters of the IBAN.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`",
            "enum": ["de", "en", "fr", "nl"],
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_attempt_payment_method_details_sofort",
        "type": "object",
        "x-expandableFields": [
          "generated_sepa_debit",
          "generated_sepa_debit_mandate"
        ]
      },
      "setup_attempt_payment_method_details_us_bank_account": {
        "description": "",
        "properties": {},
        "title": "setup_attempt_payment_method_details_us_bank_account",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent": {
        "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)",
        "properties": {
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "ID of the Connect application that created the SetupIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "attach_to_self": {
            "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.",
            "type": "boolean"
          },
          "automatic_payment_methods": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent"
              }
            ],
            "description": "Settings for dynamic payment methods compatible with this Setup Intent",
            "nullable": true
          },
          "cancellation_reason": {
            "description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.",
            "enum": ["abandoned", "duplicate", "requested_by_customer"],
            "nullable": true,
            "type": "string"
          },
          "client_secret": {
            "description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "flow_directions": {
            "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.",
            "items": {
              "enum": ["inbound", "outbound"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "last_setup_error": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/api_errors"
              }
            ],
            "description": "The error encountered in the previous SetupIntent confirmation.",
            "nullable": true
          },
          "latest_attempt": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_attempt"
              }
            ],
            "description": "The most recent SetupAttempt for this SetupIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_attempt"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the multi use Mandate generated by the SetupIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "next_action": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_next_action"
              }
            ],
            "description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup.",
            "nullable": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["setup_intent"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) for which the setup is intended.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "payment_method_configuration_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
              }
            ],
            "description": "Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.",
            "nullable": true
          },
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options"
              }
            ],
            "description": "Payment method-specific configuration for this SetupIntent.",
            "nullable": true
          },
          "payment_method_types": {
            "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "single_use_mandate": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/mandate"
              }
            ],
            "description": "ID of the single_use Mandate generated by the SetupIntent.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/mandate"
                }
              ]
            }
          },
          "status": {
            "description": "[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.",
            "enum": [
              "canceled",
              "processing",
              "requires_action",
              "requires_confirmation",
              "requires_payment_method",
              "succeeded"
            ],
            "type": "string"
          },
          "usage": {
            "description": "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "payment_method_types",
          "status",
          "usage"
        ],
        "title": "SetupIntent",
        "type": "object",
        "x-expandableFields": [
          "application",
          "automatic_payment_methods",
          "customer",
          "last_setup_error",
          "latest_attempt",
          "mandate",
          "next_action",
          "on_behalf_of",
          "payment_method",
          "payment_method_configuration_details",
          "payment_method_options",
          "single_use_mandate"
        ],
        "x-resourceId": "setup_intent"
      },
      "setup_intent_next_action": {
        "description": "",
        "properties": {
          "cashapp_handle_redirect_or_display_qr_code": {
            "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
          },
          "redirect_to_url": {
            "$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url"
          },
          "type": {
            "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.",
            "maxLength": 5000,
            "type": "string"
          },
          "use_stripe_sdk": {
            "description": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.",
            "type": "object"
          },
          "verify_with_microdeposits": {
            "$ref": "#/components/schemas/setup_intent_next_action_verify_with_microdeposits"
          }
        },
        "required": ["type"],
        "title": "SetupIntentNextAction",
        "type": "object",
        "x-expandableFields": [
          "cashapp_handle_redirect_or_display_qr_code",
          "redirect_to_url",
          "verify_with_microdeposits"
        ]
      },
      "setup_intent_next_action_redirect_to_url": {
        "description": "",
        "properties": {
          "return_url": {
            "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "url": {
            "description": "The URL you must redirect your customer to in order to authenticate.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "SetupIntentNextActionRedirectToUrl",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_next_action_verify_with_microdeposits": {
        "description": "",
        "properties": {
          "arrival_date": {
            "description": "The timestamp when the microdeposits are expected to land.",
            "format": "unix-time",
            "type": "integer"
          },
          "hosted_verification_url": {
            "description": "The URL for the hosted verification page, which allows customers to verify their bank account.",
            "maxLength": 5000,
            "type": "string"
          },
          "microdeposit_type": {
            "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.",
            "enum": ["amounts", "descriptor_code"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["arrival_date", "hosted_verification_url"],
        "title": "SetupIntentNextActionVerifyWithMicrodeposits",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options": {
        "description": "",
        "properties": {
          "acss_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "amazon_pay": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "bacs_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_card"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "card_present": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "link": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_link"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "paypal": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_paypal"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "sepa_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          },
          "us_bank_account": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account"
              },
              {
                "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
              }
            ]
          }
        },
        "title": "SetupIntentPaymentMethodOptions",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "amazon_pay",
          "bacs_debit",
          "card",
          "card_present",
          "link",
          "paypal",
          "sepa_debit",
          "us_bank_account"
        ]
      },
      "setup_intent_payment_method_options_acss_debit": {
        "description": "",
        "properties": {
          "currency": {
            "description": "Currency supported by the bank account",
            "enum": ["cad", "usd"],
            "nullable": true,
            "type": "string"
          },
          "mandate_options": {
            "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "setup_intent_payment_method_options_acss_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "setup_intent_payment_method_options_amazon_pay": {
        "description": "",
        "properties": {},
        "title": "setup_intent_payment_method_options_amazon_pay",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_bacs_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit"
          }
        },
        "title": "setup_intent_payment_method_options_bacs_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "setup_intent_payment_method_options_card": {
        "description": "",
        "properties": {
          "mandate_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/setup_intent_payment_method_options_card_mandate_options"
              }
            ],
            "description": "Configuration options for setting up an eMandate for cards issued in India.",
            "nullable": true
          },
          "network": {
            "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.",
            "enum": [
              "amex",
              "cartes_bancaires",
              "diners",
              "discover",
              "eftpos_au",
              "girocard",
              "interac",
              "jcb",
              "link",
              "mastercard",
              "unionpay",
              "unknown",
              "visa"
            ],
            "nullable": true,
            "type": "string"
          },
          "request_three_d_secure": {
            "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
            "enum": ["any", "automatic", "challenge"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "setup_intent_payment_method_options_card",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "setup_intent_payment_method_options_card_mandate_options": {
        "description": "",
        "properties": {
          "amount": {
            "description": "Amount to be charged for future payments.",
            "type": "integer"
          },
          "amount_type": {
            "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.",
            "enum": ["fixed", "maximum"],
            "type": "string"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
            "maxLength": 200,
            "nullable": true,
            "type": "string"
          },
          "end_date": {
            "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "interval": {
            "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
            "enum": ["day", "month", "sporadic", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.",
            "nullable": true,
            "type": "integer"
          },
          "reference": {
            "description": "Unique identifier for the mandate or subscription.",
            "maxLength": 80,
            "type": "string"
          },
          "start_date": {
            "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
            "format": "unix-time",
            "type": "integer"
          },
          "supported_types": {
            "description": "Specifies the type of mandates supported. Possible values are `india`.",
            "items": {
              "enum": ["india"],
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "required": [
          "amount",
          "amount_type",
          "currency",
          "interval",
          "reference",
          "start_date"
        ],
        "title": "setup_intent_payment_method_options_card_mandate_options",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_card_present": {
        "description": "",
        "properties": {},
        "title": "setup_intent_payment_method_options_card_present",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_link": {
        "description": "",
        "properties": {},
        "title": "setup_intent_payment_method_options_link",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_mandate_options_acss_debit": {
        "description": "",
        "properties": {
          "custom_mandate_url": {
            "description": "A URL for custom mandate text",
            "maxLength": 5000,
            "type": "string"
          },
          "default_for": {
            "description": "List of Stripe products where this mandate can be selected automatically.",
            "items": {
              "enum": ["invoice", "subscription"],
              "type": "string"
            },
            "type": "array"
          },
          "interval_description": {
            "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payment_schedule": {
            "description": "Payment schedule for the mandate.",
            "enum": ["combined", "interval", "sporadic"],
            "nullable": true,
            "type": "string"
          },
          "transaction_type": {
            "description": "Transaction type of the mandate.",
            "enum": ["business", "personal"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_intent_payment_method_options_mandate_options_acss_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_mandate_options_bacs_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "setup_intent_payment_method_options_mandate_options_bacs_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_mandate_options_sepa_debit": {
        "description": "",
        "properties": {
          "reference_prefix": {
            "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "setup_intent_payment_method_options_mandate_options_sepa_debit",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_paypal": {
        "description": "",
        "properties": {
          "billing_agreement_id": {
            "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "setup_intent_payment_method_options_paypal",
        "type": "object",
        "x-expandableFields": []
      },
      "setup_intent_payment_method_options_sepa_debit": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit"
          }
        },
        "title": "setup_intent_payment_method_options_sepa_debit",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "setup_intent_payment_method_options_us_bank_account": {
        "description": "",
        "properties": {
          "financial_connections": {
            "$ref": "#/components/schemas/linked_account_options_us_bank_account"
          },
          "mandate_options": {
            "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
          },
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "setup_intent_payment_method_options_us_bank_account",
        "type": "object",
        "x-expandableFields": ["financial_connections", "mandate_options"]
      },
      "setup_intent_type_specific_payment_method_options_client": {
        "description": "",
        "properties": {
          "verification_method": {
            "description": "Bank account verification method.",
            "enum": ["automatic", "instant", "microdeposits"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
        "type": "object",
        "x-expandableFields": []
      },
      "shipping": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "carrier": {
            "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Recipient name.",
            "maxLength": 5000,
            "type": "string"
          },
          "phone": {
            "description": "Recipient phone (including extension).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tracking_number": {
            "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "Shipping",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "shipping_rate": {
        "description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).",
        "properties": {
          "active": {
            "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "delivery_estimate": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping_rate_delivery_estimate"
              }
            ],
            "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
            "nullable": true
          },
          "display_name": {
            "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "fixed_amount": {
            "$ref": "#/components/schemas/shipping_rate_fixed_amount"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["shipping_rate"],
            "type": "string"
          },
          "tax_behavior": {
            "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
            "enum": ["exclusive", "inclusive", "unspecified"],
            "nullable": true,
            "type": "string"
          },
          "tax_code": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/tax_code"
              }
            ],
            "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/tax_code"
                }
              ]
            }
          },
          "type": {
            "description": "The type of calculation to use on the shipping rate.",
            "enum": ["fixed_amount"],
            "type": "string"
          }
        },
        "required": [
          "active",
          "created",
          "id",
          "livemode",
          "metadata",
          "object",
          "type"
        ],
        "title": "ShippingRate",
        "type": "object",
        "x-expandableFields": ["delivery_estimate", "fixed_amount", "tax_code"],
        "x-resourceId": "shipping_rate"
      },
      "shipping_rate_currency_option": {
        "description": "",
        "properties": {
          "amount": {
            "description": "A non-negative integer in cents representing how much to charge.",
            "type": "integer"
          },
          "tax_behavior": {
            "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
            "enum": ["exclusive", "inclusive", "unspecified"],
            "type": "string"
          }
        },
        "required": ["amount", "tax_behavior"],
        "title": "ShippingRateCurrencyOption",
        "type": "object",
        "x-expandableFields": []
      },
      "shipping_rate_delivery_estimate": {
        "description": "",
        "properties": {
          "maximum": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
              }
            ],
            "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.",
            "nullable": true
          },
          "minimum": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
              }
            ],
            "description": "The lower bound of the estimated range. If empty, represents no lower bound.",
            "nullable": true
          }
        },
        "title": "ShippingRateDeliveryEstimate",
        "type": "object",
        "x-expandableFields": ["maximum", "minimum"]
      },
      "shipping_rate_delivery_estimate_bound": {
        "description": "",
        "properties": {
          "unit": {
            "description": "A unit of time.",
            "enum": ["business_day", "day", "hour", "month", "week"],
            "type": "string"
          },
          "value": {
            "description": "Must be greater than 0.",
            "type": "integer"
          }
        },
        "required": ["unit", "value"],
        "title": "ShippingRateDeliveryEstimateBound",
        "type": "object",
        "x-expandableFields": []
      },
      "shipping_rate_fixed_amount": {
        "description": "",
        "properties": {
          "amount": {
            "description": "A non-negative integer in cents representing how much to charge.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "currency_options": {
            "additionalProperties": {
              "$ref": "#/components/schemas/shipping_rate_currency_option"
            },
            "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
            "type": "object"
          }
        },
        "required": ["amount", "currency"],
        "title": "ShippingRateFixedAmount",
        "type": "object",
        "x-expandableFields": ["currency_options"]
      },
      "sigma_scheduled_query_run_error": {
        "description": "",
        "properties": {
          "message": {
            "description": "Information about the run failure.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["message"],
        "title": "SigmaScheduledQueryRunError",
        "type": "object",
        "x-expandableFields": []
      },
      "source": {
        "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).",
        "properties": {
          "ach_credit_transfer": {
            "$ref": "#/components/schemas/source_type_ach_credit_transfer"
          },
          "ach_debit": {
            "$ref": "#/components/schemas/source_type_ach_debit"
          },
          "acss_debit": {
            "$ref": "#/components/schemas/source_type_acss_debit"
          },
          "alipay": {
            "$ref": "#/components/schemas/source_type_alipay"
          },
          "allow_redisplay": {
            "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.",
            "enum": ["always", "limited", "unspecified"],
            "nullable": true,
            "type": "string"
          },
          "amount": {
            "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.",
            "nullable": true,
            "type": "integer"
          },
          "au_becs_debit": {
            "$ref": "#/components/schemas/source_type_au_becs_debit"
          },
          "bancontact": {
            "$ref": "#/components/schemas/source_type_bancontact"
          },
          "card": {
            "$ref": "#/components/schemas/source_type_card"
          },
          "card_present": {
            "$ref": "#/components/schemas/source_type_card_present"
          },
          "client_secret": {
            "description": "The client secret of the source. Used for client-side retrieval using a publishable key.",
            "maxLength": 5000,
            "type": "string"
          },
          "code_verification": {
            "$ref": "#/components/schemas/source_code_verification_flow"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.",
            "format": "currency",
            "nullable": true,
            "type": "string"
          },
          "customer": {
            "description": "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.",
            "maxLength": 5000,
            "type": "string"
          },
          "eps": {
            "$ref": "#/components/schemas/source_type_eps"
          },
          "flow": {
            "description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.",
            "maxLength": 5000,
            "type": "string"
          },
          "giropay": {
            "$ref": "#/components/schemas/source_type_giropay"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "ideal": {
            "$ref": "#/components/schemas/source_type_ideal"
          },
          "klarna": {
            "$ref": "#/components/schemas/source_type_klarna"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "multibanco": {
            "$ref": "#/components/schemas/source_type_multibanco"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["source"],
            "type": "string"
          },
          "owner": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/source_owner"
              }
            ],
            "description": "Information about the owner of the payment instrument that may be used or required by particular source types.",
            "nullable": true
          },
          "p24": {
            "$ref": "#/components/schemas/source_type_p24"
          },
          "receiver": {
            "$ref": "#/components/schemas/source_receiver_flow"
          },
          "redirect": {
            "$ref": "#/components/schemas/source_redirect_flow"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/source_type_sepa_debit"
          },
          "sofort": {
            "$ref": "#/components/schemas/source_type_sofort"
          },
          "source_order": {
            "$ref": "#/components/schemas/source_order"
          },
          "statement_descriptor": {
            "description": "Extra information about a source. This will appear on your customer's statement every time you charge the source.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.",
            "maxLength": 5000,
            "type": "string"
          },
          "three_d_secure": {
            "$ref": "#/components/schemas/source_type_three_d_secure"
          },
          "type": {
            "description": "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.",
            "enum": [
              "ach_credit_transfer",
              "ach_debit",
              "acss_debit",
              "alipay",
              "au_becs_debit",
              "bancontact",
              "card",
              "card_present",
              "eps",
              "giropay",
              "ideal",
              "klarna",
              "multibanco",
              "p24",
              "sepa_debit",
              "sofort",
              "three_d_secure",
              "wechat"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "usage": {
            "description": "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "wechat": {
            "$ref": "#/components/schemas/source_type_wechat"
          }
        },
        "required": [
          "client_secret",
          "created",
          "flow",
          "id",
          "livemode",
          "object",
          "status",
          "type"
        ],
        "title": "Source",
        "type": "object",
        "x-expandableFields": [
          "code_verification",
          "owner",
          "receiver",
          "redirect",
          "source_order"
        ],
        "x-resourceId": "source"
      },
      "source_code_verification_flow": {
        "description": "",
        "properties": {
          "attempts_remaining": {
            "description": "The number of attempts remaining to authenticate the source object with a verification code.",
            "type": "integer"
          },
          "status": {
            "description": "The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["attempts_remaining", "status"],
        "title": "SourceCodeVerificationFlow",
        "type": "object",
        "x-expandableFields": []
      },
      "source_mandate_notification": {
        "description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.",
        "properties": {
          "acss_debit": {
            "$ref": "#/components/schemas/source_mandate_notification_acss_debit_data"
          },
          "amount": {
            "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.",
            "nullable": true,
            "type": "integer"
          },
          "bacs_debit": {
            "$ref": "#/components/schemas/source_mandate_notification_bacs_debit_data"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["source_mandate_notification"],
            "type": "string"
          },
          "reason": {
            "description": "The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.",
            "maxLength": 5000,
            "type": "string"
          },
          "sepa_debit": {
            "$ref": "#/components/schemas/source_mandate_notification_sepa_debit_data"
          },
          "source": {
            "$ref": "#/components/schemas/source"
          },
          "status": {
            "description": "The status of the mandate notification. Valid statuses are `pending` or `submitted`.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "id",
          "livemode",
          "object",
          "reason",
          "source",
          "status",
          "type"
        ],
        "title": "SourceMandateNotification",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "bacs_debit",
          "sepa_debit",
          "source"
        ],
        "x-resourceId": "source_mandate_notification"
      },
      "source_mandate_notification_acss_debit_data": {
        "description": "",
        "properties": {
          "statement_descriptor": {
            "description": "The statement descriptor associate with the debit.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceMandateNotificationAcssDebitData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_mandate_notification_bacs_debit_data": {
        "description": "",
        "properties": {
          "last4": {
            "description": "Last 4 digits of the account number associated with the debit.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceMandateNotificationBacsDebitData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_mandate_notification_sepa_debit_data": {
        "description": "",
        "properties": {
          "creditor_identifier": {
            "description": "SEPA creditor ID.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "Last 4 digits of the account number associated with the debit.",
            "maxLength": 5000,
            "type": "string"
          },
          "mandate_reference": {
            "description": "Mandate reference associated with the debit.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceMandateNotificationSepaDebitData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_order": {
        "description": "",
        "properties": {
          "amount": {
            "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "email": {
            "description": "The email address of the customer placing the order.",
            "maxLength": 5000,
            "type": "string"
          },
          "items": {
            "description": "List of items constituting the order.",
            "items": {
              "$ref": "#/components/schemas/source_order_item"
            },
            "nullable": true,
            "type": "array"
          },
          "shipping": {
            "$ref": "#/components/schemas/shipping"
          }
        },
        "required": ["amount", "currency"],
        "title": "SourceOrder",
        "type": "object",
        "x-expandableFields": ["items", "shipping"]
      },
      "source_order_item": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount (price) for this order item.",
            "nullable": true,
            "type": "integer"
          },
          "currency": {
            "description": "This currency of this order item. Required when `amount` is present.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "Human-readable description for this order item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "parent": {
            "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.",
            "type": "integer"
          },
          "type": {
            "description": "The type of this order item. Must be `sku`, `tax`, or `shipping`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "SourceOrderItem",
        "type": "object",
        "x-expandableFields": []
      },
      "source_owner": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Owner's address.",
            "nullable": true
          },
          "email": {
            "description": "Owner's email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Owner's full name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "phone": {
            "description": "Owner's phone number (including extension).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/address"
              }
            ],
            "description": "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "nullable": true
          },
          "verified_email": {
            "description": "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_phone": {
            "description": "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "SourceOwner",
        "type": "object",
        "x-expandableFields": ["address", "verified_address"]
      },
      "source_receiver_flow": {
        "description": "",
        "properties": {
          "address": {
            "description": "The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "amount_charged": {
            "description": "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.",
            "type": "integer"
          },
          "amount_received": {
            "description": "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.",
            "type": "integer"
          },
          "amount_returned": {
            "description": "The total amount that was returned to the customer. The amount returned is expressed in the source's currency.",
            "type": "integer"
          },
          "refund_attributes_method": {
            "description": "Type of refund attribute method, one of `email`, `manual`, or `none`.",
            "maxLength": 5000,
            "type": "string"
          },
          "refund_attributes_status": {
            "description": "Type of refund attribute status, one of `missing`, `requested`, or `available`.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "amount_charged",
          "amount_received",
          "amount_returned",
          "refund_attributes_method",
          "refund_attributes_status"
        ],
        "title": "SourceReceiverFlow",
        "type": "object",
        "x-expandableFields": []
      },
      "source_redirect_flow": {
        "description": "",
        "properties": {
          "failure_reason": {
            "description": "The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "return_url": {
            "description": "The URL you provide to redirect the customer to after they authenticated their payment.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).",
            "maxLength": 5000,
            "type": "string"
          },
          "url": {
            "description": "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.",
            "maxLength": 2048,
            "type": "string"
          }
        },
        "required": ["return_url", "status", "url"],
        "title": "SourceRedirectFlow",
        "type": "object",
        "x-expandableFields": []
      },
      "source_transaction": {
        "description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.",
        "properties": {
          "ach_credit_transfer": {
            "$ref": "#/components/schemas/source_transaction_ach_credit_transfer_data"
          },
          "amount": {
            "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.",
            "type": "integer"
          },
          "chf_credit_transfer": {
            "$ref": "#/components/schemas/source_transaction_chf_credit_transfer_data"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "gbp_credit_transfer": {
            "$ref": "#/components/schemas/source_transaction_gbp_credit_transfer_data"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["source_transaction"],
            "type": "string"
          },
          "paper_check": {
            "$ref": "#/components/schemas/source_transaction_paper_check_data"
          },
          "sepa_credit_transfer": {
            "$ref": "#/components/schemas/source_transaction_sepa_credit_transfer_data"
          },
          "source": {
            "description": "The ID of the source this transaction is attached to.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "The status of the transaction, one of `succeeded`, `pending`, or `failed`.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The type of source this transaction is attached to.",
            "enum": [
              "ach_credit_transfer",
              "ach_debit",
              "alipay",
              "bancontact",
              "card",
              "card_present",
              "eps",
              "giropay",
              "ideal",
              "klarna",
              "multibanco",
              "p24",
              "sepa_debit",
              "sofort",
              "three_d_secure",
              "wechat"
            ],
            "type": "string"
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "id",
          "livemode",
          "object",
          "source",
          "status",
          "type"
        ],
        "title": "SourceTransaction",
        "type": "object",
        "x-expandableFields": [
          "ach_credit_transfer",
          "chf_credit_transfer",
          "gbp_credit_transfer",
          "paper_check",
          "sepa_credit_transfer"
        ],
        "x-resourceId": "source_transaction"
      },
      "source_transaction_ach_credit_transfer_data": {
        "description": "",
        "properties": {
          "customer_data": {
            "description": "Customer data associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "fingerprint": {
            "description": "Bank account fingerprint associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "Last 4 digits of the account number associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceTransactionAchCreditTransferData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_transaction_chf_credit_transfer_data": {
        "description": "",
        "properties": {
          "reference": {
            "description": "Reference associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_address_country": {
            "description": "Sender's country address.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_address_line1": {
            "description": "Sender's line 1 address.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_iban": {
            "description": "Sender's bank account IBAN.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_name": {
            "description": "Sender's name.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceTransactionChfCreditTransferData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_transaction_gbp_credit_transfer_data": {
        "description": "",
        "properties": {
          "fingerprint": {
            "description": "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "funding_method": {
            "description": "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.",
            "maxLength": 5000,
            "type": "string"
          },
          "last4": {
            "description": "Last 4 digits of sender account number associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "reference": {
            "description": "Sender entered arbitrary information about the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_account_number": {
            "description": "Sender account number associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_name": {
            "description": "Sender name associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_sort_code": {
            "description": "Sender sort code associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceTransactionGbpCreditTransferData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_transaction_paper_check_data": {
        "description": "",
        "properties": {
          "available_at": {
            "description": "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoices": {
            "description": "Comma-separated list of invoice IDs associated with the paper check.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceTransactionPaperCheckData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_transaction_sepa_credit_transfer_data": {
        "description": "",
        "properties": {
          "reference": {
            "description": "Reference associated with the transfer.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_iban": {
            "description": "Sender's bank account IBAN.",
            "maxLength": 5000,
            "type": "string"
          },
          "sender_name": {
            "description": "Sender's name.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "SourceTransactionSepaCreditTransferData",
        "type": "object",
        "x-expandableFields": []
      },
      "source_type_ach_credit_transfer": {
        "properties": {
          "account_number": {
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_name": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_type": {
            "nullable": true,
            "type": "string"
          },
          "refund_routing_number": {
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "nullable": true,
            "type": "string"
          },
          "swift_code": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_ach_debit": {
        "properties": {
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "nullable": true,
            "type": "string"
          },
          "type": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_acss_debit": {
        "properties": {
          "bank_address_city": {
            "nullable": true,
            "type": "string"
          },
          "bank_address_line_1": {
            "nullable": true,
            "type": "string"
          },
          "bank_address_line_2": {
            "nullable": true,
            "type": "string"
          },
          "bank_address_postal_code": {
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "category": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_alipay": {
        "properties": {
          "data_string": {
            "nullable": true,
            "type": "string"
          },
          "native_url": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_au_becs_debit": {
        "properties": {
          "bsb_number": {
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_bancontact": {
        "properties": {
          "bank_code": {
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          },
          "iban_last4": {
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_card": {
        "properties": {
          "address_line1_check": {
            "nullable": true,
            "type": "string"
          },
          "address_zip_check": {
            "nullable": true,
            "type": "string"
          },
          "brand": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "cvc_check": {
            "nullable": true,
            "type": "string"
          },
          "dynamic_last4": {
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "fingerprint": {
            "type": "string"
          },
          "funding": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "three_d_secure": {
            "type": "string"
          },
          "tokenization_method": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_card_present": {
        "properties": {
          "application_cryptogram": {
            "type": "string"
          },
          "application_preferred_name": {
            "type": "string"
          },
          "authorization_code": {
            "nullable": true,
            "type": "string"
          },
          "authorization_response_code": {
            "type": "string"
          },
          "brand": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "cvm_type": {
            "type": "string"
          },
          "data_type": {
            "nullable": true,
            "type": "string"
          },
          "dedicated_file_name": {
            "type": "string"
          },
          "emv_auth_data": {
            "type": "string"
          },
          "evidence_customer_signature": {
            "nullable": true,
            "type": "string"
          },
          "evidence_transaction_certificate": {
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "fingerprint": {
            "type": "string"
          },
          "funding": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "pos_device_id": {
            "nullable": true,
            "type": "string"
          },
          "pos_entry_mode": {
            "type": "string"
          },
          "read_method": {
            "nullable": true,
            "type": "string"
          },
          "reader": {
            "nullable": true,
            "type": "string"
          },
          "terminal_verification_results": {
            "type": "string"
          },
          "transaction_status_information": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_eps": {
        "properties": {
          "reference": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_giropay": {
        "properties": {
          "bank_code": {
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_ideal": {
        "properties": {
          "bank": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          },
          "iban_last4": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_klarna": {
        "properties": {
          "background_image_url": {
            "type": "string"
          },
          "client_token": {
            "nullable": true,
            "type": "string"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "logo_url": {
            "type": "string"
          },
          "page_title": {
            "type": "string"
          },
          "pay_later_asset_urls_descriptive": {
            "type": "string"
          },
          "pay_later_asset_urls_standard": {
            "type": "string"
          },
          "pay_later_name": {
            "type": "string"
          },
          "pay_later_redirect_url": {
            "type": "string"
          },
          "pay_now_asset_urls_descriptive": {
            "type": "string"
          },
          "pay_now_asset_urls_standard": {
            "type": "string"
          },
          "pay_now_name": {
            "type": "string"
          },
          "pay_now_redirect_url": {
            "type": "string"
          },
          "pay_over_time_asset_urls_descriptive": {
            "type": "string"
          },
          "pay_over_time_asset_urls_standard": {
            "type": "string"
          },
          "pay_over_time_name": {
            "type": "string"
          },
          "pay_over_time_redirect_url": {
            "type": "string"
          },
          "payment_method_categories": {
            "type": "string"
          },
          "purchase_country": {
            "type": "string"
          },
          "purchase_type": {
            "type": "string"
          },
          "redirect_url": {
            "type": "string"
          },
          "shipping_delay": {
            "type": "integer"
          },
          "shipping_first_name": {
            "type": "string"
          },
          "shipping_last_name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_multibanco": {
        "properties": {
          "entity": {
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_city": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_country": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_line1": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_line2": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_postal_code": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_address_state": {
            "nullable": true,
            "type": "string"
          },
          "refund_account_holder_name": {
            "nullable": true,
            "type": "string"
          },
          "refund_iban": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_p24": {
        "properties": {
          "reference": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_sepa_debit": {
        "properties": {
          "bank_code": {
            "nullable": true,
            "type": "string"
          },
          "branch_code": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "fingerprint": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "mandate_reference": {
            "nullable": true,
            "type": "string"
          },
          "mandate_url": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_sofort": {
        "properties": {
          "bank_code": {
            "nullable": true,
            "type": "string"
          },
          "bank_name": {
            "nullable": true,
            "type": "string"
          },
          "bic": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "iban_last4": {
            "nullable": true,
            "type": "string"
          },
          "preferred_language": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_three_d_secure": {
        "properties": {
          "address_line1_check": {
            "nullable": true,
            "type": "string"
          },
          "address_zip_check": {
            "nullable": true,
            "type": "string"
          },
          "authenticated": {
            "nullable": true,
            "type": "boolean"
          },
          "brand": {
            "nullable": true,
            "type": "string"
          },
          "card": {
            "nullable": true,
            "type": "string"
          },
          "country": {
            "nullable": true,
            "type": "string"
          },
          "customer": {
            "nullable": true,
            "type": "string"
          },
          "cvc_check": {
            "nullable": true,
            "type": "string"
          },
          "dynamic_last4": {
            "nullable": true,
            "type": "string"
          },
          "exp_month": {
            "nullable": true,
            "type": "integer"
          },
          "exp_year": {
            "nullable": true,
            "type": "integer"
          },
          "fingerprint": {
            "type": "string"
          },
          "funding": {
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "nullable": true,
            "type": "string"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "three_d_secure": {
            "type": "string"
          },
          "tokenization_method": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "source_type_wechat": {
        "properties": {
          "prepay_id": {
            "type": "string"
          },
          "qr_code_url": {
            "nullable": true,
            "type": "string"
          },
          "statement_descriptor": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "subscription": {
        "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)",
        "properties": {
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "ID of the Connect Application that created the subscription.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "application_fee_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.",
            "nullable": true,
            "type": "number"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/subscription_automatic_tax"
          },
          "billing_cycle_anchor": {
            "description": "The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.",
            "format": "unix-time",
            "type": "integer"
          },
          "billing_cycle_anchor_config": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_resource_billing_cycle_anchor_config"
              }
            ],
            "description": "The fixed values used to calculate the `billing_cycle_anchor`.",
            "nullable": true
          },
          "billing_thresholds": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_billing_thresholds"
              }
            ],
            "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period",
            "nullable": true
          },
          "cancel_at": {
            "description": "A date in the future at which the subscription will automatically get canceled",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancel_at_period_end": {
            "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.",
            "type": "boolean"
          },
          "canceled_at": {
            "description": "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "cancellation_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/cancellation_details"
              }
            ],
            "description": "Details about why this subscription was cancelled",
            "nullable": true
          },
          "collection_method": {
            "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.",
            "enum": ["charge_automatically", "send_invoice"],
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "current_period_end": {
            "description": "End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.",
            "format": "unix-time",
            "type": "integer"
          },
          "current_period_start": {
            "description": "Start of the current period that the subscription has been invoiced for.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the customer who owns the subscription.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "days_until_due": {
            "description": "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.",
            "nullable": true,
            "type": "integer"
          },
          "default_payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "default_source": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/bank_account"
                },
                {
                  "$ref": "#/components/schemas/card"
                },
                {
                  "$ref": "#/components/schemas/source"
                }
              ]
            },
            "x-stripeBypassValidation": true
          },
          "default_tax_rates": {
            "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          },
          "description": {
            "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
            "maxLength": 500,
            "nullable": true,
            "type": "string"
          },
          "discount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/discount"
              }
            ],
            "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
            "nullable": true
          },
          "discounts": {
            "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  }
                ]
              }
            },
            "type": "array"
          },
          "ended_at": {
            "description": "If the subscription has ended, the date the subscription ended.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice_settings": {
            "$ref": "#/components/schemas/subscriptions_resource_subscription_invoice_settings"
          },
          "items": {
            "description": "List of subscription items, each with an attached price.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/subscription_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "SubscriptionItemList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "latest_invoice": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/invoice"
              }
            ],
            "description": "The most recent invoice this subscription has generated.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/invoice"
                }
              ]
            }
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "next_pending_invoice_item_invoice": {
            "description": "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["subscription"],
            "type": "string"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "pause_collection": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_resource_pause_collection"
              }
            ],
            "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).",
            "nullable": true
          },
          "payment_settings": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_resource_payment_settings"
              }
            ],
            "description": "Payment settings passed on to invoices created by the subscription.",
            "nullable": true
          },
          "pending_invoice_item_interval": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_pending_invoice_item_interval"
              }
            ],
            "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.",
            "nullable": true
          },
          "pending_setup_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_intent"
              }
            ],
            "description": "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_intent"
                }
              ]
            }
          },
          "pending_update": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_resource_pending_update"
              }
            ],
            "description": "If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.",
            "nullable": true
          },
          "schedule": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription_schedule"
              }
            ],
            "description": "The schedule attached to the subscription",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              ]
            }
          },
          "start_date": {
            "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating.",
            "format": "unix-time",
            "type": "integer"
          },
          "status": {
            "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.",
            "enum": [
              "active",
              "canceled",
              "incomplete",
              "incomplete_expired",
              "past_due",
              "paused",
              "trialing",
              "unpaid"
            ],
            "type": "string"
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this subscription belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_transfer_data"
              }
            ],
            "description": "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.",
            "nullable": true
          },
          "trial_end": {
            "description": "If the subscription has a trial, the end of that trial.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "trial_settings": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings"
              }
            ],
            "description": "Settings related to subscription trials.",
            "nullable": true
          },
          "trial_start": {
            "description": "If the subscription has a trial, the beginning of that trial.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "automatic_tax",
          "billing_cycle_anchor",
          "cancel_at_period_end",
          "collection_method",
          "created",
          "currency",
          "current_period_end",
          "current_period_start",
          "customer",
          "discounts",
          "id",
          "invoice_settings",
          "items",
          "livemode",
          "metadata",
          "object",
          "start_date",
          "status"
        ],
        "title": "Subscription",
        "type": "object",
        "x-expandableFields": [
          "application",
          "automatic_tax",
          "billing_cycle_anchor_config",
          "billing_thresholds",
          "cancellation_details",
          "customer",
          "default_payment_method",
          "default_source",
          "default_tax_rates",
          "discount",
          "discounts",
          "invoice_settings",
          "items",
          "latest_invoice",
          "on_behalf_of",
          "pause_collection",
          "payment_settings",
          "pending_invoice_item_interval",
          "pending_setup_intent",
          "pending_update",
          "schedule",
          "test_clock",
          "transfer_data",
          "trial_settings"
        ],
        "x-resourceId": "subscription"
      },
      "subscription_automatic_tax": {
        "description": "",
        "properties": {
          "disabled_reason": {
            "description": "If Stripe disabled automatic tax, this enum describes why.",
            "enum": ["requires_location_inputs"],
            "nullable": true,
            "type": "string"
          },
          "enabled": {
            "description": "Whether Stripe automatically computes tax on this subscription.",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "SubscriptionAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "subscription_billing_thresholds": {
        "description": "",
        "properties": {
          "amount_gte": {
            "description": "Monetary threshold that triggers the subscription to create an invoice",
            "nullable": true,
            "type": "integer"
          },
          "reset_billing_cycle_anchor": {
            "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "SubscriptionBillingThresholds",
        "type": "object",
        "x-expandableFields": []
      },
      "subscription_details_data": {
        "description": "",
        "properties": {
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*",
            "nullable": true,
            "type": "object"
          }
        },
        "title": "SubscriptionDetailsData",
        "type": "object",
        "x-expandableFields": []
      },
      "subscription_item": {
        "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.",
        "properties": {
          "billing_thresholds": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_item_billing_thresholds"
              }
            ],
            "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period",
            "nullable": true
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "type": "integer"
          },
          "discounts": {
            "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/discount"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/discount"
                  }
                ]
              }
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["subscription_item"],
            "type": "string"
          },
          "price": {
            "$ref": "#/components/schemas/price"
          },
          "quantity": {
            "description": "The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.",
            "type": "integer"
          },
          "subscription": {
            "description": "The `subscription` this `subscription_item` belongs to.",
            "maxLength": 5000,
            "type": "string"
          },
          "tax_rates": {
            "description": "The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "required": [
          "created",
          "discounts",
          "id",
          "metadata",
          "object",
          "price",
          "subscription"
        ],
        "title": "SubscriptionItem",
        "type": "object",
        "x-expandableFields": [
          "billing_thresholds",
          "discounts",
          "price",
          "tax_rates"
        ],
        "x-resourceId": "subscription_item"
      },
      "subscription_item_billing_thresholds": {
        "description": "",
        "properties": {
          "usage_gte": {
            "description": "Usage threshold that triggers the subscription to create an invoice",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "SubscriptionItemBillingThresholds",
        "type": "object",
        "x-expandableFields": []
      },
      "subscription_payment_method_options_card": {
        "description": "",
        "properties": {
          "mandate_options": {
            "$ref": "#/components/schemas/invoice_mandate_options_card"
          },
          "network": {
            "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.",
            "enum": [
              "amex",
              "cartes_bancaires",
              "diners",
              "discover",
              "eftpos_au",
              "girocard",
              "interac",
              "jcb",
              "link",
              "mastercard",
              "unionpay",
              "unknown",
              "visa"
            ],
            "nullable": true,
            "type": "string"
          },
          "request_three_d_secure": {
            "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
            "enum": ["any", "automatic", "challenge"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "subscription_payment_method_options_card",
        "type": "object",
        "x-expandableFields": ["mandate_options"]
      },
      "subscription_pending_invoice_item_interval": {
        "description": "",
        "properties": {
          "interval": {
            "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.",
            "enum": ["day", "month", "week", "year"],
            "type": "string"
          },
          "interval_count": {
            "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).",
            "type": "integer"
          }
        },
        "required": ["interval", "interval_count"],
        "title": "SubscriptionPendingInvoiceItemInterval",
        "type": "object",
        "x-expandableFields": []
      },
      "subscription_schedule": {
        "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)",
        "properties": {
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              },
              {
                "$ref": "#/components/schemas/deleted_application"
              }
            ],
            "description": "ID of the Connect Application that created the schedule.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                },
                {
                  "$ref": "#/components/schemas/deleted_application"
                }
              ]
            }
          },
          "canceled_at": {
            "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "completed_at": {
            "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "current_phase": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_schedule_current_phase"
              }
            ],
            "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.",
            "nullable": true
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              },
              {
                "$ref": "#/components/schemas/deleted_customer"
              }
            ],
            "description": "ID of the customer who owns the subscription schedule.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                },
                {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              ]
            }
          },
          "default_settings": {
            "$ref": "#/components/schemas/subscription_schedules_resource_default_settings"
          },
          "end_behavior": {
            "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
            "enum": ["cancel", "none", "release", "renew"],
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["subscription_schedule"],
            "type": "string"
          },
          "phases": {
            "description": "Configuration for the subscription schedule's phases.",
            "items": {
              "$ref": "#/components/schemas/subscription_schedule_phase_configuration"
            },
            "type": "array"
          },
          "released_at": {
            "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "released_subscription": {
            "description": "ID of the subscription once managed by the subscription schedule (if it is released).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).",
            "enum": [
              "active",
              "canceled",
              "completed",
              "not_started",
              "released"
            ],
            "type": "string"
          },
          "subscription": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/subscription"
              }
            ],
            "description": "ID of the subscription managed by the subscription schedule.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/subscription"
                }
              ]
            }
          },
          "test_clock": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/test_helpers.test_clock"
              }
            ],
            "description": "ID of the test clock this subscription schedule belongs to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              ]
            }
          }
        },
        "required": [
          "created",
          "customer",
          "default_settings",
          "end_behavior",
          "id",
          "livemode",
          "object",
          "phases",
          "status"
        ],
        "title": "SubscriptionSchedule",
        "type": "object",
        "x-expandableFields": [
          "application",
          "current_phase",
          "customer",
          "default_settings",
          "phases",
          "subscription",
          "test_clock"
        ],
        "x-resourceId": "subscription_schedule"
      },
      "subscription_schedule_add_invoice_item": {
        "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.",
        "properties": {
          "discounts": {
            "description": "The stackable discounts that will be applied to the item.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_stackable_discount"
            },
            "type": "array"
          },
          "price": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/price"
              },
              {
                "$ref": "#/components/schemas/deleted_price"
              }
            ],
            "description": "ID of the price used to generate the invoice item.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/price"
                },
                {
                  "$ref": "#/components/schemas/deleted_price"
                }
              ]
            }
          },
          "quantity": {
            "description": "The quantity of the invoice item.",
            "nullable": true,
            "type": "integer"
          },
          "tax_rates": {
            "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "required": ["discounts", "price"],
        "title": "SubscriptionScheduleAddInvoiceItem",
        "type": "object",
        "x-expandableFields": ["discounts", "price", "tax_rates"]
      },
      "subscription_schedule_configuration_item": {
        "description": "A phase item describes the price and quantity of a phase.",
        "properties": {
          "billing_thresholds": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_item_billing_thresholds"
              }
            ],
            "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period",
            "nullable": true
          },
          "discounts": {
            "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_stackable_discount"
            },
            "type": "array"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.",
            "nullable": true,
            "type": "object"
          },
          "price": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/price"
              },
              {
                "$ref": "#/components/schemas/deleted_price"
              }
            ],
            "description": "ID of the price to which the customer should be subscribed.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/price"
                },
                {
                  "$ref": "#/components/schemas/deleted_price"
                }
              ]
            }
          },
          "quantity": {
            "description": "Quantity of the plan to which the customer should be subscribed.",
            "type": "integer"
          },
          "tax_rates": {
            "description": "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "required": ["discounts", "price"],
        "title": "SubscriptionScheduleConfigurationItem",
        "type": "object",
        "x-expandableFields": [
          "billing_thresholds",
          "discounts",
          "price",
          "tax_rates"
        ]
      },
      "subscription_schedule_current_phase": {
        "description": "",
        "properties": {
          "end_date": {
            "description": "The end of this phase of the subscription schedule.",
            "format": "unix-time",
            "type": "integer"
          },
          "start_date": {
            "description": "The start of this phase of the subscription schedule.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": ["end_date", "start_date"],
        "title": "SubscriptionScheduleCurrentPhase",
        "type": "object",
        "x-expandableFields": []
      },
      "subscription_schedule_phase_configuration": {
        "description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.",
        "properties": {
          "add_invoice_items": {
            "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.",
            "items": {
              "$ref": "#/components/schemas/subscription_schedule_add_invoice_item"
            },
            "type": "array"
          },
          "application_fee_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.",
            "nullable": true,
            "type": "number"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/schedules_phase_automatic_tax"
          },
          "billing_cycle_anchor": {
            "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
            "enum": ["automatic", "phase_start"],
            "nullable": true,
            "type": "string"
          },
          "billing_thresholds": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_billing_thresholds"
              }
            ],
            "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period",
            "nullable": true
          },
          "collection_method": {
            "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.",
            "enum": ["charge_automatically", "send_invoice"],
            "nullable": true,
            "type": "string"
          },
          "coupon": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/coupon"
              },
              {
                "$ref": "#/components/schemas/deleted_coupon"
              }
            ],
            "description": "ID of the coupon to use during this phase of the subscription schedule.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/coupon"
                },
                {
                  "$ref": "#/components/schemas/deleted_coupon"
                }
              ]
            }
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "default_payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "default_tax_rates": {
            "description": "The default tax rates to apply to the subscription during this phase of the subscription schedule.",
            "items": {
              "$ref": "#/components/schemas/tax_rate"
            },
            "nullable": true,
            "type": "array"
          },
          "description": {
            "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "discounts": {
            "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.",
            "items": {
              "$ref": "#/components/schemas/discounts_resource_stackable_discount"
            },
            "type": "array"
          },
          "end_date": {
            "description": "The end of this phase of the subscription schedule.",
            "format": "unix-time",
            "type": "integer"
          },
          "invoice_settings": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_setting_subscription_schedule_phase_setting"
              }
            ],
            "description": "The invoice settings applicable during this phase.",
            "nullable": true
          },
          "items": {
            "description": "Subscription items to configure the subscription to during this phase of the subscription schedule.",
            "items": {
              "$ref": "#/components/schemas/subscription_schedule_configuration_item"
            },
            "type": "array"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.",
            "nullable": true,
            "type": "object"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "proration_behavior": {
            "description": "If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.",
            "enum": ["always_invoice", "create_prorations", "none"],
            "type": "string"
          },
          "start_date": {
            "description": "The start of this phase of the subscription schedule.",
            "format": "unix-time",
            "type": "integer"
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_transfer_data"
              }
            ],
            "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.",
            "nullable": true
          },
          "trial_end": {
            "description": "When the trial ends within the phase.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "add_invoice_items",
          "currency",
          "discounts",
          "end_date",
          "items",
          "proration_behavior",
          "start_date"
        ],
        "title": "SubscriptionSchedulePhaseConfiguration",
        "type": "object",
        "x-expandableFields": [
          "add_invoice_items",
          "automatic_tax",
          "billing_thresholds",
          "coupon",
          "default_payment_method",
          "default_tax_rates",
          "discounts",
          "invoice_settings",
          "items",
          "on_behalf_of",
          "transfer_data"
        ]
      },
      "subscription_schedules_resource_default_settings": {
        "description": "",
        "properties": {
          "application_fee_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.",
            "nullable": true,
            "type": "number"
          },
          "automatic_tax": {
            "$ref": "#/components/schemas/subscription_schedules_resource_default_settings_automatic_tax"
          },
          "billing_cycle_anchor": {
            "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
            "enum": ["automatic", "phase_start"],
            "type": "string"
          },
          "billing_thresholds": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_billing_thresholds"
              }
            ],
            "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period",
            "nullable": true
          },
          "collection_method": {
            "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.",
            "enum": ["charge_automatically", "send_invoice"],
            "nullable": true,
            "type": "string"
          },
          "default_payment_method": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_method"
              }
            ],
            "description": "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_method"
                }
              ]
            }
          },
          "description": {
            "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "invoice_settings": {
            "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting"
          },
          "on_behalf_of": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "transfer_data": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_transfer_data"
              }
            ],
            "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.",
            "nullable": true
          }
        },
        "required": ["billing_cycle_anchor", "invoice_settings"],
        "title": "SubscriptionSchedulesResourceDefaultSettings",
        "type": "object",
        "x-expandableFields": [
          "automatic_tax",
          "billing_thresholds",
          "default_payment_method",
          "invoice_settings",
          "on_behalf_of",
          "transfer_data"
        ]
      },
      "subscription_schedules_resource_default_settings_automatic_tax": {
        "description": "",
        "properties": {
          "disabled_reason": {
            "description": "If Stripe disabled automatic tax, this enum describes why.",
            "enum": ["requires_location_inputs"],
            "nullable": true,
            "type": "string"
          },
          "enabled": {
            "description": "Whether Stripe automatically computes tax on invoices created during this phase.",
            "type": "boolean"
          },
          "liability": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/connect_account_reference"
              }
            ],
            "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.",
            "nullable": true
          }
        },
        "required": ["enabled"],
        "title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax",
        "type": "object",
        "x-expandableFields": ["liability"]
      },
      "subscription_transfer_data": {
        "description": "",
        "properties": {
          "amount_percent": {
            "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
            "nullable": true,
            "type": "number"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account where funds from the payment will be transferred to upon payment success.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "SubscriptionTransferData",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "subscriptions_resource_billing_cycle_anchor_config": {
        "description": "",
        "properties": {
          "day_of_month": {
            "description": "The day of the month of the billing_cycle_anchor.",
            "type": "integer"
          },
          "hour": {
            "description": "The hour of the day of the billing_cycle_anchor.",
            "nullable": true,
            "type": "integer"
          },
          "minute": {
            "description": "The minute of the hour of the billing_cycle_anchor.",
            "nullable": true,
            "type": "integer"
          },
          "month": {
            "description": "The month to start full cycle billing periods.",
            "nullable": true,
            "type": "integer"
          },
          "second": {
            "description": "The second of the minute of the billing_cycle_anchor.",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["day_of_month"],
        "title": "SubscriptionsResourceBillingCycleAnchorConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "subscriptions_resource_pause_collection": {
        "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.",
        "properties": {
          "behavior": {
            "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.",
            "enum": ["keep_as_draft", "mark_uncollectible", "void"],
            "type": "string"
          },
          "resumes_at": {
            "description": "The time after which the subscription will resume collecting payments.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": ["behavior"],
        "title": "SubscriptionsResourcePauseCollection",
        "type": "object",
        "x-expandableFields": []
      },
      "subscriptions_resource_payment_method_options": {
        "description": "",
        "properties": {
          "acss_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
              }
            ],
            "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "bancontact": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
              }
            ],
            "description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "card": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscription_payment_method_options_card"
              }
            ],
            "description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "customer_balance": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
              }
            ],
            "description": "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "konbini": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_konbini"
              }
            ],
            "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "sepa_debit": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
              }
            ],
            "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.",
            "nullable": true
          },
          "us_bank_account": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
              }
            ],
            "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.",
            "nullable": true
          }
        },
        "title": "SubscriptionsResourcePaymentMethodOptions",
        "type": "object",
        "x-expandableFields": [
          "acss_debit",
          "bancontact",
          "card",
          "customer_balance",
          "konbini",
          "sepa_debit",
          "us_bank_account"
        ]
      },
      "subscriptions_resource_payment_settings": {
        "description": "",
        "properties": {
          "payment_method_options": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/subscriptions_resource_payment_method_options"
              }
            ],
            "description": "Payment-method-specific configuration to provide to invoices created by the subscription.",
            "nullable": true
          },
          "payment_method_types": {
            "description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).",
            "items": {
              "enum": [
                "ach_credit_transfer",
                "ach_debit",
                "acss_debit",
                "amazon_pay",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "boleto",
                "card",
                "cashapp",
                "customer_balance",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "jp_credit_transfer",
                "kakao_pay",
                "konbini",
                "kr_card",
                "link",
                "multibanco",
                "naver_pay",
                "p24",
                "payco",
                "paynow",
                "paypal",
                "promptpay",
                "revolut_pay",
                "sepa_credit_transfer",
                "sepa_debit",
                "sofort",
                "swish",
                "us_bank_account",
                "wechat_pay"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "nullable": true,
            "type": "array"
          },
          "save_default_payment_method": {
            "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.",
            "enum": ["off", "on_subscription"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "SubscriptionsResourcePaymentSettings",
        "type": "object",
        "x-expandableFields": ["payment_method_options"]
      },
      "subscriptions_resource_pending_update": {
        "description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.",
        "properties": {
          "billing_cycle_anchor": {
            "description": "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "expires_at": {
            "description": "The point after which the changes reflected by this update will be discarded and no longer applied.",
            "format": "unix-time",
            "type": "integer"
          },
          "subscription_items": {
            "description": "List of subscription items, each with an attached plan, that will be set if the update is applied.",
            "items": {
              "$ref": "#/components/schemas/subscription_item"
            },
            "nullable": true,
            "type": "array"
          },
          "trial_end": {
            "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "trial_from_plan": {
            "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "required": ["expires_at"],
        "title": "SubscriptionsResourcePendingUpdate",
        "type": "object",
        "x-expandableFields": ["subscription_items"]
      },
      "subscriptions_resource_subscription_invoice_settings": {
        "description": "",
        "properties": {
          "account_tax_ids": {
            "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.",
            "items": {
              "anyOf": [
                {
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "$ref": "#/components/schemas/tax_id"
                },
                {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              ],
              "x-expansionResources": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/tax_id"
                  },
                  {
                    "$ref": "#/components/schemas/deleted_tax_id"
                  }
                ]
              }
            },
            "nullable": true,
            "type": "array"
          },
          "issuer": {
            "$ref": "#/components/schemas/connect_account_reference"
          }
        },
        "required": ["issuer"],
        "title": "SubscriptionsResourceSubscriptionInvoiceSettings",
        "type": "object",
        "x-expandableFields": ["account_tax_ids", "issuer"]
      },
      "subscriptions_trials_resource_end_behavior": {
        "description": "Defines how a subscription behaves when a free trial ends.",
        "properties": {
          "missing_payment_method": {
            "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.",
            "enum": ["cancel", "create_invoice", "pause"],
            "type": "string"
          }
        },
        "required": ["missing_payment_method"],
        "title": "SubscriptionsTrialsResourceEndBehavior",
        "type": "object",
        "x-expandableFields": []
      },
      "subscriptions_trials_resource_trial_settings": {
        "description": "Configures how this subscription behaves during the trial period.",
        "properties": {
          "end_behavior": {
            "$ref": "#/components/schemas/subscriptions_trials_resource_end_behavior"
          }
        },
        "required": ["end_behavior"],
        "title": "SubscriptionsTrialsResourceTrialSettings",
        "type": "object",
        "x-expandableFields": ["end_behavior"]
      },
      "tax.calculation": {
        "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)",
        "properties": {
          "amount_total": {
            "description": "Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "customer": {
            "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_details": {
            "$ref": "#/components/schemas/tax_product_resource_customer_details"
          },
          "expires_at": {
            "description": "Timestamp of date at which the tax calculation will expire.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the calculation.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line_items": {
            "description": "The list of items the customer is purchasing.",
            "nullable": true,
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/tax.calculation_line_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "pattern": "^/v1/tax/calculations/[^/]+/line_items",
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "TaxProductResourceTaxCalculationLineItemList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.calculation"],
            "type": "string"
          },
          "ship_from_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_ship_from_details"
              }
            ],
            "description": "The details of the ship from location, such as the address.",
            "nullable": true
          },
          "shipping_cost": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost"
              }
            ],
            "description": "The shipping cost details for the calculation.",
            "nullable": true
          },
          "tax_amount_exclusive": {
            "description": "The amount of tax to be collected on top of the line item prices.",
            "type": "integer"
          },
          "tax_amount_inclusive": {
            "description": "The amount of tax already included in the line item prices.",
            "type": "integer"
          },
          "tax_breakdown": {
            "description": "Breakdown of individual tax amounts that add up to the total.",
            "items": {
              "$ref": "#/components/schemas/tax_product_resource_tax_breakdown"
            },
            "type": "array"
          },
          "tax_date": {
            "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "amount_total",
          "currency",
          "customer_details",
          "livemode",
          "object",
          "tax_amount_exclusive",
          "tax_amount_inclusive",
          "tax_breakdown",
          "tax_date"
        ],
        "title": "TaxProductResourceTaxCalculation",
        "type": "object",
        "x-expandableFields": [
          "customer_details",
          "line_items",
          "ship_from_details",
          "shipping_cost",
          "tax_breakdown"
        ],
        "x-resourceId": "tax.calculation"
      },
      "tax.calculation_line_item": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.calculation_line_item"],
            "type": "string"
          },
          "product": {
            "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.",
            "type": "integer"
          },
          "reference": {
            "description": "A custom identifier for this line item.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_behavior": {
            "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.",
            "enum": ["exclusive", "inclusive"],
            "type": "string"
          },
          "tax_breakdown": {
            "description": "Detailed account of taxes relevant to this line item.",
            "items": {
              "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown"
            },
            "nullable": true,
            "type": "array"
          },
          "tax_code": {
            "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "amount_tax",
          "id",
          "livemode",
          "object",
          "quantity",
          "tax_behavior",
          "tax_code"
        ],
        "title": "TaxProductResourceTaxCalculationLineItem",
        "type": "object",
        "x-expandableFields": ["tax_breakdown"],
        "x-resourceId": "tax.calculation_line_item"
      },
      "tax.registration": {
        "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)",
        "properties": {
          "active_from": {
            "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "country_options": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "expires_at": {
            "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.registration"],
            "type": "string"
          },
          "status": {
            "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.",
            "enum": ["active", "expired", "scheduled"],
            "type": "string"
          }
        },
        "required": [
          "active_from",
          "country",
          "country_options",
          "created",
          "id",
          "livemode",
          "object",
          "status"
        ],
        "title": "TaxProductRegistrationsResourceTaxRegistration",
        "type": "object",
        "x-expandableFields": ["country_options"],
        "x-resourceId": "tax.registration"
      },
      "tax.settings": {
        "description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)",
        "properties": {
          "defaults": {
            "$ref": "#/components/schemas/tax_product_resource_tax_settings_defaults"
          },
          "head_office": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_tax_settings_head_office"
              }
            ],
            "description": "The place where your business is located.",
            "nullable": true
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.settings"],
            "type": "string"
          },
          "status": {
            "description": "The status of the Tax `Settings`.",
            "enum": ["active", "pending"],
            "type": "string"
          },
          "status_details": {
            "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details"
          }
        },
        "required": [
          "defaults",
          "livemode",
          "object",
          "status",
          "status_details"
        ],
        "title": "TaxProductResourceTaxSettings",
        "type": "object",
        "x-expandableFields": ["defaults", "head_office", "status_details"],
        "x-resourceId": "tax.settings"
      },
      "tax.transaction": {
        "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "customer": {
            "description": "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "customer_details": {
            "$ref": "#/components/schemas/tax_product_resource_customer_details"
          },
          "id": {
            "description": "Unique identifier for the transaction.",
            "maxLength": 5000,
            "type": "string"
          },
          "line_items": {
            "description": "The tax collected or refunded, by line item.",
            "nullable": true,
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/tax.transaction_line_item"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "pattern": "^/v1/tax/transactions/[^/]+/line_items",
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "TaxProductResourceTaxTransactionLineItemList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.transaction"],
            "type": "string"
          },
          "posted_at": {
            "description": "The Unix timestamp representing when the tax liability is assumed or reduced.",
            "format": "unix-time",
            "type": "integer"
          },
          "reference": {
            "description": "A custom unique identifier, such as 'myOrder_123'.",
            "maxLength": 5000,
            "type": "string"
          },
          "reversal": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal"
              }
            ],
            "description": "If `type=reversal`, contains information about what was reversed.",
            "nullable": true
          },
          "ship_from_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_ship_from_details"
              }
            ],
            "description": "The details of the ship from location, such as the address.",
            "nullable": true
          },
          "shipping_cost": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost"
              }
            ],
            "description": "The shipping cost details for the transaction.",
            "nullable": true
          },
          "tax_date": {
            "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation.",
            "format": "unix-time",
            "type": "integer"
          },
          "type": {
            "description": "If `reversal`, this transaction reverses an earlier transaction.",
            "enum": ["reversal", "transaction"],
            "type": "string"
          }
        },
        "required": [
          "created",
          "currency",
          "customer_details",
          "id",
          "livemode",
          "object",
          "posted_at",
          "reference",
          "tax_date",
          "type"
        ],
        "title": "TaxProductResourceTaxTransaction",
        "type": "object",
        "x-expandableFields": [
          "customer_details",
          "line_items",
          "reversal",
          "ship_from_details",
          "shipping_cost"
        ],
        "x-resourceId": "tax.transaction"
      },
      "tax.transaction_line_item": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax.transaction_line_item"],
            "type": "string"
          },
          "product": {
            "description": "The ID of an existing [Product](https://stripe.com/docs/api/products/object).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed.",
            "type": "integer"
          },
          "reference": {
            "description": "A custom identifier for this line item in the transaction.",
            "maxLength": 5000,
            "type": "string"
          },
          "reversal": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal"
              }
            ],
            "description": "If `type=reversal`, contains information about what was reversed.",
            "nullable": true
          },
          "tax_behavior": {
            "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.",
            "enum": ["exclusive", "inclusive"],
            "type": "string"
          },
          "tax_code": {
            "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "If `reversal`, this line item reverses an earlier transaction.",
            "enum": ["reversal", "transaction"],
            "type": "string"
          }
        },
        "required": [
          "amount",
          "amount_tax",
          "id",
          "livemode",
          "object",
          "quantity",
          "reference",
          "tax_behavior",
          "tax_code",
          "type"
        ],
        "title": "TaxProductResourceTaxTransactionLineItem",
        "type": "object",
        "x-expandableFields": ["reversal"],
        "x-resourceId": "tax.transaction_line_item"
      },
      "tax_code": {
        "description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.",
        "properties": {
          "description": {
            "description": "A detailed description of which types of products the tax code represents.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "name": {
            "description": "A short name for the tax code.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax_code"],
            "type": "string"
          }
        },
        "required": ["description", "id", "name", "object"],
        "title": "TaxProductResourceTaxCode",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "tax_code"
      },
      "tax_deducted_at_source": {
        "description": "",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax_deducted_at_source"],
            "type": "string"
          },
          "period_end": {
            "description": "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.",
            "format": "unix-time",
            "type": "integer"
          },
          "period_start": {
            "description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.",
            "format": "unix-time",
            "type": "integer"
          },
          "tax_deduction_account_number": {
            "description": "The TAN that was supplied to Stripe when TDS was assessed",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "period_end",
          "period_start",
          "tax_deduction_account_number"
        ],
        "title": "TaxDeductedAtSource",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_i_ds_owner": {
        "description": "",
        "properties": {
          "account": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account being referenced when `type` is `account`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "application": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/application"
              }
            ],
            "description": "The Connect Application being referenced when `type` is `application`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/application"
                }
              ]
            }
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "The customer being referenced when `type` is `customer`.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "type": {
            "description": "Type of owner referenced.",
            "enum": ["account", "application", "customer", "self"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxIDsOwner",
        "type": "object",
        "x-expandableFields": ["account", "application", "customer"]
      },
      "tax_id": {
        "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)",
        "properties": {
          "country": {
            "description": "Two-letter ISO code representing the country of the tax ID.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "ID of the customer.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax_id"],
            "type": "string"
          },
          "owner": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_i_ds_owner"
              }
            ],
            "description": "The account or customer the tax ID belongs to.",
            "nullable": true
          },
          "type": {
            "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`",
            "enum": [
              "ad_nrt",
              "ae_trn",
              "al_tin",
              "am_tin",
              "ao_tin",
              "ar_cuit",
              "au_abn",
              "au_arn",
              "ba_tin",
              "bb_tin",
              "bg_uic",
              "bh_vat",
              "bo_tin",
              "br_cnpj",
              "br_cpf",
              "bs_tin",
              "by_tin",
              "ca_bn",
              "ca_gst_hst",
              "ca_pst_bc",
              "ca_pst_mb",
              "ca_pst_sk",
              "ca_qst",
              "cd_nif",
              "ch_uid",
              "ch_vat",
              "cl_tin",
              "cn_tin",
              "co_nit",
              "cr_tin",
              "de_stn",
              "do_rcn",
              "ec_ruc",
              "eg_tin",
              "es_cif",
              "eu_oss_vat",
              "eu_vat",
              "gb_vat",
              "ge_vat",
              "gn_nif",
              "hk_br",
              "hr_oib",
              "hu_tin",
              "id_npwp",
              "il_vat",
              "in_gst",
              "is_vat",
              "jp_cn",
              "jp_rn",
              "jp_trn",
              "ke_pin",
              "kh_tin",
              "kr_brn",
              "kz_bin",
              "li_uid",
              "li_vat",
              "ma_vat",
              "md_vat",
              "me_pib",
              "mk_vat",
              "mr_nif",
              "mx_rfc",
              "my_frp",
              "my_itn",
              "my_sst",
              "ng_tin",
              "no_vat",
              "no_voec",
              "np_pan",
              "nz_gst",
              "om_vat",
              "pe_ruc",
              "ph_tin",
              "ro_tin",
              "rs_pib",
              "ru_inn",
              "ru_kpp",
              "sa_vat",
              "sg_gst",
              "sg_uen",
              "si_tin",
              "sn_ninea",
              "sr_fin",
              "sv_nit",
              "th_vat",
              "tj_tin",
              "tr_tin",
              "tw_vat",
              "tz_vat",
              "ua_vat",
              "ug_tin",
              "unknown",
              "us_ein",
              "uy_ruc",
              "uz_tin",
              "uz_vat",
              "ve_rif",
              "vn_tin",
              "za_vat",
              "zm_tin",
              "zw_tin"
            ],
            "type": "string"
          },
          "value": {
            "description": "Value of the tax ID.",
            "maxLength": 5000,
            "type": "string"
          },
          "verification": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_id_verification"
              }
            ],
            "description": "Tax ID verification information.",
            "nullable": true
          }
        },
        "required": ["created", "id", "livemode", "object", "type", "value"],
        "title": "tax_id",
        "type": "object",
        "x-expandableFields": ["customer", "owner", "verification"],
        "x-resourceId": "tax_id"
      },
      "tax_id_verification": {
        "description": "",
        "properties": {
          "status": {
            "description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.",
            "enum": ["pending", "unavailable", "unverified", "verified"],
            "type": "string"
          },
          "verified_address": {
            "description": "Verified address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "verified_name": {
            "description": "Verified name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "tax_id_verification",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options": {
        "description": "",
        "properties": {
          "ae": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "al": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "am": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ao": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "at": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "au": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "ba": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "bb": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "be": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "bg": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "bh": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "bs": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "by": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ca": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada"
          },
          "cd": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "ch": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "cl": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "co": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "cr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "cy": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "cz": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "de": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "dk": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "ec": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ee": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "eg": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "es": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "fi": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "fr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "gb": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "ge": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "gn": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "gr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "hr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "hu": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "id": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ie": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "is": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "it": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "jp": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "ke": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "kh": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "kr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "kz": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "lt": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "lu": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "lv": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "ma": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "md": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "me": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "mk": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "mr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "mt": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "mx": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "my": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ng": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "nl": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "no": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "np": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "nz": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "om": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "pe": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "pl": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "pt": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "ro": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "rs": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "ru": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "sa": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "se": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "sg": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "si": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "sk": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
          },
          "sn": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "sr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "th": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "tj": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "tr": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "tz": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "ug": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "us": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states"
          },
          "uy": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "uz": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "vn": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "za": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          },
          "zm": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
          },
          "zw": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
          }
        },
        "title": "TaxProductRegistrationsResourceCountryOptions",
        "type": "object",
        "x-expandableFields": [
          "ae",
          "al",
          "am",
          "ao",
          "at",
          "au",
          "ba",
          "bb",
          "be",
          "bg",
          "bh",
          "bs",
          "by",
          "ca",
          "cd",
          "ch",
          "cl",
          "co",
          "cr",
          "cy",
          "cz",
          "de",
          "dk",
          "ec",
          "ee",
          "eg",
          "es",
          "fi",
          "fr",
          "gb",
          "ge",
          "gn",
          "gr",
          "hr",
          "hu",
          "id",
          "ie",
          "is",
          "it",
          "jp",
          "ke",
          "kh",
          "kr",
          "kz",
          "lt",
          "lu",
          "lv",
          "ma",
          "md",
          "me",
          "mk",
          "mr",
          "mt",
          "mx",
          "my",
          "ng",
          "nl",
          "no",
          "np",
          "nz",
          "om",
          "pe",
          "pl",
          "pt",
          "ro",
          "rs",
          "ru",
          "sa",
          "se",
          "sg",
          "si",
          "sk",
          "sn",
          "sr",
          "th",
          "tj",
          "tr",
          "tz",
          "ug",
          "us",
          "uy",
          "uz",
          "vn",
          "za",
          "zm",
          "zw"
        ]
      },
      "tax_product_registrations_resource_country_options_ca_province_standard": {
        "description": "",
        "properties": {
          "province": {
            "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["province"],
        "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_canada": {
        "description": "",
        "properties": {
          "province_standard": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard"
          },
          "type": {
            "description": "Type of registration in Canada.",
            "enum": ["province_standard", "simplified", "standard"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsCanada",
        "type": "object",
        "x-expandableFields": ["province_standard"]
      },
      "tax_product_registrations_resource_country_options_default": {
        "description": "",
        "properties": {
          "type": {
            "description": "Type of registration in `country`.",
            "enum": ["standard"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsDefault",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_eu_standard": {
        "description": "",
        "properties": {
          "place_of_supply_scheme": {
            "description": "Place of supply scheme used in an EU standard registration.",
            "enum": ["small_seller", "standard"],
            "type": "string"
          }
        },
        "required": ["place_of_supply_scheme"],
        "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_europe": {
        "description": "",
        "properties": {
          "standard": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard"
          },
          "type": {
            "description": "Type of registration in an EU country.",
            "enum": ["ioss", "oss_non_union", "oss_union", "standard"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsEurope",
        "type": "object",
        "x-expandableFields": ["standard"]
      },
      "tax_product_registrations_resource_country_options_simplified": {
        "description": "",
        "properties": {
          "type": {
            "description": "Type of registration in `country`.",
            "enum": ["simplified"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsSimplified",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_united_states": {
        "description": "",
        "properties": {
          "local_amusement_tax": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax"
          },
          "local_lease_tax": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax"
          },
          "state": {
            "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "state_sales_tax": {
            "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax"
          },
          "type": {
            "description": "Type of registration in the US.",
            "enum": [
              "local_amusement_tax",
              "local_lease_tax",
              "state_communications_tax",
              "state_retail_delivery_fee",
              "state_sales_tax"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["state", "type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates",
        "type": "object",
        "x-expandableFields": [
          "local_amusement_tax",
          "local_lease_tax",
          "state_sales_tax"
        ]
      },
      "tax_product_registrations_resource_country_options_us_local_amusement_tax": {
        "description": "",
        "properties": {
          "jurisdiction": {
            "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["jurisdiction"],
        "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_us_local_lease_tax": {
        "description": "",
        "properties": {
          "jurisdiction": {
            "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["jurisdiction"],
        "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_registrations_resource_country_options_us_state_sales_tax": {
        "description": "",
        "properties": {
          "elections": {
            "description": "Elections for the state sales tax registration.",
            "items": {
              "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election"
            },
            "type": "array"
          }
        },
        "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax",
        "type": "object",
        "x-expandableFields": ["elections"]
      },
      "tax_product_registrations_resource_country_options_us_state_sales_tax_election": {
        "description": "",
        "properties": {
          "jurisdiction": {
            "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "The type of the election for the state sales tax registration.",
            "enum": [
              "local_use_tax",
              "simplified_sellers_use_tax",
              "single_local_use_tax"
            ],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_customer_details": {
        "description": "",
        "properties": {
          "address": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_postal_address"
              }
            ],
            "description": "The customer's postal address (for example, home or business location).",
            "nullable": true
          },
          "address_source": {
            "description": "The type of customer address provided.",
            "enum": ["billing", "shipping"],
            "nullable": true,
            "type": "string"
          },
          "ip_address": {
            "description": "The customer's IP address (IPv4 or IPv6).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_ids": {
            "description": "The customer's tax IDs (for example, EU VAT numbers).",
            "items": {
              "$ref": "#/components/schemas/tax_product_resource_customer_details_resource_tax_id"
            },
            "type": "array"
          },
          "taxability_override": {
            "description": "The taxability override used for taxation.",
            "enum": ["customer_exempt", "none", "reverse_charge"],
            "type": "string"
          }
        },
        "required": ["tax_ids", "taxability_override"],
        "title": "TaxProductResourceCustomerDetails",
        "type": "object",
        "x-expandableFields": ["address", "tax_ids"]
      },
      "tax_product_resource_customer_details_resource_tax_id": {
        "description": "",
        "properties": {
          "type": {
            "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`",
            "enum": [
              "ad_nrt",
              "ae_trn",
              "al_tin",
              "am_tin",
              "ao_tin",
              "ar_cuit",
              "au_abn",
              "au_arn",
              "ba_tin",
              "bb_tin",
              "bg_uic",
              "bh_vat",
              "bo_tin",
              "br_cnpj",
              "br_cpf",
              "bs_tin",
              "by_tin",
              "ca_bn",
              "ca_gst_hst",
              "ca_pst_bc",
              "ca_pst_mb",
              "ca_pst_sk",
              "ca_qst",
              "cd_nif",
              "ch_uid",
              "ch_vat",
              "cl_tin",
              "cn_tin",
              "co_nit",
              "cr_tin",
              "de_stn",
              "do_rcn",
              "ec_ruc",
              "eg_tin",
              "es_cif",
              "eu_oss_vat",
              "eu_vat",
              "gb_vat",
              "ge_vat",
              "gn_nif",
              "hk_br",
              "hr_oib",
              "hu_tin",
              "id_npwp",
              "il_vat",
              "in_gst",
              "is_vat",
              "jp_cn",
              "jp_rn",
              "jp_trn",
              "ke_pin",
              "kh_tin",
              "kr_brn",
              "kz_bin",
              "li_uid",
              "li_vat",
              "ma_vat",
              "md_vat",
              "me_pib",
              "mk_vat",
              "mr_nif",
              "mx_rfc",
              "my_frp",
              "my_itn",
              "my_sst",
              "ng_tin",
              "no_vat",
              "no_voec",
              "np_pan",
              "nz_gst",
              "om_vat",
              "pe_ruc",
              "ph_tin",
              "ro_tin",
              "rs_pib",
              "ru_inn",
              "ru_kpp",
              "sa_vat",
              "sg_gst",
              "sg_uen",
              "si_tin",
              "sn_ninea",
              "sr_fin",
              "sv_nit",
              "th_vat",
              "tj_tin",
              "tr_tin",
              "tw_vat",
              "tz_vat",
              "ua_vat",
              "ug_tin",
              "unknown",
              "us_ein",
              "uy_ruc",
              "uz_tin",
              "uz_vat",
              "ve_rif",
              "vn_tin",
              "za_vat",
              "zm_tin",
              "zw_tin"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value of the tax ID.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["type", "value"],
        "title": "TaxProductResourceCustomerDetailsResourceTaxId",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_jurisdiction": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "display_name": {
            "description": "A human-readable name for the jurisdiction imposing the tax.",
            "maxLength": 5000,
            "type": "string"
          },
          "level": {
            "description": "Indicates the level of the jurisdiction imposing the tax.",
            "enum": ["city", "country", "county", "district", "state"],
            "type": "string"
          },
          "state": {
            "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["country", "display_name", "level"],
        "title": "TaxProductResourceJurisdiction",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_line_item_tax_breakdown": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "jurisdiction": {
            "$ref": "#/components/schemas/tax_product_resource_jurisdiction"
          },
          "sourcing": {
            "description": "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).",
            "enum": ["destination", "origin"],
            "type": "string"
          },
          "tax_rate_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_product_resource_line_item_tax_rate_details"
              }
            ],
            "description": "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.",
            "nullable": true
          },
          "taxability_reason": {
            "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
            "enum": [
              "customer_exempt",
              "not_collecting",
              "not_subject_to_tax",
              "not_supported",
              "portion_product_exempt",
              "portion_reduced_rated",
              "portion_standard_rated",
              "product_exempt",
              "product_exempt_holiday",
              "proportionally_rated",
              "reduced_rated",
              "reverse_charge",
              "standard_rated",
              "taxable_basis_reduced",
              "zero_rated"
            ],
            "type": "string"
          },
          "taxable_amount": {
            "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "jurisdiction",
          "sourcing",
          "taxability_reason",
          "taxable_amount"
        ],
        "title": "TaxProductResourceLineItemTaxBreakdown",
        "type": "object",
        "x-expandableFields": ["jurisdiction", "tax_rate_details"]
      },
      "tax_product_resource_line_item_tax_rate_details": {
        "description": "",
        "properties": {
          "display_name": {
            "description": "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\".",
            "maxLength": 5000,
            "type": "string"
          },
          "percentage_decimal": {
            "description": "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\".",
            "maxLength": 5000,
            "type": "string"
          },
          "tax_type": {
            "description": "The tax type, such as `vat` or `sales_tax`.",
            "enum": [
              "amusement_tax",
              "communications_tax",
              "gst",
              "hst",
              "igst",
              "jct",
              "lease_tax",
              "pst",
              "qst",
              "retail_delivery_fee",
              "rst",
              "sales_tax",
              "service_tax",
              "vat"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["display_name", "percentage_decimal", "tax_type"],
        "title": "TaxProductResourceLineItemTaxRateDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_postal_address": {
        "description": "",
        "properties": {
          "city": {
            "description": "City, district, suburb, town, or village.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "line1": {
            "description": "Address line 1 (e.g., street, PO Box, or company name).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "line2": {
            "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "postal_code": {
            "description": "ZIP or postal code.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\".",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["country"],
        "title": "TaxProductResourcePostalAddress",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_ship_from_details": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/tax_product_resource_postal_address"
          }
        },
        "required": ["address"],
        "title": "TaxProductResourceShipFromDetails",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "tax_product_resource_tax_breakdown": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "inclusive": {
            "description": "Specifies whether the tax amount is included in the line item amount.",
            "type": "boolean"
          },
          "tax_rate_details": {
            "$ref": "#/components/schemas/tax_product_resource_tax_rate_details"
          },
          "taxability_reason": {
            "description": "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.",
            "enum": [
              "customer_exempt",
              "not_collecting",
              "not_subject_to_tax",
              "not_supported",
              "portion_product_exempt",
              "portion_reduced_rated",
              "portion_standard_rated",
              "product_exempt",
              "product_exempt_holiday",
              "proportionally_rated",
              "reduced_rated",
              "reverse_charge",
              "standard_rated",
              "taxable_basis_reduced",
              "zero_rated"
            ],
            "type": "string"
          },
          "taxable_amount": {
            "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          }
        },
        "required": [
          "amount",
          "inclusive",
          "tax_rate_details",
          "taxability_reason",
          "taxable_amount"
        ],
        "title": "TaxProductResourceTaxBreakdown",
        "type": "object",
        "x-expandableFields": ["tax_rate_details"]
      },
      "tax_product_resource_tax_calculation_shipping_cost": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "shipping_rate": {
            "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).",
            "maxLength": 5000,
            "type": "string"
          },
          "tax_behavior": {
            "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.",
            "enum": ["exclusive", "inclusive"],
            "type": "string"
          },
          "tax_breakdown": {
            "description": "Detailed account of taxes relevant to shipping cost.",
            "items": {
              "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown"
            },
            "type": "array"
          },
          "tax_code": {
            "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["amount", "amount_tax", "tax_behavior", "tax_code"],
        "title": "TaxProductResourceTaxCalculationShippingCost",
        "type": "object",
        "x-expandableFields": ["tax_breakdown"]
      },
      "tax_product_resource_tax_rate_details": {
        "description": "",
        "properties": {
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "flat_amount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_rate_flat_amount"
              }
            ],
            "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.",
            "nullable": true
          },
          "percentage_decimal": {
            "description": "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`.",
            "maxLength": 5000,
            "type": "string"
          },
          "rate_type": {
            "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.",
            "enum": ["flat_amount", "percentage"],
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "State, county, province, or region.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_type": {
            "description": "The tax type, such as `vat` or `sales_tax`.",
            "enum": [
              "amusement_tax",
              "communications_tax",
              "gst",
              "hst",
              "igst",
              "jct",
              "lease_tax",
              "pst",
              "qst",
              "retail_delivery_fee",
              "rst",
              "sales_tax",
              "service_tax",
              "vat"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["percentage_decimal"],
        "title": "TaxProductResourceTaxRateDetails",
        "type": "object",
        "x-expandableFields": ["flat_amount"]
      },
      "tax_product_resource_tax_settings_defaults": {
        "description": "",
        "properties": {
          "tax_behavior": {
            "description": "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.",
            "enum": ["exclusive", "inclusive", "inferred_by_currency"],
            "nullable": true,
            "type": "string"
          },
          "tax_code": {
            "description": "Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TaxProductResourceTaxSettingsDefaults",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_tax_settings_head_office": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          }
        },
        "required": ["address"],
        "title": "TaxProductResourceTaxSettingsHeadOffice",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "tax_product_resource_tax_settings_status_details": {
        "description": "",
        "properties": {
          "active": {
            "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_active"
          },
          "pending": {
            "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending"
          }
        },
        "title": "TaxProductResourceTaxSettingsStatusDetails",
        "type": "object",
        "x-expandableFields": ["active", "pending"]
      },
      "tax_product_resource_tax_settings_status_details_resource_active": {
        "description": "",
        "properties": {},
        "title": "TaxProductResourceTaxSettingsStatusDetailsResourceActive",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_tax_settings_status_details_resource_pending": {
        "description": "",
        "properties": {
          "missing_fields": {
            "description": "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_tax_transaction_line_item_resource_reversal": {
        "description": "",
        "properties": {
          "original_line_item": {
            "description": "The `id` of the line item to reverse in the original transaction.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["original_line_item"],
        "title": "TaxProductResourceTaxTransactionLineItemResourceReversal",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_tax_transaction_resource_reversal": {
        "description": "",
        "properties": {
          "original_transaction": {
            "description": "The `id` of the reversed `Transaction` object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TaxProductResourceTaxTransactionResourceReversal",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_product_resource_tax_transaction_shipping_cost": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.",
            "type": "integer"
          },
          "amount_tax": {
            "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "shipping_rate": {
            "description": "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).",
            "maxLength": 5000,
            "type": "string"
          },
          "tax_behavior": {
            "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.",
            "enum": ["exclusive", "inclusive"],
            "type": "string"
          },
          "tax_code": {
            "description": "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["amount", "amount_tax", "tax_behavior", "tax_code"],
        "title": "TaxProductResourceTaxTransactionShippingCost",
        "type": "object",
        "x-expandableFields": []
      },
      "tax_rate": {
        "description": "Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.\n\nRelated guide: [Tax rates](/billing/taxes/tax-rates)",
        "properties": {
          "active": {
            "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.",
            "type": "boolean"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "description": {
            "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "display_name": {
            "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.",
            "maxLength": 5000,
            "type": "string"
          },
          "effective_percentage": {
            "description": "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction.",
            "nullable": true,
            "type": "number"
          },
          "flat_amount": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/tax_rate_flat_amount"
              }
            ],
            "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.",
            "nullable": true
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "inclusive": {
            "description": "This specifies if the tax rate is inclusive or exclusive.",
            "type": "boolean"
          },
          "jurisdiction": {
            "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "jurisdiction_level": {
            "description": "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.",
            "enum": [
              "city",
              "country",
              "county",
              "district",
              "multiple",
              "state"
            ],
            "nullable": true,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["tax_rate"],
            "type": "string"
          },
          "percentage": {
            "description": "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.",
            "type": "number"
          },
          "rate_type": {
            "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.",
            "enum": ["flat_amount", "percentage"],
            "nullable": true,
            "type": "string"
          },
          "state": {
            "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "tax_type": {
            "description": "The high-level tax type, such as `vat` or `sales_tax`.",
            "enum": [
              "amusement_tax",
              "communications_tax",
              "gst",
              "hst",
              "igst",
              "jct",
              "lease_tax",
              "pst",
              "qst",
              "retail_delivery_fee",
              "rst",
              "sales_tax",
              "service_tax",
              "vat"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": [
          "active",
          "created",
          "display_name",
          "id",
          "inclusive",
          "livemode",
          "object",
          "percentage"
        ],
        "title": "TaxRate",
        "type": "object",
        "x-expandableFields": ["flat_amount"],
        "x-resourceId": "tax_rate"
      },
      "tax_rate_flat_amount": {
        "description": "The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.",
        "properties": {
          "amount": {
            "description": "Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter ISO currency code, in lowercase.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["amount", "currency"],
        "title": "TaxRateFlatAmount",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal.configuration": {
        "description": "A Configurations object represents how features should be configured for terminal readers.",
        "properties": {
          "bbpos_wisepos_e": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "is_account_default": {
            "description": "Whether this Configuration is the default for your account",
            "nullable": true,
            "type": "boolean"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "name": {
            "description": "String indicating the name of the Configuration object, set by the user",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.configuration"],
            "type": "string"
          },
          "offline": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config"
          },
          "reboot_window": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window"
          },
          "stripe_s700": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
          },
          "tipping": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping"
          },
          "verifone_p400": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
          }
        },
        "required": ["id", "livemode", "object"],
        "title": "TerminalConfigurationConfiguration",
        "type": "object",
        "x-expandableFields": [
          "bbpos_wisepos_e",
          "offline",
          "reboot_window",
          "stripe_s700",
          "tipping",
          "verifone_p400"
        ],
        "x-resourceId": "terminal.configuration"
      },
      "terminal.connection_token": {
        "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)",
        "properties": {
          "location": {
            "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).",
            "maxLength": 5000,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.connection_token"],
            "type": "string"
          },
          "secret": {
            "description": "Your application should pass this token to the Stripe Terminal SDK.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["object", "secret"],
        "title": "TerminalConnectionToken",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "terminal.connection_token"
      },
      "terminal.location": {
        "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "configuration_overrides": {
            "description": "The ID of a configuration that will be used to customize all readers in this location.",
            "maxLength": 5000,
            "type": "string"
          },
          "display_name": {
            "description": "The display name of the location.",
            "maxLength": 5000,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.location"],
            "type": "string"
          }
        },
        "required": [
          "address",
          "display_name",
          "id",
          "livemode",
          "metadata",
          "object"
        ],
        "title": "TerminalLocationLocation",
        "type": "object",
        "x-expandableFields": ["address"],
        "x-resourceId": "terminal.location"
      },
      "terminal.reader": {
        "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)",
        "properties": {
          "action": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/terminal_reader_reader_resource_reader_action"
              }
            ],
            "description": "The most recent action performed by the reader.",
            "nullable": true
          },
          "device_sw_version": {
            "description": "The current software version of the reader.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "device_type": {
            "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.",
            "enum": [
              "bbpos_chipper2x",
              "bbpos_wisepad3",
              "bbpos_wisepos_e",
              "mobile_phone_reader",
              "simulated_wisepos_e",
              "stripe_m2",
              "stripe_s700",
              "verifone_P400"
            ],
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "ip_address": {
            "description": "The local IP address of the reader.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "label": {
            "description": "Custom label given to the reader for easier identification.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "location": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/terminal.location"
              }
            ],
            "description": "The location identifier of the reader.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/terminal.location"
                }
              ]
            }
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["terminal.reader"],
            "type": "string"
          },
          "serial_number": {
            "description": "Serial number of the reader.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "The networking status of the reader. We do not recommend using this field in flows that may block taking payments.",
            "enum": ["offline", "online"],
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "device_type",
          "id",
          "label",
          "livemode",
          "metadata",
          "object",
          "serial_number"
        ],
        "title": "TerminalReaderReader",
        "type": "object",
        "x-expandableFields": ["action", "location"],
        "x-resourceId": "terminal.reader"
      },
      "terminal_configuration_configuration_resource_currency_specific_config": {
        "description": "",
        "properties": {
          "fixed_amounts": {
            "description": "Fixed amounts displayed when collecting a tip",
            "items": {
              "type": "integer"
            },
            "nullable": true,
            "type": "array"
          },
          "percentages": {
            "description": "Percentages displayed when collecting a tip",
            "items": {
              "type": "integer"
            },
            "nullable": true,
            "type": "array"
          },
          "smart_tip_threshold": {
            "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed",
            "type": "integer"
          }
        },
        "title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_configuration_configuration_resource_device_type_specific_config": {
        "description": "",
        "properties": {
          "splashscreen": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/file"
              }
            ],
            "description": "A File ID representing an image you would like displayed on the reader.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/file"
                }
              ]
            }
          }
        },
        "title": "TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig",
        "type": "object",
        "x-expandableFields": ["splashscreen"]
      },
      "terminal_configuration_configuration_resource_offline_config": {
        "description": "",
        "properties": {
          "enabled": {
            "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.",
            "nullable": true,
            "type": "boolean"
          }
        },
        "title": "TerminalConfigurationConfigurationResourceOfflineConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_configuration_configuration_resource_reboot_window": {
        "description": "",
        "properties": {
          "end_hour": {
            "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.",
            "type": "integer"
          },
          "start_hour": {
            "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.",
            "type": "integer"
          }
        },
        "required": ["end_hour", "start_hour"],
        "title": "TerminalConfigurationConfigurationResourceRebootWindow",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_configuration_configuration_resource_tipping": {
        "description": "",
        "properties": {
          "aud": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "cad": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "chf": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "czk": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "dkk": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "eur": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "gbp": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "hkd": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "jpy": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "myr": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "nok": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "nzd": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "pln": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "sek": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "sgd": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          },
          "usd": {
            "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
          }
        },
        "title": "TerminalConfigurationConfigurationResourceTipping",
        "type": "object",
        "x-expandableFields": [
          "aud",
          "cad",
          "chf",
          "czk",
          "dkk",
          "eur",
          "gbp",
          "hkd",
          "jpy",
          "myr",
          "nok",
          "nzd",
          "pln",
          "sek",
          "sgd",
          "usd"
        ]
      },
      "terminal_reader_reader_resource_cart": {
        "description": "Represents a cart to be displayed on the reader",
        "properties": {
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "line_items": {
            "description": "List of line items in the cart.",
            "items": {
              "$ref": "#/components/schemas/terminal_reader_reader_resource_line_item"
            },
            "type": "array"
          },
          "tax": {
            "description": "Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "nullable": true,
            "type": "integer"
          },
          "total": {
            "description": "Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          }
        },
        "required": ["currency", "line_items", "total"],
        "title": "TerminalReaderReaderResourceCart",
        "type": "object",
        "x-expandableFields": ["line_items"]
      },
      "terminal_reader_reader_resource_line_item": {
        "description": "Represents a line item to be displayed on the reader",
        "properties": {
          "amount": {
            "description": "The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
            "type": "integer"
          },
          "description": {
            "description": "Description of the line item.",
            "maxLength": 5000,
            "type": "string"
          },
          "quantity": {
            "description": "The quantity of the line item.",
            "type": "integer"
          }
        },
        "required": ["amount", "description", "quantity"],
        "title": "TerminalReaderReaderResourceLineItem",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_reader_reader_resource_process_config": {
        "description": "Represents a per-transaction override of a reader configuration",
        "properties": {
          "enable_customer_cancellation": {
            "description": "Enable customer initiated cancellation when processing this payment.",
            "type": "boolean"
          },
          "skip_tipping": {
            "description": "Override showing a tipping selection screen on this transaction.",
            "type": "boolean"
          },
          "tipping": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config"
          }
        },
        "title": "TerminalReaderReaderResourceProcessConfig",
        "type": "object",
        "x-expandableFields": ["tipping"]
      },
      "terminal_reader_reader_resource_process_payment_intent_action": {
        "description": "Represents a reader action to process a payment intent",
        "properties": {
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "Most recent PaymentIntent processed by the reader.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "process_config": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_process_config"
          }
        },
        "required": ["payment_intent"],
        "title": "TerminalReaderReaderResourceProcessPaymentIntentAction",
        "type": "object",
        "x-expandableFields": ["payment_intent", "process_config"]
      },
      "terminal_reader_reader_resource_process_setup_config": {
        "description": "Represents a per-setup override of a reader configuration",
        "properties": {
          "enable_customer_cancellation": {
            "description": "Enable customer initiated cancellation when processing this SetupIntent.",
            "type": "boolean"
          }
        },
        "title": "TerminalReaderReaderResourceProcessSetupConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_reader_reader_resource_process_setup_intent_action": {
        "description": "Represents a reader action to process a setup intent",
        "properties": {
          "generated_card": {
            "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
            "maxLength": 5000,
            "type": "string"
          },
          "process_config": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config"
          },
          "setup_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/setup_intent"
              }
            ],
            "description": "Most recent SetupIntent processed by the reader.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/setup_intent"
                }
              ]
            }
          }
        },
        "required": ["setup_intent"],
        "title": "TerminalReaderReaderResourceProcessSetupIntentAction",
        "type": "object",
        "x-expandableFields": ["process_config", "setup_intent"]
      },
      "terminal_reader_reader_resource_reader_action": {
        "description": "Represents an action performed by the reader",
        "properties": {
          "failure_code": {
            "description": "Failure code, only set if status is `failed`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "failure_message": {
            "description": "Detailed failure message, only set if status is `failed`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "process_payment_intent": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action"
          },
          "process_setup_intent": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action"
          },
          "refund_payment": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_action"
          },
          "set_reader_display": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action"
          },
          "status": {
            "description": "Status of the action performed by the reader.",
            "enum": ["failed", "in_progress", "succeeded"],
            "type": "string"
          },
          "type": {
            "description": "Type of action performed by the reader.",
            "enum": [
              "process_payment_intent",
              "process_setup_intent",
              "refund_payment",
              "set_reader_display"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["status", "type"],
        "title": "TerminalReaderReaderResourceReaderAction",
        "type": "object",
        "x-expandableFields": [
          "process_payment_intent",
          "process_setup_intent",
          "refund_payment",
          "set_reader_display"
        ]
      },
      "terminal_reader_reader_resource_refund_payment_action": {
        "description": "Represents a reader action to refund a payment",
        "properties": {
          "amount": {
            "description": "The amount being refunded.",
            "type": "integer"
          },
          "charge": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "Charge that is being refunded.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "payment_intent": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/payment_intent"
              }
            ],
            "description": "Payment intent that is being refunded.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/payment_intent"
                }
              ]
            }
          },
          "reason": {
            "description": "The reason for the refund.",
            "enum": ["duplicate", "fraudulent", "requested_by_customer"],
            "type": "string"
          },
          "refund": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/refund"
              }
            ],
            "description": "Unique identifier for the refund object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/refund"
                }
              ]
            }
          },
          "refund_application_fee": {
            "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
            "type": "boolean"
          },
          "refund_payment_config": {
            "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config"
          },
          "reverse_transfer": {
            "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.",
            "type": "boolean"
          }
        },
        "title": "TerminalReaderReaderResourceRefundPaymentAction",
        "type": "object",
        "x-expandableFields": [
          "charge",
          "payment_intent",
          "refund",
          "refund_payment_config"
        ]
      },
      "terminal_reader_reader_resource_refund_payment_config": {
        "description": "Represents a per-transaction override of a reader configuration",
        "properties": {
          "enable_customer_cancellation": {
            "description": "Enable customer initiated cancellation when refunding this payment.",
            "type": "boolean"
          }
        },
        "title": "TerminalReaderReaderResourceRefundPaymentConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "terminal_reader_reader_resource_set_reader_display_action": {
        "description": "Represents a reader action to set the reader display",
        "properties": {
          "cart": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/terminal_reader_reader_resource_cart"
              }
            ],
            "description": "Cart object to be displayed by the reader.",
            "nullable": true
          },
          "type": {
            "description": "Type of information to be displayed by the reader.",
            "enum": ["cart"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TerminalReaderReaderResourceSetReaderDisplayAction",
        "type": "object",
        "x-expandableFields": ["cart"]
      },
      "terminal_reader_reader_resource_tipping_config": {
        "description": "Represents a per-transaction tipping configuration",
        "properties": {
          "amount_eligible": {
            "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).",
            "type": "integer"
          }
        },
        "title": "TerminalReaderReaderResourceTippingConfig",
        "type": "object",
        "x-expandableFields": []
      },
      "test_helpers.test_clock": {
        "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.",
        "properties": {
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "deletes_after": {
            "description": "Time at which this clock is scheduled to auto delete.",
            "format": "unix-time",
            "type": "integer"
          },
          "frozen_time": {
            "description": "Time at which all objects belonging to this clock are frozen.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "name": {
            "description": "The custom name supplied at creation.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["test_helpers.test_clock"],
            "type": "string"
          },
          "status": {
            "description": "The status of the Test Clock.",
            "enum": ["advancing", "internal_failure", "ready"],
            "type": "string"
          },
          "status_details": {
            "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
          }
        },
        "required": [
          "created",
          "deletes_after",
          "frozen_time",
          "id",
          "livemode",
          "object",
          "status",
          "status_details"
        ],
        "title": "TestClock",
        "type": "object",
        "x-expandableFields": ["status_details"],
        "x-resourceId": "test_helpers.test_clock"
      },
      "three_d_secure_details": {
        "description": "",
        "properties": {
          "authentication_flow": {
            "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.",
            "enum": ["challenge", "frictionless"],
            "nullable": true,
            "type": "string"
          },
          "electronic_commerce_indicator": {
            "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
            "enum": ["01", "02", "05", "06", "07"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "result": {
            "description": "Indicates the outcome of 3D Secure authentication.",
            "enum": [
              "attempt_acknowledged",
              "authenticated",
              "exempted",
              "failed",
              "not_supported",
              "processing_error"
            ],
            "nullable": true,
            "type": "string"
          },
          "result_reason": {
            "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.",
            "enum": [
              "abandoned",
              "bypassed",
              "canceled",
              "card_not_enrolled",
              "network_not_supported",
              "protocol_error",
              "rejected"
            ],
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "version": {
            "description": "The version of 3D Secure that was used.",
            "enum": ["1.0.2", "2.1.0", "2.2.0"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "three_d_secure_details",
        "type": "object",
        "x-expandableFields": []
      },
      "three_d_secure_details_charge": {
        "description": "",
        "properties": {
          "authentication_flow": {
            "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.",
            "enum": ["challenge", "frictionless"],
            "nullable": true,
            "type": "string"
          },
          "electronic_commerce_indicator": {
            "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
            "enum": ["01", "02", "05", "06", "07"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "exemption_indicator": {
            "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
            "enum": ["low_risk", "none"],
            "nullable": true,
            "type": "string"
          },
          "exemption_indicator_applied": {
            "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment.",
            "type": "boolean"
          },
          "result": {
            "description": "Indicates the outcome of 3D Secure authentication.",
            "enum": [
              "attempt_acknowledged",
              "authenticated",
              "exempted",
              "failed",
              "not_supported",
              "processing_error"
            ],
            "nullable": true,
            "type": "string"
          },
          "result_reason": {
            "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.",
            "enum": [
              "abandoned",
              "bypassed",
              "canceled",
              "card_not_enrolled",
              "network_not_supported",
              "protocol_error",
              "rejected"
            ],
            "nullable": true,
            "type": "string"
          },
          "transaction_id": {
            "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "version": {
            "description": "The version of 3D Secure that was used.",
            "enum": ["1.0.2", "2.1.0", "2.2.0"],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "title": "three_d_secure_details_charge",
        "type": "object",
        "x-expandableFields": []
      },
      "three_d_secure_usage": {
        "description": "",
        "properties": {
          "supported": {
            "description": "Whether 3D Secure is supported on this card.",
            "type": "boolean"
          }
        },
        "required": ["supported"],
        "title": "three_d_secure_usage",
        "type": "object",
        "x-expandableFields": []
      },
      "thresholds_resource_usage_alert_filter": {
        "description": "",
        "properties": {
          "customer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/customer"
              }
            ],
            "description": "Limit the scope of the alert to this customer ID",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/customer"
                }
              ]
            }
          },
          "type": {
            "enum": ["customer"],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "ThresholdsResourceUsageAlertFilter",
        "type": "object",
        "x-expandableFields": ["customer"]
      },
      "thresholds_resource_usage_threshold_config": {
        "description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.",
        "properties": {
          "filters": {
            "description": "The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.",
            "items": {
              "$ref": "#/components/schemas/thresholds_resource_usage_alert_filter"
            },
            "nullable": true,
            "type": "array"
          },
          "gte": {
            "description": "The value at which this alert will trigger.",
            "type": "integer"
          },
          "meter": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/billing.meter"
              }
            ],
            "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/billing.meter"
                }
              ]
            }
          },
          "recurrence": {
            "description": "Defines how the alert will behave.",
            "enum": ["one_time"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["gte", "meter", "recurrence"],
        "title": "ThresholdsResourceUsageThresholdConfig",
        "type": "object",
        "x-expandableFields": ["filters", "meter"]
      },
      "token": {
        "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.",
        "properties": {
          "bank_account": {
            "$ref": "#/components/schemas/bank_account"
          },
          "card": {
            "$ref": "#/components/schemas/card"
          },
          "client_ip": {
            "description": "IP address of the client that generates the token.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["token"],
            "type": "string"
          },
          "type": {
            "description": "Type of the token: `account`, `bank_account`, `card`, or `pii`.",
            "maxLength": 5000,
            "type": "string"
          },
          "used": {
            "description": "Determines if you have already used this token (you can only use tokens once).",
            "type": "boolean"
          }
        },
        "required": ["created", "id", "livemode", "object", "type", "used"],
        "title": "Token",
        "type": "object",
        "x-expandableFields": ["bank_account", "card"],
        "x-resourceId": "token"
      },
      "token_card_networks": {
        "description": "",
        "properties": {
          "preferred": {
            "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "token_card_networks",
        "type": "object",
        "x-expandableFields": []
      },
      "topup": {
        "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)",
        "properties": {
          "amount": {
            "description": "Amount transferred.",
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "maxLength": 5000,
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "expected_availability_date": {
            "description": "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.",
            "nullable": true,
            "type": "integer"
          },
          "failure_code": {
            "description": "Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "failure_message": {
            "description": "Message to user further explaining reason for top-up failure if available.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["topup"],
            "type": "string"
          },
          "source": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "description": "The source field is deprecated. It might not always be present in the API response.",
            "nullable": true
          },
          "statement_descriptor": {
            "description": "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.",
            "enum": ["canceled", "failed", "pending", "reversed", "succeeded"],
            "type": "string"
          },
          "transfer_group": {
            "description": "A string that identifies this top-up as part of a group.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "id",
          "livemode",
          "metadata",
          "object",
          "status"
        ],
        "title": "Topup",
        "type": "object",
        "x-expandableFields": ["balance_transaction", "source"],
        "x-resourceId": "topup"
      },
      "transfer": {
        "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)",
        "properties": {
          "amount": {
            "description": "Amount in cents (or local equivalent) to be transferred.",
            "type": "integer"
          },
          "amount_reversed": {
            "description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).",
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "Balance transaction that describes the impact of this transfer on your account balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "created": {
            "description": "Time that this record of the transfer was first created.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "ID of the Stripe account the transfer was sent to.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          },
          "destination_payment": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["transfer"],
            "type": "string"
          },
          "reversals": {
            "description": "A list of reversals that have been applied to the transfer.",
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/transfer_reversal"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "TransferReversalList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "reversed": {
            "description": "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.",
            "type": "boolean"
          },
          "source_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/charge"
              }
            ],
            "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/charge"
                }
              ]
            }
          },
          "source_type": {
            "description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.",
            "maxLength": 5000,
            "type": "string"
          },
          "transfer_group": {
            "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "amount",
          "amount_reversed",
          "created",
          "currency",
          "id",
          "livemode",
          "metadata",
          "object",
          "reversals",
          "reversed"
        ],
        "title": "Transfer",
        "type": "object",
        "x-expandableFields": [
          "balance_transaction",
          "destination",
          "destination_payment",
          "reversals",
          "source_transaction"
        ],
        "x-resourceId": "transfer"
      },
      "transfer_data": {
        "description": "",
        "properties": {
          "amount": {
            "description": "The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).",
            "type": "integer"
          },
          "destination": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/account"
              }
            ],
            "description": "The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/account"
                }
              ]
            }
          }
        },
        "required": ["destination"],
        "title": "transfer_data",
        "type": "object",
        "x-expandableFields": ["destination"]
      },
      "transfer_reversal": {
        "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)",
        "properties": {
          "amount": {
            "description": "Amount, in cents (or local equivalent).",
            "type": "integer"
          },
          "balance_transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/balance_transaction"
              }
            ],
            "description": "Balance transaction that describes the impact on your account balance.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              ]
            }
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "destination_payment_refund": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/refund"
              }
            ],
            "description": "Linked payment refund for the transfer reversal.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/refund"
                }
              ]
            }
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["transfer_reversal"],
            "type": "string"
          },
          "source_refund": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/refund"
              }
            ],
            "description": "ID of the refund responsible for the transfer reversal.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/refund"
                }
              ]
            }
          },
          "transfer": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/transfer"
              }
            ],
            "description": "ID of the transfer that was reversed.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/transfer"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "id",
          "object",
          "transfer"
        ],
        "title": "TransferReversal",
        "type": "object",
        "x-expandableFields": [
          "balance_transaction",
          "destination_payment_refund",
          "source_refund",
          "transfer"
        ],
        "x-resourceId": "transfer_reversal"
      },
      "transfer_schedule": {
        "description": "",
        "properties": {
          "delay_days": {
            "description": "The number of days charges for the account will be held before being paid out.",
            "type": "integer"
          },
          "interval": {
            "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.",
            "maxLength": 5000,
            "type": "string"
          },
          "monthly_anchor": {
            "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.",
            "type": "integer"
          },
          "weekly_anchor": {
            "description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["delay_days", "interval"],
        "title": "TransferSchedule",
        "type": "object",
        "x-expandableFields": []
      },
      "transform_quantity": {
        "description": "",
        "properties": {
          "divide_by": {
            "description": "Divide usage by this number.",
            "type": "integer"
          },
          "round": {
            "description": "After division, either round the result `up` or `down`.",
            "enum": ["down", "up"],
            "type": "string"
          }
        },
        "required": ["divide_by", "round"],
        "title": "TransformQuantity",
        "type": "object",
        "x-expandableFields": []
      },
      "transform_usage": {
        "description": "",
        "properties": {
          "divide_by": {
            "description": "Divide usage by this number.",
            "type": "integer"
          },
          "round": {
            "description": "After division, either round the result `up` or `down`.",
            "enum": ["down", "up"],
            "type": "string"
          }
        },
        "required": ["divide_by", "round"],
        "title": "TransformUsage",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury.credit_reversal": {
        "description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "financial_account": {
            "description": "The FinancialAccount to reverse funds from.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "network": {
            "description": "The rails used to reverse the funds.",
            "enum": ["ach", "stripe"],
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.credit_reversal"],
            "type": "string"
          },
          "received_credit": {
            "description": "The ReceivedCredit being reversed.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Status of the CreditReversal",
            "enum": ["canceled", "posted", "processing"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_received_credits_resource_status_transitions"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "financial_account",
          "id",
          "livemode",
          "metadata",
          "network",
          "object",
          "received_credit",
          "status",
          "status_transitions"
        ],
        "title": "TreasuryReceivedCreditsResourceCreditReversal",
        "type": "object",
        "x-expandableFields": ["status_transitions", "transaction"],
        "x-resourceId": "treasury.credit_reversal"
      },
      "treasury.debit_reversal": {
        "description": "You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "financial_account": {
            "description": "The FinancialAccount to reverse funds from.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "linked_flows": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows"
              }
            ],
            "description": "Other flows linked to a DebitReversal.",
            "nullable": true
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "network": {
            "description": "The rails used to reverse the funds.",
            "enum": ["ach", "card"],
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.debit_reversal"],
            "type": "string"
          },
          "received_debit": {
            "description": "The ReceivedDebit being reversed.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Status of the DebitReversal",
            "enum": ["failed", "processing", "succeeded"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_received_debits_resource_status_transitions"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "id",
          "livemode",
          "metadata",
          "network",
          "object",
          "received_debit",
          "status",
          "status_transitions"
        ],
        "title": "TreasuryReceivedDebitsResourceDebitReversal",
        "type": "object",
        "x-expandableFields": [
          "linked_flows",
          "status_transitions",
          "transaction"
        ],
        "x-resourceId": "treasury.debit_reversal"
      },
      "treasury.financial_account": {
        "description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.",
        "properties": {
          "active_features": {
            "description": "The array of paths to active Features in the Features hash.",
            "items": {
              "enum": [
                "card_issuing",
                "deposit_insurance",
                "financial_addresses.aba",
                "financial_addresses.aba.forwarding",
                "inbound_transfers.ach",
                "intra_stripe_flows",
                "outbound_payments.ach",
                "outbound_payments.us_domestic_wire",
                "outbound_transfers.ach",
                "outbound_transfers.us_domestic_wire",
                "remote_deposit_capture"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "balance": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_balance"
          },
          "country": {
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
            "maxLength": 5000,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "features": {
            "$ref": "#/components/schemas/treasury.financial_account_features"
          },
          "financial_addresses": {
            "description": "The set of credentials that resolve to a FinancialAccount.",
            "items": {
              "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_address"
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "is_default": {
            "type": "boolean"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "nullable": true,
            "type": "object"
          },
          "nickname": {
            "description": "The nickname for the FinancialAccount.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.financial_account"],
            "type": "string"
          },
          "pending_features": {
            "description": "The array of paths to pending Features in the Features hash.",
            "items": {
              "enum": [
                "card_issuing",
                "deposit_insurance",
                "financial_addresses.aba",
                "financial_addresses.aba.forwarding",
                "inbound_transfers.ach",
                "intra_stripe_flows",
                "outbound_payments.ach",
                "outbound_payments.us_domestic_wire",
                "outbound_transfers.ach",
                "outbound_transfers.us_domestic_wire",
                "remote_deposit_capture"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "platform_restrictions": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions"
              }
            ],
            "description": "The set of functionalities that the platform can restrict on the FinancialAccount.",
            "nullable": true
          },
          "restricted_features": {
            "description": "The array of paths to restricted Features in the Features hash.",
            "items": {
              "enum": [
                "card_issuing",
                "deposit_insurance",
                "financial_addresses.aba",
                "financial_addresses.aba.forwarding",
                "inbound_transfers.ach",
                "intra_stripe_flows",
                "outbound_payments.ach",
                "outbound_payments.us_domestic_wire",
                "outbound_transfers.ach",
                "outbound_transfers.us_domestic_wire",
                "remote_deposit_capture"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "status": {
            "description": "Status of this FinancialAccount.",
            "enum": ["closed", "open"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "status_details": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_status_details"
          },
          "supported_currencies": {
            "description": "The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "balance",
          "country",
          "created",
          "financial_addresses",
          "id",
          "livemode",
          "object",
          "status",
          "status_details",
          "supported_currencies"
        ],
        "title": "TreasuryFinancialAccountsResourceFinancialAccount",
        "type": "object",
        "x-expandableFields": [
          "balance",
          "features",
          "financial_addresses",
          "platform_restrictions",
          "status_details"
        ],
        "x-resourceId": "treasury.financial_account"
      },
      "treasury.financial_account_features": {
        "description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.",
        "properties": {
          "card_issuing": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
          },
          "deposit_insurance": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
          },
          "financial_addresses": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features"
          },
          "inbound_transfers": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers"
          },
          "intra_stripe_flows": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.financial_account_features"],
            "type": "string"
          },
          "outbound_payments": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_payments"
          },
          "outbound_transfers": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers"
          }
        },
        "required": ["object"],
        "title": "TreasuryFinancialAccountsResourceFinancialAccountFeatures",
        "type": "object",
        "x-expandableFields": [
          "card_issuing",
          "deposit_insurance",
          "financial_addresses",
          "inbound_transfers",
          "intra_stripe_flows",
          "outbound_payments",
          "outbound_transfers"
        ],
        "x-resourceId": "treasury.financial_account_features"
      },
      "treasury.inbound_transfer": {
        "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "cancelable": {
            "description": "Returns `true` if the InboundTransfer is able to be canceled.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "failure_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_inbound_transfers_resource_failure_details"
              }
            ],
            "description": "Details about this InboundTransfer's failure. Only set when status is `failed`.",
            "nullable": true
          },
          "financial_account": {
            "description": "The FinancialAccount that received the funds.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "linked_flows": {
            "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.inbound_transfer"],
            "type": "string"
          },
          "origin_payment_method": {
            "description": "The origin payment method to be debited for an InboundTransfer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "origin_payment_method_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/inbound_transfers"
              }
            ],
            "description": "Details about the PaymentMethod for an InboundTransfer.",
            "nullable": true
          },
          "returned": {
            "description": "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.",
            "nullable": true,
            "type": "boolean"
          },
          "statement_descriptor": {
            "description": "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been \"confirmed\" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.",
            "enum": ["canceled", "failed", "processing", "succeeded"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "cancelable",
          "created",
          "currency",
          "financial_account",
          "id",
          "linked_flows",
          "livemode",
          "metadata",
          "object",
          "statement_descriptor",
          "status",
          "status_transitions"
        ],
        "title": "TreasuryInboundTransfersResourceInboundTransfer",
        "type": "object",
        "x-expandableFields": [
          "failure_details",
          "linked_flows",
          "origin_payment_method_details",
          "status_transitions",
          "transaction"
        ],
        "x-resourceId": "treasury.inbound_transfer"
      },
      "treasury.outbound_payment": {
        "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "cancelable": {
            "description": "Returns `true` if the object can be canceled, and `false` otherwise.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "customer": {
            "description": "ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination_payment_method": {
            "description": "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination_payment_method_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/outbound_payments_payment_method_details"
              }
            ],
            "description": "Details about the PaymentMethod for an OutboundPayment.",
            "nullable": true
          },
          "end_user_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"
              }
            ],
            "description": "Details about the end user.",
            "nullable": true
          },
          "expected_arrival_date": {
            "description": "The date when funds are expected to arrive in the destination account.",
            "format": "unix-time",
            "type": "integer"
          },
          "financial_account": {
            "description": "The FinancialAccount that funds were pulled from.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.outbound_payment"],
            "type": "string"
          },
          "returned_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_outbound_payments_resource_returned_status"
              }
            ],
            "description": "Details about a returned OutboundPayment. Only set when the status is `returned`.",
            "nullable": true
          },
          "statement_descriptor": {
            "description": "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.",
            "enum": ["canceled", "failed", "posted", "processing", "returned"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"
          },
          "tracking_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"
              }
            ],
            "description": "Details about network-specific tracking information if available.",
            "nullable": true
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "cancelable",
          "created",
          "currency",
          "expected_arrival_date",
          "financial_account",
          "id",
          "livemode",
          "metadata",
          "object",
          "statement_descriptor",
          "status",
          "status_transitions",
          "transaction"
        ],
        "title": "TreasuryOutboundPaymentsResourceOutboundPayment",
        "type": "object",
        "x-expandableFields": [
          "destination_payment_method_details",
          "end_user_details",
          "returned_details",
          "status_transitions",
          "tracking_details",
          "transaction"
        ],
        "x-resourceId": "treasury.outbound_payment"
      },
      "treasury.outbound_transfer": {
        "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "cancelable": {
            "description": "Returns `true` if the object can be canceled, and `false` otherwise.",
            "type": "boolean"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination_payment_method": {
            "description": "The PaymentMethod used as the payment instrument for an OutboundTransfer.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "destination_payment_method_details": {
            "$ref": "#/components/schemas/outbound_transfers_payment_method_details"
          },
          "expected_arrival_date": {
            "description": "The date when funds are expected to arrive in the destination account.",
            "format": "unix-time",
            "type": "integer"
          },
          "financial_account": {
            "description": "The FinancialAccount that funds were pulled from.",
            "maxLength": 5000,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.outbound_transfer"],
            "type": "string"
          },
          "returned_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_outbound_transfers_resource_returned_details"
              }
            ],
            "description": "Details about a returned OutboundTransfer. Only set when the status is `returned`.",
            "nullable": true
          },
          "statement_descriptor": {
            "description": "Information about the OutboundTransfer to be sent to the recipient account.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.",
            "enum": ["canceled", "failed", "posted", "processing", "returned"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"
          },
          "tracking_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"
              }
            ],
            "description": "Details about network-specific tracking information if available.",
            "nullable": true
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "cancelable",
          "created",
          "currency",
          "destination_payment_method_details",
          "expected_arrival_date",
          "financial_account",
          "id",
          "livemode",
          "metadata",
          "object",
          "statement_descriptor",
          "status",
          "status_transitions",
          "transaction"
        ],
        "title": "TreasuryOutboundTransfersResourceOutboundTransfer",
        "type": "object",
        "x-expandableFields": [
          "destination_payment_method_details",
          "returned_details",
          "status_transitions",
          "tracking_details",
          "transaction"
        ],
        "x-resourceId": "treasury.outbound_transfer"
      },
      "treasury.received_credit": {
        "description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "type": "string"
          },
          "failure_code": {
            "description": "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.",
            "enum": [
              "account_closed",
              "account_frozen",
              "international_transaction",
              "other"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "financial_account": {
            "description": "The FinancialAccount that received the funds.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "initiating_payment_method_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
          },
          "linked_flows": {
            "$ref": "#/components/schemas/treasury_received_credits_resource_linked_flows"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "network": {
            "description": "The rails used to send the funds.",
            "enum": ["ach", "card", "stripe", "us_domestic_wire"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.received_credit"],
            "type": "string"
          },
          "reversal_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_received_credits_resource_reversal_details"
              }
            ],
            "description": "Details describing when a ReceivedCredit may be reversed.",
            "nullable": true
          },
          "status": {
            "description": "Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.",
            "enum": ["failed", "succeeded"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "description",
          "id",
          "initiating_payment_method_details",
          "linked_flows",
          "livemode",
          "network",
          "object",
          "status"
        ],
        "title": "TreasuryReceivedCreditsResourceReceivedCredit",
        "type": "object",
        "x-expandableFields": [
          "initiating_payment_method_details",
          "linked_flows",
          "reversal_details",
          "transaction"
        ],
        "x-resourceId": "treasury.received_credit"
      },
      "treasury.received_debit": {
        "description": "ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "type": "string"
          },
          "failure_code": {
            "description": "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.",
            "enum": [
              "account_closed",
              "account_frozen",
              "insufficient_funds",
              "international_transaction",
              "other"
            ],
            "nullable": true,
            "type": "string"
          },
          "financial_account": {
            "description": "The FinancialAccount that funds were pulled from.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "hosted_regulatory_receipt_url": {
            "description": "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "initiating_payment_method_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
          },
          "linked_flows": {
            "$ref": "#/components/schemas/treasury_received_debits_resource_linked_flows"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "network": {
            "description": "The network used for the ReceivedDebit.",
            "enum": ["ach", "card", "stripe"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.received_debit"],
            "type": "string"
          },
          "reversal_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_received_debits_resource_reversal_details"
              }
            ],
            "description": "Details describing when a ReceivedDebit might be reversed.",
            "nullable": true
          },
          "status": {
            "description": "Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.",
            "enum": ["failed", "succeeded"],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "nullable": true,
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": [
          "amount",
          "created",
          "currency",
          "description",
          "id",
          "linked_flows",
          "livemode",
          "network",
          "object",
          "status"
        ],
        "title": "TreasuryReceivedDebitsResourceReceivedDebit",
        "type": "object",
        "x-expandableFields": [
          "initiating_payment_method_details",
          "linked_flows",
          "reversal_details",
          "transaction"
        ],
        "x-resourceId": "treasury.received_debit"
      },
      "treasury.transaction": {
        "description": "Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.",
        "properties": {
          "amount": {
            "description": "Amount (in cents) transferred.",
            "type": "integer"
          },
          "balance_impact": {
            "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "description": {
            "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
            "maxLength": 5000,
            "type": "string"
          },
          "entries": {
            "description": "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.",
            "nullable": true,
            "properties": {
              "data": {
                "description": "Details about each object.",
                "items": {
                  "$ref": "#/components/schemas/treasury.transaction_entry"
                },
                "type": "array"
              },
              "has_more": {
                "description": "True if this list has another page of items after this one that can be fetched.",
                "type": "boolean"
              },
              "object": {
                "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                "enum": ["list"],
                "type": "string"
              },
              "url": {
                "description": "The URL where this list can be accessed.",
                "maxLength": 5000,
                "pattern": "^/v1/treasury/transaction_entries",
                "type": "string"
              }
            },
            "required": ["data", "has_more", "object", "url"],
            "title": "TreasuryTransactionsResourceTransactionEntryList",
            "type": "object",
            "x-expandableFields": ["data"]
          },
          "financial_account": {
            "description": "The FinancialAccount associated with this object.",
            "maxLength": 5000,
            "type": "string"
          },
          "flow": {
            "description": "ID of the flow that created the Transaction.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "flow_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
              }
            ],
            "description": "Details of the flow that created the Transaction.",
            "nullable": true
          },
          "flow_type": {
            "description": "Type of the flow that created the Transaction.",
            "enum": [
              "credit_reversal",
              "debit_reversal",
              "inbound_transfer",
              "issuing_authorization",
              "other",
              "outbound_payment",
              "outbound_transfer",
              "received_credit",
              "received_debit"
            ],
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.transaction"],
            "type": "string"
          },
          "status": {
            "description": "Status of the Transaction.",
            "enum": ["open", "posted", "void"],
            "type": "string"
          },
          "status_transitions": {
            "$ref": "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions"
          }
        },
        "required": [
          "amount",
          "balance_impact",
          "created",
          "currency",
          "description",
          "financial_account",
          "flow_type",
          "id",
          "livemode",
          "object",
          "status",
          "status_transitions"
        ],
        "title": "TreasuryTransactionsResourceTransaction",
        "type": "object",
        "x-expandableFields": [
          "balance_impact",
          "entries",
          "flow_details",
          "status_transitions"
        ],
        "x-resourceId": "treasury.transaction"
      },
      "treasury.transaction_entry": {
        "description": "TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).",
        "properties": {
          "balance_impact": {
            "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "currency": {
            "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "format": "currency",
            "type": "string"
          },
          "effective_at": {
            "description": "When the TransactionEntry will impact the FinancialAccount's balance.",
            "format": "unix-time",
            "type": "integer"
          },
          "financial_account": {
            "description": "The FinancialAccount associated with this object.",
            "maxLength": 5000,
            "type": "string"
          },
          "flow": {
            "description": "Token of the flow associated with the TransactionEntry.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "flow_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
              }
            ],
            "description": "Details of the flow associated with the TransactionEntry.",
            "nullable": true
          },
          "flow_type": {
            "description": "Type of the flow associated with the TransactionEntry.",
            "enum": [
              "credit_reversal",
              "debit_reversal",
              "inbound_transfer",
              "issuing_authorization",
              "other",
              "outbound_payment",
              "outbound_transfer",
              "received_credit",
              "received_debit"
            ],
            "type": "string"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["treasury.transaction_entry"],
            "type": "string"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          },
          "type": {
            "description": "The specific money movement that generated the TransactionEntry.",
            "enum": [
              "credit_reversal",
              "credit_reversal_posting",
              "debit_reversal",
              "inbound_transfer",
              "inbound_transfer_return",
              "issuing_authorization_hold",
              "issuing_authorization_release",
              "other",
              "outbound_payment",
              "outbound_payment_cancellation",
              "outbound_payment_failure",
              "outbound_payment_posting",
              "outbound_payment_return",
              "outbound_transfer",
              "outbound_transfer_cancellation",
              "outbound_transfer_failure",
              "outbound_transfer_posting",
              "outbound_transfer_return",
              "received_credit",
              "received_debit"
            ],
            "type": "string"
          }
        },
        "required": [
          "balance_impact",
          "created",
          "currency",
          "effective_at",
          "financial_account",
          "flow_type",
          "id",
          "livemode",
          "object",
          "transaction",
          "type"
        ],
        "title": "TreasuryTransactionsResourceTransactionEntry",
        "type": "object",
        "x-expandableFields": ["balance_impact", "flow_details", "transaction"],
        "x-resourceId": "treasury.transaction_entry"
      },
      "treasury_financial_accounts_resource_aba_record": {
        "description": "ABA Records contain U.S. bank account details per the ABA format.",
        "properties": {
          "account_holder_name": {
            "description": "The name of the person or business that owns the bank account.",
            "maxLength": 5000,
            "type": "string"
          },
          "account_number": {
            "description": "The account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "account_number_last4": {
            "description": "The last four characters of the account number.",
            "maxLength": 5000,
            "type": "string"
          },
          "bank_name": {
            "description": "Name of the bank.",
            "maxLength": 5000,
            "type": "string"
          },
          "routing_number": {
            "description": "Routing number for the account.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "account_holder_name",
          "account_number_last4",
          "bank_name",
          "routing_number"
        ],
        "title": "TreasuryFinancialAccountsResourceABARecord",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_financial_accounts_resource_aba_toggle_settings": {
        "description": "Toggle settings for enabling/disabling the ABA address feature",
        "properties": {
          "requested": {
            "description": "Whether the FinancialAccount should have the Feature.",
            "type": "boolean"
          },
          "status": {
            "description": "Whether the Feature is operational.",
            "enum": ["active", "pending", "restricted"],
            "type": "string"
          },
          "status_details": {
            "description": "Additional details; includes at least one entry when the status is not `active`.",
            "items": {
              "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
            },
            "type": "array"
          }
        },
        "required": ["requested", "status", "status_details"],
        "title": "TreasuryFinancialAccountsResourceAbaToggleSettings",
        "type": "object",
        "x-expandableFields": ["status_details"]
      },
      "treasury_financial_accounts_resource_balance": {
        "description": "Balance information for the FinancialAccount",
        "properties": {
          "cash": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "Funds the user can spend right now.",
            "type": "object"
          },
          "inbound_pending": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "Funds not spendable yet, but will become available at a later time.",
            "type": "object"
          },
          "outbound_pending": {
            "additionalProperties": {
              "type": "integer"
            },
            "description": "Funds in the account, but not spendable because they are being held for pending outbound flows.",
            "type": "object"
          }
        },
        "required": ["cash", "inbound_pending", "outbound_pending"],
        "title": "TreasuryFinancialAccountsResourceBalance",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_financial_accounts_resource_closed_status_details": {
        "description": "",
        "properties": {
          "reasons": {
            "description": "The array that contains reasons for a FinancialAccount closure.",
            "items": {
              "enum": ["account_rejected", "closed_by_platform", "other"],
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["reasons"],
        "title": "TreasuryFinancialAccountsResourceClosedStatusDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_financial_accounts_resource_financial_address": {
        "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
        "properties": {
          "aba": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_record"
          },
          "supported_networks": {
            "description": "The list of networks that the address supports",
            "items": {
              "enum": ["ach", "us_domestic_wire"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "type": "array"
          },
          "type": {
            "description": "The type of financial address",
            "enum": ["aba"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["type"],
        "title": "TreasuryFinancialAccountsResourceFinancialAddress",
        "type": "object",
        "x-expandableFields": ["aba"]
      },
      "treasury_financial_accounts_resource_financial_addresses_features": {
        "description": "Settings related to Financial Addresses features on a Financial Account",
        "properties": {
          "aba": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings"
          }
        },
        "title": "TreasuryFinancialAccountsResourceFinancialAddressesFeatures",
        "type": "object",
        "x-expandableFields": ["aba"]
      },
      "treasury_financial_accounts_resource_inbound_ach_toggle_settings": {
        "description": "Toggle settings for enabling/disabling an inbound ACH specific feature",
        "properties": {
          "requested": {
            "description": "Whether the FinancialAccount should have the Feature.",
            "type": "boolean"
          },
          "status": {
            "description": "Whether the Feature is operational.",
            "enum": ["active", "pending", "restricted"],
            "type": "string"
          },
          "status_details": {
            "description": "Additional details; includes at least one entry when the status is not `active`.",
            "items": {
              "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
            },
            "type": "array"
          }
        },
        "required": ["requested", "status", "status_details"],
        "title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings",
        "type": "object",
        "x-expandableFields": ["status_details"]
      },
      "treasury_financial_accounts_resource_inbound_transfers": {
        "description": "InboundTransfers contains inbound transfers features for a FinancialAccount.",
        "properties": {
          "ach": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings"
          }
        },
        "title": "TreasuryFinancialAccountsResourceInboundTransfers",
        "type": "object",
        "x-expandableFields": ["ach"]
      },
      "treasury_financial_accounts_resource_outbound_ach_toggle_settings": {
        "description": "Toggle settings for enabling/disabling an outbound ACH specific feature",
        "properties": {
          "requested": {
            "description": "Whether the FinancialAccount should have the Feature.",
            "type": "boolean"
          },
          "status": {
            "description": "Whether the Feature is operational.",
            "enum": ["active", "pending", "restricted"],
            "type": "string"
          },
          "status_details": {
            "description": "Additional details; includes at least one entry when the status is not `active`.",
            "items": {
              "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
            },
            "type": "array"
          }
        },
        "required": ["requested", "status", "status_details"],
        "title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings",
        "type": "object",
        "x-expandableFields": ["status_details"]
      },
      "treasury_financial_accounts_resource_outbound_payments": {
        "description": "Settings related to Outbound Payments features on a Financial Account",
        "properties": {
          "ach": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
          },
          "us_domestic_wire": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
          }
        },
        "title": "TreasuryFinancialAccountsResourceOutboundPayments",
        "type": "object",
        "x-expandableFields": ["ach", "us_domestic_wire"]
      },
      "treasury_financial_accounts_resource_outbound_transfers": {
        "description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.",
        "properties": {
          "ach": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
          },
          "us_domestic_wire": {
            "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
          }
        },
        "title": "TreasuryFinancialAccountsResourceOutboundTransfers",
        "type": "object",
        "x-expandableFields": ["ach", "us_domestic_wire"]
      },
      "treasury_financial_accounts_resource_platform_restrictions": {
        "description": "Restrictions that a Connect Platform has placed on this FinancialAccount.",
        "properties": {
          "inbound_flows": {
            "description": "Restricts all inbound money movement.",
            "enum": ["restricted", "unrestricted"],
            "nullable": true,
            "type": "string"
          },
          "outbound_flows": {
            "description": "Restricts all outbound money movement.",
            "enum": ["restricted", "unrestricted"],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryFinancialAccountsResourcePlatformRestrictions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_financial_accounts_resource_status_details": {
        "description": "",
        "properties": {
          "closed": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_financial_accounts_resource_closed_status_details"
              }
            ],
            "description": "Details related to the closure of this FinancialAccount",
            "nullable": true
          }
        },
        "title": "TreasuryFinancialAccountsResourceStatusDetails",
        "type": "object",
        "x-expandableFields": ["closed"]
      },
      "treasury_financial_accounts_resource_toggle_settings": {
        "description": "Toggle settings for enabling/disabling a feature",
        "properties": {
          "requested": {
            "description": "Whether the FinancialAccount should have the Feature.",
            "type": "boolean"
          },
          "status": {
            "description": "Whether the Feature is operational.",
            "enum": ["active", "pending", "restricted"],
            "type": "string"
          },
          "status_details": {
            "description": "Additional details; includes at least one entry when the status is not `active`.",
            "items": {
              "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
            },
            "type": "array"
          }
        },
        "required": ["requested", "status", "status_details"],
        "title": "TreasuryFinancialAccountsResourceToggleSettings",
        "type": "object",
        "x-expandableFields": ["status_details"]
      },
      "treasury_financial_accounts_resource_toggles_setting_status_details": {
        "description": "Additional details on the FinancialAccount Features information.",
        "properties": {
          "code": {
            "description": "Represents the reason why the status is `pending` or `restricted`.",
            "enum": [
              "activating",
              "capability_not_requested",
              "financial_account_closed",
              "rejected_other",
              "rejected_unsupported_business",
              "requirements_past_due",
              "requirements_pending_verification",
              "restricted_by_platform",
              "restricted_other"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "resolution": {
            "description": "Represents what the user should do, if anything, to activate the Feature.",
            "enum": [
              "contact_stripe",
              "provide_information",
              "remove_restriction"
            ],
            "nullable": true,
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "restriction": {
            "description": "The `platform_restrictions` that are restricting this Feature.",
            "enum": ["inbound_flows", "outbound_flows"],
            "type": "string",
            "x-stripeBypassValidation": true
          }
        },
        "required": ["code"],
        "title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_inbound_transfers_resource_failure_details": {
        "description": "",
        "properties": {
          "code": {
            "description": "Reason for the failure.",
            "enum": [
              "account_closed",
              "account_frozen",
              "bank_account_restricted",
              "bank_ownership_changed",
              "debit_not_authorized",
              "incorrect_account_holder_address",
              "incorrect_account_holder_name",
              "incorrect_account_holder_tax_id",
              "insufficient_funds",
              "invalid_account_number",
              "invalid_currency",
              "no_account",
              "other"
            ],
            "type": "string"
          }
        },
        "required": ["code"],
        "title": "TreasuryInboundTransfersResourceFailureDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": {
        "description": "",
        "properties": {
          "received_debit": {
            "description": "If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": {
        "description": "",
        "properties": {
          "canceled_at": {
            "description": "Timestamp describing when an InboundTransfer changed status to `canceled`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "failed_at": {
            "description": "Timestamp describing when an InboundTransfer changed status to `failed`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "succeeded_at": {
            "description": "Timestamp describing when an InboundTransfer changed status to `succeeded`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_payments_resource_ach_tracking_details": {
        "description": "",
        "properties": {
          "trace_id": {
            "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["trace_id"],
        "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": {
        "description": "",
        "properties": {
          "ip_address": {
            "description": "IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "present": {
            "description": "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.",
            "type": "boolean"
          }
        },
        "required": ["present"],
        "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": {
        "description": "",
        "properties": {
          "canceled_at": {
            "description": "Timestamp describing when an OutboundPayment changed status to `canceled`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "failed_at": {
            "description": "Timestamp describing when an OutboundPayment changed status to `failed`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "posted_at": {
            "description": "Timestamp describing when an OutboundPayment changed status to `posted`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "returned_at": {
            "description": "Timestamp describing when an OutboundPayment changed status to `returned`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": {
        "description": "",
        "properties": {
          "ach": {
            "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details"
          },
          "type": {
            "description": "The US bank account network used to send funds.",
            "enum": ["ach", "us_domestic_wire"],
            "type": "string"
          },
          "us_domestic_wire": {
            "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details"
          }
        },
        "required": ["type"],
        "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails",
        "type": "object",
        "x-expandableFields": ["ach", "us_domestic_wire"]
      },
      "treasury_outbound_payments_resource_returned_status": {
        "description": "",
        "properties": {
          "code": {
            "description": "Reason for the return.",
            "enum": [
              "account_closed",
              "account_frozen",
              "bank_account_restricted",
              "bank_ownership_changed",
              "declined",
              "incorrect_account_holder_name",
              "invalid_account_number",
              "invalid_currency",
              "no_account",
              "other"
            ],
            "type": "string"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": ["code", "transaction"],
        "title": "TreasuryOutboundPaymentsResourceReturnedStatus",
        "type": "object",
        "x-expandableFields": ["transaction"]
      },
      "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": {
        "description": "",
        "properties": {
          "chips": {
            "description": "CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "imad": {
            "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "omad": {
            "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_transfers_resource_ach_tracking_details": {
        "description": "",
        "properties": {
          "trace_id": {
            "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": ["trace_id"],
        "title": "TreasuryOutboundTransfersResourceACHTrackingDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": {
        "description": "",
        "properties": {
          "ach": {
            "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details"
          },
          "type": {
            "description": "The US bank account network used to send funds.",
            "enum": ["ach", "us_domestic_wire"],
            "type": "string"
          },
          "us_domestic_wire": {
            "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details"
          }
        },
        "required": ["type"],
        "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails",
        "type": "object",
        "x-expandableFields": ["ach", "us_domestic_wire"]
      },
      "treasury_outbound_transfers_resource_returned_details": {
        "description": "",
        "properties": {
          "code": {
            "description": "Reason for the return.",
            "enum": [
              "account_closed",
              "account_frozen",
              "bank_account_restricted",
              "bank_ownership_changed",
              "declined",
              "incorrect_account_holder_name",
              "invalid_account_number",
              "invalid_currency",
              "no_account",
              "other"
            ],
            "type": "string"
          },
          "transaction": {
            "anyOf": [
              {
                "maxLength": 5000,
                "type": "string"
              },
              {
                "$ref": "#/components/schemas/treasury.transaction"
              }
            ],
            "description": "The Transaction associated with this object.",
            "x-expansionResources": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              ]
            }
          }
        },
        "required": ["code", "transaction"],
        "title": "TreasuryOutboundTransfersResourceReturnedDetails",
        "type": "object",
        "x-expandableFields": ["transaction"]
      },
      "treasury_outbound_transfers_resource_status_transitions": {
        "description": "",
        "properties": {
          "canceled_at": {
            "description": "Timestamp describing when an OutboundTransfer changed status to `canceled`",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "failed_at": {
            "description": "Timestamp describing when an OutboundTransfer changed status to `failed`",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "posted_at": {
            "description": "Timestamp describing when an OutboundTransfer changed status to `posted`",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "returned_at": {
            "description": "Timestamp describing when an OutboundTransfer changed status to `returned`",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryOutboundTransfersResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": {
        "description": "",
        "properties": {
          "chips": {
            "description": "CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "imad": {
            "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "omad": {
            "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_credits_resource_linked_flows": {
        "description": "",
        "properties": {
          "credit_reversal": {
            "description": "The CreditReversal created as a result of this ReceivedCredit being reversed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuing_authorization": {
            "description": "Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuing_transaction": {
            "description": "Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "source_flow": {
            "description": "ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "source_flow_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/treasury_received_credits_resource_source_flows_details"
              }
            ],
            "description": "The expandable object of the source flow.",
            "nullable": true
          },
          "source_flow_type": {
            "description": "The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryReceivedCreditsResourceLinkedFlows",
        "type": "object",
        "x-expandableFields": ["source_flow_details"]
      },
      "treasury_received_credits_resource_reversal_details": {
        "description": "",
        "properties": {
          "deadline": {
            "description": "Time before which a ReceivedCredit can be reversed.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "restricted_reason": {
            "description": "Set if a ReceivedCredit cannot be reversed.",
            "enum": [
              "already_reversed",
              "deadline_passed",
              "network_restricted",
              "other",
              "source_flow_restricted"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryReceivedCreditsResourceReversalDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_credits_resource_source_flows_details": {
        "description": "",
        "properties": {
          "credit_reversal": {
            "$ref": "#/components/schemas/treasury.credit_reversal"
          },
          "outbound_payment": {
            "$ref": "#/components/schemas/treasury.outbound_payment"
          },
          "outbound_transfer": {
            "$ref": "#/components/schemas/treasury.outbound_transfer"
          },
          "payout": {
            "$ref": "#/components/schemas/payout"
          },
          "type": {
            "description": "The type of the source flow that originated the ReceivedCredit.",
            "enum": [
              "credit_reversal",
              "other",
              "outbound_payment",
              "outbound_transfer",
              "payout"
            ],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TreasuryReceivedCreditsResourceSourceFlowsDetails",
        "type": "object",
        "x-expandableFields": [
          "credit_reversal",
          "outbound_payment",
          "outbound_transfer",
          "payout"
        ]
      },
      "treasury_received_credits_resource_status_transitions": {
        "description": "",
        "properties": {
          "posted_at": {
            "description": "Timestamp describing when the CreditReversal changed status to `posted`",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryReceivedCreditsResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_debits_resource_debit_reversal_linked_flows": {
        "description": "",
        "properties": {
          "issuing_dispute": {
            "description": "Set if there is an Issuing dispute associated with the DebitReversal.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_debits_resource_linked_flows": {
        "description": "",
        "properties": {
          "debit_reversal": {
            "description": "The DebitReversal created as a result of this ReceivedDebit being reversed.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "inbound_transfer": {
            "description": "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuing_authorization": {
            "description": "Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "issuing_transaction": {
            "description": "Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "payout": {
            "description": "Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryReceivedDebitsResourceLinkedFlows",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_debits_resource_reversal_details": {
        "description": "",
        "properties": {
          "deadline": {
            "description": "Time before which a ReceivedDebit can be reversed.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "restricted_reason": {
            "description": "Set if a ReceivedDebit can't be reversed.",
            "enum": [
              "already_reversed",
              "deadline_passed",
              "network_restricted",
              "other",
              "source_flow_restricted"
            ],
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasuryReceivedDebitsResourceReversalDetails",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_received_debits_resource_status_transitions": {
        "description": "",
        "properties": {
          "completed_at": {
            "description": "Timestamp describing when the DebitReversal changed status to `completed`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryReceivedDebitsResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_shared_resource_billing_details": {
        "description": "",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/address"
          },
          "email": {
            "description": "Email address.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "name": {
            "description": "Full name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "required": ["address"],
        "title": "TreasurySharedResourceBillingDetails",
        "type": "object",
        "x-expandableFields": ["address"]
      },
      "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details": {
        "description": "",
        "properties": {
          "balance": {
            "description": "Set when `type` is `balance`.",
            "enum": ["payments"],
            "type": "string"
          },
          "billing_details": {
            "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
          },
          "financial_account": {
            "$ref": "#/components/schemas/received_payment_method_details_financial_account"
          },
          "issuing_card": {
            "description": "Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.",
            "maxLength": 5000,
            "type": "string"
          },
          "type": {
            "description": "Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.",
            "enum": [
              "balance",
              "financial_account",
              "issuing_card",
              "stripe",
              "us_bank_account"
            ],
            "type": "string",
            "x-stripeBypassValidation": true
          },
          "us_bank_account": {
            "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account"
          }
        },
        "required": ["billing_details", "type"],
        "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails",
        "type": "object",
        "x-expandableFields": [
          "billing_details",
          "financial_account",
          "us_bank_account"
        ]
      },
      "treasury_shared_resource_initiating_payment_method_details_us_bank_account": {
        "description": "",
        "properties": {
          "bank_name": {
            "description": "Bank name.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "last4": {
            "description": "The last four digits of the bank account number.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "routing_number": {
            "description": "The routing number for the bank account.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          }
        },
        "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_transactions_resource_abstract_transaction_resource_status_transitions": {
        "description": "",
        "properties": {
          "posted_at": {
            "description": "Timestamp describing when the Transaction changed status to `posted`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          },
          "void_at": {
            "description": "Timestamp describing when the Transaction changed status to `void`.",
            "format": "unix-time",
            "nullable": true,
            "type": "integer"
          }
        },
        "title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_transactions_resource_balance_impact": {
        "description": "Change to a FinancialAccount's balance",
        "properties": {
          "cash": {
            "description": "The change made to funds the user can spend right now.",
            "type": "integer"
          },
          "inbound_pending": {
            "description": "The change made to funds that are not spendable yet, but will become available at a later time.",
            "type": "integer"
          },
          "outbound_pending": {
            "description": "The change made to funds in the account, but not spendable because they are being held for pending outbound flows.",
            "type": "integer"
          }
        },
        "required": ["cash", "inbound_pending", "outbound_pending"],
        "title": "TreasuryTransactionsResourceBalanceImpact",
        "type": "object",
        "x-expandableFields": []
      },
      "treasury_transactions_resource_flow_details": {
        "description": "",
        "properties": {
          "credit_reversal": {
            "$ref": "#/components/schemas/treasury.credit_reversal"
          },
          "debit_reversal": {
            "$ref": "#/components/schemas/treasury.debit_reversal"
          },
          "inbound_transfer": {
            "$ref": "#/components/schemas/treasury.inbound_transfer"
          },
          "issuing_authorization": {
            "$ref": "#/components/schemas/issuing.authorization"
          },
          "outbound_payment": {
            "$ref": "#/components/schemas/treasury.outbound_payment"
          },
          "outbound_transfer": {
            "$ref": "#/components/schemas/treasury.outbound_transfer"
          },
          "received_credit": {
            "$ref": "#/components/schemas/treasury.received_credit"
          },
          "received_debit": {
            "$ref": "#/components/schemas/treasury.received_debit"
          },
          "type": {
            "description": "Type of the flow that created the Transaction. Set to the same value as `flow_type`.",
            "enum": [
              "credit_reversal",
              "debit_reversal",
              "inbound_transfer",
              "issuing_authorization",
              "other",
              "outbound_payment",
              "outbound_transfer",
              "received_credit",
              "received_debit"
            ],
            "type": "string"
          }
        },
        "required": ["type"],
        "title": "TreasuryTransactionsResourceFlowDetails",
        "type": "object",
        "x-expandableFields": [
          "credit_reversal",
          "debit_reversal",
          "inbound_transfer",
          "issuing_authorization",
          "outbound_payment",
          "outbound_transfer",
          "received_credit",
          "received_debit"
        ]
      },
      "us_bank_account_networks": {
        "description": "",
        "properties": {
          "preferred": {
            "description": "The preferred network.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "supported": {
            "description": "All supported networks.",
            "items": {
              "enum": ["ach", "us_domestic_wire"],
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": ["supported"],
        "title": "us_bank_account_networks",
        "type": "object",
        "x-expandableFields": []
      },
      "usage_record": {
        "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["usage_record"],
            "type": "string"
          },
          "quantity": {
            "description": "The usage quantity for the specified date.",
            "type": "integer"
          },
          "subscription_item": {
            "description": "The ID of the subscription item this usage record contains data for.",
            "maxLength": 5000,
            "type": "string"
          },
          "timestamp": {
            "description": "The timestamp when this usage occurred.",
            "format": "unix-time",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "livemode",
          "object",
          "quantity",
          "subscription_item",
          "timestamp"
        ],
        "title": "UsageRecord",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "usage_record"
      },
      "usage_record_summary": {
        "description": "A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.",
        "properties": {
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "invoice": {
            "description": "The invoice in which this usage period has been billed for.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["usage_record_summary"],
            "type": "string"
          },
          "period": {
            "$ref": "#/components/schemas/period"
          },
          "subscription_item": {
            "description": "The ID of the subscription item this summary is describing.",
            "maxLength": 5000,
            "type": "string"
          },
          "total_usage": {
            "description": "The total usage within this usage period.",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "livemode",
          "object",
          "period",
          "subscription_item",
          "total_usage"
        ],
        "title": "UsageRecordSummary",
        "type": "object",
        "x-expandableFields": ["period"],
        "x-resourceId": "usage_record_summary"
      },
      "verification_session_redaction": {
        "description": "",
        "properties": {
          "status": {
            "description": "Indicates whether this object and its related objects have been redacted or not.",
            "enum": ["processing", "redacted"],
            "type": "string"
          }
        },
        "required": ["status"],
        "title": "verification_session_redaction",
        "type": "object",
        "x-expandableFields": []
      },
      "webhook_endpoint": {
        "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)",
        "properties": {
          "api_version": {
            "description": "The API version events are rendered as for this webhook endpoint.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "application": {
            "description": "The ID of the associated Connect application.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
            "format": "unix-time",
            "type": "integer"
          },
          "description": {
            "description": "An optional description of what the webhook is used for.",
            "maxLength": 5000,
            "nullable": true,
            "type": "string"
          },
          "enabled_events": {
            "description": "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.",
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "description": "Unique identifier for the object.",
            "maxLength": 5000,
            "type": "string"
          },
          "livemode": {
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
            "type": "boolean"
          },
          "metadata": {
            "additionalProperties": {
              "maxLength": 500,
              "type": "string"
            },
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
            "type": "object"
          },
          "object": {
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": ["webhook_endpoint"],
            "type": "string"
          },
          "secret": {
            "description": "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.",
            "maxLength": 5000,
            "type": "string"
          },
          "status": {
            "description": "The status of the webhook. It can be `enabled` or `disabled`.",
            "maxLength": 5000,
            "type": "string"
          },
          "url": {
            "description": "The URL of the webhook endpoint.",
            "maxLength": 5000,
            "type": "string"
          }
        },
        "required": [
          "created",
          "enabled_events",
          "id",
          "livemode",
          "metadata",
          "object",
          "status",
          "url"
        ],
        "title": "NotificationWebhookEndpoint",
        "type": "object",
        "x-expandableFields": [],
        "x-resourceId": "webhook_endpoint"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "description": "Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>",
        "scheme": "basic",
        "type": "http"
      },
      "bearerAuth": {
        "bearerFormat": "auth-scheme",
        "description": "Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "contact": {
      "email": "dev-platform@stripe.com",
      "name": "Stripe Dev Platform Team",
      "url": "https://stripe.com"
    },
    "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
    "termsOfService": "https://stripe.com/us/terms/",
    "title": "Stripe API",
    "version": "2025-02-24.acacia",
    "x-stripeSpecFilename": "spec3"
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/account": {
      "get": {
        "description": "<p>Retrieves the details of an account.</p>",
        "operationId": "GetAccount",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve account"
      }
    },
    "/v1/account_links": {
      "post": {
        "description": "<p>Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.</p>",
        "operationId": "PostAccountLinks",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "collection_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account": {
                    "description": "The identifier of the account to create an account link for.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "collect": {
                    "description": "The collect parameter is deprecated. Use `collection_options` instead.",
                    "enum": ["currently_due", "eventually_due"],
                    "type": "string"
                  },
                  "collection_options": {
                    "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.",
                    "properties": {
                      "fields": {
                        "enum": ["currently_due", "eventually_due"],
                        "type": "string"
                      },
                      "future_requirements": {
                        "enum": ["include", "omit"],
                        "type": "string"
                      }
                    },
                    "title": "collection_options_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "refresh_url": {
                    "description": "The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.",
                    "type": "string"
                  },
                  "return_url": {
                    "description": "The URL that the user will be redirected to upon leaving or completing the linked flow.",
                    "type": "string"
                  },
                  "type": {
                    "description": "The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.",
                    "enum": ["account_onboarding", "account_update"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "required": ["account", "type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an account link"
      }
    },
    "/v1/account_sessions": {
      "post": {
        "description": "<p>Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.</p>",
        "operationId": "PostAccountSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "components": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account": {
                    "description": "The identifier of the account to create an Account Session for.",
                    "type": "string"
                  },
                  "components": {
                    "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).",
                    "properties": {
                      "account_management": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              }
                            },
                            "title": "account_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "account_config_param",
                        "type": "object"
                      },
                      "account_onboarding": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              }
                            },
                            "title": "account_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "account_config_param",
                        "type": "object"
                      },
                      "balances": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "edit_payout_schedule": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              },
                              "instant_payouts": {
                                "type": "boolean"
                              },
                              "standard_payouts": {
                                "type": "boolean"
                              }
                            },
                            "title": "payouts_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payouts_config_param",
                        "type": "object"
                      },
                      "documents": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {},
                            "title": "base_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "base_config_param",
                        "type": "object"
                      },
                      "financial_account": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              },
                              "send_money": {
                                "type": "boolean"
                              },
                              "transfer_balance": {
                                "type": "boolean"
                              }
                            },
                            "title": "financial_account_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "financial_account_config_param",
                        "type": "object"
                      },
                      "financial_account_transactions": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "card_spend_dispute_management": {
                                "type": "boolean"
                              }
                            },
                            "title": "financial_account_transactions_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "financial_account_transactions_config_param",
                        "type": "object"
                      },
                      "issuing_card": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "card_management": {
                                "type": "boolean"
                              },
                              "card_spend_dispute_management": {
                                "type": "boolean"
                              },
                              "cardholder_management": {
                                "type": "boolean"
                              },
                              "spend_control_management": {
                                "type": "boolean"
                              }
                            },
                            "title": "issuing_card_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "issuing_card_config_param",
                        "type": "object"
                      },
                      "issuing_cards_list": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "card_management": {
                                "type": "boolean"
                              },
                              "card_spend_dispute_management": {
                                "type": "boolean"
                              },
                              "cardholder_management": {
                                "type": "boolean"
                              },
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "spend_control_management": {
                                "type": "boolean"
                              }
                            },
                            "title": "issuing_cards_list_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "issuing_cards_list_config_param",
                        "type": "object"
                      },
                      "notification_banner": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              }
                            },
                            "title": "account_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "account_config_param",
                        "type": "object"
                      },
                      "payment_details": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "capture_payments": {
                                "type": "boolean"
                              },
                              "destination_on_behalf_of_charge_management": {
                                "type": "boolean"
                              },
                              "dispute_management": {
                                "type": "boolean"
                              },
                              "refund_management": {
                                "type": "boolean"
                              }
                            },
                            "title": "payments_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payments_config_param",
                        "type": "object"
                      },
                      "payments": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "capture_payments": {
                                "type": "boolean"
                              },
                              "destination_on_behalf_of_charge_management": {
                                "type": "boolean"
                              },
                              "dispute_management": {
                                "type": "boolean"
                              },
                              "refund_management": {
                                "type": "boolean"
                              }
                            },
                            "title": "payments_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payments_config_param",
                        "type": "object"
                      },
                      "payouts": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "disable_stripe_user_authentication": {
                                "type": "boolean"
                              },
                              "edit_payout_schedule": {
                                "type": "boolean"
                              },
                              "external_account_collection": {
                                "type": "boolean"
                              },
                              "instant_payouts": {
                                "type": "boolean"
                              },
                              "standard_payouts": {
                                "type": "boolean"
                              }
                            },
                            "title": "payouts_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payouts_config_param",
                        "type": "object"
                      },
                      "payouts_list": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {},
                            "title": "base_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "base_config_param",
                        "type": "object"
                      },
                      "tax_registrations": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {},
                            "title": "base_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "base_config_param",
                        "type": "object"
                      },
                      "tax_settings": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {},
                            "title": "base_features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "base_config_param",
                        "type": "object"
                      }
                    },
                    "title": "account_session_create_components_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["account", "components"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an Account Session"
      }
    },
    "/v1/accounts": {
      "get": {
        "description": "<p>Returns a list of accounts connected to your platform via <a href=\"/docs/connect\">Connect</a>. If you’re not a platform, the list is empty.</p>",
        "operationId": "GetAccounts",
        "parameters": [
          {
            "description": "Only return connected accounts that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/account"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/accounts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "AccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all connected accounts"
      },
      "post": {
        "description": "<p>With <a href=\"/docs/connect\">Connect</a>, you can create Stripe accounts for your users.\nTo do this, you’ll first need to <a href=\"https://dashboard.stripe.com/account/applications/settings\">register your platform</a>.</p>\n\n<p>If you’ve already collected information for your connected accounts, you <a href=\"/docs/connect/best-practices#onboarding\">can prefill that information</a> when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.</p>",
        "operationId": "PostAccounts",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "business_profile": {
                  "explode": true,
                  "style": "deepObject"
                },
                "capabilities": {
                  "explode": true,
                  "style": "deepObject"
                },
                "company": {
                  "explode": true,
                  "style": "deepObject"
                },
                "controller": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "groups": {
                  "explode": true,
                  "style": "deepObject"
                },
                "individual": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tos_acceptance": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_token": {
                    "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "futsu", "savings", "toza"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "documents": {
                            "properties": {
                              "bank_account_ownership_verification": {
                                "properties": {
                                  "files": {
                                    "items": {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "documents_param",
                                "type": "object"
                              }
                            },
                            "title": "external_account_documents_param",
                            "type": "object"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "external_account_payout_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "business_profile": {
                    "description": "Business information about the account.",
                    "properties": {
                      "annual_revenue": {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "fiscal_year_end": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["amount", "currency", "fiscal_year_end"],
                        "title": "annual_revenue_specs",
                        "type": "object"
                      },
                      "estimated_worker_count": {
                        "type": "integer"
                      },
                      "mcc": {
                        "maxLength": 4,
                        "type": "string"
                      },
                      "monthly_estimated_revenue": {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          }
                        },
                        "required": ["amount", "currency"],
                        "title": "monthly_estimated_revenue_specs",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "product_description": {
                        "maxLength": 40000,
                        "type": "string"
                      },
                      "support_address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "support_email": {
                        "type": "string"
                      },
                      "support_phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "support_url": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "title": "business_profile_specs",
                    "type": "object"
                  },
                  "business_type": {
                    "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "enum": [
                      "company",
                      "government_entity",
                      "individual",
                      "non_profit"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "capabilities": {
                    "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.",
                    "properties": {
                      "acss_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "affirm_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "afterpay_clearpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "alma_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "amazon_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "au_becs_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bacs_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bancontact_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "blik_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "boleto_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "card_issuing": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "card_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "cartes_bancaires_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "cashapp_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "eps_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "fpx_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "gb_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "giropay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "grabpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "ideal_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "india_international_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "jcb_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "jp_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "kakao_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "klarna_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "konbini_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "kr_card_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "legacy_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "link_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "mobilepay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "multibanco_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "mx_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "naver_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "oxxo_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "p24_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "pay_by_bank_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "payco_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "paynow_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "promptpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "revolut_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "samsung_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sepa_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sepa_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sofort_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "swish_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "tax_reporting_us_1099_k": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "tax_reporting_us_1099_misc": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "transfers": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "treasury": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "twint_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "us_bank_account_ach_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "us_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "zip_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      }
                    },
                    "title": "capabilities_param",
                    "type": "object"
                  },
                  "company": {
                    "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "legal_entity_and_kyc_address_specs",
                        "type": "object"
                      },
                      "address_kana": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kana_specs",
                        "type": "object"
                      },
                      "address_kanji": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kanji_specs",
                        "type": "object"
                      },
                      "directors_provided": {
                        "type": "boolean"
                      },
                      "directorship_declaration": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "company_directorship_declaration",
                        "type": "object"
                      },
                      "executives_provided": {
                        "type": "boolean"
                      },
                      "export_license_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "export_purpose_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "name_kana": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "name_kanji": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "owners_provided": {
                        "type": "boolean"
                      },
                      "ownership_declaration": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "company_ownership_declaration",
                        "type": "object"
                      },
                      "ownership_exemption_reason": {
                        "enum": [
                          "",
                          "qualified_entity_exceeds_ownership_threshold",
                          "qualifies_as_financial_institution"
                        ],
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "registration_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "structure": {
                        "enum": [
                          "",
                          "free_zone_establishment",
                          "free_zone_llc",
                          "government_instrumentality",
                          "governmental_unit",
                          "incorporated_non_profit",
                          "incorporated_partnership",
                          "limited_liability_partnership",
                          "llc",
                          "multi_member_llc",
                          "private_company",
                          "private_corporation",
                          "private_partnership",
                          "public_company",
                          "public_corporation",
                          "public_partnership",
                          "registered_charity",
                          "single_member_llc",
                          "sole_establishment",
                          "sole_proprietorship",
                          "tax_exempt_government_instrumentality",
                          "unincorporated_association",
                          "unincorporated_non_profit",
                          "unincorporated_partnership"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "tax_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_id_registrar": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "vat_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "verification_document_specs",
                            "type": "object"
                          }
                        },
                        "title": "verification_specs",
                        "type": "object"
                      }
                    },
                    "title": "company_specs",
                    "type": "object"
                  },
                  "controller": {
                    "description": "A hash of configuration describing the account controller's attributes.",
                    "properties": {
                      "fees": {
                        "properties": {
                          "payer": {
                            "enum": ["account", "application"],
                            "type": "string"
                          }
                        },
                        "title": "controller_fees_specs",
                        "type": "object"
                      },
                      "losses": {
                        "properties": {
                          "payments": {
                            "enum": ["application", "stripe"],
                            "type": "string"
                          }
                        },
                        "title": "controller_losses_specs",
                        "type": "object"
                      },
                      "requirement_collection": {
                        "enum": ["application", "stripe"],
                        "type": "string"
                      },
                      "stripe_dashboard": {
                        "properties": {
                          "type": {
                            "enum": ["express", "full", "none"],
                            "type": "string"
                          }
                        },
                        "title": "controller_dashboard_specs",
                        "type": "object"
                      }
                    },
                    "title": "controller_specs",
                    "type": "object"
                  },
                  "country": {
                    "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_currency": {
                    "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).",
                    "format": "currency",
                    "type": "string"
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "bank_account_ownership_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_license": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_memorandum_of_association": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_ministerial_decree": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_registration_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_tax_id_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "proof_of_registration": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "proof_of_ultimate_beneficial_ownership": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "external_account": {
                    "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "groups": {
                    "description": "A hash of account group type to tokens. These are account groups this account should be added to.",
                    "properties": {
                      "payments_pricing": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "account_groups_specs",
                    "type": "object"
                  },
                  "individual": {
                    "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "address_kana": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kana_specs",
                        "type": "object"
                      },
                      "address_kanji": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kanji_specs",
                        "type": "object"
                      },
                      "dob": {
                        "anyOf": [
                          {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth_specs",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "email": {
                        "type": "string"
                      },
                      "first_name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "first_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "first_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "full_name_aliases": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 300,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "gender": {
                        "type": "string"
                      },
                      "id_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "id_number_secondary": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "last_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "maiden_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "phone": {
                        "type": "string"
                      },
                      "political_exposure": {
                        "enum": ["existing", "none"],
                        "type": "string"
                      },
                      "registered_address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "relationship": {
                        "properties": {
                          "director": {
                            "type": "boolean"
                          },
                          "executive": {
                            "type": "boolean"
                          },
                          "owner": {
                            "type": "boolean"
                          },
                          "percent_ownership": {
                            "anyOf": [
                              {
                                "type": "number"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "title": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "individual_relationship_specs",
                        "type": "object"
                      },
                      "ssn_last_4": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "additional_document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          },
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          }
                        },
                        "title": "person_verification_specs",
                        "type": "object"
                      }
                    },
                    "title": "individual_specs",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "settings": {
                    "description": "Options for customizing how the account functions within Stripe.",
                    "properties": {
                      "bacs_debit_payments": {
                        "properties": {
                          "display_name": {
                            "type": "string"
                          }
                        },
                        "title": "bacs_debit_payments_specs",
                        "type": "object"
                      },
                      "branding": {
                        "properties": {
                          "icon": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "logo": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "primary_color": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "secondary_color": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "branding_settings_specs",
                        "type": "object"
                      },
                      "card_issuing": {
                        "properties": {
                          "tos_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "settings_terms_of_service_specs",
                            "type": "object"
                          }
                        },
                        "title": "card_issuing_settings_specs",
                        "type": "object"
                      },
                      "card_payments": {
                        "properties": {
                          "decline_on": {
                            "properties": {
                              "avs_failure": {
                                "type": "boolean"
                              },
                              "cvc_failure": {
                                "type": "boolean"
                              }
                            },
                            "title": "decline_charge_on_specs",
                            "type": "object"
                          },
                          "statement_descriptor_prefix": {
                            "maxLength": 10,
                            "type": "string"
                          },
                          "statement_descriptor_prefix_kana": {
                            "anyOf": [
                              {
                                "maxLength": 10,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "statement_descriptor_prefix_kanji": {
                            "anyOf": [
                              {
                                "maxLength": 10,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "card_payments_settings_specs",
                        "type": "object"
                      },
                      "payments": {
                        "properties": {
                          "statement_descriptor": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "statement_descriptor_kana": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "statement_descriptor_kanji": {
                            "maxLength": 22,
                            "type": "string"
                          }
                        },
                        "title": "payments_settings_specs",
                        "type": "object"
                      },
                      "payouts": {
                        "properties": {
                          "debit_negative_balances": {
                            "type": "boolean"
                          },
                          "schedule": {
                            "properties": {
                              "delay_days": {
                                "anyOf": [
                                  {
                                    "enum": ["minimum"],
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "type": "integer"
                                  }
                                ]
                              },
                              "interval": {
                                "enum": [
                                  "daily",
                                  "manual",
                                  "monthly",
                                  "weekly"
                                ],
                                "maxLength": 5000,
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "monthly_anchor": {
                                "type": "integer"
                              },
                              "weekly_anchor": {
                                "enum": [
                                  "friday",
                                  "monday",
                                  "saturday",
                                  "sunday",
                                  "thursday",
                                  "tuesday",
                                  "wednesday"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "transfer_schedule_specs",
                            "type": "object"
                          },
                          "statement_descriptor": {
                            "maxLength": 22,
                            "type": "string"
                          }
                        },
                        "title": "payout_settings_specs",
                        "type": "object"
                      },
                      "treasury": {
                        "properties": {
                          "tos_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "settings_terms_of_service_specs",
                            "type": "object"
                          }
                        },
                        "title": "treasury_settings_specs",
                        "type": "object"
                      }
                    },
                    "title": "settings_specs",
                    "type": "object"
                  },
                  "tos_acceptance": {
                    "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.",
                    "properties": {
                      "date": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "ip": {
                        "type": "string"
                      },
                      "service_agreement": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "user_agent": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "tos_acceptance_specs",
                    "type": "object"
                  },
                  "type": {
                    "description": "The type of Stripe account to create. May be one of `custom`, `express` or `standard`.",
                    "enum": ["custom", "express", "standard"],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/accounts/{account}": {
      "delete": {
        "description": "<p>With <a href=\"/connect\">Connect</a>, you can delete accounts you manage.</p>\n\n<p>Test-mode accounts can be deleted at any time.</p>\n\n<p>Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all <a href=\"/api/balance/balance_object\">balances</a> are zero.</p>\n\n<p>If you want to delete your own account, use the <a href=\"https://dashboard.stripe.com/settings/account\">account information tab in your account settings</a> instead.</p>",
        "operationId": "DeleteAccountsAccount",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete an account"
      },
      "get": {
        "description": "<p>Retrieves the details of an account.</p>",
        "operationId": "GetAccountsAccount",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve account"
      },
      "post": {
        "description": "<p>Updates a <a href=\"/connect/accounts\">connected account</a> by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.</p>\n\n<p>For accounts where <a href=\"/api/accounts/object#account_object-controller-requirement_collection\">controller.requirement_collection</a>\nis <code>application</code>, which includes Custom accounts, you can update any information on the account.</p>\n\n<p>For accounts where <a href=\"/api/accounts/object#account_object-controller-requirement_collection\">controller.requirement_collection</a>\nis <code>stripe</code>, which includes Standard and Express accounts, you can update all information until you create\nan <a href=\"/api/account_links\">Account Link</a> or <a href=\"/api/account_sessions\">Account Session</a> to start Connect onboarding,\nafter which some properties can no longer be updated.</p>\n\n<p>To update your own account, use the <a href=\"https://dashboard.stripe.com/settings/account\">Dashboard</a>. Refer to our\n<a href=\"/docs/connect/updating-accounts\">Connect</a> documentation to learn more about updating accounts.</p>",
        "operationId": "PostAccountsAccount",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "business_profile": {
                  "explode": true,
                  "style": "deepObject"
                },
                "capabilities": {
                  "explode": true,
                  "style": "deepObject"
                },
                "company": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "groups": {
                  "explode": true,
                  "style": "deepObject"
                },
                "individual": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tos_acceptance": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_token": {
                    "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "business_profile": {
                    "description": "Business information about the account.",
                    "properties": {
                      "annual_revenue": {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "fiscal_year_end": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["amount", "currency", "fiscal_year_end"],
                        "title": "annual_revenue_specs",
                        "type": "object"
                      },
                      "estimated_worker_count": {
                        "type": "integer"
                      },
                      "mcc": {
                        "maxLength": 4,
                        "type": "string"
                      },
                      "monthly_estimated_revenue": {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          }
                        },
                        "required": ["amount", "currency"],
                        "title": "monthly_estimated_revenue_specs",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "product_description": {
                        "maxLength": 40000,
                        "type": "string"
                      },
                      "support_address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "support_email": {
                        "type": "string"
                      },
                      "support_phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "support_url": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "title": "business_profile_update_specs",
                    "type": "object"
                  },
                  "business_type": {
                    "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "enum": [
                      "company",
                      "government_entity",
                      "individual",
                      "non_profit"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "capabilities": {
                    "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.",
                    "properties": {
                      "acss_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "affirm_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "afterpay_clearpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "alma_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "amazon_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "au_becs_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bacs_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bancontact_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "blik_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "boleto_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "card_issuing": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "card_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "cartes_bancaires_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "cashapp_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "eps_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "fpx_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "gb_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "giropay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "grabpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "ideal_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "india_international_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "jcb_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "jp_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "kakao_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "klarna_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "konbini_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "kr_card_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "legacy_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "link_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "mobilepay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "multibanco_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "mx_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "naver_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "oxxo_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "p24_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "pay_by_bank_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "payco_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "paynow_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "promptpay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "revolut_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "samsung_pay_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sepa_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sepa_debit_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "sofort_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "swish_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "tax_reporting_us_1099_k": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "tax_reporting_us_1099_misc": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "transfers": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "treasury": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "twint_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "us_bank_account_ach_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "us_bank_transfer_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      },
                      "zip_payments": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "title": "capability_param",
                        "type": "object"
                      }
                    },
                    "title": "capabilities_param",
                    "type": "object"
                  },
                  "company": {
                    "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "legal_entity_and_kyc_address_specs",
                        "type": "object"
                      },
                      "address_kana": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kana_specs",
                        "type": "object"
                      },
                      "address_kanji": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kanji_specs",
                        "type": "object"
                      },
                      "directors_provided": {
                        "type": "boolean"
                      },
                      "directorship_declaration": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "company_directorship_declaration",
                        "type": "object"
                      },
                      "executives_provided": {
                        "type": "boolean"
                      },
                      "export_license_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "export_purpose_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "name_kana": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "name_kanji": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "owners_provided": {
                        "type": "boolean"
                      },
                      "ownership_declaration": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "company_ownership_declaration",
                        "type": "object"
                      },
                      "ownership_exemption_reason": {
                        "enum": [
                          "",
                          "qualified_entity_exceeds_ownership_threshold",
                          "qualifies_as_financial_institution"
                        ],
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "registration_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "structure": {
                        "enum": [
                          "",
                          "free_zone_establishment",
                          "free_zone_llc",
                          "government_instrumentality",
                          "governmental_unit",
                          "incorporated_non_profit",
                          "incorporated_partnership",
                          "limited_liability_partnership",
                          "llc",
                          "multi_member_llc",
                          "private_company",
                          "private_corporation",
                          "private_partnership",
                          "public_company",
                          "public_corporation",
                          "public_partnership",
                          "registered_charity",
                          "single_member_llc",
                          "sole_establishment",
                          "sole_proprietorship",
                          "tax_exempt_government_instrumentality",
                          "unincorporated_association",
                          "unincorporated_non_profit",
                          "unincorporated_partnership"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "tax_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_id_registrar": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "vat_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "verification_document_specs",
                            "type": "object"
                          }
                        },
                        "title": "verification_specs",
                        "type": "object"
                      }
                    },
                    "title": "company_update_specs",
                    "type": "object"
                  },
                  "default_currency": {
                    "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).",
                    "format": "currency",
                    "type": "string"
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "bank_account_ownership_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_license": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_memorandum_of_association": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_ministerial_decree": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_registration_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "company_tax_id_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "proof_of_registration": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "proof_of_ultimate_beneficial_ownership": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "external_account": {
                    "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "groups": {
                    "description": "A hash of account group type to tokens. These are account groups this account should be added to.",
                    "properties": {
                      "payments_pricing": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "account_groups_specs",
                    "type": "object"
                  },
                  "individual": {
                    "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "address_kana": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kana_specs",
                        "type": "object"
                      },
                      "address_kanji": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kanji_specs",
                        "type": "object"
                      },
                      "dob": {
                        "anyOf": [
                          {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth_specs",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "email": {
                        "type": "string"
                      },
                      "first_name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "first_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "first_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "full_name_aliases": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 300,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "gender": {
                        "type": "string"
                      },
                      "id_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "id_number_secondary": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "last_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "maiden_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "phone": {
                        "type": "string"
                      },
                      "political_exposure": {
                        "enum": ["existing", "none"],
                        "type": "string"
                      },
                      "registered_address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "relationship": {
                        "properties": {
                          "director": {
                            "type": "boolean"
                          },
                          "executive": {
                            "type": "boolean"
                          },
                          "owner": {
                            "type": "boolean"
                          },
                          "percent_ownership": {
                            "anyOf": [
                              {
                                "type": "number"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "title": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "individual_relationship_specs",
                        "type": "object"
                      },
                      "ssn_last_4": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "additional_document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          },
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          }
                        },
                        "title": "person_verification_specs",
                        "type": "object"
                      }
                    },
                    "title": "individual_update_specs",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "settings": {
                    "description": "Options for customizing how the account functions within Stripe.",
                    "properties": {
                      "bacs_debit_payments": {
                        "properties": {
                          "display_name": {
                            "type": "string"
                          }
                        },
                        "title": "bacs_debit_payments_specs",
                        "type": "object"
                      },
                      "branding": {
                        "properties": {
                          "icon": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "logo": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "primary_color": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "secondary_color": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "branding_settings_specs",
                        "type": "object"
                      },
                      "card_issuing": {
                        "properties": {
                          "tos_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "settings_terms_of_service_specs",
                            "type": "object"
                          }
                        },
                        "title": "card_issuing_settings_specs",
                        "type": "object"
                      },
                      "card_payments": {
                        "properties": {
                          "decline_on": {
                            "properties": {
                              "avs_failure": {
                                "type": "boolean"
                              },
                              "cvc_failure": {
                                "type": "boolean"
                              }
                            },
                            "title": "decline_charge_on_specs",
                            "type": "object"
                          },
                          "statement_descriptor_prefix": {
                            "maxLength": 10,
                            "type": "string"
                          },
                          "statement_descriptor_prefix_kana": {
                            "anyOf": [
                              {
                                "maxLength": 10,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "statement_descriptor_prefix_kanji": {
                            "anyOf": [
                              {
                                "maxLength": 10,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "card_payments_settings_specs",
                        "type": "object"
                      },
                      "invoices": {
                        "properties": {
                          "default_account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "invoices_settings_specs",
                        "type": "object"
                      },
                      "payments": {
                        "properties": {
                          "statement_descriptor": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "statement_descriptor_kana": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "statement_descriptor_kanji": {
                            "maxLength": 22,
                            "type": "string"
                          }
                        },
                        "title": "payments_settings_specs",
                        "type": "object"
                      },
                      "payouts": {
                        "properties": {
                          "debit_negative_balances": {
                            "type": "boolean"
                          },
                          "schedule": {
                            "properties": {
                              "delay_days": {
                                "anyOf": [
                                  {
                                    "enum": ["minimum"],
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "type": "integer"
                                  }
                                ]
                              },
                              "interval": {
                                "enum": [
                                  "daily",
                                  "manual",
                                  "monthly",
                                  "weekly"
                                ],
                                "maxLength": 5000,
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "monthly_anchor": {
                                "type": "integer"
                              },
                              "weekly_anchor": {
                                "enum": [
                                  "friday",
                                  "monday",
                                  "saturday",
                                  "sunday",
                                  "thursday",
                                  "tuesday",
                                  "wednesday"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "transfer_schedule_specs",
                            "type": "object"
                          },
                          "statement_descriptor": {
                            "maxLength": 22,
                            "type": "string"
                          }
                        },
                        "title": "payout_settings_specs",
                        "type": "object"
                      },
                      "treasury": {
                        "properties": {
                          "tos_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "settings_terms_of_service_specs",
                            "type": "object"
                          }
                        },
                        "title": "treasury_settings_specs",
                        "type": "object"
                      }
                    },
                    "title": "settings_specs_update",
                    "type": "object"
                  },
                  "tos_acceptance": {
                    "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.",
                    "properties": {
                      "date": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "ip": {
                        "type": "string"
                      },
                      "service_agreement": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "user_agent": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "tos_acceptance_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an account"
      }
    },
    "/v1/accounts/{account}/bank_accounts": {
      "post": {
        "description": "<p>Create an external account for a given account.</p>",
        "operationId": "PostAccountsAccountBankAccounts",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "futsu", "savings", "toza"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "documents": {
                            "properties": {
                              "bank_account_ownership_verification": {
                                "properties": {
                                  "files": {
                                    "items": {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "documents_param",
                                "type": "object"
                              }
                            },
                            "title": "external_account_documents_param",
                            "type": "object"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "external_account_payout_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "default_for_currency": {
                    "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "external_account": {
                    "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an external account"
      }
    },
    "/v1/accounts/{account}/bank_accounts/{id}": {
      "delete": {
        "description": "<p>Delete a specified external account for a given account.</p>",
        "operationId": "DeleteAccountsAccountBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete an external account"
      },
      "get": {
        "description": "<p>Retrieve a specified external account for a given account.</p>",
        "operationId": "GetAccountsAccountBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an external account"
      },
      "post": {
        "description": "<p>Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.</p>\n\n<p>You can only update bank accounts when <a href=\"/api/accounts/object#account_object-controller-requirement_collection\">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href=\"/connect/custom-accounts\">Custom accounts</a>.</p>\n\n<p>You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.</p>",
        "operationId": "PostAccountsAccountBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder_name": {
                    "description": "The name of the person or business that owns the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_holder_type": {
                    "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
                    "enum": ["", "company", "individual"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_type": {
                    "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.",
                    "enum": ["checking", "futsu", "savings", "toza"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_city": {
                    "description": "City/District/Suburb/Town/Village.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_country": {
                    "description": "Billing address country, if provided when creating card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line1": {
                    "description": "Address line 1 (Street address/PO Box/Company name).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line2": {
                    "description": "Address line 2 (Apartment/Suite/Unit/Building).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_state": {
                    "description": "State/County/Province/Region.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_zip": {
                    "description": "ZIP or postal code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_for_currency": {
                    "description": "When set to true, this becomes the default external account for its currency.",
                    "type": "boolean"
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "bank_account_ownership_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "external_account_documents_param",
                    "type": "object"
                  },
                  "exp_month": {
                    "description": "Two digit number representing the card’s expiration month.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_year": {
                    "description": "Four digit number representing the card’s expiration year.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Cardholder name.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/accounts/{account}/capabilities": {
      "get": {
        "description": "<p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p>",
        "operationId": "GetAccountsAccountCapabilities",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/capability"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ListAccountCapability",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all account capabilities"
      }
    },
    "/v1/accounts/{account}/capabilities/{capability}": {
      "get": {
        "description": "<p>Retrieves information about the specified Account Capability.</p>",
        "operationId": "GetAccountsAccountCapabilitiesCapability",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "capability",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/capability"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an Account Capability"
      },
      "post": {
        "description": "<p>Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.</p>",
        "operationId": "PostAccountsAccountCapabilitiesCapability",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "capability",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "requested": {
                    "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/capability"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an Account Capability"
      }
    },
    "/v1/accounts/{account}/external_accounts": {
      "get": {
        "description": "<p>List external accounts for an account.</p>",
        "operationId": "GetAccountsAccountExternalAccounts",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filter external accounts according to a particular object type.",
            "in": "query",
            "name": "object",
            "required": false,
            "schema": {
              "enum": ["bank_account", "card"],
              "maxLength": 5000,
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.",
                      "items": {
                        "anyOf": [
                          {
                            "$ref": "#/components/schemas/bank_account"
                          },
                          {
                            "$ref": "#/components/schemas/card"
                          }
                        ],
                        "title": "Polymorphic",
                        "x-stripeBypassValidation": true
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ExternalAccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all external accounts"
      },
      "post": {
        "description": "<p>Create an external account for a given account.</p>",
        "operationId": "PostAccountsAccountExternalAccounts",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "futsu", "savings", "toza"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "documents": {
                            "properties": {
                              "bank_account_ownership_verification": {
                                "properties": {
                                  "files": {
                                    "items": {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "documents_param",
                                "type": "object"
                              }
                            },
                            "title": "external_account_documents_param",
                            "type": "object"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "external_account_payout_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "default_for_currency": {
                    "description": "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "external_account": {
                    "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an external account"
      }
    },
    "/v1/accounts/{account}/external_accounts/{id}": {
      "delete": {
        "description": "<p>Delete a specified external account for a given account.</p>",
        "operationId": "DeleteAccountsAccountExternalAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete an external account"
      },
      "get": {
        "description": "<p>Retrieve a specified external account for a given account.</p>",
        "operationId": "GetAccountsAccountExternalAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an external account"
      },
      "post": {
        "description": "<p>Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.</p>\n\n<p>You can only update bank accounts when <a href=\"/api/accounts/object#account_object-controller-requirement_collection\">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href=\"/connect/custom-accounts\">Custom accounts</a>.</p>\n\n<p>You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.</p>",
        "operationId": "PostAccountsAccountExternalAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder_name": {
                    "description": "The name of the person or business that owns the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_holder_type": {
                    "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
                    "enum": ["", "company", "individual"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_type": {
                    "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.",
                    "enum": ["checking", "futsu", "savings", "toza"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_city": {
                    "description": "City/District/Suburb/Town/Village.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_country": {
                    "description": "Billing address country, if provided when creating card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line1": {
                    "description": "Address line 1 (Street address/PO Box/Company name).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line2": {
                    "description": "Address line 2 (Apartment/Suite/Unit/Building).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_state": {
                    "description": "State/County/Province/Region.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_zip": {
                    "description": "ZIP or postal code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_for_currency": {
                    "description": "When set to true, this becomes the default external account for its currency.",
                    "type": "boolean"
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "bank_account_ownership_verification": {
                        "properties": {
                          "files": {
                            "items": {
                              "maxLength": 500,
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "external_account_documents_param",
                    "type": "object"
                  },
                  "exp_month": {
                    "description": "Two digit number representing the card’s expiration month.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_year": {
                    "description": "Four digit number representing the card’s expiration year.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Cardholder name.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/external_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/accounts/{account}/login_links": {
      "post": {
        "description": "<p>Creates a login link for a connected account to access the Express Dashboard.</p>\n\n<p><strong>You can only create login links for accounts that use the <a href=\"/connect/express-dashboard\">Express Dashboard</a> and are connected to your platform</strong>.</p>",
        "operationId": "PostAccountsAccountLoginLinks",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/login_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a login link"
      }
    },
    "/v1/accounts/{account}/people": {
      "get": {
        "description": "<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>",
        "operationId": "GetAccountsAccountPeople",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filters on the list of people returned based on the person's relationship to the account's company.",
            "explode": true,
            "in": "query",
            "name": "relationship",
            "required": false,
            "schema": {
              "properties": {
                "authorizer": {
                  "type": "boolean"
                },
                "director": {
                  "type": "boolean"
                },
                "executive": {
                  "type": "boolean"
                },
                "legal_guardian": {
                  "type": "boolean"
                },
                "owner": {
                  "type": "boolean"
                },
                "representative": {
                  "type": "boolean"
                }
              },
              "title": "all_people_relationship_specs",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/person"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PersonList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all persons"
      },
      "post": {
        "description": "<p>Creates a new person.</p>",
        "operationId": "PostAccountsAccountPeople",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "additional_tos_acceptances": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kana": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kanji": {
                  "explode": true,
                  "style": "deepObject"
                },
                "dob": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "full_name_aliases": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "registered_address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "relationship": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verification": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "additional_tos_acceptances": {
                    "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
                    "properties": {
                      "account": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "settings_terms_of_service_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_additional_tos_acceptances_specs",
                    "type": "object"
                  },
                  "address": {
                    "description": "The person's address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "legal_entity_and_kyc_address_specs",
                    "type": "object"
                  },
                  "address_kana": {
                    "description": "The Kana variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kana_specs",
                    "type": "object"
                  },
                  "address_kanji": {
                    "description": "The Kanji variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kanji_specs",
                    "type": "object"
                  },
                  "dob": {
                    "anyOf": [
                      {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The person's date of birth."
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "company_authorization": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "passport": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "visa": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "person_documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The person's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "first_name": {
                    "description": "The person's first name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kana": {
                    "description": "The Kana variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kanji": {
                    "description": "The Kanji variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "full_name_aliases": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of alternate names or aliases that the person is known by."
                  },
                  "gender": {
                    "description": "The person's gender (International regulations require either \"male\" or \"female\").",
                    "type": "string"
                  },
                  "id_number": {
                    "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "id_number_secondary": {
                    "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name": {
                    "description": "The person's last name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kana": {
                    "description": "The Kana variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kanji": {
                    "description": "The Kanji variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "maiden_name": {
                    "description": "The person's maiden name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nationality": {
                    "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "person_token": {
                    "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "phone": {
                    "description": "The person's phone number.",
                    "type": "string"
                  },
                  "political_exposure": {
                    "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.",
                    "enum": ["existing", "none"],
                    "type": "string"
                  },
                  "registered_address": {
                    "description": "The person's registered address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "address_specs",
                    "type": "object"
                  },
                  "relationship": {
                    "description": "The relationship that this person has with the account's legal entity.",
                    "properties": {
                      "authorizer": {
                        "type": "boolean"
                      },
                      "director": {
                        "type": "boolean"
                      },
                      "executive": {
                        "type": "boolean"
                      },
                      "legal_guardian": {
                        "type": "boolean"
                      },
                      "owner": {
                        "type": "boolean"
                      },
                      "percent_ownership": {
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "representative": {
                        "type": "boolean"
                      },
                      "title": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "relationship_specs",
                    "type": "object"
                  },
                  "ssn_last_4": {
                    "description": "The last four digits of the person's Social Security number (U.S. only).",
                    "type": "string"
                  },
                  "verification": {
                    "description": "The person's verification status.",
                    "properties": {
                      "additional_document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      },
                      "document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_verification_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a person"
      }
    },
    "/v1/accounts/{account}/people/{person}": {
      "delete": {
        "description": "<p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>",
        "operationId": "DeleteAccountsAccountPeoplePerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a person"
      },
      "get": {
        "description": "<p>Retrieves an existing person.</p>",
        "operationId": "GetAccountsAccountPeoplePerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a person"
      },
      "post": {
        "description": "<p>Updates an existing person.</p>",
        "operationId": "PostAccountsAccountPeoplePerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "additional_tos_acceptances": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kana": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kanji": {
                  "explode": true,
                  "style": "deepObject"
                },
                "dob": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "full_name_aliases": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "registered_address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "relationship": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verification": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "additional_tos_acceptances": {
                    "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
                    "properties": {
                      "account": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "settings_terms_of_service_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_additional_tos_acceptances_specs",
                    "type": "object"
                  },
                  "address": {
                    "description": "The person's address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "legal_entity_and_kyc_address_specs",
                    "type": "object"
                  },
                  "address_kana": {
                    "description": "The Kana variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kana_specs",
                    "type": "object"
                  },
                  "address_kanji": {
                    "description": "The Kanji variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kanji_specs",
                    "type": "object"
                  },
                  "dob": {
                    "anyOf": [
                      {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The person's date of birth."
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "company_authorization": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "passport": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "visa": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "person_documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The person's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "first_name": {
                    "description": "The person's first name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kana": {
                    "description": "The Kana variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kanji": {
                    "description": "The Kanji variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "full_name_aliases": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of alternate names or aliases that the person is known by."
                  },
                  "gender": {
                    "description": "The person's gender (International regulations require either \"male\" or \"female\").",
                    "type": "string"
                  },
                  "id_number": {
                    "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "id_number_secondary": {
                    "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name": {
                    "description": "The person's last name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kana": {
                    "description": "The Kana variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kanji": {
                    "description": "The Kanji variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "maiden_name": {
                    "description": "The person's maiden name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nationality": {
                    "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "person_token": {
                    "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "phone": {
                    "description": "The person's phone number.",
                    "type": "string"
                  },
                  "political_exposure": {
                    "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.",
                    "enum": ["existing", "none"],
                    "type": "string"
                  },
                  "registered_address": {
                    "description": "The person's registered address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "address_specs",
                    "type": "object"
                  },
                  "relationship": {
                    "description": "The relationship that this person has with the account's legal entity.",
                    "properties": {
                      "authorizer": {
                        "type": "boolean"
                      },
                      "director": {
                        "type": "boolean"
                      },
                      "executive": {
                        "type": "boolean"
                      },
                      "legal_guardian": {
                        "type": "boolean"
                      },
                      "owner": {
                        "type": "boolean"
                      },
                      "percent_ownership": {
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "representative": {
                        "type": "boolean"
                      },
                      "title": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "relationship_specs",
                    "type": "object"
                  },
                  "ssn_last_4": {
                    "description": "The last four digits of the person's Social Security number (U.S. only).",
                    "type": "string"
                  },
                  "verification": {
                    "description": "The person's verification status.",
                    "properties": {
                      "additional_document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      },
                      "document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_verification_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a person"
      }
    },
    "/v1/accounts/{account}/persons": {
      "get": {
        "description": "<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>",
        "operationId": "GetAccountsAccountPersons",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filters on the list of people returned based on the person's relationship to the account's company.",
            "explode": true,
            "in": "query",
            "name": "relationship",
            "required": false,
            "schema": {
              "properties": {
                "authorizer": {
                  "type": "boolean"
                },
                "director": {
                  "type": "boolean"
                },
                "executive": {
                  "type": "boolean"
                },
                "legal_guardian": {
                  "type": "boolean"
                },
                "owner": {
                  "type": "boolean"
                },
                "representative": {
                  "type": "boolean"
                }
              },
              "title": "all_people_relationship_specs",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/person"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PersonList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all persons"
      },
      "post": {
        "description": "<p>Creates a new person.</p>",
        "operationId": "PostAccountsAccountPersons",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "additional_tos_acceptances": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kana": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kanji": {
                  "explode": true,
                  "style": "deepObject"
                },
                "dob": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "full_name_aliases": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "registered_address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "relationship": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verification": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "additional_tos_acceptances": {
                    "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
                    "properties": {
                      "account": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "settings_terms_of_service_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_additional_tos_acceptances_specs",
                    "type": "object"
                  },
                  "address": {
                    "description": "The person's address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "legal_entity_and_kyc_address_specs",
                    "type": "object"
                  },
                  "address_kana": {
                    "description": "The Kana variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kana_specs",
                    "type": "object"
                  },
                  "address_kanji": {
                    "description": "The Kanji variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kanji_specs",
                    "type": "object"
                  },
                  "dob": {
                    "anyOf": [
                      {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The person's date of birth."
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "company_authorization": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "passport": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "visa": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "person_documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The person's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "first_name": {
                    "description": "The person's first name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kana": {
                    "description": "The Kana variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kanji": {
                    "description": "The Kanji variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "full_name_aliases": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of alternate names or aliases that the person is known by."
                  },
                  "gender": {
                    "description": "The person's gender (International regulations require either \"male\" or \"female\").",
                    "type": "string"
                  },
                  "id_number": {
                    "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "id_number_secondary": {
                    "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name": {
                    "description": "The person's last name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kana": {
                    "description": "The Kana variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kanji": {
                    "description": "The Kanji variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "maiden_name": {
                    "description": "The person's maiden name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nationality": {
                    "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "person_token": {
                    "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "phone": {
                    "description": "The person's phone number.",
                    "type": "string"
                  },
                  "political_exposure": {
                    "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.",
                    "enum": ["existing", "none"],
                    "type": "string"
                  },
                  "registered_address": {
                    "description": "The person's registered address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "address_specs",
                    "type": "object"
                  },
                  "relationship": {
                    "description": "The relationship that this person has with the account's legal entity.",
                    "properties": {
                      "authorizer": {
                        "type": "boolean"
                      },
                      "director": {
                        "type": "boolean"
                      },
                      "executive": {
                        "type": "boolean"
                      },
                      "legal_guardian": {
                        "type": "boolean"
                      },
                      "owner": {
                        "type": "boolean"
                      },
                      "percent_ownership": {
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "representative": {
                        "type": "boolean"
                      },
                      "title": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "relationship_specs",
                    "type": "object"
                  },
                  "ssn_last_4": {
                    "description": "The last four digits of the person's Social Security number (U.S. only).",
                    "type": "string"
                  },
                  "verification": {
                    "description": "The person's verification status.",
                    "properties": {
                      "additional_document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      },
                      "document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_verification_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a person"
      }
    },
    "/v1/accounts/{account}/persons/{person}": {
      "delete": {
        "description": "<p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>",
        "operationId": "DeleteAccountsAccountPersonsPerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a person"
      },
      "get": {
        "description": "<p>Retrieves an existing person.</p>",
        "operationId": "GetAccountsAccountPersonsPerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a person"
      },
      "post": {
        "description": "<p>Updates an existing person.</p>",
        "operationId": "PostAccountsAccountPersonsPerson",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "person",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "additional_tos_acceptances": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kana": {
                  "explode": true,
                  "style": "deepObject"
                },
                "address_kanji": {
                  "explode": true,
                  "style": "deepObject"
                },
                "dob": {
                  "explode": true,
                  "style": "deepObject"
                },
                "documents": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "full_name_aliases": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "registered_address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "relationship": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verification": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "additional_tos_acceptances": {
                    "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.",
                    "properties": {
                      "account": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "user_agent": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "settings_terms_of_service_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_additional_tos_acceptances_specs",
                    "type": "object"
                  },
                  "address": {
                    "description": "The person's address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "legal_entity_and_kyc_address_specs",
                    "type": "object"
                  },
                  "address_kana": {
                    "description": "The Kana variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kana_specs",
                    "type": "object"
                  },
                  "address_kanji": {
                    "description": "The Kanji variation of the person's address (Japan only).",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "town": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "japan_address_kanji_specs",
                    "type": "object"
                  },
                  "dob": {
                    "anyOf": [
                      {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The person's date of birth."
                  },
                  "documents": {
                    "description": "Documents that may be submitted to satisfy various informational requests.",
                    "properties": {
                      "company_authorization": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "passport": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      },
                      "visa": {
                        "properties": {
                          "files": {
                            "items": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "type": "array"
                          }
                        },
                        "title": "documents_param",
                        "type": "object"
                      }
                    },
                    "title": "person_documents_specs",
                    "type": "object"
                  },
                  "email": {
                    "description": "The person's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "first_name": {
                    "description": "The person's first name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kana": {
                    "description": "The Kana variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "first_name_kanji": {
                    "description": "The Kanji variation of the person's first name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "full_name_aliases": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of alternate names or aliases that the person is known by."
                  },
                  "gender": {
                    "description": "The person's gender (International regulations require either \"male\" or \"female\").",
                    "type": "string"
                  },
                  "id_number": {
                    "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "id_number_secondary": {
                    "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name": {
                    "description": "The person's last name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kana": {
                    "description": "The Kana variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "last_name_kanji": {
                    "description": "The Kanji variation of the person's last name (Japan only).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "maiden_name": {
                    "description": "The person's maiden name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nationality": {
                    "description": "The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \"XX\" if unavailable.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "person_token": {
                    "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "phone": {
                    "description": "The person's phone number.",
                    "type": "string"
                  },
                  "political_exposure": {
                    "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.",
                    "enum": ["existing", "none"],
                    "type": "string"
                  },
                  "registered_address": {
                    "description": "The person's registered address.",
                    "properties": {
                      "city": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 200,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "address_specs",
                    "type": "object"
                  },
                  "relationship": {
                    "description": "The relationship that this person has with the account's legal entity.",
                    "properties": {
                      "authorizer": {
                        "type": "boolean"
                      },
                      "director": {
                        "type": "boolean"
                      },
                      "executive": {
                        "type": "boolean"
                      },
                      "legal_guardian": {
                        "type": "boolean"
                      },
                      "owner": {
                        "type": "boolean"
                      },
                      "percent_ownership": {
                        "anyOf": [
                          {
                            "type": "number"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "representative": {
                        "type": "boolean"
                      },
                      "title": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "relationship_specs",
                    "type": "object"
                  },
                  "ssn_last_4": {
                    "description": "The last four digits of the person's Social Security number (U.S. only).",
                    "type": "string"
                  },
                  "verification": {
                    "description": "The person's verification status.",
                    "properties": {
                      "additional_document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      },
                      "document": {
                        "properties": {
                          "back": {
                            "maxLength": 500,
                            "type": "string"
                          },
                          "front": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "person_verification_document_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_verification_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/person"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a person"
      }
    },
    "/v1/accounts/{account}/reject": {
      "post": {
        "description": "<p>With <a href=\"/connect\">Connect</a>, you can reject accounts that you have flagged as suspicious.</p>\n\n<p>Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.</p>",
        "operationId": "PostAccountsAccountReject",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "reason": {
                    "description": "The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["reason"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reject an account"
      }
    },
    "/v1/apple_pay/domains": {
      "get": {
        "description": "<p>List apple pay domains.</p>",
        "operationId": "GetApplePayDomains",
        "parameters": [
          {
            "in": "query",
            "name": "domain_name",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/apple_pay_domain"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/apple_pay/domains",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ApplePayDomainList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "post": {
        "description": "<p>Create an apple pay domain.</p>",
        "operationId": "PostApplePayDomains",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "domain_name": {
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["domain_name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apple_pay_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/apple_pay/domains/{domain}": {
      "delete": {
        "description": "<p>Delete an apple pay domain.</p>",
        "operationId": "DeleteApplePayDomainsDomain",
        "parameters": [
          {
            "in": "path",
            "name": "domain",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_apple_pay_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "get": {
        "description": "<p>Retrieve an apple pay domain.</p>",
        "operationId": "GetApplePayDomainsDomain",
        "parameters": [
          {
            "in": "path",
            "name": "domain",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apple_pay_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/application_fees": {
      "get": {
        "description": "<p>Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.</p>",
        "operationId": "GetApplicationFees",
        "parameters": [
          {
            "description": "Only return application fees for the charge specified by this charge ID.",
            "in": "query",
            "name": "charge",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return applications fees that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/application_fee"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/application_fees",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PlatformEarningList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all application fees"
      }
    },
    "/v1/application_fees/{fee}/refunds/{id}": {
      "get": {
        "description": "<p>By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.</p>",
        "operationId": "GetApplicationFeesFeeRefundsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "fee",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/fee_refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an application fee refund"
      },
      "post": {
        "description": "<p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>\n\n<p>This request only accepts metadata as an argument.</p>",
        "operationId": "PostApplicationFeesFeeRefundsId",
        "parameters": [
          {
            "in": "path",
            "name": "fee",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/fee_refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an application fee refund"
      }
    },
    "/v1/application_fees/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p>",
        "operationId": "GetApplicationFeesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/application_fee"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an application fee"
      }
    },
    "/v1/application_fees/{id}/refund": {
      "post": {
        "description": "",
        "operationId": "PostApplicationFeesIdRefund",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "directive": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/application_fee"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/application_fees/{id}/refunds": {
      "get": {
        "description": "<p>You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>",
        "operationId": "GetApplicationFeesIdRefunds",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/fee_refund"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "FeeRefundList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all application fee refunds"
      },
      "post": {
        "description": "<p>Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.</p>\n\n<p>You can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.</p>\n\n<p>Once entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.</p>",
        "operationId": "PostApplicationFeesIdRefunds",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/fee_refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an application fee refund"
      }
    },
    "/v1/apps/secrets": {
      "get": {
        "description": "<p>List all secrets stored on the given scope.</p>",
        "operationId": "GetAppsSecrets",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.",
            "explode": true,
            "in": "query",
            "name": "scope",
            "required": true,
            "schema": {
              "properties": {
                "type": {
                  "enum": ["account", "user"],
                  "type": "string"
                },
                "user": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "scope_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/apps.secret"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/apps/secrets",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SecretServiceResourceSecretList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List secrets"
      },
      "post": {
        "description": "<p>Create or replace a secret in the secret store.</p>",
        "operationId": "PostAppsSecrets",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "scope": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "name": {
                    "description": "A name for the secret that's unique within the scope.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payload": {
                    "description": "The plaintext secret value to be stored.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "scope": {
                    "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.",
                    "properties": {
                      "type": {
                        "enum": ["account", "user"],
                        "type": "string"
                      },
                      "user": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "scope_param",
                    "type": "object"
                  }
                },
                "required": ["name", "payload", "scope"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apps.secret"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Set a Secret"
      }
    },
    "/v1/apps/secrets/delete": {
      "post": {
        "description": "<p>Deletes a secret from the secret store by name and scope.</p>",
        "operationId": "PostAppsSecretsDelete",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "scope": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "name": {
                    "description": "A name for the secret that's unique within the scope.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "scope": {
                    "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.",
                    "properties": {
                      "type": {
                        "enum": ["account", "user"],
                        "type": "string"
                      },
                      "user": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "scope_param",
                    "type": "object"
                  }
                },
                "required": ["name", "scope"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apps.secret"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a Secret"
      }
    },
    "/v1/apps/secrets/find": {
      "get": {
        "description": "<p>Finds a secret in the secret store by name and scope.</p>",
        "operationId": "GetAppsSecretsFind",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A name for the secret that's unique within the scope.",
            "in": "query",
            "name": "name",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.",
            "explode": true,
            "in": "query",
            "name": "scope",
            "required": true,
            "schema": {
              "properties": {
                "type": {
                  "enum": ["account", "user"],
                  "type": "string"
                },
                "user": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "scope_param",
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/apps.secret"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Find a Secret"
      }
    },
    "/v1/balance": {
      "get": {
        "description": "<p>Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see <a href=\"/docs/connect/account-balances#accounting-for-negative-balances\">Accounting for negative balances</a>.</p>",
        "operationId": "GetBalance",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/balance"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve balance"
      }
    },
    "/v1/balance/history": {
      "get": {
        "description": "<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p>\n\n<p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>",
        "operationId": "GetBalanceHistory",
        "parameters": [
          {
            "description": "Only return transactions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.",
            "in": "query",
            "name": "payout",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only returns the original transaction.",
            "in": "query",
            "name": "source",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/balance_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/balance_transactions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BalanceTransactionsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all balance transactions"
      }
    },
    "/v1/balance/history/{id}": {
      "get": {
        "description": "<p>Retrieves the balance transaction with the given ID.</p>\n\n<p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p>",
        "operationId": "GetBalanceHistoryId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a balance transaction"
      }
    },
    "/v1/balance_transactions": {
      "get": {
        "description": "<p>Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p>\n\n<p>Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.</p>",
        "operationId": "GetBalanceTransactions",
        "parameters": [
          {
            "description": "Only return transactions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.",
            "in": "query",
            "name": "payout",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only returns the original transaction.",
            "in": "query",
            "name": "source",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/balance_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/balance_transactions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BalanceTransactionsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all balance transactions"
      }
    },
    "/v1/balance_transactions/{id}": {
      "get": {
        "description": "<p>Retrieves the balance transaction with the given ID.</p>\n\n<p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p>",
        "operationId": "GetBalanceTransactionsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a balance transaction"
      }
    },
    "/v1/billing/alerts": {
      "get": {
        "description": "<p>Lists billing active and inactive alerts</p>",
        "operationId": "GetBillingAlerts",
        "parameters": [
          {
            "description": "Filter results to only include this type of alert.",
            "in": "query",
            "name": "alert_type",
            "required": false,
            "schema": {
              "enum": ["usage_threshold"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filter results to only include alerts with the given meter.",
            "in": "query",
            "name": "meter",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing.alert"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing/alerts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ThresholdsResourceAlertList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List billing alerts"
      },
      "post": {
        "description": "<p>Creates a billing alert</p>",
        "operationId": "PostBillingAlerts",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "usage_threshold": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alert_type": {
                    "description": "The type of alert to create.",
                    "enum": ["usage_threshold"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "title": {
                    "description": "The title of the alert.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "usage_threshold": {
                    "description": "The configuration of the usage threshold.",
                    "properties": {
                      "filters": {
                        "items": {
                          "properties": {
                            "customer": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": {
                              "enum": ["customer"],
                              "type": "string"
                            }
                          },
                          "required": ["type"],
                          "title": "usage_alert_filter",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "gte": {
                        "type": "integer"
                      },
                      "meter": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "recurrence": {
                        "enum": ["one_time"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "required": ["gte", "recurrence"],
                    "title": "usage_threshold_config",
                    "type": "object"
                  }
                },
                "required": ["alert_type", "title"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.alert"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a billing alert"
      }
    },
    "/v1/billing/alerts/{id}": {
      "get": {
        "description": "<p>Retrieves a billing alert given an ID</p>",
        "operationId": "GetBillingAlertsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.alert"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a billing alert"
      }
    },
    "/v1/billing/alerts/{id}/activate": {
      "post": {
        "description": "<p>Reactivates this alert, allowing it to trigger again.</p>",
        "operationId": "PostBillingAlertsIdActivate",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.alert"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Activate a billing alert"
      }
    },
    "/v1/billing/alerts/{id}/archive": {
      "post": {
        "description": "<p>Archives this alert, removing it from the list view and APIs. This is non-reversible.</p>",
        "operationId": "PostBillingAlertsIdArchive",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.alert"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Archive a billing alert"
      }
    },
    "/v1/billing/alerts/{id}/deactivate": {
      "post": {
        "description": "<p>Deactivates this alert, preventing it from triggering.</p>",
        "operationId": "PostBillingAlertsIdDeactivate",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.alert"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Deactivate a billing alert"
      }
    },
    "/v1/billing/credit_balance_summary": {
      "get": {
        "description": "<p>Retrieves the credit balance summary for a customer.</p>",
        "operationId": "GetBillingCreditBalanceSummary",
        "parameters": [
          {
            "description": "The customer for which to fetch credit balance summary.",
            "in": "query",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The filter criteria for the credit balance summary.",
            "explode": true,
            "in": "query",
            "name": "filter",
            "required": true,
            "schema": {
              "properties": {
                "applicability_scope": {
                  "properties": {
                    "price_type": {
                      "enum": ["metered"],
                      "type": "string"
                    },
                    "prices": {
                      "items": {
                        "properties": {
                          "id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["id"],
                        "title": "applicable_price_param",
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "title": "scope_param",
                  "type": "object"
                },
                "credit_grant": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "type": {
                  "enum": ["applicability_scope", "credit_grant"],
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "balance_summary_filter_param",
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_balance_summary"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve the credit balance summary for a customer"
      }
    },
    "/v1/billing/credit_balance_transactions": {
      "get": {
        "description": "<p>Retrieve a list of credit balance transactions.</p>",
        "operationId": "GetBillingCreditBalanceTransactions",
        "parameters": [
          {
            "description": "The credit grant for which to fetch credit balance transactions.",
            "in": "query",
            "name": "credit_grant",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The customer for which to fetch credit balance transactions.",
            "in": "query",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing.credit_balance_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing/credit_grants",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BillingCreditGrantsResourceBalanceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List credit balance transactions"
      }
    },
    "/v1/billing/credit_balance_transactions/{id}": {
      "get": {
        "description": "<p>Retrieves a credit balance transaction.</p>",
        "operationId": "GetBillingCreditBalanceTransactionsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a credit balance transaction"
      }
    },
    "/v1/billing/credit_grants": {
      "get": {
        "description": "<p>Retrieve a list of credit grants.</p>",
        "operationId": "GetBillingCreditGrants",
        "parameters": [
          {
            "description": "Only return credit grants for this customer.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing.credit_grant"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing/credit_grants",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BillingCreditGrantsResourceCreditGrantList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List credit grants"
      },
      "post": {
        "description": "<p>Creates a credit grant.</p>",
        "operationId": "PostBillingCreditGrants",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "applicability_config": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount of this credit grant.",
                    "properties": {
                      "monetary": {
                        "properties": {
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "value": {
                            "type": "integer"
                          }
                        },
                        "required": ["currency", "value"],
                        "title": "monetary_amount_param",
                        "type": "object"
                      },
                      "type": {
                        "enum": ["monetary"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "amount_param",
                    "type": "object"
                  },
                  "applicability_config": {
                    "description": "Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.",
                    "properties": {
                      "scope": {
                        "properties": {
                          "price_type": {
                            "enum": ["metered"],
                            "type": "string"
                          },
                          "prices": {
                            "items": {
                              "properties": {
                                "id": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "required": ["id"],
                              "title": "applicable_price_param",
                              "type": "object"
                            },
                            "type": "array"
                          }
                        },
                        "title": "scope_param",
                        "type": "object"
                      }
                    },
                    "required": ["scope"],
                    "title": "applicability_config_param",
                    "type": "object"
                  },
                  "category": {
                    "description": "The category of this credit grant.",
                    "enum": ["paid", "promotional"],
                    "type": "string"
                  },
                  "customer": {
                    "description": "ID of the customer to receive the billing credits.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "effective_at": {
                    "description": "The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "The time when the billing credits expire. If not specified, the billing credits don't expire.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.",
                    "type": "object"
                  },
                  "name": {
                    "description": "A descriptive name shown in the Dashboard.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "priority": {
                    "description": "The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.",
                    "type": "integer"
                  }
                },
                "required": [
                  "amount",
                  "applicability_config",
                  "category",
                  "customer"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a credit grant"
      }
    },
    "/v1/billing/credit_grants/{id}": {
      "get": {
        "description": "<p>Retrieves a credit grant.</p>",
        "operationId": "GetBillingCreditGrantsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a credit grant"
      },
      "post": {
        "description": "<p>Updates a credit grant.</p>",
        "operationId": "PostBillingCreditGrantsId",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expires_at": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "anyOf": [
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire."
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a credit grant"
      }
    },
    "/v1/billing/credit_grants/{id}/expire": {
      "post": {
        "description": "<p>Expires a credit grant.</p>",
        "operationId": "PostBillingCreditGrantsIdExpire",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Expire a credit grant"
      }
    },
    "/v1/billing/credit_grants/{id}/void": {
      "post": {
        "description": "<p>Voids a credit grant.</p>",
        "operationId": "PostBillingCreditGrantsIdVoid",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.credit_grant"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Void a credit grant"
      }
    },
    "/v1/billing/meter_event_adjustments": {
      "post": {
        "description": "<p>Creates a billing meter event adjustment.</p>",
        "operationId": "PostBillingMeterEventAdjustments",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "cancel": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cancel": {
                    "description": "Specifies which event to cancel.",
                    "properties": {
                      "identifier": {
                        "maxLength": 100,
                        "type": "string"
                      }
                    },
                    "title": "event_adjustment_cancel_settings_param",
                    "type": "object"
                  },
                  "event_name": {
                    "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "type": {
                    "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.",
                    "enum": ["cancel"],
                    "type": "string"
                  }
                },
                "required": ["event_name", "type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter_event_adjustment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a billing meter event adjustment"
      }
    },
    "/v1/billing/meter_events": {
      "post": {
        "description": "<p>Creates a billing meter event.</p>",
        "operationId": "PostBillingMeterEvents",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payload": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "event_name": {
                    "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "identifier": {
                    "description": "A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payload": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).",
                    "type": "object"
                  },
                  "timestamp": {
                    "description": "The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "required": ["event_name", "payload"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter_event"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a billing meter event"
      }
    },
    "/v1/billing/meters": {
      "get": {
        "description": "<p>Retrieve a list of billing meters.</p>",
        "operationId": "GetBillingMeters",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Filter results to only include meters with the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "inactive"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing.meter"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing/meters",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BillingMeterResourceBillingMeterList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List billing meters"
      },
      "post": {
        "description": "<p>Creates a billing meter.</p>",
        "operationId": "PostBillingMeters",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "customer_mapping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_aggregation": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "value_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "customer_mapping": {
                    "description": "Fields that specify how to map a meter event to a customer.",
                    "properties": {
                      "event_payload_key": {
                        "maxLength": 100,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["by_id"],
                        "type": "string"
                      }
                    },
                    "required": ["event_payload_key", "type"],
                    "title": "customer_mapping_param",
                    "type": "object"
                  },
                  "default_aggregation": {
                    "description": "The default settings to aggregate a meter's events with.",
                    "properties": {
                      "formula": {
                        "enum": ["count", "sum"],
                        "type": "string"
                      }
                    },
                    "required": ["formula"],
                    "title": "aggregation_settings_param",
                    "type": "object"
                  },
                  "display_name": {
                    "description": "The meter’s name. Not visible to the customer.",
                    "maxLength": 250,
                    "type": "string"
                  },
                  "event_name": {
                    "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "event_time_window": {
                    "description": "The time window to pre-aggregate meter events for, if any.",
                    "enum": ["day", "hour"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "value_settings": {
                    "description": "Fields that specify how to calculate a meter event's value.",
                    "properties": {
                      "event_payload_key": {
                        "maxLength": 100,
                        "type": "string"
                      }
                    },
                    "required": ["event_payload_key"],
                    "title": "meter_value_settings_param",
                    "type": "object"
                  }
                },
                "required": [
                  "default_aggregation",
                  "display_name",
                  "event_name"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a billing meter"
      }
    },
    "/v1/billing/meters/{id}": {
      "get": {
        "description": "<p>Retrieves a billing meter given an ID.</p>",
        "operationId": "GetBillingMetersId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a billing meter"
      },
      "post": {
        "description": "<p>Updates a billing meter.</p>",
        "operationId": "PostBillingMetersId",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "display_name": {
                    "description": "The meter’s name. Not visible to the customer.",
                    "maxLength": 250,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a billing meter"
      }
    },
    "/v1/billing/meters/{id}/deactivate": {
      "post": {
        "description": "<p>When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.</p>",
        "operationId": "PostBillingMetersIdDeactivate",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Deactivate a billing meter"
      }
    },
    "/v1/billing/meters/{id}/event_summaries": {
      "get": {
        "description": "<p>Retrieve a list of billing meter event summaries.</p>",
        "operationId": "GetBillingMetersIdEventSummaries",
        "parameters": [
          {
            "description": "The customer for which to fetch event summaries.",
            "in": "query",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.",
            "in": "query",
            "name": "end_time",
            "required": true,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.",
            "in": "query",
            "name": "start_time",
            "required": true,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).",
            "in": "query",
            "name": "value_grouping_window",
            "required": false,
            "schema": {
              "enum": ["day", "hour"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing.meter_event_summary"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing/meters/[^/]+/event_summaries",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BillingMeterResourceBillingMeterEventSummaryList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List billing meter event summaries"
      }
    },
    "/v1/billing/meters/{id}/reactivate": {
      "post": {
        "description": "<p>When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.</p>",
        "operationId": "PostBillingMetersIdReactivate",
        "parameters": [
          {
            "description": "Unique identifier for the object.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing.meter"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reactivate a billing meter"
      }
    },
    "/v1/billing_portal/configurations": {
      "get": {
        "description": "<p>Returns a list of configurations that describe the functionality of the customer portal.</p>",
        "operationId": "GetBillingPortalConfigurations",
        "parameters": [
          {
            "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).",
            "in": "query",
            "name": "is_default",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/billing_portal.configuration"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/billing_portal/configurations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PortalPublicResourceConfigurationList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List portal configurations"
      },
      "post": {
        "description": "<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>",
        "operationId": "PostBillingPortalConfigurations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "business_profile": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_return_url": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "login_page": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "business_profile": {
                    "description": "The business information shown to customers in the portal.",
                    "properties": {
                      "headline": {
                        "anyOf": [
                          {
                            "maxLength": 60,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "privacy_policy_url": {
                        "type": "string"
                      },
                      "terms_of_service_url": {
                        "type": "string"
                      }
                    },
                    "title": "business_profile_create_param",
                    "type": "object"
                  },
                  "default_return_url": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "Information about the features available in the portal.",
                    "properties": {
                      "customer_update": {
                        "properties": {
                          "allowed_updates": {
                            "anyOf": [
                              {
                                "items": {
                                  "enum": [
                                    "address",
                                    "email",
                                    "name",
                                    "phone",
                                    "shipping",
                                    "tax_id"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "customer_update_creation_param",
                        "type": "object"
                      },
                      "invoice_history": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "invoice_list_param",
                        "type": "object"
                      },
                      "payment_method_update": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payment_method_update_param",
                        "type": "object"
                      },
                      "subscription_cancel": {
                        "properties": {
                          "cancellation_reason": {
                            "properties": {
                              "enabled": {
                                "type": "boolean"
                              },
                              "options": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "enum": [
                                        "customer_service",
                                        "low_quality",
                                        "missing_features",
                                        "other",
                                        "switched_service",
                                        "too_complex",
                                        "too_expensive",
                                        "unused"
                                      ],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "required": ["enabled", "options"],
                            "title": "subscription_cancellation_reason_creation_param",
                            "type": "object"
                          },
                          "enabled": {
                            "type": "boolean"
                          },
                          "mode": {
                            "enum": ["at_period_end", "immediately"],
                            "type": "string"
                          },
                          "proration_behavior": {
                            "enum": [
                              "always_invoice",
                              "create_prorations",
                              "none"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["enabled"],
                        "title": "subscription_cancel_creation_param",
                        "type": "object"
                      },
                      "subscription_update": {
                        "properties": {
                          "default_allowed_updates": {
                            "anyOf": [
                              {
                                "items": {
                                  "enum": [
                                    "price",
                                    "promotion_code",
                                    "quantity"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "enabled": {
                            "type": "boolean"
                          },
                          "products": {
                            "anyOf": [
                              {
                                "items": {
                                  "properties": {
                                    "prices": {
                                      "items": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "type": "array"
                                    },
                                    "product": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    }
                                  },
                                  "required": ["prices", "product"],
                                  "title": "subscription_update_product_param",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "proration_behavior": {
                            "enum": [
                              "always_invoice",
                              "create_prorations",
                              "none"
                            ],
                            "type": "string"
                          },
                          "schedule_at_period_end": {
                            "properties": {
                              "conditions": {
                                "items": {
                                  "properties": {
                                    "type": {
                                      "enum": [
                                        "decreasing_item_amount",
                                        "shortening_interval"
                                      ],
                                      "type": "string"
                                    }
                                  },
                                  "required": ["type"],
                                  "title": "schedule_update_at_period_end_condition_param",
                                  "type": "object"
                                },
                                "type": "array"
                              }
                            },
                            "title": "schedule_update_at_period_end_creating_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "subscription_update_creation_param",
                        "type": "object"
                      }
                    },
                    "title": "features_creation_param",
                    "type": "object"
                  },
                  "login_page": {
                    "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "login_page_create_param",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "required": ["features"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing_portal.configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a portal configuration"
      }
    },
    "/v1/billing_portal/configurations/{configuration}": {
      "get": {
        "description": "<p>Retrieves a configuration that describes the functionality of the customer portal.</p>",
        "operationId": "GetBillingPortalConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing_portal.configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a portal configuration"
      },
      "post": {
        "description": "<p>Updates a configuration that describes the functionality of the customer portal.</p>",
        "operationId": "PostBillingPortalConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "business_profile": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_return_url": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "login_page": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the configuration is active and can be used to create portal sessions.",
                    "type": "boolean"
                  },
                  "business_profile": {
                    "description": "The business information shown to customers in the portal.",
                    "properties": {
                      "headline": {
                        "anyOf": [
                          {
                            "maxLength": 60,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "privacy_policy_url": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "terms_of_service_url": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "business_profile_update_param",
                    "type": "object"
                  },
                  "default_return_url": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "Information about the features available in the portal.",
                    "properties": {
                      "customer_update": {
                        "properties": {
                          "allowed_updates": {
                            "anyOf": [
                              {
                                "items": {
                                  "enum": [
                                    "address",
                                    "email",
                                    "name",
                                    "phone",
                                    "shipping",
                                    "tax_id"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "title": "customer_update_updating_param",
                        "type": "object"
                      },
                      "invoice_history": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "invoice_list_param",
                        "type": "object"
                      },
                      "payment_method_update": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payment_method_update_param",
                        "type": "object"
                      },
                      "subscription_cancel": {
                        "properties": {
                          "cancellation_reason": {
                            "properties": {
                              "enabled": {
                                "type": "boolean"
                              },
                              "options": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "enum": [
                                        "customer_service",
                                        "low_quality",
                                        "missing_features",
                                        "other",
                                        "switched_service",
                                        "too_complex",
                                        "too_expensive",
                                        "unused"
                                      ],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "required": ["enabled"],
                            "title": "subscription_cancellation_reason_updating_param",
                            "type": "object"
                          },
                          "enabled": {
                            "type": "boolean"
                          },
                          "mode": {
                            "enum": ["at_period_end", "immediately"],
                            "type": "string"
                          },
                          "proration_behavior": {
                            "enum": [
                              "always_invoice",
                              "create_prorations",
                              "none"
                            ],
                            "type": "string"
                          }
                        },
                        "title": "subscription_cancel_updating_param",
                        "type": "object"
                      },
                      "subscription_update": {
                        "properties": {
                          "default_allowed_updates": {
                            "anyOf": [
                              {
                                "items": {
                                  "enum": [
                                    "price",
                                    "promotion_code",
                                    "quantity"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "enabled": {
                            "type": "boolean"
                          },
                          "products": {
                            "anyOf": [
                              {
                                "items": {
                                  "properties": {
                                    "prices": {
                                      "items": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "type": "array"
                                    },
                                    "product": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    }
                                  },
                                  "required": ["prices", "product"],
                                  "title": "subscription_update_product_param",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "proration_behavior": {
                            "enum": [
                              "always_invoice",
                              "create_prorations",
                              "none"
                            ],
                            "type": "string"
                          },
                          "schedule_at_period_end": {
                            "properties": {
                              "conditions": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "properties": {
                                        "type": {
                                          "enum": [
                                            "decreasing_item_amount",
                                            "shortening_interval"
                                          ],
                                          "type": "string"
                                        }
                                      },
                                      "required": ["type"],
                                      "title": "schedule_update_at_period_end_condition_param",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "schedule_update_at_period_end_updating_param",
                            "type": "object"
                          }
                        },
                        "title": "subscription_update_updating_param",
                        "type": "object"
                      }
                    },
                    "title": "features_updating_param",
                    "type": "object"
                  },
                  "login_page": {
                    "description": "The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "login_page_update_param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing_portal.configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a portal configuration"
      }
    },
    "/v1/billing_portal/sessions": {
      "post": {
        "description": "<p>Creates a session of the customer portal.</p>",
        "operationId": "PostBillingPortalSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "flow_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "configuration": {
                    "description": "The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer": {
                    "description": "The ID of an existing customer.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "flow_data": {
                    "description": "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.",
                    "properties": {
                      "after_completion": {
                        "properties": {
                          "hosted_confirmation": {
                            "properties": {
                              "custom_message": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "after_completion_hosted_confirmation_param",
                            "type": "object"
                          },
                          "redirect": {
                            "properties": {
                              "return_url": {
                                "type": "string"
                              }
                            },
                            "required": ["return_url"],
                            "title": "after_completion_redirect_param",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "hosted_confirmation",
                              "portal_homepage",
                              "redirect"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "flow_data_after_completion_param",
                        "type": "object"
                      },
                      "subscription_cancel": {
                        "properties": {
                          "retention": {
                            "properties": {
                              "coupon_offer": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["coupon"],
                                "title": "coupon_offer_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["coupon_offer"],
                                "type": "string"
                              }
                            },
                            "required": ["coupon_offer", "type"],
                            "title": "retention_param",
                            "type": "object"
                          },
                          "subscription": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["subscription"],
                        "title": "flow_data_subscription_cancel_param",
                        "type": "object"
                      },
                      "subscription_update": {
                        "properties": {
                          "subscription": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["subscription"],
                        "title": "flow_data_subscription_update_param",
                        "type": "object"
                      },
                      "subscription_update_confirm": {
                        "properties": {
                          "discounts": {
                            "items": {
                              "properties": {
                                "coupon": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "promotion_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "title": "subscription_update_confirm_discount_params",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "items": {
                            "items": {
                              "properties": {
                                "id": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "price": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "quantity": {
                                  "type": "integer"
                                }
                              },
                              "required": ["id"],
                              "title": "subscription_update_confirm_item_params",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "subscription": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["items", "subscription"],
                        "title": "flow_data_subscription_update_confirm_param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "payment_method_update",
                          "subscription_cancel",
                          "subscription_update",
                          "subscription_update_confirm"
                        ],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "flow_data_param",
                    "type": "object"
                  },
                  "locale": {
                    "description": "The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.",
                    "enum": [
                      "auto",
                      "bg",
                      "cs",
                      "da",
                      "de",
                      "el",
                      "en",
                      "en-AU",
                      "en-CA",
                      "en-GB",
                      "en-IE",
                      "en-IN",
                      "en-NZ",
                      "en-SG",
                      "es",
                      "es-419",
                      "et",
                      "fi",
                      "fil",
                      "fr",
                      "fr-CA",
                      "hr",
                      "hu",
                      "id",
                      "it",
                      "ja",
                      "ko",
                      "lt",
                      "lv",
                      "ms",
                      "mt",
                      "nb",
                      "nl",
                      "pl",
                      "pt",
                      "pt-BR",
                      "ro",
                      "ru",
                      "sk",
                      "sl",
                      "sv",
                      "th",
                      "tr",
                      "vi",
                      "zh",
                      "zh-HK",
                      "zh-TW"
                    ],
                    "type": "string"
                  },
                  "on_behalf_of": {
                    "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.",
                    "type": "string"
                  },
                  "return_url": {
                    "description": "The default URL to redirect customers to when they click on the portal's link to return to your website.",
                    "type": "string"
                  }
                },
                "required": ["customer"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/billing_portal.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a portal session"
      }
    },
    "/v1/charges": {
      "get": {
        "description": "<p>Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.</p>",
        "operationId": "GetCharges",
        "parameters": [
          {
            "description": "Only return charges that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return charges for the customer specified by this customer ID.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.",
            "in": "query",
            "name": "payment_intent",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return charges for this transfer group, limited to 100.",
            "in": "query",
            "name": "transfer_group",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/charge"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/charges",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ChargeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all charges"
      },
      "post": {
        "description": "<p>This method is no longer recommended—use the <a href=\"/docs/api/payment_intents\">Payment Intents API</a>\nto initiate a new payment instead. Confirmation of the PaymentIntent creates the <code>Charge</code>\nobject used to request payment.</p>",
        "operationId": "PostCharges",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "destination": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "radar_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
                    "type": "integer"
                  },
                  "application_fee": {
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).",
                    "type": "integer"
                  },
                  "capture": {
                    "description": "Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.",
                    "type": "boolean"
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "object": {
                            "enum": ["card"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "customer_payment_source_card",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).",
                    "x-stripeBypassValidation": true
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The ID of an existing customer that will be charged in this request.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.",
                    "maxLength": 40000,
                    "type": "string"
                  },
                  "destination": {
                    "anyOf": [
                      {
                        "properties": {
                          "account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "amount": {
                            "type": "integer"
                          }
                        },
                        "required": ["account"],
                        "title": "destination_specs",
                        "type": "object"
                      },
                      {
                        "type": "string"
                      }
                    ]
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "on_behalf_of": {
                    "description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "radar_options": {
                    "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
                    "properties": {
                      "session": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "radar_options_with_hidden_options",
                    "type": "object"
                  },
                  "receipt_email": {
                    "description": "The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
                    "type": "string"
                  },
                  "shipping": {
                    "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_address",
                        "type": "object"
                      },
                      "carrier": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tracking_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["address", "name"],
                    "title": "optional_fields_shipping",
                    "type": "object"
                  },
                  "source": {
                    "description": "A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "statement_descriptor": {
                    "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "statement_descriptor_suffix": {
                    "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "destination": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_specs",
                    "type": "object"
                  },
                  "transfer_group": {
                    "description": "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options).",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/charge"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/charges/search": {
      "get": {
        "description": "<p>Search for charges you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetChargesSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/charge"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search charges"
      }
    },
    "/v1/charges/{charge}": {
      "get": {
        "description": "<p>Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.</p>",
        "operationId": "GetChargesCharge",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/charge"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a charge"
      },
      "post": {
        "description": "<p>Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostChargesCharge",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fraud_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "customer": {
                    "description": "The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.",
                    "maxLength": 40000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fraud_details": {
                    "description": "A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.",
                    "properties": {
                      "user_report": {
                        "enum": ["", "fraudulent", "safe"],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["user_report"],
                    "title": "fraud_details",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "receipt_email": {
                    "description": "This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "shipping": {
                    "description": "Shipping information for the charge. Helps prevent fraud on charges for physical goods.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_address",
                        "type": "object"
                      },
                      "carrier": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tracking_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["address", "name"],
                    "title": "optional_fields_shipping",
                    "type": "object"
                  },
                  "transfer_group": {
                    "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/charge"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a charge"
      }
    },
    "/v1/charges/{charge}/capture": {
      "post": {
        "description": "<p>Capture the payment of an existing, uncaptured charge that was created with the <code>capture</code> option set to false.</p>\n\n<p>Uncaptured payments expire a set number of days after they are created (<a href=\"/docs/charges/placing-a-hold\">7 by default</a>), after which they are marked as refunded and capture attempts will fail.</p>\n\n<p>Don’t use this method to capture a PaymentIntent-initiated charge. Use <a href=\"/docs/api/payment_intents/capture\">Capture a PaymentIntent</a>.</p>",
        "operationId": "PostChargesChargeCapture",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.",
                    "type": "integer"
                  },
                  "application_fee": {
                    "description": "An application fee to add on to this charge.",
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "description": "An application fee amount to add on to this charge, which must be less than or equal to the original amount.",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "receipt_email": {
                    "description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.",
                    "type": "string"
                  },
                  "statement_descriptor": {
                    "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "statement_descriptor_suffix": {
                    "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      }
                    },
                    "title": "transfer_data_specs",
                    "type": "object"
                  },
                  "transfer_group": {
                    "description": "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/charge"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Capture a payment"
      }
    },
    "/v1/charges/{charge}/dispute": {
      "get": {
        "description": "<p>Retrieve a dispute for a specified charge.</p>",
        "operationId": "GetChargesChargeDispute",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "post": {
        "description": "",
        "operationId": "PostChargesChargeDispute",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "evidence": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "evidence": {
                    "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.",
                    "properties": {
                      "access_activity_log": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "billing_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "cancellation_policy": {
                        "type": "string"
                      },
                      "cancellation_policy_disclosure": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "cancellation_rebuttal": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "customer_communication": {
                        "type": "string"
                      },
                      "customer_email_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_purchase_ip": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_signature": {
                        "type": "string"
                      },
                      "duplicate_charge_documentation": {
                        "type": "string"
                      },
                      "duplicate_charge_explanation": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "duplicate_charge_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "enhanced_evidence": {
                        "anyOf": [
                          {
                            "properties": {
                              "visa_compelling_evidence_3": {
                                "properties": {
                                  "disputed_transaction": {
                                    "properties": {
                                      "customer_account_id": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_device_fingerprint": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_device_id": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_email_address": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_purchase_ip": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "merchandise_or_services": {
                                        "enum": ["merchandise", "services"],
                                        "type": "string"
                                      },
                                      "product_description": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "shipping_address": {
                                        "properties": {
                                          "city": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "country": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "line1": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "line2": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "postal_code": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "state": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          }
                                        },
                                        "title": "shipping_address",
                                        "type": "object"
                                      }
                                    },
                                    "title": "visa_compelling_evidence3_disputed_transaction",
                                    "type": "object"
                                  },
                                  "prior_undisputed_transactions": {
                                    "items": {
                                      "properties": {
                                        "charge": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "customer_account_id": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_device_fingerprint": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_device_id": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_email_address": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_purchase_ip": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "product_description": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "shipping_address": {
                                          "properties": {
                                            "city": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "country": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "line1": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "line2": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "postal_code": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "state": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            }
                                          },
                                          "title": "shipping_address",
                                          "type": "object"
                                        }
                                      },
                                      "required": ["charge"],
                                      "title": "visa_compelling_evidence3_prior_undisputed_transaction",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "visa_compelling_evidence3",
                                "type": "object"
                              },
                              "visa_compliance": {
                                "properties": {
                                  "fee_acknowledged": {
                                    "type": "boolean"
                                  }
                                },
                                "title": "visa_compliance",
                                "type": "object"
                              }
                            },
                            "title": "enhanced_evidence",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "product_description": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "receipt": {
                        "type": "string"
                      },
                      "refund_policy": {
                        "type": "string"
                      },
                      "refund_policy_disclosure": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "refund_refusal_explanation": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "service_date": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "service_documentation": {
                        "type": "string"
                      },
                      "shipping_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_carrier": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_date": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_documentation": {
                        "type": "string"
                      },
                      "shipping_tracking_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "uncategorized_file": {
                        "type": "string"
                      },
                      "uncategorized_text": {
                        "maxLength": 20000,
                        "type": "string"
                      }
                    },
                    "title": "dispute_evidence_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "submit": {
                    "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/charges/{charge}/dispute/close": {
      "post": {
        "description": "",
        "operationId": "PostChargesChargeDisputeClose",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/charges/{charge}/refund": {
      "post": {
        "description": "<p>When you create a new refund, you must specify either a Charge or a PaymentIntent object.</p>\n\n<p>This action refunds a previously created charge that’s not refunded yet.\nFunds are refunded to the credit or debit card that’s originally charged.</p>\n\n<p>You can optionally refund only part of a charge.\nYou can repeat this until the entire charge is refunded.</p>\n\n<p>After you entirely refund a charge, you can’t refund it again.\nThis method raises an error when it’s called on an already-refunded charge,\nor when you attempt to refund more money than is left on a charge.</p>",
        "operationId": "PostChargesChargeRefund",
        "parameters": [
          {
            "description": "The identifier of the charge to refund.",
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "instructions_email": {
                    "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.",
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "payment_intent": {
                    "description": "The identifier of the PaymentIntent to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "reason": {
                    "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.",
                    "enum": [
                      "duplicate",
                      "fraudulent",
                      "requested_by_customer"
                    ],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "refund_application_fee": {
                    "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
                    "type": "boolean"
                  },
                  "reverse_transfer": {
                    "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/charge"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a refund"
      }
    },
    "/v1/charges/{charge}/refunds": {
      "get": {
        "description": "<p>You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>",
        "operationId": "GetChargesChargeRefunds",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/refund"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "RefundList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all refunds"
      },
      "post": {
        "description": "<p>When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.</p>\n\n<p>Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.</p>\n\n<p>You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.</p>\n\n<p>Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.</p>",
        "operationId": "PostChargesChargeRefunds",
        "parameters": [
          {
            "description": "The identifier of the charge to refund.",
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "Customer whose customer balance to refund from.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "instructions_email": {
                    "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.",
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "origin": {
                    "description": "Origin of the refund",
                    "enum": ["customer_balance"],
                    "type": "string"
                  },
                  "payment_intent": {
                    "description": "The identifier of the PaymentIntent to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "reason": {
                    "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.",
                    "enum": [
                      "duplicate",
                      "fraudulent",
                      "requested_by_customer"
                    ],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "refund_application_fee": {
                    "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
                    "type": "boolean"
                  },
                  "reverse_transfer": {
                    "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create customer balance refund"
      }
    },
    "/v1/charges/{charge}/refunds/{refund}": {
      "get": {
        "description": "<p>Retrieves the details of an existing refund.</p>",
        "operationId": "GetChargesChargeRefundsRefund",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "post": {
        "description": "<p>Update a specified refund.</p>",
        "operationId": "PostChargesChargeRefundsRefund",
        "parameters": [
          {
            "in": "path",
            "name": "charge",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/checkout/sessions": {
      "get": {
        "description": "<p>Returns a list of Checkout Sessions.</p>",
        "operationId": "GetCheckoutSessions",
        "parameters": [
          {
            "description": "Only return Checkout Sessions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return the Checkout Sessions for the Customer specified.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return the Checkout Sessions for the Customer details specified.",
            "explode": true,
            "in": "query",
            "name": "customer_details",
            "required": false,
            "schema": {
              "properties": {
                "email": {
                  "type": "string"
                }
              },
              "required": ["email"],
              "title": "customer_details_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return the Checkout Session for the PaymentIntent specified.",
            "in": "query",
            "name": "payment_intent",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return the Checkout Sessions for the Payment Link specified.",
            "in": "query",
            "name": "payment_link",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return the Checkout Sessions matching the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["complete", "expired", "open"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return the Checkout Session for the subscription specified.",
            "in": "query",
            "name": "subscription",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/checkout.session"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentPagesCheckoutSessionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Checkout Sessions"
      },
      "post": {
        "description": "<p>Creates a Session object.</p>",
        "operationId": "PostCheckoutSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "adaptive_pricing": {
                  "explode": true,
                  "style": "deepObject"
                },
                "after_expiration": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "consent_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_fields": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_text": {
                  "explode": true,
                  "style": "deepObject"
                },
                "customer_update": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_creation": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_intent_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "phone_number_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "saved_payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "setup_intent_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_address_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_id_collection": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "adaptive_pricing": {
                    "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "title": "adaptive_pricing_params",
                    "type": "object"
                  },
                  "after_expiration": {
                    "description": "Configure actions after a Checkout Session has expired.",
                    "properties": {
                      "recovery": {
                        "properties": {
                          "allow_promotion_codes": {
                            "type": "boolean"
                          },
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "recovery_params",
                        "type": "object"
                      }
                    },
                    "title": "after_expiration_params",
                    "type": "object"
                  },
                  "allow_promotion_codes": {
                    "description": "Enables user redeemable promotion codes.",
                    "type": "boolean"
                  },
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_params",
                    "type": "object"
                  },
                  "billing_address_collection": {
                    "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.",
                    "enum": ["auto", "required"],
                    "type": "string"
                  },
                  "cancel_url": {
                    "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "client_reference_id": {
                    "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems.",
                    "maxLength": 200,
                    "type": "string"
                  },
                  "consent_collection": {
                    "description": "Configure fields for the Checkout Session to gather active consent from customers.",
                    "properties": {
                      "payment_method_reuse_agreement": {
                        "properties": {
                          "position": {
                            "enum": ["auto", "hidden"],
                            "type": "string"
                          }
                        },
                        "required": ["position"],
                        "title": "payment_method_reuse_agreement_params",
                        "type": "object"
                      },
                      "promotions": {
                        "enum": ["auto", "none"],
                        "type": "string"
                      },
                      "terms_of_service": {
                        "enum": ["none", "required"],
                        "type": "string"
                      }
                    },
                    "title": "consent_collection_params",
                    "type": "object"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.",
                    "format": "currency",
                    "type": "string"
                  },
                  "custom_fields": {
                    "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.",
                    "items": {
                      "properties": {
                        "dropdown": {
                          "properties": {
                            "default_value": {
                              "maxLength": 100,
                              "type": "string"
                            },
                            "options": {
                              "items": {
                                "properties": {
                                  "label": {
                                    "maxLength": 100,
                                    "type": "string"
                                  },
                                  "value": {
                                    "maxLength": 100,
                                    "type": "string"
                                  }
                                },
                                "required": ["label", "value"],
                                "title": "custom_field_option_param",
                                "type": "object"
                              },
                              "type": "array"
                            }
                          },
                          "required": ["options"],
                          "title": "custom_field_dropdown_param",
                          "type": "object"
                        },
                        "key": {
                          "maxLength": 200,
                          "type": "string"
                        },
                        "label": {
                          "properties": {
                            "custom": {
                              "maxLength": 50,
                              "type": "string"
                            },
                            "type": {
                              "enum": ["custom"],
                              "type": "string"
                            }
                          },
                          "required": ["custom", "type"],
                          "title": "custom_field_label_param",
                          "type": "object"
                        },
                        "numeric": {
                          "properties": {
                            "default_value": {
                              "maxLength": 255,
                              "type": "string"
                            },
                            "maximum_length": {
                              "type": "integer"
                            },
                            "minimum_length": {
                              "type": "integer"
                            }
                          },
                          "title": "custom_field_numeric_param",
                          "type": "object"
                        },
                        "optional": {
                          "type": "boolean"
                        },
                        "text": {
                          "properties": {
                            "default_value": {
                              "maxLength": 255,
                              "type": "string"
                            },
                            "maximum_length": {
                              "type": "integer"
                            },
                            "minimum_length": {
                              "type": "integer"
                            }
                          },
                          "title": "custom_field_text_param",
                          "type": "object"
                        },
                        "type": {
                          "enum": ["dropdown", "numeric", "text"],
                          "type": "string"
                        }
                      },
                      "required": ["key", "label", "type"],
                      "title": "custom_field_param",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "custom_text": {
                    "description": "Display additional text for your customers using custom text.",
                    "properties": {
                      "after_submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "shipping_address": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "terms_of_service_acceptance": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "custom_text_param",
                    "type": "object"
                  },
                  "customer": {
                    "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer_creation": {
                    "description": "Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "customer_email": {
                    "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field.",
                    "type": "string"
                  },
                  "customer_update": {
                    "description": "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.",
                    "properties": {
                      "address": {
                        "enum": ["auto", "never"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "name": {
                        "enum": ["auto", "never"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "shipping": {
                        "enum": ["auto", "never"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "title": "customer_update_params",
                    "type": "object"
                  },
                  "discounts": {
                    "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.",
                    "items": {
                      "properties": {
                        "coupon": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "promotion_code": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "title": "discount_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "invoice_creation": {
                    "description": "Generate a post-purchase Invoice for one-time payments.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "invoice_data": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "custom_fields": {
                            "anyOf": [
                              {
                                "items": {
                                  "properties": {
                                    "name": {
                                      "maxLength": 40,
                                      "type": "string"
                                    },
                                    "value": {
                                      "maxLength": 140,
                                      "type": "string"
                                    }
                                  },
                                  "required": ["name", "value"],
                                  "title": "custom_field_params",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "description": {
                            "maxLength": 1500,
                            "type": "string"
                          },
                          "footer": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "rendering_options": {
                            "anyOf": [
                              {
                                "properties": {
                                  "amount_tax_display": {
                                    "enum": [
                                      "",
                                      "exclude_tax",
                                      "include_inclusive_tax"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "title": "checkout_rendering_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "invoice_data_params",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "invoice_creation_params",
                    "type": "object"
                  },
                  "line_items": {
                    "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nFor `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.",
                    "items": {
                      "properties": {
                        "adjustable_quantity": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "maximum": {
                              "type": "integer"
                            },
                            "minimum": {
                              "type": "integer"
                            }
                          },
                          "required": ["enabled"],
                          "title": "adjustable_quantity_params",
                          "type": "object"
                        },
                        "dynamic_tax_rates": {
                          "items": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "type": "array"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "product_data": {
                              "properties": {
                                "description": {
                                  "maxLength": 40000,
                                  "type": "string"
                                },
                                "images": {
                                  "items": {
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                "metadata": {
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "type": "object"
                                },
                                "name": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "required": ["name"],
                              "title": "product_data",
                              "type": "object"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency"],
                          "title": "price_data_with_product_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "items": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "type": "array"
                        }
                      },
                      "title": "line_item_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "locale": {
                    "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
                    "enum": [
                      "auto",
                      "bg",
                      "cs",
                      "da",
                      "de",
                      "el",
                      "en",
                      "en-GB",
                      "es",
                      "es-419",
                      "et",
                      "fi",
                      "fil",
                      "fr",
                      "fr-CA",
                      "hr",
                      "hu",
                      "id",
                      "it",
                      "ja",
                      "ko",
                      "lt",
                      "lv",
                      "ms",
                      "mt",
                      "nb",
                      "nl",
                      "pl",
                      "pt",
                      "pt-BR",
                      "ro",
                      "ru",
                      "sk",
                      "sl",
                      "sv",
                      "th",
                      "tr",
                      "vi",
                      "zh",
                      "zh-HK",
                      "zh-TW"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "mode": {
                    "description": "The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.",
                    "enum": ["payment", "setup", "subscription"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "payment_intent_data": {
                    "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
                    "properties": {
                      "application_fee_amount": {
                        "type": "integer"
                      },
                      "capture_method": {
                        "enum": ["automatic", "automatic_async", "manual"],
                        "type": "string"
                      },
                      "description": {
                        "maxLength": 1000,
                        "type": "string"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "type": "string"
                      },
                      "receipt_email": {
                        "type": "string"
                      },
                      "setup_future_usage": {
                        "enum": ["off_session", "on_session"],
                        "type": "string"
                      },
                      "shipping": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["line1"],
                            "title": "address",
                            "type": "object"
                          },
                          "carrier": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tracking_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "shipping",
                        "type": "object"
                      },
                      "statement_descriptor": {
                        "maxLength": 22,
                        "type": "string"
                      },
                      "statement_descriptor_suffix": {
                        "maxLength": 22,
                        "type": "string"
                      },
                      "transfer_data": {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_params",
                        "type": "object"
                      },
                      "transfer_group": {
                        "type": "string"
                      }
                    },
                    "title": "payment_intent_data_params",
                    "type": "object"
                  },
                  "payment_method_collection": {
                    "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "payment_method_configuration": {
                    "description": "The ID of the payment method configuration to use with this Checkout session.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.",
                    "properties": {
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      }
                    },
                    "title": "payment_method_data_param",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment-method-specific configuration.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "currency": {
                            "enum": ["cad", "usd"],
                            "type": "string"
                          },
                          "mandate_options": {
                            "properties": {
                              "custom_mandate_url": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "default_for": {
                                "items": {
                                  "enum": ["invoice", "subscription"],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "interval_description": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "payment_schedule": {
                                "enum": ["combined", "interval", "sporadic"],
                                "type": "string"
                              },
                              "transaction_type": {
                                "enum": ["business", "personal"],
                                "type": "string"
                              }
                            },
                            "title": "mandate_options_param",
                            "type": "object"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          },
                          "target_date": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          },
                          "target_date": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          },
                          "target_date": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "expires_after_days": {
                            "type": "integer"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "card": {
                        "properties": {
                          "installments": {
                            "properties": {
                              "enabled": {
                                "type": "boolean"
                              }
                            },
                            "title": "installments_param",
                            "type": "object"
                          },
                          "request_extended_authorization": {
                            "enum": ["if_available", "never"],
                            "type": "string"
                          },
                          "request_incremental_authorization": {
                            "enum": ["if_available", "never"],
                            "type": "string"
                          },
                          "request_multicapture": {
                            "enum": ["if_available", "never"],
                            "type": "string"
                          },
                          "request_overcapture": {
                            "enum": ["if_available", "never"],
                            "type": "string"
                          },
                          "request_three_d_secure": {
                            "enum": ["any", "automatic", "challenge"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "restrictions": {
                            "properties": {
                              "brands_blocked": {
                                "items": {
                                  "enum": [
                                    "american_express",
                                    "discover_global_network",
                                    "mastercard",
                                    "visa"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "title": "restrictions_param",
                            "type": "object"
                          },
                          "setup_future_usage": {
                            "enum": ["off_session", "on_session"],
                            "type": "string"
                          },
                          "statement_descriptor_suffix_kana": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "statement_descriptor_suffix_kanji": {
                            "maxLength": 17,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {
                          "bank_transfer": {
                            "properties": {
                              "eu_bank_transfer": {
                                "properties": {
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["country"],
                                "title": "eu_bank_transfer_params",
                                "type": "object"
                              },
                              "requested_address_types": {
                                "items": {
                                  "enum": [
                                    "aba",
                                    "iban",
                                    "sepa",
                                    "sort_code",
                                    "spei",
                                    "swift",
                                    "zengin"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "type": {
                                "enum": [
                                  "eu_bank_transfer",
                                  "gb_bank_transfer",
                                  "jp_bank_transfer",
                                  "mx_bank_transfer",
                                  "us_bank_transfer"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "required": ["type"],
                            "title": "bank_transfer_param",
                            "type": "object"
                          },
                          "funding_type": {
                            "enum": ["bank_transfer"],
                            "type": "string"
                          },
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {
                          "capture_method": {
                            "enum": ["manual"],
                            "type": "string"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {
                          "expires_after_days": {
                            "type": "integer"
                          },
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {
                          "capture_method": {
                            "enum": ["manual"],
                            "type": "string"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "capture_method": {
                            "enum": ["manual"],
                            "type": "string"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {
                          "expires_after_days": {
                            "type": "integer"
                          },
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          },
                          "tos_shown_and_accepted": {
                            "type": "boolean"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {
                          "capture_method": {
                            "enum": ["manual"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {
                          "capture_method": {
                            "enum": ["", "manual"],
                            "type": "string"
                          },
                          "preferred_locale": {
                            "enum": [
                              "cs-CZ",
                              "da-DK",
                              "de-AT",
                              "de-DE",
                              "de-LU",
                              "el-GR",
                              "en-GB",
                              "en-US",
                              "es-ES",
                              "fi-FI",
                              "fr-BE",
                              "fr-FR",
                              "fr-LU",
                              "hu-HU",
                              "it-IT",
                              "nl-BE",
                              "nl-NL",
                              "pl-PL",
                              "pt-PT",
                              "sk-SK",
                              "sv-SE"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "reference": {
                            "maxLength": 127,
                            "type": "string"
                          },
                          "risk_correlation_id": {
                            "maxLength": 32,
                            "type": "string"
                          },
                          "setup_future_usage": {
                            "enum": ["", "none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {
                          "expires_after_seconds": {
                            "type": "integer"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none", "off_session"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {
                          "capture_method": {
                            "enum": ["manual"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          },
                          "target_date": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {
                          "reference": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "us_bank_account": {
                        "properties": {
                          "financial_connections": {
                            "properties": {
                              "permissions": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "payment_method",
                                    "transactions"
                                  ],
                                  "maxLength": 5000,
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "prefetch": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "transactions"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              }
                            },
                            "title": "linked_account_options_param",
                            "type": "object"
                          },
                          "setup_future_usage": {
                            "enum": ["none", "off_session", "on_session"],
                            "type": "string"
                          },
                          "target_date": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {
                          "app_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "client": {
                            "enum": ["android", "ios", "web"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "setup_future_usage": {
                            "enum": ["none"],
                            "type": "string"
                          }
                        },
                        "required": ["client"],
                        "title": "payment_method_options_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.",
                    "items": {
                      "enum": [
                        "acss_debit",
                        "affirm",
                        "afterpay_clearpay",
                        "alipay",
                        "alma",
                        "amazon_pay",
                        "au_becs_debit",
                        "bacs_debit",
                        "bancontact",
                        "blik",
                        "boleto",
                        "card",
                        "cashapp",
                        "customer_balance",
                        "eps",
                        "fpx",
                        "giropay",
                        "grabpay",
                        "ideal",
                        "kakao_pay",
                        "klarna",
                        "konbini",
                        "kr_card",
                        "link",
                        "mobilepay",
                        "multibanco",
                        "naver_pay",
                        "oxxo",
                        "p24",
                        "pay_by_bank",
                        "payco",
                        "paynow",
                        "paypal",
                        "pix",
                        "promptpay",
                        "revolut_pay",
                        "samsung_pay",
                        "sepa_debit",
                        "sofort",
                        "swish",
                        "twint",
                        "us_bank_account",
                        "wechat_pay",
                        "zip"
                      ],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "phone_number_collection": {
                    "description": "Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers).",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "phone_number_collection_params",
                    "type": "object"
                  },
                  "redirect_on_completion": {
                    "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.",
                    "enum": ["always", "if_required", "never"],
                    "type": "string"
                  },
                  "return_url": {
                    "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if ui_mode is `embedded`\nand redirect-based payment methods are enabled on the session.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "saved_payment_method_options": {
                    "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.",
                    "properties": {
                      "allow_redisplay_filters": {
                        "items": {
                          "enum": ["always", "limited", "unspecified"],
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "payment_method_save": {
                        "enum": ["disabled", "enabled"],
                        "type": "string"
                      }
                    },
                    "title": "saved_payment_method_options_param",
                    "type": "object"
                  },
                  "setup_intent_data": {
                    "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.",
                    "properties": {
                      "description": {
                        "maxLength": 1000,
                        "type": "string"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "type": "string"
                      }
                    },
                    "title": "setup_intent_data_param",
                    "type": "object"
                  },
                  "shipping_address_collection": {
                    "description": "When set, provides configuration for Checkout to collect a shipping address from a customer.",
                    "properties": {
                      "allowed_countries": {
                        "items": {
                          "enum": [
                            "AC",
                            "AD",
                            "AE",
                            "AF",
                            "AG",
                            "AI",
                            "AL",
                            "AM",
                            "AO",
                            "AQ",
                            "AR",
                            "AT",
                            "AU",
                            "AW",
                            "AX",
                            "AZ",
                            "BA",
                            "BB",
                            "BD",
                            "BE",
                            "BF",
                            "BG",
                            "BH",
                            "BI",
                            "BJ",
                            "BL",
                            "BM",
                            "BN",
                            "BO",
                            "BQ",
                            "BR",
                            "BS",
                            "BT",
                            "BV",
                            "BW",
                            "BY",
                            "BZ",
                            "CA",
                            "CD",
                            "CF",
                            "CG",
                            "CH",
                            "CI",
                            "CK",
                            "CL",
                            "CM",
                            "CN",
                            "CO",
                            "CR",
                            "CV",
                            "CW",
                            "CY",
                            "CZ",
                            "DE",
                            "DJ",
                            "DK",
                            "DM",
                            "DO",
                            "DZ",
                            "EC",
                            "EE",
                            "EG",
                            "EH",
                            "ER",
                            "ES",
                            "ET",
                            "FI",
                            "FJ",
                            "FK",
                            "FO",
                            "FR",
                            "GA",
                            "GB",
                            "GD",
                            "GE",
                            "GF",
                            "GG",
                            "GH",
                            "GI",
                            "GL",
                            "GM",
                            "GN",
                            "GP",
                            "GQ",
                            "GR",
                            "GS",
                            "GT",
                            "GU",
                            "GW",
                            "GY",
                            "HK",
                            "HN",
                            "HR",
                            "HT",
                            "HU",
                            "ID",
                            "IE",
                            "IL",
                            "IM",
                            "IN",
                            "IO",
                            "IQ",
                            "IS",
                            "IT",
                            "JE",
                            "JM",
                            "JO",
                            "JP",
                            "KE",
                            "KG",
                            "KH",
                            "KI",
                            "KM",
                            "KN",
                            "KR",
                            "KW",
                            "KY",
                            "KZ",
                            "LA",
                            "LB",
                            "LC",
                            "LI",
                            "LK",
                            "LR",
                            "LS",
                            "LT",
                            "LU",
                            "LV",
                            "LY",
                            "MA",
                            "MC",
                            "MD",
                            "ME",
                            "MF",
                            "MG",
                            "MK",
                            "ML",
                            "MM",
                            "MN",
                            "MO",
                            "MQ",
                            "MR",
                            "MS",
                            "MT",
                            "MU",
                            "MV",
                            "MW",
                            "MX",
                            "MY",
                            "MZ",
                            "NA",
                            "NC",
                            "NE",
                            "NG",
                            "NI",
                            "NL",
                            "NO",
                            "NP",
                            "NR",
                            "NU",
                            "NZ",
                            "OM",
                            "PA",
                            "PE",
                            "PF",
                            "PG",
                            "PH",
                            "PK",
                            "PL",
                            "PM",
                            "PN",
                            "PR",
                            "PS",
                            "PT",
                            "PY",
                            "QA",
                            "RE",
                            "RO",
                            "RS",
                            "RU",
                            "RW",
                            "SA",
                            "SB",
                            "SC",
                            "SD",
                            "SE",
                            "SG",
                            "SH",
                            "SI",
                            "SJ",
                            "SK",
                            "SL",
                            "SM",
                            "SN",
                            "SO",
                            "SR",
                            "SS",
                            "ST",
                            "SV",
                            "SX",
                            "SZ",
                            "TA",
                            "TC",
                            "TD",
                            "TF",
                            "TG",
                            "TH",
                            "TJ",
                            "TK",
                            "TL",
                            "TM",
                            "TN",
                            "TO",
                            "TR",
                            "TT",
                            "TV",
                            "TW",
                            "TZ",
                            "UA",
                            "UG",
                            "US",
                            "UY",
                            "UZ",
                            "VA",
                            "VC",
                            "VE",
                            "VG",
                            "VN",
                            "VU",
                            "WF",
                            "WS",
                            "XK",
                            "YE",
                            "YT",
                            "ZA",
                            "ZM",
                            "ZW",
                            "ZZ"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": ["allowed_countries"],
                    "title": "shipping_address_collection_params",
                    "type": "object"
                  },
                  "shipping_options": {
                    "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.",
                    "items": {
                      "properties": {
                        "shipping_rate": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "shipping_rate_data": {
                          "properties": {
                            "delivery_estimate": {
                              "properties": {
                                "maximum": {
                                  "properties": {
                                    "unit": {
                                      "enum": [
                                        "business_day",
                                        "day",
                                        "hour",
                                        "month",
                                        "week"
                                      ],
                                      "type": "string"
                                    },
                                    "value": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["unit", "value"],
                                  "title": "delivery_estimate_bound",
                                  "type": "object"
                                },
                                "minimum": {
                                  "properties": {
                                    "unit": {
                                      "enum": [
                                        "business_day",
                                        "day",
                                        "hour",
                                        "month",
                                        "week"
                                      ],
                                      "type": "string"
                                    },
                                    "value": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["unit", "value"],
                                  "title": "delivery_estimate_bound",
                                  "type": "object"
                                }
                              },
                              "title": "delivery_estimate",
                              "type": "object"
                            },
                            "display_name": {
                              "maxLength": 100,
                              "type": "string"
                            },
                            "fixed_amount": {
                              "properties": {
                                "amount": {
                                  "type": "integer"
                                },
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "currency_options": {
                                  "additionalProperties": {
                                    "properties": {
                                      "amount": {
                                        "type": "integer"
                                      },
                                      "tax_behavior": {
                                        "enum": [
                                          "exclusive",
                                          "inclusive",
                                          "unspecified"
                                        ],
                                        "type": "string"
                                      }
                                    },
                                    "required": ["amount"],
                                    "title": "currency_option",
                                    "type": "object"
                                  },
                                  "type": "object"
                                }
                              },
                              "required": ["amount", "currency"],
                              "title": "fixed_amount",
                              "type": "object"
                            },
                            "metadata": {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "tax_code": {
                              "type": "string"
                            },
                            "type": {
                              "enum": ["fixed_amount"],
                              "type": "string"
                            }
                          },
                          "required": ["display_name"],
                          "title": "method_params",
                          "type": "object"
                        }
                      },
                      "title": "shipping_option_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "submit_type": {
                    "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.",
                    "enum": ["auto", "book", "donate", "pay", "subscribe"],
                    "type": "string"
                  },
                  "subscription_data": {
                    "description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.",
                    "properties": {
                      "application_fee_percent": {
                        "type": "number"
                      },
                      "billing_cycle_anchor": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "default_tax_rates": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "description": {
                        "maxLength": 500,
                        "type": "string"
                      },
                      "invoice_settings": {
                        "properties": {
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "invoice_settings_params",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "type": "string"
                      },
                      "proration_behavior": {
                        "enum": ["create_prorations", "none"],
                        "type": "string"
                      },
                      "transfer_data": {
                        "properties": {
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      "trial_end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "trial_period_days": {
                        "type": "integer"
                      },
                      "trial_settings": {
                        "properties": {
                          "end_behavior": {
                            "properties": {
                              "missing_payment_method": {
                                "enum": ["cancel", "create_invoice", "pause"],
                                "type": "string"
                              }
                            },
                            "required": ["missing_payment_method"],
                            "title": "end_behavior",
                            "type": "object"
                          }
                        },
                        "required": ["end_behavior"],
                        "title": "trial_settings_config",
                        "type": "object"
                      }
                    },
                    "title": "subscription_data_params",
                    "type": "object"
                  },
                  "success_url": {
                    "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded`. If you’d like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_id_collection": {
                    "description": "Controls tax ID collection during checkout.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "required": {
                        "enum": ["if_supported", "never"],
                        "type": "string"
                      }
                    },
                    "required": ["enabled"],
                    "title": "tax_id_collection_params",
                    "type": "object"
                  },
                  "ui_mode": {
                    "description": "The UI mode of the Session. Defaults to `hosted`.",
                    "enum": ["embedded", "hosted"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/checkout.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Session"
      }
    },
    "/v1/checkout/sessions/{session}": {
      "get": {
        "description": "<p>Retrieves a Session object.</p>",
        "operationId": "GetCheckoutSessionsSession",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 66,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/checkout.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Session"
      },
      "post": {
        "description": "<p>Updates a Session object.</p>",
        "operationId": "PostCheckoutSessionsSession",
        "parameters": [
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "collected_information": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "collected_information": {
                    "description": "Information about the customer collected within the Checkout Session.",
                    "properties": {
                      "shipping_details": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["country", "line1"],
                            "title": "address",
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 255,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "shipping_details_params",
                        "type": "object"
                      }
                    },
                    "title": "collected_information_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/checkout.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a Session"
      }
    },
    "/v1/checkout/sessions/{session}/expire": {
      "post": {
        "description": "<p>A Session can be expired when it is in one of these statuses: <code>open</code> </p>\n\n<p>After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.</p>",
        "operationId": "PostCheckoutSessionsSessionExpire",
        "parameters": [
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/checkout.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Expire a Session"
      }
    },
    "/v1/checkout/sessions/{session}/line_items": {
      "get": {
        "description": "<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetCheckoutSessionsSessionLineItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentPagesCheckoutSessionListLineItems",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Checkout Session's line items"
      }
    },
    "/v1/climate/orders": {
      "get": {
        "description": "<p>Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.</p>",
        "operationId": "GetClimateOrders",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/climate.order"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/climate/orders",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ClimateRemovalsOrdersList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List orders"
      },
      "post": {
        "description": "<p>Creates a Climate order object for a given Climate product. The order will be processed immediately\nafter creation and payment will be deducted your Stripe balance.</p>",
        "operationId": "PostClimateOrders",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "beneficiary": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.",
                    "type": "integer"
                  },
                  "beneficiary": {
                    "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.",
                    "properties": {
                      "public_name": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["public_name"],
                    "title": "beneficiary_params",
                    "type": "object"
                  },
                  "currency": {
                    "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "metric_tons": {
                    "description": "Requested number of tons for the order. Either this or `amount` must be specified.",
                    "format": "decimal",
                    "type": "string"
                  },
                  "product": {
                    "description": "Unique identifier of the Climate product.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["product"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.order"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an order"
      }
    },
    "/v1/climate/orders/{order}": {
      "get": {
        "description": "<p>Retrieves the details of a Climate order object with the given ID.</p>",
        "operationId": "GetClimateOrdersOrder",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Unique identifier of the order.",
            "in": "path",
            "name": "order",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.order"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an order"
      },
      "post": {
        "description": "<p>Updates the specified order by setting the values of the parameters passed.</p>",
        "operationId": "PostClimateOrdersOrder",
        "parameters": [
          {
            "description": "Unique identifier of the order.",
            "in": "path",
            "name": "order",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "beneficiary": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "beneficiary": {
                    "anyOf": [
                      {
                        "properties": {
                          "public_name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "required": ["public_name"],
                        "title": "beneficiary_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.order"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an order"
      }
    },
    "/v1/climate/orders/{order}/cancel": {
      "post": {
        "description": "<p>Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation <code>amount_subtotal</code>, but not the <code>amount_fees</code> for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the <code>amount_total</code>.</p>",
        "operationId": "PostClimateOrdersOrderCancel",
        "parameters": [
          {
            "description": "Unique identifier of the order.",
            "in": "path",
            "name": "order",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.order"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel an order"
      }
    },
    "/v1/climate/products": {
      "get": {
        "description": "<p>Lists all available Climate product objects.</p>",
        "operationId": "GetClimateProducts",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/climate.product"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/climate/products",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ClimateRemovalsProductsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List products"
      }
    },
    "/v1/climate/products/{product}": {
      "get": {
        "description": "<p>Retrieves the details of a Climate product with the given ID.</p>",
        "operationId": "GetClimateProductsProduct",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "product",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.product"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a product"
      }
    },
    "/v1/climate/suppliers": {
      "get": {
        "description": "<p>Lists all available Climate supplier objects.</p>",
        "operationId": "GetClimateSuppliers",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/climate.supplier"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/climate/suppliers",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ClimateRemovalsSuppliersList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List suppliers"
      }
    },
    "/v1/climate/suppliers/{supplier}": {
      "get": {
        "description": "<p>Retrieves a Climate supplier object.</p>",
        "operationId": "GetClimateSuppliersSupplier",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "supplier",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/climate.supplier"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a supplier"
      }
    },
    "/v1/confirmation_tokens/{confirmation_token}": {
      "get": {
        "description": "<p>Retrieves an existing ConfirmationToken object</p>",
        "operationId": "GetConfirmationTokensConfirmationToken",
        "parameters": [
          {
            "in": "path",
            "name": "confirmation_token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/confirmation_token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a ConfirmationToken"
      }
    },
    "/v1/country_specs": {
      "get": {
        "description": "<p>Lists all Country Spec objects available in the API.</p>",
        "operationId": "GetCountrySpecs",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/country_spec"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/country_specs",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CountrySpecList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Country Specs"
      }
    },
    "/v1/country_specs/{country}": {
      "get": {
        "description": "<p>Returns a Country Spec for a given Country code.</p>",
        "operationId": "GetCountrySpecsCountry",
        "parameters": [
          {
            "in": "path",
            "name": "country",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/country_spec"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Country Spec"
      }
    },
    "/v1/coupons": {
      "get": {
        "description": "<p>Returns a list of your coupons.</p>",
        "operationId": "GetCoupons",
        "parameters": [
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/coupon"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/coupons",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CouponsResourceCouponList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all coupons"
      },
      "post": {
        "description": "<p>You can create coupons easily via the <a href=\"https://dashboard.stripe.com/coupons\">coupon management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.</p>\n\n<p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.</p>",
        "operationId": "PostCoupons",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "applies_to": {
                  "explode": true,
                  "style": "deepObject"
                },
                "currency_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount_off": {
                    "description": "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).",
                    "type": "integer"
                  },
                  "applies_to": {
                    "description": "A hash containing directions for what this Coupon will apply discounts to.",
                    "properties": {
                      "products": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "title": "applies_to_params",
                    "type": "object"
                  },
                  "currency": {
                    "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).",
                    "format": "currency",
                    "type": "string"
                  },
                  "currency_options": {
                    "additionalProperties": {
                      "properties": {
                        "amount_off": {
                          "type": "integer"
                        }
                      },
                      "required": ["amount_off"],
                      "title": "currency_option",
                      "type": "object"
                    },
                    "description": "Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
                    "type": "object"
                  },
                  "duration": {
                    "description": "Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.",
                    "enum": ["forever", "once", "repeating"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "duration_in_months": {
                    "description": "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "id": {
                    "description": "Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "max_redemptions": {
                    "description": "A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.",
                    "type": "integer"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.",
                    "maxLength": 40,
                    "type": "string"
                  },
                  "percent_off": {
                    "description": "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).",
                    "type": "number"
                  },
                  "redeem_by": {
                    "description": "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/coupon"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a coupon"
      }
    },
    "/v1/coupons/{coupon}": {
      "delete": {
        "description": "<p>You can delete coupons via the <a href=\"https://dashboard.stripe.com/coupons\">coupon management</a> page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.</p>",
        "operationId": "DeleteCouponsCoupon",
        "parameters": [
          {
            "in": "path",
            "name": "coupon",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_coupon"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a coupon"
      },
      "get": {
        "description": "<p>Retrieves the coupon with the given ID.</p>",
        "operationId": "GetCouponsCoupon",
        "parameters": [
          {
            "in": "path",
            "name": "coupon",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/coupon"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a coupon"
      },
      "post": {
        "description": "<p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p>",
        "operationId": "PostCouponsCoupon",
        "parameters": [
          {
            "in": "path",
            "name": "coupon",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "currency_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "currency_options": {
                    "additionalProperties": {
                      "properties": {
                        "amount_off": {
                          "type": "integer"
                        }
                      },
                      "required": ["amount_off"],
                      "title": "currency_option",
                      "type": "object"
                    },
                    "description": "Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.",
                    "maxLength": 40,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/coupon"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a coupon"
      }
    },
    "/v1/credit_notes": {
      "get": {
        "description": "<p>Returns a list of credit notes.</p>",
        "operationId": "GetCreditNotes",
        "parameters": [
          {
            "description": "Only return credit notes that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return credit notes for the customer specified by this customer ID.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return credit notes for the invoice specified by this invoice ID.",
            "in": "query",
            "name": "invoice",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/credit_note"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CreditNotesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all credit notes"
      },
      "post": {
        "description": "<p>Issue a credit note to adjust the amount of a finalized invoice. For a <code>status=open</code> invoice, a credit note reduces\nits <code>amount_due</code>. For a <code>status=paid</code> invoice, a credit note does not affect its <code>amount_due</code>. Instead, it can result\nin any combination of the following:</p>\n\n<ul>\n<li>Refund: create a new refund (using <code>refund_amount</code>) or link an existing refund (using <code>refund</code>).</li>\n<li>Customer balance credit: credit the customer’s balance (using <code>credit_amount</code>) which will be automatically applied to their next invoice when it’s finalized.</li>\n<li>Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using <code>out_of_band_amount</code>).</li>\n</ul>\n\n<p>For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.</p>\n\n<p>You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s <code>pre_payment_credit_notes_amount</code>\nor <code>post_payment_credit_notes_amount</code> depending on its <code>status</code> at the time of credit note creation.</p>",
        "operationId": "PostCreditNotes",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "lines": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_cost": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note.",
                    "type": "integer"
                  },
                  "credit_amount": {
                    "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.",
                    "type": "integer"
                  },
                  "effective_at": {
                    "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "email_type": {
                    "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.",
                    "enum": ["credit_note", "none"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice": {
                    "description": "ID of the invoice.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "lines": {
                    "description": "Line items that make up the credit note.",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "description": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "invoice_line_item": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_amounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "tax_rate": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "taxable_amount": {
                                    "type": "integer"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "tax_rate",
                                  "taxable_amount"
                                ],
                                "title": "tax_amount_with_tax_rate_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "type": {
                          "enum": ["custom_line_item", "invoice_line_item"],
                          "type": "string"
                        },
                        "unit_amount": {
                          "type": "integer"
                        },
                        "unit_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        }
                      },
                      "required": ["type"],
                      "title": "credit_note_line_item_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "memo": {
                    "description": "The credit note's memo appears on the credit note PDF.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "out_of_band_amount": {
                    "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.",
                    "type": "integer"
                  },
                  "reason": {
                    "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`",
                    "enum": [
                      "duplicate",
                      "fraudulent",
                      "order_change",
                      "product_unsatisfactory"
                    ],
                    "type": "string"
                  },
                  "refund": {
                    "description": "ID of an existing refund to link this credit note to.",
                    "type": "string"
                  },
                  "refund_amount": {
                    "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.",
                    "type": "integer"
                  },
                  "shipping_cost": {
                    "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.",
                    "properties": {
                      "shipping_rate": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "credit_note_shipping_cost",
                    "type": "object"
                  }
                },
                "required": ["invoice"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credit_note"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a credit note"
      }
    },
    "/v1/credit_notes/preview": {
      "get": {
        "description": "<p>Get a preview of a credit note without creating it.</p>",
        "operationId": "GetCreditNotesPreview",
        "parameters": [
          {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note.",
            "in": "query",
            "name": "amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.",
            "in": "query",
            "name": "credit_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.",
            "in": "query",
            "name": "effective_at",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.",
            "in": "query",
            "name": "email_type",
            "required": false,
            "schema": {
              "enum": ["credit_note", "none"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "ID of the invoice.",
            "in": "query",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Line items that make up the credit note.",
            "explode": true,
            "in": "query",
            "name": "lines",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "description": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "invoice_line_item": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_amounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "tax_rate": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "taxable_amount": {
                              "type": "integer"
                            }
                          },
                          "required": ["amount", "tax_rate", "taxable_amount"],
                          "title": "tax_amount_with_tax_rate_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "type": {
                    "enum": ["custom_line_item", "invoice_line_item"],
                    "type": "string"
                  },
                  "unit_amount": {
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "required": ["type"],
                "title": "credit_note_line_item_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The credit note's memo appears on the credit note PDF.",
            "in": "query",
            "name": "memo",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
            "explode": true,
            "in": "query",
            "name": "metadata",
            "required": false,
            "schema": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.",
            "in": "query",
            "name": "out_of_band_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`",
            "in": "query",
            "name": "reason",
            "required": false,
            "schema": {
              "enum": [
                "duplicate",
                "fraudulent",
                "order_change",
                "product_unsatisfactory"
              ],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "ID of an existing refund to link this credit note to.",
            "in": "query",
            "name": "refund",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.",
            "in": "query",
            "name": "refund_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.",
            "explode": true,
            "in": "query",
            "name": "shipping_cost",
            "required": false,
            "schema": {
              "properties": {
                "shipping_rate": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "title": "credit_note_shipping_cost",
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credit_note"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Preview a credit note"
      }
    },
    "/v1/credit_notes/preview/lines": {
      "get": {
        "description": "<p>When retrieving a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetCreditNotesPreviewLines",
        "parameters": [
          {
            "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note.",
            "in": "query",
            "name": "amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.",
            "in": "query",
            "name": "credit_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.",
            "in": "query",
            "name": "effective_at",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.",
            "in": "query",
            "name": "email_type",
            "required": false,
            "schema": {
              "enum": ["credit_note", "none"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "ID of the invoice.",
            "in": "query",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Line items that make up the credit note.",
            "explode": true,
            "in": "query",
            "name": "lines",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "description": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "invoice_line_item": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_amounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "tax_rate": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "taxable_amount": {
                              "type": "integer"
                            }
                          },
                          "required": ["amount", "tax_rate", "taxable_amount"],
                          "title": "tax_amount_with_tax_rate_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "type": {
                    "enum": ["custom_line_item", "invoice_line_item"],
                    "type": "string"
                  },
                  "unit_amount": {
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "required": ["type"],
                "title": "credit_note_line_item_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The credit note's memo appears on the credit note PDF.",
            "in": "query",
            "name": "memo",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
            "explode": true,
            "in": "query",
            "name": "metadata",
            "required": false,
            "schema": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.",
            "in": "query",
            "name": "out_of_band_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`",
            "in": "query",
            "name": "reason",
            "required": false,
            "schema": {
              "enum": [
                "duplicate",
                "fraudulent",
                "order_change",
                "product_unsatisfactory"
              ],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "ID of an existing refund to link this credit note to.",
            "in": "query",
            "name": "refund",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.",
            "in": "query",
            "name": "refund_amount",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.",
            "explode": true,
            "in": "query",
            "name": "shipping_cost",
            "required": false,
            "schema": {
              "properties": {
                "shipping_rate": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "title": "credit_note_shipping_cost",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/credit_note_line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CreditNoteLinesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a credit note preview's line items"
      }
    },
    "/v1/credit_notes/{credit_note}/lines": {
      "get": {
        "description": "<p>When retrieving a credit note, you’ll get a <strong>lines</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetCreditNotesCreditNoteLines",
        "parameters": [
          {
            "in": "path",
            "name": "credit_note",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/credit_note_line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CreditNoteLinesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a credit note's line items"
      }
    },
    "/v1/credit_notes/{id}": {
      "get": {
        "description": "<p>Retrieves the credit note object with the given identifier.</p>",
        "operationId": "GetCreditNotesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credit_note"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a credit note"
      },
      "post": {
        "description": "<p>Updates an existing credit note.</p>",
        "operationId": "PostCreditNotesId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "memo": {
                    "description": "Credit note memo.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credit_note"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a credit note"
      }
    },
    "/v1/credit_notes/{id}/void": {
      "post": {
        "description": "<p>Marks a credit note as void. Learn more about <a href=\"/docs/billing/invoices/credit-notes#voiding\">voiding credit notes</a>.</p>",
        "operationId": "PostCreditNotesIdVoid",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/credit_note"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Void a credit note"
      }
    },
    "/v1/customer_sessions": {
      "post": {
        "description": "<p>Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.</p>",
        "operationId": "PostCustomerSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "components": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "components": {
                    "description": "Configuration for each component. Exactly 1 component must be enabled.",
                    "properties": {
                      "buy_button": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "buy_button_param",
                        "type": "object"
                      },
                      "payment_element": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "features": {
                            "properties": {
                              "payment_method_allow_redisplay_filters": {
                                "items": {
                                  "enum": ["always", "limited", "unspecified"],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "payment_method_redisplay": {
                                "enum": ["disabled", "enabled"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "payment_method_redisplay_limit": {
                                "type": "integer"
                              },
                              "payment_method_remove": {
                                "enum": ["disabled", "enabled"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "payment_method_save": {
                                "enum": ["disabled", "enabled"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "payment_method_save_usage": {
                                "enum": ["off_session", "on_session"],
                                "type": "string"
                              }
                            },
                            "title": "features_param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "payment_element_param",
                        "type": "object"
                      },
                      "pricing_table": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "pricing_table_param",
                        "type": "object"
                      }
                    },
                    "title": "components",
                    "type": "object"
                  },
                  "customer": {
                    "description": "The ID of an existing customer for which to create the Customer Session.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["components", "customer"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Customer Session"
      }
    },
    "/v1/customers": {
      "get": {
        "description": "<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>",
        "operationId": "GetCustomers",
        "parameters": [
          {
            "description": "Only return customers that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.",
            "in": "query",
            "name": "email",
            "required": false,
            "schema": {
              "maxLength": 512,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.",
            "in": "query",
            "name": "test_clock",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/customer"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/customers",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CustomerResourceCustomerList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all customers"
      },
      "post": {
        "description": "<p>Creates a new customer object.</p>",
        "operationId": "PostCustomers",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cash_balance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferred_locales": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_id_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "address": {
                    "anyOf": [
                      {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_customer_address",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The customer's address."
                  },
                  "balance": {
                    "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.",
                    "type": "integer"
                  },
                  "cash_balance": {
                    "description": "Balance information and default balance settings for this customer.",
                    "properties": {
                      "settings": {
                        "properties": {
                          "reconciliation_mode": {
                            "enum": ["automatic", "manual", "merchant_default"],
                            "type": "string"
                          }
                        },
                        "title": "balance_settings_param",
                        "type": "object"
                      }
                    },
                    "title": "cash_balance_param",
                    "type": "object"
                  },
                  "coupon": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "email": {
                    "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.",
                    "maxLength": 512,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_prefix": {
                    "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "invoice_settings": {
                    "description": "Default invoice settings for this customer.",
                    "properties": {
                      "custom_fields": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "name": {
                                  "maxLength": 40,
                                  "type": "string"
                                },
                                "value": {
                                  "maxLength": 140,
                                  "type": "string"
                                }
                              },
                              "required": ["name", "value"],
                              "title": "custom_field_params",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "footer": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "rendering_options": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_tax_display": {
                                "enum": [
                                  "",
                                  "exclude_tax",
                                  "include_inclusive_tax"
                                ],
                                "type": "string"
                              },
                              "template": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "customer_rendering_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "customer_param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "The customer's full name or business name.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "next_invoice_sequence": {
                    "description": "The sequence to be used on the customer's next invoice. Defaults to 1.",
                    "type": "integer"
                  },
                  "payment_method": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "phone": {
                    "description": "The customer's phone number.",
                    "maxLength": 20,
                    "type": "string"
                  },
                  "preferred_locales": {
                    "description": "Customer's preferred languages, ordered by preference.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "promotion_code": {
                    "description": "The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "shipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_customer_address",
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "customer_shipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The customer's shipping information. Appears on invoices emailed to this customer."
                  },
                  "source": {
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "tax": {
                    "description": "Tax details about the customer.",
                    "properties": {
                      "ip_address": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "validate_location": {
                        "enum": ["deferred", "immediately"],
                        "type": "string"
                      }
                    },
                    "title": "shared_tax_create_param",
                    "type": "object"
                  },
                  "tax_exempt": {
                    "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
                    "enum": ["", "exempt", "none", "reverse"],
                    "type": "string"
                  },
                  "tax_id_data": {
                    "description": "The customer's tax IDs.",
                    "items": {
                      "properties": {
                        "type": {
                          "enum": [
                            "ad_nrt",
                            "ae_trn",
                            "al_tin",
                            "am_tin",
                            "ao_tin",
                            "ar_cuit",
                            "au_abn",
                            "au_arn",
                            "ba_tin",
                            "bb_tin",
                            "bg_uic",
                            "bh_vat",
                            "bo_tin",
                            "br_cnpj",
                            "br_cpf",
                            "bs_tin",
                            "by_tin",
                            "ca_bn",
                            "ca_gst_hst",
                            "ca_pst_bc",
                            "ca_pst_mb",
                            "ca_pst_sk",
                            "ca_qst",
                            "cd_nif",
                            "ch_uid",
                            "ch_vat",
                            "cl_tin",
                            "cn_tin",
                            "co_nit",
                            "cr_tin",
                            "de_stn",
                            "do_rcn",
                            "ec_ruc",
                            "eg_tin",
                            "es_cif",
                            "eu_oss_vat",
                            "eu_vat",
                            "gb_vat",
                            "ge_vat",
                            "gn_nif",
                            "hk_br",
                            "hr_oib",
                            "hu_tin",
                            "id_npwp",
                            "il_vat",
                            "in_gst",
                            "is_vat",
                            "jp_cn",
                            "jp_rn",
                            "jp_trn",
                            "ke_pin",
                            "kh_tin",
                            "kr_brn",
                            "kz_bin",
                            "li_uid",
                            "li_vat",
                            "ma_vat",
                            "md_vat",
                            "me_pib",
                            "mk_vat",
                            "mr_nif",
                            "mx_rfc",
                            "my_frp",
                            "my_itn",
                            "my_sst",
                            "ng_tin",
                            "no_vat",
                            "no_voec",
                            "np_pan",
                            "nz_gst",
                            "om_vat",
                            "pe_ruc",
                            "ph_tin",
                            "ro_tin",
                            "rs_pib",
                            "ru_inn",
                            "ru_kpp",
                            "sa_vat",
                            "sg_gst",
                            "sg_uen",
                            "si_tin",
                            "sn_ninea",
                            "sr_fin",
                            "sv_nit",
                            "th_vat",
                            "tj_tin",
                            "tr_tin",
                            "tw_vat",
                            "tz_vat",
                            "ua_vat",
                            "ug_tin",
                            "us_ein",
                            "uy_ruc",
                            "uz_tin",
                            "uz_vat",
                            "ve_rif",
                            "vn_tin",
                            "za_vat",
                            "zm_tin",
                            "zw_tin"
                          ],
                          "maxLength": 5000,
                          "type": "string",
                          "x-stripeBypassValidation": true
                        },
                        "value": {
                          "type": "string"
                        }
                      },
                      "required": ["type", "value"],
                      "title": "data_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "test_clock": {
                    "description": "ID of the test clock to attach to the customer.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a customer"
      }
    },
    "/v1/customers/search": {
      "get": {
        "description": "<p>Search for customers you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetCustomersSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/customer"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search customers"
      }
    },
    "/v1/customers/{customer}": {
      "delete": {
        "description": "<p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.</p>",
        "operationId": "DeleteCustomersCustomer",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_customer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer"
      },
      "get": {
        "description": "<p>Retrieves a Customer object.</p>",
        "operationId": "GetCustomersCustomer",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/customer"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_customer"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a customer"
      },
      "post": {
        "description": "<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the <strong>source</strong> parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the <strong>default_source</strong> for a customer will not trigger this behavior.</p>\n\n<p>This request accepts mostly the same arguments as the customer creation call.</p>",
        "operationId": "PostCustomersCustomer",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cash_balance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferred_locales": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "address": {
                    "anyOf": [
                      {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_customer_address",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The customer's address."
                  },
                  "balance": {
                    "description": "An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.",
                    "type": "integer"
                  },
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "customer_payment_source_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "object": {
                            "enum": ["card"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "customer_payment_source_card",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).",
                    "x-stripeBypassValidation": true
                  },
                  "cash_balance": {
                    "description": "Balance information and default balance settings for this customer.",
                    "properties": {
                      "settings": {
                        "properties": {
                          "reconciliation_mode": {
                            "enum": ["automatic", "manual", "merchant_default"],
                            "type": "string"
                          }
                        },
                        "title": "balance_settings_param",
                        "type": "object"
                      }
                    },
                    "title": "cash_balance_param",
                    "type": "object"
                  },
                  "coupon": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_alipay_account": {
                    "description": "ID of Alipay account to make the customer's new default for invoice payments.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "default_bank_account": {
                    "description": "ID of bank account to make the customer's new default for invoice payments.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "default_card": {
                    "description": "ID of card to make the customer's new default for invoice payments.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "default_source": {
                    "description": "If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.\n\nProvide the ID of a payment source already attached to this customer to make it this customer's default payment source.\n\nIf you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "email": {
                    "description": "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.",
                    "maxLength": 512,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_prefix": {
                    "description": "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "invoice_settings": {
                    "description": "Default invoice settings for this customer.",
                    "properties": {
                      "custom_fields": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "name": {
                                  "maxLength": 40,
                                  "type": "string"
                                },
                                "value": {
                                  "maxLength": 140,
                                  "type": "string"
                                }
                              },
                              "required": ["name", "value"],
                              "title": "custom_field_params",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "footer": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "rendering_options": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_tax_display": {
                                "enum": [
                                  "",
                                  "exclude_tax",
                                  "include_inclusive_tax"
                                ],
                                "type": "string"
                              },
                              "template": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "customer_rendering_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "customer_param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "The customer's full name or business name.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "next_invoice_sequence": {
                    "description": "The sequence to be used on the customer's next invoice. Defaults to 1.",
                    "type": "integer"
                  },
                  "phone": {
                    "description": "The customer's phone number.",
                    "maxLength": 20,
                    "type": "string"
                  },
                  "preferred_locales": {
                    "description": "Customer's preferred languages, ordered by preference.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "promotion_code": {
                    "description": "The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "shipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_customer_address",
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "customer_shipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The customer's shipping information. Appears on invoices emailed to this customer."
                  },
                  "source": {
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "tax": {
                    "description": "Tax details about the customer.",
                    "properties": {
                      "ip_address": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "validate_location": {
                        "enum": ["auto", "deferred", "immediately"],
                        "type": "string"
                      }
                    },
                    "title": "shared_tax_update_param",
                    "type": "object"
                  },
                  "tax_exempt": {
                    "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.",
                    "enum": ["", "exempt", "none", "reverse"],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a customer"
      }
    },
    "/v1/customers/{customer}/balance_transactions": {
      "get": {
        "description": "<p>Returns a list of transactions that updated the customer’s <a href=\"/docs/billing/customer/balance\">balances</a>.</p>",
        "operationId": "GetCustomersCustomerBalanceTransactions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/customer_balance_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CustomerBalanceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List customer balance transactions"
      },
      "post": {
        "description": "<p>Creates an immutable transaction that updates the customer’s credit <a href=\"/docs/billing/customer/balance\">balance</a>.</p>",
        "operationId": "PostCustomersCustomerBalanceTransactions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value.",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 350,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "required": ["amount", "currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a customer balance transaction"
      }
    },
    "/v1/customers/{customer}/balance_transactions/{transaction}": {
      "get": {
        "description": "<p>Retrieves a specific customer balance transaction that updated the customer’s <a href=\"/docs/billing/customer/balance\">balances</a>.</p>",
        "operationId": "GetCustomersCustomerBalanceTransactionsTransaction",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a customer balance transaction"
      },
      "post": {
        "description": "<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p>",
        "operationId": "PostCustomersCustomerBalanceTransactionsTransaction",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 350,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a customer credit balance transaction"
      }
    },
    "/v1/customers/{customer}/bank_accounts": {
      "get": {
        "deprecated": true,
        "description": "<p>You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional bank accounts.</p>",
        "operationId": "GetCustomersCustomerBankAccounts",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/bank_account"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankAccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all bank accounts"
      },
      "post": {
        "description": "<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>\n\n<p>If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should <a href=\"/docs/api#update_customer\">update the customer</a> to have a new <code>default_source</code>.</p>",
        "operationId": "PostCustomersCustomerBankAccounts",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alipay_account": {
                    "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "customer_payment_source_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "object": {
                            "enum": ["card"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "customer_payment_source_card",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "source": {
                    "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a card"
      }
    },
    "/v1/customers/{customer}/bank_accounts/{id}": {
      "delete": {
        "description": "<p>Delete a specified source for a given customer.</p>",
        "operationId": "DeleteCustomersCustomerBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/payment_source"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_payment_source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer source"
      },
      "get": {
        "deprecated": true,
        "description": "<p>By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.</p>",
        "operationId": "GetCustomersCustomerBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/bank_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a bank account"
      },
      "post": {
        "description": "<p>Update a specified source for a given customer.</p>",
        "operationId": "PostCustomersCustomerBankAccountsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder_name": {
                    "description": "The name of the person or business that owns the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_holder_type": {
                    "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
                    "enum": ["company", "individual"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_city": {
                    "description": "City/District/Suburb/Town/Village.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_country": {
                    "description": "Billing address country, if provided when creating card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line1": {
                    "description": "Address line 1 (Street address/PO Box/Company name).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line2": {
                    "description": "Address line 2 (Apartment/Suite/Unit/Building).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_state": {
                    "description": "State/County/Province/Region.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_zip": {
                    "description": "ZIP or postal code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_month": {
                    "description": "Two digit number representing the card’s expiration month.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_year": {
                    "description": "Four digit number representing the card’s expiration year.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Cardholder name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "owner": {
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "source_address",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "owner",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/card"
                    },
                    {
                      "$ref": "#/components/schemas/bank_account"
                    },
                    {
                      "$ref": "#/components/schemas/source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/customers/{customer}/bank_accounts/{id}/verify": {
      "post": {
        "description": "<p>Verify a specified bank account for a given customer.</p>",
        "operationId": "PostCustomersCustomerBankAccountsIdVerify",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amounts": {
                    "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.",
                    "items": {
                      "type": "integer"
                    },
                    "type": "array"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/bank_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Verify a bank account"
      }
    },
    "/v1/customers/{customer}/cards": {
      "get": {
        "deprecated": true,
        "description": "<p>You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the <code>Customer</code> object.\nIf you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional cards.</p>",
        "operationId": "GetCustomersCustomerCards",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/card"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CardList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all cards"
      },
      "post": {
        "description": "<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>\n\n<p>If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should <a href=\"/docs/api#update_customer\">update the customer</a> to have a new <code>default_source</code>.</p>",
        "operationId": "PostCustomersCustomerCards",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alipay_account": {
                    "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "customer_payment_source_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "object": {
                            "enum": ["card"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "customer_payment_source_card",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "source": {
                    "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a card"
      }
    },
    "/v1/customers/{customer}/cards/{id}": {
      "delete": {
        "description": "<p>Delete a specified source for a given customer.</p>",
        "operationId": "DeleteCustomersCustomerCardsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/payment_source"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_payment_source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer source"
      },
      "get": {
        "deprecated": true,
        "description": "<p>You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.</p>",
        "operationId": "GetCustomersCustomerCardsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a card"
      },
      "post": {
        "description": "<p>Update a specified source for a given customer.</p>",
        "operationId": "PostCustomersCustomerCardsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder_name": {
                    "description": "The name of the person or business that owns the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_holder_type": {
                    "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
                    "enum": ["company", "individual"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_city": {
                    "description": "City/District/Suburb/Town/Village.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_country": {
                    "description": "Billing address country, if provided when creating card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line1": {
                    "description": "Address line 1 (Street address/PO Box/Company name).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line2": {
                    "description": "Address line 2 (Apartment/Suite/Unit/Building).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_state": {
                    "description": "State/County/Province/Region.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_zip": {
                    "description": "ZIP or postal code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_month": {
                    "description": "Two digit number representing the card’s expiration month.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_year": {
                    "description": "Four digit number representing the card’s expiration year.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Cardholder name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "owner": {
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "source_address",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "owner",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/card"
                    },
                    {
                      "$ref": "#/components/schemas/bank_account"
                    },
                    {
                      "$ref": "#/components/schemas/source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/customers/{customer}/cash_balance": {
      "get": {
        "description": "<p>Retrieves a customer’s cash balance.</p>",
        "operationId": "GetCustomersCustomerCashBalance",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/cash_balance"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a cash balance"
      },
      "post": {
        "description": "<p>Changes the settings on a customer’s cash balance.</p>",
        "operationId": "PostCustomersCustomerCashBalance",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "settings": {
                    "description": "A hash of settings for this cash balance.",
                    "properties": {
                      "reconciliation_mode": {
                        "enum": ["automatic", "manual", "merchant_default"],
                        "type": "string"
                      }
                    },
                    "title": "balance_settings_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/cash_balance"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a cash balance's settings"
      }
    },
    "/v1/customers/{customer}/cash_balance_transactions": {
      "get": {
        "description": "<p>Returns a list of transactions that modified the customer’s <a href=\"/docs/payments/customer-balance\">cash balance</a>.</p>",
        "operationId": "GetCustomersCustomerCashBalanceTransactions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/customer_cash_balance_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CustomerCashBalanceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List cash balance transactions"
      }
    },
    "/v1/customers/{customer}/cash_balance_transactions/{transaction}": {
      "get": {
        "description": "<p>Retrieves a specific cash balance transaction, which updated the customer’s <a href=\"/docs/payments/customer-balance\">cash balance</a>.</p>",
        "operationId": "GetCustomersCustomerCashBalanceTransactionsTransaction",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_cash_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a cash balance transaction"
      }
    },
    "/v1/customers/{customer}/discount": {
      "delete": {
        "description": "<p>Removes the currently applied discount on a customer.</p>",
        "operationId": "DeleteCustomersCustomerDiscount",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer discount"
      },
      "get": {
        "description": "",
        "operationId": "GetCustomersCustomerDiscount",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/discount"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/customers/{customer}/funding_instructions": {
      "post": {
        "description": "<p>Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.</p>",
        "operationId": "PostCustomersCustomerFundingInstructions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_transfer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bank_transfer": {
                    "description": "Additional parameters for `bank_transfer` funding types",
                    "properties": {
                      "eu_bank_transfer": {
                        "properties": {
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "eu_bank_account_params",
                        "type": "object"
                      },
                      "requested_address_types": {
                        "items": {
                          "enum": ["iban", "sort_code", "spei", "zengin"],
                          "type": "string",
                          "x-stripeBypassValidation": true
                        },
                        "type": "array"
                      },
                      "type": {
                        "enum": [
                          "eu_bank_transfer",
                          "gb_bank_transfer",
                          "jp_bank_transfer",
                          "mx_bank_transfer",
                          "us_bank_transfer"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "required": ["type"],
                    "title": "bank_transfer_params",
                    "type": "object"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "funding_type": {
                    "description": "The `funding_type` to get the instructions for.",
                    "enum": ["bank_transfer"],
                    "type": "string"
                  }
                },
                "required": ["bank_transfer", "currency", "funding_type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/funding_instructions"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create or retrieve funding instructions for a customer cash balance"
      }
    },
    "/v1/customers/{customer}/payment_methods": {
      "get": {
        "description": "<p>Returns a list of PaymentMethods for a given Customer</p>",
        "operationId": "GetCustomersCustomerPaymentMethods",
        "parameters": [
          {
            "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.",
            "in": "query",
            "name": "allow_redisplay",
            "required": false,
            "schema": {
              "enum": ["always", "limited", "unspecified"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": [
                "acss_debit",
                "affirm",
                "afterpay_clearpay",
                "alipay",
                "alma",
                "amazon_pay",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "blik",
                "boleto",
                "card",
                "cashapp",
                "customer_balance",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "kakao_pay",
                "klarna",
                "konbini",
                "kr_card",
                "link",
                "mobilepay",
                "multibanco",
                "naver_pay",
                "oxxo",
                "p24",
                "pay_by_bank",
                "payco",
                "paynow",
                "paypal",
                "pix",
                "promptpay",
                "revolut_pay",
                "samsung_pay",
                "sepa_debit",
                "sofort",
                "swish",
                "twint",
                "us_bank_account",
                "wechat_pay",
                "zip"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_method"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "CustomerPaymentMethodResourceList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List a Customer's PaymentMethods"
      }
    },
    "/v1/customers/{customer}/payment_methods/{payment_method}": {
      "get": {
        "description": "<p>Retrieves a PaymentMethod object for a given Customer.</p>",
        "operationId": "GetCustomersCustomerPaymentMethodsPaymentMethod",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "payment_method",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Customer's PaymentMethod"
      }
    },
    "/v1/customers/{customer}/sources": {
      "get": {
        "description": "<p>List sources for a specified customer.</p>",
        "operationId": "GetCustomersCustomerSources",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filter sources according to a particular object type.",
            "in": "query",
            "name": "object",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "anyOf": [
                          {
                            "$ref": "#/components/schemas/bank_account"
                          },
                          {
                            "$ref": "#/components/schemas/card"
                          },
                          {
                            "$ref": "#/components/schemas/source"
                          }
                        ],
                        "title": "Polymorphic",
                        "x-stripeBypassValidation": true
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ApmsSourcesSourceList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "post": {
        "description": "<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>\n\n<p>If the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should <a href=\"/docs/api#update_customer\">update the customer</a> to have a new <code>default_source</code>.</p>",
        "operationId": "PostCustomersCustomerSources",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alipay_account": {
                    "description": "A token returned by [Stripe.js](https://stripe.com/docs/js) representing the user’s Alipay account details.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "bank_account": {
                    "anyOf": [
                      {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "object": {
                            "enum": ["bank_account"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "country"],
                        "title": "customer_payment_source_bank_account",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "object": {
                            "enum": ["card"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "customer_payment_source_card",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js).",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "source": {
                    "description": "Please refer to full [documentation](https://stripe.com/docs/api) instead.",
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a card"
      }
    },
    "/v1/customers/{customer}/sources/{id}": {
      "delete": {
        "description": "<p>Delete a specified source for a given customer.</p>",
        "operationId": "DeleteCustomersCustomerSourcesId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/payment_source"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_payment_source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer source"
      },
      "get": {
        "description": "<p>Retrieve a specified source for a given customer.</p>",
        "operationId": "GetCustomersCustomerSourcesId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 500,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      },
      "post": {
        "description": "<p>Update a specified source for a given customer.</p>",
        "operationId": "PostCustomersCustomerSourcesId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder_name": {
                    "description": "The name of the person or business that owns the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "account_holder_type": {
                    "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
                    "enum": ["company", "individual"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_city": {
                    "description": "City/District/Suburb/Town/Village.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_country": {
                    "description": "Billing address country, if provided when creating card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line1": {
                    "description": "Address line 1 (Street address/PO Box/Company name).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_line2": {
                    "description": "Address line 2 (Apartment/Suite/Unit/Building).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_state": {
                    "description": "State/County/Province/Region.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "address_zip": {
                    "description": "ZIP or postal code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_month": {
                    "description": "Two digit number representing the card’s expiration month.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "exp_year": {
                    "description": "Four digit number representing the card’s expiration year.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "Cardholder name.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "owner": {
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "source_address",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "owner",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/card"
                    },
                    {
                      "$ref": "#/components/schemas/bank_account"
                    },
                    {
                      "$ref": "#/components/schemas/source"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/customers/{customer}/sources/{id}/verify": {
      "post": {
        "description": "<p>Verify a specified bank account for a given customer.</p>",
        "operationId": "PostCustomersCustomerSourcesIdVerify",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amounts": {
                    "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.",
                    "items": {
                      "type": "integer"
                    },
                    "type": "array"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/bank_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Verify a bank account"
      }
    },
    "/v1/customers/{customer}/subscriptions": {
      "get": {
        "description": "<p>You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.</p>",
        "operationId": "GetCustomersCustomerSubscriptions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/subscription"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SubscriptionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List active subscriptions"
      },
      "post": {
        "description": "<p>Creates a new subscription on an existing customer.</p>",
        "operationId": "PostCustomersCustomerSubscriptions",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "add_invoice_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pending_invoice_item_interval": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_end": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "add_invoice_items": {
                    "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "items": {
                            "properties": {
                              "coupon": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "discount": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "promotion_code": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "discounts_data_param",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "one_time_price_data_with_negative_amounts",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "add_invoice_item_entry",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)."
                  },
                  "automatic_tax": {
                    "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_config",
                    "type": "object"
                  },
                  "backdate_start_date": {
                    "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "billing_cycle_anchor": {
                    "description": "A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.",
                    "format": "unix-time",
                    "type": "integer",
                    "x-stripeBypassValidation": true
                  },
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_gte": {
                            "type": "integer"
                          },
                          "reset_billing_cycle_anchor": {
                            "type": "boolean"
                          }
                        },
                        "title": "billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds."
                  },
                  "cancel_at": {
                    "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "cancel_at_period_end": {
                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                    "type": "boolean"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "coupon": {
                    "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "days_until_due": {
                    "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "account_tax_ids": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "invoice_settings_param",
                    "type": "object"
                  },
                  "items": {
                    "description": "A list of up to 20 subscription items, each with an attached price.",
                    "items": {
                      "properties": {
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "usage_gte": {
                                  "type": "integer"
                                }
                              },
                              "required": ["usage_gte"],
                              "title": "item_billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "metadata": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product", "recurring"],
                          "title": "recurring_price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "subscription_item_create_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).",
                    "type": "boolean"
                  },
                  "payment_behavior": {
                    "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "payment_settings": {
                    "description": "Payment settings to pass to invoices created by the subscription.",
                    "properties": {
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "amount": {
                                        "type": "integer"
                                      },
                                      "amount_type": {
                                        "enum": ["fixed", "maximum"],
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 200,
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "network": {
                                    "enum": [
                                      "amex",
                                      "cartes_bancaires",
                                      "diners",
                                      "discover",
                                      "eftpos_au",
                                      "girocard",
                                      "interac",
                                      "jcb",
                                      "link",
                                      "mastercard",
                                      "unionpay",
                                      "unknown",
                                      "visa"
                                    ],
                                    "maxLength": 5000,
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "subscription_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "save_default_payment_method": {
                        "enum": ["off", "on_subscription"],
                        "type": "string"
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "pending_invoice_item_interval": {
                    "anyOf": [
                      {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "pending_invoice_item_interval_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
                  },
                  "promotion_code": {
                    "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.",
                    "properties": {
                      "amount_percent": {
                        "type": "number"
                      },
                      "destination": {
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_specs",
                    "type": "object"
                  },
                  "trial_end": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more."
                  },
                  "trial_from_plan": {
                    "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "boolean"
                  },
                  "trial_period_days": {
                    "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "integer"
                  },
                  "trial_settings": {
                    "description": "Settings related to subscription trials.",
                    "properties": {
                      "end_behavior": {
                        "properties": {
                          "missing_payment_method": {
                            "enum": ["cancel", "create_invoice", "pause"],
                            "type": "string"
                          }
                        },
                        "required": ["missing_payment_method"],
                        "title": "end_behavior",
                        "type": "object"
                      }
                    },
                    "required": ["end_behavior"],
                    "title": "trial_settings_config",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a subscription"
      }
    },
    "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": {
      "delete": {
        "description": "<p>Cancels a customer’s subscription. If you set the <code>at_period_end</code> parameter to <code>true</code>, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default <code>false</code> value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.</p>\n\n<p>Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually <a href=\"#delete_invoiceitem\">deleted</a>. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.</p>\n\n<p>By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.</p>",
        "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_now": {
                    "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.",
                    "type": "boolean"
                  },
                  "prorate": {
                    "description": "Can be set to `true` if `at_period_end` is not set to `true`. Will generate a proration invoice item that credits remaining unused time until the subscription period end.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a subscription"
      },
      "get": {
        "description": "<p>Retrieves the subscription with the given ID.</p>",
        "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a subscription"
      },
      "post": {
        "description": "<p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href=\"#upcoming_invoice\">upcoming invoice</a> endpoint.</p>",
        "operationId": "PostCustomersCustomerSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "add_invoice_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cancel_at": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cancellation_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_source": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pause_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pending_invoice_item_interval": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_end": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "add_invoice_items": {
                    "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "items": {
                            "properties": {
                              "coupon": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "discount": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "promotion_code": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "discounts_data_param",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "one_time_price_data_with_negative_amounts",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "add_invoice_item_entry",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)."
                  },
                  "automatic_tax": {
                    "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_config",
                    "type": "object"
                  },
                  "billing_cycle_anchor": {
                    "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
                    "enum": ["now", "unchanged"],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_gte": {
                            "type": "integer"
                          },
                          "reset_billing_cycle_anchor": {
                            "type": "boolean"
                          }
                        },
                        "title": "billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds."
                  },
                  "cancel_at": {
                    "anyOf": [
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                  },
                  "cancel_at_period_end": {
                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                    "type": "boolean"
                  },
                  "cancellation_details": {
                    "description": "Details about why this subscription was cancelled",
                    "properties": {
                      "comment": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "feedback": {
                        "enum": [
                          "",
                          "customer_service",
                          "low_quality",
                          "missing_features",
                          "other",
                          "switched_service",
                          "too_complex",
                          "too_expensive",
                          "unused"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "cancellation_details_param",
                    "type": "object"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "coupon": {
                    "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "days_until_due": {
                    "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)."
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "account_tax_ids": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "invoice_settings_param",
                    "type": "object"
                  },
                  "items": {
                    "description": "A list of up to 20 subscription items, each with an attached price.",
                    "items": {
                      "properties": {
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "usage_gte": {
                                  "type": "integer"
                                }
                              },
                              "required": ["usage_gte"],
                              "title": "item_billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "clear_usage": {
                          "type": "boolean"
                        },
                        "deleted": {
                          "type": "boolean"
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "metadata": {
                          "anyOf": [
                            {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product", "recurring"],
                          "title": "recurring_price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "subscription_item_update_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).",
                    "type": "boolean"
                  },
                  "pause_collection": {
                    "anyOf": [
                      {
                        "properties": {
                          "behavior": {
                            "enum": [
                              "keep_as_draft",
                              "mark_uncollectible",
                              "void"
                            ],
                            "type": "string"
                          },
                          "resumes_at": {
                            "format": "unix-time",
                            "type": "integer"
                          }
                        },
                        "required": ["behavior"],
                        "title": "pause_collection_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment)."
                  },
                  "payment_behavior": {
                    "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "payment_settings": {
                    "description": "Payment settings to pass to invoices created by the subscription.",
                    "properties": {
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "amount": {
                                        "type": "integer"
                                      },
                                      "amount_type": {
                                        "enum": ["fixed", "maximum"],
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 200,
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "network": {
                                    "enum": [
                                      "amex",
                                      "cartes_bancaires",
                                      "diners",
                                      "discover",
                                      "eftpos_au",
                                      "girocard",
                                      "interac",
                                      "jcb",
                                      "link",
                                      "mastercard",
                                      "unionpay",
                                      "unknown",
                                      "visa"
                                    ],
                                    "maxLength": 5000,
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "subscription_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "save_default_payment_method": {
                        "enum": ["off", "on_subscription"],
                        "type": "string"
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "pending_invoice_item_interval": {
                    "anyOf": [
                      {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "pending_invoice_item_interval_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
                  },
                  "promotion_code": {
                    "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "transfer_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value."
                  },
                  "trial_end": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`."
                  },
                  "trial_from_plan": {
                    "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "boolean"
                  },
                  "trial_settings": {
                    "description": "Settings related to subscription trials.",
                    "properties": {
                      "end_behavior": {
                        "properties": {
                          "missing_payment_method": {
                            "enum": ["cancel", "create_invoice", "pause"],
                            "type": "string"
                          }
                        },
                        "required": ["missing_payment_method"],
                        "title": "end_behavior",
                        "type": "object"
                      }
                    },
                    "required": ["end_behavior"],
                    "title": "trial_settings_config",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a subscription on a customer"
      }
    },
    "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": {
      "delete": {
        "description": "<p>Removes the currently applied discount on a customer.</p>",
        "operationId": "DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a customer discount"
      },
      "get": {
        "description": "",
        "operationId": "GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/discount"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/customers/{customer}/tax_ids": {
      "get": {
        "description": "<p>Returns a list of tax IDs for a customer.</p>",
        "operationId": "GetCustomersCustomerTaxIds",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/tax_id"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxIDsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Customer tax IDs"
      },
      "post": {
        "description": "<p>Creates a new <code>tax_id</code> object for a customer.</p>",
        "operationId": "PostCustomersCustomerTaxIds",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "type": {
                    "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`",
                    "enum": [
                      "ad_nrt",
                      "ae_trn",
                      "al_tin",
                      "am_tin",
                      "ao_tin",
                      "ar_cuit",
                      "au_abn",
                      "au_arn",
                      "ba_tin",
                      "bb_tin",
                      "bg_uic",
                      "bh_vat",
                      "bo_tin",
                      "br_cnpj",
                      "br_cpf",
                      "bs_tin",
                      "by_tin",
                      "ca_bn",
                      "ca_gst_hst",
                      "ca_pst_bc",
                      "ca_pst_mb",
                      "ca_pst_sk",
                      "ca_qst",
                      "cd_nif",
                      "ch_uid",
                      "ch_vat",
                      "cl_tin",
                      "cn_tin",
                      "co_nit",
                      "cr_tin",
                      "de_stn",
                      "do_rcn",
                      "ec_ruc",
                      "eg_tin",
                      "es_cif",
                      "eu_oss_vat",
                      "eu_vat",
                      "gb_vat",
                      "ge_vat",
                      "gn_nif",
                      "hk_br",
                      "hr_oib",
                      "hu_tin",
                      "id_npwp",
                      "il_vat",
                      "in_gst",
                      "is_vat",
                      "jp_cn",
                      "jp_rn",
                      "jp_trn",
                      "ke_pin",
                      "kh_tin",
                      "kr_brn",
                      "kz_bin",
                      "li_uid",
                      "li_vat",
                      "ma_vat",
                      "md_vat",
                      "me_pib",
                      "mk_vat",
                      "mr_nif",
                      "mx_rfc",
                      "my_frp",
                      "my_itn",
                      "my_sst",
                      "ng_tin",
                      "no_vat",
                      "no_voec",
                      "np_pan",
                      "nz_gst",
                      "om_vat",
                      "pe_ruc",
                      "ph_tin",
                      "ro_tin",
                      "rs_pib",
                      "ru_inn",
                      "ru_kpp",
                      "sa_vat",
                      "sg_gst",
                      "sg_uen",
                      "si_tin",
                      "sn_ninea",
                      "sr_fin",
                      "sv_nit",
                      "th_vat",
                      "tj_tin",
                      "tr_tin",
                      "tw_vat",
                      "tz_vat",
                      "ua_vat",
                      "ug_tin",
                      "us_ein",
                      "uy_ruc",
                      "uz_tin",
                      "uz_vat",
                      "ve_rif",
                      "vn_tin",
                      "za_vat",
                      "zm_tin",
                      "zw_tin"
                    ],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "value": {
                    "description": "Value of the tax ID.",
                    "type": "string"
                  }
                },
                "required": ["type", "value"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Customer tax ID"
      }
    },
    "/v1/customers/{customer}/tax_ids/{id}": {
      "delete": {
        "description": "<p>Deletes an existing <code>tax_id</code> object.</p>",
        "operationId": "DeleteCustomersCustomerTaxIdsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a Customer tax ID"
      },
      "get": {
        "description": "<p>Retrieves the <code>tax_id</code> object with the given identifier.</p>",
        "operationId": "GetCustomersCustomerTaxIdsId",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Customer tax ID"
      }
    },
    "/v1/disputes": {
      "get": {
        "description": "<p>Returns a list of your disputes.</p>",
        "operationId": "GetDisputes",
        "parameters": [
          {
            "description": "Only return disputes associated to the charge specified by this charge ID.",
            "in": "query",
            "name": "charge",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return disputes that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.",
            "in": "query",
            "name": "payment_intent",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/dispute"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/disputes",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "DisputeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all disputes"
      }
    },
    "/v1/disputes/{dispute}": {
      "get": {
        "description": "<p>Retrieves the dispute with the given ID.</p>",
        "operationId": "GetDisputesDispute",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a dispute"
      },
      "post": {
        "description": "<p>When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your <a href=\"https://dashboard.stripe.com/disputes\">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p>\n\n<p>Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our <a href=\"/docs/disputes/categories\">guide to dispute types</a>.</p>",
        "operationId": "PostDisputesDispute",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "evidence": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "evidence": {
                    "description": "Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.",
                    "properties": {
                      "access_activity_log": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "billing_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "cancellation_policy": {
                        "type": "string"
                      },
                      "cancellation_policy_disclosure": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "cancellation_rebuttal": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "customer_communication": {
                        "type": "string"
                      },
                      "customer_email_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_purchase_ip": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer_signature": {
                        "type": "string"
                      },
                      "duplicate_charge_documentation": {
                        "type": "string"
                      },
                      "duplicate_charge_explanation": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "duplicate_charge_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "enhanced_evidence": {
                        "anyOf": [
                          {
                            "properties": {
                              "visa_compelling_evidence_3": {
                                "properties": {
                                  "disputed_transaction": {
                                    "properties": {
                                      "customer_account_id": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_device_fingerprint": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_device_id": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_email_address": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "customer_purchase_ip": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "merchandise_or_services": {
                                        "enum": ["merchandise", "services"],
                                        "type": "string"
                                      },
                                      "product_description": {
                                        "anyOf": [
                                          {
                                            "maxLength": 5000,
                                            "type": "string"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      },
                                      "shipping_address": {
                                        "properties": {
                                          "city": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "country": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "line1": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "line2": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "postal_code": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          },
                                          "state": {
                                            "anyOf": [
                                              {
                                                "maxLength": 5000,
                                                "type": "string"
                                              },
                                              {
                                                "enum": [""],
                                                "type": "string"
                                              }
                                            ]
                                          }
                                        },
                                        "title": "shipping_address",
                                        "type": "object"
                                      }
                                    },
                                    "title": "visa_compelling_evidence3_disputed_transaction",
                                    "type": "object"
                                  },
                                  "prior_undisputed_transactions": {
                                    "items": {
                                      "properties": {
                                        "charge": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "customer_account_id": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_device_fingerprint": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_device_id": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_email_address": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "customer_purchase_ip": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "product_description": {
                                          "anyOf": [
                                            {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            {
                                              "enum": [""],
                                              "type": "string"
                                            }
                                          ]
                                        },
                                        "shipping_address": {
                                          "properties": {
                                            "city": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "country": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "line1": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "line2": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "postal_code": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            },
                                            "state": {
                                              "anyOf": [
                                                {
                                                  "maxLength": 5000,
                                                  "type": "string"
                                                },
                                                {
                                                  "enum": [""],
                                                  "type": "string"
                                                }
                                              ]
                                            }
                                          },
                                          "title": "shipping_address",
                                          "type": "object"
                                        }
                                      },
                                      "required": ["charge"],
                                      "title": "visa_compelling_evidence3_prior_undisputed_transaction",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "visa_compelling_evidence3",
                                "type": "object"
                              },
                              "visa_compliance": {
                                "properties": {
                                  "fee_acknowledged": {
                                    "type": "boolean"
                                  }
                                },
                                "title": "visa_compliance",
                                "type": "object"
                              }
                            },
                            "title": "enhanced_evidence",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "product_description": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "receipt": {
                        "type": "string"
                      },
                      "refund_policy": {
                        "type": "string"
                      },
                      "refund_policy_disclosure": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "refund_refusal_explanation": {
                        "maxLength": 20000,
                        "type": "string"
                      },
                      "service_date": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "service_documentation": {
                        "type": "string"
                      },
                      "shipping_address": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_carrier": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_date": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_documentation": {
                        "type": "string"
                      },
                      "shipping_tracking_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "uncategorized_file": {
                        "type": "string"
                      },
                      "uncategorized_text": {
                        "maxLength": 20000,
                        "type": "string"
                      }
                    },
                    "title": "dispute_evidence_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "submit": {
                    "description": "Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a dispute"
      }
    },
    "/v1/disputes/{dispute}/close": {
      "post": {
        "description": "<p>Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.</p>\n\n<p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. <em>Closing a dispute is irreversible</em>.</p>",
        "operationId": "PostDisputesDisputeClose",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Close a dispute"
      }
    },
    "/v1/entitlements/active_entitlements": {
      "get": {
        "description": "<p>Retrieve a list of active entitlements for a customer</p>",
        "operationId": "GetEntitlementsActiveEntitlements",
        "parameters": [
          {
            "description": "The ID of the customer.",
            "in": "query",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/entitlements.active_entitlement"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "EntitlementsResourceCustomerEntitlementList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all active entitlements"
      }
    },
    "/v1/entitlements/active_entitlements/{id}": {
      "get": {
        "description": "<p>Retrieve an active entitlement</p>",
        "operationId": "GetEntitlementsActiveEntitlementsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the entitlement.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/entitlements.active_entitlement"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an active entitlement"
      }
    },
    "/v1/entitlements/features": {
      "get": {
        "description": "<p>Retrieve a list of features</p>",
        "operationId": "GetEntitlementsFeatures",
        "parameters": [
          {
            "description": "If set, filter results to only include features with the given archive status.",
            "in": "query",
            "name": "archived",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "If set, filter results to only include features with the given lookup_key.",
            "in": "query",
            "name": "lookup_key",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/entitlements.feature"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/entitlements/features",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "EntitlementsResourceFeatureList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all features"
      },
      "post": {
        "description": "<p>Creates a feature</p>",
        "operationId": "PostEntitlementsFeatures",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "lookup_key": {
                    "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.",
                    "maxLength": 80,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
                    "type": "object"
                  },
                  "name": {
                    "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.",
                    "maxLength": 80,
                    "type": "string"
                  }
                },
                "required": ["lookup_key", "name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/entitlements.feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a feature"
      }
    },
    "/v1/entitlements/features/{id}": {
      "get": {
        "description": "<p>Retrieves a feature</p>",
        "operationId": "GetEntitlementsFeaturesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the feature.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/entitlements.feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a feature"
      },
      "post": {
        "description": "<p>Update a feature’s metadata or permanently deactivate it.</p>",
        "operationId": "PostEntitlementsFeaturesId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
                  },
                  "name": {
                    "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.",
                    "maxLength": 80,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/entitlements.feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Updates a feature"
      }
    },
    "/v1/ephemeral_keys": {
      "post": {
        "description": "<p>Creates a short-lived API key for a given resource.</p>",
        "operationId": "PostEphemeralKeys",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "customer": {
                    "description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "issuing_card": {
                    "description": "The ID of the Issuing Card you'd like to access using the resulting ephemeral key.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "nonce": {
                    "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "verification_session": {
                    "description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ephemeral_key"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an ephemeral key"
      }
    },
    "/v1/ephemeral_keys/{key}": {
      "delete": {
        "description": "<p>Invalidates a short-lived API key for a given resource.</p>",
        "operationId": "DeleteEphemeralKeysKey",
        "parameters": [
          {
            "in": "path",
            "name": "key",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ephemeral_key"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Immediately invalidate an ephemeral key"
      }
    },
    "/v1/events": {
      "get": {
        "description": "<p>List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href=\"https://docs.stripe.com/api/events/object\">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).</p>",
        "operationId": "GetEvents",
        "parameters": [
          {
            "description": "Only return events that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.",
            "in": "query",
            "name": "delivery_success",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.",
            "explode": true,
            "in": "query",
            "name": "types",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/event"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/events",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "NotificationEventList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all events"
      }
    },
    "/v1/events/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.</p>",
        "operationId": "GetEventsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/event"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an event"
      }
    },
    "/v1/exchange_rates": {
      "get": {
        "description": "<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>",
        "operationId": "GetExchangeRates",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/exchange_rate"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/exchange_rates",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ExchangeRateList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all exchange rates"
      }
    },
    "/v1/exchange_rates/{rate_id}": {
      "get": {
        "description": "<p>Retrieves the exchange rates from the given currency to every supported currency.</p>",
        "operationId": "GetExchangeRatesRateId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "rate_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/exchange_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an exchange rate"
      }
    },
    "/v1/file_links": {
      "get": {
        "description": "<p>Returns a list of file links.</p>",
        "operationId": "GetFileLinks",
        "parameters": [
          {
            "description": "Only return links that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Filter links by their expiration status. By default, Stripe returns all links.",
            "in": "query",
            "name": "expired",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "Only return links for the given file.",
            "in": "query",
            "name": "file",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/file_link"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/file_links",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "FileResourceFileLinkList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all file links"
      },
      "post": {
        "description": "<p>Creates a new file link object.</p>",
        "operationId": "PostFileLinks",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "The link isn't usable after this future timestamp.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "file": {
                    "description": "The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "required": ["file"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/file_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a file link"
      }
    },
    "/v1/file_links/{link}": {
      "get": {
        "description": "<p>Retrieves the file link with the given ID.</p>",
        "operationId": "GetFileLinksLink",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "link",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/file_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a file link"
      },
      "post": {
        "description": "<p>Updates an existing file link object. Expired links can no longer be updated.</p>",
        "operationId": "PostFileLinksLink",
        "parameters": [
          {
            "in": "path",
            "name": "link",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expires_at": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately."
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/file_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a file link"
      }
    },
    "/v1/files": {
      "get": {
        "description": "<p>Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.</p>",
        "operationId": "GetFiles",
        "parameters": [
          {
            "description": "Only return files that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.",
            "in": "query",
            "name": "purpose",
            "required": false,
            "schema": {
              "enum": [
                "account_requirement",
                "additional_verification",
                "business_icon",
                "business_logo",
                "customer_signature",
                "dispute_evidence",
                "document_provider_identity_document",
                "finance_report_run",
                "financial_account_statement",
                "identity_document",
                "identity_document_downloadable",
                "issuing_regulatory_reporting",
                "pci_document",
                "selfie",
                "sigma_scheduled_query",
                "tax_document_user_upload",
                "terminal_reader_splashscreen"
              ],
              "maxLength": 5000,
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/file"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/files",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "FileResourceFileList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all files"
      },
      "post": {
        "description": "<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and the parameters for creating a file.</p>\n\n<p>All of Stripe’s officially supported Client libraries support sending <code>multipart/form-data</code>.</p>",
        "operationId": "PostFiles",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "file_link_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "file": {
                    "description": "A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.",
                    "format": "binary",
                    "type": "string"
                  },
                  "file_link_data": {
                    "description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
                    "properties": {
                      "create": {
                        "type": "boolean"
                      },
                      "expires_at": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "required": ["create"],
                    "title": "file_link_creation_params",
                    "type": "object"
                  },
                  "purpose": {
                    "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.",
                    "enum": [
                      "account_requirement",
                      "additional_verification",
                      "business_icon",
                      "business_logo",
                      "customer_signature",
                      "dispute_evidence",
                      "identity_document",
                      "issuing_regulatory_reporting",
                      "pci_document",
                      "tax_document_user_upload",
                      "terminal_reader_splashscreen"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "required": ["file", "purpose"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/file"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "servers": [
          {
            "url": "https://files.stripe.com/"
          }
        ],
        "summary": "Create a file"
      }
    },
    "/v1/files/{file}": {
      "get": {
        "description": "<p>Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href=\"/docs/file-upload#download-file-contents\">access file contents</a>.</p>",
        "operationId": "GetFilesFile",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "file",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/file"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a file"
      }
    },
    "/v1/financial_connections/accounts": {
      "get": {
        "description": "<p>Returns a list of Financial Connections <code>Account</code> objects.</p>",
        "operationId": "GetFinancialConnectionsAccounts",
        "parameters": [
          {
            "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.",
            "explode": true,
            "in": "query",
            "name": "account_holder",
            "required": false,
            "schema": {
              "properties": {
                "account": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "customer": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "title": "accountholder_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "If present, only return accounts that were collected as part of the given session.",
            "in": "query",
            "name": "session",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/financial_connections.account"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/financial_connections/accounts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankConnectionsResourceLinkedAccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Accounts"
      }
    },
    "/v1/financial_connections/accounts/{account}": {
      "get": {
        "description": "<p>Retrieves the details of an Financial Connections <code>Account</code>.</p>",
        "operationId": "GetFinancialConnectionsAccountsAccount",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an Account"
      }
    },
    "/v1/financial_connections/accounts/{account}/disconnect": {
      "post": {
        "description": "<p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p>",
        "operationId": "PostFinancialConnectionsAccountsAccountDisconnect",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Disconnect an Account"
      }
    },
    "/v1/financial_connections/accounts/{account}/owners": {
      "get": {
        "description": "<p>Lists all owners for a given <code>Account</code></p>",
        "operationId": "GetFinancialConnectionsAccountsAccountOwners",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The ID of the ownership object to fetch owners from.",
            "in": "query",
            "name": "ownership",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/financial_connections.account_owner"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankConnectionsResourceOwnerList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Account Owners"
      }
    },
    "/v1/financial_connections/accounts/{account}/refresh": {
      "post": {
        "description": "<p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p>",
        "operationId": "PostFinancialConnectionsAccountsAccountRefresh",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "The list of account features that you would like to refresh.",
                    "items": {
                      "enum": ["balance", "ownership", "transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  }
                },
                "required": ["features"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Refresh Account data"
      }
    },
    "/v1/financial_connections/accounts/{account}/subscribe": {
      "post": {
        "description": "<p>Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p>",
        "operationId": "PostFinancialConnectionsAccountsAccountSubscribe",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "The list of account features to which you would like to subscribe.",
                    "items": {
                      "enum": ["transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  }
                },
                "required": ["features"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Subscribe to data refreshes for an Account"
      }
    },
    "/v1/financial_connections/accounts/{account}/unsubscribe": {
      "post": {
        "description": "<p>Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p>",
        "operationId": "PostFinancialConnectionsAccountsAccountUnsubscribe",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "The list of account features from which you would like to unsubscribe.",
                    "items": {
                      "enum": ["transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  }
                },
                "required": ["features"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Unsubscribe from data refreshes for an Account"
      }
    },
    "/v1/financial_connections/sessions": {
      "post": {
        "description": "<p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>",
        "operationId": "PostFinancialConnectionsSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "account_holder": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "filters": {
                  "explode": true,
                  "style": "deepObject"
                },
                "permissions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "prefetch": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder": {
                    "description": "The account holder to link accounts for.",
                    "properties": {
                      "account": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "customer"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "accountholder_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "filters": {
                    "description": "Filters to restrict the kinds of accounts to collect.",
                    "properties": {
                      "account_subcategories": {
                        "items": {
                          "enum": [
                            "checking",
                            "credit_card",
                            "line_of_credit",
                            "mortgage",
                            "savings"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "title": "filters_params",
                    "type": "object"
                  },
                  "permissions": {
                    "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
                    "items": {
                      "enum": [
                        "balances",
                        "ownership",
                        "payment_method",
                        "transactions"
                      ],
                      "maxLength": 5000,
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "prefetch": {
                    "description": "List of data features that you would like to retrieve upon account creation.",
                    "items": {
                      "enum": ["balances", "ownership", "transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "return_url": {
                    "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["account_holder", "permissions"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Session"
      }
    },
    "/v1/financial_connections/sessions/{session}": {
      "get": {
        "description": "<p>Retrieves the details of a Financial Connections <code>Session</code></p>",
        "operationId": "GetFinancialConnectionsSessionsSession",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Session"
      }
    },
    "/v1/financial_connections/transactions": {
      "get": {
        "description": "<p>Returns a list of Financial Connections <code>Transaction</code> objects.</p>",
        "operationId": "GetFinancialConnectionsTransactions",
        "parameters": [
          {
            "description": "The ID of the Financial Connections Account whose transactions will be retrieved.",
            "in": "query",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:",
            "explode": true,
            "in": "query",
            "name": "transacted_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:",
            "explode": true,
            "in": "query",
            "name": "transaction_refresh",
            "required": false,
            "schema": {
              "properties": {
                "after": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "required": ["after"],
              "title": "transaction_refresh_params",
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/financial_connections.transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/financial_connections/transactions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankConnectionsResourceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Transactions"
      }
    },
    "/v1/financial_connections/transactions/{transaction}": {
      "get": {
        "description": "<p>Retrieves the details of a Financial Connections <code>Transaction</code></p>",
        "operationId": "GetFinancialConnectionsTransactionsTransaction",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Transaction"
      }
    },
    "/v1/forwarding/requests": {
      "get": {
        "description": "<p>Lists all ForwardingRequest objects.</p>",
        "operationId": "GetForwardingRequests",
        "parameters": [
          {
            "description": "Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "properties": {
                "gt": {
                  "type": "integer"
                },
                "gte": {
                  "type": "integer"
                },
                "lt": {
                  "type": "integer"
                },
                "lte": {
                  "type": "integer"
                }
              },
              "title": "created_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "List of ForwardingRequest data.",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/forwarding.request"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ForwardingRequestList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all ForwardingRequests"
      },
      "post": {
        "description": "<p>Creates a ForwardingRequest object.</p>",
        "operationId": "PostForwardingRequests",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "replacements": {
                  "explode": true,
                  "style": "deepObject"
                },
                "request": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "payment_method": {
                    "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "replacements": {
                    "description": "The field kinds to be replaced in the forwarded request.",
                    "items": {
                      "enum": [
                        "card_cvc",
                        "card_expiry",
                        "card_number",
                        "cardholder_name",
                        "request_signature"
                      ],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "request": {
                    "description": "The request body and headers to be sent to the destination endpoint.",
                    "properties": {
                      "body": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "headers": {
                        "items": {
                          "properties": {
                            "name": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "value": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "required": ["name", "value"],
                          "title": "header_param",
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "title": "request_param",
                    "type": "object"
                  },
                  "url": {
                    "description": "The destination URL for the forwarded request. Must be supported by the config.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["payment_method", "replacements", "url"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/forwarding.request"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a ForwardingRequest"
      }
    },
    "/v1/forwarding/requests/{id}": {
      "get": {
        "description": "<p>Retrieves a ForwardingRequest object.</p>",
        "operationId": "GetForwardingRequestsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/forwarding.request"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a ForwardingRequest"
      }
    },
    "/v1/identity/verification_reports": {
      "get": {
        "description": "<p>List all verification reports.</p>",
        "operationId": "GetIdentityVerificationReports",
        "parameters": [
          {
            "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
            "in": "query",
            "name": "client_reference_id",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return VerificationReports that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return VerificationReports of this type",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["document", "id_number"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.",
            "in": "query",
            "name": "verification_session",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/identity.verification_report"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/identity/verification_reports",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "GelatoVerificationReportList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List VerificationReports"
      }
    },
    "/v1/identity/verification_reports/{report}": {
      "get": {
        "description": "<p>Retrieves an existing VerificationReport</p>",
        "operationId": "GetIdentityVerificationReportsReport",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "report",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_report"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a VerificationReport"
      }
    },
    "/v1/identity/verification_sessions": {
      "get": {
        "description": "<p>Returns a list of VerificationSessions</p>",
        "operationId": "GetIdentityVerificationSessions",
        "parameters": [
          {
            "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
            "in": "query",
            "name": "client_reference_id",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return VerificationSessions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "query",
            "name": "related_customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["canceled", "processing", "requires_input", "verified"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/identity.verification_session"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/identity/verification_sessions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "GelatoVerificationSessionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List VerificationSessions"
      },
      "post": {
        "description": "<p>Creates a VerificationSession object.</p>\n\n<p>After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.</p>\n\n<p>If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.</p>\n\n<p>Related guide: <a href=\"/docs/identity/verify-identity-documents\">Verify your users’ identity documents</a></p>",
        "operationId": "PostIdentityVerificationSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "provided_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "client_reference_id": {
                    "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "options": {
                    "description": "A set of options for the session’s verification checks.",
                    "properties": {
                      "document": {
                        "anyOf": [
                          {
                            "properties": {
                              "allowed_types": {
                                "items": {
                                  "enum": [
                                    "driving_license",
                                    "id_card",
                                    "passport"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "require_id_number": {
                                "type": "boolean"
                              },
                              "require_live_capture": {
                                "type": "boolean"
                              },
                              "require_matching_selfie": {
                                "type": "boolean"
                              }
                            },
                            "title": "document_options",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "session_options_param",
                    "type": "object"
                  },
                  "provided_details": {
                    "description": "Details provided about the user being verified. These details may be shown to the user.",
                    "properties": {
                      "email": {
                        "type": "string"
                      },
                      "phone": {
                        "type": "string"
                      }
                    },
                    "title": "provided_details_param",
                    "type": "object"
                  },
                  "related_customer": {
                    "description": "Token referencing a Customer resource.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "return_url": {
                    "description": "The URL that the user will be redirected to upon completing the verification flow.",
                    "type": "string"
                  },
                  "type": {
                    "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.",
                    "enum": ["document", "id_number"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "verification_flow": {
                    "description": "The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a VerificationSession"
      }
    },
    "/v1/identity/verification_sessions/{session}": {
      "get": {
        "description": "<p>Retrieves the details of a VerificationSession that was previously created.</p>\n\n<p>When the session status is <code>requires_input</code>, you can use this method to retrieve a valid\n<code>client_secret</code> or <code>url</code> to allow re-submission.</p>",
        "operationId": "GetIdentityVerificationSessionsSession",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a VerificationSession"
      },
      "post": {
        "description": "<p>Updates a VerificationSession object.</p>\n\n<p>When the session status is <code>requires_input</code>, you can use this method to update the\nverification check and options.</p>",
        "operationId": "PostIdentityVerificationSessionsSession",
        "parameters": [
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "provided_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "options": {
                    "description": "A set of options for the session’s verification checks.",
                    "properties": {
                      "document": {
                        "anyOf": [
                          {
                            "properties": {
                              "allowed_types": {
                                "items": {
                                  "enum": [
                                    "driving_license",
                                    "id_card",
                                    "passport"
                                  ],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "require_id_number": {
                                "type": "boolean"
                              },
                              "require_live_capture": {
                                "type": "boolean"
                              },
                              "require_matching_selfie": {
                                "type": "boolean"
                              }
                            },
                            "title": "document_options",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "session_options_param",
                    "type": "object"
                  },
                  "provided_details": {
                    "description": "Details provided about the user being verified. These details may be shown to the user.",
                    "properties": {
                      "email": {
                        "type": "string"
                      },
                      "phone": {
                        "type": "string"
                      }
                    },
                    "title": "provided_details_param",
                    "type": "object"
                  },
                  "type": {
                    "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.",
                    "enum": ["document", "id_number"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a VerificationSession"
      }
    },
    "/v1/identity/verification_sessions/{session}/cancel": {
      "post": {
        "description": "<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href=\"/docs/identity/how-sessions-work\">status</a>.</p>\n\n<p>Once canceled, future submission attempts are disabled. This cannot be undone. <a href=\"/docs/identity/verification-sessions#cancel\">Learn more</a>.</p>",
        "operationId": "PostIdentityVerificationSessionsSessionCancel",
        "parameters": [
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a VerificationSession"
      }
    },
    "/v1/identity/verification_sessions/{session}/redact": {
      "post": {
        "description": "<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.</p>\n\n<p>A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code>\n<a href=\"/docs/identity/how-sessions-work\">status</a>. Redacting a VerificationSession in <code>requires_action</code>\nstate will automatically cancel it.</p>\n\n<p>The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is\nfinished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event\nwill be emitted.</p>\n\n<p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar\nplaceholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or\nused for any purpose.</p>\n\n<p><a href=\"/docs/identity/verification-sessions#redact\">Learn more</a>.</p>",
        "operationId": "PostIdentityVerificationSessionsSessionRedact",
        "parameters": [
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity.verification_session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Redact a VerificationSession"
      }
    },
    "/v1/invoice_rendering_templates": {
      "get": {
        "description": "<p>List all templates, ordered by creation date, with the most recently created template appearing first.</p>",
        "operationId": "GetInvoiceRenderingTemplates",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "archived"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/invoice_rendering_template"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "InvoiceRenderingTemplatesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all invoice rendering templates"
      }
    },
    "/v1/invoice_rendering_templates/{template}": {
      "get": {
        "description": "<p>Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.</p>",
        "operationId": "GetInvoiceRenderingTemplatesTemplate",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "template",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "query",
            "name": "version",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice_rendering_template"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an invoice rendering template"
      }
    },
    "/v1/invoice_rendering_templates/{template}/archive": {
      "post": {
        "description": "<p>Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.</p>",
        "operationId": "PostInvoiceRenderingTemplatesTemplateArchive",
        "parameters": [
          {
            "in": "path",
            "name": "template",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice_rendering_template"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Archive an invoice rendering template"
      }
    },
    "/v1/invoice_rendering_templates/{template}/unarchive": {
      "post": {
        "description": "<p>Unarchive an invoice rendering template so it can be used on new Stripe objects again.</p>",
        "operationId": "PostInvoiceRenderingTemplatesTemplateUnarchive",
        "parameters": [
          {
            "in": "path",
            "name": "template",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice_rendering_template"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Unarchive an invoice rendering template"
      }
    },
    "/v1/invoiceitems": {
      "get": {
        "description": "<p>Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.</p>",
        "operationId": "GetInvoiceitems",
        "parameters": [
          {
            "description": "Only return invoice items that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.",
            "in": "query",
            "name": "invoice",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.",
            "in": "query",
            "name": "pending",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/invoiceitem"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/invoiceitems",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "InvoicesItemsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all invoice items"
      },
      "post": {
        "description": "<p>Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.</p>",
        "operationId": "PostInvoiceitems",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "period": {
                  "explode": true,
                  "style": "deepObject"
                },
                "price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_code": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The ID of the customer who will be billed when this invoice item is billed.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "discountable": {
                    "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.",
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice": {
                    "description": "The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "period": {
                    "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
                    "properties": {
                      "end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "start": {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    },
                    "required": ["end", "start"],
                    "title": "period",
                    "type": "object"
                  },
                  "price": {
                    "description": "The ID of the price object. One of `price` or `price_data` is required.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product"],
                    "title": "one_time_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "description": "Non-negative integer. The quantity of units for the invoice item.",
                    "type": "integer"
                  },
                  "subscription": {
                    "description": "The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_behavior": {
                    "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tax_code": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
                  },
                  "tax_rates": {
                    "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "unit_amount": {
                    "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.",
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "required": ["customer"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoiceitem"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an invoice item"
      }
    },
    "/v1/invoiceitems/{invoiceitem}": {
      "delete": {
        "description": "<p>Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.</p>",
        "operationId": "DeleteInvoiceitemsInvoiceitem",
        "parameters": [
          {
            "in": "path",
            "name": "invoiceitem",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_invoiceitem"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete an invoice item"
      },
      "get": {
        "description": "<p>Retrieves the invoice item with the given ID.</p>",
        "operationId": "GetInvoiceitemsInvoiceitem",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "invoiceitem",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoiceitem"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an invoice item"
      },
      "post": {
        "description": "<p>Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.</p>",
        "operationId": "PostInvoiceitemsInvoiceitem",
        "parameters": [
          {
            "in": "path",
            "name": "invoiceitem",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "period": {
                  "explode": true,
                  "style": "deepObject"
                },
                "price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_code": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
                    "type": "integer"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "discountable": {
                    "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.",
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "period": {
                    "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
                    "properties": {
                      "end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "start": {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    },
                    "required": ["end", "start"],
                    "title": "period",
                    "type": "object"
                  },
                  "price": {
                    "description": "The ID of the price object. One of `price` or `price_data` is required.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product"],
                    "title": "one_time_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "description": "Non-negative integer. The quantity of units for the invoice item.",
                    "type": "integer"
                  },
                  "tax_behavior": {
                    "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tax_code": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates."
                  },
                  "unit_amount": {
                    "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.",
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoiceitem"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an invoice item"
      }
    },
    "/v1/invoices": {
      "get": {
        "description": "<p>You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.</p>",
        "operationId": "GetInvoices",
        "parameters": [
          {
            "description": "The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.",
            "in": "query",
            "name": "collection_method",
            "required": false,
            "schema": {
              "enum": ["charge_automatically", "send_invoice"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return invoices that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return invoices for the customer specified by this customer ID.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "explode": true,
            "in": "query",
            "name": "due_date",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["draft", "open", "paid", "uncollectible", "void"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return invoices for the subscription specified by this subscription ID.",
            "in": "query",
            "name": "subscription",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/invoice"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/invoices",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "InvoicesResourceList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all invoices"
      },
      "post": {
        "description": "<p>This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you <a href=\"#finalize_invoice\">finalize</a> the invoice, which allows you to <a href=\"#pay_invoice\">pay</a> or <a href=\"#send_invoice\">send</a> the invoice to your customers.</p>",
        "operationId": "PostInvoices",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "account_tax_ids": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_fields": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "from_invoice": {
                  "explode": true,
                  "style": "deepObject"
                },
                "issuer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "rendering": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_cost": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_tax_ids": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft."
                  },
                  "application_fee_amount": {
                    "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).",
                    "type": "integer"
                  },
                  "auto_advance": {
                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                    "type": "boolean"
                  },
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this invoice.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_param",
                    "type": "object"
                  },
                  "automatically_finalizes_at": {
                    "description": "The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency to create this invoice in. Defaults to that of `customer` if not specified.",
                    "format": "currency",
                    "type": "string"
                  },
                  "custom_fields": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "name": {
                              "maxLength": 40,
                              "type": "string"
                            },
                            "value": {
                              "maxLength": 140,
                              "type": "string"
                            }
                          },
                          "required": ["name", "value"],
                          "title": "custom_field_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of up to 4 custom fields to be displayed on the invoice."
                  },
                  "customer": {
                    "description": "The ID of the customer who will be billed.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "days_until_due": {
                    "description": "The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_tax_rates": {
                    "description": "The tax rates that will apply to any line item that does not have `tax_rates` set.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.",
                    "maxLength": 1500,
                    "type": "string"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts."
                  },
                  "due_date": {
                    "description": "The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "effective_at": {
                    "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "footer": {
                    "description": "Footer to be displayed on the invoice.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "from_invoice": {
                    "description": "Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.",
                    "properties": {
                      "action": {
                        "enum": ["revision"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "invoice": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["action", "invoice"],
                    "title": "from_invoice",
                    "type": "object"
                  },
                  "issuer": {
                    "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
                    "properties": {
                      "account": {
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "self"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "number": {
                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.",
                    "maxLength": 26,
                    "type": "string"
                  },
                  "on_behalf_of": {
                    "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.",
                    "type": "string"
                  },
                  "payment_settings": {
                    "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.",
                    "properties": {
                      "default_mandate": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "installments": {
                                    "properties": {
                                      "enabled": {
                                        "type": "boolean"
                                      },
                                      "plan": {
                                        "anyOf": [
                                          {
                                            "properties": {
                                              "count": {
                                                "type": "integer"
                                              },
                                              "interval": {
                                                "enum": ["month"],
                                                "type": "string"
                                              },
                                              "type": {
                                                "enum": ["fixed_count"],
                                                "type": "string",
                                                "x-stripeBypassValidation": true
                                              }
                                            },
                                            "required": ["type"],
                                            "title": "installment_plan",
                                            "type": "object"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      }
                                    },
                                    "title": "installments_param",
                                    "type": "object"
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "pending_invoice_items_behavior": {
                    "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.",
                    "enum": ["exclude", "include"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "rendering": {
                    "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
                    "properties": {
                      "amount_tax_display": {
                        "enum": ["", "exclude_tax", "include_inclusive_tax"],
                        "type": "string"
                      },
                      "pdf": {
                        "properties": {
                          "page_size": {
                            "enum": ["a4", "auto", "letter"],
                            "type": "string"
                          }
                        },
                        "title": "rendering_pdf_param",
                        "type": "object"
                      },
                      "template": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "template_version": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "rendering_param",
                    "type": "object"
                  },
                  "shipping_cost": {
                    "description": "Settings for the cost of shipping for this invoice.",
                    "properties": {
                      "shipping_rate": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "shipping_rate_data": {
                        "properties": {
                          "delivery_estimate": {
                            "properties": {
                              "maximum": {
                                "properties": {
                                  "unit": {
                                    "enum": [
                                      "business_day",
                                      "day",
                                      "hour",
                                      "month",
                                      "week"
                                    ],
                                    "type": "string"
                                  },
                                  "value": {
                                    "type": "integer"
                                  }
                                },
                                "required": ["unit", "value"],
                                "title": "delivery_estimate_bound",
                                "type": "object"
                              },
                              "minimum": {
                                "properties": {
                                  "unit": {
                                    "enum": [
                                      "business_day",
                                      "day",
                                      "hour",
                                      "month",
                                      "week"
                                    ],
                                    "type": "string"
                                  },
                                  "value": {
                                    "type": "integer"
                                  }
                                },
                                "required": ["unit", "value"],
                                "title": "delivery_estimate_bound",
                                "type": "object"
                              }
                            },
                            "title": "delivery_estimate",
                            "type": "object"
                          },
                          "display_name": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "fixed_amount": {
                            "properties": {
                              "amount": {
                                "type": "integer"
                              },
                              "currency": {
                                "format": "currency",
                                "type": "string"
                              },
                              "currency_options": {
                                "additionalProperties": {
                                  "properties": {
                                    "amount": {
                                      "type": "integer"
                                    },
                                    "tax_behavior": {
                                      "enum": [
                                        "exclusive",
                                        "inclusive",
                                        "unspecified"
                                      ],
                                      "type": "string"
                                    }
                                  },
                                  "required": ["amount"],
                                  "title": "currency_option",
                                  "type": "object"
                                },
                                "type": "object"
                              }
                            },
                            "required": ["amount", "currency"],
                            "title": "fixed_amount",
                            "type": "object"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "tax_behavior": {
                            "enum": ["exclusive", "inclusive", "unspecified"],
                            "type": "string"
                          },
                          "tax_code": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["fixed_amount"],
                            "type": "string"
                          }
                        },
                        "required": ["display_name"],
                        "title": "method_params",
                        "type": "object"
                      }
                    },
                    "title": "shipping_cost",
                    "type": "object"
                  },
                  "shipping_details": {
                    "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_address",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "required": ["address", "name"],
                    "title": "recipient_shipping_with_optional_fields_address",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "subscription": {
                    "description": "The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "destination": {
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an invoice"
      }
    },
    "/v1/invoices/create_preview": {
      "post": {
        "description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_details.proration_date</code> value passed in the request. </p>\n\n<p>Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. <a href=\"https://docs.stripe.com/currencies/conversions\">Learn more</a></p>",
        "operationId": "PostInvoicesCreatePreview",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "customer_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "issuer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "schedule_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this invoice preview.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_param",
                    "type": "object"
                  },
                  "coupon": {
                    "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer_details": {
                    "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
                    "properties": {
                      "address": {
                        "anyOf": [
                          {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_address",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "shipping": {
                        "anyOf": [
                          {
                            "properties": {
                              "address": {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "optional_fields_customer_address",
                                "type": "object"
                              },
                              "name": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "phone": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["address", "name"],
                            "title": "customer_shipping",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "tax": {
                        "properties": {
                          "ip_address": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "tax_param",
                        "type": "object"
                      },
                      "tax_exempt": {
                        "enum": ["", "exempt", "none", "reverse"],
                        "type": "string"
                      },
                      "tax_ids": {
                        "items": {
                          "properties": {
                            "type": {
                              "enum": [
                                "ad_nrt",
                                "ae_trn",
                                "al_tin",
                                "am_tin",
                                "ao_tin",
                                "ar_cuit",
                                "au_abn",
                                "au_arn",
                                "ba_tin",
                                "bb_tin",
                                "bg_uic",
                                "bh_vat",
                                "bo_tin",
                                "br_cnpj",
                                "br_cpf",
                                "bs_tin",
                                "by_tin",
                                "ca_bn",
                                "ca_gst_hst",
                                "ca_pst_bc",
                                "ca_pst_mb",
                                "ca_pst_sk",
                                "ca_qst",
                                "cd_nif",
                                "ch_uid",
                                "ch_vat",
                                "cl_tin",
                                "cn_tin",
                                "co_nit",
                                "cr_tin",
                                "de_stn",
                                "do_rcn",
                                "ec_ruc",
                                "eg_tin",
                                "es_cif",
                                "eu_oss_vat",
                                "eu_vat",
                                "gb_vat",
                                "ge_vat",
                                "gn_nif",
                                "hk_br",
                                "hr_oib",
                                "hu_tin",
                                "id_npwp",
                                "il_vat",
                                "in_gst",
                                "is_vat",
                                "jp_cn",
                                "jp_rn",
                                "jp_trn",
                                "ke_pin",
                                "kh_tin",
                                "kr_brn",
                                "kz_bin",
                                "li_uid",
                                "li_vat",
                                "ma_vat",
                                "md_vat",
                                "me_pib",
                                "mk_vat",
                                "mr_nif",
                                "mx_rfc",
                                "my_frp",
                                "my_itn",
                                "my_sst",
                                "ng_tin",
                                "no_vat",
                                "no_voec",
                                "np_pan",
                                "nz_gst",
                                "om_vat",
                                "pe_ruc",
                                "ph_tin",
                                "ro_tin",
                                "rs_pib",
                                "ru_inn",
                                "ru_kpp",
                                "sa_vat",
                                "sg_gst",
                                "sg_uen",
                                "si_tin",
                                "sn_ninea",
                                "sr_fin",
                                "sv_nit",
                                "th_vat",
                                "tj_tin",
                                "tr_tin",
                                "tw_vat",
                                "tz_vat",
                                "ua_vat",
                                "ug_tin",
                                "us_ein",
                                "uy_ruc",
                                "uz_tin",
                                "uz_vat",
                                "ve_rif",
                                "vn_tin",
                                "za_vat",
                                "zm_tin",
                                "zw_tin"
                              ],
                              "maxLength": 5000,
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "value": {
                              "type": "string"
                            }
                          },
                          "required": ["type", "value"],
                          "title": "data_params",
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "title": "customer_details_param",
                    "type": "object"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_items": {
                    "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "currency": {
                          "format": "currency",
                          "type": "string"
                        },
                        "description": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "discountable": {
                          "type": "boolean"
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "invoiceitem": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "metadata": {
                          "anyOf": [
                            {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "period": {
                          "properties": {
                            "end": {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            "start": {
                              "format": "unix-time",
                              "type": "integer"
                            }
                          },
                          "required": ["end", "start"],
                          "title": "period",
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "one_time_price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_behavior": {
                          "enum": ["exclusive", "inclusive", "unspecified"],
                          "type": "string"
                        },
                        "tax_code": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "unit_amount": {
                          "type": "integer"
                        },
                        "unit_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        }
                      },
                      "title": "invoice_item_preview_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "issuer": {
                    "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
                    "properties": {
                      "account": {
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "self"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "param",
                    "type": "object"
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details."
                  },
                  "preview_mode": {
                    "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
                    "enum": ["next", "recurring"],
                    "type": "string"
                  },
                  "schedule": {
                    "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "schedule_details": {
                    "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.",
                    "properties": {
                      "end_behavior": {
                        "enum": ["cancel", "release"],
                        "type": "string"
                      },
                      "phases": {
                        "items": {
                          "properties": {
                            "add_invoice_items": {
                              "items": {
                                "properties": {
                                  "discounts": {
                                    "items": {
                                      "properties": {
                                        "coupon": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "discount": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "promotion_code": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        }
                                      },
                                      "title": "discounts_data_param",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  },
                                  "price": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "price_data": {
                                    "properties": {
                                      "currency": {
                                        "format": "currency",
                                        "type": "string"
                                      },
                                      "product": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "tax_behavior": {
                                        "enum": [
                                          "exclusive",
                                          "inclusive",
                                          "unspecified"
                                        ],
                                        "type": "string"
                                      },
                                      "unit_amount": {
                                        "type": "integer"
                                      },
                                      "unit_amount_decimal": {
                                        "format": "decimal",
                                        "type": "string"
                                      }
                                    },
                                    "required": ["currency", "product"],
                                    "title": "one_time_price_data_with_negative_amounts",
                                    "type": "object"
                                  },
                                  "quantity": {
                                    "type": "integer"
                                  },
                                  "tax_rates": {
                                    "anyOf": [
                                      {
                                        "items": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "type": "array"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "add_invoice_item_entry",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "application_fee_percent": {
                              "type": "number"
                            },
                            "automatic_tax": {
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                },
                                "liability": {
                                  "properties": {
                                    "account": {
                                      "type": "string"
                                    },
                                    "type": {
                                      "enum": ["account", "self"],
                                      "type": "string"
                                    }
                                  },
                                  "required": ["type"],
                                  "title": "param",
                                  "type": "object"
                                }
                              },
                              "required": ["enabled"],
                              "title": "automatic_tax_config",
                              "type": "object"
                            },
                            "billing_cycle_anchor": {
                              "enum": ["automatic", "phase_start"],
                              "type": "string"
                            },
                            "billing_thresholds": {
                              "anyOf": [
                                {
                                  "properties": {
                                    "amount_gte": {
                                      "type": "integer"
                                    },
                                    "reset_billing_cycle_anchor": {
                                      "type": "boolean"
                                    }
                                  },
                                  "title": "billing_thresholds_param",
                                  "type": "object"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "collection_method": {
                              "enum": ["charge_automatically", "send_invoice"],
                              "type": "string"
                            },
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "default_payment_method": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "default_tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "description": {
                              "anyOf": [
                                {
                                  "maxLength": 500,
                                  "type": "string"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "discounts": {
                              "anyOf": [
                                {
                                  "items": {
                                    "properties": {
                                      "coupon": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "discount": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "promotion_code": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "title": "discounts_data_param",
                                    "type": "object"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "end_date": {
                              "anyOf": [
                                {
                                  "format": "unix-time",
                                  "type": "integer"
                                },
                                {
                                  "enum": ["now"],
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              ]
                            },
                            "invoice_settings": {
                              "properties": {
                                "account_tax_ids": {
                                  "anyOf": [
                                    {
                                      "items": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "type": "array"
                                    },
                                    {
                                      "enum": [""],
                                      "type": "string"
                                    }
                                  ]
                                },
                                "days_until_due": {
                                  "type": "integer"
                                },
                                "issuer": {
                                  "properties": {
                                    "account": {
                                      "type": "string"
                                    },
                                    "type": {
                                      "enum": ["account", "self"],
                                      "type": "string"
                                    }
                                  },
                                  "required": ["type"],
                                  "title": "param",
                                  "type": "object"
                                }
                              },
                              "title": "invoice_settings",
                              "type": "object"
                            },
                            "items": {
                              "items": {
                                "properties": {
                                  "billing_thresholds": {
                                    "anyOf": [
                                      {
                                        "properties": {
                                          "usage_gte": {
                                            "type": "integer"
                                          }
                                        },
                                        "required": ["usage_gte"],
                                        "title": "item_billing_thresholds_param",
                                        "type": "object"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  },
                                  "discounts": {
                                    "anyOf": [
                                      {
                                        "items": {
                                          "properties": {
                                            "coupon": {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            "discount": {
                                              "maxLength": 5000,
                                              "type": "string"
                                            },
                                            "promotion_code": {
                                              "maxLength": 5000,
                                              "type": "string"
                                            }
                                          },
                                          "title": "discounts_data_param",
                                          "type": "object"
                                        },
                                        "type": "array"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  },
                                  "metadata": {
                                    "additionalProperties": {
                                      "type": "string"
                                    },
                                    "type": "object"
                                  },
                                  "price": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "price_data": {
                                    "properties": {
                                      "currency": {
                                        "format": "currency",
                                        "type": "string"
                                      },
                                      "product": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "recurring": {
                                        "properties": {
                                          "interval": {
                                            "enum": [
                                              "day",
                                              "month",
                                              "week",
                                              "year"
                                            ],
                                            "type": "string"
                                          },
                                          "interval_count": {
                                            "type": "integer"
                                          }
                                        },
                                        "required": ["interval"],
                                        "title": "recurring_adhoc",
                                        "type": "object"
                                      },
                                      "tax_behavior": {
                                        "enum": [
                                          "exclusive",
                                          "inclusive",
                                          "unspecified"
                                        ],
                                        "type": "string"
                                      },
                                      "unit_amount": {
                                        "type": "integer"
                                      },
                                      "unit_amount_decimal": {
                                        "format": "decimal",
                                        "type": "string"
                                      }
                                    },
                                    "required": [
                                      "currency",
                                      "product",
                                      "recurring"
                                    ],
                                    "title": "recurring_price_data",
                                    "type": "object"
                                  },
                                  "quantity": {
                                    "type": "integer"
                                  },
                                  "tax_rates": {
                                    "anyOf": [
                                      {
                                        "items": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "type": "array"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "configuration_item_params",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "iterations": {
                              "type": "integer"
                            },
                            "metadata": {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            "on_behalf_of": {
                              "type": "string"
                            },
                            "proration_behavior": {
                              "enum": [
                                "always_invoice",
                                "create_prorations",
                                "none"
                              ],
                              "type": "string"
                            },
                            "start_date": {
                              "anyOf": [
                                {
                                  "format": "unix-time",
                                  "type": "integer"
                                },
                                {
                                  "enum": ["now"],
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              ]
                            },
                            "transfer_data": {
                              "properties": {
                                "amount_percent": {
                                  "type": "number"
                                },
                                "destination": {
                                  "type": "string"
                                }
                              },
                              "required": ["destination"],
                              "title": "transfer_data_specs",
                              "type": "object"
                            },
                            "trial": {
                              "type": "boolean"
                            },
                            "trial_end": {
                              "anyOf": [
                                {
                                  "format": "unix-time",
                                  "type": "integer"
                                },
                                {
                                  "enum": ["now"],
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "required": ["items"],
                          "title": "phase_configuration_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "proration_behavior": {
                        "enum": ["always_invoice", "create_prorations", "none"],
                        "type": "string"
                      }
                    },
                    "title": "schedule_details_params",
                    "type": "object"
                  },
                  "subscription": {
                    "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "subscription_details": {
                    "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.",
                    "properties": {
                      "billing_cycle_anchor": {
                        "anyOf": [
                          {
                            "enum": ["now", "unchanged"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "format": "unix-time",
                            "type": "integer"
                          }
                        ]
                      },
                      "cancel_at": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "cancel_at_period_end": {
                        "type": "boolean"
                      },
                      "cancel_now": {
                        "type": "boolean"
                      },
                      "default_tax_rates": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "items": {
                        "items": {
                          "properties": {
                            "billing_thresholds": {
                              "anyOf": [
                                {
                                  "properties": {
                                    "usage_gte": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["usage_gte"],
                                  "title": "item_billing_thresholds_param",
                                  "type": "object"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "clear_usage": {
                              "type": "boolean"
                            },
                            "deleted": {
                              "type": "boolean"
                            },
                            "discounts": {
                              "anyOf": [
                                {
                                  "items": {
                                    "properties": {
                                      "coupon": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "discount": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "promotion_code": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "title": "discounts_data_param",
                                    "type": "object"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "id": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "metadata": {
                              "anyOf": [
                                {
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "type": "object"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "price": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "price_data": {
                              "properties": {
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "product": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "recurring": {
                                  "properties": {
                                    "interval": {
                                      "enum": ["day", "month", "week", "year"],
                                      "type": "string"
                                    },
                                    "interval_count": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["interval"],
                                  "title": "recurring_adhoc",
                                  "type": "object"
                                },
                                "tax_behavior": {
                                  "enum": [
                                    "exclusive",
                                    "inclusive",
                                    "unspecified"
                                  ],
                                  "type": "string"
                                },
                                "unit_amount": {
                                  "type": "integer"
                                },
                                "unit_amount_decimal": {
                                  "format": "decimal",
                                  "type": "string"
                                }
                              },
                              "required": ["currency", "product", "recurring"],
                              "title": "recurring_price_data",
                              "type": "object"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "title": "subscription_item_update_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "proration_behavior": {
                        "enum": ["always_invoice", "create_prorations", "none"],
                        "type": "string"
                      },
                      "proration_date": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "resume_at": {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "start_date": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "trial_end": {
                        "anyOf": [
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "format": "unix-time",
                            "type": "integer"
                          }
                        ]
                      }
                    },
                    "title": "subscription_details_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a preview invoice"
      }
    },
    "/v1/invoices/search": {
      "get": {
        "description": "<p>Search for invoices you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetInvoicesSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/invoice"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search invoices"
      }
    },
    "/v1/invoices/upcoming": {
      "get": {
        "description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_details.proration_date</code> value passed in the request.</p>\n\n<p>Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. <a href=\"https://docs.stripe.com/currencies/conversions\">Learn more</a></p>",
        "operationId": "GetInvoicesUpcoming",
        "parameters": [
          {
            "description": "Settings for automatic tax lookup for this invoice preview.",
            "explode": true,
            "in": "query",
            "name": "automatic_tax",
            "required": false,
            "schema": {
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "liability": {
                  "properties": {
                    "account": {
                      "type": "string"
                    },
                    "type": {
                      "enum": ["account", "self"],
                      "type": "string"
                    }
                  },
                  "required": ["type"],
                  "title": "param",
                  "type": "object"
                }
              },
              "required": ["enabled"],
              "title": "automatic_tax_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
            "in": "query",
            "name": "coupon",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
            "explode": true,
            "in": "query",
            "name": "customer_details",
            "required": false,
            "schema": {
              "properties": {
                "address": {
                  "anyOf": [
                    {
                      "properties": {
                        "city": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "country": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "line1": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "line2": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "postal_code": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "state": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "title": "optional_fields_address",
                      "type": "object"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "shipping": {
                  "anyOf": [
                    {
                      "properties": {
                        "address": {
                          "properties": {
                            "city": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "country": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "line1": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "line2": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "postal_code": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "state": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "optional_fields_customer_address",
                          "type": "object"
                        },
                        "name": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "phone": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "required": ["address", "name"],
                      "title": "customer_shipping",
                      "type": "object"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "tax": {
                  "properties": {
                    "ip_address": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "enum": [""],
                          "type": "string"
                        }
                      ]
                    }
                  },
                  "title": "tax_param",
                  "type": "object"
                },
                "tax_exempt": {
                  "enum": ["", "exempt", "none", "reverse"],
                  "type": "string"
                },
                "tax_ids": {
                  "items": {
                    "properties": {
                      "type": {
                        "enum": [
                          "ad_nrt",
                          "ae_trn",
                          "al_tin",
                          "am_tin",
                          "ao_tin",
                          "ar_cuit",
                          "au_abn",
                          "au_arn",
                          "ba_tin",
                          "bb_tin",
                          "bg_uic",
                          "bh_vat",
                          "bo_tin",
                          "br_cnpj",
                          "br_cpf",
                          "bs_tin",
                          "by_tin",
                          "ca_bn",
                          "ca_gst_hst",
                          "ca_pst_bc",
                          "ca_pst_mb",
                          "ca_pst_sk",
                          "ca_qst",
                          "cd_nif",
                          "ch_uid",
                          "ch_vat",
                          "cl_tin",
                          "cn_tin",
                          "co_nit",
                          "cr_tin",
                          "de_stn",
                          "do_rcn",
                          "ec_ruc",
                          "eg_tin",
                          "es_cif",
                          "eu_oss_vat",
                          "eu_vat",
                          "gb_vat",
                          "ge_vat",
                          "gn_nif",
                          "hk_br",
                          "hr_oib",
                          "hu_tin",
                          "id_npwp",
                          "il_vat",
                          "in_gst",
                          "is_vat",
                          "jp_cn",
                          "jp_rn",
                          "jp_trn",
                          "ke_pin",
                          "kh_tin",
                          "kr_brn",
                          "kz_bin",
                          "li_uid",
                          "li_vat",
                          "ma_vat",
                          "md_vat",
                          "me_pib",
                          "mk_vat",
                          "mr_nif",
                          "mx_rfc",
                          "my_frp",
                          "my_itn",
                          "my_sst",
                          "ng_tin",
                          "no_vat",
                          "no_voec",
                          "np_pan",
                          "nz_gst",
                          "om_vat",
                          "pe_ruc",
                          "ph_tin",
                          "ro_tin",
                          "rs_pib",
                          "ru_inn",
                          "ru_kpp",
                          "sa_vat",
                          "sg_gst",
                          "sg_uen",
                          "si_tin",
                          "sn_ninea",
                          "sr_fin",
                          "sv_nit",
                          "th_vat",
                          "tj_tin",
                          "tr_tin",
                          "tw_vat",
                          "tz_vat",
                          "ua_vat",
                          "ug_tin",
                          "us_ein",
                          "uy_ruc",
                          "uz_tin",
                          "uz_vat",
                          "ve_rif",
                          "vn_tin",
                          "za_vat",
                          "zm_tin",
                          "zw_tin"
                        ],
                        "maxLength": 5000,
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "value"],
                    "title": "data_params",
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "title": "customer_details_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.",
            "explode": true,
            "in": "query",
            "name": "discounts",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "properties": {
                      "coupon": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "discount": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "promotion_code": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "discounts_data_param",
                    "type": "object"
                  },
                  "type": "array"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
            "explode": true,
            "in": "query",
            "name": "invoice_items",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "currency": {
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "discountable": {
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "invoiceitem": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "period": {
                    "properties": {
                      "end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "start": {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    },
                    "required": ["end", "start"],
                    "title": "period",
                    "type": "object"
                  },
                  "price": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product"],
                    "title": "one_time_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_behavior": {
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tax_code": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "unit_amount": {
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "title": "invoice_item_preview_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
            "explode": true,
            "in": "query",
            "name": "issuer",
            "required": false,
            "schema": {
              "properties": {
                "account": {
                  "type": "string"
                },
                "type": {
                  "enum": ["account", "self"],
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.",
            "explode": true,
            "in": "query",
            "name": "on_behalf_of",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
            "in": "query",
            "name": "preview_mode",
            "required": false,
            "schema": {
              "enum": ["next", "recurring"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
            "in": "query",
            "name": "schedule",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.",
            "explode": true,
            "in": "query",
            "name": "schedule_details",
            "required": false,
            "schema": {
              "properties": {
                "end_behavior": {
                  "enum": ["cancel", "release"],
                  "type": "string"
                },
                "phases": {
                  "items": {
                    "properties": {
                      "add_invoice_items": {
                        "items": {
                          "properties": {
                            "discounts": {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "price": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "price_data": {
                              "properties": {
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "product": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_behavior": {
                                  "enum": [
                                    "exclusive",
                                    "inclusive",
                                    "unspecified"
                                  ],
                                  "type": "string"
                                },
                                "unit_amount": {
                                  "type": "integer"
                                },
                                "unit_amount_decimal": {
                                  "format": "decimal",
                                  "type": "string"
                                }
                              },
                              "required": ["currency", "product"],
                              "title": "one_time_price_data_with_negative_amounts",
                              "type": "object"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "title": "add_invoice_item_entry",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "application_fee_percent": {
                        "type": "number"
                      },
                      "automatic_tax": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "liability": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "automatic_tax_config",
                        "type": "object"
                      },
                      "billing_cycle_anchor": {
                        "enum": ["automatic", "phase_start"],
                        "type": "string"
                      },
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_gte": {
                                "type": "integer"
                              },
                              "reset_billing_cycle_anchor": {
                                "type": "boolean"
                              }
                            },
                            "title": "billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "collection_method": {
                        "enum": ["charge_automatically", "send_invoice"],
                        "type": "string"
                      },
                      "coupon": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "default_tax_rates": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 500,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "discounts": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "coupon": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "discount": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "promotion_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "title": "discounts_data_param",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "end_date": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      },
                      "invoice_settings": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "days_until_due": {
                            "type": "integer"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "invoice_settings",
                        "type": "object"
                      },
                      "items": {
                        "items": {
                          "properties": {
                            "billing_thresholds": {
                              "anyOf": [
                                {
                                  "properties": {
                                    "usage_gte": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["usage_gte"],
                                  "title": "item_billing_thresholds_param",
                                  "type": "object"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "discounts": {
                              "anyOf": [
                                {
                                  "items": {
                                    "properties": {
                                      "coupon": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "discount": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "promotion_code": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "title": "discounts_data_param",
                                    "type": "object"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "metadata": {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            "price": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "price_data": {
                              "properties": {
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "product": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "recurring": {
                                  "properties": {
                                    "interval": {
                                      "enum": ["day", "month", "week", "year"],
                                      "type": "string"
                                    },
                                    "interval_count": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["interval"],
                                  "title": "recurring_adhoc",
                                  "type": "object"
                                },
                                "tax_behavior": {
                                  "enum": [
                                    "exclusive",
                                    "inclusive",
                                    "unspecified"
                                  ],
                                  "type": "string"
                                },
                                "unit_amount": {
                                  "type": "integer"
                                },
                                "unit_amount_decimal": {
                                  "format": "decimal",
                                  "type": "string"
                                }
                              },
                              "required": ["currency", "product", "recurring"],
                              "title": "recurring_price_data",
                              "type": "object"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "title": "configuration_item_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "iterations": {
                        "type": "integer"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "type": "string"
                      },
                      "proration_behavior": {
                        "enum": ["always_invoice", "create_prorations", "none"],
                        "type": "string"
                      },
                      "start_date": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      },
                      "transfer_data": {
                        "properties": {
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      "trial": {
                        "type": "boolean"
                      },
                      "trial_end": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "required": ["items"],
                    "title": "phase_configuration_params",
                    "type": "object"
                  },
                  "type": "array"
                },
                "proration_behavior": {
                  "enum": ["always_invoice", "create_prorations", "none"],
                  "type": "string"
                }
              },
              "title": "schedule_details_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.",
            "in": "query",
            "name": "subscription",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_billing_cycle_anchor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": ["now", "unchanged"],
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "format": "unix-time",
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_cancel_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "unix-time",
                  "type": "integer"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
            "in": "query",
            "name": "subscription_cancel_at_period_end",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.",
            "in": "query",
            "name": "subscription_cancel_now",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_default_tax_rates",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.",
            "explode": true,
            "in": "query",
            "name": "subscription_details",
            "required": false,
            "schema": {
              "properties": {
                "billing_cycle_anchor": {
                  "anyOf": [
                    {
                      "enum": ["now", "unchanged"],
                      "maxLength": 5000,
                      "type": "string"
                    },
                    {
                      "format": "unix-time",
                      "type": "integer"
                    }
                  ]
                },
                "cancel_at": {
                  "anyOf": [
                    {
                      "format": "unix-time",
                      "type": "integer"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "cancel_at_period_end": {
                  "type": "boolean"
                },
                "cancel_now": {
                  "type": "boolean"
                },
                "default_tax_rates": {
                  "anyOf": [
                    {
                      "items": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": "array"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "items": {
                  "items": {
                    "properties": {
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "usage_gte": {
                                "type": "integer"
                              }
                            },
                            "required": ["usage_gte"],
                            "title": "item_billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "clear_usage": {
                        "type": "boolean"
                      },
                      "deleted": {
                        "type": "boolean"
                      },
                      "discounts": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "coupon": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "discount": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "promotion_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "title": "discounts_data_param",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "price": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "price_data": {
                        "properties": {
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "product": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "recurring": {
                            "properties": {
                              "interval": {
                                "enum": ["day", "month", "week", "year"],
                                "type": "string"
                              },
                              "interval_count": {
                                "type": "integer"
                              }
                            },
                            "required": ["interval"],
                            "title": "recurring_adhoc",
                            "type": "object"
                          },
                          "tax_behavior": {
                            "enum": ["exclusive", "inclusive", "unspecified"],
                            "type": "string"
                          },
                          "unit_amount": {
                            "type": "integer"
                          },
                          "unit_amount_decimal": {
                            "format": "decimal",
                            "type": "string"
                          }
                        },
                        "required": ["currency", "product", "recurring"],
                        "title": "recurring_price_data",
                        "type": "object"
                      },
                      "quantity": {
                        "type": "integer"
                      },
                      "tax_rates": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "subscription_item_update_params",
                    "type": "object"
                  },
                  "type": "array"
                },
                "proration_behavior": {
                  "enum": ["always_invoice", "create_prorations", "none"],
                  "type": "string"
                },
                "proration_date": {
                  "format": "unix-time",
                  "type": "integer"
                },
                "resume_at": {
                  "enum": ["now"],
                  "maxLength": 5000,
                  "type": "string"
                },
                "start_date": {
                  "format": "unix-time",
                  "type": "integer"
                },
                "trial_end": {
                  "anyOf": [
                    {
                      "enum": ["now"],
                      "maxLength": 5000,
                      "type": "string"
                    },
                    {
                      "format": "unix-time",
                      "type": "integer"
                    }
                  ]
                }
              },
              "title": "subscription_details_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_items",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "usage_gte": {
                            "type": "integer"
                          }
                        },
                        "required": ["usage_gte"],
                        "title": "item_billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "clear_usage": {
                    "type": "boolean"
                  },
                  "deleted": {
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "id": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "price": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "recurring": {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "recurring_adhoc",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product", "recurring"],
                    "title": "recurring_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  }
                },
                "title": "subscription_item_update_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.",
            "in": "query",
            "name": "subscription_proration_behavior",
            "required": false,
            "schema": {
              "enum": ["always_invoice", "create_prorations", "none"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.",
            "in": "query",
            "name": "subscription_proration_date",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.",
            "in": "query",
            "name": "subscription_resume_at",
            "required": false,
            "schema": {
              "enum": ["now"],
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.",
            "in": "query",
            "name": "subscription_start_date",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_trial_end",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": ["now"],
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "format": "unix-time",
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an upcoming invoice"
      }
    },
    "/v1/invoices/upcoming/lines": {
      "get": {
        "description": "<p>When retrieving an upcoming invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetInvoicesUpcomingLines",
        "parameters": [
          {
            "description": "Settings for automatic tax lookup for this invoice preview.",
            "explode": true,
            "in": "query",
            "name": "automatic_tax",
            "required": false,
            "schema": {
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "liability": {
                  "properties": {
                    "account": {
                      "type": "string"
                    },
                    "type": {
                      "enum": ["account", "self"],
                      "type": "string"
                    }
                  },
                  "required": ["type"],
                  "title": "param",
                  "type": "object"
                }
              },
              "required": ["enabled"],
              "title": "automatic_tax_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
            "in": "query",
            "name": "coupon",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
            "explode": true,
            "in": "query",
            "name": "customer_details",
            "required": false,
            "schema": {
              "properties": {
                "address": {
                  "anyOf": [
                    {
                      "properties": {
                        "city": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "country": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "line1": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "line2": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "postal_code": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "state": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "title": "optional_fields_address",
                      "type": "object"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "shipping": {
                  "anyOf": [
                    {
                      "properties": {
                        "address": {
                          "properties": {
                            "city": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "country": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "line1": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "line2": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "postal_code": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "state": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "optional_fields_customer_address",
                          "type": "object"
                        },
                        "name": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "phone": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "required": ["address", "name"],
                      "title": "customer_shipping",
                      "type": "object"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "tax": {
                  "properties": {
                    "ip_address": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "enum": [""],
                          "type": "string"
                        }
                      ]
                    }
                  },
                  "title": "tax_param",
                  "type": "object"
                },
                "tax_exempt": {
                  "enum": ["", "exempt", "none", "reverse"],
                  "type": "string"
                },
                "tax_ids": {
                  "items": {
                    "properties": {
                      "type": {
                        "enum": [
                          "ad_nrt",
                          "ae_trn",
                          "al_tin",
                          "am_tin",
                          "ao_tin",
                          "ar_cuit",
                          "au_abn",
                          "au_arn",
                          "ba_tin",
                          "bb_tin",
                          "bg_uic",
                          "bh_vat",
                          "bo_tin",
                          "br_cnpj",
                          "br_cpf",
                          "bs_tin",
                          "by_tin",
                          "ca_bn",
                          "ca_gst_hst",
                          "ca_pst_bc",
                          "ca_pst_mb",
                          "ca_pst_sk",
                          "ca_qst",
                          "cd_nif",
                          "ch_uid",
                          "ch_vat",
                          "cl_tin",
                          "cn_tin",
                          "co_nit",
                          "cr_tin",
                          "de_stn",
                          "do_rcn",
                          "ec_ruc",
                          "eg_tin",
                          "es_cif",
                          "eu_oss_vat",
                          "eu_vat",
                          "gb_vat",
                          "ge_vat",
                          "gn_nif",
                          "hk_br",
                          "hr_oib",
                          "hu_tin",
                          "id_npwp",
                          "il_vat",
                          "in_gst",
                          "is_vat",
                          "jp_cn",
                          "jp_rn",
                          "jp_trn",
                          "ke_pin",
                          "kh_tin",
                          "kr_brn",
                          "kz_bin",
                          "li_uid",
                          "li_vat",
                          "ma_vat",
                          "md_vat",
                          "me_pib",
                          "mk_vat",
                          "mr_nif",
                          "mx_rfc",
                          "my_frp",
                          "my_itn",
                          "my_sst",
                          "ng_tin",
                          "no_vat",
                          "no_voec",
                          "np_pan",
                          "nz_gst",
                          "om_vat",
                          "pe_ruc",
                          "ph_tin",
                          "ro_tin",
                          "rs_pib",
                          "ru_inn",
                          "ru_kpp",
                          "sa_vat",
                          "sg_gst",
                          "sg_uen",
                          "si_tin",
                          "sn_ninea",
                          "sr_fin",
                          "sv_nit",
                          "th_vat",
                          "tj_tin",
                          "tr_tin",
                          "tw_vat",
                          "tz_vat",
                          "ua_vat",
                          "ug_tin",
                          "us_ein",
                          "uy_ruc",
                          "uz_tin",
                          "uz_vat",
                          "ve_rif",
                          "vn_tin",
                          "za_vat",
                          "zm_tin",
                          "zw_tin"
                        ],
                        "maxLength": 5000,
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "value"],
                    "title": "data_params",
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "title": "customer_details_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.",
            "explode": true,
            "in": "query",
            "name": "discounts",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "properties": {
                      "coupon": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "discount": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "promotion_code": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "discounts_data_param",
                    "type": "object"
                  },
                  "type": "array"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "List of invoice items to add or update in the upcoming invoice preview (up to 250).",
            "explode": true,
            "in": "query",
            "name": "invoice_items",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "currency": {
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "discountable": {
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "invoiceitem": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "period": {
                    "properties": {
                      "end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "start": {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    },
                    "required": ["end", "start"],
                    "title": "period",
                    "type": "object"
                  },
                  "price": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product"],
                    "title": "one_time_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_behavior": {
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tax_code": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "unit_amount": {
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "title": "invoice_item_preview_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
            "explode": true,
            "in": "query",
            "name": "issuer",
            "required": false,
            "schema": {
              "properties": {
                "account": {
                  "type": "string"
                },
                "type": {
                  "enum": ["account", "self"],
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.",
            "explode": true,
            "in": "query",
            "name": "on_behalf_of",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.",
            "in": "query",
            "name": "preview_mode",
            "required": false,
            "schema": {
              "enum": ["next", "recurring"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
            "in": "query",
            "name": "schedule",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.",
            "explode": true,
            "in": "query",
            "name": "schedule_details",
            "required": false,
            "schema": {
              "properties": {
                "end_behavior": {
                  "enum": ["cancel", "release"],
                  "type": "string"
                },
                "phases": {
                  "items": {
                    "properties": {
                      "add_invoice_items": {
                        "items": {
                          "properties": {
                            "discounts": {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "price": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "price_data": {
                              "properties": {
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "product": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_behavior": {
                                  "enum": [
                                    "exclusive",
                                    "inclusive",
                                    "unspecified"
                                  ],
                                  "type": "string"
                                },
                                "unit_amount": {
                                  "type": "integer"
                                },
                                "unit_amount_decimal": {
                                  "format": "decimal",
                                  "type": "string"
                                }
                              },
                              "required": ["currency", "product"],
                              "title": "one_time_price_data_with_negative_amounts",
                              "type": "object"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "title": "add_invoice_item_entry",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "application_fee_percent": {
                        "type": "number"
                      },
                      "automatic_tax": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "liability": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "automatic_tax_config",
                        "type": "object"
                      },
                      "billing_cycle_anchor": {
                        "enum": ["automatic", "phase_start"],
                        "type": "string"
                      },
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_gte": {
                                "type": "integer"
                              },
                              "reset_billing_cycle_anchor": {
                                "type": "boolean"
                              }
                            },
                            "title": "billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "collection_method": {
                        "enum": ["charge_automatically", "send_invoice"],
                        "type": "string"
                      },
                      "coupon": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "default_tax_rates": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 500,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "discounts": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "coupon": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "discount": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "promotion_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "title": "discounts_data_param",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "end_date": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      },
                      "invoice_settings": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "days_until_due": {
                            "type": "integer"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "invoice_settings",
                        "type": "object"
                      },
                      "items": {
                        "items": {
                          "properties": {
                            "billing_thresholds": {
                              "anyOf": [
                                {
                                  "properties": {
                                    "usage_gte": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["usage_gte"],
                                  "title": "item_billing_thresholds_param",
                                  "type": "object"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "discounts": {
                              "anyOf": [
                                {
                                  "items": {
                                    "properties": {
                                      "coupon": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "discount": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "promotion_code": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "title": "discounts_data_param",
                                    "type": "object"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "metadata": {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            "price": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "price_data": {
                              "properties": {
                                "currency": {
                                  "format": "currency",
                                  "type": "string"
                                },
                                "product": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "recurring": {
                                  "properties": {
                                    "interval": {
                                      "enum": ["day", "month", "week", "year"],
                                      "type": "string"
                                    },
                                    "interval_count": {
                                      "type": "integer"
                                    }
                                  },
                                  "required": ["interval"],
                                  "title": "recurring_adhoc",
                                  "type": "object"
                                },
                                "tax_behavior": {
                                  "enum": [
                                    "exclusive",
                                    "inclusive",
                                    "unspecified"
                                  ],
                                  "type": "string"
                                },
                                "unit_amount": {
                                  "type": "integer"
                                },
                                "unit_amount_decimal": {
                                  "format": "decimal",
                                  "type": "string"
                                }
                              },
                              "required": ["currency", "product", "recurring"],
                              "title": "recurring_price_data",
                              "type": "object"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "tax_rates": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            }
                          },
                          "title": "configuration_item_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "iterations": {
                        "type": "integer"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "type": "string"
                      },
                      "proration_behavior": {
                        "enum": ["always_invoice", "create_prorations", "none"],
                        "type": "string"
                      },
                      "start_date": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      },
                      "transfer_data": {
                        "properties": {
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      "trial": {
                        "type": "boolean"
                      },
                      "trial_end": {
                        "anyOf": [
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": ["now"],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "required": ["items"],
                    "title": "phase_configuration_params",
                    "type": "object"
                  },
                  "type": "array"
                },
                "proration_behavior": {
                  "enum": ["always_invoice", "create_prorations", "none"],
                  "type": "string"
                }
              },
              "title": "schedule_details_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.",
            "in": "query",
            "name": "subscription",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_billing_cycle_anchor",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": ["now", "unchanged"],
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "format": "unix-time",
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_cancel_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "format": "unix-time",
                  "type": "integer"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.",
            "in": "query",
            "name": "subscription_cancel_at_period_end",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.",
            "in": "query",
            "name": "subscription_cancel_now",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_default_tax_rates",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "items": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.",
            "explode": true,
            "in": "query",
            "name": "subscription_details",
            "required": false,
            "schema": {
              "properties": {
                "billing_cycle_anchor": {
                  "anyOf": [
                    {
                      "enum": ["now", "unchanged"],
                      "maxLength": 5000,
                      "type": "string"
                    },
                    {
                      "format": "unix-time",
                      "type": "integer"
                    }
                  ]
                },
                "cancel_at": {
                  "anyOf": [
                    {
                      "format": "unix-time",
                      "type": "integer"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "cancel_at_period_end": {
                  "type": "boolean"
                },
                "cancel_now": {
                  "type": "boolean"
                },
                "default_tax_rates": {
                  "anyOf": [
                    {
                      "items": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": "array"
                    },
                    {
                      "enum": [""],
                      "type": "string"
                    }
                  ]
                },
                "items": {
                  "items": {
                    "properties": {
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "usage_gte": {
                                "type": "integer"
                              }
                            },
                            "required": ["usage_gte"],
                            "title": "item_billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "clear_usage": {
                        "type": "boolean"
                      },
                      "deleted": {
                        "type": "boolean"
                      },
                      "discounts": {
                        "anyOf": [
                          {
                            "items": {
                              "properties": {
                                "coupon": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "discount": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "promotion_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "title": "discounts_data_param",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "price": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "price_data": {
                        "properties": {
                          "currency": {
                            "format": "currency",
                            "type": "string"
                          },
                          "product": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "recurring": {
                            "properties": {
                              "interval": {
                                "enum": ["day", "month", "week", "year"],
                                "type": "string"
                              },
                              "interval_count": {
                                "type": "integer"
                              }
                            },
                            "required": ["interval"],
                            "title": "recurring_adhoc",
                            "type": "object"
                          },
                          "tax_behavior": {
                            "enum": ["exclusive", "inclusive", "unspecified"],
                            "type": "string"
                          },
                          "unit_amount": {
                            "type": "integer"
                          },
                          "unit_amount_decimal": {
                            "format": "decimal",
                            "type": "string"
                          }
                        },
                        "required": ["currency", "product", "recurring"],
                        "title": "recurring_price_data",
                        "type": "object"
                      },
                      "quantity": {
                        "type": "integer"
                      },
                      "tax_rates": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "subscription_item_update_params",
                    "type": "object"
                  },
                  "type": "array"
                },
                "proration_behavior": {
                  "enum": ["always_invoice", "create_prorations", "none"],
                  "type": "string"
                },
                "proration_date": {
                  "format": "unix-time",
                  "type": "integer"
                },
                "resume_at": {
                  "enum": ["now"],
                  "maxLength": 5000,
                  "type": "string"
                },
                "start_date": {
                  "format": "unix-time",
                  "type": "integer"
                },
                "trial_end": {
                  "anyOf": [
                    {
                      "enum": ["now"],
                      "maxLength": 5000,
                      "type": "string"
                    },
                    {
                      "format": "unix-time",
                      "type": "integer"
                    }
                  ]
                }
              },
              "title": "subscription_details_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_items",
            "required": false,
            "schema": {
              "items": {
                "properties": {
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "usage_gte": {
                            "type": "integer"
                          }
                        },
                        "required": ["usage_gte"],
                        "title": "item_billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "clear_usage": {
                    "type": "boolean"
                  },
                  "deleted": {
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "id": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  },
                  "price": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "recurring": {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "recurring_adhoc",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product", "recurring"],
                    "title": "recurring_price_data",
                    "type": "object"
                  },
                  "quantity": {
                    "type": "integer"
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ]
                  }
                },
                "title": "subscription_item_update_params",
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.",
            "in": "query",
            "name": "subscription_proration_behavior",
            "required": false,
            "schema": {
              "enum": ["always_invoice", "create_prorations", "none"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.",
            "in": "query",
            "name": "subscription_proration_date",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.",
            "in": "query",
            "name": "subscription_resume_at",
            "required": false,
            "schema": {
              "enum": ["now"],
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.",
            "in": "query",
            "name": "subscription_start_date",
            "required": false,
            "schema": {
              "format": "unix-time",
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.",
            "explode": true,
            "in": "query",
            "name": "subscription_trial_end",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "enum": ["now"],
                  "maxLength": 5000,
                  "type": "string"
                },
                {
                  "format": "unix-time",
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "InvoiceLinesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an upcoming invoice's line items"
      }
    },
    "/v1/invoices/{invoice}": {
      "delete": {
        "description": "<p>Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be <a href=\"#void_invoice\">voided</a>.</p>",
        "operationId": "DeleteInvoicesInvoice",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a draft invoice"
      },
      "get": {
        "description": "<p>Retrieves the invoice with the given ID.</p>",
        "operationId": "GetInvoicesInvoice",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an invoice"
      },
      "post": {
        "description": "<p>Draft invoices are fully editable. Once an invoice is <a href=\"/docs/billing/invoices/workflow#finalized\">finalized</a>,\nmonetary values, as well as <code>collection_method</code>, become uneditable.</p>\n\n<p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or <a href=\"/docs/billing/invoices/reconciliation\">automatically reconciling</a> invoices, pass\n<code>auto_advance=false</code>.</p>",
        "operationId": "PostInvoicesInvoice",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "account_tax_ids": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_fields": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_source": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "effective_at": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "issuer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "number": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "rendering": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_cost": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_tax_ids": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft."
                  },
                  "application_fee_amount": {
                    "description": "A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).",
                    "type": "integer"
                  },
                  "auto_advance": {
                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.",
                    "type": "boolean"
                  },
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this invoice.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_param",
                    "type": "object"
                  },
                  "automatically_finalizes_at": {
                    "description": "The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "custom_fields": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "name": {
                              "maxLength": 40,
                              "type": "string"
                            },
                            "value": {
                              "maxLength": 140,
                              "type": "string"
                            }
                          },
                          "required": ["name", "value"],
                          "title": "custom_field_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields."
                  },
                  "days_until_due": {
                    "description": "The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source."
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates."
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.",
                    "maxLength": 1500,
                    "type": "string"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts."
                  },
                  "due_date": {
                    "description": "The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "effective_at": {
                    "anyOf": [
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "footer": {
                    "description": "Footer to be displayed on the invoice.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "issuer": {
                    "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.",
                    "properties": {
                      "account": {
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "self"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "number": {
                    "anyOf": [
                      {
                        "maxLength": 26,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically."
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details."
                  },
                  "payment_settings": {
                    "description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.",
                    "properties": {
                      "default_mandate": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "installments": {
                                    "properties": {
                                      "enabled": {
                                        "type": "boolean"
                                      },
                                      "plan": {
                                        "anyOf": [
                                          {
                                            "properties": {
                                              "count": {
                                                "type": "integer"
                                              },
                                              "interval": {
                                                "enum": ["month"],
                                                "type": "string"
                                              },
                                              "type": {
                                                "enum": ["fixed_count"],
                                                "type": "string",
                                                "x-stripeBypassValidation": true
                                              }
                                            },
                                            "required": ["type"],
                                            "title": "installment_plan",
                                            "type": "object"
                                          },
                                          {
                                            "enum": [""],
                                            "type": "string"
                                          }
                                        ]
                                      }
                                    },
                                    "title": "installments_param",
                                    "type": "object"
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "rendering": {
                    "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
                    "properties": {
                      "amount_tax_display": {
                        "enum": ["", "exclude_tax", "include_inclusive_tax"],
                        "type": "string"
                      },
                      "pdf": {
                        "properties": {
                          "page_size": {
                            "enum": ["a4", "auto", "letter"],
                            "type": "string"
                          }
                        },
                        "title": "rendering_pdf_param",
                        "type": "object"
                      },
                      "template": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "template_version": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "rendering_param",
                    "type": "object"
                  },
                  "shipping_cost": {
                    "anyOf": [
                      {
                        "properties": {
                          "shipping_rate": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "shipping_rate_data": {
                            "properties": {
                              "delivery_estimate": {
                                "properties": {
                                  "maximum": {
                                    "properties": {
                                      "unit": {
                                        "enum": [
                                          "business_day",
                                          "day",
                                          "hour",
                                          "month",
                                          "week"
                                        ],
                                        "type": "string"
                                      },
                                      "value": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["unit", "value"],
                                    "title": "delivery_estimate_bound",
                                    "type": "object"
                                  },
                                  "minimum": {
                                    "properties": {
                                      "unit": {
                                        "enum": [
                                          "business_day",
                                          "day",
                                          "hour",
                                          "month",
                                          "week"
                                        ],
                                        "type": "string"
                                      },
                                      "value": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["unit", "value"],
                                    "title": "delivery_estimate_bound",
                                    "type": "object"
                                  }
                                },
                                "title": "delivery_estimate",
                                "type": "object"
                              },
                              "display_name": {
                                "maxLength": 100,
                                "type": "string"
                              },
                              "fixed_amount": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "currency": {
                                    "format": "currency",
                                    "type": "string"
                                  },
                                  "currency_options": {
                                    "additionalProperties": {
                                      "properties": {
                                        "amount": {
                                          "type": "integer"
                                        },
                                        "tax_behavior": {
                                          "enum": [
                                            "exclusive",
                                            "inclusive",
                                            "unspecified"
                                          ],
                                          "type": "string"
                                        }
                                      },
                                      "required": ["amount"],
                                      "title": "currency_option",
                                      "type": "object"
                                    },
                                    "type": "object"
                                  }
                                },
                                "required": ["amount", "currency"],
                                "title": "fixed_amount",
                                "type": "object"
                              },
                              "metadata": {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              "tax_behavior": {
                                "enum": [
                                  "exclusive",
                                  "inclusive",
                                  "unspecified"
                                ],
                                "type": "string"
                              },
                              "tax_code": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["fixed_amount"],
                                "type": "string"
                              }
                            },
                            "required": ["display_name"],
                            "title": "method_params",
                            "type": "object"
                          }
                        },
                        "title": "shipping_cost",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Settings for the cost of shipping for this invoice."
                  },
                  "shipping_details": {
                    "anyOf": [
                      {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_address",
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "required": ["address", "name"],
                        "title": "recipient_shipping_with_optional_fields_address",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer."
                  },
                  "statement_descriptor": {
                    "description": "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an invoice"
      }
    },
    "/v1/invoices/{invoice}/add_lines": {
      "post": {
        "description": "<p>Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.</p>",
        "operationId": "PostInvoicesInvoiceAddLines",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "lines": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "lines": {
                    "description": "The line items to add.",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "description": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "discountable": {
                          "type": "boolean"
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "invoice_item": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "metadata": {
                          "anyOf": [
                            {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "period": {
                          "properties": {
                            "end": {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            "start": {
                              "format": "unix-time",
                              "type": "integer"
                            }
                          },
                          "required": ["end", "start"],
                          "title": "period",
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "product_data": {
                              "properties": {
                                "description": {
                                  "maxLength": 40000,
                                  "type": "string"
                                },
                                "images": {
                                  "items": {
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                "metadata": {
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "type": "object"
                                },
                                "name": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "required": ["name"],
                              "title": "product_data",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency"],
                          "title": "one_time_price_data_with_product_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_amounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "tax_rate_data": {
                                    "properties": {
                                      "country": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "display_name": {
                                        "maxLength": 100,
                                        "type": "string"
                                      },
                                      "inclusive": {
                                        "type": "boolean"
                                      },
                                      "jurisdiction": {
                                        "maxLength": 200,
                                        "type": "string"
                                      },
                                      "percentage": {
                                        "type": "number"
                                      },
                                      "state": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "tax_type": {
                                        "enum": [
                                          "amusement_tax",
                                          "communications_tax",
                                          "gst",
                                          "hst",
                                          "igst",
                                          "jct",
                                          "lease_tax",
                                          "pst",
                                          "qst",
                                          "retail_delivery_fee",
                                          "rst",
                                          "sales_tax",
                                          "service_tax",
                                          "vat"
                                        ],
                                        "type": "string",
                                        "x-stripeBypassValidation": true
                                      }
                                    },
                                    "required": [
                                      "display_name",
                                      "inclusive",
                                      "percentage"
                                    ],
                                    "title": "tax_rate_data_param",
                                    "type": "object"
                                  },
                                  "taxable_amount": {
                                    "type": "integer"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "tax_rate_data",
                                  "taxable_amount"
                                ],
                                "title": "tax_amount_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "lines_data_param",
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "required": ["lines"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Bulk add invoice line items"
      }
    },
    "/v1/invoices/{invoice}/finalize": {
      "post": {
        "description": "<p>Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.</p>",
        "operationId": "PostInvoicesInvoiceFinalize",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "auto_advance": {
                    "description": "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Finalize an invoice"
      }
    },
    "/v1/invoices/{invoice}/lines": {
      "get": {
        "description": "<p>When retrieving an invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetInvoicesInvoiceLines",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "InvoiceLinesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an invoice's line items"
      }
    },
    "/v1/invoices/{invoice}/lines/{line_item_id}": {
      "post": {
        "description": "<p>Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as <code>amount</code>, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.</p>",
        "operationId": "PostInvoicesInvoiceLinesLineItemId",
        "parameters": [
          {
            "description": "Invoice ID of line item",
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Invoice line item ID",
            "in": "path",
            "name": "line_item_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "period": {
                  "explode": true,
                  "style": "deepObject"
                },
                "price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_amounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
                    "type": "integer"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "discountable": {
                    "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.",
                    "type": "boolean"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data."
                  },
                  "period": {
                    "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
                    "properties": {
                      "end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "start": {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    },
                    "required": ["end", "start"],
                    "title": "period",
                    "type": "object"
                  },
                  "price": {
                    "description": "The ID of the price object. One of `price` or `price_data` is required.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "product_data": {
                        "properties": {
                          "description": {
                            "maxLength": 40000,
                            "type": "string"
                          },
                          "images": {
                            "items": {
                              "type": "string"
                            },
                            "type": "array"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tax_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["name"],
                        "title": "product_data",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency"],
                    "title": "one_time_price_data_with_product_data",
                    "type": "object"
                  },
                  "quantity": {
                    "description": "Non-negative integer. The quantity of units for the line item.",
                    "type": "integer"
                  },
                  "tax_amounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "tax_rate_data": {
                              "properties": {
                                "country": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "description": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "display_name": {
                                  "maxLength": 100,
                                  "type": "string"
                                },
                                "inclusive": {
                                  "type": "boolean"
                                },
                                "jurisdiction": {
                                  "maxLength": 200,
                                  "type": "string"
                                },
                                "percentage": {
                                  "type": "number"
                                },
                                "state": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_type": {
                                  "enum": [
                                    "amusement_tax",
                                    "communications_tax",
                                    "gst",
                                    "hst",
                                    "igst",
                                    "jct",
                                    "lease_tax",
                                    "pst",
                                    "qst",
                                    "retail_delivery_fee",
                                    "rst",
                                    "sales_tax",
                                    "service_tax",
                                    "vat"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                }
                              },
                              "required": [
                                "display_name",
                                "inclusive",
                                "percentage"
                              ],
                              "title": "tax_rate_data_param",
                              "type": "object"
                            },
                            "taxable_amount": {
                              "type": "integer"
                            }
                          },
                          "required": [
                            "amount",
                            "tax_rate_data",
                            "taxable_amount"
                          ],
                          "title": "tax_amount_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts."
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/line_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an invoice's line item"
      }
    },
    "/v1/invoices/{invoice}/mark_uncollectible": {
      "post": {
        "description": "<p>Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.</p>",
        "operationId": "PostInvoicesInvoiceMarkUncollectible",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Mark an invoice as uncollectible"
      }
    },
    "/v1/invoices/{invoice}/pay": {
      "post": {
        "description": "<p>Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your <a href=\"https://dashboard.stripe.com/account/billing/automatic\">subscriptions settings</a>. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.</p>",
        "operationId": "PostInvoicesInvoicePay",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "forgive": {
                    "description": "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.",
                    "type": "boolean"
                  },
                  "mandate": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).",
                    "type": "boolean"
                  },
                  "paid_out_of_band": {
                    "description": "Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.",
                    "type": "boolean"
                  },
                  "payment_method": {
                    "description": "A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "source": {
                    "description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Pay an invoice"
      }
    },
    "/v1/invoices/{invoice}/remove_lines": {
      "post": {
        "description": "<p>Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.</p>",
        "operationId": "PostInvoicesInvoiceRemoveLines",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "lines": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "lines": {
                    "description": "The line items to remove.",
                    "items": {
                      "properties": {
                        "behavior": {
                          "enum": ["delete", "unassign"],
                          "type": "string"
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "required": ["behavior", "id"],
                      "title": "lines_data_param",
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "required": ["lines"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Bulk remove invoice line items"
      }
    },
    "/v1/invoices/{invoice}/send": {
      "post": {
        "description": "<p>Stripe will automatically send invoices to customers according to your <a href=\"https://dashboard.stripe.com/account/billing/automatic\">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.</p>\n\n<p>Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> event.</p>",
        "operationId": "PostInvoicesInvoiceSend",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Send an invoice for manual payment"
      }
    },
    "/v1/invoices/{invoice}/update_lines": {
      "post": {
        "description": "<p>Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.</p>",
        "operationId": "PostInvoicesInvoiceUpdateLines",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "lines": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data."
                  },
                  "lines": {
                    "description": "The line items to update.",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "description": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "discountable": {
                          "type": "boolean"
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "metadata": {
                          "anyOf": [
                            {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "period": {
                          "properties": {
                            "end": {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            "start": {
                              "format": "unix-time",
                              "type": "integer"
                            }
                          },
                          "required": ["end", "start"],
                          "title": "period",
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "product_data": {
                              "properties": {
                                "description": {
                                  "maxLength": 40000,
                                  "type": "string"
                                },
                                "images": {
                                  "items": {
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                "metadata": {
                                  "additionalProperties": {
                                    "type": "string"
                                  },
                                  "type": "object"
                                },
                                "name": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "tax_code": {
                                  "maxLength": 5000,
                                  "type": "string"
                                }
                              },
                              "required": ["name"],
                              "title": "product_data",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency"],
                          "title": "one_time_price_data_with_product_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_amounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "tax_rate_data": {
                                    "properties": {
                                      "country": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "display_name": {
                                        "maxLength": 100,
                                        "type": "string"
                                      },
                                      "inclusive": {
                                        "type": "boolean"
                                      },
                                      "jurisdiction": {
                                        "maxLength": 200,
                                        "type": "string"
                                      },
                                      "percentage": {
                                        "type": "number"
                                      },
                                      "state": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      "tax_type": {
                                        "enum": [
                                          "amusement_tax",
                                          "communications_tax",
                                          "gst",
                                          "hst",
                                          "igst",
                                          "jct",
                                          "lease_tax",
                                          "pst",
                                          "qst",
                                          "retail_delivery_fee",
                                          "rst",
                                          "sales_tax",
                                          "service_tax",
                                          "vat"
                                        ],
                                        "type": "string",
                                        "x-stripeBypassValidation": true
                                      }
                                    },
                                    "required": [
                                      "display_name",
                                      "inclusive",
                                      "percentage"
                                    ],
                                    "title": "tax_rate_data_param",
                                    "type": "object"
                                  },
                                  "taxable_amount": {
                                    "type": "integer"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "tax_rate_data",
                                  "taxable_amount"
                                ],
                                "title": "tax_amount_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "required": ["id"],
                      "title": "lines_data_param",
                      "type": "object"
                    },
                    "type": "array"
                  }
                },
                "required": ["lines"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Bulk update invoice line items"
      }
    },
    "/v1/invoices/{invoice}/void": {
      "post": {
        "description": "<p>Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to <a href=\"#delete_invoice\">deletion</a>, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.</p>\n\n<p>Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to <a href=\"#create_invoice\">issue another invoice</a> or <a href=\"#create_credit_note\">credit note</a> instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.</p>",
        "operationId": "PostInvoicesInvoiceVoid",
        "parameters": [
          {
            "in": "path",
            "name": "invoice",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/invoice"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Void an invoice"
      }
    },
    "/v1/issuing/authorizations": {
      "get": {
        "description": "<p>Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingAuthorizations",
        "parameters": [
          {
            "description": "Only return authorizations that belong to the given card.",
            "in": "query",
            "name": "card",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return authorizations that belong to the given cardholder.",
            "in": "query",
            "name": "cardholder",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return authorizations that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["closed", "pending", "reversed"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.authorization"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/authorizations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingAuthorizationList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all authorizations"
      }
    },
    "/v1/issuing/authorizations/{authorization}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Authorization</code> object.</p>",
        "operationId": "GetIssuingAuthorizationsAuthorization",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an authorization"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostIssuingAuthorizationsAuthorization",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update an authorization"
      }
    },
    "/v1/issuing/authorizations/{authorization}/approve": {
      "post": {
        "deprecated": true,
        "description": "<p>[Deprecated] Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href=\"/docs/issuing/controls/real-time-authorizations\">real-time authorization</a> flow. \nThis method is deprecated. Instead, <a href=\"/docs/issuing/controls/real-time-authorizations#authorization-handling\">respond directly to the webhook request to approve an authorization</a>.</p>",
        "operationId": "PostIssuingAuthorizationsAuthorizationApprove",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Approve an authorization"
      }
    },
    "/v1/issuing/authorizations/{authorization}/decline": {
      "post": {
        "deprecated": true,
        "description": "<p>[Deprecated] Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href=\"/docs/issuing/controls/real-time-authorizations\">real time authorization</a> flow.\nThis method is deprecated. Instead, <a href=\"/docs/issuing/controls/real-time-authorizations#authorization-handling\">respond directly to the webhook request to decline an authorization</a>.</p>",
        "operationId": "PostIssuingAuthorizationsAuthorizationDecline",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Decline an authorization"
      }
    },
    "/v1/issuing/cardholders": {
      "get": {
        "description": "<p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingCardholders",
        "parameters": [
          {
            "description": "Only return cardholders that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return cardholders that have the given email address.",
            "in": "query",
            "name": "email",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return cardholders that have the given phone number.",
            "in": "query",
            "name": "phone_number",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "blocked", "inactive"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return cardholders that have the given type. One of `individual` or `company`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["company", "individual"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.cardholder"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/cardholders",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingCardholderList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all cardholders"
      },
      "post": {
        "description": "<p>Creates a new Issuing <code>Cardholder</code> object that can be issued cards.</p>",
        "operationId": "PostIssuingCardholders",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "billing": {
                  "explode": true,
                  "style": "deepObject"
                },
                "company": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "individual": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferred_locales": {
                  "explode": true,
                  "style": "deepObject"
                },
                "spending_controls": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "billing": {
                    "description": "The cardholder's billing address.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["city", "country", "line1", "postal_code"],
                        "title": "required_address",
                        "type": "object"
                      }
                    },
                    "required": ["address"],
                    "title": "billing_specs",
                    "type": "object"
                  },
                  "company": {
                    "description": "Additional information about a `company` cardholder.",
                    "properties": {
                      "tax_id": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "company_param",
                    "type": "object"
                  },
                  "email": {
                    "description": "The cardholder's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "individual": {
                    "description": "Additional information about an `individual` cardholder.",
                    "properties": {
                      "card_issuing": {
                        "properties": {
                          "user_terms_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "terms_acceptance_param",
                            "type": "object"
                          }
                        },
                        "title": "card_issuing_param",
                        "type": "object"
                      },
                      "dob": {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      "first_name": {
                        "type": "string"
                      },
                      "last_name": {
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_param",
                            "type": "object"
                          }
                        },
                        "title": "person_verification_param",
                        "type": "object"
                      }
                    },
                    "title": "individual_param",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "description": "The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.",
                    "type": "string"
                  },
                  "phone_number": {
                    "description": "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.",
                    "type": "string"
                  },
                  "preferred_locales": {
                    "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.",
                    "items": {
                      "enum": ["de", "en", "es", "fr", "it"],
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "spending_controls": {
                    "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
                    "properties": {
                      "allowed_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "allowed_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "spending_limits": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "categories": {
                              "items": {
                                "enum": [
                                  "ac_refrigeration_repair",
                                  "accounting_bookkeeping_services",
                                  "advertising_services",
                                  "agricultural_cooperative",
                                  "airlines_air_carriers",
                                  "airports_flying_fields",
                                  "ambulance_services",
                                  "amusement_parks_carnivals",
                                  "antique_reproductions",
                                  "antique_shops",
                                  "aquariums",
                                  "architectural_surveying_services",
                                  "art_dealers_and_galleries",
                                  "artists_supply_and_craft_shops",
                                  "auto_and_home_supply_stores",
                                  "auto_body_repair_shops",
                                  "auto_paint_shops",
                                  "auto_service_shops",
                                  "automated_cash_disburse",
                                  "automated_fuel_dispensers",
                                  "automobile_associations",
                                  "automotive_parts_and_accessories_stores",
                                  "automotive_tire_stores",
                                  "bail_and_bond_payments",
                                  "bakeries",
                                  "bands_orchestras",
                                  "barber_and_beauty_shops",
                                  "betting_casino_gambling",
                                  "bicycle_shops",
                                  "billiard_pool_establishments",
                                  "boat_dealers",
                                  "boat_rentals_and_leases",
                                  "book_stores",
                                  "books_periodicals_and_newspapers",
                                  "bowling_alleys",
                                  "bus_lines",
                                  "business_secretarial_schools",
                                  "buying_shopping_services",
                                  "cable_satellite_and_other_pay_television_and_radio",
                                  "camera_and_photographic_supply_stores",
                                  "candy_nut_and_confectionery_stores",
                                  "car_and_truck_dealers_new_used",
                                  "car_and_truck_dealers_used_only",
                                  "car_rental_agencies",
                                  "car_washes",
                                  "carpentry_services",
                                  "carpet_upholstery_cleaning",
                                  "caterers",
                                  "charitable_and_social_service_organizations_fundraising",
                                  "chemicals_and_allied_products",
                                  "child_care_services",
                                  "childrens_and_infants_wear_stores",
                                  "chiropodists_podiatrists",
                                  "chiropractors",
                                  "cigar_stores_and_stands",
                                  "civic_social_fraternal_associations",
                                  "cleaning_and_maintenance",
                                  "clothing_rental",
                                  "colleges_universities",
                                  "commercial_equipment",
                                  "commercial_footwear",
                                  "commercial_photography_art_and_graphics",
                                  "commuter_transport_and_ferries",
                                  "computer_network_services",
                                  "computer_programming",
                                  "computer_repair",
                                  "computer_software_stores",
                                  "computers_peripherals_and_software",
                                  "concrete_work_services",
                                  "construction_materials",
                                  "consulting_public_relations",
                                  "correspondence_schools",
                                  "cosmetic_stores",
                                  "counseling_services",
                                  "country_clubs",
                                  "courier_services",
                                  "court_costs",
                                  "credit_reporting_agencies",
                                  "cruise_lines",
                                  "dairy_products_stores",
                                  "dance_hall_studios_schools",
                                  "dating_escort_services",
                                  "dentists_orthodontists",
                                  "department_stores",
                                  "detective_agencies",
                                  "digital_goods_applications",
                                  "digital_goods_games",
                                  "digital_goods_large_volume",
                                  "digital_goods_media",
                                  "direct_marketing_catalog_merchant",
                                  "direct_marketing_combination_catalog_and_retail_merchant",
                                  "direct_marketing_inbound_telemarketing",
                                  "direct_marketing_insurance_services",
                                  "direct_marketing_other",
                                  "direct_marketing_outbound_telemarketing",
                                  "direct_marketing_subscription",
                                  "direct_marketing_travel",
                                  "discount_stores",
                                  "doctors",
                                  "door_to_door_sales",
                                  "drapery_window_covering_and_upholstery_stores",
                                  "drinking_places",
                                  "drug_stores_and_pharmacies",
                                  "drugs_drug_proprietaries_and_druggist_sundries",
                                  "dry_cleaners",
                                  "durable_goods",
                                  "duty_free_stores",
                                  "eating_places_restaurants",
                                  "educational_services",
                                  "electric_razor_stores",
                                  "electric_vehicle_charging",
                                  "electrical_parts_and_equipment",
                                  "electrical_services",
                                  "electronics_repair_shops",
                                  "electronics_stores",
                                  "elementary_secondary_schools",
                                  "emergency_services_gcas_visa_use_only",
                                  "employment_temp_agencies",
                                  "equipment_rental",
                                  "exterminating_services",
                                  "family_clothing_stores",
                                  "fast_food_restaurants",
                                  "financial_institutions",
                                  "fines_government_administrative_entities",
                                  "fireplace_fireplace_screens_and_accessories_stores",
                                  "floor_covering_stores",
                                  "florists",
                                  "florists_supplies_nursery_stock_and_flowers",
                                  "freezer_and_locker_meat_provisioners",
                                  "fuel_dealers_non_automotive",
                                  "funeral_services_crematories",
                                  "furniture_home_furnishings_and_equipment_stores_except_appliances",
                                  "furniture_repair_refinishing",
                                  "furriers_and_fur_shops",
                                  "general_services",
                                  "gift_card_novelty_and_souvenir_shops",
                                  "glass_paint_and_wallpaper_stores",
                                  "glassware_crystal_stores",
                                  "golf_courses_public",
                                  "government_licensed_horse_dog_racing_us_region_only",
                                  "government_licensed_online_casions_online_gambling_us_region_only",
                                  "government_owned_lotteries_non_us_region",
                                  "government_owned_lotteries_us_region_only",
                                  "government_services",
                                  "grocery_stores_supermarkets",
                                  "hardware_equipment_and_supplies",
                                  "hardware_stores",
                                  "health_and_beauty_spas",
                                  "hearing_aids_sales_and_supplies",
                                  "heating_plumbing_a_c",
                                  "hobby_toy_and_game_shops",
                                  "home_supply_warehouse_stores",
                                  "hospitals",
                                  "hotels_motels_and_resorts",
                                  "household_appliance_stores",
                                  "industrial_supplies",
                                  "information_retrieval_services",
                                  "insurance_default",
                                  "insurance_underwriting_premiums",
                                  "intra_company_purchases",
                                  "jewelry_stores_watches_clocks_and_silverware_stores",
                                  "landscaping_services",
                                  "laundries",
                                  "laundry_cleaning_services",
                                  "legal_services_attorneys",
                                  "luggage_and_leather_goods_stores",
                                  "lumber_building_materials_stores",
                                  "manual_cash_disburse",
                                  "marinas_service_and_supplies",
                                  "marketplaces",
                                  "masonry_stonework_and_plaster",
                                  "massage_parlors",
                                  "medical_and_dental_labs",
                                  "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                                  "medical_services",
                                  "membership_organizations",
                                  "mens_and_boys_clothing_and_accessories_stores",
                                  "mens_womens_clothing_stores",
                                  "metal_service_centers",
                                  "miscellaneous",
                                  "miscellaneous_apparel_and_accessory_shops",
                                  "miscellaneous_auto_dealers",
                                  "miscellaneous_business_services",
                                  "miscellaneous_food_stores",
                                  "miscellaneous_general_merchandise",
                                  "miscellaneous_general_services",
                                  "miscellaneous_home_furnishing_specialty_stores",
                                  "miscellaneous_publishing_and_printing",
                                  "miscellaneous_recreation_services",
                                  "miscellaneous_repair_shops",
                                  "miscellaneous_specialty_retail",
                                  "mobile_home_dealers",
                                  "motion_picture_theaters",
                                  "motor_freight_carriers_and_trucking",
                                  "motor_homes_dealers",
                                  "motor_vehicle_supplies_and_new_parts",
                                  "motorcycle_shops_and_dealers",
                                  "motorcycle_shops_dealers",
                                  "music_stores_musical_instruments_pianos_and_sheet_music",
                                  "news_dealers_and_newsstands",
                                  "non_fi_money_orders",
                                  "non_fi_stored_value_card_purchase_load",
                                  "nondurable_goods",
                                  "nurseries_lawn_and_garden_supply_stores",
                                  "nursing_personal_care",
                                  "office_and_commercial_furniture",
                                  "opticians_eyeglasses",
                                  "optometrists_ophthalmologist",
                                  "orthopedic_goods_prosthetic_devices",
                                  "osteopaths",
                                  "package_stores_beer_wine_and_liquor",
                                  "paints_varnishes_and_supplies",
                                  "parking_lots_garages",
                                  "passenger_railways",
                                  "pawn_shops",
                                  "pet_shops_pet_food_and_supplies",
                                  "petroleum_and_petroleum_products",
                                  "photo_developing",
                                  "photographic_photocopy_microfilm_equipment_and_supplies",
                                  "photographic_studios",
                                  "picture_video_production",
                                  "piece_goods_notions_and_other_dry_goods",
                                  "plumbing_heating_equipment_and_supplies",
                                  "political_organizations",
                                  "postal_services_government_only",
                                  "precious_stones_and_metals_watches_and_jewelry",
                                  "professional_services",
                                  "public_warehousing_and_storage",
                                  "quick_copy_repro_and_blueprint",
                                  "railroads",
                                  "real_estate_agents_and_managers_rentals",
                                  "record_stores",
                                  "recreational_vehicle_rentals",
                                  "religious_goods_stores",
                                  "religious_organizations",
                                  "roofing_siding_sheet_metal",
                                  "secretarial_support_services",
                                  "security_brokers_dealers",
                                  "service_stations",
                                  "sewing_needlework_fabric_and_piece_goods_stores",
                                  "shoe_repair_hat_cleaning",
                                  "shoe_stores",
                                  "small_appliance_repair",
                                  "snowmobile_dealers",
                                  "special_trade_services",
                                  "specialty_cleaning",
                                  "sporting_goods_stores",
                                  "sporting_recreation_camps",
                                  "sports_and_riding_apparel_stores",
                                  "sports_clubs_fields",
                                  "stamp_and_coin_stores",
                                  "stationary_office_supplies_printing_and_writing_paper",
                                  "stationery_stores_office_and_school_supply_stores",
                                  "swimming_pools_sales",
                                  "t_ui_travel_germany",
                                  "tailors_alterations",
                                  "tax_payments_government_agencies",
                                  "tax_preparation_services",
                                  "taxicabs_limousines",
                                  "telecommunication_equipment_and_telephone_sales",
                                  "telecommunication_services",
                                  "telegraph_services",
                                  "tent_and_awning_shops",
                                  "testing_laboratories",
                                  "theatrical_ticket_agencies",
                                  "timeshares",
                                  "tire_retreading_and_repair",
                                  "tolls_bridge_fees",
                                  "tourist_attractions_and_exhibits",
                                  "towing_services",
                                  "trailer_parks_campgrounds",
                                  "transportation_services",
                                  "travel_agencies_tour_operators",
                                  "truck_stop_iteration",
                                  "truck_utility_trailer_rentals",
                                  "typesetting_plate_making_and_related_services",
                                  "typewriter_stores",
                                  "u_s_federal_government_agencies_or_departments",
                                  "uniforms_commercial_clothing",
                                  "used_merchandise_and_secondhand_stores",
                                  "utilities",
                                  "variety_stores",
                                  "veterinary_services",
                                  "video_amusement_game_supplies",
                                  "video_game_arcades",
                                  "video_tape_rental_stores",
                                  "vocational_trade_schools",
                                  "watch_jewelry_repair",
                                  "welding_repair",
                                  "wholesale_clubs",
                                  "wig_and_toupee_stores",
                                  "wires_money_orders",
                                  "womens_accessory_and_specialty_shops",
                                  "womens_ready_to_wear_stores",
                                  "wrecking_and_salvage_yards"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            "interval": {
                              "enum": [
                                "all_time",
                                "daily",
                                "monthly",
                                "per_authorization",
                                "weekly",
                                "yearly"
                              ],
                              "type": "string"
                            }
                          },
                          "required": ["amount", "interval"],
                          "title": "spending_limits_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "spending_limits_currency": {
                        "type": "string"
                      }
                    },
                    "title": "authorization_controls_param_v2",
                    "type": "object"
                  },
                  "status": {
                    "description": "Specifies whether to permit authorizations on this cardholder's cards. Defaults to `active`.",
                    "enum": ["active", "inactive"],
                    "type": "string"
                  },
                  "type": {
                    "description": "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.",
                    "enum": ["company", "individual"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "required": ["billing", "name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.cardholder"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a cardholder"
      }
    },
    "/v1/issuing/cardholders/{cardholder}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Cardholder</code> object.</p>",
        "operationId": "GetIssuingCardholdersCardholder",
        "parameters": [
          {
            "in": "path",
            "name": "cardholder",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.cardholder"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a cardholder"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostIssuingCardholdersCardholder",
        "parameters": [
          {
            "in": "path",
            "name": "cardholder",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "billing": {
                  "explode": true,
                  "style": "deepObject"
                },
                "company": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "individual": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferred_locales": {
                  "explode": true,
                  "style": "deepObject"
                },
                "spending_controls": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "billing": {
                    "description": "The cardholder's billing address.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["city", "country", "line1", "postal_code"],
                        "title": "required_address",
                        "type": "object"
                      }
                    },
                    "required": ["address"],
                    "title": "billing_specs",
                    "type": "object"
                  },
                  "company": {
                    "description": "Additional information about a `company` cardholder.",
                    "properties": {
                      "tax_id": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "company_param",
                    "type": "object"
                  },
                  "email": {
                    "description": "The cardholder's email address.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "individual": {
                    "description": "Additional information about an `individual` cardholder.",
                    "properties": {
                      "card_issuing": {
                        "properties": {
                          "user_terms_acceptance": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "terms_acceptance_param",
                            "type": "object"
                          }
                        },
                        "title": "card_issuing_param",
                        "type": "object"
                      },
                      "dob": {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth_specs",
                        "type": "object"
                      },
                      "first_name": {
                        "type": "string"
                      },
                      "last_name": {
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_param",
                            "type": "object"
                          }
                        },
                        "title": "person_verification_param",
                        "type": "object"
                      }
                    },
                    "title": "individual_param",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "phone_number": {
                    "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details.",
                    "type": "string"
                  },
                  "preferred_locales": {
                    "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.",
                    "items": {
                      "enum": ["de", "en", "es", "fr", "it"],
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "spending_controls": {
                    "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
                    "properties": {
                      "allowed_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "allowed_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "spending_limits": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "categories": {
                              "items": {
                                "enum": [
                                  "ac_refrigeration_repair",
                                  "accounting_bookkeeping_services",
                                  "advertising_services",
                                  "agricultural_cooperative",
                                  "airlines_air_carriers",
                                  "airports_flying_fields",
                                  "ambulance_services",
                                  "amusement_parks_carnivals",
                                  "antique_reproductions",
                                  "antique_shops",
                                  "aquariums",
                                  "architectural_surveying_services",
                                  "art_dealers_and_galleries",
                                  "artists_supply_and_craft_shops",
                                  "auto_and_home_supply_stores",
                                  "auto_body_repair_shops",
                                  "auto_paint_shops",
                                  "auto_service_shops",
                                  "automated_cash_disburse",
                                  "automated_fuel_dispensers",
                                  "automobile_associations",
                                  "automotive_parts_and_accessories_stores",
                                  "automotive_tire_stores",
                                  "bail_and_bond_payments",
                                  "bakeries",
                                  "bands_orchestras",
                                  "barber_and_beauty_shops",
                                  "betting_casino_gambling",
                                  "bicycle_shops",
                                  "billiard_pool_establishments",
                                  "boat_dealers",
                                  "boat_rentals_and_leases",
                                  "book_stores",
                                  "books_periodicals_and_newspapers",
                                  "bowling_alleys",
                                  "bus_lines",
                                  "business_secretarial_schools",
                                  "buying_shopping_services",
                                  "cable_satellite_and_other_pay_television_and_radio",
                                  "camera_and_photographic_supply_stores",
                                  "candy_nut_and_confectionery_stores",
                                  "car_and_truck_dealers_new_used",
                                  "car_and_truck_dealers_used_only",
                                  "car_rental_agencies",
                                  "car_washes",
                                  "carpentry_services",
                                  "carpet_upholstery_cleaning",
                                  "caterers",
                                  "charitable_and_social_service_organizations_fundraising",
                                  "chemicals_and_allied_products",
                                  "child_care_services",
                                  "childrens_and_infants_wear_stores",
                                  "chiropodists_podiatrists",
                                  "chiropractors",
                                  "cigar_stores_and_stands",
                                  "civic_social_fraternal_associations",
                                  "cleaning_and_maintenance",
                                  "clothing_rental",
                                  "colleges_universities",
                                  "commercial_equipment",
                                  "commercial_footwear",
                                  "commercial_photography_art_and_graphics",
                                  "commuter_transport_and_ferries",
                                  "computer_network_services",
                                  "computer_programming",
                                  "computer_repair",
                                  "computer_software_stores",
                                  "computers_peripherals_and_software",
                                  "concrete_work_services",
                                  "construction_materials",
                                  "consulting_public_relations",
                                  "correspondence_schools",
                                  "cosmetic_stores",
                                  "counseling_services",
                                  "country_clubs",
                                  "courier_services",
                                  "court_costs",
                                  "credit_reporting_agencies",
                                  "cruise_lines",
                                  "dairy_products_stores",
                                  "dance_hall_studios_schools",
                                  "dating_escort_services",
                                  "dentists_orthodontists",
                                  "department_stores",
                                  "detective_agencies",
                                  "digital_goods_applications",
                                  "digital_goods_games",
                                  "digital_goods_large_volume",
                                  "digital_goods_media",
                                  "direct_marketing_catalog_merchant",
                                  "direct_marketing_combination_catalog_and_retail_merchant",
                                  "direct_marketing_inbound_telemarketing",
                                  "direct_marketing_insurance_services",
                                  "direct_marketing_other",
                                  "direct_marketing_outbound_telemarketing",
                                  "direct_marketing_subscription",
                                  "direct_marketing_travel",
                                  "discount_stores",
                                  "doctors",
                                  "door_to_door_sales",
                                  "drapery_window_covering_and_upholstery_stores",
                                  "drinking_places",
                                  "drug_stores_and_pharmacies",
                                  "drugs_drug_proprietaries_and_druggist_sundries",
                                  "dry_cleaners",
                                  "durable_goods",
                                  "duty_free_stores",
                                  "eating_places_restaurants",
                                  "educational_services",
                                  "electric_razor_stores",
                                  "electric_vehicle_charging",
                                  "electrical_parts_and_equipment",
                                  "electrical_services",
                                  "electronics_repair_shops",
                                  "electronics_stores",
                                  "elementary_secondary_schools",
                                  "emergency_services_gcas_visa_use_only",
                                  "employment_temp_agencies",
                                  "equipment_rental",
                                  "exterminating_services",
                                  "family_clothing_stores",
                                  "fast_food_restaurants",
                                  "financial_institutions",
                                  "fines_government_administrative_entities",
                                  "fireplace_fireplace_screens_and_accessories_stores",
                                  "floor_covering_stores",
                                  "florists",
                                  "florists_supplies_nursery_stock_and_flowers",
                                  "freezer_and_locker_meat_provisioners",
                                  "fuel_dealers_non_automotive",
                                  "funeral_services_crematories",
                                  "furniture_home_furnishings_and_equipment_stores_except_appliances",
                                  "furniture_repair_refinishing",
                                  "furriers_and_fur_shops",
                                  "general_services",
                                  "gift_card_novelty_and_souvenir_shops",
                                  "glass_paint_and_wallpaper_stores",
                                  "glassware_crystal_stores",
                                  "golf_courses_public",
                                  "government_licensed_horse_dog_racing_us_region_only",
                                  "government_licensed_online_casions_online_gambling_us_region_only",
                                  "government_owned_lotteries_non_us_region",
                                  "government_owned_lotteries_us_region_only",
                                  "government_services",
                                  "grocery_stores_supermarkets",
                                  "hardware_equipment_and_supplies",
                                  "hardware_stores",
                                  "health_and_beauty_spas",
                                  "hearing_aids_sales_and_supplies",
                                  "heating_plumbing_a_c",
                                  "hobby_toy_and_game_shops",
                                  "home_supply_warehouse_stores",
                                  "hospitals",
                                  "hotels_motels_and_resorts",
                                  "household_appliance_stores",
                                  "industrial_supplies",
                                  "information_retrieval_services",
                                  "insurance_default",
                                  "insurance_underwriting_premiums",
                                  "intra_company_purchases",
                                  "jewelry_stores_watches_clocks_and_silverware_stores",
                                  "landscaping_services",
                                  "laundries",
                                  "laundry_cleaning_services",
                                  "legal_services_attorneys",
                                  "luggage_and_leather_goods_stores",
                                  "lumber_building_materials_stores",
                                  "manual_cash_disburse",
                                  "marinas_service_and_supplies",
                                  "marketplaces",
                                  "masonry_stonework_and_plaster",
                                  "massage_parlors",
                                  "medical_and_dental_labs",
                                  "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                                  "medical_services",
                                  "membership_organizations",
                                  "mens_and_boys_clothing_and_accessories_stores",
                                  "mens_womens_clothing_stores",
                                  "metal_service_centers",
                                  "miscellaneous",
                                  "miscellaneous_apparel_and_accessory_shops",
                                  "miscellaneous_auto_dealers",
                                  "miscellaneous_business_services",
                                  "miscellaneous_food_stores",
                                  "miscellaneous_general_merchandise",
                                  "miscellaneous_general_services",
                                  "miscellaneous_home_furnishing_specialty_stores",
                                  "miscellaneous_publishing_and_printing",
                                  "miscellaneous_recreation_services",
                                  "miscellaneous_repair_shops",
                                  "miscellaneous_specialty_retail",
                                  "mobile_home_dealers",
                                  "motion_picture_theaters",
                                  "motor_freight_carriers_and_trucking",
                                  "motor_homes_dealers",
                                  "motor_vehicle_supplies_and_new_parts",
                                  "motorcycle_shops_and_dealers",
                                  "motorcycle_shops_dealers",
                                  "music_stores_musical_instruments_pianos_and_sheet_music",
                                  "news_dealers_and_newsstands",
                                  "non_fi_money_orders",
                                  "non_fi_stored_value_card_purchase_load",
                                  "nondurable_goods",
                                  "nurseries_lawn_and_garden_supply_stores",
                                  "nursing_personal_care",
                                  "office_and_commercial_furniture",
                                  "opticians_eyeglasses",
                                  "optometrists_ophthalmologist",
                                  "orthopedic_goods_prosthetic_devices",
                                  "osteopaths",
                                  "package_stores_beer_wine_and_liquor",
                                  "paints_varnishes_and_supplies",
                                  "parking_lots_garages",
                                  "passenger_railways",
                                  "pawn_shops",
                                  "pet_shops_pet_food_and_supplies",
                                  "petroleum_and_petroleum_products",
                                  "photo_developing",
                                  "photographic_photocopy_microfilm_equipment_and_supplies",
                                  "photographic_studios",
                                  "picture_video_production",
                                  "piece_goods_notions_and_other_dry_goods",
                                  "plumbing_heating_equipment_and_supplies",
                                  "political_organizations",
                                  "postal_services_government_only",
                                  "precious_stones_and_metals_watches_and_jewelry",
                                  "professional_services",
                                  "public_warehousing_and_storage",
                                  "quick_copy_repro_and_blueprint",
                                  "railroads",
                                  "real_estate_agents_and_managers_rentals",
                                  "record_stores",
                                  "recreational_vehicle_rentals",
                                  "religious_goods_stores",
                                  "religious_organizations",
                                  "roofing_siding_sheet_metal",
                                  "secretarial_support_services",
                                  "security_brokers_dealers",
                                  "service_stations",
                                  "sewing_needlework_fabric_and_piece_goods_stores",
                                  "shoe_repair_hat_cleaning",
                                  "shoe_stores",
                                  "small_appliance_repair",
                                  "snowmobile_dealers",
                                  "special_trade_services",
                                  "specialty_cleaning",
                                  "sporting_goods_stores",
                                  "sporting_recreation_camps",
                                  "sports_and_riding_apparel_stores",
                                  "sports_clubs_fields",
                                  "stamp_and_coin_stores",
                                  "stationary_office_supplies_printing_and_writing_paper",
                                  "stationery_stores_office_and_school_supply_stores",
                                  "swimming_pools_sales",
                                  "t_ui_travel_germany",
                                  "tailors_alterations",
                                  "tax_payments_government_agencies",
                                  "tax_preparation_services",
                                  "taxicabs_limousines",
                                  "telecommunication_equipment_and_telephone_sales",
                                  "telecommunication_services",
                                  "telegraph_services",
                                  "tent_and_awning_shops",
                                  "testing_laboratories",
                                  "theatrical_ticket_agencies",
                                  "timeshares",
                                  "tire_retreading_and_repair",
                                  "tolls_bridge_fees",
                                  "tourist_attractions_and_exhibits",
                                  "towing_services",
                                  "trailer_parks_campgrounds",
                                  "transportation_services",
                                  "travel_agencies_tour_operators",
                                  "truck_stop_iteration",
                                  "truck_utility_trailer_rentals",
                                  "typesetting_plate_making_and_related_services",
                                  "typewriter_stores",
                                  "u_s_federal_government_agencies_or_departments",
                                  "uniforms_commercial_clothing",
                                  "used_merchandise_and_secondhand_stores",
                                  "utilities",
                                  "variety_stores",
                                  "veterinary_services",
                                  "video_amusement_game_supplies",
                                  "video_game_arcades",
                                  "video_tape_rental_stores",
                                  "vocational_trade_schools",
                                  "watch_jewelry_repair",
                                  "welding_repair",
                                  "wholesale_clubs",
                                  "wig_and_toupee_stores",
                                  "wires_money_orders",
                                  "womens_accessory_and_specialty_shops",
                                  "womens_ready_to_wear_stores",
                                  "wrecking_and_salvage_yards"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            "interval": {
                              "enum": [
                                "all_time",
                                "daily",
                                "monthly",
                                "per_authorization",
                                "weekly",
                                "yearly"
                              ],
                              "type": "string"
                            }
                          },
                          "required": ["amount", "interval"],
                          "title": "spending_limits_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "spending_limits_currency": {
                        "type": "string"
                      }
                    },
                    "title": "authorization_controls_param_v2",
                    "type": "object"
                  },
                  "status": {
                    "description": "Specifies whether to permit authorizations on this cardholder's cards.",
                    "enum": ["active", "inactive"],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.cardholder"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a cardholder"
      }
    },
    "/v1/issuing/cards": {
      "get": {
        "description": "<p>Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingCards",
        "parameters": [
          {
            "description": "Only return cards belonging to the Cardholder with the provided ID.",
            "in": "query",
            "name": "cardholder",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return cards that were issued during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return cards that have the given expiration month.",
            "in": "query",
            "name": "exp_month",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return cards that have the given expiration year.",
            "in": "query",
            "name": "exp_year",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return cards that have the given last four digits.",
            "in": "query",
            "name": "last4",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "query",
            "name": "personalization_design",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "canceled", "inactive"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "Only return cards that have the given type. One of `virtual` or `physical`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["physical", "virtual"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.card"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/cards",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingCardList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all cards"
      },
      "post": {
        "description": "<p>Creates an Issuing <code>Card</code> object.</p>",
        "operationId": "PostIssuingCards",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pin": {
                  "explode": true,
                  "style": "deepObject"
                },
                "second_line": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "spending_controls": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cardholder": {
                    "description": "The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency for the card.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "personalization_design": {
                    "description": "The personalization design object belonging to this card.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "pin": {
                    "description": "The desired PIN for this card.",
                    "properties": {
                      "encrypted_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "encrypted_pin_param",
                    "type": "object"
                  },
                  "replacement_for": {
                    "description": "The card this is meant to be a replacement for (if any).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "replacement_reason": {
                    "description": "If `replacement_for` is specified, this should indicate why that card is being replaced.",
                    "enum": ["damaged", "expired", "lost", "stolen"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "second_line": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The second line to print on the card. Max length: 24 characters."
                  },
                  "shipping": {
                    "description": "The address where the card will be shipped.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["city", "country", "line1", "postal_code"],
                        "title": "required_address",
                        "type": "object"
                      },
                      "address_validation": {
                        "properties": {
                          "mode": {
                            "enum": [
                              "disabled",
                              "normalization_only",
                              "validation_and_normalization"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["mode"],
                        "title": "address_validation_param",
                        "type": "object"
                      },
                      "customs": {
                        "properties": {
                          "eori_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "customs_param",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone_number": {
                        "type": "string"
                      },
                      "require_signature": {
                        "type": "boolean"
                      },
                      "service": {
                        "enum": ["express", "priority", "standard"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "type": {
                        "enum": ["bulk", "individual"],
                        "type": "string"
                      }
                    },
                    "required": ["address", "name"],
                    "title": "shipping_specs",
                    "type": "object"
                  },
                  "spending_controls": {
                    "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
                    "properties": {
                      "allowed_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "allowed_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "spending_limits": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "categories": {
                              "items": {
                                "enum": [
                                  "ac_refrigeration_repair",
                                  "accounting_bookkeeping_services",
                                  "advertising_services",
                                  "agricultural_cooperative",
                                  "airlines_air_carriers",
                                  "airports_flying_fields",
                                  "ambulance_services",
                                  "amusement_parks_carnivals",
                                  "antique_reproductions",
                                  "antique_shops",
                                  "aquariums",
                                  "architectural_surveying_services",
                                  "art_dealers_and_galleries",
                                  "artists_supply_and_craft_shops",
                                  "auto_and_home_supply_stores",
                                  "auto_body_repair_shops",
                                  "auto_paint_shops",
                                  "auto_service_shops",
                                  "automated_cash_disburse",
                                  "automated_fuel_dispensers",
                                  "automobile_associations",
                                  "automotive_parts_and_accessories_stores",
                                  "automotive_tire_stores",
                                  "bail_and_bond_payments",
                                  "bakeries",
                                  "bands_orchestras",
                                  "barber_and_beauty_shops",
                                  "betting_casino_gambling",
                                  "bicycle_shops",
                                  "billiard_pool_establishments",
                                  "boat_dealers",
                                  "boat_rentals_and_leases",
                                  "book_stores",
                                  "books_periodicals_and_newspapers",
                                  "bowling_alleys",
                                  "bus_lines",
                                  "business_secretarial_schools",
                                  "buying_shopping_services",
                                  "cable_satellite_and_other_pay_television_and_radio",
                                  "camera_and_photographic_supply_stores",
                                  "candy_nut_and_confectionery_stores",
                                  "car_and_truck_dealers_new_used",
                                  "car_and_truck_dealers_used_only",
                                  "car_rental_agencies",
                                  "car_washes",
                                  "carpentry_services",
                                  "carpet_upholstery_cleaning",
                                  "caterers",
                                  "charitable_and_social_service_organizations_fundraising",
                                  "chemicals_and_allied_products",
                                  "child_care_services",
                                  "childrens_and_infants_wear_stores",
                                  "chiropodists_podiatrists",
                                  "chiropractors",
                                  "cigar_stores_and_stands",
                                  "civic_social_fraternal_associations",
                                  "cleaning_and_maintenance",
                                  "clothing_rental",
                                  "colleges_universities",
                                  "commercial_equipment",
                                  "commercial_footwear",
                                  "commercial_photography_art_and_graphics",
                                  "commuter_transport_and_ferries",
                                  "computer_network_services",
                                  "computer_programming",
                                  "computer_repair",
                                  "computer_software_stores",
                                  "computers_peripherals_and_software",
                                  "concrete_work_services",
                                  "construction_materials",
                                  "consulting_public_relations",
                                  "correspondence_schools",
                                  "cosmetic_stores",
                                  "counseling_services",
                                  "country_clubs",
                                  "courier_services",
                                  "court_costs",
                                  "credit_reporting_agencies",
                                  "cruise_lines",
                                  "dairy_products_stores",
                                  "dance_hall_studios_schools",
                                  "dating_escort_services",
                                  "dentists_orthodontists",
                                  "department_stores",
                                  "detective_agencies",
                                  "digital_goods_applications",
                                  "digital_goods_games",
                                  "digital_goods_large_volume",
                                  "digital_goods_media",
                                  "direct_marketing_catalog_merchant",
                                  "direct_marketing_combination_catalog_and_retail_merchant",
                                  "direct_marketing_inbound_telemarketing",
                                  "direct_marketing_insurance_services",
                                  "direct_marketing_other",
                                  "direct_marketing_outbound_telemarketing",
                                  "direct_marketing_subscription",
                                  "direct_marketing_travel",
                                  "discount_stores",
                                  "doctors",
                                  "door_to_door_sales",
                                  "drapery_window_covering_and_upholstery_stores",
                                  "drinking_places",
                                  "drug_stores_and_pharmacies",
                                  "drugs_drug_proprietaries_and_druggist_sundries",
                                  "dry_cleaners",
                                  "durable_goods",
                                  "duty_free_stores",
                                  "eating_places_restaurants",
                                  "educational_services",
                                  "electric_razor_stores",
                                  "electric_vehicle_charging",
                                  "electrical_parts_and_equipment",
                                  "electrical_services",
                                  "electronics_repair_shops",
                                  "electronics_stores",
                                  "elementary_secondary_schools",
                                  "emergency_services_gcas_visa_use_only",
                                  "employment_temp_agencies",
                                  "equipment_rental",
                                  "exterminating_services",
                                  "family_clothing_stores",
                                  "fast_food_restaurants",
                                  "financial_institutions",
                                  "fines_government_administrative_entities",
                                  "fireplace_fireplace_screens_and_accessories_stores",
                                  "floor_covering_stores",
                                  "florists",
                                  "florists_supplies_nursery_stock_and_flowers",
                                  "freezer_and_locker_meat_provisioners",
                                  "fuel_dealers_non_automotive",
                                  "funeral_services_crematories",
                                  "furniture_home_furnishings_and_equipment_stores_except_appliances",
                                  "furniture_repair_refinishing",
                                  "furriers_and_fur_shops",
                                  "general_services",
                                  "gift_card_novelty_and_souvenir_shops",
                                  "glass_paint_and_wallpaper_stores",
                                  "glassware_crystal_stores",
                                  "golf_courses_public",
                                  "government_licensed_horse_dog_racing_us_region_only",
                                  "government_licensed_online_casions_online_gambling_us_region_only",
                                  "government_owned_lotteries_non_us_region",
                                  "government_owned_lotteries_us_region_only",
                                  "government_services",
                                  "grocery_stores_supermarkets",
                                  "hardware_equipment_and_supplies",
                                  "hardware_stores",
                                  "health_and_beauty_spas",
                                  "hearing_aids_sales_and_supplies",
                                  "heating_plumbing_a_c",
                                  "hobby_toy_and_game_shops",
                                  "home_supply_warehouse_stores",
                                  "hospitals",
                                  "hotels_motels_and_resorts",
                                  "household_appliance_stores",
                                  "industrial_supplies",
                                  "information_retrieval_services",
                                  "insurance_default",
                                  "insurance_underwriting_premiums",
                                  "intra_company_purchases",
                                  "jewelry_stores_watches_clocks_and_silverware_stores",
                                  "landscaping_services",
                                  "laundries",
                                  "laundry_cleaning_services",
                                  "legal_services_attorneys",
                                  "luggage_and_leather_goods_stores",
                                  "lumber_building_materials_stores",
                                  "manual_cash_disburse",
                                  "marinas_service_and_supplies",
                                  "marketplaces",
                                  "masonry_stonework_and_plaster",
                                  "massage_parlors",
                                  "medical_and_dental_labs",
                                  "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                                  "medical_services",
                                  "membership_organizations",
                                  "mens_and_boys_clothing_and_accessories_stores",
                                  "mens_womens_clothing_stores",
                                  "metal_service_centers",
                                  "miscellaneous",
                                  "miscellaneous_apparel_and_accessory_shops",
                                  "miscellaneous_auto_dealers",
                                  "miscellaneous_business_services",
                                  "miscellaneous_food_stores",
                                  "miscellaneous_general_merchandise",
                                  "miscellaneous_general_services",
                                  "miscellaneous_home_furnishing_specialty_stores",
                                  "miscellaneous_publishing_and_printing",
                                  "miscellaneous_recreation_services",
                                  "miscellaneous_repair_shops",
                                  "miscellaneous_specialty_retail",
                                  "mobile_home_dealers",
                                  "motion_picture_theaters",
                                  "motor_freight_carriers_and_trucking",
                                  "motor_homes_dealers",
                                  "motor_vehicle_supplies_and_new_parts",
                                  "motorcycle_shops_and_dealers",
                                  "motorcycle_shops_dealers",
                                  "music_stores_musical_instruments_pianos_and_sheet_music",
                                  "news_dealers_and_newsstands",
                                  "non_fi_money_orders",
                                  "non_fi_stored_value_card_purchase_load",
                                  "nondurable_goods",
                                  "nurseries_lawn_and_garden_supply_stores",
                                  "nursing_personal_care",
                                  "office_and_commercial_furniture",
                                  "opticians_eyeglasses",
                                  "optometrists_ophthalmologist",
                                  "orthopedic_goods_prosthetic_devices",
                                  "osteopaths",
                                  "package_stores_beer_wine_and_liquor",
                                  "paints_varnishes_and_supplies",
                                  "parking_lots_garages",
                                  "passenger_railways",
                                  "pawn_shops",
                                  "pet_shops_pet_food_and_supplies",
                                  "petroleum_and_petroleum_products",
                                  "photo_developing",
                                  "photographic_photocopy_microfilm_equipment_and_supplies",
                                  "photographic_studios",
                                  "picture_video_production",
                                  "piece_goods_notions_and_other_dry_goods",
                                  "plumbing_heating_equipment_and_supplies",
                                  "political_organizations",
                                  "postal_services_government_only",
                                  "precious_stones_and_metals_watches_and_jewelry",
                                  "professional_services",
                                  "public_warehousing_and_storage",
                                  "quick_copy_repro_and_blueprint",
                                  "railroads",
                                  "real_estate_agents_and_managers_rentals",
                                  "record_stores",
                                  "recreational_vehicle_rentals",
                                  "religious_goods_stores",
                                  "religious_organizations",
                                  "roofing_siding_sheet_metal",
                                  "secretarial_support_services",
                                  "security_brokers_dealers",
                                  "service_stations",
                                  "sewing_needlework_fabric_and_piece_goods_stores",
                                  "shoe_repair_hat_cleaning",
                                  "shoe_stores",
                                  "small_appliance_repair",
                                  "snowmobile_dealers",
                                  "special_trade_services",
                                  "specialty_cleaning",
                                  "sporting_goods_stores",
                                  "sporting_recreation_camps",
                                  "sports_and_riding_apparel_stores",
                                  "sports_clubs_fields",
                                  "stamp_and_coin_stores",
                                  "stationary_office_supplies_printing_and_writing_paper",
                                  "stationery_stores_office_and_school_supply_stores",
                                  "swimming_pools_sales",
                                  "t_ui_travel_germany",
                                  "tailors_alterations",
                                  "tax_payments_government_agencies",
                                  "tax_preparation_services",
                                  "taxicabs_limousines",
                                  "telecommunication_equipment_and_telephone_sales",
                                  "telecommunication_services",
                                  "telegraph_services",
                                  "tent_and_awning_shops",
                                  "testing_laboratories",
                                  "theatrical_ticket_agencies",
                                  "timeshares",
                                  "tire_retreading_and_repair",
                                  "tolls_bridge_fees",
                                  "tourist_attractions_and_exhibits",
                                  "towing_services",
                                  "trailer_parks_campgrounds",
                                  "transportation_services",
                                  "travel_agencies_tour_operators",
                                  "truck_stop_iteration",
                                  "truck_utility_trailer_rentals",
                                  "typesetting_plate_making_and_related_services",
                                  "typewriter_stores",
                                  "u_s_federal_government_agencies_or_departments",
                                  "uniforms_commercial_clothing",
                                  "used_merchandise_and_secondhand_stores",
                                  "utilities",
                                  "variety_stores",
                                  "veterinary_services",
                                  "video_amusement_game_supplies",
                                  "video_game_arcades",
                                  "video_tape_rental_stores",
                                  "vocational_trade_schools",
                                  "watch_jewelry_repair",
                                  "welding_repair",
                                  "wholesale_clubs",
                                  "wig_and_toupee_stores",
                                  "wires_money_orders",
                                  "womens_accessory_and_specialty_shops",
                                  "womens_ready_to_wear_stores",
                                  "wrecking_and_salvage_yards"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            "interval": {
                              "enum": [
                                "all_time",
                                "daily",
                                "monthly",
                                "per_authorization",
                                "weekly",
                                "yearly"
                              ],
                              "type": "string"
                            }
                          },
                          "required": ["amount", "interval"],
                          "title": "spending_limits_param",
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "title": "authorization_controls_param",
                    "type": "object"
                  },
                  "status": {
                    "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.",
                    "enum": ["active", "inactive"],
                    "type": "string"
                  },
                  "type": {
                    "description": "The type of card to issue. Possible values are `physical` or `virtual`.",
                    "enum": ["physical", "virtual"],
                    "type": "string"
                  }
                },
                "required": ["currency", "type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a card"
      }
    },
    "/v1/issuing/cards/{card}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Card</code> object.</p>",
        "operationId": "GetIssuingCardsCard",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a card"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostIssuingCardsCard",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pin": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "spending_controls": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cancellation_reason": {
                    "description": "Reason why the `status` of this card is `canceled`.",
                    "enum": ["lost", "stolen"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "personalization_design": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "pin": {
                    "description": "The desired new PIN for this card.",
                    "properties": {
                      "encrypted_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "encrypted_pin_param",
                    "type": "object"
                  },
                  "shipping": {
                    "description": "Updated shipping information for the card.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["city", "country", "line1", "postal_code"],
                        "title": "required_address",
                        "type": "object"
                      },
                      "address_validation": {
                        "properties": {
                          "mode": {
                            "enum": [
                              "disabled",
                              "normalization_only",
                              "validation_and_normalization"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["mode"],
                        "title": "address_validation_param",
                        "type": "object"
                      },
                      "customs": {
                        "properties": {
                          "eori_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "customs_param",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone_number": {
                        "type": "string"
                      },
                      "require_signature": {
                        "type": "boolean"
                      },
                      "service": {
                        "enum": ["express", "priority", "standard"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "type": {
                        "enum": ["bulk", "individual"],
                        "type": "string"
                      }
                    },
                    "required": ["address", "name"],
                    "title": "shipping_specs",
                    "type": "object"
                  },
                  "spending_controls": {
                    "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
                    "properties": {
                      "allowed_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "allowed_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_categories": {
                        "items": {
                          "enum": [
                            "ac_refrigeration_repair",
                            "accounting_bookkeeping_services",
                            "advertising_services",
                            "agricultural_cooperative",
                            "airlines_air_carriers",
                            "airports_flying_fields",
                            "ambulance_services",
                            "amusement_parks_carnivals",
                            "antique_reproductions",
                            "antique_shops",
                            "aquariums",
                            "architectural_surveying_services",
                            "art_dealers_and_galleries",
                            "artists_supply_and_craft_shops",
                            "auto_and_home_supply_stores",
                            "auto_body_repair_shops",
                            "auto_paint_shops",
                            "auto_service_shops",
                            "automated_cash_disburse",
                            "automated_fuel_dispensers",
                            "automobile_associations",
                            "automotive_parts_and_accessories_stores",
                            "automotive_tire_stores",
                            "bail_and_bond_payments",
                            "bakeries",
                            "bands_orchestras",
                            "barber_and_beauty_shops",
                            "betting_casino_gambling",
                            "bicycle_shops",
                            "billiard_pool_establishments",
                            "boat_dealers",
                            "boat_rentals_and_leases",
                            "book_stores",
                            "books_periodicals_and_newspapers",
                            "bowling_alleys",
                            "bus_lines",
                            "business_secretarial_schools",
                            "buying_shopping_services",
                            "cable_satellite_and_other_pay_television_and_radio",
                            "camera_and_photographic_supply_stores",
                            "candy_nut_and_confectionery_stores",
                            "car_and_truck_dealers_new_used",
                            "car_and_truck_dealers_used_only",
                            "car_rental_agencies",
                            "car_washes",
                            "carpentry_services",
                            "carpet_upholstery_cleaning",
                            "caterers",
                            "charitable_and_social_service_organizations_fundraising",
                            "chemicals_and_allied_products",
                            "child_care_services",
                            "childrens_and_infants_wear_stores",
                            "chiropodists_podiatrists",
                            "chiropractors",
                            "cigar_stores_and_stands",
                            "civic_social_fraternal_associations",
                            "cleaning_and_maintenance",
                            "clothing_rental",
                            "colleges_universities",
                            "commercial_equipment",
                            "commercial_footwear",
                            "commercial_photography_art_and_graphics",
                            "commuter_transport_and_ferries",
                            "computer_network_services",
                            "computer_programming",
                            "computer_repair",
                            "computer_software_stores",
                            "computers_peripherals_and_software",
                            "concrete_work_services",
                            "construction_materials",
                            "consulting_public_relations",
                            "correspondence_schools",
                            "cosmetic_stores",
                            "counseling_services",
                            "country_clubs",
                            "courier_services",
                            "court_costs",
                            "credit_reporting_agencies",
                            "cruise_lines",
                            "dairy_products_stores",
                            "dance_hall_studios_schools",
                            "dating_escort_services",
                            "dentists_orthodontists",
                            "department_stores",
                            "detective_agencies",
                            "digital_goods_applications",
                            "digital_goods_games",
                            "digital_goods_large_volume",
                            "digital_goods_media",
                            "direct_marketing_catalog_merchant",
                            "direct_marketing_combination_catalog_and_retail_merchant",
                            "direct_marketing_inbound_telemarketing",
                            "direct_marketing_insurance_services",
                            "direct_marketing_other",
                            "direct_marketing_outbound_telemarketing",
                            "direct_marketing_subscription",
                            "direct_marketing_travel",
                            "discount_stores",
                            "doctors",
                            "door_to_door_sales",
                            "drapery_window_covering_and_upholstery_stores",
                            "drinking_places",
                            "drug_stores_and_pharmacies",
                            "drugs_drug_proprietaries_and_druggist_sundries",
                            "dry_cleaners",
                            "durable_goods",
                            "duty_free_stores",
                            "eating_places_restaurants",
                            "educational_services",
                            "electric_razor_stores",
                            "electric_vehicle_charging",
                            "electrical_parts_and_equipment",
                            "electrical_services",
                            "electronics_repair_shops",
                            "electronics_stores",
                            "elementary_secondary_schools",
                            "emergency_services_gcas_visa_use_only",
                            "employment_temp_agencies",
                            "equipment_rental",
                            "exterminating_services",
                            "family_clothing_stores",
                            "fast_food_restaurants",
                            "financial_institutions",
                            "fines_government_administrative_entities",
                            "fireplace_fireplace_screens_and_accessories_stores",
                            "floor_covering_stores",
                            "florists",
                            "florists_supplies_nursery_stock_and_flowers",
                            "freezer_and_locker_meat_provisioners",
                            "fuel_dealers_non_automotive",
                            "funeral_services_crematories",
                            "furniture_home_furnishings_and_equipment_stores_except_appliances",
                            "furniture_repair_refinishing",
                            "furriers_and_fur_shops",
                            "general_services",
                            "gift_card_novelty_and_souvenir_shops",
                            "glass_paint_and_wallpaper_stores",
                            "glassware_crystal_stores",
                            "golf_courses_public",
                            "government_licensed_horse_dog_racing_us_region_only",
                            "government_licensed_online_casions_online_gambling_us_region_only",
                            "government_owned_lotteries_non_us_region",
                            "government_owned_lotteries_us_region_only",
                            "government_services",
                            "grocery_stores_supermarkets",
                            "hardware_equipment_and_supplies",
                            "hardware_stores",
                            "health_and_beauty_spas",
                            "hearing_aids_sales_and_supplies",
                            "heating_plumbing_a_c",
                            "hobby_toy_and_game_shops",
                            "home_supply_warehouse_stores",
                            "hospitals",
                            "hotels_motels_and_resorts",
                            "household_appliance_stores",
                            "industrial_supplies",
                            "information_retrieval_services",
                            "insurance_default",
                            "insurance_underwriting_premiums",
                            "intra_company_purchases",
                            "jewelry_stores_watches_clocks_and_silverware_stores",
                            "landscaping_services",
                            "laundries",
                            "laundry_cleaning_services",
                            "legal_services_attorneys",
                            "luggage_and_leather_goods_stores",
                            "lumber_building_materials_stores",
                            "manual_cash_disburse",
                            "marinas_service_and_supplies",
                            "marketplaces",
                            "masonry_stonework_and_plaster",
                            "massage_parlors",
                            "medical_and_dental_labs",
                            "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                            "medical_services",
                            "membership_organizations",
                            "mens_and_boys_clothing_and_accessories_stores",
                            "mens_womens_clothing_stores",
                            "metal_service_centers",
                            "miscellaneous",
                            "miscellaneous_apparel_and_accessory_shops",
                            "miscellaneous_auto_dealers",
                            "miscellaneous_business_services",
                            "miscellaneous_food_stores",
                            "miscellaneous_general_merchandise",
                            "miscellaneous_general_services",
                            "miscellaneous_home_furnishing_specialty_stores",
                            "miscellaneous_publishing_and_printing",
                            "miscellaneous_recreation_services",
                            "miscellaneous_repair_shops",
                            "miscellaneous_specialty_retail",
                            "mobile_home_dealers",
                            "motion_picture_theaters",
                            "motor_freight_carriers_and_trucking",
                            "motor_homes_dealers",
                            "motor_vehicle_supplies_and_new_parts",
                            "motorcycle_shops_and_dealers",
                            "motorcycle_shops_dealers",
                            "music_stores_musical_instruments_pianos_and_sheet_music",
                            "news_dealers_and_newsstands",
                            "non_fi_money_orders",
                            "non_fi_stored_value_card_purchase_load",
                            "nondurable_goods",
                            "nurseries_lawn_and_garden_supply_stores",
                            "nursing_personal_care",
                            "office_and_commercial_furniture",
                            "opticians_eyeglasses",
                            "optometrists_ophthalmologist",
                            "orthopedic_goods_prosthetic_devices",
                            "osteopaths",
                            "package_stores_beer_wine_and_liquor",
                            "paints_varnishes_and_supplies",
                            "parking_lots_garages",
                            "passenger_railways",
                            "pawn_shops",
                            "pet_shops_pet_food_and_supplies",
                            "petroleum_and_petroleum_products",
                            "photo_developing",
                            "photographic_photocopy_microfilm_equipment_and_supplies",
                            "photographic_studios",
                            "picture_video_production",
                            "piece_goods_notions_and_other_dry_goods",
                            "plumbing_heating_equipment_and_supplies",
                            "political_organizations",
                            "postal_services_government_only",
                            "precious_stones_and_metals_watches_and_jewelry",
                            "professional_services",
                            "public_warehousing_and_storage",
                            "quick_copy_repro_and_blueprint",
                            "railroads",
                            "real_estate_agents_and_managers_rentals",
                            "record_stores",
                            "recreational_vehicle_rentals",
                            "religious_goods_stores",
                            "religious_organizations",
                            "roofing_siding_sheet_metal",
                            "secretarial_support_services",
                            "security_brokers_dealers",
                            "service_stations",
                            "sewing_needlework_fabric_and_piece_goods_stores",
                            "shoe_repair_hat_cleaning",
                            "shoe_stores",
                            "small_appliance_repair",
                            "snowmobile_dealers",
                            "special_trade_services",
                            "specialty_cleaning",
                            "sporting_goods_stores",
                            "sporting_recreation_camps",
                            "sports_and_riding_apparel_stores",
                            "sports_clubs_fields",
                            "stamp_and_coin_stores",
                            "stationary_office_supplies_printing_and_writing_paper",
                            "stationery_stores_office_and_school_supply_stores",
                            "swimming_pools_sales",
                            "t_ui_travel_germany",
                            "tailors_alterations",
                            "tax_payments_government_agencies",
                            "tax_preparation_services",
                            "taxicabs_limousines",
                            "telecommunication_equipment_and_telephone_sales",
                            "telecommunication_services",
                            "telegraph_services",
                            "tent_and_awning_shops",
                            "testing_laboratories",
                            "theatrical_ticket_agencies",
                            "timeshares",
                            "tire_retreading_and_repair",
                            "tolls_bridge_fees",
                            "tourist_attractions_and_exhibits",
                            "towing_services",
                            "trailer_parks_campgrounds",
                            "transportation_services",
                            "travel_agencies_tour_operators",
                            "truck_stop_iteration",
                            "truck_utility_trailer_rentals",
                            "typesetting_plate_making_and_related_services",
                            "typewriter_stores",
                            "u_s_federal_government_agencies_or_departments",
                            "uniforms_commercial_clothing",
                            "used_merchandise_and_secondhand_stores",
                            "utilities",
                            "variety_stores",
                            "veterinary_services",
                            "video_amusement_game_supplies",
                            "video_game_arcades",
                            "video_tape_rental_stores",
                            "vocational_trade_schools",
                            "watch_jewelry_repair",
                            "welding_repair",
                            "wholesale_clubs",
                            "wig_and_toupee_stores",
                            "wires_money_orders",
                            "womens_accessory_and_specialty_shops",
                            "womens_ready_to_wear_stores",
                            "wrecking_and_salvage_yards"
                          ],
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "blocked_merchant_countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "spending_limits": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "categories": {
                              "items": {
                                "enum": [
                                  "ac_refrigeration_repair",
                                  "accounting_bookkeeping_services",
                                  "advertising_services",
                                  "agricultural_cooperative",
                                  "airlines_air_carriers",
                                  "airports_flying_fields",
                                  "ambulance_services",
                                  "amusement_parks_carnivals",
                                  "antique_reproductions",
                                  "antique_shops",
                                  "aquariums",
                                  "architectural_surveying_services",
                                  "art_dealers_and_galleries",
                                  "artists_supply_and_craft_shops",
                                  "auto_and_home_supply_stores",
                                  "auto_body_repair_shops",
                                  "auto_paint_shops",
                                  "auto_service_shops",
                                  "automated_cash_disburse",
                                  "automated_fuel_dispensers",
                                  "automobile_associations",
                                  "automotive_parts_and_accessories_stores",
                                  "automotive_tire_stores",
                                  "bail_and_bond_payments",
                                  "bakeries",
                                  "bands_orchestras",
                                  "barber_and_beauty_shops",
                                  "betting_casino_gambling",
                                  "bicycle_shops",
                                  "billiard_pool_establishments",
                                  "boat_dealers",
                                  "boat_rentals_and_leases",
                                  "book_stores",
                                  "books_periodicals_and_newspapers",
                                  "bowling_alleys",
                                  "bus_lines",
                                  "business_secretarial_schools",
                                  "buying_shopping_services",
                                  "cable_satellite_and_other_pay_television_and_radio",
                                  "camera_and_photographic_supply_stores",
                                  "candy_nut_and_confectionery_stores",
                                  "car_and_truck_dealers_new_used",
                                  "car_and_truck_dealers_used_only",
                                  "car_rental_agencies",
                                  "car_washes",
                                  "carpentry_services",
                                  "carpet_upholstery_cleaning",
                                  "caterers",
                                  "charitable_and_social_service_organizations_fundraising",
                                  "chemicals_and_allied_products",
                                  "child_care_services",
                                  "childrens_and_infants_wear_stores",
                                  "chiropodists_podiatrists",
                                  "chiropractors",
                                  "cigar_stores_and_stands",
                                  "civic_social_fraternal_associations",
                                  "cleaning_and_maintenance",
                                  "clothing_rental",
                                  "colleges_universities",
                                  "commercial_equipment",
                                  "commercial_footwear",
                                  "commercial_photography_art_and_graphics",
                                  "commuter_transport_and_ferries",
                                  "computer_network_services",
                                  "computer_programming",
                                  "computer_repair",
                                  "computer_software_stores",
                                  "computers_peripherals_and_software",
                                  "concrete_work_services",
                                  "construction_materials",
                                  "consulting_public_relations",
                                  "correspondence_schools",
                                  "cosmetic_stores",
                                  "counseling_services",
                                  "country_clubs",
                                  "courier_services",
                                  "court_costs",
                                  "credit_reporting_agencies",
                                  "cruise_lines",
                                  "dairy_products_stores",
                                  "dance_hall_studios_schools",
                                  "dating_escort_services",
                                  "dentists_orthodontists",
                                  "department_stores",
                                  "detective_agencies",
                                  "digital_goods_applications",
                                  "digital_goods_games",
                                  "digital_goods_large_volume",
                                  "digital_goods_media",
                                  "direct_marketing_catalog_merchant",
                                  "direct_marketing_combination_catalog_and_retail_merchant",
                                  "direct_marketing_inbound_telemarketing",
                                  "direct_marketing_insurance_services",
                                  "direct_marketing_other",
                                  "direct_marketing_outbound_telemarketing",
                                  "direct_marketing_subscription",
                                  "direct_marketing_travel",
                                  "discount_stores",
                                  "doctors",
                                  "door_to_door_sales",
                                  "drapery_window_covering_and_upholstery_stores",
                                  "drinking_places",
                                  "drug_stores_and_pharmacies",
                                  "drugs_drug_proprietaries_and_druggist_sundries",
                                  "dry_cleaners",
                                  "durable_goods",
                                  "duty_free_stores",
                                  "eating_places_restaurants",
                                  "educational_services",
                                  "electric_razor_stores",
                                  "electric_vehicle_charging",
                                  "electrical_parts_and_equipment",
                                  "electrical_services",
                                  "electronics_repair_shops",
                                  "electronics_stores",
                                  "elementary_secondary_schools",
                                  "emergency_services_gcas_visa_use_only",
                                  "employment_temp_agencies",
                                  "equipment_rental",
                                  "exterminating_services",
                                  "family_clothing_stores",
                                  "fast_food_restaurants",
                                  "financial_institutions",
                                  "fines_government_administrative_entities",
                                  "fireplace_fireplace_screens_and_accessories_stores",
                                  "floor_covering_stores",
                                  "florists",
                                  "florists_supplies_nursery_stock_and_flowers",
                                  "freezer_and_locker_meat_provisioners",
                                  "fuel_dealers_non_automotive",
                                  "funeral_services_crematories",
                                  "furniture_home_furnishings_and_equipment_stores_except_appliances",
                                  "furniture_repair_refinishing",
                                  "furriers_and_fur_shops",
                                  "general_services",
                                  "gift_card_novelty_and_souvenir_shops",
                                  "glass_paint_and_wallpaper_stores",
                                  "glassware_crystal_stores",
                                  "golf_courses_public",
                                  "government_licensed_horse_dog_racing_us_region_only",
                                  "government_licensed_online_casions_online_gambling_us_region_only",
                                  "government_owned_lotteries_non_us_region",
                                  "government_owned_lotteries_us_region_only",
                                  "government_services",
                                  "grocery_stores_supermarkets",
                                  "hardware_equipment_and_supplies",
                                  "hardware_stores",
                                  "health_and_beauty_spas",
                                  "hearing_aids_sales_and_supplies",
                                  "heating_plumbing_a_c",
                                  "hobby_toy_and_game_shops",
                                  "home_supply_warehouse_stores",
                                  "hospitals",
                                  "hotels_motels_and_resorts",
                                  "household_appliance_stores",
                                  "industrial_supplies",
                                  "information_retrieval_services",
                                  "insurance_default",
                                  "insurance_underwriting_premiums",
                                  "intra_company_purchases",
                                  "jewelry_stores_watches_clocks_and_silverware_stores",
                                  "landscaping_services",
                                  "laundries",
                                  "laundry_cleaning_services",
                                  "legal_services_attorneys",
                                  "luggage_and_leather_goods_stores",
                                  "lumber_building_materials_stores",
                                  "manual_cash_disburse",
                                  "marinas_service_and_supplies",
                                  "marketplaces",
                                  "masonry_stonework_and_plaster",
                                  "massage_parlors",
                                  "medical_and_dental_labs",
                                  "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                                  "medical_services",
                                  "membership_organizations",
                                  "mens_and_boys_clothing_and_accessories_stores",
                                  "mens_womens_clothing_stores",
                                  "metal_service_centers",
                                  "miscellaneous",
                                  "miscellaneous_apparel_and_accessory_shops",
                                  "miscellaneous_auto_dealers",
                                  "miscellaneous_business_services",
                                  "miscellaneous_food_stores",
                                  "miscellaneous_general_merchandise",
                                  "miscellaneous_general_services",
                                  "miscellaneous_home_furnishing_specialty_stores",
                                  "miscellaneous_publishing_and_printing",
                                  "miscellaneous_recreation_services",
                                  "miscellaneous_repair_shops",
                                  "miscellaneous_specialty_retail",
                                  "mobile_home_dealers",
                                  "motion_picture_theaters",
                                  "motor_freight_carriers_and_trucking",
                                  "motor_homes_dealers",
                                  "motor_vehicle_supplies_and_new_parts",
                                  "motorcycle_shops_and_dealers",
                                  "motorcycle_shops_dealers",
                                  "music_stores_musical_instruments_pianos_and_sheet_music",
                                  "news_dealers_and_newsstands",
                                  "non_fi_money_orders",
                                  "non_fi_stored_value_card_purchase_load",
                                  "nondurable_goods",
                                  "nurseries_lawn_and_garden_supply_stores",
                                  "nursing_personal_care",
                                  "office_and_commercial_furniture",
                                  "opticians_eyeglasses",
                                  "optometrists_ophthalmologist",
                                  "orthopedic_goods_prosthetic_devices",
                                  "osteopaths",
                                  "package_stores_beer_wine_and_liquor",
                                  "paints_varnishes_and_supplies",
                                  "parking_lots_garages",
                                  "passenger_railways",
                                  "pawn_shops",
                                  "pet_shops_pet_food_and_supplies",
                                  "petroleum_and_petroleum_products",
                                  "photo_developing",
                                  "photographic_photocopy_microfilm_equipment_and_supplies",
                                  "photographic_studios",
                                  "picture_video_production",
                                  "piece_goods_notions_and_other_dry_goods",
                                  "plumbing_heating_equipment_and_supplies",
                                  "political_organizations",
                                  "postal_services_government_only",
                                  "precious_stones_and_metals_watches_and_jewelry",
                                  "professional_services",
                                  "public_warehousing_and_storage",
                                  "quick_copy_repro_and_blueprint",
                                  "railroads",
                                  "real_estate_agents_and_managers_rentals",
                                  "record_stores",
                                  "recreational_vehicle_rentals",
                                  "religious_goods_stores",
                                  "religious_organizations",
                                  "roofing_siding_sheet_metal",
                                  "secretarial_support_services",
                                  "security_brokers_dealers",
                                  "service_stations",
                                  "sewing_needlework_fabric_and_piece_goods_stores",
                                  "shoe_repair_hat_cleaning",
                                  "shoe_stores",
                                  "small_appliance_repair",
                                  "snowmobile_dealers",
                                  "special_trade_services",
                                  "specialty_cleaning",
                                  "sporting_goods_stores",
                                  "sporting_recreation_camps",
                                  "sports_and_riding_apparel_stores",
                                  "sports_clubs_fields",
                                  "stamp_and_coin_stores",
                                  "stationary_office_supplies_printing_and_writing_paper",
                                  "stationery_stores_office_and_school_supply_stores",
                                  "swimming_pools_sales",
                                  "t_ui_travel_germany",
                                  "tailors_alterations",
                                  "tax_payments_government_agencies",
                                  "tax_preparation_services",
                                  "taxicabs_limousines",
                                  "telecommunication_equipment_and_telephone_sales",
                                  "telecommunication_services",
                                  "telegraph_services",
                                  "tent_and_awning_shops",
                                  "testing_laboratories",
                                  "theatrical_ticket_agencies",
                                  "timeshares",
                                  "tire_retreading_and_repair",
                                  "tolls_bridge_fees",
                                  "tourist_attractions_and_exhibits",
                                  "towing_services",
                                  "trailer_parks_campgrounds",
                                  "transportation_services",
                                  "travel_agencies_tour_operators",
                                  "truck_stop_iteration",
                                  "truck_utility_trailer_rentals",
                                  "typesetting_plate_making_and_related_services",
                                  "typewriter_stores",
                                  "u_s_federal_government_agencies_or_departments",
                                  "uniforms_commercial_clothing",
                                  "used_merchandise_and_secondhand_stores",
                                  "utilities",
                                  "variety_stores",
                                  "veterinary_services",
                                  "video_amusement_game_supplies",
                                  "video_game_arcades",
                                  "video_tape_rental_stores",
                                  "vocational_trade_schools",
                                  "watch_jewelry_repair",
                                  "welding_repair",
                                  "wholesale_clubs",
                                  "wig_and_toupee_stores",
                                  "wires_money_orders",
                                  "womens_accessory_and_specialty_shops",
                                  "womens_ready_to_wear_stores",
                                  "wrecking_and_salvage_yards"
                                ],
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            "interval": {
                              "enum": [
                                "all_time",
                                "daily",
                                "monthly",
                                "per_authorization",
                                "weekly",
                                "yearly"
                              ],
                              "type": "string"
                            }
                          },
                          "required": ["amount", "interval"],
                          "title": "spending_limits_param",
                          "type": "object"
                        },
                        "type": "array"
                      }
                    },
                    "title": "authorization_controls_param",
                    "type": "object"
                  },
                  "status": {
                    "description": "Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. If this card is being canceled because it was lost or stolen, this information should be provided as `cancellation_reason`.",
                    "enum": ["active", "canceled", "inactive"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a card"
      }
    },
    "/v1/issuing/disputes": {
      "get": {
        "description": "<p>Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingDisputes",
        "parameters": [
          {
            "description": "Only return Issuing disputes that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Select Issuing disputes with the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["expired", "lost", "submitted", "unsubmitted", "won"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Select the Issuing dispute for the given transaction.",
            "in": "query",
            "name": "transaction",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.dispute"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/disputes",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingDisputeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all disputes"
      },
      "post": {
        "description": "<p>Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href=\"/docs/issuing/purchases/disputes#dispute-reasons-and-evidence\">Dispute reasons and evidence</a> for more details about evidence requirements.</p>",
        "operationId": "PostIssuingDisputes",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "evidence": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "treasury": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.",
                    "type": "integer"
                  },
                  "evidence": {
                    "description": "Evidence provided for the dispute.",
                    "properties": {
                      "canceled": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "canceled_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_policy_provided": {
                                "anyOf": [
                                  {
                                    "type": "boolean"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_reason": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expected_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              },
                              "return_status": {
                                "enum": ["", "merchant_rejected", "successful"],
                                "type": "string"
                              },
                              "returned_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "canceled",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "duplicate": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "card_statement": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cash_receipt": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "check_image": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "original_transaction": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "duplicate",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "fraudulent": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "fraudulent",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "merchandise_not_as_described": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "received_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "return_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "return_status": {
                                "enum": ["", "merchant_rejected", "successful"],
                                "type": "string"
                              },
                              "returned_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "merchandise_not_as_described",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "no_valid_authorization": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "no_valid_authorization",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "not_received": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expected_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              }
                            },
                            "title": "not_received",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "other": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              }
                            },
                            "title": "other",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "reason": {
                        "enum": [
                          "canceled",
                          "duplicate",
                          "fraudulent",
                          "merchandise_not_as_described",
                          "no_valid_authorization",
                          "not_received",
                          "other",
                          "service_not_as_described"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "service_not_as_described": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "canceled_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_reason": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "received_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "service_not_as_described",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "evidence_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "transaction": {
                    "description": "The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "treasury": {
                    "description": "Params for disputes related to Treasury FinancialAccounts",
                    "properties": {
                      "received_debit": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["received_debit"],
                    "title": "treasury_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a dispute"
      }
    },
    "/v1/issuing/disputes/{dispute}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Dispute</code> object.</p>",
        "operationId": "GetIssuingDisputesDispute",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a dispute"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string.</p>",
        "operationId": "PostIssuingDisputesDispute",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "evidence": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "evidence": {
                    "description": "Evidence provided for the dispute.",
                    "properties": {
                      "canceled": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "canceled_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_policy_provided": {
                                "anyOf": [
                                  {
                                    "type": "boolean"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_reason": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expected_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              },
                              "return_status": {
                                "enum": ["", "merchant_rejected", "successful"],
                                "type": "string"
                              },
                              "returned_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "canceled",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "duplicate": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "card_statement": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cash_receipt": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "check_image": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "original_transaction": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "duplicate",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "fraudulent": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "fraudulent",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "merchandise_not_as_described": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "received_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "return_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "return_status": {
                                "enum": ["", "merchant_rejected", "successful"],
                                "type": "string"
                              },
                              "returned_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "merchandise_not_as_described",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "no_valid_authorization": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "no_valid_authorization",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "not_received": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expected_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              }
                            },
                            "title": "not_received",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "other": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_type": {
                                "enum": ["", "merchandise", "service"],
                                "type": "string"
                              }
                            },
                            "title": "other",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "reason": {
                        "enum": [
                          "canceled",
                          "duplicate",
                          "fraudulent",
                          "merchandise_not_as_described",
                          "no_valid_authorization",
                          "not_received",
                          "other",
                          "service_not_as_described"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "service_not_as_described": {
                        "anyOf": [
                          {
                            "properties": {
                              "additional_documentation": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "canceled_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "cancellation_reason": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "explanation": {
                                "anyOf": [
                                  {
                                    "maxLength": 2500,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "received_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "service_not_as_described",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "evidence_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a dispute"
      }
    },
    "/v1/issuing/disputes/{dispute}/submit": {
      "post": {
        "description": "<p>Submits an Issuing <code>Dispute</code> to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see <a href=\"/docs/issuing/purchases/disputes#dispute-reasons-and-evidence\">Dispute reasons and evidence</a>.</p>",
        "operationId": "PostIssuingDisputesDisputeSubmit",
        "parameters": [
          {
            "in": "path",
            "name": "dispute",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.dispute"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Submit a dispute"
      }
    },
    "/v1/issuing/personalization_designs": {
      "get": {
        "description": "<p>Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingPersonalizationDesigns",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return personalization designs with the given lookup keys.",
            "explode": true,
            "in": "query",
            "name": "lookup_keys",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 200,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return personalization designs with the given preferences.",
            "explode": true,
            "in": "query",
            "name": "preferences",
            "required": false,
            "schema": {
              "properties": {
                "is_default": {
                  "type": "boolean"
                },
                "is_platform_default": {
                  "type": "boolean"
                }
              },
              "title": "preferences_list_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return personalization designs with the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "inactive", "rejected", "review"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.personalization_design"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/personalization_designs",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingPersonalizationDesignList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all personalization designs"
      },
      "post": {
        "description": "<p>Creates a personalization design object.</p>",
        "operationId": "PostIssuingPersonalizationDesigns",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "carrier_text": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferences": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "card_logo": {
                    "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.",
                    "type": "string"
                  },
                  "carrier_text": {
                    "description": "Hash containing carrier text, for use with physical bundles that support carrier text.",
                    "properties": {
                      "footer_body": {
                        "anyOf": [
                          {
                            "maxLength": 200,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "footer_title": {
                        "anyOf": [
                          {
                            "maxLength": 30,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "header_body": {
                        "anyOf": [
                          {
                            "maxLength": 200,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "header_title": {
                        "anyOf": [
                          {
                            "maxLength": 30,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "carrier_text_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "lookup_key": {
                    "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.",
                    "maxLength": 200,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "description": "Friendly display name.",
                    "maxLength": 200,
                    "type": "string"
                  },
                  "physical_bundle": {
                    "description": "The physical bundle object belonging to this personalization design.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "preferences": {
                    "description": "Information on whether this personalization design is used to create cards when one is not specified.",
                    "properties": {
                      "is_default": {
                        "type": "boolean"
                      }
                    },
                    "required": ["is_default"],
                    "title": "preferences_param",
                    "type": "object"
                  },
                  "transfer_lookup_key": {
                    "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
                    "type": "boolean"
                  }
                },
                "required": ["physical_bundle"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a personalization design"
      }
    },
    "/v1/issuing/personalization_designs/{personalization_design}": {
      "get": {
        "description": "<p>Retrieves a personalization design object.</p>",
        "operationId": "GetIssuingPersonalizationDesignsPersonalizationDesign",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "personalization_design",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a personalization design"
      },
      "post": {
        "description": "<p>Updates a card personalization object.</p>",
        "operationId": "PostIssuingPersonalizationDesignsPersonalizationDesign",
        "parameters": [
          {
            "in": "path",
            "name": "personalization_design",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "card_logo": {
                  "explode": true,
                  "style": "deepObject"
                },
                "carrier_text": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "lookup_key": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "name": {
                  "explode": true,
                  "style": "deepObject"
                },
                "preferences": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "card_logo": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`."
                  },
                  "carrier_text": {
                    "anyOf": [
                      {
                        "properties": {
                          "footer_body": {
                            "anyOf": [
                              {
                                "maxLength": 200,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "footer_title": {
                            "anyOf": [
                              {
                                "maxLength": 30,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "header_body": {
                            "anyOf": [
                              {
                                "maxLength": 200,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "header_title": {
                            "anyOf": [
                              {
                                "maxLength": 30,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "carrier_text_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Hash containing carrier text, for use with physical bundles that support carrier text."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "lookup_key": {
                    "anyOf": [
                      {
                        "maxLength": 200,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "anyOf": [
                      {
                        "maxLength": 200,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Friendly display name. Providing an empty string will set the field to null."
                  },
                  "physical_bundle": {
                    "description": "The physical bundle object belonging to this personalization design.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "preferences": {
                    "description": "Information on whether this personalization design is used to create cards when one is not specified.",
                    "properties": {
                      "is_default": {
                        "type": "boolean"
                      }
                    },
                    "required": ["is_default"],
                    "title": "preferences_param",
                    "type": "object"
                  },
                  "transfer_lookup_key": {
                    "description": "If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a personalization design"
      }
    },
    "/v1/issuing/physical_bundles": {
      "get": {
        "description": "<p>Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingPhysicalBundles",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return physical bundles with the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "inactive", "review"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return physical bundles with the given type.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["custom", "standard"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.physical_bundle"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/physical_bundles",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingPhysicalBundleList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all physical bundles"
      }
    },
    "/v1/issuing/physical_bundles/{physical_bundle}": {
      "get": {
        "description": "<p>Retrieves a physical bundle object.</p>",
        "operationId": "GetIssuingPhysicalBundlesPhysicalBundle",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "physical_bundle",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.physical_bundle"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a physical bundle"
      }
    },
    "/v1/issuing/settlements/{settlement}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Settlement</code> object.</p>",
        "operationId": "GetIssuingSettlementsSettlement",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "settlement",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.settlement"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a settlement"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostIssuingSettlementsSettlement",
        "parameters": [
          {
            "in": "path",
            "name": "settlement",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.settlement"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a settlement"
      }
    },
    "/v1/issuing/tokens": {
      "get": {
        "description": "<p>Lists all Issuing <code>Token</code> objects for a given card.</p>",
        "operationId": "GetIssuingTokens",
        "parameters": [
          {
            "description": "The Issuing card identifier to list tokens for.",
            "in": "query",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return Issuing tokens that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Select Issuing tokens with the given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "deleted", "requested", "suspended"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.token"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingNetworkTokenList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all issuing tokens for card"
      }
    },
    "/v1/issuing/tokens/{token}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Token</code> object.</p>",
        "operationId": "GetIssuingTokensToken",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an issuing token"
      },
      "post": {
        "description": "<p>Attempts to update the specified Issuing <code>Token</code> object to the status specified.</p>",
        "operationId": "PostIssuingTokensToken",
        "parameters": [
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "status": {
                    "description": "Specifies which status the token should be updated to.",
                    "enum": ["active", "deleted", "suspended"],
                    "type": "string"
                  }
                },
                "required": ["status"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a token status"
      }
    },
    "/v1/issuing/transactions": {
      "get": {
        "description": "<p>Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetIssuingTransactions",
        "parameters": [
          {
            "description": "Only return transactions that belong to the given card.",
            "in": "query",
            "name": "card",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return transactions that belong to the given cardholder.",
            "in": "query",
            "name": "cardholder",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return transactions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return transactions that have the given type. One of `capture` or `refund`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["capture", "refund"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/issuing.transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/issuing/transactions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "IssuingTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all transactions"
      }
    },
    "/v1/issuing/transactions/{transaction}": {
      "get": {
        "description": "<p>Retrieves an Issuing <code>Transaction</code> object.</p>",
        "operationId": "GetIssuingTransactionsTransaction",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a transaction"
      },
      "post": {
        "description": "<p>Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostIssuingTransactionsTransaction",
        "parameters": [
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a transaction"
      }
    },
    "/v1/link_account_sessions": {
      "post": {
        "description": "<p>To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.</p>",
        "operationId": "PostLinkAccountSessions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "account_holder": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "filters": {
                  "explode": true,
                  "style": "deepObject"
                },
                "permissions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "prefetch": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account_holder": {
                    "description": "The account holder to link accounts for.",
                    "properties": {
                      "account": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "customer": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "customer"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "accountholder_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "filters": {
                    "description": "Filters to restrict the kinds of accounts to collect.",
                    "properties": {
                      "account_subcategories": {
                        "items": {
                          "enum": [
                            "checking",
                            "credit_card",
                            "line_of_credit",
                            "mortgage",
                            "savings"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "countries": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "title": "filters_params",
                    "type": "object"
                  },
                  "permissions": {
                    "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
                    "items": {
                      "enum": [
                        "balances",
                        "ownership",
                        "payment_method",
                        "transactions"
                      ],
                      "maxLength": 5000,
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "prefetch": {
                    "description": "List of data features that you would like to retrieve upon account creation.",
                    "items": {
                      "enum": ["balances", "ownership", "transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "return_url": {
                    "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["account_holder", "permissions"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Session"
      }
    },
    "/v1/link_account_sessions/{session}": {
      "get": {
        "description": "<p>Retrieves the details of a Financial Connections <code>Session</code></p>",
        "operationId": "GetLinkAccountSessionsSession",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "session",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.session"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Session"
      }
    },
    "/v1/linked_accounts": {
      "get": {
        "description": "<p>Returns a list of Financial Connections <code>Account</code> objects.</p>",
        "operationId": "GetLinkedAccounts",
        "parameters": [
          {
            "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.",
            "explode": true,
            "in": "query",
            "name": "account_holder",
            "required": false,
            "schema": {
              "properties": {
                "account": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "customer": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "title": "accountholder_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "If present, only return accounts that were collected as part of the given session.",
            "in": "query",
            "name": "session",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/financial_connections.account"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/financial_connections/accounts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankConnectionsResourceLinkedAccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Accounts"
      }
    },
    "/v1/linked_accounts/{account}": {
      "get": {
        "description": "<p>Retrieves the details of an Financial Connections <code>Account</code>.</p>",
        "operationId": "GetLinkedAccountsAccount",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an Account"
      }
    },
    "/v1/linked_accounts/{account}/disconnect": {
      "post": {
        "description": "<p>Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).</p>",
        "operationId": "PostLinkedAccountsAccountDisconnect",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Disconnect an Account"
      }
    },
    "/v1/linked_accounts/{account}/owners": {
      "get": {
        "description": "<p>Lists all owners for a given <code>Account</code></p>",
        "operationId": "GetLinkedAccountsAccountOwners",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The ID of the ownership object to fetch owners from.",
            "in": "query",
            "name": "ownership",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/financial_connections.account_owner"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BankConnectionsResourceOwnerList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List Account Owners"
      }
    },
    "/v1/linked_accounts/{account}/refresh": {
      "post": {
        "description": "<p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p>",
        "operationId": "PostLinkedAccountsAccountRefresh",
        "parameters": [
          {
            "in": "path",
            "name": "account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "The list of account features that you would like to refresh.",
                    "items": {
                      "enum": ["balance", "ownership", "transactions"],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  }
                },
                "required": ["features"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/financial_connections.account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Refresh Account data"
      }
    },
    "/v1/mandates/{mandate}": {
      "get": {
        "description": "<p>Retrieves a Mandate object.</p>",
        "operationId": "GetMandatesMandate",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "mandate",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mandate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Mandate"
      }
    },
    "/v1/payment_intents": {
      "get": {
        "description": "<p>Returns a list of PaymentIntents.</p>",
        "operationId": "GetPaymentIntents",
        "parameters": [
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return PaymentIntents for the customer that this customer ID specifies.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_intent"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payment_intents",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentFlowsPaymentIntentList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all PaymentIntents"
      },
      "post": {
        "description": "<p>Creates a PaymentIntent object.</p>\n\n<p>After the PaymentIntent is created, attach a payment method and <a href=\"/docs/api/payment_intents/confirm\">confirm</a>\nto continue the payment. Learn more about <a href=\"/docs/payments/payment-intents\">the available payment flows\nwith the Payment Intents API</a>.</p>\n\n<p>When you use <code>confirm=true</code> during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the <a href=\"/docs/api/payment_intents/confirm\">confirm API</a> when you supply\n<code>confirm=true</code>.</p>",
        "operationId": "PostPaymentIntents",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "automatic_payment_methods": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "off_session": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "radar_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "type": "integer"
                  },
                  "automatic_payment_methods": {
                    "description": "When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.",
                    "properties": {
                      "allow_redirects": {
                        "enum": ["always", "never"],
                        "type": "string"
                      },
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_payment_methods_param",
                    "type": "object"
                  },
                  "capture_method": {
                    "description": "Controls when the funds will be captured from the customer's account.",
                    "enum": ["automatic", "automatic_async", "manual"],
                    "type": "string"
                  },
                  "confirm": {
                    "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).",
                    "type": "boolean"
                  },
                  "confirmation_method": {
                    "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.",
                    "enum": ["automatic", "manual"],
                    "type": "string"
                  },
                  "confirmation_token": {
                    "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "error_on_requires_action": {
                    "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "mandate": {
                    "description": "ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "mandate_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "accepted_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "offline": {
                                "properties": {},
                                "title": "offline_param",
                                "type": "object"
                              },
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["ip_address", "user_agent"],
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["offline", "online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "secret_key_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)."
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "off_session": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "enum": ["one_off", "recurring"],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)."
                  },
                  "on_behalf_of": {
                    "description": "The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "type": "string"
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.\n\nIf you omit this parameter with `confirm=true`, `customer.default_source` attaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_configuration": {
                    "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment method-specific configuration for this PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "custom_mandate_url": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  },
                                  "interval_description": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "payment_schedule": {
                                    "enum": [
                                      "combined",
                                      "interval",
                                      "sporadic"
                                    ],
                                    "type": "string"
                                  },
                                  "transaction_type": {
                                    "enum": ["business", "personal"],
                                    "type": "string"
                                  }
                                },
                                "title": "payment_intent_payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "affirm": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "maxLength": 30,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "afterpay_clearpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "reference": {
                                "maxLength": 128,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alipay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alma": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "amazon_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "au_becs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bacs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bancontact": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": ["de", "en", "fr", "nl"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "blik": {
                        "anyOf": [
                          {
                            "properties": {
                              "code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "boleto": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "cvc_token": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "installments": {
                                "properties": {
                                  "enabled": {
                                    "type": "boolean"
                                  },
                                  "plan": {
                                    "anyOf": [
                                      {
                                        "properties": {
                                          "count": {
                                            "type": "integer"
                                          },
                                          "interval": {
                                            "enum": ["month"],
                                            "type": "string"
                                          },
                                          "type": {
                                            "enum": ["fixed_count"],
                                            "type": "string",
                                            "x-stripeBypassValidation": true
                                          }
                                        },
                                        "required": ["type"],
                                        "title": "installment_plan",
                                        "type": "object"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "installments_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "amount_type": {
                                    "enum": ["fixed", "maximum"],
                                    "type": "string"
                                  },
                                  "description": {
                                    "maxLength": 200,
                                    "type": "string"
                                  },
                                  "end_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "interval": {
                                    "enum": [
                                      "day",
                                      "month",
                                      "sporadic",
                                      "week",
                                      "year"
                                    ],
                                    "type": "string"
                                  },
                                  "interval_count": {
                                    "type": "integer"
                                  },
                                  "reference": {
                                    "maxLength": 80,
                                    "type": "string"
                                  },
                                  "start_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "supported_types": {
                                    "items": {
                                      "enum": ["india"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "amount_type",
                                  "interval",
                                  "reference",
                                  "start_date"
                                ],
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "network": {
                                "enum": [
                                  "amex",
                                  "cartes_bancaires",
                                  "diners",
                                  "discover",
                                  "eftpos_au",
                                  "girocard",
                                  "interac",
                                  "jcb",
                                  "link",
                                  "mastercard",
                                  "unionpay",
                                  "unknown",
                                  "visa"
                                ],
                                "maxLength": 5000,
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "request_extended_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_incremental_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_multicapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_overcapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_three_d_secure": {
                                "enum": ["any", "automatic", "challenge"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "require_cvc_recollection": {
                                "type": "boolean"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "statement_descriptor_suffix_kana": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "statement_descriptor_suffix_kanji": {
                                "anyOf": [
                                  {
                                    "maxLength": 17,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "three_d_secure": {
                                "properties": {
                                  "ares_trans_status": {
                                    "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                    "type": "string"
                                  },
                                  "cryptogram": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "electronic_commerce_indicator": {
                                    "enum": ["01", "02", "05", "06", "07"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "exemption_indicator": {
                                    "enum": ["low_risk", "none"],
                                    "type": "string"
                                  },
                                  "network_options": {
                                    "properties": {
                                      "cartes_bancaires": {
                                        "properties": {
                                          "cb_avalgo": {
                                            "enum": [
                                              "0",
                                              "1",
                                              "2",
                                              "3",
                                              "4",
                                              "A"
                                            ],
                                            "type": "string"
                                          },
                                          "cb_exemption": {
                                            "maxLength": 4,
                                            "type": "string"
                                          },
                                          "cb_score": {
                                            "type": "integer"
                                          }
                                        },
                                        "required": ["cb_avalgo"],
                                        "title": "cartes_bancaires_network_options_param",
                                        "type": "object"
                                      }
                                    },
                                    "title": "network_options_param",
                                    "type": "object"
                                  },
                                  "requestor_challenge_indicator": {
                                    "maxLength": 2,
                                    "type": "string"
                                  },
                                  "transaction_id": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "version": {
                                    "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": [
                                  "cryptogram",
                                  "transaction_id",
                                  "version"
                                ],
                                "title": "payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_intent_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card_present": {
                        "anyOf": [
                          {
                            "properties": {
                              "request_extended_authorization": {
                                "type": "boolean"
                              },
                              "request_incremental_authorization_support": {
                                "type": "boolean"
                              },
                              "routing": {
                                "properties": {
                                  "requested_priority": {
                                    "enum": ["domestic", "international"],
                                    "type": "string"
                                  }
                                },
                                "title": "routing_payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "cashapp": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "customer_balance": {
                        "anyOf": [
                          {
                            "properties": {
                              "bank_transfer": {
                                "properties": {
                                  "eu_bank_transfer": {
                                    "properties": {
                                      "country": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "required": ["country"],
                                    "title": "eu_bank_transfer_params",
                                    "type": "object"
                                  },
                                  "requested_address_types": {
                                    "items": {
                                      "enum": [
                                        "aba",
                                        "iban",
                                        "sepa",
                                        "sort_code",
                                        "spei",
                                        "swift",
                                        "zengin"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "type": {
                                    "enum": [
                                      "eu_bank_transfer",
                                      "gb_bank_transfer",
                                      "jp_bank_transfer",
                                      "mx_bank_transfer",
                                      "us_bank_transfer"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": ["type"],
                                "title": "bank_transfer_param",
                                "type": "object"
                              },
                              "funding_type": {
                                "enum": ["bank_transfer"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "eps": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "fpx": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "giropay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "grabpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "ideal": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "interac_present": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kakao_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "klarna": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-CH",
                                  "de-DE",
                                  "el-GR",
                                  "en-AT",
                                  "en-AU",
                                  "en-BE",
                                  "en-CA",
                                  "en-CH",
                                  "en-CZ",
                                  "en-DE",
                                  "en-DK",
                                  "en-ES",
                                  "en-FI",
                                  "en-FR",
                                  "en-GB",
                                  "en-GR",
                                  "en-IE",
                                  "en-IT",
                                  "en-NL",
                                  "en-NO",
                                  "en-NZ",
                                  "en-PL",
                                  "en-PT",
                                  "en-RO",
                                  "en-SE",
                                  "en-US",
                                  "es-ES",
                                  "es-US",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-CA",
                                  "fr-CH",
                                  "fr-FR",
                                  "it-CH",
                                  "it-IT",
                                  "nb-NO",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "ro-RO",
                                  "sv-FI",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "konbini": {
                        "anyOf": [
                          {
                            "properties": {
                              "confirmation_number": {
                                "anyOf": [
                                  {
                                    "maxLength": 11,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_after_days": {
                                "anyOf": [
                                  {
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kr_card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "link": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "mobilepay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "multibanco": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "naver_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "oxxo": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "p24": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              },
                              "tos_shown_and_accepted": {
                                "type": "boolean"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pay_by_bank": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "payco": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paynow": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paypal": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-DE",
                                  "de-LU",
                                  "el-GR",
                                  "en-GB",
                                  "en-US",
                                  "es-ES",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-FR",
                                  "fr-LU",
                                  "hu-HU",
                                  "it-IT",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "sk-SK",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "reference": {
                                "maxLength": 127,
                                "type": "string"
                              },
                              "risk_correlation_id": {
                                "maxLength": 32,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pix": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_seconds": {
                                "type": "integer"
                              },
                              "expires_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "promptpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "revolut_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "samsung_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sepa_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sofort": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": [
                                  "",
                                  "de",
                                  "en",
                                  "es",
                                  "fr",
                                  "it",
                                  "nl",
                                  "pl"
                                ],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "swish": {
                        "anyOf": [
                          {
                            "properties": {
                              "reference": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "twint": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "us_bank_account": {
                        "anyOf": [
                          {
                            "properties": {
                              "financial_connections": {
                                "properties": {
                                  "filters": {
                                    "properties": {
                                      "account_subcategories": {
                                        "items": {
                                          "enum": ["checking", "savings"],
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "linked_account_options_filters_param",
                                    "type": "object"
                                  },
                                  "permissions": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "payment_method",
                                        "transactions"
                                      ],
                                      "maxLength": 5000,
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "prefetch": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "transactions"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "return_url": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "linked_account_options_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "collection_method": {
                                    "enum": ["", "paper"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "networks": {
                                "properties": {
                                  "requested": {
                                    "items": {
                                      "enum": ["ach", "us_domestic_wire"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "networks_options_param",
                                "type": "object"
                              },
                              "preferred_settlement_speed": {
                                "enum": ["", "fastest", "standard"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "wechat_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "app_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "client": {
                                "enum": ["android", "ios", "web"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "required": ["client"],
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "zip": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "radar_options": {
                    "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).",
                    "properties": {
                      "session": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "radar_options_with_hidden_options",
                    "type": "object"
                  },
                  "receipt_email": {
                    "description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
                    "type": "string"
                  },
                  "return_url": {
                    "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
                    "type": "string"
                  },
                  "setup_future_usage": {
                    "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
                    "enum": ["off_session", "on_session"],
                    "type": "string"
                  },
                  "shipping": {
                    "description": "Shipping information for this PaymentIntent.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_address",
                        "type": "object"
                      },
                      "carrier": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tracking_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["address", "name"],
                    "title": "optional_fields_shipping",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "statement_descriptor_suffix": {
                    "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "The parameters that you can use to automatically create a Transfer.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "destination": {
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_creation_params",
                    "type": "object"
                  },
                  "transfer_group": {
                    "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).",
                    "type": "string"
                  },
                  "use_stripe_sdk": {
                    "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.",
                    "type": "boolean"
                  }
                },
                "required": ["amount", "currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a PaymentIntent"
      }
    },
    "/v1/payment_intents/search": {
      "get": {
        "description": "<p>Search for PaymentIntents you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetPaymentIntentsSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_intent"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search PaymentIntents"
      }
    },
    "/v1/payment_intents/{intent}": {
      "get": {
        "description": "<p>Retrieves the details of a PaymentIntent that has previously been created. </p>\n\n<p>You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. </p>\n\n<p>If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the <a href=\"#payment_intent_object\">payment intent</a> object reference for more details.</p>",
        "operationId": "GetPaymentIntentsIntent",
        "parameters": [
          {
            "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.",
            "in": "query",
            "name": "client_secret",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a PaymentIntent"
      },
      "post": {
        "description": "<p>Updates properties on a PaymentIntent object without confirming.</p>\n\n<p>Depending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the <code>payment_method</code>\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe <a href=\"/docs/api/payment_intents/confirm\">confirm API</a> instead.</p>",
        "operationId": "PostPaymentIntentsIntent",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "application_fee_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "receipt_email": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).",
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)."
                  },
                  "capture_method": {
                    "description": "Controls when the funds will be captured from the customer's account.",
                    "enum": ["automatic", "automatic_async", "manual"],
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_configuration": {
                    "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment-method-specific configuration for this PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "custom_mandate_url": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  },
                                  "interval_description": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "payment_schedule": {
                                    "enum": [
                                      "combined",
                                      "interval",
                                      "sporadic"
                                    ],
                                    "type": "string"
                                  },
                                  "transaction_type": {
                                    "enum": ["business", "personal"],
                                    "type": "string"
                                  }
                                },
                                "title": "payment_intent_payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "affirm": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "maxLength": 30,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "afterpay_clearpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "reference": {
                                "maxLength": 128,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alipay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alma": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "amazon_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "au_becs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bacs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bancontact": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": ["de", "en", "fr", "nl"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "blik": {
                        "anyOf": [
                          {
                            "properties": {
                              "code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "boleto": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "cvc_token": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "installments": {
                                "properties": {
                                  "enabled": {
                                    "type": "boolean"
                                  },
                                  "plan": {
                                    "anyOf": [
                                      {
                                        "properties": {
                                          "count": {
                                            "type": "integer"
                                          },
                                          "interval": {
                                            "enum": ["month"],
                                            "type": "string"
                                          },
                                          "type": {
                                            "enum": ["fixed_count"],
                                            "type": "string",
                                            "x-stripeBypassValidation": true
                                          }
                                        },
                                        "required": ["type"],
                                        "title": "installment_plan",
                                        "type": "object"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "installments_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "amount_type": {
                                    "enum": ["fixed", "maximum"],
                                    "type": "string"
                                  },
                                  "description": {
                                    "maxLength": 200,
                                    "type": "string"
                                  },
                                  "end_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "interval": {
                                    "enum": [
                                      "day",
                                      "month",
                                      "sporadic",
                                      "week",
                                      "year"
                                    ],
                                    "type": "string"
                                  },
                                  "interval_count": {
                                    "type": "integer"
                                  },
                                  "reference": {
                                    "maxLength": 80,
                                    "type": "string"
                                  },
                                  "start_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "supported_types": {
                                    "items": {
                                      "enum": ["india"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "amount_type",
                                  "interval",
                                  "reference",
                                  "start_date"
                                ],
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "network": {
                                "enum": [
                                  "amex",
                                  "cartes_bancaires",
                                  "diners",
                                  "discover",
                                  "eftpos_au",
                                  "girocard",
                                  "interac",
                                  "jcb",
                                  "link",
                                  "mastercard",
                                  "unionpay",
                                  "unknown",
                                  "visa"
                                ],
                                "maxLength": 5000,
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "request_extended_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_incremental_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_multicapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_overcapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_three_d_secure": {
                                "enum": ["any", "automatic", "challenge"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "require_cvc_recollection": {
                                "type": "boolean"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "statement_descriptor_suffix_kana": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "statement_descriptor_suffix_kanji": {
                                "anyOf": [
                                  {
                                    "maxLength": 17,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "three_d_secure": {
                                "properties": {
                                  "ares_trans_status": {
                                    "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                    "type": "string"
                                  },
                                  "cryptogram": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "electronic_commerce_indicator": {
                                    "enum": ["01", "02", "05", "06", "07"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "exemption_indicator": {
                                    "enum": ["low_risk", "none"],
                                    "type": "string"
                                  },
                                  "network_options": {
                                    "properties": {
                                      "cartes_bancaires": {
                                        "properties": {
                                          "cb_avalgo": {
                                            "enum": [
                                              "0",
                                              "1",
                                              "2",
                                              "3",
                                              "4",
                                              "A"
                                            ],
                                            "type": "string"
                                          },
                                          "cb_exemption": {
                                            "maxLength": 4,
                                            "type": "string"
                                          },
                                          "cb_score": {
                                            "type": "integer"
                                          }
                                        },
                                        "required": ["cb_avalgo"],
                                        "title": "cartes_bancaires_network_options_param",
                                        "type": "object"
                                      }
                                    },
                                    "title": "network_options_param",
                                    "type": "object"
                                  },
                                  "requestor_challenge_indicator": {
                                    "maxLength": 2,
                                    "type": "string"
                                  },
                                  "transaction_id": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "version": {
                                    "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": [
                                  "cryptogram",
                                  "transaction_id",
                                  "version"
                                ],
                                "title": "payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_intent_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card_present": {
                        "anyOf": [
                          {
                            "properties": {
                              "request_extended_authorization": {
                                "type": "boolean"
                              },
                              "request_incremental_authorization_support": {
                                "type": "boolean"
                              },
                              "routing": {
                                "properties": {
                                  "requested_priority": {
                                    "enum": ["domestic", "international"],
                                    "type": "string"
                                  }
                                },
                                "title": "routing_payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "cashapp": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "customer_balance": {
                        "anyOf": [
                          {
                            "properties": {
                              "bank_transfer": {
                                "properties": {
                                  "eu_bank_transfer": {
                                    "properties": {
                                      "country": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "required": ["country"],
                                    "title": "eu_bank_transfer_params",
                                    "type": "object"
                                  },
                                  "requested_address_types": {
                                    "items": {
                                      "enum": [
                                        "aba",
                                        "iban",
                                        "sepa",
                                        "sort_code",
                                        "spei",
                                        "swift",
                                        "zengin"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "type": {
                                    "enum": [
                                      "eu_bank_transfer",
                                      "gb_bank_transfer",
                                      "jp_bank_transfer",
                                      "mx_bank_transfer",
                                      "us_bank_transfer"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": ["type"],
                                "title": "bank_transfer_param",
                                "type": "object"
                              },
                              "funding_type": {
                                "enum": ["bank_transfer"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "eps": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "fpx": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "giropay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "grabpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "ideal": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "interac_present": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kakao_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "klarna": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-CH",
                                  "de-DE",
                                  "el-GR",
                                  "en-AT",
                                  "en-AU",
                                  "en-BE",
                                  "en-CA",
                                  "en-CH",
                                  "en-CZ",
                                  "en-DE",
                                  "en-DK",
                                  "en-ES",
                                  "en-FI",
                                  "en-FR",
                                  "en-GB",
                                  "en-GR",
                                  "en-IE",
                                  "en-IT",
                                  "en-NL",
                                  "en-NO",
                                  "en-NZ",
                                  "en-PL",
                                  "en-PT",
                                  "en-RO",
                                  "en-SE",
                                  "en-US",
                                  "es-ES",
                                  "es-US",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-CA",
                                  "fr-CH",
                                  "fr-FR",
                                  "it-CH",
                                  "it-IT",
                                  "nb-NO",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "ro-RO",
                                  "sv-FI",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "konbini": {
                        "anyOf": [
                          {
                            "properties": {
                              "confirmation_number": {
                                "anyOf": [
                                  {
                                    "maxLength": 11,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_after_days": {
                                "anyOf": [
                                  {
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kr_card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "link": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "mobilepay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "multibanco": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "naver_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "oxxo": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "p24": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              },
                              "tos_shown_and_accepted": {
                                "type": "boolean"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pay_by_bank": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "payco": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paynow": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paypal": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-DE",
                                  "de-LU",
                                  "el-GR",
                                  "en-GB",
                                  "en-US",
                                  "es-ES",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-FR",
                                  "fr-LU",
                                  "hu-HU",
                                  "it-IT",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "sk-SK",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "reference": {
                                "maxLength": 127,
                                "type": "string"
                              },
                              "risk_correlation_id": {
                                "maxLength": 32,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pix": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_seconds": {
                                "type": "integer"
                              },
                              "expires_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "promptpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "revolut_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "samsung_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sepa_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sofort": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": [
                                  "",
                                  "de",
                                  "en",
                                  "es",
                                  "fr",
                                  "it",
                                  "nl",
                                  "pl"
                                ],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "swish": {
                        "anyOf": [
                          {
                            "properties": {
                              "reference": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "twint": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "us_bank_account": {
                        "anyOf": [
                          {
                            "properties": {
                              "financial_connections": {
                                "properties": {
                                  "filters": {
                                    "properties": {
                                      "account_subcategories": {
                                        "items": {
                                          "enum": ["checking", "savings"],
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "linked_account_options_filters_param",
                                    "type": "object"
                                  },
                                  "permissions": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "payment_method",
                                        "transactions"
                                      ],
                                      "maxLength": 5000,
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "prefetch": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "transactions"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "return_url": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "linked_account_options_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "collection_method": {
                                    "enum": ["", "paper"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "networks": {
                                "properties": {
                                  "requested": {
                                    "items": {
                                      "enum": ["ach", "us_domestic_wire"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "networks_options_param",
                                "type": "object"
                              },
                              "preferred_settlement_speed": {
                                "enum": ["", "fastest", "standard"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "wechat_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "app_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "client": {
                                "enum": ["android", "ios", "web"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "required": ["client"],
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "zip": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "receipt_email": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)."
                  },
                  "setup_future_usage": {
                    "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
                    "enum": ["", "off_session", "on_session"],
                    "type": "string"
                  },
                  "shipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_address",
                            "type": "object"
                          },
                          "carrier": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tracking_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "optional_fields_shipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Shipping information for this PaymentIntent."
                  },
                  "statement_descriptor": {
                    "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "statement_descriptor_suffix": {
                    "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      }
                    },
                    "title": "transfer_data_update_params",
                    "type": "object"
                  },
                  "transfer_group": {
                    "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a PaymentIntent"
      }
    },
    "/v1/payment_intents/{intent}/apply_customer_balance": {
      "post": {
        "description": "<p>Manually reconcile the remaining amount for a <code>customer_balance</code> PaymentIntent.</p>",
        "operationId": "PostPaymentIntentsIntentApplyCustomerBalance",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reconcile a customer_balance PaymentIntent"
      }
    },
    "/v1/payment_intents/{intent}/cancel": {
      "post": {
        "description": "<p>You can cancel a PaymentIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code> or, <a href=\"/docs/payments/intents\">in rare cases</a>, <code>processing</code>. </p>\n\n<p>After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a <code>status</code> of <code>requires_capture</code>, the remaining <code>amount_capturable</code> is automatically refunded. </p>\n\n<p>You can’t cancel the PaymentIntent for a Checkout Session. <a href=\"/docs/api/checkout/sessions/expire\">Expire the Checkout Session</a> instead.</p>",
        "operationId": "PostPaymentIntentsIntentCancel",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cancellation_reason": {
                    "description": "Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`",
                    "enum": [
                      "abandoned",
                      "duplicate",
                      "fraudulent",
                      "requested_by_customer"
                    ],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a PaymentIntent"
      }
    },
    "/v1/payment_intents/{intent}/capture": {
      "post": {
        "description": "<p>Capture the funds of an existing uncaptured PaymentIntent when its status is <code>requires_capture</code>.</p>\n\n<p>Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.</p>\n\n<p>Learn more about <a href=\"/docs/payments/capture-later\">separate authorization and capture</a>.</p>",
        "operationId": "PostPaymentIntentsIntentCapture",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount_to_capture": {
                    "description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided.",
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "final_capture": {
                    "description": "Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.",
                    "type": "boolean"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "statement_descriptor": {
                    "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "statement_descriptor_suffix": {
                    "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "The parameters that you can use to automatically create a transfer after the payment\nis captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      }
                    },
                    "title": "transfer_data_update_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Capture a PaymentIntent"
      }
    },
    "/v1/payment_intents/{intent}/confirm": {
      "post": {
        "description": "<p>Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the <code>requires_action</code> status and\nsuggest additional actions via <code>next_action</code>. If payment fails,\nthe PaymentIntent transitions to the <code>requires_payment_method</code> status or the\n<code>canceled</code> status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the <code>succeeded</code>\nstatus (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>).\nIf the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted\nusing our <a href=\"/docs/stripe-js/reference#stripe-handle-card-payment\">client SDKs</a>\nand the PaymentIntent’s <a href=\"#payment_intent_object-client_secret\">client_secret</a>.\nAfter <code>next_action</code>s are handled by the client, no additional\nconfirmation is required to complete the payment.\nIf the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be\ninitiated using a secret key.\nIf any actions are required for the payment, the PaymentIntent will\nreturn to the <code>requires_confirmation</code> state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.\nThere is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the <code>canceled</code> state.</p>",
        "operationId": "PostPaymentIntentsIntentConfirm",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "off_session": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "radar_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "receipt_email": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "capture_method": {
                    "description": "Controls when the funds will be captured from the customer's account.",
                    "enum": ["automatic", "automatic_async", "manual"],
                    "type": "string"
                  },
                  "client_secret": {
                    "description": "The client secret of the PaymentIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "confirmation_token": {
                    "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "error_on_requires_action": {
                    "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "mandate": {
                    "description": "ID of the mandate that's used for this payment.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "mandate_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "accepted_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "offline": {
                                "properties": {},
                                "title": "offline_param",
                                "type": "object"
                              },
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["ip_address", "user_agent"],
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["offline", "online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "secret_key_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      },
                      {
                        "description": "This hash contains details about the Mandate to create",
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["online", "type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "client_key_param",
                        "type": "object"
                      }
                    ]
                  },
                  "off_session": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "enum": ["one_off", "recurring"],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards)."
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment method-specific configuration for this PaymentIntent.",
                    "properties": {
                      "acss_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "custom_mandate_url": {
                                    "anyOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  },
                                  "interval_description": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "payment_schedule": {
                                    "enum": [
                                      "combined",
                                      "interval",
                                      "sporadic"
                                    ],
                                    "type": "string"
                                  },
                                  "transaction_type": {
                                    "enum": ["business", "personal"],
                                    "type": "string"
                                  }
                                },
                                "title": "payment_intent_payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "affirm": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "maxLength": 30,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "afterpay_clearpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "reference": {
                                "maxLength": 128,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alipay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "alma": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "amazon_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "au_becs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bacs_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "bancontact": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": ["de", "en", "fr", "nl"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "blik": {
                        "anyOf": [
                          {
                            "properties": {
                              "code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "boleto": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "cvc_token": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "installments": {
                                "properties": {
                                  "enabled": {
                                    "type": "boolean"
                                  },
                                  "plan": {
                                    "anyOf": [
                                      {
                                        "properties": {
                                          "count": {
                                            "type": "integer"
                                          },
                                          "interval": {
                                            "enum": ["month"],
                                            "type": "string"
                                          },
                                          "type": {
                                            "enum": ["fixed_count"],
                                            "type": "string",
                                            "x-stripeBypassValidation": true
                                          }
                                        },
                                        "required": ["type"],
                                        "title": "installment_plan",
                                        "type": "object"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "installments_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "amount": {
                                    "type": "integer"
                                  },
                                  "amount_type": {
                                    "enum": ["fixed", "maximum"],
                                    "type": "string"
                                  },
                                  "description": {
                                    "maxLength": 200,
                                    "type": "string"
                                  },
                                  "end_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "interval": {
                                    "enum": [
                                      "day",
                                      "month",
                                      "sporadic",
                                      "week",
                                      "year"
                                    ],
                                    "type": "string"
                                  },
                                  "interval_count": {
                                    "type": "integer"
                                  },
                                  "reference": {
                                    "maxLength": 80,
                                    "type": "string"
                                  },
                                  "start_date": {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  "supported_types": {
                                    "items": {
                                      "enum": ["india"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "amount",
                                  "amount_type",
                                  "interval",
                                  "reference",
                                  "start_date"
                                ],
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "network": {
                                "enum": [
                                  "amex",
                                  "cartes_bancaires",
                                  "diners",
                                  "discover",
                                  "eftpos_au",
                                  "girocard",
                                  "interac",
                                  "jcb",
                                  "link",
                                  "mastercard",
                                  "unionpay",
                                  "unknown",
                                  "visa"
                                ],
                                "maxLength": 5000,
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "request_extended_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_incremental_authorization": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_multicapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_overcapture": {
                                "enum": ["if_available", "never"],
                                "type": "string"
                              },
                              "request_three_d_secure": {
                                "enum": ["any", "automatic", "challenge"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "require_cvc_recollection": {
                                "type": "boolean"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "statement_descriptor_suffix_kana": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "statement_descriptor_suffix_kanji": {
                                "anyOf": [
                                  {
                                    "maxLength": 17,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "three_d_secure": {
                                "properties": {
                                  "ares_trans_status": {
                                    "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                    "type": "string"
                                  },
                                  "cryptogram": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "electronic_commerce_indicator": {
                                    "enum": ["01", "02", "05", "06", "07"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "exemption_indicator": {
                                    "enum": ["low_risk", "none"],
                                    "type": "string"
                                  },
                                  "network_options": {
                                    "properties": {
                                      "cartes_bancaires": {
                                        "properties": {
                                          "cb_avalgo": {
                                            "enum": [
                                              "0",
                                              "1",
                                              "2",
                                              "3",
                                              "4",
                                              "A"
                                            ],
                                            "type": "string"
                                          },
                                          "cb_exemption": {
                                            "maxLength": 4,
                                            "type": "string"
                                          },
                                          "cb_score": {
                                            "type": "integer"
                                          }
                                        },
                                        "required": ["cb_avalgo"],
                                        "title": "cartes_bancaires_network_options_param",
                                        "type": "object"
                                      }
                                    },
                                    "title": "network_options_param",
                                    "type": "object"
                                  },
                                  "requestor_challenge_indicator": {
                                    "maxLength": 2,
                                    "type": "string"
                                  },
                                  "transaction_id": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "version": {
                                    "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": [
                                  "cryptogram",
                                  "transaction_id",
                                  "version"
                                ],
                                "title": "payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_intent_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "card_present": {
                        "anyOf": [
                          {
                            "properties": {
                              "request_extended_authorization": {
                                "type": "boolean"
                              },
                              "request_incremental_authorization_support": {
                                "type": "boolean"
                              },
                              "routing": {
                                "properties": {
                                  "requested_priority": {
                                    "enum": ["domestic", "international"],
                                    "type": "string"
                                  }
                                },
                                "title": "routing_payment_method_options_param",
                                "type": "object"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "cashapp": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "customer_balance": {
                        "anyOf": [
                          {
                            "properties": {
                              "bank_transfer": {
                                "properties": {
                                  "eu_bank_transfer": {
                                    "properties": {
                                      "country": {
                                        "maxLength": 5000,
                                        "type": "string"
                                      }
                                    },
                                    "required": ["country"],
                                    "title": "eu_bank_transfer_params",
                                    "type": "object"
                                  },
                                  "requested_address_types": {
                                    "items": {
                                      "enum": [
                                        "aba",
                                        "iban",
                                        "sepa",
                                        "sort_code",
                                        "spei",
                                        "swift",
                                        "zengin"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "type": {
                                    "enum": [
                                      "eu_bank_transfer",
                                      "gb_bank_transfer",
                                      "jp_bank_transfer",
                                      "mx_bank_transfer",
                                      "us_bank_transfer"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "required": ["type"],
                                "title": "bank_transfer_param",
                                "type": "object"
                              },
                              "funding_type": {
                                "enum": ["bank_transfer"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "eps": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "fpx": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "giropay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "grabpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "ideal": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "interac_present": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kakao_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "klarna": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-CH",
                                  "de-DE",
                                  "el-GR",
                                  "en-AT",
                                  "en-AU",
                                  "en-BE",
                                  "en-CA",
                                  "en-CH",
                                  "en-CZ",
                                  "en-DE",
                                  "en-DK",
                                  "en-ES",
                                  "en-FI",
                                  "en-FR",
                                  "en-GB",
                                  "en-GR",
                                  "en-IE",
                                  "en-IT",
                                  "en-NL",
                                  "en-NO",
                                  "en-NZ",
                                  "en-PL",
                                  "en-PT",
                                  "en-RO",
                                  "en-SE",
                                  "en-US",
                                  "es-ES",
                                  "es-US",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-CA",
                                  "fr-CH",
                                  "fr-FR",
                                  "it-CH",
                                  "it-IT",
                                  "nb-NO",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "ro-RO",
                                  "sv-FI",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "konbini": {
                        "anyOf": [
                          {
                            "properties": {
                              "confirmation_number": {
                                "anyOf": [
                                  {
                                    "maxLength": 11,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_after_days": {
                                "anyOf": [
                                  {
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "expires_at": {
                                "anyOf": [
                                  {
                                    "format": "unix-time",
                                    "type": "integer"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "product_description": {
                                "anyOf": [
                                  {
                                    "maxLength": 22,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "kr_card": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "link": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "mobilepay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "multibanco": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "naver_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "oxxo": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_days": {
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "p24": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              },
                              "tos_shown_and_accepted": {
                                "type": "boolean"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pay_by_bank": {
                        "anyOf": [
                          {
                            "properties": {},
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "payco": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paynow": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "paypal": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "preferred_locale": {
                                "enum": [
                                  "cs-CZ",
                                  "da-DK",
                                  "de-AT",
                                  "de-DE",
                                  "de-LU",
                                  "el-GR",
                                  "en-GB",
                                  "en-US",
                                  "es-ES",
                                  "fi-FI",
                                  "fr-BE",
                                  "fr-FR",
                                  "fr-LU",
                                  "hu-HU",
                                  "it-IT",
                                  "nl-BE",
                                  "nl-NL",
                                  "pl-PL",
                                  "pt-PT",
                                  "sk-SK",
                                  "sv-SE"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "reference": {
                                "maxLength": 127,
                                "type": "string"
                              },
                              "risk_correlation_id": {
                                "maxLength": 32,
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "pix": {
                        "anyOf": [
                          {
                            "properties": {
                              "expires_after_seconds": {
                                "type": "integer"
                              },
                              "expires_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "promptpay": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "revolut_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "samsung_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "capture_method": {
                                "enum": ["", "manual"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sepa_debit": {
                        "anyOf": [
                          {
                            "properties": {
                              "mandate_options": {
                                "properties": {
                                  "reference_prefix": {
                                    "anyOf": [
                                      {
                                        "maxLength": 12,
                                        "type": "string"
                                      },
                                      {
                                        "enum": [""],
                                        "type": "string"
                                      }
                                    ]
                                  }
                                },
                                "title": "payment_method_options_mandate_options_param",
                                "type": "object"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "sofort": {
                        "anyOf": [
                          {
                            "properties": {
                              "preferred_language": {
                                "enum": [
                                  "",
                                  "de",
                                  "en",
                                  "es",
                                  "fr",
                                  "it",
                                  "nl",
                                  "pl"
                                ],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": ["", "none", "off_session"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "swish": {
                        "anyOf": [
                          {
                            "properties": {
                              "reference": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "twint": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "us_bank_account": {
                        "anyOf": [
                          {
                            "properties": {
                              "financial_connections": {
                                "properties": {
                                  "filters": {
                                    "properties": {
                                      "account_subcategories": {
                                        "items": {
                                          "enum": ["checking", "savings"],
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "linked_account_options_filters_param",
                                    "type": "object"
                                  },
                                  "permissions": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "payment_method",
                                        "transactions"
                                      ],
                                      "maxLength": 5000,
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "prefetch": {
                                    "items": {
                                      "enum": [
                                        "balances",
                                        "ownership",
                                        "transactions"
                                      ],
                                      "type": "string",
                                      "x-stripeBypassValidation": true
                                    },
                                    "type": "array"
                                  },
                                  "return_url": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "linked_account_options_param",
                                "type": "object"
                              },
                              "mandate_options": {
                                "properties": {
                                  "collection_method": {
                                    "enum": ["", "paper"],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "mandate_options_param",
                                "type": "object"
                              },
                              "networks": {
                                "properties": {
                                  "requested": {
                                    "items": {
                                      "enum": ["ach", "us_domestic_wire"],
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "networks_options_param",
                                "type": "object"
                              },
                              "preferred_settlement_speed": {
                                "enum": ["", "fastest", "standard"],
                                "type": "string"
                              },
                              "setup_future_usage": {
                                "enum": [
                                  "",
                                  "none",
                                  "off_session",
                                  "on_session"
                                ],
                                "type": "string"
                              },
                              "target_date": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "verification_method": {
                                "enum": [
                                  "automatic",
                                  "instant",
                                  "microdeposits"
                                ],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "payment_intent_payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "wechat_pay": {
                        "anyOf": [
                          {
                            "properties": {
                              "app_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "client": {
                                "enum": ["android", "ios", "web"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "required": ["client"],
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "zip": {
                        "anyOf": [
                          {
                            "properties": {
                              "setup_future_usage": {
                                "enum": ["none"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "radar_options": {
                    "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).",
                    "properties": {
                      "session": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "radar_options_with_hidden_options",
                    "type": "object"
                  },
                  "receipt_email": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)."
                  },
                  "return_url": {
                    "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.",
                    "type": "string"
                  },
                  "setup_future_usage": {
                    "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.",
                    "enum": ["", "off_session", "on_session"],
                    "type": "string"
                  },
                  "shipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "optional_fields_address",
                            "type": "object"
                          },
                          "carrier": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tracking_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address", "name"],
                        "title": "optional_fields_shipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Shipping information for this PaymentIntent."
                  },
                  "use_stripe_sdk": {
                    "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Confirm a PaymentIntent"
      }
    },
    "/v1/payment_intents/{intent}/increment_authorization": {
      "post": {
        "description": "<p>Perform an incremental authorization on an eligible\n<a href=\"/docs/api/payment_intents/object\">PaymentIntent</a>. To be eligible, the\nPaymentIntent’s status must be <code>requires_capture</code> and\n<a href=\"/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported\">incremental_authorization_supported</a>\nmust be <code>true</code>.</p>\n\n<p>Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher <code>amount</code> provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.</p>\n\n<p>If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\n<a href=\"/docs/api/payment_intents/object#payment_intent_object-amount\">amount</a>.\nIf the incremental authorization fails, a\n<a href=\"/docs/error-codes#card-declined\">card_declined</a> error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.</p>\n\n<p>Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.</p>\n\n<p>Learn more about <a href=\"/docs/terminal/features/incremental-authorizations\">incremental authorizations</a>.</p>",
        "operationId": "PostPaymentIntentsIntentIncrementAuthorization",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.",
                    "type": "integer"
                  },
                  "application_fee_amount": {
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "type": "integer"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      }
                    },
                    "title": "transfer_data_update_params",
                    "type": "object"
                  }
                },
                "required": ["amount"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Increment an authorization"
      }
    },
    "/v1/payment_intents/{intent}/verify_microdeposits": {
      "post": {
        "description": "<p>Verifies microdeposits on a PaymentIntent object.</p>",
        "operationId": "PostPaymentIntentsIntentVerifyMicrodeposits",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amounts": {
                    "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.",
                    "items": {
                      "type": "integer"
                    },
                    "type": "array"
                  },
                  "client_secret": {
                    "description": "The client secret of the PaymentIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "descriptor_code": {
                    "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Verify microdeposits on a PaymentIntent"
      }
    },
    "/v1/payment_links": {
      "get": {
        "description": "<p>Returns a list of your payment links.</p>",
        "operationId": "GetPaymentLinks",
        "parameters": [
          {
            "description": "Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_link"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payment_links",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentLinksResourcePaymentLinkList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all payment links"
      },
      "post": {
        "description": "<p>Creates a payment link.</p>",
        "operationId": "PostPaymentLinks",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "after_completion": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "consent_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_fields": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_text": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_creation": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_intent_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "phone_number_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "restrictions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_address_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_id_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "after_completion": {
                    "description": "Behavior after the purchase is complete.",
                    "properties": {
                      "hosted_confirmation": {
                        "properties": {
                          "custom_message": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "after_completion_confirmation_page_params",
                        "type": "object"
                      },
                      "redirect": {
                        "properties": {
                          "url": {
                            "maxLength": 2048,
                            "type": "string"
                          }
                        },
                        "required": ["url"],
                        "title": "after_completion_redirect_params",
                        "type": "object"
                      },
                      "type": {
                        "enum": ["hosted_confirmation", "redirect"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "after_completion_params",
                    "type": "object"
                  },
                  "allow_promotion_codes": {
                    "description": "Enables user redeemable promotion codes.",
                    "type": "boolean"
                  },
                  "application_fee_amount": {
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.",
                    "type": "integer"
                  },
                  "application_fee_percent": {
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.",
                    "type": "number"
                  },
                  "automatic_tax": {
                    "description": "Configuration for automatic tax collection.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_params",
                    "type": "object"
                  },
                  "billing_address_collection": {
                    "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.",
                    "enum": ["auto", "required"],
                    "type": "string"
                  },
                  "consent_collection": {
                    "description": "Configure fields to gather active consent from customers.",
                    "properties": {
                      "payment_method_reuse_agreement": {
                        "properties": {
                          "position": {
                            "enum": ["auto", "hidden"],
                            "type": "string"
                          }
                        },
                        "required": ["position"],
                        "title": "payment_method_reuse_agreement_params",
                        "type": "object"
                      },
                      "promotions": {
                        "enum": ["auto", "none"],
                        "type": "string"
                      },
                      "terms_of_service": {
                        "enum": ["none", "required"],
                        "type": "string"
                      }
                    },
                    "title": "consent_collection_params",
                    "type": "object"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.",
                    "format": "currency",
                    "type": "string"
                  },
                  "custom_fields": {
                    "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.",
                    "items": {
                      "properties": {
                        "dropdown": {
                          "properties": {
                            "options": {
                              "items": {
                                "properties": {
                                  "label": {
                                    "maxLength": 100,
                                    "type": "string"
                                  },
                                  "value": {
                                    "maxLength": 100,
                                    "type": "string"
                                  }
                                },
                                "required": ["label", "value"],
                                "title": "custom_field_option_param",
                                "type": "object"
                              },
                              "type": "array"
                            }
                          },
                          "required": ["options"],
                          "title": "custom_field_dropdown_param",
                          "type": "object"
                        },
                        "key": {
                          "maxLength": 200,
                          "type": "string"
                        },
                        "label": {
                          "properties": {
                            "custom": {
                              "maxLength": 50,
                              "type": "string"
                            },
                            "type": {
                              "enum": ["custom"],
                              "type": "string"
                            }
                          },
                          "required": ["custom", "type"],
                          "title": "custom_field_label_param",
                          "type": "object"
                        },
                        "numeric": {
                          "properties": {
                            "maximum_length": {
                              "type": "integer"
                            },
                            "minimum_length": {
                              "type": "integer"
                            }
                          },
                          "title": "custom_field_numeric_param",
                          "type": "object"
                        },
                        "optional": {
                          "type": "boolean"
                        },
                        "text": {
                          "properties": {
                            "maximum_length": {
                              "type": "integer"
                            },
                            "minimum_length": {
                              "type": "integer"
                            }
                          },
                          "title": "custom_field_text_param",
                          "type": "object"
                        },
                        "type": {
                          "enum": ["dropdown", "numeric", "text"],
                          "type": "string"
                        }
                      },
                      "required": ["key", "label", "type"],
                      "title": "custom_field_param",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "custom_text": {
                    "description": "Display additional text for your customers using custom text.",
                    "properties": {
                      "after_submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "shipping_address": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "terms_of_service_acceptance": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "custom_text_param",
                    "type": "object"
                  },
                  "customer_creation": {
                    "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "inactive_message": {
                    "description": "The custom message to be displayed to a customer when a payment link is no longer active.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "invoice_creation": {
                    "description": "Generate a post-purchase Invoice for one-time payments.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "invoice_data": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "custom_fields": {
                            "anyOf": [
                              {
                                "items": {
                                  "properties": {
                                    "name": {
                                      "maxLength": 40,
                                      "type": "string"
                                    },
                                    "value": {
                                      "maxLength": 140,
                                      "type": "string"
                                    }
                                  },
                                  "required": ["name", "value"],
                                  "title": "custom_field_params",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "description": {
                            "maxLength": 1500,
                            "type": "string"
                          },
                          "footer": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          },
                          "metadata": {
                            "anyOf": [
                              {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "rendering_options": {
                            "anyOf": [
                              {
                                "properties": {
                                  "amount_tax_display": {
                                    "enum": [
                                      "",
                                      "exclude_tax",
                                      "include_inclusive_tax"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "title": "checkout_rendering_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "invoice_settings_params",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "invoice_creation_create_params",
                    "type": "object"
                  },
                  "line_items": {
                    "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.",
                    "items": {
                      "properties": {
                        "adjustable_quantity": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "maximum": {
                              "type": "integer"
                            },
                            "minimum": {
                              "type": "integer"
                            }
                          },
                          "required": ["enabled"],
                          "title": "adjustable_quantity_params",
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "quantity": {
                          "type": "integer"
                        }
                      },
                      "required": ["price", "quantity"],
                      "title": "line_items_create_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
                    "type": "object"
                  },
                  "on_behalf_of": {
                    "description": "The account on behalf of which to charge.",
                    "type": "string"
                  },
                  "payment_intent_data": {
                    "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
                    "properties": {
                      "capture_method": {
                        "enum": ["automatic", "automatic_async", "manual"],
                        "type": "string"
                      },
                      "description": {
                        "maxLength": 1000,
                        "type": "string"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "setup_future_usage": {
                        "enum": ["off_session", "on_session"],
                        "type": "string"
                      },
                      "statement_descriptor": {
                        "maxLength": 22,
                        "type": "string"
                      },
                      "statement_descriptor_suffix": {
                        "maxLength": 22,
                        "type": "string"
                      },
                      "transfer_group": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "payment_intent_data_params",
                    "type": "object"
                  },
                  "payment_method_collection": {
                    "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).",
                    "items": {
                      "enum": [
                        "affirm",
                        "afterpay_clearpay",
                        "alipay",
                        "alma",
                        "au_becs_debit",
                        "bacs_debit",
                        "bancontact",
                        "blik",
                        "boleto",
                        "card",
                        "cashapp",
                        "eps",
                        "fpx",
                        "giropay",
                        "grabpay",
                        "ideal",
                        "klarna",
                        "konbini",
                        "link",
                        "mobilepay",
                        "multibanco",
                        "oxxo",
                        "p24",
                        "pay_by_bank",
                        "paynow",
                        "paypal",
                        "pix",
                        "promptpay",
                        "sepa_debit",
                        "sofort",
                        "swish",
                        "twint",
                        "us_bank_account",
                        "wechat_pay",
                        "zip"
                      ],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "phone_number_collection": {
                    "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "phone_number_collection_params",
                    "type": "object"
                  },
                  "restrictions": {
                    "description": "Settings that restrict the usage of a payment link.",
                    "properties": {
                      "completed_sessions": {
                        "properties": {
                          "limit": {
                            "type": "integer"
                          }
                        },
                        "required": ["limit"],
                        "title": "completed_sessions_params",
                        "type": "object"
                      }
                    },
                    "required": ["completed_sessions"],
                    "title": "restrictions_params",
                    "type": "object"
                  },
                  "shipping_address_collection": {
                    "description": "Configuration for collecting the customer's shipping address.",
                    "properties": {
                      "allowed_countries": {
                        "items": {
                          "enum": [
                            "AC",
                            "AD",
                            "AE",
                            "AF",
                            "AG",
                            "AI",
                            "AL",
                            "AM",
                            "AO",
                            "AQ",
                            "AR",
                            "AT",
                            "AU",
                            "AW",
                            "AX",
                            "AZ",
                            "BA",
                            "BB",
                            "BD",
                            "BE",
                            "BF",
                            "BG",
                            "BH",
                            "BI",
                            "BJ",
                            "BL",
                            "BM",
                            "BN",
                            "BO",
                            "BQ",
                            "BR",
                            "BS",
                            "BT",
                            "BV",
                            "BW",
                            "BY",
                            "BZ",
                            "CA",
                            "CD",
                            "CF",
                            "CG",
                            "CH",
                            "CI",
                            "CK",
                            "CL",
                            "CM",
                            "CN",
                            "CO",
                            "CR",
                            "CV",
                            "CW",
                            "CY",
                            "CZ",
                            "DE",
                            "DJ",
                            "DK",
                            "DM",
                            "DO",
                            "DZ",
                            "EC",
                            "EE",
                            "EG",
                            "EH",
                            "ER",
                            "ES",
                            "ET",
                            "FI",
                            "FJ",
                            "FK",
                            "FO",
                            "FR",
                            "GA",
                            "GB",
                            "GD",
                            "GE",
                            "GF",
                            "GG",
                            "GH",
                            "GI",
                            "GL",
                            "GM",
                            "GN",
                            "GP",
                            "GQ",
                            "GR",
                            "GS",
                            "GT",
                            "GU",
                            "GW",
                            "GY",
                            "HK",
                            "HN",
                            "HR",
                            "HT",
                            "HU",
                            "ID",
                            "IE",
                            "IL",
                            "IM",
                            "IN",
                            "IO",
                            "IQ",
                            "IS",
                            "IT",
                            "JE",
                            "JM",
                            "JO",
                            "JP",
                            "KE",
                            "KG",
                            "KH",
                            "KI",
                            "KM",
                            "KN",
                            "KR",
                            "KW",
                            "KY",
                            "KZ",
                            "LA",
                            "LB",
                            "LC",
                            "LI",
                            "LK",
                            "LR",
                            "LS",
                            "LT",
                            "LU",
                            "LV",
                            "LY",
                            "MA",
                            "MC",
                            "MD",
                            "ME",
                            "MF",
                            "MG",
                            "MK",
                            "ML",
                            "MM",
                            "MN",
                            "MO",
                            "MQ",
                            "MR",
                            "MS",
                            "MT",
                            "MU",
                            "MV",
                            "MW",
                            "MX",
                            "MY",
                            "MZ",
                            "NA",
                            "NC",
                            "NE",
                            "NG",
                            "NI",
                            "NL",
                            "NO",
                            "NP",
                            "NR",
                            "NU",
                            "NZ",
                            "OM",
                            "PA",
                            "PE",
                            "PF",
                            "PG",
                            "PH",
                            "PK",
                            "PL",
                            "PM",
                            "PN",
                            "PR",
                            "PS",
                            "PT",
                            "PY",
                            "QA",
                            "RE",
                            "RO",
                            "RS",
                            "RU",
                            "RW",
                            "SA",
                            "SB",
                            "SC",
                            "SD",
                            "SE",
                            "SG",
                            "SH",
                            "SI",
                            "SJ",
                            "SK",
                            "SL",
                            "SM",
                            "SN",
                            "SO",
                            "SR",
                            "SS",
                            "ST",
                            "SV",
                            "SX",
                            "SZ",
                            "TA",
                            "TC",
                            "TD",
                            "TF",
                            "TG",
                            "TH",
                            "TJ",
                            "TK",
                            "TL",
                            "TM",
                            "TN",
                            "TO",
                            "TR",
                            "TT",
                            "TV",
                            "TW",
                            "TZ",
                            "UA",
                            "UG",
                            "US",
                            "UY",
                            "UZ",
                            "VA",
                            "VC",
                            "VE",
                            "VG",
                            "VN",
                            "VU",
                            "WF",
                            "WS",
                            "XK",
                            "YE",
                            "YT",
                            "ZA",
                            "ZM",
                            "ZW",
                            "ZZ"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": ["allowed_countries"],
                    "title": "shipping_address_collection_params",
                    "type": "object"
                  },
                  "shipping_options": {
                    "description": "The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
                    "items": {
                      "properties": {
                        "shipping_rate": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "title": "shipping_option_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "submit_type": {
                    "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).",
                    "enum": ["auto", "book", "donate", "pay", "subscribe"],
                    "type": "string"
                  },
                  "subscription_data": {
                    "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.",
                    "properties": {
                      "description": {
                        "maxLength": 500,
                        "type": "string"
                      },
                      "invoice_settings": {
                        "properties": {
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "subscription_data_invoice_settings_params",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "trial_period_days": {
                        "type": "integer"
                      },
                      "trial_settings": {
                        "properties": {
                          "end_behavior": {
                            "properties": {
                              "missing_payment_method": {
                                "enum": ["cancel", "create_invoice", "pause"],
                                "type": "string"
                              }
                            },
                            "required": ["missing_payment_method"],
                            "title": "end_behavior",
                            "type": "object"
                          }
                        },
                        "required": ["end_behavior"],
                        "title": "trial_settings_config",
                        "type": "object"
                      }
                    },
                    "title": "subscription_data_params",
                    "type": "object"
                  },
                  "tax_id_collection": {
                    "description": "Controls tax ID collection during checkout.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "required": {
                        "enum": ["if_supported", "never"],
                        "type": "string"
                      }
                    },
                    "required": ["enabled"],
                    "title": "tax_id_collection_params",
                    "type": "object"
                  },
                  "transfer_data": {
                    "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "destination": {
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_params",
                    "type": "object"
                  }
                },
                "required": ["line_items"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a payment link"
      }
    },
    "/v1/payment_links/{payment_link}": {
      "get": {
        "description": "<p>Retrieve a payment link.</p>",
        "operationId": "GetPaymentLinksPaymentLink",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "payment_link",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve payment link"
      },
      "post": {
        "description": "<p>Updates a payment link.</p>",
        "operationId": "PostPaymentLinksPaymentLink",
        "parameters": [
          {
            "in": "path",
            "name": "payment_link",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "after_completion": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_fields": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_text": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "inactive_message": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_creation": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_intent_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "phone_number_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "restrictions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_address_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_id_collection": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.",
                    "type": "boolean"
                  },
                  "after_completion": {
                    "description": "Behavior after the purchase is complete.",
                    "properties": {
                      "hosted_confirmation": {
                        "properties": {
                          "custom_message": {
                            "maxLength": 500,
                            "type": "string"
                          }
                        },
                        "title": "after_completion_confirmation_page_params",
                        "type": "object"
                      },
                      "redirect": {
                        "properties": {
                          "url": {
                            "maxLength": 2048,
                            "type": "string"
                          }
                        },
                        "required": ["url"],
                        "title": "after_completion_redirect_params",
                        "type": "object"
                      },
                      "type": {
                        "enum": ["hosted_confirmation", "redirect"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "after_completion_params",
                    "type": "object"
                  },
                  "allow_promotion_codes": {
                    "description": "Enables user redeemable promotion codes.",
                    "type": "boolean"
                  },
                  "automatic_tax": {
                    "description": "Configuration for automatic tax collection.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_params",
                    "type": "object"
                  },
                  "billing_address_collection": {
                    "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.",
                    "enum": ["auto", "required"],
                    "type": "string"
                  },
                  "custom_fields": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "dropdown": {
                              "properties": {
                                "options": {
                                  "items": {
                                    "properties": {
                                      "label": {
                                        "maxLength": 100,
                                        "type": "string"
                                      },
                                      "value": {
                                        "maxLength": 100,
                                        "type": "string"
                                      }
                                    },
                                    "required": ["label", "value"],
                                    "title": "custom_field_option_param",
                                    "type": "object"
                                  },
                                  "type": "array"
                                }
                              },
                              "required": ["options"],
                              "title": "custom_field_dropdown_param",
                              "type": "object"
                            },
                            "key": {
                              "maxLength": 200,
                              "type": "string"
                            },
                            "label": {
                              "properties": {
                                "custom": {
                                  "maxLength": 50,
                                  "type": "string"
                                },
                                "type": {
                                  "enum": ["custom"],
                                  "type": "string"
                                }
                              },
                              "required": ["custom", "type"],
                              "title": "custom_field_label_param",
                              "type": "object"
                            },
                            "numeric": {
                              "properties": {
                                "maximum_length": {
                                  "type": "integer"
                                },
                                "minimum_length": {
                                  "type": "integer"
                                }
                              },
                              "title": "custom_field_numeric_param",
                              "type": "object"
                            },
                            "optional": {
                              "type": "boolean"
                            },
                            "text": {
                              "properties": {
                                "maximum_length": {
                                  "type": "integer"
                                },
                                "minimum_length": {
                                  "type": "integer"
                                }
                              },
                              "title": "custom_field_text_param",
                              "type": "object"
                            },
                            "type": {
                              "enum": ["dropdown", "numeric", "text"],
                              "type": "string"
                            }
                          },
                          "required": ["key", "label", "type"],
                          "title": "custom_field_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported."
                  },
                  "custom_text": {
                    "description": "Display additional text for your customers using custom text.",
                    "properties": {
                      "after_submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "shipping_address": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "submit": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "terms_of_service_acceptance": {
                        "anyOf": [
                          {
                            "properties": {
                              "message": {
                                "maxLength": 1200,
                                "type": "string"
                              }
                            },
                            "required": ["message"],
                            "title": "custom_text_position_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "custom_text_param",
                    "type": "object"
                  },
                  "customer_creation": {
                    "description": "Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "inactive_message": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The custom message to be displayed to a customer when a payment link is no longer active."
                  },
                  "invoice_creation": {
                    "description": "Generate a post-purchase Invoice for one-time payments.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "invoice_data": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "custom_fields": {
                            "anyOf": [
                              {
                                "items": {
                                  "properties": {
                                    "name": {
                                      "maxLength": 40,
                                      "type": "string"
                                    },
                                    "value": {
                                      "maxLength": 140,
                                      "type": "string"
                                    }
                                  },
                                  "required": ["name", "value"],
                                  "title": "custom_field_params",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "description": {
                            "maxLength": 1500,
                            "type": "string"
                          },
                          "footer": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          },
                          "metadata": {
                            "anyOf": [
                              {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "rendering_options": {
                            "anyOf": [
                              {
                                "properties": {
                                  "amount_tax_display": {
                                    "enum": [
                                      "",
                                      "exclude_tax",
                                      "include_inclusive_tax"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "title": "checkout_rendering_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "invoice_settings_params",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "invoice_creation_update_params",
                    "type": "object"
                  },
                  "line_items": {
                    "description": "The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.",
                    "items": {
                      "properties": {
                        "adjustable_quantity": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "maximum": {
                              "type": "integer"
                            },
                            "minimum": {
                              "type": "integer"
                            }
                          },
                          "required": ["enabled"],
                          "title": "adjustable_quantity_params",
                          "type": "object"
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "quantity": {
                          "type": "integer"
                        }
                      },
                      "required": ["id"],
                      "title": "line_items_update_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
                    "type": "object"
                  },
                  "payment_intent_data": {
                    "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
                    "properties": {
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 1000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "statement_descriptor": {
                        "anyOf": [
                          {
                            "maxLength": 22,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "statement_descriptor_suffix": {
                        "anyOf": [
                          {
                            "maxLength": 22,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "transfer_group": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_intent_data_update_params",
                    "type": "object"
                  },
                  "payment_method_collection": {
                    "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
                    "enum": ["always", "if_required"],
                    "type": "string"
                  },
                  "payment_method_types": {
                    "anyOf": [
                      {
                        "items": {
                          "enum": [
                            "affirm",
                            "afterpay_clearpay",
                            "alipay",
                            "alma",
                            "au_becs_debit",
                            "bacs_debit",
                            "bancontact",
                            "blik",
                            "boleto",
                            "card",
                            "cashapp",
                            "eps",
                            "fpx",
                            "giropay",
                            "grabpay",
                            "ideal",
                            "klarna",
                            "konbini",
                            "link",
                            "mobilepay",
                            "multibanco",
                            "oxxo",
                            "p24",
                            "pay_by_bank",
                            "paynow",
                            "paypal",
                            "pix",
                            "promptpay",
                            "sepa_debit",
                            "sofort",
                            "swish",
                            "twint",
                            "us_bank_account",
                            "wechat_pay",
                            "zip"
                          ],
                          "type": "string",
                          "x-stripeBypassValidation": true
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."
                  },
                  "phone_number_collection": {
                    "description": "Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "phone_number_collection_params",
                    "type": "object"
                  },
                  "restrictions": {
                    "anyOf": [
                      {
                        "properties": {
                          "completed_sessions": {
                            "properties": {
                              "limit": {
                                "type": "integer"
                              }
                            },
                            "required": ["limit"],
                            "title": "completed_sessions_params",
                            "type": "object"
                          }
                        },
                        "required": ["completed_sessions"],
                        "title": "restrictions_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Settings that restrict the usage of a payment link."
                  },
                  "shipping_address_collection": {
                    "anyOf": [
                      {
                        "properties": {
                          "allowed_countries": {
                            "items": {
                              "enum": [
                                "AC",
                                "AD",
                                "AE",
                                "AF",
                                "AG",
                                "AI",
                                "AL",
                                "AM",
                                "AO",
                                "AQ",
                                "AR",
                                "AT",
                                "AU",
                                "AW",
                                "AX",
                                "AZ",
                                "BA",
                                "BB",
                                "BD",
                                "BE",
                                "BF",
                                "BG",
                                "BH",
                                "BI",
                                "BJ",
                                "BL",
                                "BM",
                                "BN",
                                "BO",
                                "BQ",
                                "BR",
                                "BS",
                                "BT",
                                "BV",
                                "BW",
                                "BY",
                                "BZ",
                                "CA",
                                "CD",
                                "CF",
                                "CG",
                                "CH",
                                "CI",
                                "CK",
                                "CL",
                                "CM",
                                "CN",
                                "CO",
                                "CR",
                                "CV",
                                "CW",
                                "CY",
                                "CZ",
                                "DE",
                                "DJ",
                                "DK",
                                "DM",
                                "DO",
                                "DZ",
                                "EC",
                                "EE",
                                "EG",
                                "EH",
                                "ER",
                                "ES",
                                "ET",
                                "FI",
                                "FJ",
                                "FK",
                                "FO",
                                "FR",
                                "GA",
                                "GB",
                                "GD",
                                "GE",
                                "GF",
                                "GG",
                                "GH",
                                "GI",
                                "GL",
                                "GM",
                                "GN",
                                "GP",
                                "GQ",
                                "GR",
                                "GS",
                                "GT",
                                "GU",
                                "GW",
                                "GY",
                                "HK",
                                "HN",
                                "HR",
                                "HT",
                                "HU",
                                "ID",
                                "IE",
                                "IL",
                                "IM",
                                "IN",
                                "IO",
                                "IQ",
                                "IS",
                                "IT",
                                "JE",
                                "JM",
                                "JO",
                                "JP",
                                "KE",
                                "KG",
                                "KH",
                                "KI",
                                "KM",
                                "KN",
                                "KR",
                                "KW",
                                "KY",
                                "KZ",
                                "LA",
                                "LB",
                                "LC",
                                "LI",
                                "LK",
                                "LR",
                                "LS",
                                "LT",
                                "LU",
                                "LV",
                                "LY",
                                "MA",
                                "MC",
                                "MD",
                                "ME",
                                "MF",
                                "MG",
                                "MK",
                                "ML",
                                "MM",
                                "MN",
                                "MO",
                                "MQ",
                                "MR",
                                "MS",
                                "MT",
                                "MU",
                                "MV",
                                "MW",
                                "MX",
                                "MY",
                                "MZ",
                                "NA",
                                "NC",
                                "NE",
                                "NG",
                                "NI",
                                "NL",
                                "NO",
                                "NP",
                                "NR",
                                "NU",
                                "NZ",
                                "OM",
                                "PA",
                                "PE",
                                "PF",
                                "PG",
                                "PH",
                                "PK",
                                "PL",
                                "PM",
                                "PN",
                                "PR",
                                "PS",
                                "PT",
                                "PY",
                                "QA",
                                "RE",
                                "RO",
                                "RS",
                                "RU",
                                "RW",
                                "SA",
                                "SB",
                                "SC",
                                "SD",
                                "SE",
                                "SG",
                                "SH",
                                "SI",
                                "SJ",
                                "SK",
                                "SL",
                                "SM",
                                "SN",
                                "SO",
                                "SR",
                                "SS",
                                "ST",
                                "SV",
                                "SX",
                                "SZ",
                                "TA",
                                "TC",
                                "TD",
                                "TF",
                                "TG",
                                "TH",
                                "TJ",
                                "TK",
                                "TL",
                                "TM",
                                "TN",
                                "TO",
                                "TR",
                                "TT",
                                "TV",
                                "TW",
                                "TZ",
                                "UA",
                                "UG",
                                "US",
                                "UY",
                                "UZ",
                                "VA",
                                "VC",
                                "VE",
                                "VG",
                                "VN",
                                "VU",
                                "WF",
                                "WS",
                                "XK",
                                "YE",
                                "YT",
                                "ZA",
                                "ZM",
                                "ZW",
                                "ZZ"
                              ],
                              "type": "string"
                            },
                            "type": "array"
                          }
                        },
                        "required": ["allowed_countries"],
                        "title": "shipping_address_collection_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Configuration for collecting the customer's shipping address."
                  },
                  "submit_type": {
                    "description": "Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).",
                    "enum": ["auto", "book", "donate", "pay", "subscribe"],
                    "type": "string"
                  },
                  "subscription_data": {
                    "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.",
                    "properties": {
                      "invoice_settings": {
                        "properties": {
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "subscription_data_invoice_settings_params",
                        "type": "object"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "trial_period_days": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "trial_settings": {
                        "anyOf": [
                          {
                            "properties": {
                              "end_behavior": {
                                "properties": {
                                  "missing_payment_method": {
                                    "enum": [
                                      "cancel",
                                      "create_invoice",
                                      "pause"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "required": ["missing_payment_method"],
                                "title": "end_behavior",
                                "type": "object"
                              }
                            },
                            "required": ["end_behavior"],
                            "title": "trial_settings_config",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "subscription_data_update_params",
                    "type": "object"
                  },
                  "tax_id_collection": {
                    "description": "Controls tax ID collection during checkout.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "required": {
                        "enum": ["if_supported", "never"],
                        "type": "string"
                      }
                    },
                    "required": ["enabled"],
                    "title": "tax_id_collection_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_link"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a payment link"
      }
    },
    "/v1/payment_links/{payment_link}/line_items": {
      "get": {
        "description": "<p>When retrieving a payment link, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetPaymentLinksPaymentLinkLineItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "payment_link",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentLinksResourceListLineItems",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a payment link's line items"
      }
    },
    "/v1/payment_method_configurations": {
      "get": {
        "description": "<p>List payment method configurations</p>",
        "operationId": "GetPaymentMethodConfigurations",
        "parameters": [
          {
            "description": "The Connect application to filter by.",
            "explode": true,
            "in": "query",
            "name": "application",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "maxLength": 100,
                  "type": "string"
                },
                {
                  "enum": [""],
                  "type": "string"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_method_configuration"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payment_method_configurations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentMethodConfigResourcePaymentMethodConfigurationsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List payment method configurations"
      },
      "post": {
        "description": "<p>Creates a payment method configuration</p>",
        "operationId": "PostPaymentMethodConfigurations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "acss_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "affirm": {
                  "explode": true,
                  "style": "deepObject"
                },
                "afterpay_clearpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alipay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alma": {
                  "explode": true,
                  "style": "deepObject"
                },
                "amazon_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "apple_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "apple_pay_later": {
                  "explode": true,
                  "style": "deepObject"
                },
                "au_becs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bacs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bancontact": {
                  "explode": true,
                  "style": "deepObject"
                },
                "blik": {
                  "explode": true,
                  "style": "deepObject"
                },
                "boleto": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cartes_bancaires": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cashapp": {
                  "explode": true,
                  "style": "deepObject"
                },
                "customer_balance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "eps": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fpx": {
                  "explode": true,
                  "style": "deepObject"
                },
                "giropay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "google_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "grabpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "ideal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "jcb": {
                  "explode": true,
                  "style": "deepObject"
                },
                "klarna": {
                  "explode": true,
                  "style": "deepObject"
                },
                "konbini": {
                  "explode": true,
                  "style": "deepObject"
                },
                "link": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mobilepay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "multibanco": {
                  "explode": true,
                  "style": "deepObject"
                },
                "oxxo": {
                  "explode": true,
                  "style": "deepObject"
                },
                "p24": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pay_by_bank": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paynow": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paypal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "promptpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "revolut_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sepa_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sofort": {
                  "explode": true,
                  "style": "deepObject"
                },
                "swish": {
                  "explode": true,
                  "style": "deepObject"
                },
                "twint": {
                  "explode": true,
                  "style": "deepObject"
                },
                "us_bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "wechat_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "zip": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "acss_debit": {
                    "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "affirm": {
                    "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "afterpay_clearpay": {
                    "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "alipay": {
                    "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "alma": {
                    "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "amazon_pay": {
                    "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "apple_pay": {
                    "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "apple_pay_later": {
                    "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "au_becs_debit": {
                    "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "bacs_debit": {
                    "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "bancontact": {
                    "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "blik": {
                    "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "boleto": {
                    "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "card": {
                    "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "cartes_bancaires": {
                    "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "cashapp": {
                    "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "customer_balance": {
                    "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "eps": {
                    "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fpx": {
                    "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "giropay": {
                    "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "google_pay": {
                    "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "grabpay": {
                    "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "ideal": {
                    "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "jcb": {
                    "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "klarna": {
                    "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "konbini": {
                    "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "link": {
                    "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "mobilepay": {
                    "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "multibanco": {
                    "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "name": {
                    "description": "Configuration name.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "oxxo": {
                    "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "p24": {
                    "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "parent": {
                    "description": "Configuration's parent configuration. Specify to create a child configuration.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "pay_by_bank": {
                    "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "paynow": {
                    "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "paypal": {
                    "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "promptpay": {
                    "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "revolut_pay": {
                    "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "sepa_debit": {
                    "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "sofort": {
                    "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "swish": {
                    "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "twint": {
                    "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "us_bank_account": {
                    "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "wechat_pay": {
                    "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "zip": {
                    "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a payment method configuration"
      }
    },
    "/v1/payment_method_configurations/{configuration}": {
      "get": {
        "description": "<p>Retrieve payment method configuration</p>",
        "operationId": "GetPaymentMethodConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve payment method configuration"
      },
      "post": {
        "description": "<p>Update payment method configuration</p>",
        "operationId": "PostPaymentMethodConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "acss_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "affirm": {
                  "explode": true,
                  "style": "deepObject"
                },
                "afterpay_clearpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alipay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alma": {
                  "explode": true,
                  "style": "deepObject"
                },
                "amazon_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "apple_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "apple_pay_later": {
                  "explode": true,
                  "style": "deepObject"
                },
                "au_becs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bacs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bancontact": {
                  "explode": true,
                  "style": "deepObject"
                },
                "blik": {
                  "explode": true,
                  "style": "deepObject"
                },
                "boleto": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cartes_bancaires": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cashapp": {
                  "explode": true,
                  "style": "deepObject"
                },
                "customer_balance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "eps": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fpx": {
                  "explode": true,
                  "style": "deepObject"
                },
                "giropay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "google_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "grabpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "ideal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "jcb": {
                  "explode": true,
                  "style": "deepObject"
                },
                "klarna": {
                  "explode": true,
                  "style": "deepObject"
                },
                "konbini": {
                  "explode": true,
                  "style": "deepObject"
                },
                "link": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mobilepay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "multibanco": {
                  "explode": true,
                  "style": "deepObject"
                },
                "oxxo": {
                  "explode": true,
                  "style": "deepObject"
                },
                "p24": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pay_by_bank": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paynow": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paypal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "promptpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "revolut_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sepa_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sofort": {
                  "explode": true,
                  "style": "deepObject"
                },
                "swish": {
                  "explode": true,
                  "style": "deepObject"
                },
                "twint": {
                  "explode": true,
                  "style": "deepObject"
                },
                "us_bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "wechat_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "zip": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "acss_debit": {
                    "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "active": {
                    "description": "Whether the configuration can be used for new payments.",
                    "type": "boolean"
                  },
                  "affirm": {
                    "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "afterpay_clearpay": {
                    "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "alipay": {
                    "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "alma": {
                    "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "amazon_pay": {
                    "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "apple_pay": {
                    "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "apple_pay_later": {
                    "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "au_becs_debit": {
                    "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "bacs_debit": {
                    "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "bancontact": {
                    "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "blik": {
                    "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "boleto": {
                    "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "card": {
                    "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "cartes_bancaires": {
                    "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "cashapp": {
                    "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "customer_balance": {
                    "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "eps": {
                    "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fpx": {
                    "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "giropay": {
                    "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "google_pay": {
                    "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "grabpay": {
                    "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "ideal": {
                    "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "jcb": {
                    "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "klarna": {
                    "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "konbini": {
                    "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "link": {
                    "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "mobilepay": {
                    "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "multibanco": {
                    "description": "Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "name": {
                    "description": "Configuration name.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "oxxo": {
                    "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "p24": {
                    "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "pay_by_bank": {
                    "description": "Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "paynow": {
                    "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "paypal": {
                    "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "promptpay": {
                    "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "revolut_pay": {
                    "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "sepa_debit": {
                    "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "sofort": {
                    "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "swish": {
                    "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "twint": {
                    "description": "Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "us_bank_account": {
                    "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-direct-debit) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "wechat_pay": {
                    "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "zip": {
                    "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.",
                    "properties": {
                      "display_preference": {
                        "properties": {
                          "preference": {
                            "enum": ["none", "off", "on"],
                            "type": "string"
                          }
                        },
                        "title": "display_preference_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update payment method configuration"
      }
    },
    "/v1/payment_method_domains": {
      "get": {
        "description": "<p>Lists the details of existing payment method domains.</p>",
        "operationId": "GetPaymentMethodDomains",
        "parameters": [
          {
            "description": "The domain name that this payment method domain object represents.",
            "in": "query",
            "name": "domain_name",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements",
            "in": "query",
            "name": "enabled",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_method_domain"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payment_method_domains",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentMethodDomainResourcePaymentMethodDomainList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List payment method domains"
      },
      "post": {
        "description": "<p>Creates a payment method domain.</p>",
        "operationId": "PostPaymentMethodDomains",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "domain_name": {
                    "description": "The domain name that this payment method domain object represents.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "enabled": {
                    "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["domain_name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a payment method domain"
      }
    },
    "/v1/payment_method_domains/{payment_method_domain}": {
      "get": {
        "description": "<p>Retrieves the details of an existing payment method domain.</p>",
        "operationId": "GetPaymentMethodDomainsPaymentMethodDomain",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "payment_method_domain",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a payment method domain"
      },
      "post": {
        "description": "<p>Updates an existing payment method domain.</p>",
        "operationId": "PostPaymentMethodDomainsPaymentMethodDomain",
        "parameters": [
          {
            "in": "path",
            "name": "payment_method_domain",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "enabled": {
                    "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a payment method domain"
      }
    },
    "/v1/payment_method_domains/{payment_method_domain}/validate": {
      "post": {
        "description": "<p>Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.\nThe payment method doesn’t appear in Elements for this domain until it is active.</p>\n\n<p>To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.</p>\n\n<p>Related guides: <a href=\"/docs/payments/payment-methods/pmd-registration\">Payment method domains</a>.</p>",
        "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate",
        "parameters": [
          {
            "in": "path",
            "name": "payment_method_domain",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method_domain"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Validate an existing payment method domain"
      }
    },
    "/v1/payment_methods": {
      "get": {
        "description": "<p>Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the <a href=\"/docs/api/payment_methods/customer_list\">List a Customer’s PaymentMethods</a> API instead.</p>",
        "operationId": "GetPaymentMethods",
        "parameters": [
          {
            "description": "The ID of the customer whose PaymentMethods will be retrieved.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": [
                "acss_debit",
                "affirm",
                "afterpay_clearpay",
                "alipay",
                "alma",
                "amazon_pay",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "blik",
                "boleto",
                "card",
                "cashapp",
                "customer_balance",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "kakao_pay",
                "klarna",
                "konbini",
                "kr_card",
                "link",
                "mobilepay",
                "multibanco",
                "naver_pay",
                "oxxo",
                "p24",
                "pay_by_bank",
                "payco",
                "paynow",
                "paypal",
                "pix",
                "promptpay",
                "revolut_pay",
                "samsung_pay",
                "sepa_debit",
                "sofort",
                "swish",
                "twint",
                "us_bank_account",
                "wechat_pay",
                "zip"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payment_method"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payment_methods",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentFlowsPaymentMethodList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List PaymentMethods"
      },
      "post": {
        "description": "<p>Creates a PaymentMethod object. Read the <a href=\"/docs/stripe-js/reference#stripe-create-payment-method\">Stripe.js reference</a> to learn how to create PaymentMethods via Stripe.js.</p>\n\n<p>Instead of creating a PaymentMethod directly, we recommend using the <a href=\"/docs/payments/accept-a-payment\">PaymentIntents</a> API to accept a payment immediately or the <a href=\"/docs/payments/save-and-reuse\">SetupIntent</a> API to collect payment method details ahead of a future payment.</p>",
        "operationId": "PostPaymentMethods",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "acss_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "affirm": {
                  "explode": true,
                  "style": "deepObject"
                },
                "afterpay_clearpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alipay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "alma": {
                  "explode": true,
                  "style": "deepObject"
                },
                "amazon_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "au_becs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bacs_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bancontact": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "blik": {
                  "explode": true,
                  "style": "deepObject"
                },
                "boleto": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cashapp": {
                  "explode": true,
                  "style": "deepObject"
                },
                "customer_balance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "eps": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fpx": {
                  "explode": true,
                  "style": "deepObject"
                },
                "giropay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "grabpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "ideal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "interac_present": {
                  "explode": true,
                  "style": "deepObject"
                },
                "kakao_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "klarna": {
                  "explode": true,
                  "style": "deepObject"
                },
                "konbini": {
                  "explode": true,
                  "style": "deepObject"
                },
                "kr_card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "link": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mobilepay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "multibanco": {
                  "explode": true,
                  "style": "deepObject"
                },
                "naver_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "oxxo": {
                  "explode": true,
                  "style": "deepObject"
                },
                "p24": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pay_by_bank": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payco": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paynow": {
                  "explode": true,
                  "style": "deepObject"
                },
                "paypal": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pix": {
                  "explode": true,
                  "style": "deepObject"
                },
                "promptpay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "radar_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "revolut_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "samsung_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sepa_debit": {
                  "explode": true,
                  "style": "deepObject"
                },
                "sofort": {
                  "explode": true,
                  "style": "deepObject"
                },
                "swish": {
                  "explode": true,
                  "style": "deepObject"
                },
                "twint": {
                  "explode": true,
                  "style": "deepObject"
                },
                "us_bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "wechat_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "zip": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "acss_debit": {
                    "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.",
                    "properties": {
                      "account_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "institution_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "transit_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": [
                      "account_number",
                      "institution_number",
                      "transit_number"
                    ],
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "affirm": {
                    "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "afterpay_clearpay": {
                    "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "alipay": {
                    "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "allow_redisplay": {
                    "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.",
                    "enum": ["always", "limited", "unspecified"],
                    "type": "string"
                  },
                  "alma": {
                    "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "amazon_pay": {
                    "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "au_becs_debit": {
                    "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.",
                    "properties": {
                      "account_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "bsb_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["account_number", "bsb_number"],
                    "title": "param",
                    "type": "object"
                  },
                  "bacs_debit": {
                    "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.",
                    "properties": {
                      "account_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "sort_code": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "bancontact": {
                    "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "billing_details": {
                    "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
                    "properties": {
                      "address": {
                        "anyOf": [
                          {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "billing_details_address",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "email": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "name": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "phone": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "billing_details_inner_params",
                    "type": "object"
                  },
                  "blik": {
                    "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "boleto": {
                    "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.",
                    "properties": {
                      "tax_id": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["tax_id"],
                    "title": "param",
                    "type": "object"
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "type": "integer"
                          },
                          "exp_year": {
                            "type": "integer"
                          },
                          "networks": {
                            "properties": {
                              "preferred": {
                                "enum": [
                                  "cartes_bancaires",
                                  "mastercard",
                                  "visa"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "networks_params",
                            "type": "object"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "card_details_params",
                        "type": "object"
                      },
                      {
                        "properties": {
                          "token": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["token"],
                        "title": "token_params",
                        "type": "object"
                      }
                    ],
                    "description": "If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: \"tok_visa\"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.",
                    "x-stripeBypassValidation": true
                  },
                  "cashapp": {
                    "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "customer": {
                    "description": "The `Customer` to whom the original PaymentMethod is attached.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer_balance": {
                    "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "eps": {
                    "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.",
                    "properties": {
                      "bank": {
                        "enum": [
                          "arzte_und_apotheker_bank",
                          "austrian_anadi_bank_ag",
                          "bank_austria",
                          "bankhaus_carl_spangler",
                          "bankhaus_schelhammer_und_schattera_ag",
                          "bawag_psk_ag",
                          "bks_bank_ag",
                          "brull_kallmus_bank_ag",
                          "btv_vier_lander_bank",
                          "capital_bank_grawe_gruppe_ag",
                          "deutsche_bank_ag",
                          "dolomitenbank",
                          "easybank_ag",
                          "erste_bank_und_sparkassen",
                          "hypo_alpeadriabank_international_ag",
                          "hypo_bank_burgenland_aktiengesellschaft",
                          "hypo_noe_lb_fur_niederosterreich_u_wien",
                          "hypo_oberosterreich_salzburg_steiermark",
                          "hypo_tirol_bank_ag",
                          "hypo_vorarlberg_bank_ag",
                          "marchfelder_bank",
                          "oberbank_ag",
                          "raiffeisen_bankengruppe_osterreich",
                          "schoellerbank_ag",
                          "sparda_bank_wien",
                          "volksbank_gruppe",
                          "volkskreditbank_ag",
                          "vr_bank_braunau"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fpx": {
                    "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.",
                    "properties": {
                      "bank": {
                        "enum": [
                          "affin_bank",
                          "agrobank",
                          "alliance_bank",
                          "ambank",
                          "bank_islam",
                          "bank_muamalat",
                          "bank_of_china",
                          "bank_rakyat",
                          "bsn",
                          "cimb",
                          "deutsche_bank",
                          "hong_leong_bank",
                          "hsbc",
                          "kfh",
                          "maybank2e",
                          "maybank2u",
                          "ocbc",
                          "pb_enterprise",
                          "public_bank",
                          "rhb",
                          "standard_chartered",
                          "uob"
                        ],
                        "maxLength": 5000,
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "required": ["bank"],
                    "title": "param",
                    "type": "object"
                  },
                  "giropay": {
                    "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "grabpay": {
                    "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "ideal": {
                    "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.",
                    "properties": {
                      "bank": {
                        "enum": [
                          "abn_amro",
                          "asn_bank",
                          "bunq",
                          "handelsbanken",
                          "ing",
                          "knab",
                          "moneyou",
                          "n26",
                          "nn",
                          "rabobank",
                          "regiobank",
                          "revolut",
                          "sns_bank",
                          "triodos_bank",
                          "van_lanschot",
                          "yoursafe"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "interac_present": {
                    "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "kakao_pay": {
                    "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "klarna": {
                    "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.",
                    "properties": {
                      "dob": {
                        "properties": {
                          "day": {
                            "type": "integer"
                          },
                          "month": {
                            "type": "integer"
                          },
                          "year": {
                            "type": "integer"
                          }
                        },
                        "required": ["day", "month", "year"],
                        "title": "date_of_birth",
                        "type": "object"
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "konbini": {
                    "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "kr_card": {
                    "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "link": {
                    "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "mobilepay": {
                    "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "multibanco": {
                    "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "naver_pay": {
                    "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.",
                    "properties": {
                      "funding": {
                        "enum": ["card", "points"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "oxxo": {
                    "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "p24": {
                    "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.",
                    "properties": {
                      "bank": {
                        "enum": [
                          "alior_bank",
                          "bank_millennium",
                          "bank_nowy_bfg_sa",
                          "bank_pekao_sa",
                          "banki_spbdzielcze",
                          "blik",
                          "bnp_paribas",
                          "boz",
                          "citi_handlowy",
                          "credit_agricole",
                          "envelobank",
                          "etransfer_pocztowy24",
                          "getin_bank",
                          "ideabank",
                          "ing",
                          "inteligo",
                          "mbank_mtransfer",
                          "nest_przelew",
                          "noble_pay",
                          "pbac_z_ipko",
                          "plus_bank",
                          "santander_przelew24",
                          "tmobile_usbugi_bankowe",
                          "toyota_bank",
                          "velobank",
                          "volkswagen_bank"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "pay_by_bank": {
                    "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "payco": {
                    "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "payment_method": {
                    "description": "The PaymentMethod to share.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "paynow": {
                    "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "paypal": {
                    "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "pix": {
                    "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "promptpay": {
                    "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "radar_options": {
                    "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
                    "properties": {
                      "session": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "radar_options_with_hidden_options",
                    "type": "object"
                  },
                  "revolut_pay": {
                    "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "samsung_pay": {
                    "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "sepa_debit": {
                    "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
                    "properties": {
                      "iban": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["iban"],
                    "title": "param",
                    "type": "object"
                  },
                  "sofort": {
                    "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.",
                    "properties": {
                      "country": {
                        "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                        "type": "string"
                      }
                    },
                    "required": ["country"],
                    "title": "param",
                    "type": "object"
                  },
                  "swish": {
                    "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "twint": {
                    "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "type": {
                    "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
                    "enum": [
                      "acss_debit",
                      "affirm",
                      "afterpay_clearpay",
                      "alipay",
                      "alma",
                      "amazon_pay",
                      "au_becs_debit",
                      "bacs_debit",
                      "bancontact",
                      "blik",
                      "boleto",
                      "card",
                      "cashapp",
                      "customer_balance",
                      "eps",
                      "fpx",
                      "giropay",
                      "grabpay",
                      "ideal",
                      "kakao_pay",
                      "klarna",
                      "konbini",
                      "kr_card",
                      "link",
                      "mobilepay",
                      "multibanco",
                      "naver_pay",
                      "oxxo",
                      "p24",
                      "pay_by_bank",
                      "payco",
                      "paynow",
                      "paypal",
                      "pix",
                      "promptpay",
                      "revolut_pay",
                      "samsung_pay",
                      "sepa_debit",
                      "sofort",
                      "swish",
                      "twint",
                      "us_bank_account",
                      "wechat_pay",
                      "zip"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "us_bank_account": {
                    "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
                    "properties": {
                      "account_holder_type": {
                        "enum": ["company", "individual"],
                        "type": "string"
                      },
                      "account_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "account_type": {
                        "enum": ["checking", "savings"],
                        "type": "string"
                      },
                      "financial_connections_account": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "routing_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "payment_method_param",
                    "type": "object"
                  },
                  "wechat_pay": {
                    "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "zip": {
                    "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Shares a PaymentMethod"
      }
    },
    "/v1/payment_methods/{payment_method}": {
      "get": {
        "description": "<p>Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use <a href=\"/docs/api/payment_methods/customer\">Retrieve a Customer’s PaymentMethods</a></p>",
        "operationId": "GetPaymentMethodsPaymentMethod",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "payment_method",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a PaymentMethod"
      },
      "post": {
        "description": "<p>Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.</p>",
        "operationId": "PostPaymentMethodsPaymentMethod",
        "parameters": [
          {
            "in": "path",
            "name": "payment_method",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "billing_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "link": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "naver_pay": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pay_by_bank": {
                  "explode": true,
                  "style": "deepObject"
                },
                "us_bank_account": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "allow_redisplay": {
                    "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.",
                    "enum": ["always", "limited", "unspecified"],
                    "type": "string"
                  },
                  "billing_details": {
                    "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
                    "properties": {
                      "address": {
                        "anyOf": [
                          {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "billing_details_address",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "email": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "name": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "phone": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "billing_details_inner_params",
                    "type": "object"
                  },
                  "card": {
                    "description": "If this is a `card` PaymentMethod, this hash contains the user's card details.",
                    "properties": {
                      "exp_month": {
                        "type": "integer"
                      },
                      "exp_year": {
                        "type": "integer"
                      },
                      "networks": {
                        "properties": {
                          "preferred": {
                            "enum": [
                              "",
                              "cartes_bancaires",
                              "mastercard",
                              "visa"
                            ],
                            "type": "string"
                          }
                        },
                        "title": "networks_update_api_param",
                        "type": "object"
                      }
                    },
                    "title": "update_api_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "link": {
                    "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "naver_pay": {
                    "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.",
                    "properties": {
                      "funding": {
                        "enum": ["card", "points"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      }
                    },
                    "title": "param",
                    "type": "object"
                  },
                  "pay_by_bank": {
                    "description": "If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.",
                    "properties": {},
                    "title": "param",
                    "type": "object"
                  },
                  "us_bank_account": {
                    "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
                    "properties": {
                      "account_holder_type": {
                        "enum": ["company", "individual"],
                        "type": "string"
                      },
                      "account_type": {
                        "enum": ["checking", "savings"],
                        "type": "string"
                      }
                    },
                    "title": "update_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a PaymentMethod"
      }
    },
    "/v1/payment_methods/{payment_method}/attach": {
      "post": {
        "description": "<p>Attaches a PaymentMethod object to a Customer.</p>\n\n<p>To attach a new PaymentMethod to a customer for future payments, we recommend you use a <a href=\"/docs/api/setup_intents\">SetupIntent</a>\nor a PaymentIntent with <a href=\"/docs/api/payment_intents/create#create_payment_intent-setup_future_usage\">setup_future_usage</a>.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the <code>/v1/payment_methods/:id/attach</code>\nendpoint without first using a SetupIntent or PaymentIntent with <code>setup_future_usage</code> does not optimize the PaymentMethod for\nfuture use, which makes later declines and payment friction more likely.\nSee <a href=\"/docs/payments/payment-intents#future-usage\">Optimizing cards for future payments</a> for more information about setting up\nfuture payments.</p>\n\n<p>To use this PaymentMethod as the default for invoice or subscription payments,\nset <a href=\"/docs/api/customers/update#update_customer-invoice_settings-default_payment_method\"><code>invoice_settings.default_payment_method</code></a>,\non the Customer to the PaymentMethod’s ID.</p>",
        "operationId": "PostPaymentMethodsPaymentMethodAttach",
        "parameters": [
          {
            "in": "path",
            "name": "payment_method",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "customer": {
                    "description": "The ID of the customer to which to attach the PaymentMethod.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["customer"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Attach a PaymentMethod to a Customer"
      }
    },
    "/v1/payment_methods/{payment_method}/detach": {
      "post": {
        "description": "<p>Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.</p>",
        "operationId": "PostPaymentMethodsPaymentMethodDetach",
        "parameters": [
          {
            "in": "path",
            "name": "payment_method",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payment_method"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Detach a PaymentMethod from a Customer"
      }
    },
    "/v1/payouts": {
      "get": {
        "description": "<p>Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.</p>",
        "operationId": "GetPayouts",
        "parameters": [
          {
            "description": "Only return payouts that are expected to arrive during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "arrival_date",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return payouts that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of an external account - only return payouts sent to this external account.",
            "in": "query",
            "name": "destination",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/payout"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/payouts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PayoutList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all payouts"
      },
      "post": {
        "description": "<p>To send funds to your own bank account, create a new payout object. Your <a href=\"#balance\">Stripe balance</a> must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.</p>\n\n<p>If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.</p>\n\n<p>If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The <a href=\"#balance_object\">balance object</a> details available and pending amounts by source type.</p>",
        "operationId": "PostPayouts",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer in cents representing how much to payout.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination": {
                    "description": "The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "method": {
                    "description": "The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).",
                    "enum": ["instant", "standard"],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "source_type": {
                    "description": "The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.",
                    "enum": ["bank_account", "card", "fpx"],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "statement_descriptor": {
                    "description": "A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.",
                    "maxLength": 22,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "required": ["amount", "currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payout"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a payout"
      }
    },
    "/v1/payouts/{payout}": {
      "get": {
        "description": "<p>Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.</p>",
        "operationId": "GetPayoutsPayout",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "payout",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payout"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a payout"
      },
      "post": {
        "description": "<p>Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.</p>",
        "operationId": "PostPayoutsPayout",
        "parameters": [
          {
            "in": "path",
            "name": "payout",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payout"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a payout"
      }
    },
    "/v1/payouts/{payout}/cancel": {
      "post": {
        "description": "<p>You can cancel a previously created payout if its status is <code>pending</code>. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.</p>",
        "operationId": "PostPayoutsPayoutCancel",
        "parameters": [
          {
            "in": "path",
            "name": "payout",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payout"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a payout"
      }
    },
    "/v1/payouts/{payout}/reverse": {
      "post": {
        "description": "<p>Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the <code>pending</code> status, use <code>/v1/payouts/:id/cancel</code> instead.</p>\n\n<p>By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.</p>",
        "operationId": "PostPayoutsPayoutReverse",
        "parameters": [
          {
            "in": "path",
            "name": "payout",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/payout"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reverse a payout"
      }
    },
    "/v1/plans": {
      "get": {
        "description": "<p>Returns a list of your plans.</p>",
        "operationId": "GetPlans",
        "parameters": [
          {
            "description": "Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return plans for the given product.",
            "in": "query",
            "name": "product",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/plan"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/plans",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PlanList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all plans"
      },
      "post": {
        "description": "<p>You can now model subscriptions more flexibly using the <a href=\"#prices\">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>",
        "operationId": "PostPlans",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "product": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tiers": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transform_usage": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the plan is currently available for new subscriptions. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "aggregate_usage": {
                    "description": "Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.",
                    "enum": ["last_during_period", "last_ever", "max", "sum"],
                    "type": "string"
                  },
                  "amount": {
                    "description": "A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.",
                    "type": "integer"
                  },
                  "amount_decimal": {
                    "description": "Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.",
                    "format": "decimal",
                    "type": "string"
                  },
                  "billing_scheme": {
                    "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
                    "enum": ["per_unit", "tiered"],
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "id": {
                    "description": "An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "interval": {
                    "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
                    "enum": ["day", "month", "week", "year"],
                    "type": "string"
                  },
                  "interval_count": {
                    "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).",
                    "type": "integer"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "meter": {
                    "description": "The meter tracking the usage of a metered price",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "nickname": {
                    "description": "A brief description of the plan, hidden from customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "product": {
                    "anyOf": [
                      {
                        "description": "The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service product](https://stripe.com/docs/api#product_object-type).",
                        "properties": {
                          "active": {
                            "type": "boolean"
                          },
                          "id": {
                            "deprecated": true,
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "metadata": {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "statement_descriptor": {
                            "maxLength": 22,
                            "type": "string"
                          },
                          "tax_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit_label": {
                            "maxLength": 12,
                            "type": "string"
                          }
                        },
                        "required": ["name"],
                        "title": "inline_product_params",
                        "type": "object"
                      },
                      {
                        "description": "The ID of the product whose pricing the created plan will represent.",
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ]
                  },
                  "tiers": {
                    "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
                    "items": {
                      "properties": {
                        "flat_amount": {
                          "type": "integer"
                        },
                        "flat_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        },
                        "unit_amount": {
                          "type": "integer"
                        },
                        "unit_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        },
                        "up_to": {
                          "anyOf": [
                            {
                              "enum": ["inf"],
                              "maxLength": 5000,
                              "type": "string"
                            },
                            {
                              "type": "integer"
                            }
                          ]
                        }
                      },
                      "required": ["up_to"],
                      "title": "tier",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "tiers_mode": {
                    "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.",
                    "enum": ["graduated", "volume"],
                    "type": "string"
                  },
                  "transform_usage": {
                    "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.",
                    "properties": {
                      "divide_by": {
                        "type": "integer"
                      },
                      "round": {
                        "enum": ["down", "up"],
                        "type": "string"
                      }
                    },
                    "required": ["divide_by", "round"],
                    "title": "transform_usage_param",
                    "type": "object"
                  },
                  "trial_period_days": {
                    "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).",
                    "type": "integer"
                  },
                  "usage_type": {
                    "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.",
                    "enum": ["licensed", "metered"],
                    "type": "string"
                  }
                },
                "required": ["currency", "interval"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a plan"
      }
    },
    "/v1/plans/{plan}": {
      "delete": {
        "description": "<p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>",
        "operationId": "DeletePlansPlan",
        "parameters": [
          {
            "in": "path",
            "name": "plan",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_plan"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a plan"
      },
      "get": {
        "description": "<p>Retrieves the plan with the given ID.</p>",
        "operationId": "GetPlansPlan",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "plan",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a plan"
      },
      "post": {
        "description": "<p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.</p>",
        "operationId": "PostPlansPlan",
        "parameters": [
          {
            "in": "path",
            "name": "plan",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the plan is currently available for new subscriptions.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nickname": {
                    "description": "A brief description of the plan, hidden from customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "product": {
                    "description": "The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "trial_period_days": {
                    "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/plan"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a plan"
      }
    },
    "/v1/prices": {
      "get": {
        "description": "<p>Returns a list of your active prices, excluding <a href=\"/docs/products-prices/pricing-models#inline-pricing\">inline prices</a>. For the list of inactive prices, set <code>active</code> to false.</p>",
        "operationId": "GetPrices",
        "parameters": [
          {
            "description": "Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return prices for the given currency.",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.",
            "explode": true,
            "in": "query",
            "name": "lookup_keys",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return prices for the given product.",
            "in": "query",
            "name": "product",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return prices with these recurring fields.",
            "explode": true,
            "in": "query",
            "name": "recurring",
            "required": false,
            "schema": {
              "properties": {
                "interval": {
                  "enum": ["day", "month", "week", "year"],
                  "type": "string"
                },
                "meter": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "usage_type": {
                  "enum": ["licensed", "metered"],
                  "type": "string"
                }
              },
              "title": "all_prices_recurring_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return prices of type `recurring` or `one_time`.",
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": ["one_time", "recurring"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/price"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/prices",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PriceList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all prices"
      },
      "post": {
        "description": "<p>Creates a new price for an existing product. The price can be recurring or one-time.</p>",
        "operationId": "PostPrices",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "currency_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "custom_unit_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "product_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "recurring": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tiers": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transform_quantity": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the price can be used for new purchases. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "billing_scheme": {
                    "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
                    "enum": ["per_unit", "tiered"],
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "currency_options": {
                    "additionalProperties": {
                      "properties": {
                        "custom_unit_amount": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "maximum": {
                              "type": "integer"
                            },
                            "minimum": {
                              "type": "integer"
                            },
                            "preset": {
                              "type": "integer"
                            }
                          },
                          "required": ["enabled"],
                          "title": "custom_unit_amount",
                          "type": "object"
                        },
                        "tax_behavior": {
                          "enum": ["exclusive", "inclusive", "unspecified"],
                          "type": "string"
                        },
                        "tiers": {
                          "items": {
                            "properties": {
                              "flat_amount": {
                                "type": "integer"
                              },
                              "flat_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              },
                              "unit_amount": {
                                "type": "integer"
                              },
                              "unit_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              },
                              "up_to": {
                                "anyOf": [
                                  {
                                    "enum": ["inf"],
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "type": "integer"
                                  }
                                ]
                              }
                            },
                            "required": ["up_to"],
                            "title": "tier",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "unit_amount": {
                          "type": "integer"
                        },
                        "unit_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        }
                      },
                      "title": "currency_option",
                      "type": "object"
                    },
                    "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
                    "type": "object"
                  },
                  "custom_unit_amount": {
                    "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "maximum": {
                        "type": "integer"
                      },
                      "minimum": {
                        "type": "integer"
                      },
                      "preset": {
                        "type": "integer"
                      }
                    },
                    "required": ["enabled"],
                    "title": "custom_unit_amount",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "lookup_key": {
                    "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.",
                    "maxLength": 200,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "nickname": {
                    "description": "A brief description of the price, hidden from customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "product": {
                    "description": "The ID of the product that this price will belong to.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "product_data": {
                    "description": "These fields can be used to create a new product that this price will belong to.",
                    "properties": {
                      "active": {
                        "type": "boolean"
                      },
                      "id": {
                        "deprecated": true,
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "statement_descriptor": {
                        "maxLength": 22,
                        "type": "string"
                      },
                      "tax_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "unit_label": {
                        "maxLength": 12,
                        "type": "string"
                      }
                    },
                    "required": ["name"],
                    "title": "inline_product_params",
                    "type": "object"
                  },
                  "recurring": {
                    "description": "The recurring components of a price such as `interval` and `usage_type`.",
                    "properties": {
                      "aggregate_usage": {
                        "enum": [
                          "last_during_period",
                          "last_ever",
                          "max",
                          "sum"
                        ],
                        "type": "string"
                      },
                      "interval": {
                        "enum": ["day", "month", "week", "year"],
                        "type": "string"
                      },
                      "interval_count": {
                        "type": "integer"
                      },
                      "meter": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "usage_type": {
                        "enum": ["licensed", "metered"],
                        "type": "string"
                      }
                    },
                    "required": ["interval"],
                    "title": "recurring",
                    "type": "object"
                  },
                  "tax_behavior": {
                    "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tiers": {
                    "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.",
                    "items": {
                      "properties": {
                        "flat_amount": {
                          "type": "integer"
                        },
                        "flat_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        },
                        "unit_amount": {
                          "type": "integer"
                        },
                        "unit_amount_decimal": {
                          "format": "decimal",
                          "type": "string"
                        },
                        "up_to": {
                          "anyOf": [
                            {
                              "enum": ["inf"],
                              "maxLength": 5000,
                              "type": "string"
                            },
                            {
                              "type": "integer"
                            }
                          ]
                        }
                      },
                      "required": ["up_to"],
                      "title": "tier",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "tiers_mode": {
                    "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.",
                    "enum": ["graduated", "volume"],
                    "type": "string"
                  },
                  "transfer_lookup_key": {
                    "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.",
                    "type": "boolean"
                  },
                  "transform_quantity": {
                    "description": "Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.",
                    "properties": {
                      "divide_by": {
                        "type": "integer"
                      },
                      "round": {
                        "enum": ["down", "up"],
                        "type": "string"
                      }
                    },
                    "required": ["divide_by", "round"],
                    "title": "transform_usage_param",
                    "type": "object"
                  },
                  "unit_amount": {
                    "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.",
                    "type": "integer"
                  },
                  "unit_amount_decimal": {
                    "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
                    "format": "decimal",
                    "type": "string"
                  }
                },
                "required": ["currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/price"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a price"
      }
    },
    "/v1/prices/search": {
      "get": {
        "description": "<p>Search for prices you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetPricesSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/price"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search prices"
      }
    },
    "/v1/prices/{price}": {
      "get": {
        "description": "<p>Retrieves the price with the given ID.</p>",
        "operationId": "GetPricesPrice",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "price",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/price"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a price"
      },
      "post": {
        "description": "<p>Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p>",
        "operationId": "PostPricesPrice",
        "parameters": [
          {
            "in": "path",
            "name": "price",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "currency_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the price can be used for new purchases. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "currency_options": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "properties": {
                            "custom_unit_amount": {
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                },
                                "maximum": {
                                  "type": "integer"
                                },
                                "minimum": {
                                  "type": "integer"
                                },
                                "preset": {
                                  "type": "integer"
                                }
                              },
                              "required": ["enabled"],
                              "title": "custom_unit_amount",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "tiers": {
                              "items": {
                                "properties": {
                                  "flat_amount": {
                                    "type": "integer"
                                  },
                                  "flat_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "up_to": {
                                    "anyOf": [
                                      {
                                        "enum": ["inf"],
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      {
                                        "type": "integer"
                                      }
                                    ]
                                  }
                                },
                                "required": ["up_to"],
                                "title": "tier",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "title": "currency_option",
                          "type": "object"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "lookup_key": {
                    "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.",
                    "maxLength": 200,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "nickname": {
                    "description": "A brief description of the price, hidden from customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_behavior": {
                    "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "transfer_lookup_key": {
                    "description": "If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/price"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a price"
      }
    },
    "/v1/products": {
      "get": {
        "description": "<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p>",
        "operationId": "GetProducts",
        "parameters": [
          {
            "description": "Only return products that are active or inactive (e.g., pass `false` to list all inactive products).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "Only return products that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).",
            "explode": true,
            "in": "query",
            "name": "ids",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return products that can be shipped (i.e., physical, not digital products).",
            "in": "query",
            "name": "shippable",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return products with the given url.",
            "in": "query",
            "name": "url",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/product"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/products",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ProductList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all products"
      },
      "post": {
        "description": "<p>Creates a new product object.</p>",
        "operationId": "PostProducts",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "default_price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "images": {
                  "explode": true,
                  "style": "deepObject"
                },
                "marketing_features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "package_dimensions": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the product is currently available for purchase. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "default_price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "currency_options": {
                        "additionalProperties": {
                          "properties": {
                            "custom_unit_amount": {
                              "properties": {
                                "enabled": {
                                  "type": "boolean"
                                },
                                "maximum": {
                                  "type": "integer"
                                },
                                "minimum": {
                                  "type": "integer"
                                },
                                "preset": {
                                  "type": "integer"
                                }
                              },
                              "required": ["enabled"],
                              "title": "custom_unit_amount",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "tiers": {
                              "items": {
                                "properties": {
                                  "flat_amount": {
                                    "type": "integer"
                                  },
                                  "flat_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "up_to": {
                                    "anyOf": [
                                      {
                                        "enum": ["inf"],
                                        "maxLength": 5000,
                                        "type": "string"
                                      },
                                      {
                                        "type": "integer"
                                      }
                                    ]
                                  }
                                },
                                "required": ["up_to"],
                                "title": "tier",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "title": "currency_option",
                          "type": "object"
                        },
                        "type": "object"
                      },
                      "custom_unit_amount": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "maximum": {
                            "type": "integer"
                          },
                          "minimum": {
                            "type": "integer"
                          },
                          "preset": {
                            "type": "integer"
                          }
                        },
                        "required": ["enabled"],
                        "title": "custom_unit_amount",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "recurring": {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "recurring_adhoc",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency"],
                    "title": "price_data_without_product_with_metadata",
                    "type": "object"
                  },
                  "description": {
                    "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.",
                    "maxLength": 40000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "id": {
                    "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "images": {
                    "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "marketing_features": {
                    "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).",
                    "items": {
                      "properties": {
                        "name": {
                          "maxLength": 5000,
                          "type": "string"
                        }
                      },
                      "required": ["name"],
                      "title": "features",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "description": "The product's name, meant to be displayable to the customer.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "package_dimensions": {
                    "description": "The dimensions of this product for shipping purposes.",
                    "properties": {
                      "height": {
                        "type": "number"
                      },
                      "length": {
                        "type": "number"
                      },
                      "weight": {
                        "type": "number"
                      },
                      "width": {
                        "type": "number"
                      }
                    },
                    "required": ["height", "length", "weight", "width"],
                    "title": "package_dimensions_specs",
                    "type": "object"
                  },
                  "shippable": {
                    "description": "Whether this product is shipped (i.e., physical goods).",
                    "type": "boolean"
                  },
                  "statement_descriptor": {
                    "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. Only used for subscription payments.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "tax_code": {
                    "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
                    "type": "string"
                  },
                  "unit_label": {
                    "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.",
                    "maxLength": 12,
                    "type": "string"
                  },
                  "url": {
                    "description": "A URL of a publicly-accessible webpage for this product.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a product"
      }
    },
    "/v1/products/search": {
      "get": {
        "description": "<p>Search for products you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetProductsSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/product"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search products"
      }
    },
    "/v1/products/{id}": {
      "delete": {
        "description": "<p>Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with <code>type=good</code> is only possible if it has no SKUs associated with it.</p>",
        "operationId": "DeleteProductsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_product"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a product"
      },
      "get": {
        "description": "<p>Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.</p>",
        "operationId": "GetProductsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a product"
      },
      "post": {
        "description": "<p>Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostProductsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "images": {
                  "explode": true,
                  "style": "deepObject"
                },
                "marketing_features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "package_dimensions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_code": {
                  "explode": true,
                  "style": "deepObject"
                },
                "unit_label": {
                  "explode": true,
                  "style": "deepObject"
                },
                "url": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the product is available for purchase.",
                    "type": "boolean"
                  },
                  "default_price": {
                    "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 40000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "images": {
                    "anyOf": [
                      {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer."
                  },
                  "marketing_features": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "name": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "required": ["name"],
                          "title": "features",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)."
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "name": {
                    "description": "The product's name, meant to be displayable to the customer.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "package_dimensions": {
                    "anyOf": [
                      {
                        "properties": {
                          "height": {
                            "type": "number"
                          },
                          "length": {
                            "type": "number"
                          },
                          "weight": {
                            "type": "number"
                          },
                          "width": {
                            "type": "number"
                          }
                        },
                        "required": ["height", "length", "weight", "width"],
                        "title": "package_dimensions_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The dimensions of this product for shipping purposes."
                  },
                  "shippable": {
                    "description": "Whether this product is shipped (i.e., physical goods).",
                    "type": "boolean"
                  },
                  "statement_descriptor": {
                    "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\n\nThis may be up to 22 characters. The statement description may not include `<`, `>`, `\\`, `\"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.\n It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.",
                    "maxLength": 22,
                    "type": "string"
                  },
                  "tax_code": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
                  },
                  "unit_label": {
                    "anyOf": [
                      {
                        "maxLength": 12,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`."
                  },
                  "url": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A URL of a publicly-accessible webpage for this product."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a product"
      }
    },
    "/v1/products/{product}/features": {
      "get": {
        "description": "<p>Retrieve a list of features for a product</p>",
        "operationId": "GetProductsProductFeatures",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "product",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/product_feature"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "EntitlementsResourceProductFeatureList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all features attached to a product"
      },
      "post": {
        "description": "<p>Creates a product_feature, which represents a feature attachment to a product</p>",
        "operationId": "PostProductsProductFeatures",
        "parameters": [
          {
            "in": "path",
            "name": "product",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "entitlement_feature": {
                    "description": "The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["entitlement_feature"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Attach a feature to a product"
      }
    },
    "/v1/products/{product}/features/{id}": {
      "delete": {
        "description": "<p>Deletes the feature attachment to a product</p>",
        "operationId": "DeleteProductsProductFeaturesId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "product",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_product_feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Remove a feature from a product"
      },
      "get": {
        "description": "<p>Retrieves a product_feature, which represents a feature attachment to a product</p>",
        "operationId": "GetProductsProductFeaturesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the product_feature.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "The ID of the product.",
            "in": "path",
            "name": "product",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/product_feature"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a product_feature"
      }
    },
    "/v1/promotion_codes": {
      "get": {
        "description": "<p>Returns a list of your promotion codes.</p>",
        "operationId": "GetPromotionCodes",
        "parameters": [
          {
            "description": "Filter promotion codes by whether they are active.",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "Only return promotion codes that have this case-insensitive code.",
            "in": "query",
            "name": "code",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return promotion codes for this coupon.",
            "in": "query",
            "name": "coupon",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return promotion codes that are restricted to this customer.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/promotion_code"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/promotion_codes",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PromotionCodesResourcePromotionCodeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all promotion codes"
      },
      "post": {
        "description": "<p>A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.</p>",
        "operationId": "PostPromotionCodes",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "restrictions": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the promotion code is currently active.",
                    "type": "boolean"
                  },
                  "code": {
                    "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).\n\nIf left blank, we will generate one automatically.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "coupon": {
                    "description": "The coupon for this promotion code.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer": {
                    "description": "The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "max_redemptions": {
                    "description": "A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.",
                    "type": "integer"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "restrictions": {
                    "description": "Settings that restrict the redemption of the promotion code.",
                    "properties": {
                      "currency_options": {
                        "additionalProperties": {
                          "properties": {
                            "minimum_amount": {
                              "type": "integer"
                            }
                          },
                          "title": "currency_option",
                          "type": "object"
                        },
                        "type": "object"
                      },
                      "first_time_transaction": {
                        "type": "boolean"
                      },
                      "minimum_amount": {
                        "type": "integer"
                      },
                      "minimum_amount_currency": {
                        "format": "currency",
                        "type": "string"
                      }
                    },
                    "title": "restrictions_params",
                    "type": "object"
                  }
                },
                "required": ["coupon"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/promotion_code"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a promotion code"
      }
    },
    "/v1/promotion_codes/{promotion_code}": {
      "get": {
        "description": "<p>Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing <code>code</code> use <a href=\"/docs/api/promotion_codes/list\">list</a> with the desired <code>code</code>.</p>",
        "operationId": "GetPromotionCodesPromotionCode",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "promotion_code",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/promotion_code"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a promotion code"
      },
      "post": {
        "description": "<p>Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.</p>",
        "operationId": "PostPromotionCodesPromotionCode",
        "parameters": [
          {
            "in": "path",
            "name": "promotion_code",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "restrictions": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "restrictions": {
                    "description": "Settings that restrict the redemption of the promotion code.",
                    "properties": {
                      "currency_options": {
                        "additionalProperties": {
                          "properties": {
                            "minimum_amount": {
                              "type": "integer"
                            }
                          },
                          "title": "currency_option",
                          "type": "object"
                        },
                        "type": "object"
                      }
                    },
                    "title": "restrictions_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/promotion_code"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a promotion code"
      }
    },
    "/v1/quotes": {
      "get": {
        "description": "<p>Returns a list of your quotes.</p>",
        "operationId": "GetQuotes",
        "parameters": [
          {
            "description": "The ID of the customer whose quotes will be retrieved.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The status of the quote.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["accepted", "canceled", "draft", "open"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.",
            "in": "query",
            "name": "test_clock",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/quote"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/quotes",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "QuotesResourceQuoteList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all quotes"
      },
      "post": {
        "description": "<p>A quote models prices and services for a customer. Default options for <code>header</code>, <code>description</code>, <code>footer</code>, and <code>expires_at</code> can be set in the dashboard via the <a href=\"https://dashboard.stripe.com/settings/billing/quote\">quote template</a>.</p>",
        "operationId": "PostQuotes",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "application_fee_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "footer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "from_quote": {
                  "explode": true,
                  "style": "deepObject"
                },
                "header": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "application_fee_amount": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field."
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field."
                  },
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_param",
                    "type": "object"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "customer": {
                    "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any line item that does not have `tax_rates` set."
                  },
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The discounts applied to the quote."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "footer": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
                  },
                  "from_quote": {
                    "description": "Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.",
                    "properties": {
                      "is_revision": {
                        "type": "boolean"
                      },
                      "quote": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["quote"],
                    "title": "from_quote_params",
                    "type": "object"
                  },
                  "header": {
                    "anyOf": [
                      {
                        "maxLength": 50,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "days_until_due": {
                        "type": "integer"
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "quote_param",
                    "type": "object"
                  },
                  "line_items": {
                    "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "line_item_create_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account on behalf of which to charge."
                  },
                  "subscription_data": {
                    "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
                    "properties": {
                      "description": {
                        "maxLength": 500,
                        "type": "string"
                      },
                      "effective_date": {
                        "anyOf": [
                          {
                            "enum": ["current_period_end"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "trial_period_days": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "subscription_data_create_params",
                    "type": "object"
                  },
                  "test_clock": {
                    "description": "ID of the test clock to attach to the quote.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "transfer_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The data with which to automatically create a Transfer for each of the invoices."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a quote"
      }
    },
    "/v1/quotes/{quote}": {
      "get": {
        "description": "<p>Retrieves the quote with the given ID.</p>",
        "operationId": "GetQuotesQuote",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a quote"
      },
      "post": {
        "description": "<p>A quote models prices and services for a customer.</p>",
        "operationId": "PostQuotesQuote",
        "parameters": [
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "application_fee_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "footer": {
                  "explode": true,
                  "style": "deepObject"
                },
                "header": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "subscription_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "application_fee_amount": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field."
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field."
                  },
                  "automatic_tax": {
                    "description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_param",
                    "type": "object"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "customer": {
                    "description": "The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any line item that does not have `tax_rates` set."
                  },
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A description that will be displayed on the quote PDF."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The discounts applied to the quote."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "footer": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A footer that will be displayed on the quote PDF."
                  },
                  "header": {
                    "anyOf": [
                      {
                        "maxLength": 50,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A header that will be displayed on the quote PDF."
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "days_until_due": {
                        "type": "integer"
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "quote_param",
                    "type": "object"
                  },
                  "line_items": {
                    "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "line_item_update_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account on behalf of which to charge."
                  },
                  "subscription_data": {
                    "description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
                    "properties": {
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 500,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "effective_date": {
                        "anyOf": [
                          {
                            "enum": ["current_period_end"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "trial_period_days": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "subscription_data_update_params",
                    "type": "object"
                  },
                  "transfer_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount": {
                            "type": "integer"
                          },
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The data with which to automatically create a Transfer for each of the invoices."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a quote"
      }
    },
    "/v1/quotes/{quote}/accept": {
      "post": {
        "description": "<p>Accepts the specified quote.</p>",
        "operationId": "PostQuotesQuoteAccept",
        "parameters": [
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Accept a quote"
      }
    },
    "/v1/quotes/{quote}/cancel": {
      "post": {
        "description": "<p>Cancels the quote.</p>",
        "operationId": "PostQuotesQuoteCancel",
        "parameters": [
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a quote"
      }
    },
    "/v1/quotes/{quote}/computed_upfront_line_items": {
      "get": {
        "description": "<p>When retrieving a quote, there is an includable <a href=\"https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items\"><strong>computed.upfront.line_items</strong></a> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.</p>",
        "operationId": "GetQuotesQuoteComputedUpfrontLineItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "QuotesResourceListLineItems",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a quote's upfront line items"
      }
    },
    "/v1/quotes/{quote}/finalize": {
      "post": {
        "description": "<p>Finalizes the quote.</p>",
        "operationId": "PostQuotesQuoteFinalize",
        "parameters": [
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/quote"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Finalize a quote"
      }
    },
    "/v1/quotes/{quote}/line_items": {
      "get": {
        "description": "<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>",
        "operationId": "GetQuotesQuoteLineItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "QuotesResourceListLineItems",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a quote's line items"
      }
    },
    "/v1/quotes/{quote}/pdf": {
      "get": {
        "description": "<p>Download the PDF for a finalized quote. Explanation for special handling can be found <a href=\"https://docs.stripe.com/quotes/overview#quote_pdf\">here</a></p>",
        "operationId": "GetQuotesQuotePdf",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "quote",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "servers": [
          {
            "url": "https://files.stripe.com/"
          }
        ],
        "summary": "Download quote PDF"
      }
    },
    "/v1/radar/early_fraud_warnings": {
      "get": {
        "description": "<p>Returns a list of early fraud warnings.</p>",
        "operationId": "GetRadarEarlyFraudWarnings",
        "parameters": [
          {
            "description": "Only return early fraud warnings for the charge specified by this charge ID.",
            "in": "query",
            "name": "charge",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return early fraud warnings that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.",
            "in": "query",
            "name": "payment_intent",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/radar.early_fraud_warning"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/radar/early_fraud_warnings",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "RadarEarlyFraudWarningList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all early fraud warnings"
      }
    },
    "/v1/radar/early_fraud_warnings/{early_fraud_warning}": {
      "get": {
        "description": "<p>Retrieves the details of an early fraud warning that has previously been created. </p>\n\n<p>Please refer to the <a href=\"#early_fraud_warning_object\">early fraud warning</a> object reference for more details.</p>",
        "operationId": "GetRadarEarlyFraudWarningsEarlyFraudWarning",
        "parameters": [
          {
            "in": "path",
            "name": "early_fraud_warning",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.early_fraud_warning"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an early fraud warning"
      }
    },
    "/v1/radar/value_list_items": {
      "get": {
        "description": "<p>Returns a list of <code>ValueListItem</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetRadarValueListItems",
        "parameters": [
          {
            "description": "Only return items that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Return items belonging to the parent list whose value matches the specified value (using an \"is like\" match).",
            "in": "query",
            "name": "value",
            "required": false,
            "schema": {
              "maxLength": 800,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Identifier for the parent value list this item belongs to.",
            "in": "query",
            "name": "value_list",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/radar.value_list_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/radar/value_list_items",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "RadarListListItemList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all value list items"
      },
      "post": {
        "description": "<p>Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.</p>",
        "operationId": "PostRadarValueListItems",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "value": {
                    "description": "The value of the item (whose type must match the type of the parent value list).",
                    "maxLength": 800,
                    "type": "string"
                  },
                  "value_list": {
                    "description": "The identifier of the value list which the created item will be added to.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["value", "value_list"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.value_list_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a value list item"
      }
    },
    "/v1/radar/value_list_items/{item}": {
      "delete": {
        "description": "<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p>",
        "operationId": "DeleteRadarValueListItemsItem",
        "parameters": [
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_radar.value_list_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a value list item"
      },
      "get": {
        "description": "<p>Retrieves a <code>ValueListItem</code> object.</p>",
        "operationId": "GetRadarValueListItemsItem",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.value_list_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a value list item"
      }
    },
    "/v1/radar/value_lists": {
      "get": {
        "description": "<p>Returns a list of <code>ValueList</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetRadarValueLists",
        "parameters": [
          {
            "description": "The alias used to reference the value list when writing rules.",
            "in": "query",
            "name": "alias",
            "required": false,
            "schema": {
              "maxLength": 100,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A value contained within a value list - returns all value lists containing this value.",
            "in": "query",
            "name": "contains",
            "required": false,
            "schema": {
              "maxLength": 800,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return value lists that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/radar.value_list"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/radar/value_lists",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "RadarListListList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all value lists"
      },
      "post": {
        "description": "<p>Creates a new <code>ValueList</code> object, which can then be referenced in rules.</p>",
        "operationId": "PostRadarValueLists",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alias": {
                    "description": "The name of the value list for use in rules.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "item_type": {
                    "description": "Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed.",
                    "enum": [
                      "card_bin",
                      "card_fingerprint",
                      "case_sensitive_string",
                      "country",
                      "customer_id",
                      "email",
                      "ip_address",
                      "sepa_debit_fingerprint",
                      "string",
                      "us_bank_account_fingerprint"
                    ],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "description": "The human-readable name of the value list.",
                    "maxLength": 100,
                    "type": "string"
                  }
                },
                "required": ["alias", "name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.value_list"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a value list"
      }
    },
    "/v1/radar/value_lists/{value_list}": {
      "delete": {
        "description": "<p>Deletes a <code>ValueList</code> object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.</p>",
        "operationId": "DeleteRadarValueListsValueList",
        "parameters": [
          {
            "in": "path",
            "name": "value_list",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_radar.value_list"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a value list"
      },
      "get": {
        "description": "<p>Retrieves a <code>ValueList</code> object.</p>",
        "operationId": "GetRadarValueListsValueList",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "value_list",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.value_list"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a value list"
      },
      "post": {
        "description": "<p>Updates a <code>ValueList</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that <code>item_type</code> is immutable.</p>",
        "operationId": "PostRadarValueListsValueList",
        "parameters": [
          {
            "in": "path",
            "name": "value_list",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "alias": {
                    "description": "The name of the value list for use in rules.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "name": {
                    "description": "The human-readable name of the value list.",
                    "maxLength": 100,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/radar.value_list"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a value list"
      }
    },
    "/v1/refunds": {
      "get": {
        "description": "<p>Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.</p>",
        "operationId": "GetRefunds",
        "parameters": [
          {
            "description": "Only return refunds for the charge specified by this charge ID.",
            "in": "query",
            "name": "charge",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return refunds that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return refunds for the PaymentIntent specified by this ID.",
            "in": "query",
            "name": "payment_intent",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/refund"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/refunds",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "APIMethodRefundList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all refunds"
      },
      "post": {
        "description": "<p>When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.</p>\n\n<p>Creating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.</p>\n\n<p>You can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.</p>\n\n<p>Once entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.</p>",
        "operationId": "PostRefunds",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "type": "integer"
                  },
                  "charge": {
                    "description": "The identifier of the charge to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "Customer whose customer balance to refund from.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "instructions_email": {
                    "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.",
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "origin": {
                    "description": "Origin of the refund",
                    "enum": ["customer_balance"],
                    "type": "string"
                  },
                  "payment_intent": {
                    "description": "The identifier of the PaymentIntent to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "reason": {
                    "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.",
                    "enum": [
                      "duplicate",
                      "fraudulent",
                      "requested_by_customer"
                    ],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "refund_application_fee": {
                    "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
                    "type": "boolean"
                  },
                  "reverse_transfer": {
                    "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create customer balance refund"
      }
    },
    "/v1/refunds/{refund}": {
      "get": {
        "description": "<p>Retrieves the details of an existing refund.</p>",
        "operationId": "GetRefundsRefund",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a refund"
      },
      "post": {
        "description": "<p>Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.</p>\n\n<p>This request only accepts <code>metadata</code> as an argument.</p>",
        "operationId": "PostRefundsRefund",
        "parameters": [
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a refund"
      }
    },
    "/v1/refunds/{refund}/cancel": {
      "post": {
        "description": "<p>Cancels a refund with a status of <code>requires_action</code>.</p>\n\n<p>You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the <code>requires_action</code> state.</p>",
        "operationId": "PostRefundsRefundCancel",
        "parameters": [
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a refund"
      }
    },
    "/v1/reporting/report_runs": {
      "get": {
        "description": "<p>Returns a list of Report Runs, with the most recent appearing first.</p>",
        "operationId": "GetReportingReportRuns",
        "parameters": [
          {
            "description": "Only return Report Runs that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/reporting.report_run"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/reporting/report_runs",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "FinancialReportingFinanceReportRunList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Report Runs"
      },
      "post": {
        "description": "<p>Creates a new object and begin running the report. (Certain report types require a <a href=\"https://stripe.com/docs/keys#test-live-modes\">live-mode API key</a>.)</p>",
        "operationId": "PostReportingReportRuns",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "parameters": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "parameters": {
                    "description": "Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation.",
                    "properties": {
                      "columns": {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "connected_account": {
                        "type": "string"
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "interval_end": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "interval_start": {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      "payout": {
                        "type": "string"
                      },
                      "reporting_category": {
                        "enum": [
                          "advance",
                          "advance_funding",
                          "anticipation_repayment",
                          "charge",
                          "charge_failure",
                          "climate_order_purchase",
                          "climate_order_refund",
                          "connect_collection_transfer",
                          "connect_reserved_funds",
                          "contribution",
                          "dispute",
                          "dispute_reversal",
                          "fee",
                          "financing_paydown",
                          "financing_paydown_reversal",
                          "financing_payout",
                          "financing_payout_reversal",
                          "issuing_authorization_hold",
                          "issuing_authorization_release",
                          "issuing_dispute",
                          "issuing_transaction",
                          "network_cost",
                          "other_adjustment",
                          "partial_capture_reversal",
                          "payout",
                          "payout_reversal",
                          "platform_earning",
                          "platform_earning_refund",
                          "refund",
                          "refund_failure",
                          "risk_reserved_funds",
                          "tax",
                          "topup",
                          "topup_reversal",
                          "transfer",
                          "transfer_reversal",
                          "unreconciled_customer_funds"
                        ],
                        "maxLength": 5000,
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "timezone": {
                        "enum": [
                          "Africa/Abidjan",
                          "Africa/Accra",
                          "Africa/Addis_Ababa",
                          "Africa/Algiers",
                          "Africa/Asmara",
                          "Africa/Asmera",
                          "Africa/Bamako",
                          "Africa/Bangui",
                          "Africa/Banjul",
                          "Africa/Bissau",
                          "Africa/Blantyre",
                          "Africa/Brazzaville",
                          "Africa/Bujumbura",
                          "Africa/Cairo",
                          "Africa/Casablanca",
                          "Africa/Ceuta",
                          "Africa/Conakry",
                          "Africa/Dakar",
                          "Africa/Dar_es_Salaam",
                          "Africa/Djibouti",
                          "Africa/Douala",
                          "Africa/El_Aaiun",
                          "Africa/Freetown",
                          "Africa/Gaborone",
                          "Africa/Harare",
                          "Africa/Johannesburg",
                          "Africa/Juba",
                          "Africa/Kampala",
                          "Africa/Khartoum",
                          "Africa/Kigali",
                          "Africa/Kinshasa",
                          "Africa/Lagos",
                          "Africa/Libreville",
                          "Africa/Lome",
                          "Africa/Luanda",
                          "Africa/Lubumbashi",
                          "Africa/Lusaka",
                          "Africa/Malabo",
                          "Africa/Maputo",
                          "Africa/Maseru",
                          "Africa/Mbabane",
                          "Africa/Mogadishu",
                          "Africa/Monrovia",
                          "Africa/Nairobi",
                          "Africa/Ndjamena",
                          "Africa/Niamey",
                          "Africa/Nouakchott",
                          "Africa/Ouagadougou",
                          "Africa/Porto-Novo",
                          "Africa/Sao_Tome",
                          "Africa/Timbuktu",
                          "Africa/Tripoli",
                          "Africa/Tunis",
                          "Africa/Windhoek",
                          "America/Adak",
                          "America/Anchorage",
                          "America/Anguilla",
                          "America/Antigua",
                          "America/Araguaina",
                          "America/Argentina/Buenos_Aires",
                          "America/Argentina/Catamarca",
                          "America/Argentina/ComodRivadavia",
                          "America/Argentina/Cordoba",
                          "America/Argentina/Jujuy",
                          "America/Argentina/La_Rioja",
                          "America/Argentina/Mendoza",
                          "America/Argentina/Rio_Gallegos",
                          "America/Argentina/Salta",
                          "America/Argentina/San_Juan",
                          "America/Argentina/San_Luis",
                          "America/Argentina/Tucuman",
                          "America/Argentina/Ushuaia",
                          "America/Aruba",
                          "America/Asuncion",
                          "America/Atikokan",
                          "America/Atka",
                          "America/Bahia",
                          "America/Bahia_Banderas",
                          "America/Barbados",
                          "America/Belem",
                          "America/Belize",
                          "America/Blanc-Sablon",
                          "America/Boa_Vista",
                          "America/Bogota",
                          "America/Boise",
                          "America/Buenos_Aires",
                          "America/Cambridge_Bay",
                          "America/Campo_Grande",
                          "America/Cancun",
                          "America/Caracas",
                          "America/Catamarca",
                          "America/Cayenne",
                          "America/Cayman",
                          "America/Chicago",
                          "America/Chihuahua",
                          "America/Ciudad_Juarez",
                          "America/Coral_Harbour",
                          "America/Cordoba",
                          "America/Costa_Rica",
                          "America/Creston",
                          "America/Cuiaba",
                          "America/Curacao",
                          "America/Danmarkshavn",
                          "America/Dawson",
                          "America/Dawson_Creek",
                          "America/Denver",
                          "America/Detroit",
                          "America/Dominica",
                          "America/Edmonton",
                          "America/Eirunepe",
                          "America/El_Salvador",
                          "America/Ensenada",
                          "America/Fort_Nelson",
                          "America/Fort_Wayne",
                          "America/Fortaleza",
                          "America/Glace_Bay",
                          "America/Godthab",
                          "America/Goose_Bay",
                          "America/Grand_Turk",
                          "America/Grenada",
                          "America/Guadeloupe",
                          "America/Guatemala",
                          "America/Guayaquil",
                          "America/Guyana",
                          "America/Halifax",
                          "America/Havana",
                          "America/Hermosillo",
                          "America/Indiana/Indianapolis",
                          "America/Indiana/Knox",
                          "America/Indiana/Marengo",
                          "America/Indiana/Petersburg",
                          "America/Indiana/Tell_City",
                          "America/Indiana/Vevay",
                          "America/Indiana/Vincennes",
                          "America/Indiana/Winamac",
                          "America/Indianapolis",
                          "America/Inuvik",
                          "America/Iqaluit",
                          "America/Jamaica",
                          "America/Jujuy",
                          "America/Juneau",
                          "America/Kentucky/Louisville",
                          "America/Kentucky/Monticello",
                          "America/Knox_IN",
                          "America/Kralendijk",
                          "America/La_Paz",
                          "America/Lima",
                          "America/Los_Angeles",
                          "America/Louisville",
                          "America/Lower_Princes",
                          "America/Maceio",
                          "America/Managua",
                          "America/Manaus",
                          "America/Marigot",
                          "America/Martinique",
                          "America/Matamoros",
                          "America/Mazatlan",
                          "America/Mendoza",
                          "America/Menominee",
                          "America/Merida",
                          "America/Metlakatla",
                          "America/Mexico_City",
                          "America/Miquelon",
                          "America/Moncton",
                          "America/Monterrey",
                          "America/Montevideo",
                          "America/Montreal",
                          "America/Montserrat",
                          "America/Nassau",
                          "America/New_York",
                          "America/Nipigon",
                          "America/Nome",
                          "America/Noronha",
                          "America/North_Dakota/Beulah",
                          "America/North_Dakota/Center",
                          "America/North_Dakota/New_Salem",
                          "America/Nuuk",
                          "America/Ojinaga",
                          "America/Panama",
                          "America/Pangnirtung",
                          "America/Paramaribo",
                          "America/Phoenix",
                          "America/Port-au-Prince",
                          "America/Port_of_Spain",
                          "America/Porto_Acre",
                          "America/Porto_Velho",
                          "America/Puerto_Rico",
                          "America/Punta_Arenas",
                          "America/Rainy_River",
                          "America/Rankin_Inlet",
                          "America/Recife",
                          "America/Regina",
                          "America/Resolute",
                          "America/Rio_Branco",
                          "America/Rosario",
                          "America/Santa_Isabel",
                          "America/Santarem",
                          "America/Santiago",
                          "America/Santo_Domingo",
                          "America/Sao_Paulo",
                          "America/Scoresbysund",
                          "America/Shiprock",
                          "America/Sitka",
                          "America/St_Barthelemy",
                          "America/St_Johns",
                          "America/St_Kitts",
                          "America/St_Lucia",
                          "America/St_Thomas",
                          "America/St_Vincent",
                          "America/Swift_Current",
                          "America/Tegucigalpa",
                          "America/Thule",
                          "America/Thunder_Bay",
                          "America/Tijuana",
                          "America/Toronto",
                          "America/Tortola",
                          "America/Vancouver",
                          "America/Virgin",
                          "America/Whitehorse",
                          "America/Winnipeg",
                          "America/Yakutat",
                          "America/Yellowknife",
                          "Antarctica/Casey",
                          "Antarctica/Davis",
                          "Antarctica/DumontDUrville",
                          "Antarctica/Macquarie",
                          "Antarctica/Mawson",
                          "Antarctica/McMurdo",
                          "Antarctica/Palmer",
                          "Antarctica/Rothera",
                          "Antarctica/South_Pole",
                          "Antarctica/Syowa",
                          "Antarctica/Troll",
                          "Antarctica/Vostok",
                          "Arctic/Longyearbyen",
                          "Asia/Aden",
                          "Asia/Almaty",
                          "Asia/Amman",
                          "Asia/Anadyr",
                          "Asia/Aqtau",
                          "Asia/Aqtobe",
                          "Asia/Ashgabat",
                          "Asia/Ashkhabad",
                          "Asia/Atyrau",
                          "Asia/Baghdad",
                          "Asia/Bahrain",
                          "Asia/Baku",
                          "Asia/Bangkok",
                          "Asia/Barnaul",
                          "Asia/Beirut",
                          "Asia/Bishkek",
                          "Asia/Brunei",
                          "Asia/Calcutta",
                          "Asia/Chita",
                          "Asia/Choibalsan",
                          "Asia/Chongqing",
                          "Asia/Chungking",
                          "Asia/Colombo",
                          "Asia/Dacca",
                          "Asia/Damascus",
                          "Asia/Dhaka",
                          "Asia/Dili",
                          "Asia/Dubai",
                          "Asia/Dushanbe",
                          "Asia/Famagusta",
                          "Asia/Gaza",
                          "Asia/Harbin",
                          "Asia/Hebron",
                          "Asia/Ho_Chi_Minh",
                          "Asia/Hong_Kong",
                          "Asia/Hovd",
                          "Asia/Irkutsk",
                          "Asia/Istanbul",
                          "Asia/Jakarta",
                          "Asia/Jayapura",
                          "Asia/Jerusalem",
                          "Asia/Kabul",
                          "Asia/Kamchatka",
                          "Asia/Karachi",
                          "Asia/Kashgar",
                          "Asia/Kathmandu",
                          "Asia/Katmandu",
                          "Asia/Khandyga",
                          "Asia/Kolkata",
                          "Asia/Krasnoyarsk",
                          "Asia/Kuala_Lumpur",
                          "Asia/Kuching",
                          "Asia/Kuwait",
                          "Asia/Macao",
                          "Asia/Macau",
                          "Asia/Magadan",
                          "Asia/Makassar",
                          "Asia/Manila",
                          "Asia/Muscat",
                          "Asia/Nicosia",
                          "Asia/Novokuznetsk",
                          "Asia/Novosibirsk",
                          "Asia/Omsk",
                          "Asia/Oral",
                          "Asia/Phnom_Penh",
                          "Asia/Pontianak",
                          "Asia/Pyongyang",
                          "Asia/Qatar",
                          "Asia/Qostanay",
                          "Asia/Qyzylorda",
                          "Asia/Rangoon",
                          "Asia/Riyadh",
                          "Asia/Saigon",
                          "Asia/Sakhalin",
                          "Asia/Samarkand",
                          "Asia/Seoul",
                          "Asia/Shanghai",
                          "Asia/Singapore",
                          "Asia/Srednekolymsk",
                          "Asia/Taipei",
                          "Asia/Tashkent",
                          "Asia/Tbilisi",
                          "Asia/Tehran",
                          "Asia/Tel_Aviv",
                          "Asia/Thimbu",
                          "Asia/Thimphu",
                          "Asia/Tokyo",
                          "Asia/Tomsk",
                          "Asia/Ujung_Pandang",
                          "Asia/Ulaanbaatar",
                          "Asia/Ulan_Bator",
                          "Asia/Urumqi",
                          "Asia/Ust-Nera",
                          "Asia/Vientiane",
                          "Asia/Vladivostok",
                          "Asia/Yakutsk",
                          "Asia/Yangon",
                          "Asia/Yekaterinburg",
                          "Asia/Yerevan",
                          "Atlantic/Azores",
                          "Atlantic/Bermuda",
                          "Atlantic/Canary",
                          "Atlantic/Cape_Verde",
                          "Atlantic/Faeroe",
                          "Atlantic/Faroe",
                          "Atlantic/Jan_Mayen",
                          "Atlantic/Madeira",
                          "Atlantic/Reykjavik",
                          "Atlantic/South_Georgia",
                          "Atlantic/St_Helena",
                          "Atlantic/Stanley",
                          "Australia/ACT",
                          "Australia/Adelaide",
                          "Australia/Brisbane",
                          "Australia/Broken_Hill",
                          "Australia/Canberra",
                          "Australia/Currie",
                          "Australia/Darwin",
                          "Australia/Eucla",
                          "Australia/Hobart",
                          "Australia/LHI",
                          "Australia/Lindeman",
                          "Australia/Lord_Howe",
                          "Australia/Melbourne",
                          "Australia/NSW",
                          "Australia/North",
                          "Australia/Perth",
                          "Australia/Queensland",
                          "Australia/South",
                          "Australia/Sydney",
                          "Australia/Tasmania",
                          "Australia/Victoria",
                          "Australia/West",
                          "Australia/Yancowinna",
                          "Brazil/Acre",
                          "Brazil/DeNoronha",
                          "Brazil/East",
                          "Brazil/West",
                          "CET",
                          "CST6CDT",
                          "Canada/Atlantic",
                          "Canada/Central",
                          "Canada/Eastern",
                          "Canada/Mountain",
                          "Canada/Newfoundland",
                          "Canada/Pacific",
                          "Canada/Saskatchewan",
                          "Canada/Yukon",
                          "Chile/Continental",
                          "Chile/EasterIsland",
                          "Cuba",
                          "EET",
                          "EST",
                          "EST5EDT",
                          "Egypt",
                          "Eire",
                          "Etc/GMT",
                          "Etc/GMT+0",
                          "Etc/GMT+1",
                          "Etc/GMT+10",
                          "Etc/GMT+11",
                          "Etc/GMT+12",
                          "Etc/GMT+2",
                          "Etc/GMT+3",
                          "Etc/GMT+4",
                          "Etc/GMT+5",
                          "Etc/GMT+6",
                          "Etc/GMT+7",
                          "Etc/GMT+8",
                          "Etc/GMT+9",
                          "Etc/GMT-0",
                          "Etc/GMT-1",
                          "Etc/GMT-10",
                          "Etc/GMT-11",
                          "Etc/GMT-12",
                          "Etc/GMT-13",
                          "Etc/GMT-14",
                          "Etc/GMT-2",
                          "Etc/GMT-3",
                          "Etc/GMT-4",
                          "Etc/GMT-5",
                          "Etc/GMT-6",
                          "Etc/GMT-7",
                          "Etc/GMT-8",
                          "Etc/GMT-9",
                          "Etc/GMT0",
                          "Etc/Greenwich",
                          "Etc/UCT",
                          "Etc/UTC",
                          "Etc/Universal",
                          "Etc/Zulu",
                          "Europe/Amsterdam",
                          "Europe/Andorra",
                          "Europe/Astrakhan",
                          "Europe/Athens",
                          "Europe/Belfast",
                          "Europe/Belgrade",
                          "Europe/Berlin",
                          "Europe/Bratislava",
                          "Europe/Brussels",
                          "Europe/Bucharest",
                          "Europe/Budapest",
                          "Europe/Busingen",
                          "Europe/Chisinau",
                          "Europe/Copenhagen",
                          "Europe/Dublin",
                          "Europe/Gibraltar",
                          "Europe/Guernsey",
                          "Europe/Helsinki",
                          "Europe/Isle_of_Man",
                          "Europe/Istanbul",
                          "Europe/Jersey",
                          "Europe/Kaliningrad",
                          "Europe/Kiev",
                          "Europe/Kirov",
                          "Europe/Kyiv",
                          "Europe/Lisbon",
                          "Europe/Ljubljana",
                          "Europe/London",
                          "Europe/Luxembourg",
                          "Europe/Madrid",
                          "Europe/Malta",
                          "Europe/Mariehamn",
                          "Europe/Minsk",
                          "Europe/Monaco",
                          "Europe/Moscow",
                          "Europe/Nicosia",
                          "Europe/Oslo",
                          "Europe/Paris",
                          "Europe/Podgorica",
                          "Europe/Prague",
                          "Europe/Riga",
                          "Europe/Rome",
                          "Europe/Samara",
                          "Europe/San_Marino",
                          "Europe/Sarajevo",
                          "Europe/Saratov",
                          "Europe/Simferopol",
                          "Europe/Skopje",
                          "Europe/Sofia",
                          "Europe/Stockholm",
                          "Europe/Tallinn",
                          "Europe/Tirane",
                          "Europe/Tiraspol",
                          "Europe/Ulyanovsk",
                          "Europe/Uzhgorod",
                          "Europe/Vaduz",
                          "Europe/Vatican",
                          "Europe/Vienna",
                          "Europe/Vilnius",
                          "Europe/Volgograd",
                          "Europe/Warsaw",
                          "Europe/Zagreb",
                          "Europe/Zaporozhye",
                          "Europe/Zurich",
                          "Factory",
                          "GB",
                          "GB-Eire",
                          "GMT",
                          "GMT+0",
                          "GMT-0",
                          "GMT0",
                          "Greenwich",
                          "HST",
                          "Hongkong",
                          "Iceland",
                          "Indian/Antananarivo",
                          "Indian/Chagos",
                          "Indian/Christmas",
                          "Indian/Cocos",
                          "Indian/Comoro",
                          "Indian/Kerguelen",
                          "Indian/Mahe",
                          "Indian/Maldives",
                          "Indian/Mauritius",
                          "Indian/Mayotte",
                          "Indian/Reunion",
                          "Iran",
                          "Israel",
                          "Jamaica",
                          "Japan",
                          "Kwajalein",
                          "Libya",
                          "MET",
                          "MST",
                          "MST7MDT",
                          "Mexico/BajaNorte",
                          "Mexico/BajaSur",
                          "Mexico/General",
                          "NZ",
                          "NZ-CHAT",
                          "Navajo",
                          "PRC",
                          "PST8PDT",
                          "Pacific/Apia",
                          "Pacific/Auckland",
                          "Pacific/Bougainville",
                          "Pacific/Chatham",
                          "Pacific/Chuuk",
                          "Pacific/Easter",
                          "Pacific/Efate",
                          "Pacific/Enderbury",
                          "Pacific/Fakaofo",
                          "Pacific/Fiji",
                          "Pacific/Funafuti",
                          "Pacific/Galapagos",
                          "Pacific/Gambier",
                          "Pacific/Guadalcanal",
                          "Pacific/Guam",
                          "Pacific/Honolulu",
                          "Pacific/Johnston",
                          "Pacific/Kanton",
                          "Pacific/Kiritimati",
                          "Pacific/Kosrae",
                          "Pacific/Kwajalein",
                          "Pacific/Majuro",
                          "Pacific/Marquesas",
                          "Pacific/Midway",
                          "Pacific/Nauru",
                          "Pacific/Niue",
                          "Pacific/Norfolk",
                          "Pacific/Noumea",
                          "Pacific/Pago_Pago",
                          "Pacific/Palau",
                          "Pacific/Pitcairn",
                          "Pacific/Pohnpei",
                          "Pacific/Ponape",
                          "Pacific/Port_Moresby",
                          "Pacific/Rarotonga",
                          "Pacific/Saipan",
                          "Pacific/Samoa",
                          "Pacific/Tahiti",
                          "Pacific/Tarawa",
                          "Pacific/Tongatapu",
                          "Pacific/Truk",
                          "Pacific/Wake",
                          "Pacific/Wallis",
                          "Pacific/Yap",
                          "Poland",
                          "Portugal",
                          "ROC",
                          "ROK",
                          "Singapore",
                          "Turkey",
                          "UCT",
                          "US/Alaska",
                          "US/Aleutian",
                          "US/Arizona",
                          "US/Central",
                          "US/East-Indiana",
                          "US/Eastern",
                          "US/Hawaii",
                          "US/Indiana-Starke",
                          "US/Michigan",
                          "US/Mountain",
                          "US/Pacific",
                          "US/Pacific-New",
                          "US/Samoa",
                          "UTC",
                          "Universal",
                          "W-SU",
                          "WET",
                          "Zulu"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "run_parameter_specs",
                    "type": "object"
                  },
                  "report_type": {
                    "description": "The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`.",
                    "type": "string"
                  }
                },
                "required": ["report_type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/reporting.report_run"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Report Run"
      }
    },
    "/v1/reporting/report_runs/{report_run}": {
      "get": {
        "description": "<p>Retrieves the details of an existing Report Run.</p>",
        "operationId": "GetReportingReportRunsReportRun",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "report_run",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/reporting.report_run"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Report Run"
      }
    },
    "/v1/reporting/report_types": {
      "get": {
        "description": "<p>Returns a full list of Report Types.</p>",
        "operationId": "GetReportingReportTypes",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/reporting.report_type"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "FinancialReportingFinanceReportTypeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Report Types"
      }
    },
    "/v1/reporting/report_types/{report_type}": {
      "get": {
        "description": "<p>Retrieves the details of a Report Type. (Certain report types require a <a href=\"https://stripe.com/docs/keys#test-live-modes\">live-mode API key</a>.)</p>",
        "operationId": "GetReportingReportTypesReportType",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "report_type",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/reporting.report_type"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Report Type"
      }
    },
    "/v1/reviews": {
      "get": {
        "description": "<p>Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>",
        "operationId": "GetReviews",
        "parameters": [
          {
            "description": "Only return reviews that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/review"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "RadarReviewList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all open reviews"
      }
    },
    "/v1/reviews/{review}": {
      "get": {
        "description": "<p>Retrieves a <code>Review</code> object.</p>",
        "operationId": "GetReviewsReview",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "review",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/review"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a review"
      }
    },
    "/v1/reviews/{review}/approve": {
      "post": {
        "description": "<p>Approves a <code>Review</code> object, closing it and removing it from the list of reviews.</p>",
        "operationId": "PostReviewsReviewApprove",
        "parameters": [
          {
            "in": "path",
            "name": "review",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/review"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Approve a review"
      }
    },
    "/v1/setup_attempts": {
      "get": {
        "description": "<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p>",
        "operationId": "GetSetupAttempts",
        "parameters": [
          {
            "description": "A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return SetupAttempts created by the SetupIntent specified by\nthis ID.",
            "in": "query",
            "name": "setup_intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/setup_attempt"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/setup_attempts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentFlowsSetupIntentSetupAttemptList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all SetupAttempts"
      }
    },
    "/v1/setup_intents": {
      "get": {
        "description": "<p>Returns a list of SetupIntents.</p>",
        "operationId": "GetSetupIntents",
        "parameters": [
          {
            "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.",
            "in": "query",
            "name": "attach_to_self",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return SetupIntents for the customer specified by this customer ID.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return SetupIntents that associate with the specified payment method.",
            "in": "query",
            "name": "payment_method",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/setup_intent"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/setup_intents",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "PaymentFlowsSetupIntentList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all SetupIntents"
      },
      "post": {
        "description": "<p>Creates a SetupIntent object.</p>\n\n<p>After you create the SetupIntent, attach a payment method and <a href=\"/docs/api/setup_intents/confirm\">confirm</a>\nit to collect any required permissions to charge the payment method later.</p>",
        "operationId": "PostSetupIntents",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "automatic_payment_methods": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "flow_directions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                },
                "single_use": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "attach_to_self": {
                    "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.",
                    "type": "boolean"
                  },
                  "automatic_payment_methods": {
                    "description": "When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.",
                    "properties": {
                      "allow_redirects": {
                        "enum": ["always", "never"],
                        "type": "string"
                      },
                      "enabled": {
                        "type": "boolean"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_payment_methods_param",
                    "type": "object"
                  },
                  "confirm": {
                    "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.",
                    "type": "boolean"
                  },
                  "confirmation_token": {
                    "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer": {
                    "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "flow_directions": {
                    "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.",
                    "items": {
                      "enum": ["inbound", "outbound"],
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "mandate_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "accepted_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "offline": {
                                "properties": {},
                                "title": "offline_param",
                                "type": "object"
                              },
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["ip_address", "user_agent"],
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["offline", "online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "secret_key_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm)."
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "on_behalf_of": {
                    "description": "The Stripe account ID created for this SetupIntent.",
                    "type": "string"
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_configuration": {
                    "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment method-specific configuration for this SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "currency": {
                            "enum": ["cad", "usd"],
                            "type": "string"
                          },
                          "mandate_options": {
                            "properties": {
                              "custom_mandate_url": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "default_for": {
                                "items": {
                                  "enum": ["invoice", "subscription"],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "interval_description": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "payment_schedule": {
                                "enum": ["combined", "interval", "sporadic"],
                                "type": "string"
                              },
                              "transaction_type": {
                                "enum": ["business", "personal"],
                                "type": "string"
                              }
                            },
                            "title": "setup_intent_payment_method_options_mandate_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "card": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "amount": {
                                "type": "integer"
                              },
                              "amount_type": {
                                "enum": ["fixed", "maximum"],
                                "type": "string"
                              },
                              "currency": {
                                "format": "currency",
                                "type": "string"
                              },
                              "description": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "end_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "interval": {
                                "enum": [
                                  "day",
                                  "month",
                                  "sporadic",
                                  "week",
                                  "year"
                                ],
                                "type": "string"
                              },
                              "interval_count": {
                                "type": "integer"
                              },
                              "reference": {
                                "maxLength": 80,
                                "type": "string"
                              },
                              "start_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "supported_types": {
                                "items": {
                                  "enum": ["india"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "required": [
                              "amount",
                              "amount_type",
                              "currency",
                              "interval",
                              "reference",
                              "start_date"
                            ],
                            "title": "setup_intent_mandate_options_param",
                            "type": "object"
                          },
                          "network": {
                            "enum": [
                              "amex",
                              "cartes_bancaires",
                              "diners",
                              "discover",
                              "eftpos_au",
                              "girocard",
                              "interac",
                              "jcb",
                              "link",
                              "mastercard",
                              "unionpay",
                              "unknown",
                              "visa"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "request_three_d_secure": {
                            "enum": ["any", "automatic", "challenge"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "three_d_secure": {
                            "properties": {
                              "ares_trans_status": {
                                "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                "type": "string"
                              },
                              "cryptogram": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "electronic_commerce_indicator": {
                                "enum": ["01", "02", "05", "06", "07"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "network_options": {
                                "properties": {
                                  "cartes_bancaires": {
                                    "properties": {
                                      "cb_avalgo": {
                                        "enum": ["0", "1", "2", "3", "4", "A"],
                                        "type": "string"
                                      },
                                      "cb_exemption": {
                                        "maxLength": 4,
                                        "type": "string"
                                      },
                                      "cb_score": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["cb_avalgo"],
                                    "title": "cartes_bancaires_network_options_param",
                                    "type": "object"
                                  }
                                },
                                "title": "network_options_param",
                                "type": "object"
                              },
                              "requestor_challenge_indicator": {
                                "maxLength": 2,
                                "type": "string"
                              },
                              "transaction_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "version": {
                                "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "setup_intent_payment_method_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_param",
                        "type": "object"
                      },
                      "card_present": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {
                          "billing_agreement_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "us_bank_account": {
                        "properties": {
                          "financial_connections": {
                            "properties": {
                              "filters": {
                                "properties": {
                                  "account_subcategories": {
                                    "items": {
                                      "enum": ["checking", "savings"],
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "linked_account_options_filters_param",
                                "type": "object"
                              },
                              "permissions": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "payment_method",
                                    "transactions"
                                  ],
                                  "maxLength": 5000,
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "prefetch": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "transactions"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "return_url": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "linked_account_options_param",
                            "type": "object"
                          },
                          "mandate_options": {
                            "properties": {
                              "collection_method": {
                                "enum": ["", "paper"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "mandate_options_param",
                            "type": "object"
                          },
                          "networks": {
                            "properties": {
                              "requested": {
                                "items": {
                                  "enum": ["ach", "us_domestic_wire"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "title": "networks_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "return_url": {
                    "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).",
                    "type": "string"
                  },
                  "single_use": {
                    "description": "If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      }
                    },
                    "required": ["amount", "currency"],
                    "title": "setup_intent_single_use_params",
                    "type": "object"
                  },
                  "usage": {
                    "description": "Indicates how the payment method is intended to be used in the future. If not provided, this value defaults to `off_session`.",
                    "enum": ["off_session", "on_session"],
                    "type": "string"
                  },
                  "use_stripe_sdk": {
                    "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a SetupIntent"
      }
    },
    "/v1/setup_intents/{intent}": {
      "get": {
        "description": "<p>Retrieves the details of a SetupIntent that has previously been created. </p>\n\n<p>Client-side retrieval using a publishable key is allowed when the <code>client_secret</code> is provided in the query string. </p>\n\n<p>When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the <a href=\"#setup_intent_object\">SetupIntent</a> object reference for more details.</p>",
        "operationId": "GetSetupIntentsIntent",
        "parameters": [
          {
            "description": "The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.",
            "in": "query",
            "name": "client_secret",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a SetupIntent"
      },
      "post": {
        "description": "<p>Updates a SetupIntent object.</p>",
        "operationId": "PostSetupIntentsIntent",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "flow_directions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_types": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "attach_to_self": {
                    "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.",
                    "type": "boolean"
                  },
                  "customer": {
                    "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "flow_directions": {
                    "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.",
                    "items": {
                      "enum": ["inbound", "outbound"],
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_configuration": {
                    "description": "The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment method-specific configuration for this SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "currency": {
                            "enum": ["cad", "usd"],
                            "type": "string"
                          },
                          "mandate_options": {
                            "properties": {
                              "custom_mandate_url": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "default_for": {
                                "items": {
                                  "enum": ["invoice", "subscription"],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "interval_description": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "payment_schedule": {
                                "enum": ["combined", "interval", "sporadic"],
                                "type": "string"
                              },
                              "transaction_type": {
                                "enum": ["business", "personal"],
                                "type": "string"
                              }
                            },
                            "title": "setup_intent_payment_method_options_mandate_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "card": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "amount": {
                                "type": "integer"
                              },
                              "amount_type": {
                                "enum": ["fixed", "maximum"],
                                "type": "string"
                              },
                              "currency": {
                                "format": "currency",
                                "type": "string"
                              },
                              "description": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "end_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "interval": {
                                "enum": [
                                  "day",
                                  "month",
                                  "sporadic",
                                  "week",
                                  "year"
                                ],
                                "type": "string"
                              },
                              "interval_count": {
                                "type": "integer"
                              },
                              "reference": {
                                "maxLength": 80,
                                "type": "string"
                              },
                              "start_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "supported_types": {
                                "items": {
                                  "enum": ["india"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "required": [
                              "amount",
                              "amount_type",
                              "currency",
                              "interval",
                              "reference",
                              "start_date"
                            ],
                            "title": "setup_intent_mandate_options_param",
                            "type": "object"
                          },
                          "network": {
                            "enum": [
                              "amex",
                              "cartes_bancaires",
                              "diners",
                              "discover",
                              "eftpos_au",
                              "girocard",
                              "interac",
                              "jcb",
                              "link",
                              "mastercard",
                              "unionpay",
                              "unknown",
                              "visa"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "request_three_d_secure": {
                            "enum": ["any", "automatic", "challenge"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "three_d_secure": {
                            "properties": {
                              "ares_trans_status": {
                                "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                "type": "string"
                              },
                              "cryptogram": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "electronic_commerce_indicator": {
                                "enum": ["01", "02", "05", "06", "07"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "network_options": {
                                "properties": {
                                  "cartes_bancaires": {
                                    "properties": {
                                      "cb_avalgo": {
                                        "enum": ["0", "1", "2", "3", "4", "A"],
                                        "type": "string"
                                      },
                                      "cb_exemption": {
                                        "maxLength": 4,
                                        "type": "string"
                                      },
                                      "cb_score": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["cb_avalgo"],
                                    "title": "cartes_bancaires_network_options_param",
                                    "type": "object"
                                  }
                                },
                                "title": "network_options_param",
                                "type": "object"
                              },
                              "requestor_challenge_indicator": {
                                "maxLength": 2,
                                "type": "string"
                              },
                              "transaction_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "version": {
                                "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "setup_intent_payment_method_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_param",
                        "type": "object"
                      },
                      "card_present": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {
                          "billing_agreement_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "us_bank_account": {
                        "properties": {
                          "financial_connections": {
                            "properties": {
                              "filters": {
                                "properties": {
                                  "account_subcategories": {
                                    "items": {
                                      "enum": ["checking", "savings"],
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "linked_account_options_filters_param",
                                "type": "object"
                              },
                              "permissions": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "payment_method",
                                    "transactions"
                                  ],
                                  "maxLength": 5000,
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "prefetch": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "transactions"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "return_url": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "linked_account_options_param",
                            "type": "object"
                          },
                          "mandate_options": {
                            "properties": {
                              "collection_method": {
                                "enum": ["", "paper"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "mandate_options_param",
                            "type": "object"
                          },
                          "networks": {
                            "properties": {
                              "requested": {
                                "items": {
                                  "enum": ["ach", "us_domestic_wire"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "title": "networks_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "payment_method_types": {
                    "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a SetupIntent"
      }
    },
    "/v1/setup_intents/{intent}/cancel": {
      "post": {
        "description": "<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>\n\n<p>After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. <a href=\"/docs/api/checkout/sessions/expire\">Expire the Checkout Session</a> instead.</p>",
        "operationId": "PostSetupIntentsIntentCancel",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cancellation_reason": {
                    "description": "Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`",
                    "enum": ["abandoned", "duplicate", "requested_by_customer"],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a SetupIntent"
      }
    },
    "/v1/setup_intents/{intent}/confirm": {
      "post": {
        "description": "<p>Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.</p>\n\n<p>If the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\n<code>succeeded</code> status.</p>\n\n<p>Otherwise, it will transition to the <code>requires_action</code> status and\nsuggest additional actions via <code>next_action</code>. If setup fails,\nthe SetupIntent will transition to the\n<code>requires_payment_method</code> status or the <code>canceled</code> status if the\nconfirmation limit is reached.</p>",
        "operationId": "PostSetupIntentsIntentConfirm",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "client_secret": {
                    "description": "The client secret of the SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "confirmation_token": {
                    "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "mandate_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "accepted_at": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "offline": {
                                "properties": {},
                                "title": "offline_param",
                                "type": "object"
                              },
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "required": ["ip_address", "user_agent"],
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["offline", "online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "secret_key_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      },
                      {
                        "description": "This hash contains details about the Mandate to create",
                        "properties": {
                          "customer_acceptance": {
                            "properties": {
                              "online": {
                                "properties": {
                                  "ip_address": {
                                    "type": "string"
                                  },
                                  "user_agent": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "online_param",
                                "type": "object"
                              },
                              "type": {
                                "enum": ["online"],
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["online", "type"],
                            "title": "customer_acceptance_param",
                            "type": "object"
                          }
                        },
                        "required": ["customer_acceptance"],
                        "title": "client_key_param",
                        "type": "object"
                      }
                    ]
                  },
                  "payment_method": {
                    "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "payment_method_options": {
                    "description": "Payment method-specific configuration for this SetupIntent.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "currency": {
                            "enum": ["cad", "usd"],
                            "type": "string"
                          },
                          "mandate_options": {
                            "properties": {
                              "custom_mandate_url": {
                                "anyOf": [
                                  {
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "default_for": {
                                "items": {
                                  "enum": ["invoice", "subscription"],
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              "interval_description": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "payment_schedule": {
                                "enum": ["combined", "interval", "sporadic"],
                                "type": "string"
                              },
                              "transaction_type": {
                                "enum": ["business", "personal"],
                                "type": "string"
                              }
                            },
                            "title": "setup_intent_payment_method_options_mandate_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "card": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "amount": {
                                "type": "integer"
                              },
                              "amount_type": {
                                "enum": ["fixed", "maximum"],
                                "type": "string"
                              },
                              "currency": {
                                "format": "currency",
                                "type": "string"
                              },
                              "description": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "end_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "interval": {
                                "enum": [
                                  "day",
                                  "month",
                                  "sporadic",
                                  "week",
                                  "year"
                                ],
                                "type": "string"
                              },
                              "interval_count": {
                                "type": "integer"
                              },
                              "reference": {
                                "maxLength": 80,
                                "type": "string"
                              },
                              "start_date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "supported_types": {
                                "items": {
                                  "enum": ["india"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "required": [
                              "amount",
                              "amount_type",
                              "currency",
                              "interval",
                              "reference",
                              "start_date"
                            ],
                            "title": "setup_intent_mandate_options_param",
                            "type": "object"
                          },
                          "network": {
                            "enum": [
                              "amex",
                              "cartes_bancaires",
                              "diners",
                              "discover",
                              "eftpos_au",
                              "girocard",
                              "interac",
                              "jcb",
                              "link",
                              "mastercard",
                              "unionpay",
                              "unknown",
                              "visa"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "request_three_d_secure": {
                            "enum": ["any", "automatic", "challenge"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "three_d_secure": {
                            "properties": {
                              "ares_trans_status": {
                                "enum": ["A", "C", "I", "N", "R", "U", "Y"],
                                "type": "string"
                              },
                              "cryptogram": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "electronic_commerce_indicator": {
                                "enum": ["01", "02", "05", "06", "07"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              },
                              "network_options": {
                                "properties": {
                                  "cartes_bancaires": {
                                    "properties": {
                                      "cb_avalgo": {
                                        "enum": ["0", "1", "2", "3", "4", "A"],
                                        "type": "string"
                                      },
                                      "cb_exemption": {
                                        "maxLength": 4,
                                        "type": "string"
                                      },
                                      "cb_score": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["cb_avalgo"],
                                    "title": "cartes_bancaires_network_options_param",
                                    "type": "object"
                                  }
                                },
                                "title": "network_options_param",
                                "type": "object"
                              },
                              "requestor_challenge_indicator": {
                                "maxLength": 2,
                                "type": "string"
                              },
                              "transaction_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "version": {
                                "enum": ["1.0.2", "2.1.0", "2.2.0"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "setup_intent_payment_method_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_param",
                        "type": "object"
                      },
                      "card_present": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {
                          "billing_agreement_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_options_param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "mandate_options": {
                            "properties": {
                              "reference_prefix": {
                                "anyOf": [
                                  {
                                    "maxLength": 12,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "payment_method_options_mandate_options_param",
                            "type": "object"
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      },
                      "us_bank_account": {
                        "properties": {
                          "financial_connections": {
                            "properties": {
                              "filters": {
                                "properties": {
                                  "account_subcategories": {
                                    "items": {
                                      "enum": ["checking", "savings"],
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  }
                                },
                                "title": "linked_account_options_filters_param",
                                "type": "object"
                              },
                              "permissions": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "payment_method",
                                    "transactions"
                                  ],
                                  "maxLength": 5000,
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "prefetch": {
                                "items": {
                                  "enum": [
                                    "balances",
                                    "ownership",
                                    "transactions"
                                  ],
                                  "type": "string",
                                  "x-stripeBypassValidation": true
                                },
                                "type": "array"
                              },
                              "return_url": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "linked_account_options_param",
                            "type": "object"
                          },
                          "mandate_options": {
                            "properties": {
                              "collection_method": {
                                "enum": ["", "paper"],
                                "type": "string",
                                "x-stripeBypassValidation": true
                              }
                            },
                            "title": "mandate_options_param",
                            "type": "object"
                          },
                          "networks": {
                            "properties": {
                              "requested": {
                                "items": {
                                  "enum": ["ach", "us_domestic_wire"],
                                  "type": "string"
                                },
                                "type": "array"
                              }
                            },
                            "title": "networks_options_param",
                            "type": "object"
                          },
                          "verification_method": {
                            "enum": ["automatic", "instant", "microdeposits"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "setup_intent_payment_method_options_param",
                        "type": "object"
                      }
                    },
                    "title": "payment_method_options_param",
                    "type": "object"
                  },
                  "return_url": {
                    "description": "The URL to redirect your customer back to after they authenticate on the payment method's app or site.\nIf you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.\nThis parameter is only used for cards and other redirect-based payment methods.",
                    "type": "string"
                  },
                  "use_stripe_sdk": {
                    "description": "Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Confirm a SetupIntent"
      }
    },
    "/v1/setup_intents/{intent}/verify_microdeposits": {
      "post": {
        "description": "<p>Verifies microdeposits on a SetupIntent object.</p>",
        "operationId": "PostSetupIntentsIntentVerifyMicrodeposits",
        "parameters": [
          {
            "in": "path",
            "name": "intent",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amounts": {
                    "description": "Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.",
                    "items": {
                      "type": "integer"
                    },
                    "type": "array"
                  },
                  "client_secret": {
                    "description": "The client secret of the SetupIntent.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "descriptor_code": {
                    "description": "A six-character code starting with SM present in the microdeposit sent to the bank account.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/setup_intent"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Verify microdeposits on a SetupIntent"
      }
    },
    "/v1/shipping_rates": {
      "get": {
        "description": "<p>Returns a list of your shipping rates.</p>",
        "operationId": "GetShippingRates",
        "parameters": [
          {
            "description": "Only return shipping rates that are active or inactive.",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return shipping rates for the given currency.",
            "in": "query",
            "name": "currency",
            "required": false,
            "schema": {
              "format": "currency",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/shipping_rate"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/shipping_rates",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ShippingResourcesShippingRateList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all shipping rates"
      },
      "post": {
        "description": "<p>Creates a new shipping rate object.</p>",
        "operationId": "PostShippingRates",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "delivery_estimate": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fixed_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "delivery_estimate": {
                    "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.",
                    "properties": {
                      "maximum": {
                        "properties": {
                          "unit": {
                            "enum": [
                              "business_day",
                              "day",
                              "hour",
                              "month",
                              "week"
                            ],
                            "type": "string"
                          },
                          "value": {
                            "type": "integer"
                          }
                        },
                        "required": ["unit", "value"],
                        "title": "delivery_estimate_bound",
                        "type": "object"
                      },
                      "minimum": {
                        "properties": {
                          "unit": {
                            "enum": [
                              "business_day",
                              "day",
                              "hour",
                              "month",
                              "week"
                            ],
                            "type": "string"
                          },
                          "value": {
                            "type": "integer"
                          }
                        },
                        "required": ["unit", "value"],
                        "title": "delivery_estimate_bound",
                        "type": "object"
                      }
                    },
                    "title": "delivery_estimate",
                    "type": "object"
                  },
                  "display_name": {
                    "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fixed_amount": {
                    "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "currency_options": {
                        "additionalProperties": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            }
                          },
                          "required": ["amount"],
                          "title": "currency_option",
                          "type": "object"
                        },
                        "type": "object"
                      }
                    },
                    "required": ["amount", "currency"],
                    "title": "fixed_amount",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "tax_behavior": {
                    "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  },
                  "tax_code": {
                    "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
                    "type": "string"
                  },
                  "type": {
                    "description": "The type of calculation to use on the shipping rate.",
                    "enum": ["fixed_amount"],
                    "type": "string"
                  }
                },
                "required": ["display_name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a shipping rate"
      }
    },
    "/v1/shipping_rates/{shipping_rate_token}": {
      "get": {
        "description": "<p>Returns the shipping rate object with the given ID.</p>",
        "operationId": "GetShippingRatesShippingRateToken",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "shipping_rate_token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a shipping rate"
      },
      "post": {
        "description": "<p>Updates an existing shipping rate object.</p>",
        "operationId": "PostShippingRatesShippingRateToken",
        "parameters": [
          {
            "in": "path",
            "name": "shipping_rate_token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fixed_amount": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fixed_amount": {
                    "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
                    "properties": {
                      "currency_options": {
                        "additionalProperties": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            }
                          },
                          "title": "currency_option_update",
                          "type": "object"
                        },
                        "type": "object"
                      }
                    },
                    "title": "fixed_amount_update",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "tax_behavior": {
                    "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
                    "enum": ["exclusive", "inclusive", "unspecified"],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/shipping_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a shipping rate"
      }
    },
    "/v1/sigma/scheduled_query_runs": {
      "get": {
        "description": "<p>Returns a list of scheduled query runs.</p>",
        "operationId": "GetSigmaScheduledQueryRuns",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/scheduled_query_run"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/sigma/scheduled_query_runs",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SigmaScheduledQueryRunList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all scheduled query runs"
      }
    },
    "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": {
      "get": {
        "description": "<p>Retrieves the details of an scheduled query run.</p>",
        "operationId": "GetSigmaScheduledQueryRunsScheduledQueryRun",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "scheduled_query_run",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/scheduled_query_run"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a scheduled query run"
      }
    },
    "/v1/sources": {
      "post": {
        "description": "<p>Creates a new source object.</p>",
        "operationId": "PostSources",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                },
                "receiver": {
                  "explode": true,
                  "style": "deepObject"
                },
                "redirect": {
                  "explode": true,
                  "style": "deepObject"
                },
                "source_order": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`).",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "flow": {
                    "description": "The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.",
                    "enum": [
                      "code_verification",
                      "none",
                      "receiver",
                      "redirect"
                    ],
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "mandate": {
                    "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.",
                    "properties": {
                      "acceptance": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "offline": {
                            "properties": {
                              "contact_email": {
                                "type": "string"
                              }
                            },
                            "required": ["contact_email"],
                            "title": "mandate_offline_acceptance_params",
                            "type": "object"
                          },
                          "online": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "mandate_online_acceptance_params",
                            "type": "object"
                          },
                          "status": {
                            "enum": [
                              "accepted",
                              "pending",
                              "refused",
                              "revoked"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "type": {
                            "enum": ["offline", "online"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["status"],
                        "title": "mandate_acceptance_params",
                        "type": "object"
                      },
                      "amount": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "interval": {
                        "enum": ["one_time", "scheduled", "variable"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "notification_method": {
                        "enum": [
                          "deprecated_none",
                          "email",
                          "manual",
                          "none",
                          "stripe_email"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "mandate_params",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "type": "object"
                  },
                  "original_source": {
                    "description": "The source to share.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "owner": {
                    "description": "Information about the owner of the payment instrument that may be used or required by particular source types.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "source_address",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "owner",
                    "type": "object"
                  },
                  "receiver": {
                    "description": "Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).",
                    "properties": {
                      "refund_attributes_method": {
                        "enum": ["email", "manual", "none"],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "receiver_params",
                    "type": "object"
                  },
                  "redirect": {
                    "description": "Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).",
                    "properties": {
                      "return_url": {
                        "type": "string"
                      }
                    },
                    "required": ["return_url"],
                    "title": "redirect_params",
                    "type": "object"
                  },
                  "source_order": {
                    "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
                    "properties": {
                      "items": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "description": {
                              "maxLength": 1000,
                              "type": "string"
                            },
                            "parent": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "type": {
                              "enum": ["discount", "shipping", "sku", "tax"],
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "order_item_specs",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "shipping": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["line1"],
                            "title": "address",
                            "type": "object"
                          },
                          "carrier": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tracking_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address"],
                        "title": "order_shipping",
                        "type": "object"
                      }
                    },
                    "title": "shallow_order_specs",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "token": {
                    "description": "An optional token used to create the source. When passed, token properties will override source parameters.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "type": {
                    "description": "The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide)",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "usage": {
                    "enum": ["reusable", "single_use"],
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Shares a source"
      }
    },
    "/v1/sources/{source}": {
      "get": {
        "description": "<p>Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.</p>",
        "operationId": "GetSourcesSource",
        "parameters": [
          {
            "description": "The client secret of the source. Required if a publishable key is used to retrieve the source.",
            "in": "query",
            "name": "client_secret",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a source"
      },
      "post": {
        "description": "<p>Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>\n\n<p>This request accepts the <code>metadata</code> and <code>owner</code> as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our <a href=\"/docs/sources\">payment method guides</a> for more detail.</p>",
        "operationId": "PostSourcesSource",
        "parameters": [
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "mandate": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                },
                "source_order": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount associated with the source.",
                    "type": "integer"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "mandate": {
                    "description": "Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.",
                    "properties": {
                      "acceptance": {
                        "properties": {
                          "date": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "ip": {
                            "type": "string"
                          },
                          "offline": {
                            "properties": {
                              "contact_email": {
                                "type": "string"
                              }
                            },
                            "required": ["contact_email"],
                            "title": "mandate_offline_acceptance_params",
                            "type": "object"
                          },
                          "online": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "mandate_online_acceptance_params",
                            "type": "object"
                          },
                          "status": {
                            "enum": [
                              "accepted",
                              "pending",
                              "refused",
                              "revoked"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "type": {
                            "enum": ["offline", "online"],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "user_agent": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["status"],
                        "title": "mandate_acceptance_params",
                        "type": "object"
                      },
                      "amount": {
                        "anyOf": [
                          {
                            "type": "integer"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "interval": {
                        "enum": ["one_time", "scheduled", "variable"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "notification_method": {
                        "enum": [
                          "deprecated_none",
                          "email",
                          "manual",
                          "none",
                          "stripe_email"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "mandate_params",
                    "type": "object"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "owner": {
                    "description": "Information about the owner of the payment instrument that may be used or required by particular source types.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "source_address",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "owner",
                    "type": "object"
                  },
                  "source_order": {
                    "description": "Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.",
                    "properties": {
                      "items": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "description": {
                              "maxLength": 1000,
                              "type": "string"
                            },
                            "parent": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "quantity": {
                              "type": "integer"
                            },
                            "type": {
                              "enum": ["discount", "shipping", "sku", "tax"],
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "order_item_specs",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "shipping": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["line1"],
                            "title": "address",
                            "type": "object"
                          },
                          "carrier": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tracking_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["address"],
                        "title": "order_shipping",
                        "type": "object"
                      }
                    },
                    "title": "order_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a source"
      }
    },
    "/v1/sources/{source}/mandate_notifications/{mandate_notification}": {
      "get": {
        "description": "<p>Retrieves a new Source MandateNotification.</p>",
        "operationId": "GetSourcesSourceMandateNotificationsMandateNotification",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "mandate_notification",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source_mandate_notification"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Source MandateNotification"
      }
    },
    "/v1/sources/{source}/source_transactions": {
      "get": {
        "description": "<p>List source transactions for a given source.</p>",
        "operationId": "GetSourcesSourceSourceTransactions",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/source_transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "ApmsSourcesSourceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/sources/{source}/source_transactions/{source_transaction}": {
      "get": {
        "description": "<p>Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.</p>",
        "operationId": "GetSourcesSourceSourceTransactionsSourceTransaction",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "source_transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a source transaction"
      }
    },
    "/v1/sources/{source}/verify": {
      "post": {
        "description": "<p>Verify a given source.</p>",
        "operationId": "PostSourcesSourceVerify",
        "parameters": [
          {
            "in": "path",
            "name": "source",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "values": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "values": {
                    "description": "The values needed to verify the source.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["values"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/source"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        }
      }
    },
    "/v1/subscription_items": {
      "get": {
        "description": "<p>Returns a list of your subscription items for a given subscription.</p>",
        "operationId": "GetSubscriptionItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The ID of the subscription whose items will be retrieved.",
            "in": "query",
            "name": "subscription",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/subscription_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/subscription_items",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SubscriptionsItemsSubscriptionItemList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all subscription items"
      },
      "post": {
        "description": "<p>Adds a new item to an existing subscription. No existing items will be changed or replaced.</p>",
        "operationId": "PostSubscriptionItems",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "usage_gte": {
                            "type": "integer"
                          }
                        },
                        "required": ["usage_gte"],
                        "title": "item_billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription item."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "payment_behavior": {
                    "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "price": {
                    "description": "The ID of the price object.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "recurring": {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "recurring_adhoc",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product", "recurring"],
                    "title": "recurring_price_data",
                    "type": "object"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "quantity": {
                    "description": "The quantity you'd like to apply to the subscription item you're creating.",
                    "type": "integer"
                  },
                  "subscription": {
                    "description": "The identifier of the subscription to modify.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates."
                  }
                },
                "required": ["subscription"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a subscription item"
      }
    },
    "/v1/subscription_items/{item}": {
      "delete": {
        "description": "<p>Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.</p>",
        "operationId": "DeleteSubscriptionItemsItem",
        "parameters": [
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "clear_usage": {
                    "description": "Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.",
                    "type": "boolean"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_subscription_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a subscription item"
      },
      "get": {
        "description": "<p>Retrieves the subscription item with the given ID.</p>",
        "operationId": "GetSubscriptionItemsItem",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a subscription item"
      },
      "post": {
        "description": "<p>Updates the plan or quantity of an item on a current subscription.</p>",
        "operationId": "PostSubscriptionItemsItem",
        "parameters": [
          {
            "in": "path",
            "name": "item",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "price_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "usage_gte": {
                            "type": "integer"
                          }
                        },
                        "required": ["usage_gte"],
                        "title": "item_billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription item."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).",
                    "type": "boolean"
                  },
                  "payment_behavior": {
                    "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "price": {
                    "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "price_data": {
                    "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "product": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "recurring": {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "recurring_adhoc",
                        "type": "object"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive", "unspecified"],
                        "type": "string"
                      },
                      "unit_amount": {
                        "type": "integer"
                      },
                      "unit_amount_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "required": ["currency", "product", "recurring"],
                    "title": "recurring_price_data",
                    "type": "object"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "quantity": {
                    "description": "The quantity you'd like to apply to the subscription item you're creating.",
                    "type": "integer"
                  },
                  "tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_item"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a subscription item"
      }
    },
    "/v1/subscription_items/{subscription_item}/usage_record_summaries": {
      "get": {
        "description": "<p>For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).</p>\n\n<p>The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.</p>",
        "operationId": "GetSubscriptionItemsSubscriptionItemUsageRecordSummaries",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "subscription_item",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/usage_record_summary"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "UsageEventsResourceUsageRecordSummaryList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all subscription item period summaries"
      }
    },
    "/v1/subscription_items/{subscription_item}/usage_records": {
      "post": {
        "description": "<p>Creates a usage record for a specified subscription item and date, and fills it with a quantity.</p>\n\n<p>Usage records provide <code>quantity</code> information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the <a href=\"https://stripe.com/docs/billing/subscriptions/metered-billing\">metered billing</a> plan, Stripe helps you send accurate invoices to your customers.</p>\n\n<p>The default calculation for usage is to add up all the <code>quantity</code> values of the usage records within a billing period. You can change this default behavior with the billing plan’s <code>aggregate_usage</code> <a href=\"/docs/api/plans/create#create_plan-aggregate_usage\">parameter</a>. When there is more than one usage record with the same timestamp, Stripe adds the <code>quantity</code> values together. In most cases, this is the desired resolution, however, you can change this behavior with the <code>action</code> parameter.</p>\n\n<p>The default pricing model for metered billing is <a href=\"/docs/api/plans/object#plan_object-billing_scheme\">per-unit pricing</a>. For finer granularity, you can configure metered billing to have a <a href=\"https://stripe.com/docs/billing/subscriptions/tiers\">tiered pricing</a> model.</p>",
        "operationId": "PostSubscriptionItemsSubscriptionItemUsageRecords",
        "parameters": [
          {
            "in": "path",
            "name": "subscription_item",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "timestamp": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "action": {
                    "description": "Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.",
                    "enum": ["increment", "set"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "quantity": {
                    "description": "The usage quantity for the specified timestamp.",
                    "type": "integer"
                  },
                  "timestamp": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `\"now\"`, Stripe records usage for the current time. Default is `\"now\"` if a value is not provided."
                  }
                },
                "required": ["quantity"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/usage_record"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a usage record"
      }
    },
    "/v1/subscription_schedules": {
      "get": {
        "description": "<p>Retrieves the list of your subscription schedules.</p>",
        "operationId": "GetSubscriptionSchedules",
        "parameters": [
          {
            "description": "Only return subscription schedules that were created canceled the given date interval.",
            "explode": true,
            "in": "query",
            "name": "canceled_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscription schedules that completed during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "completed_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscription schedules that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscription schedules for the given customer.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return subscription schedules that were released during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "released_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscription schedules that have not started yet.",
            "in": "query",
            "name": "scheduled",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/subscription_schedule"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/subscription_schedules",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SubscriptionSchedulesResourceScheduleList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all schedules"
      },
      "post": {
        "description": "<p>Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.</p>",
        "operationId": "PostSubscriptionSchedules",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "default_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "phases": {
                  "explode": true,
                  "style": "deepObject"
                },
                "start_date": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "customer": {
                    "description": "The identifier of the customer to create the subscription schedule for.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_settings": {
                    "description": "Object representing the subscription schedule's default settings.",
                    "properties": {
                      "application_fee_percent": {
                        "type": "number"
                      },
                      "automatic_tax": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "liability": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "automatic_tax_config",
                        "type": "object"
                      },
                      "billing_cycle_anchor": {
                        "enum": ["automatic", "phase_start"],
                        "type": "string"
                      },
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_gte": {
                                "type": "integer"
                              },
                              "reset_billing_cycle_anchor": {
                                "type": "boolean"
                              }
                            },
                            "title": "billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "collection_method": {
                        "enum": ["charge_automatically", "send_invoice"],
                        "type": "string"
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 500,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "invoice_settings": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "days_until_due": {
                            "type": "integer"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "subscription_schedule_default_settings_param",
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "transfer_data": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_percent": {
                                "type": "number"
                              },
                              "destination": {
                                "type": "string"
                              }
                            },
                            "required": ["destination"],
                            "title": "transfer_data_specs",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "default_settings_params",
                    "type": "object"
                  },
                  "end_behavior": {
                    "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
                    "enum": ["cancel", "none", "release", "renew"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "from_subscription": {
                    "description": "Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "phases": {
                    "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.",
                    "items": {
                      "properties": {
                        "add_invoice_items": {
                          "items": {
                            "properties": {
                              "discounts": {
                                "items": {
                                  "properties": {
                                    "coupon": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "discount": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "promotion_code": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    }
                                  },
                                  "title": "discounts_data_param",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "price": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "price_data": {
                                "properties": {
                                  "currency": {
                                    "format": "currency",
                                    "type": "string"
                                  },
                                  "product": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "tax_behavior": {
                                    "enum": [
                                      "exclusive",
                                      "inclusive",
                                      "unspecified"
                                    ],
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "required": ["currency", "product"],
                                "title": "one_time_price_data_with_negative_amounts",
                                "type": "object"
                              },
                              "quantity": {
                                "type": "integer"
                              },
                              "tax_rates": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "add_invoice_item_entry",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "application_fee_percent": {
                          "type": "number"
                        },
                        "automatic_tax": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "liability": {
                              "properties": {
                                "account": {
                                  "type": "string"
                                },
                                "type": {
                                  "enum": ["account", "self"],
                                  "type": "string"
                                }
                              },
                              "required": ["type"],
                              "title": "param",
                              "type": "object"
                            }
                          },
                          "required": ["enabled"],
                          "title": "automatic_tax_config",
                          "type": "object"
                        },
                        "billing_cycle_anchor": {
                          "enum": ["automatic", "phase_start"],
                          "type": "string"
                        },
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "amount_gte": {
                                  "type": "integer"
                                },
                                "reset_billing_cycle_anchor": {
                                  "type": "boolean"
                                }
                              },
                              "title": "billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "collection_method": {
                          "enum": ["charge_automatically", "send_invoice"],
                          "type": "string"
                        },
                        "coupon": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "currency": {
                          "format": "currency",
                          "type": "string"
                        },
                        "default_payment_method": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "default_tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "description": {
                          "anyOf": [
                            {
                              "maxLength": 500,
                              "type": "string"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "end_date": {
                          "format": "unix-time",
                          "type": "integer"
                        },
                        "invoice_settings": {
                          "properties": {
                            "account_tax_ids": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "days_until_due": {
                              "type": "integer"
                            },
                            "issuer": {
                              "properties": {
                                "account": {
                                  "type": "string"
                                },
                                "type": {
                                  "enum": ["account", "self"],
                                  "type": "string"
                                }
                              },
                              "required": ["type"],
                              "title": "param",
                              "type": "object"
                            }
                          },
                          "title": "invoice_settings",
                          "type": "object"
                        },
                        "items": {
                          "items": {
                            "properties": {
                              "billing_thresholds": {
                                "anyOf": [
                                  {
                                    "properties": {
                                      "usage_gte": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["usage_gte"],
                                    "title": "item_billing_thresholds_param",
                                    "type": "object"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "discounts": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "properties": {
                                        "coupon": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "discount": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "promotion_code": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        }
                                      },
                                      "title": "discounts_data_param",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "metadata": {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              "price": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "price_data": {
                                "properties": {
                                  "currency": {
                                    "format": "currency",
                                    "type": "string"
                                  },
                                  "product": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "recurring": {
                                    "properties": {
                                      "interval": {
                                        "enum": [
                                          "day",
                                          "month",
                                          "week",
                                          "year"
                                        ],
                                        "type": "string"
                                      },
                                      "interval_count": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["interval"],
                                    "title": "recurring_adhoc",
                                    "type": "object"
                                  },
                                  "tax_behavior": {
                                    "enum": [
                                      "exclusive",
                                      "inclusive",
                                      "unspecified"
                                    ],
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "currency",
                                  "product",
                                  "recurring"
                                ],
                                "title": "recurring_price_data",
                                "type": "object"
                              },
                              "quantity": {
                                "type": "integer"
                              },
                              "tax_rates": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "configuration_item_params",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "iterations": {
                          "type": "integer"
                        },
                        "metadata": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "type": "object"
                        },
                        "on_behalf_of": {
                          "type": "string"
                        },
                        "proration_behavior": {
                          "enum": [
                            "always_invoice",
                            "create_prorations",
                            "none"
                          ],
                          "type": "string"
                        },
                        "transfer_data": {
                          "properties": {
                            "amount_percent": {
                              "type": "number"
                            },
                            "destination": {
                              "type": "string"
                            }
                          },
                          "required": ["destination"],
                          "title": "transfer_data_specs",
                          "type": "object"
                        },
                        "trial": {
                          "type": "boolean"
                        },
                        "trial_end": {
                          "format": "unix-time",
                          "type": "integer"
                        }
                      },
                      "required": ["items"],
                      "title": "phase_configuration_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "start_date": {
                    "anyOf": [
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a schedule"
      }
    },
    "/v1/subscription_schedules/{schedule}": {
      "get": {
        "description": "<p>Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.</p>",
        "operationId": "GetSubscriptionSchedulesSchedule",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "schedule",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a schedule"
      },
      "post": {
        "description": "<p>Updates an existing subscription schedule.</p>",
        "operationId": "PostSubscriptionSchedulesSchedule",
        "parameters": [
          {
            "in": "path",
            "name": "schedule",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "default_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "phases": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "default_settings": {
                    "description": "Object representing the subscription schedule's default settings.",
                    "properties": {
                      "application_fee_percent": {
                        "type": "number"
                      },
                      "automatic_tax": {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "liability": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "required": ["enabled"],
                        "title": "automatic_tax_config",
                        "type": "object"
                      },
                      "billing_cycle_anchor": {
                        "enum": ["automatic", "phase_start"],
                        "type": "string"
                      },
                      "billing_thresholds": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_gte": {
                                "type": "integer"
                              },
                              "reset_billing_cycle_anchor": {
                                "type": "boolean"
                              }
                            },
                            "title": "billing_thresholds_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "collection_method": {
                        "enum": ["charge_automatically", "send_invoice"],
                        "type": "string"
                      },
                      "default_payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "description": {
                        "anyOf": [
                          {
                            "maxLength": 500,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "invoice_settings": {
                        "properties": {
                          "account_tax_ids": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "days_until_due": {
                            "type": "integer"
                          },
                          "issuer": {
                            "properties": {
                              "account": {
                                "type": "string"
                              },
                              "type": {
                                "enum": ["account", "self"],
                                "type": "string"
                              }
                            },
                            "required": ["type"],
                            "title": "param",
                            "type": "object"
                          }
                        },
                        "title": "subscription_schedule_default_settings_param",
                        "type": "object"
                      },
                      "on_behalf_of": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "transfer_data": {
                        "anyOf": [
                          {
                            "properties": {
                              "amount_percent": {
                                "type": "number"
                              },
                              "destination": {
                                "type": "string"
                              }
                            },
                            "required": ["destination"],
                            "title": "transfer_data_specs",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "default_settings_params",
                    "type": "object"
                  },
                  "end_behavior": {
                    "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.",
                    "enum": ["cancel", "none", "release", "renew"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "phases": {
                    "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted.",
                    "items": {
                      "properties": {
                        "add_invoice_items": {
                          "items": {
                            "properties": {
                              "discounts": {
                                "items": {
                                  "properties": {
                                    "coupon": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "discount": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "promotion_code": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    }
                                  },
                                  "title": "discounts_data_param",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "price": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "price_data": {
                                "properties": {
                                  "currency": {
                                    "format": "currency",
                                    "type": "string"
                                  },
                                  "product": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "tax_behavior": {
                                    "enum": [
                                      "exclusive",
                                      "inclusive",
                                      "unspecified"
                                    ],
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "required": ["currency", "product"],
                                "title": "one_time_price_data_with_negative_amounts",
                                "type": "object"
                              },
                              "quantity": {
                                "type": "integer"
                              },
                              "tax_rates": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "add_invoice_item_entry",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "application_fee_percent": {
                          "type": "number"
                        },
                        "automatic_tax": {
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "liability": {
                              "properties": {
                                "account": {
                                  "type": "string"
                                },
                                "type": {
                                  "enum": ["account", "self"],
                                  "type": "string"
                                }
                              },
                              "required": ["type"],
                              "title": "param",
                              "type": "object"
                            }
                          },
                          "required": ["enabled"],
                          "title": "automatic_tax_config",
                          "type": "object"
                        },
                        "billing_cycle_anchor": {
                          "enum": ["automatic", "phase_start"],
                          "type": "string"
                        },
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "amount_gte": {
                                  "type": "integer"
                                },
                                "reset_billing_cycle_anchor": {
                                  "type": "boolean"
                                }
                              },
                              "title": "billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "collection_method": {
                          "enum": ["charge_automatically", "send_invoice"],
                          "type": "string"
                        },
                        "coupon": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "default_payment_method": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "default_tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "description": {
                          "anyOf": [
                            {
                              "maxLength": 500,
                              "type": "string"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "end_date": {
                          "anyOf": [
                            {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            {
                              "enum": ["now"],
                              "maxLength": 5000,
                              "type": "string"
                            }
                          ]
                        },
                        "invoice_settings": {
                          "properties": {
                            "account_tax_ids": {
                              "anyOf": [
                                {
                                  "items": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "type": "array"
                                },
                                {
                                  "enum": [""],
                                  "type": "string"
                                }
                              ]
                            },
                            "days_until_due": {
                              "type": "integer"
                            },
                            "issuer": {
                              "properties": {
                                "account": {
                                  "type": "string"
                                },
                                "type": {
                                  "enum": ["account", "self"],
                                  "type": "string"
                                }
                              },
                              "required": ["type"],
                              "title": "param",
                              "type": "object"
                            }
                          },
                          "title": "invoice_settings",
                          "type": "object"
                        },
                        "items": {
                          "items": {
                            "properties": {
                              "billing_thresholds": {
                                "anyOf": [
                                  {
                                    "properties": {
                                      "usage_gte": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["usage_gte"],
                                    "title": "item_billing_thresholds_param",
                                    "type": "object"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "discounts": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "properties": {
                                        "coupon": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "discount": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        },
                                        "promotion_code": {
                                          "maxLength": 5000,
                                          "type": "string"
                                        }
                                      },
                                      "title": "discounts_data_param",
                                      "type": "object"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "metadata": {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              "price": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "price_data": {
                                "properties": {
                                  "currency": {
                                    "format": "currency",
                                    "type": "string"
                                  },
                                  "product": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "recurring": {
                                    "properties": {
                                      "interval": {
                                        "enum": [
                                          "day",
                                          "month",
                                          "week",
                                          "year"
                                        ],
                                        "type": "string"
                                      },
                                      "interval_count": {
                                        "type": "integer"
                                      }
                                    },
                                    "required": ["interval"],
                                    "title": "recurring_adhoc",
                                    "type": "object"
                                  },
                                  "tax_behavior": {
                                    "enum": [
                                      "exclusive",
                                      "inclusive",
                                      "unspecified"
                                    ],
                                    "type": "string"
                                  },
                                  "unit_amount": {
                                    "type": "integer"
                                  },
                                  "unit_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "currency",
                                  "product",
                                  "recurring"
                                ],
                                "title": "recurring_price_data",
                                "type": "object"
                              },
                              "quantity": {
                                "type": "integer"
                              },
                              "tax_rates": {
                                "anyOf": [
                                  {
                                    "items": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": "array"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "configuration_item_params",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "iterations": {
                          "type": "integer"
                        },
                        "metadata": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "type": "object"
                        },
                        "on_behalf_of": {
                          "type": "string"
                        },
                        "proration_behavior": {
                          "enum": [
                            "always_invoice",
                            "create_prorations",
                            "none"
                          ],
                          "type": "string"
                        },
                        "start_date": {
                          "anyOf": [
                            {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            {
                              "enum": ["now"],
                              "maxLength": 5000,
                              "type": "string"
                            }
                          ]
                        },
                        "transfer_data": {
                          "properties": {
                            "amount_percent": {
                              "type": "number"
                            },
                            "destination": {
                              "type": "string"
                            }
                          },
                          "required": ["destination"],
                          "title": "transfer_data_specs",
                          "type": "object"
                        },
                        "trial": {
                          "type": "boolean"
                        },
                        "trial_end": {
                          "anyOf": [
                            {
                              "format": "unix-time",
                              "type": "integer"
                            },
                            {
                              "enum": ["now"],
                              "maxLength": 5000,
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "required": ["items"],
                      "title": "phase_configuration_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "proration_behavior": {
                    "description": "If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a schedule"
      }
    },
    "/v1/subscription_schedules/{schedule}/cancel": {
      "post": {
        "description": "<p>Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.</p>",
        "operationId": "PostSubscriptionSchedulesScheduleCancel",
        "parameters": [
          {
            "in": "path",
            "name": "schedule",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_now": {
                    "description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.",
                    "type": "boolean"
                  },
                  "prorate": {
                    "description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a schedule"
      }
    },
    "/v1/subscription_schedules/{schedule}/release": {
      "post": {
        "description": "<p>Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.</p>",
        "operationId": "PostSubscriptionSchedulesScheduleRelease",
        "parameters": [
          {
            "in": "path",
            "name": "schedule",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "preserve_cancel_date": {
                    "description": "Keep any cancellation on the subscription that the schedule has set",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription_schedule"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Release a schedule"
      }
    },
    "/v1/subscriptions": {
      "get": {
        "description": "<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>",
        "operationId": "GetSubscriptions",
        "parameters": [
          {
            "description": "Filter subscriptions by their automatic tax settings.",
            "explode": true,
            "in": "query",
            "name": "automatic_tax",
            "required": false,
            "schema": {
              "properties": {
                "enabled": {
                  "type": "boolean"
                }
              },
              "required": ["enabled"],
              "title": "automatic_tax_filter_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.",
            "in": "query",
            "name": "collection_method",
            "required": false,
            "schema": {
              "enum": ["charge_automatically", "send_invoice"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return subscriptions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscriptions whose current_period_end falls within the given date interval.",
            "explode": true,
            "in": "query",
            "name": "current_period_end",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return subscriptions whose current_period_start falls within the given date interval.",
            "explode": true,
            "in": "query",
            "name": "current_period_start",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "The ID of the customer whose subscriptions will be retrieved.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Filter for subscriptions that contain this recurring price ID.",
            "in": "query",
            "name": "price",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "active",
                "all",
                "canceled",
                "ended",
                "incomplete",
                "incomplete_expired",
                "past_due",
                "paused",
                "trialing",
                "unpaid"
              ],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.",
            "in": "query",
            "name": "test_clock",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/subscription"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/subscriptions",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SubscriptionsSubscriptionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List subscriptions"
      },
      "post": {
        "description": "<p>Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.</p>\n\n<p>When you create a subscription with <code>collection_method=charge_automatically</code>, the first invoice is finalized as part of the request.\nThe <code>payment_behavior</code> parameter determines the exact behavior of the initial payment.</p>\n\n<p>To start subscriptions where the first invoice always begins in a <code>draft</code> status, use <a href=\"/docs/billing/subscriptions/subscription-schedules#managing\">subscription schedules</a> instead.\nSchedules provide the flexibility to model more complex billing configurations that change over time.</p>",
        "operationId": "PostSubscriptions",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "add_invoice_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_cycle_anchor_config": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pending_invoice_item_interval": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_end": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "add_invoice_items": {
                    "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "items": {
                            "properties": {
                              "coupon": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "discount": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "promotion_code": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "discounts_data_param",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "one_time_price_data_with_negative_amounts",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "add_invoice_item_entry",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)."
                  },
                  "automatic_tax": {
                    "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_config",
                    "type": "object"
                  },
                  "backdate_start_date": {
                    "description": "For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "billing_cycle_anchor": {
                    "description": "A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.",
                    "format": "unix-time",
                    "type": "integer",
                    "x-stripeBypassValidation": true
                  },
                  "billing_cycle_anchor_config": {
                    "description": "Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.",
                    "properties": {
                      "day_of_month": {
                        "type": "integer"
                      },
                      "hour": {
                        "type": "integer"
                      },
                      "minute": {
                        "type": "integer"
                      },
                      "month": {
                        "type": "integer"
                      },
                      "second": {
                        "type": "integer"
                      }
                    },
                    "required": ["day_of_month"],
                    "title": "billing_cycle_anchor_config_param",
                    "type": "object"
                  },
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_gte": {
                            "type": "integer"
                          },
                          "reset_billing_cycle_anchor": {
                            "type": "boolean"
                          }
                        },
                        "title": "billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds."
                  },
                  "cancel_at": {
                    "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "cancel_at_period_end": {
                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                    "type": "boolean"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "coupon": {
                    "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The identifier of the customer to subscribe.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "days_until_due": {
                    "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription."
                  },
                  "description": {
                    "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "account_tax_ids": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "invoice_settings_param",
                    "type": "object"
                  },
                  "items": {
                    "description": "A list of up to 20 subscription items, each with an attached price.",
                    "items": {
                      "properties": {
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "usage_gte": {
                                  "type": "integer"
                                }
                              },
                              "required": ["usage_gte"],
                              "title": "item_billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "metadata": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "type": "object"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product", "recurring"],
                          "title": "recurring_price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "subscription_item_create_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).",
                    "type": "boolean"
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account on behalf of which to charge, for each of the subscription's invoices."
                  },
                  "payment_behavior": {
                    "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "payment_settings": {
                    "description": "Payment settings to pass to invoices created by the subscription.",
                    "properties": {
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "amount": {
                                        "type": "integer"
                                      },
                                      "amount_type": {
                                        "enum": ["fixed", "maximum"],
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 200,
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "network": {
                                    "enum": [
                                      "amex",
                                      "cartes_bancaires",
                                      "diners",
                                      "discover",
                                      "eftpos_au",
                                      "girocard",
                                      "interac",
                                      "jcb",
                                      "link",
                                      "mastercard",
                                      "unionpay",
                                      "unknown",
                                      "visa"
                                    ],
                                    "maxLength": 5000,
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "subscription_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "save_default_payment_method": {
                        "enum": ["off", "on_subscription"],
                        "type": "string"
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "pending_invoice_item_interval": {
                    "anyOf": [
                      {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "pending_invoice_item_interval_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
                  },
                  "promotion_code": {
                    "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "transfer_data": {
                    "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.",
                    "properties": {
                      "amount_percent": {
                        "type": "number"
                      },
                      "destination": {
                        "type": "string"
                      }
                    },
                    "required": ["destination"],
                    "title": "transfer_data_specs",
                    "type": "object"
                  },
                  "trial_end": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more."
                  },
                  "trial_from_plan": {
                    "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "boolean"
                  },
                  "trial_period_days": {
                    "description": "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "integer"
                  },
                  "trial_settings": {
                    "description": "Settings related to subscription trials.",
                    "properties": {
                      "end_behavior": {
                        "properties": {
                          "missing_payment_method": {
                            "enum": ["cancel", "create_invoice", "pause"],
                            "type": "string"
                          }
                        },
                        "required": ["missing_payment_method"],
                        "title": "end_behavior",
                        "type": "object"
                      }
                    },
                    "required": ["end_behavior"],
                    "title": "trial_settings_config",
                    "type": "object"
                  }
                },
                "required": ["customer"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a subscription"
      }
    },
    "/v1/subscriptions/search": {
      "get": {
        "description": "<p>Search for subscriptions you’ve previously created using Stripe’s <a href=\"/docs/search#search-query-language\">Search Query Language</a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.</p>",
        "operationId": "GetSubscriptionsSearch",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/subscription"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "type": "boolean"
                    },
                    "next_page": {
                      "maxLength": 5000,
                      "nullable": true,
                      "type": "string"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": ["search_result"],
                      "type": "string"
                    },
                    "total_count": {
                      "description": "The total number of objects that match the query, only accurate up to 10,000.",
                      "type": "integer"
                    },
                    "url": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "SearchResult",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Search subscriptions"
      }
    },
    "/v1/subscriptions/{subscription_exposed_id}": {
      "delete": {
        "description": "<p>Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its <a href=\"/metadata\">metadata</a>.</p>\n\n<p>Any pending invoice items that you’ve created are still charged at the end of the period, unless manually <a href=\"#delete_invoiceitem\">deleted</a>. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.</p>\n\n<p>By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.</p>",
        "operationId": "DeleteSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "cancellation_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cancellation_details": {
                    "description": "Details about why this subscription was cancelled",
                    "properties": {
                      "comment": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "feedback": {
                        "enum": [
                          "",
                          "customer_service",
                          "low_quality",
                          "missing_features",
                          "other",
                          "switched_service",
                          "too_complex",
                          "too_expensive",
                          "unused"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "cancellation_details_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_now": {
                    "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.",
                    "type": "boolean"
                  },
                  "prorate": {
                    "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a subscription"
      },
      "get": {
        "description": "<p>Retrieves the subscription with the given ID.</p>",
        "operationId": "GetSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a subscription"
      },
      "post": {
        "description": "<p>Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the <a href=\"/docs/api/invoices/create_preview\">create preview</a> endpoint.</p>\n\n<p>By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a <currency>100</currency> price, they’ll be billed <currency>100</currency> immediately. If on May 15 they switch to a <currency>200</currency> price, then on June 1 they’ll be billed <currency>250</currency> (<currency>200</currency> for a renewal of her subscription, plus a <currency>50</currency> prorating adjustment for half of the previous month’s <currency>100</currency> difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.</p>\n\n<p>Switching prices does not normally change the billing date or generate an immediate charge unless:</p>\n\n<ul>\n<li>The billing interval is changed (for example, from monthly to yearly).</li>\n<li>The subscription moves from free to paid.</li>\n<li>A trial starts or ends.</li>\n</ul>\n\n<p>In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how <a href=\"/docs/billing/subscriptions/upgrade-downgrade#immediate-payment\">Stripe immediately attempts payment for subscription changes</a>.</p>\n\n<p>If you want to charge for an upgrade immediately, pass <code>proration_behavior</code> as <code>always_invoice</code> to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass <code>create_prorations</code>, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually <a href=\"/docs/api/invoices/create\">invoice the customer</a>.</p>\n\n<p>If you don’t want to prorate, set the <code>proration_behavior</code> option to <code>none</code>. With this option, the customer is billed <currency>100</currency> on May 1 and <currency>200</currency> on June 1. Similarly, if you set <code>proration_behavior</code> to <code>none</code> when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.</p>\n\n<p>Updating the quantity on a subscription many times in an hour may result in <a href=\"/docs/rate-limits\">rate limiting</a>. If you need to bill for a frequently changing quantity, consider integrating <a href=\"/docs/billing/subscriptions/usage-based\">usage-based billing</a> instead.</p>",
        "operationId": "PostSubscriptionsSubscriptionExposedId",
        "parameters": [
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "add_invoice_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "application_fee_percent": {
                  "explode": true,
                  "style": "deepObject"
                },
                "automatic_tax": {
                  "explode": true,
                  "style": "deepObject"
                },
                "billing_thresholds": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cancel_at": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cancellation_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_source": {
                  "explode": true,
                  "style": "deepObject"
                },
                "default_tax_rates": {
                  "explode": true,
                  "style": "deepObject"
                },
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "discounts": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "invoice_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "on_behalf_of": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pause_collection": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pending_invoice_item_interval": {
                  "explode": true,
                  "style": "deepObject"
                },
                "transfer_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_end": {
                  "explode": true,
                  "style": "deepObject"
                },
                "trial_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "add_invoice_items": {
                    "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.",
                    "items": {
                      "properties": {
                        "discounts": {
                          "items": {
                            "properties": {
                              "coupon": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "discount": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "promotion_code": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "discounts_data_param",
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product"],
                          "title": "one_time_price_data_with_negative_amounts",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "add_invoice_item_entry",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "application_fee_percent": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)."
                  },
                  "automatic_tax": {
                    "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "liability": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["enabled"],
                    "title": "automatic_tax_config",
                    "type": "object"
                  },
                  "billing_cycle_anchor": {
                    "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
                    "enum": ["now", "unchanged"],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "billing_thresholds": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_gte": {
                            "type": "integer"
                          },
                          "reset_billing_cycle_anchor": {
                            "type": "boolean"
                          }
                        },
                        "title": "billing_thresholds_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds."
                  },
                  "cancel_at": {
                    "anyOf": [
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period."
                  },
                  "cancel_at_period_end": {
                    "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.",
                    "type": "boolean"
                  },
                  "cancellation_details": {
                    "description": "Details about why this subscription was cancelled",
                    "properties": {
                      "comment": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "feedback": {
                        "enum": [
                          "",
                          "customer_service",
                          "low_quality",
                          "missing_features",
                          "other",
                          "switched_service",
                          "too_complex",
                          "too_expensive",
                          "unused"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "cancellation_details_param",
                    "type": "object"
                  },
                  "collection_method": {
                    "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.",
                    "enum": ["charge_automatically", "send_invoice"],
                    "type": "string"
                  },
                  "coupon": {
                    "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "days_until_due": {
                    "description": "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.",
                    "type": "integer"
                  },
                  "default_payment_method": {
                    "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "default_source": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)."
                  },
                  "default_tax_rates": {
                    "anyOf": [
                      {
                        "items": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates."
                  },
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 500,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
                  },
                  "discounts": {
                    "anyOf": [
                      {
                        "items": {
                          "properties": {
                            "coupon": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "discount": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "promotion_code": {
                              "maxLength": 5000,
                              "type": "string"
                            }
                          },
                          "title": "discounts_data_param",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "invoice_settings": {
                    "description": "All invoices will be billed using the specified settings.",
                    "properties": {
                      "account_tax_ids": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "issuer": {
                        "properties": {
                          "account": {
                            "type": "string"
                          },
                          "type": {
                            "enum": ["account", "self"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "title": "invoice_settings_param",
                    "type": "object"
                  },
                  "items": {
                    "description": "A list of up to 20 subscription items, each with an attached price.",
                    "items": {
                      "properties": {
                        "billing_thresholds": {
                          "anyOf": [
                            {
                              "properties": {
                                "usage_gte": {
                                  "type": "integer"
                                }
                              },
                              "required": ["usage_gte"],
                              "title": "item_billing_thresholds_param",
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "clear_usage": {
                          "type": "boolean"
                        },
                        "deleted": {
                          "type": "boolean"
                        },
                        "discounts": {
                          "anyOf": [
                            {
                              "items": {
                                "properties": {
                                  "coupon": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "discount": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "promotion_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "discounts_data_param",
                                "type": "object"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "id": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "metadata": {
                          "anyOf": [
                            {
                              "additionalProperties": {
                                "type": "string"
                              },
                              "type": "object"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        },
                        "price": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "price_data": {
                          "properties": {
                            "currency": {
                              "format": "currency",
                              "type": "string"
                            },
                            "product": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "recurring": {
                              "properties": {
                                "interval": {
                                  "enum": ["day", "month", "week", "year"],
                                  "type": "string"
                                },
                                "interval_count": {
                                  "type": "integer"
                                }
                              },
                              "required": ["interval"],
                              "title": "recurring_adhoc",
                              "type": "object"
                            },
                            "tax_behavior": {
                              "enum": ["exclusive", "inclusive", "unspecified"],
                              "type": "string"
                            },
                            "unit_amount": {
                              "type": "integer"
                            },
                            "unit_amount_decimal": {
                              "format": "decimal",
                              "type": "string"
                            }
                          },
                          "required": ["currency", "product", "recurring"],
                          "title": "recurring_price_data",
                          "type": "object"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "tax_rates": {
                          "anyOf": [
                            {
                              "items": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "type": "array"
                            },
                            {
                              "enum": [""],
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "title": "subscription_item_update_params",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "off_session": {
                    "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).",
                    "type": "boolean"
                  },
                  "on_behalf_of": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The account on behalf of which to charge, for each of the subscription's invoices."
                  },
                  "pause_collection": {
                    "anyOf": [
                      {
                        "properties": {
                          "behavior": {
                            "enum": [
                              "keep_as_draft",
                              "mark_uncollectible",
                              "void"
                            ],
                            "type": "string"
                          },
                          "resumes_at": {
                            "format": "unix-time",
                            "type": "integer"
                          }
                        },
                        "required": ["behavior"],
                        "title": "pause_collection_param",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment)."
                  },
                  "payment_behavior": {
                    "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.",
                    "enum": [
                      "allow_incomplete",
                      "default_incomplete",
                      "error_if_incomplete",
                      "pending_if_incomplete"
                    ],
                    "type": "string"
                  },
                  "payment_settings": {
                    "description": "Payment settings to pass to invoices created by the subscription.",
                    "properties": {
                      "payment_method_options": {
                        "properties": {
                          "acss_debit": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "transaction_type": {
                                        "enum": ["business", "personal"],
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "bancontact": {
                            "anyOf": [
                              {
                                "properties": {
                                  "preferred_language": {
                                    "enum": ["de", "en", "fr", "nl"],
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "card": {
                            "anyOf": [
                              {
                                "properties": {
                                  "mandate_options": {
                                    "properties": {
                                      "amount": {
                                        "type": "integer"
                                      },
                                      "amount_type": {
                                        "enum": ["fixed", "maximum"],
                                        "type": "string"
                                      },
                                      "description": {
                                        "maxLength": 200,
                                        "type": "string"
                                      }
                                    },
                                    "title": "mandate_options_param",
                                    "type": "object"
                                  },
                                  "network": {
                                    "enum": [
                                      "amex",
                                      "cartes_bancaires",
                                      "diners",
                                      "discover",
                                      "eftpos_au",
                                      "girocard",
                                      "interac",
                                      "jcb",
                                      "link",
                                      "mastercard",
                                      "unionpay",
                                      "unknown",
                                      "visa"
                                    ],
                                    "maxLength": 5000,
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  },
                                  "request_three_d_secure": {
                                    "enum": ["any", "automatic", "challenge"],
                                    "type": "string"
                                  }
                                },
                                "title": "subscription_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "customer_balance": {
                            "anyOf": [
                              {
                                "properties": {
                                  "bank_transfer": {
                                    "properties": {
                                      "eu_bank_transfer": {
                                        "properties": {
                                          "country": {
                                            "maxLength": 5000,
                                            "type": "string"
                                          }
                                        },
                                        "required": ["country"],
                                        "title": "eu_bank_transfer_param",
                                        "type": "object"
                                      },
                                      "type": {
                                        "type": "string"
                                      }
                                    },
                                    "title": "bank_transfer_param",
                                    "type": "object"
                                  },
                                  "funding_type": {
                                    "type": "string"
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "konbini": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "sepa_debit": {
                            "anyOf": [
                              {
                                "properties": {},
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "us_bank_account": {
                            "anyOf": [
                              {
                                "properties": {
                                  "financial_connections": {
                                    "properties": {
                                      "filters": {
                                        "properties": {
                                          "account_subcategories": {
                                            "items": {
                                              "enum": ["checking", "savings"],
                                              "type": "string"
                                            },
                                            "type": "array"
                                          }
                                        },
                                        "title": "invoice_linked_account_options_filters_param",
                                        "type": "object"
                                      },
                                      "permissions": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "payment_method",
                                            "transactions"
                                          ],
                                          "maxLength": 5000,
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      },
                                      "prefetch": {
                                        "items": {
                                          "enum": [
                                            "balances",
                                            "ownership",
                                            "transactions"
                                          ],
                                          "type": "string",
                                          "x-stripeBypassValidation": true
                                        },
                                        "type": "array"
                                      }
                                    },
                                    "title": "invoice_linked_account_options_param",
                                    "type": "object"
                                  },
                                  "verification_method": {
                                    "enum": [
                                      "automatic",
                                      "instant",
                                      "microdeposits"
                                    ],
                                    "type": "string",
                                    "x-stripeBypassValidation": true
                                  }
                                },
                                "title": "invoice_payment_method_options_param",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "payment_method_options",
                        "type": "object"
                      },
                      "payment_method_types": {
                        "anyOf": [
                          {
                            "items": {
                              "enum": [
                                "ach_credit_transfer",
                                "ach_debit",
                                "acss_debit",
                                "amazon_pay",
                                "au_becs_debit",
                                "bacs_debit",
                                "bancontact",
                                "boleto",
                                "card",
                                "cashapp",
                                "customer_balance",
                                "eps",
                                "fpx",
                                "giropay",
                                "grabpay",
                                "ideal",
                                "jp_credit_transfer",
                                "kakao_pay",
                                "konbini",
                                "kr_card",
                                "link",
                                "multibanco",
                                "naver_pay",
                                "p24",
                                "payco",
                                "paynow",
                                "paypal",
                                "promptpay",
                                "revolut_pay",
                                "sepa_credit_transfer",
                                "sepa_debit",
                                "sofort",
                                "swish",
                                "us_bank_account",
                                "wechat_pay"
                              ],
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "save_default_payment_method": {
                        "enum": ["off", "on_subscription"],
                        "type": "string"
                      }
                    },
                    "title": "payment_settings",
                    "type": "object"
                  },
                  "pending_invoice_item_interval": {
                    "anyOf": [
                      {
                        "properties": {
                          "interval": {
                            "enum": ["day", "month", "week", "year"],
                            "type": "string"
                          },
                          "interval_count": {
                            "type": "integer"
                          }
                        },
                        "required": ["interval"],
                        "title": "pending_invoice_item_interval_params",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
                  },
                  "promotion_code": {
                    "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "transfer_data": {
                    "anyOf": [
                      {
                        "properties": {
                          "amount_percent": {
                            "type": "number"
                          },
                          "destination": {
                            "type": "string"
                          }
                        },
                        "required": ["destination"],
                        "title": "transfer_data_specs",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value."
                  },
                  "trial_end": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`."
                  },
                  "trial_from_plan": {
                    "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.",
                    "type": "boolean"
                  },
                  "trial_settings": {
                    "description": "Settings related to subscription trials.",
                    "properties": {
                      "end_behavior": {
                        "properties": {
                          "missing_payment_method": {
                            "enum": ["cancel", "create_invoice", "pause"],
                            "type": "string"
                          }
                        },
                        "required": ["missing_payment_method"],
                        "title": "end_behavior",
                        "type": "object"
                      }
                    },
                    "required": ["end_behavior"],
                    "title": "trial_settings_config",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a subscription"
      }
    },
    "/v1/subscriptions/{subscription_exposed_id}/discount": {
      "delete": {
        "description": "<p>Removes the currently applied discount on a subscription.</p>",
        "operationId": "DeleteSubscriptionsSubscriptionExposedIdDiscount",
        "parameters": [
          {
            "in": "path",
            "name": "subscription_exposed_id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_discount"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a subscription discount"
      }
    },
    "/v1/subscriptions/{subscription}/resume": {
      "post": {
        "description": "<p>Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become <code>active</code>, and if payment fails the subscription will be <code>past_due</code>. The resumption invoice will void automatically if not paid by the expiration date.</p>",
        "operationId": "PostSubscriptionsSubscriptionResume",
        "parameters": [
          {
            "in": "path",
            "name": "subscription",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "billing_cycle_anchor": {
                    "description": "The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).",
                    "enum": ["now", "unchanged"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "proration_behavior": {
                    "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.",
                    "enum": ["always_invoice", "create_prorations", "none"],
                    "type": "string"
                  },
                  "proration_date": {
                    "description": "If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/subscription"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Resume a subscription"
      }
    },
    "/v1/tax/calculations": {
      "post": {
        "description": "<p>Calculates tax based on the input and returns a Tax <code>Calculation</code> object.</p>",
        "operationId": "PostTaxCalculations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "customer_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "ship_from_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_cost": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "customer_details": {
                    "description": "Details about the customer, including address and tax IDs.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "line2": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "postal_code": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "state": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "required": ["country"],
                        "title": "postal_address",
                        "type": "object"
                      },
                      "address_source": {
                        "enum": ["billing", "shipping"],
                        "type": "string"
                      },
                      "ip_address": {
                        "type": "string"
                      },
                      "tax_ids": {
                        "items": {
                          "properties": {
                            "type": {
                              "enum": [
                                "ad_nrt",
                                "ae_trn",
                                "al_tin",
                                "am_tin",
                                "ao_tin",
                                "ar_cuit",
                                "au_abn",
                                "au_arn",
                                "ba_tin",
                                "bb_tin",
                                "bg_uic",
                                "bh_vat",
                                "bo_tin",
                                "br_cnpj",
                                "br_cpf",
                                "bs_tin",
                                "by_tin",
                                "ca_bn",
                                "ca_gst_hst",
                                "ca_pst_bc",
                                "ca_pst_mb",
                                "ca_pst_sk",
                                "ca_qst",
                                "cd_nif",
                                "ch_uid",
                                "ch_vat",
                                "cl_tin",
                                "cn_tin",
                                "co_nit",
                                "cr_tin",
                                "de_stn",
                                "do_rcn",
                                "ec_ruc",
                                "eg_tin",
                                "es_cif",
                                "eu_oss_vat",
                                "eu_vat",
                                "gb_vat",
                                "ge_vat",
                                "gn_nif",
                                "hk_br",
                                "hr_oib",
                                "hu_tin",
                                "id_npwp",
                                "il_vat",
                                "in_gst",
                                "is_vat",
                                "jp_cn",
                                "jp_rn",
                                "jp_trn",
                                "ke_pin",
                                "kh_tin",
                                "kr_brn",
                                "kz_bin",
                                "li_uid",
                                "li_vat",
                                "ma_vat",
                                "md_vat",
                                "me_pib",
                                "mk_vat",
                                "mr_nif",
                                "mx_rfc",
                                "my_frp",
                                "my_itn",
                                "my_sst",
                                "ng_tin",
                                "no_vat",
                                "no_voec",
                                "np_pan",
                                "nz_gst",
                                "om_vat",
                                "pe_ruc",
                                "ph_tin",
                                "ro_tin",
                                "rs_pib",
                                "ru_inn",
                                "ru_kpp",
                                "sa_vat",
                                "sg_gst",
                                "sg_uen",
                                "si_tin",
                                "sn_ninea",
                                "sr_fin",
                                "sv_nit",
                                "th_vat",
                                "tj_tin",
                                "tr_tin",
                                "tw_vat",
                                "tz_vat",
                                "ua_vat",
                                "ug_tin",
                                "us_ein",
                                "uy_ruc",
                                "uz_tin",
                                "uz_vat",
                                "ve_rif",
                                "vn_tin",
                                "za_vat",
                                "zm_tin",
                                "zw_tin"
                              ],
                              "maxLength": 5000,
                              "type": "string",
                              "x-stripeBypassValidation": true
                            },
                            "value": {
                              "type": "string"
                            }
                          },
                          "required": ["type", "value"],
                          "title": "data_params",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "taxability_override": {
                        "enum": ["customer_exempt", "none", "reverse_charge"],
                        "type": "string"
                      }
                    },
                    "title": "customer_details",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "line_items": {
                    "description": "A list of items the customer is purchasing.",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "product": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "reference": {
                          "maxLength": 500,
                          "type": "string"
                        },
                        "tax_behavior": {
                          "enum": ["exclusive", "inclusive"],
                          "type": "string"
                        },
                        "tax_code": {
                          "type": "string"
                        }
                      },
                      "required": ["amount"],
                      "title": "calculation_line_item",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "ship_from_details": {
                    "description": "Details about the address from which the goods are being shipped.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "line2": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "postal_code": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "state": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "required": ["country"],
                        "title": "merchant_postal_address",
                        "type": "object"
                      }
                    },
                    "required": ["address"],
                    "title": "ship_from_details",
                    "type": "object"
                  },
                  "shipping_cost": {
                    "description": "Shipping cost details to be used for the calculation.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "shipping_rate": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "tax_behavior": {
                        "enum": ["exclusive", "inclusive"],
                        "type": "string"
                      },
                      "tax_code": {
                        "type": "string"
                      }
                    },
                    "title": "shipping_cost",
                    "type": "object"
                  },
                  "tax_date": {
                    "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.",
                    "type": "integer"
                  }
                },
                "required": ["currency", "line_items"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.calculation"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Tax Calculation"
      }
    },
    "/v1/tax/calculations/{calculation}": {
      "get": {
        "description": "<p>Retrieves a Tax <code>Calculation</code> object, if the calculation hasn’t expired.</p>",
        "operationId": "GetTaxCalculationsCalculation",
        "parameters": [
          {
            "in": "path",
            "name": "calculation",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.calculation"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Tax Calculation"
      }
    },
    "/v1/tax/calculations/{calculation}/line_items": {
      "get": {
        "description": "<p>Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.</p>",
        "operationId": "GetTaxCalculationsCalculationLineItems",
        "parameters": [
          {
            "in": "path",
            "name": "calculation",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 500,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 500,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/tax.calculation_line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/tax/calculations/[^/]+/line_items",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxProductResourceTaxCalculationLineItemList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a calculation's line items"
      }
    },
    "/v1/tax/registrations": {
      "get": {
        "description": "<p>Returns a list of Tax <code>Registration</code> objects.</p>",
        "operationId": "GetTaxRegistrations",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "The status of the Tax Registration.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["active", "all", "expired", "scheduled"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/tax.registration"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/tax/registrations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxProductRegistrationsResourceTaxRegistrationList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List registrations"
      },
      "post": {
        "description": "<p>Creates a new Tax <code>Registration</code> object.</p>",
        "operationId": "PostTaxRegistrations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "active_from": {
                  "explode": true,
                  "style": "deepObject"
                },
                "country_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active_from": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch."
                  },
                  "country": {
                    "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "country_options": {
                    "description": "Specific options for a registration in the specified `country`.",
                    "properties": {
                      "ae": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "al": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "am": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ao": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "at": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "au": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "ba": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "bb": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "be": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "bg": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "bh": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "bs": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "by": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ca": {
                        "properties": {
                          "province_standard": {
                            "properties": {
                              "province": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["province"],
                            "title": "province_standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "province_standard",
                              "simplified",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "canada",
                        "type": "object"
                      },
                      "cd": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "ch": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "cl": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "co": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "cr": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "cy": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "cz": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "de": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "dk": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "ec": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ee": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "eg": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "es": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "fi": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "fr": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "gb": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "ge": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "gn": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "gr": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "hr": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "hu": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "id": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ie": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "is": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "it": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "jp": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "ke": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "kh": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "kr": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "kz": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "lt": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "lu": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "lv": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "ma": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "md": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "me": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "mk": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "mr": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "mt": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "mx": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "my": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ng": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "nl": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "no": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "np": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "nz": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "om": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "pe": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "pl": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "pt": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "ro": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "rs": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "ru": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "sa": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "se": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "sg": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "si": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "sk": {
                        "properties": {
                          "standard": {
                            "properties": {
                              "place_of_supply_scheme": {
                                "enum": ["small_seller", "standard"],
                                "type": "string"
                              }
                            },
                            "required": ["place_of_supply_scheme"],
                            "title": "standard",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "ioss",
                              "oss_non_union",
                              "oss_union",
                              "standard"
                            ],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "europe",
                        "type": "object"
                      },
                      "sn": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "sr": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "th": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "tj": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "tr": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "tz": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "ug": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "us": {
                        "properties": {
                          "local_amusement_tax": {
                            "properties": {
                              "jurisdiction": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["jurisdiction"],
                            "title": "local_amusement_tax",
                            "type": "object"
                          },
                          "local_lease_tax": {
                            "properties": {
                              "jurisdiction": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "required": ["jurisdiction"],
                            "title": "local_lease_tax",
                            "type": "object"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state_sales_tax": {
                            "properties": {
                              "elections": {
                                "items": {
                                  "properties": {
                                    "jurisdiction": {
                                      "maxLength": 5000,
                                      "type": "string"
                                    },
                                    "type": {
                                      "enum": [
                                        "local_use_tax",
                                        "simplified_sellers_use_tax",
                                        "single_local_use_tax"
                                      ],
                                      "type": "string"
                                    }
                                  },
                                  "required": ["type"],
                                  "title": "state_sales_tax_election",
                                  "type": "object"
                                },
                                "type": "array"
                              }
                            },
                            "required": ["elections"],
                            "title": "state_sales_tax",
                            "type": "object"
                          },
                          "type": {
                            "enum": [
                              "local_amusement_tax",
                              "local_lease_tax",
                              "state_communications_tax",
                              "state_retail_delivery_fee",
                              "state_sales_tax"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["state", "type"],
                        "title": "united_states",
                        "type": "object"
                      },
                      "uy": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "uz": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "vn": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "za": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      },
                      "zm": {
                        "properties": {
                          "type": {
                            "enum": ["simplified"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "simplified",
                        "type": "object"
                      },
                      "zw": {
                        "properties": {
                          "type": {
                            "enum": ["standard"],
                            "type": "string"
                          }
                        },
                        "required": ["type"],
                        "title": "default",
                        "type": "object"
                      }
                    },
                    "title": "country_options",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "required": ["active_from", "country", "country_options"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.registration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a registration"
      }
    },
    "/v1/tax/registrations/{id}": {
      "get": {
        "description": "<p>Returns a Tax <code>Registration</code> object.</p>",
        "operationId": "GetTaxRegistrationsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.registration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a registration"
      },
      "post": {
        "description": "<p>Updates an existing Tax <code>Registration</code> object.</p>\n\n<p>A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting <code>expires_at</code>.</p>",
        "operationId": "PostTaxRegistrationsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "active_from": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expires_at": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active_from": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      }
                    ],
                    "description": "Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch."
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "expires_at": {
                    "anyOf": [
                      {
                        "enum": ["now"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "format": "unix-time",
                        "type": "integer"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.registration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a registration"
      }
    },
    "/v1/tax/settings": {
      "get": {
        "description": "<p>Retrieves Tax <code>Settings</code> for a merchant.</p>",
        "operationId": "GetTaxSettings",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.settings"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve settings"
      },
      "post": {
        "description": "<p>Updates Tax <code>Settings</code> parameters used in tax calculations. All parameters are editable but none can be removed once set.</p>",
        "operationId": "PostTaxSettings",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "defaults": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "head_office": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "defaults": {
                    "description": "Default configuration to be used on Stripe Tax calculations.",
                    "properties": {
                      "tax_behavior": {
                        "enum": [
                          "exclusive",
                          "inclusive",
                          "inferred_by_currency"
                        ],
                        "type": "string"
                      },
                      "tax_code": {
                        "type": "string"
                      }
                    },
                    "title": "defaults_param",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "head_office": {
                    "description": "The place where your business is located.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "validated_country_address",
                        "type": "object"
                      }
                    },
                    "required": ["address"],
                    "title": "head_office_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.settings"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update settings"
      }
    },
    "/v1/tax/transactions/create_from_calculation": {
      "post": {
        "description": "<p>Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.</p>",
        "operationId": "PostTaxTransactionsCreateFromCalculation",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "calculation": {
                    "description": "Tax Calculation ID to be used as input when creating the transaction.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "posted_at": {
                    "description": "The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "reference": {
                    "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.",
                    "maxLength": 500,
                    "type": "string"
                  }
                },
                "required": ["calculation", "reference"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a transaction from a calculation"
      }
    },
    "/v1/tax/transactions/create_reversal": {
      "post": {
        "description": "<p>Partially or fully reverses a previously created <code>Transaction</code>.</p>",
        "operationId": "PostTaxTransactionsCreateReversal",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "line_items": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping_cost": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "flat_amount": {
                    "description": "A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.",
                    "type": "integer"
                  },
                  "line_items": {
                    "description": "The line item amounts to reverse.",
                    "items": {
                      "properties": {
                        "amount": {
                          "type": "integer"
                        },
                        "amount_tax": {
                          "type": "integer"
                        },
                        "metadata": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "type": "object"
                        },
                        "original_line_item": {
                          "maxLength": 5000,
                          "type": "string"
                        },
                        "quantity": {
                          "type": "integer"
                        },
                        "reference": {
                          "maxLength": 500,
                          "type": "string"
                        }
                      },
                      "required": [
                        "amount",
                        "amount_tax",
                        "original_line_item",
                        "reference"
                      ],
                      "title": "transaction_line_item_reversal",
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "mode": {
                    "description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.",
                    "enum": ["full", "partial"],
                    "type": "string"
                  },
                  "original_transaction": {
                    "description": "The ID of the Transaction to partially or fully reverse.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "reference": {
                    "description": "A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "shipping_cost": {
                    "description": "The shipping cost to reverse.",
                    "properties": {
                      "amount": {
                        "type": "integer"
                      },
                      "amount_tax": {
                        "type": "integer"
                      }
                    },
                    "required": ["amount", "amount_tax"],
                    "title": "transaction_shipping_cost_reversal",
                    "type": "object"
                  }
                },
                "required": ["mode", "original_transaction", "reference"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a reversal transaction"
      }
    },
    "/v1/tax/transactions/{transaction}": {
      "get": {
        "description": "<p>Retrieves a Tax <code>Transaction</code> object.</p>",
        "operationId": "GetTaxTransactionsTransaction",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a transaction"
      }
    },
    "/v1/tax/transactions/{transaction}/line_items": {
      "get": {
        "description": "<p>Retrieves the line items of a committed standalone transaction as a collection.</p>",
        "operationId": "GetTaxTransactionsTransactionLineItems",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 500,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 500,
              "type": "string"
            },
            "style": "form"
          },
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/tax.transaction_line_item"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/tax/transactions/[^/]+/line_items",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxProductResourceTaxTransactionLineItemList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a transaction's line items"
      }
    },
    "/v1/tax_codes": {
      "get": {
        "description": "<p>A list of <a href=\"https://stripe.com/docs/tax/tax-categories\">all tax codes available</a> to add to Products in order to allow specific tax calculations.</p>",
        "operationId": "GetTaxCodes",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/tax_code"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxProductResourceTaxCodeList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all tax codes"
      }
    },
    "/v1/tax_codes/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.</p>",
        "operationId": "GetTaxCodesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_code"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a tax code"
      }
    },
    "/v1/tax_ids": {
      "get": {
        "description": "<p>Returns a list of tax IDs.</p>",
        "operationId": "GetTaxIds",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.",
            "explode": true,
            "in": "query",
            "name": "owner",
            "required": false,
            "schema": {
              "properties": {
                "account": {
                  "type": "string"
                },
                "customer": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "type": {
                  "enum": ["account", "application", "customer", "self"],
                  "type": "string"
                }
              },
              "required": ["type"],
              "title": "owner_params",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/tax_id"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxIDsList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all tax IDs"
      },
      "post": {
        "description": "<p>Creates a new account or customer <code>tax_id</code> object.</p>",
        "operationId": "PostTaxIds",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "owner": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "owner": {
                    "description": "The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.",
                    "properties": {
                      "account": {
                        "type": "string"
                      },
                      "customer": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["account", "application", "customer", "self"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "owner_params",
                    "type": "object"
                  },
                  "type": {
                    "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`",
                    "enum": [
                      "ad_nrt",
                      "ae_trn",
                      "al_tin",
                      "am_tin",
                      "ao_tin",
                      "ar_cuit",
                      "au_abn",
                      "au_arn",
                      "ba_tin",
                      "bb_tin",
                      "bg_uic",
                      "bh_vat",
                      "bo_tin",
                      "br_cnpj",
                      "br_cpf",
                      "bs_tin",
                      "by_tin",
                      "ca_bn",
                      "ca_gst_hst",
                      "ca_pst_bc",
                      "ca_pst_mb",
                      "ca_pst_sk",
                      "ca_qst",
                      "cd_nif",
                      "ch_uid",
                      "ch_vat",
                      "cl_tin",
                      "cn_tin",
                      "co_nit",
                      "cr_tin",
                      "de_stn",
                      "do_rcn",
                      "ec_ruc",
                      "eg_tin",
                      "es_cif",
                      "eu_oss_vat",
                      "eu_vat",
                      "gb_vat",
                      "ge_vat",
                      "gn_nif",
                      "hk_br",
                      "hr_oib",
                      "hu_tin",
                      "id_npwp",
                      "il_vat",
                      "in_gst",
                      "is_vat",
                      "jp_cn",
                      "jp_rn",
                      "jp_trn",
                      "ke_pin",
                      "kh_tin",
                      "kr_brn",
                      "kz_bin",
                      "li_uid",
                      "li_vat",
                      "ma_vat",
                      "md_vat",
                      "me_pib",
                      "mk_vat",
                      "mr_nif",
                      "mx_rfc",
                      "my_frp",
                      "my_itn",
                      "my_sst",
                      "ng_tin",
                      "no_vat",
                      "no_voec",
                      "np_pan",
                      "nz_gst",
                      "om_vat",
                      "pe_ruc",
                      "ph_tin",
                      "ro_tin",
                      "rs_pib",
                      "ru_inn",
                      "ru_kpp",
                      "sa_vat",
                      "sg_gst",
                      "sg_uen",
                      "si_tin",
                      "sn_ninea",
                      "sr_fin",
                      "sv_nit",
                      "th_vat",
                      "tj_tin",
                      "tr_tin",
                      "tw_vat",
                      "tz_vat",
                      "ua_vat",
                      "ug_tin",
                      "us_ein",
                      "uy_ruc",
                      "uz_tin",
                      "uz_vat",
                      "ve_rif",
                      "vn_tin",
                      "za_vat",
                      "zm_tin",
                      "zw_tin"
                    ],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "value": {
                    "description": "Value of the tax ID.",
                    "type": "string"
                  }
                },
                "required": ["type", "value"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a tax ID"
      }
    },
    "/v1/tax_ids/{id}": {
      "delete": {
        "description": "<p>Deletes an existing account or customer <code>tax_id</code> object.</p>",
        "operationId": "DeleteTaxIdsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a tax ID"
      },
      "get": {
        "description": "<p>Retrieves an account or customer <code>tax_id</code> object.</p>",
        "operationId": "GetTaxIdsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_id"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a tax ID"
      }
    },
    "/v1/tax_rates": {
      "get": {
        "description": "<p>Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.</p>",
        "operationId": "GetTaxRates",
        "parameters": [
          {
            "description": "Optional flag to filter by tax rates that are either active or inactive (archived).",
            "in": "query",
            "name": "active",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "Optional range for filtering created date.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).",
            "in": "query",
            "name": "inclusive",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/tax_rate"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/tax_rates",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TaxRatesList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all tax rates"
      },
      "post": {
        "description": "<p>Creates a new tax rate.</p>",
        "operationId": "PostTaxRates",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.",
                    "type": "boolean"
                  },
                  "country": {
                    "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "display_name": {
                    "description": "The display name of the tax rate, which will be shown to users.",
                    "maxLength": 50,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "inclusive": {
                    "description": "This specifies if the tax rate is inclusive or exclusive.",
                    "type": "boolean"
                  },
                  "jurisdiction": {
                    "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
                    "maxLength": 50,
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "percentage": {
                    "description": "This represents the tax rate percent out of 100.",
                    "type": "number"
                  },
                  "state": {
                    "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_type": {
                    "description": "The high-level tax type, such as `vat` or `sales_tax`.",
                    "enum": [
                      "amusement_tax",
                      "communications_tax",
                      "gst",
                      "hst",
                      "igst",
                      "jct",
                      "lease_tax",
                      "pst",
                      "qst",
                      "retail_delivery_fee",
                      "rst",
                      "sales_tax",
                      "service_tax",
                      "vat"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "required": ["display_name", "inclusive", "percentage"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a tax rate"
      }
    },
    "/v1/tax_rates/{tax_rate}": {
      "get": {
        "description": "<p>Retrieves a tax rate with the given ID</p>",
        "operationId": "GetTaxRatesTaxRate",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "tax_rate",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a tax rate"
      },
      "post": {
        "description": "<p>Updates an existing tax rate.</p>",
        "operationId": "PostTaxRatesTaxRate",
        "parameters": [
          {
            "in": "path",
            "name": "tax_rate",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "description": "Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.",
                    "type": "boolean"
                  },
                  "country": {
                    "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "display_name": {
                    "description": "The display name of the tax rate, which will be shown to users.",
                    "maxLength": 50,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "jurisdiction": {
                    "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
                    "maxLength": 50,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "state": {
                    "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_type": {
                    "description": "The high-level tax type, such as `vat` or `sales_tax`.",
                    "enum": [
                      "amusement_tax",
                      "communications_tax",
                      "gst",
                      "hst",
                      "igst",
                      "jct",
                      "lease_tax",
                      "pst",
                      "qst",
                      "retail_delivery_fee",
                      "rst",
                      "sales_tax",
                      "service_tax",
                      "vat"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tax_rate"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a tax rate"
      }
    },
    "/v1/terminal/configurations": {
      "get": {
        "description": "<p>Returns a list of <code>Configuration</code> objects.</p>",
        "operationId": "GetTerminalConfigurations",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "if present, only return the account default or non-default configurations.",
            "in": "query",
            "name": "is_account_default",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/terminal.configuration"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/terminal/configurations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TerminalConfigurationConfigurationList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Configurations"
      },
      "post": {
        "description": "<p>Creates a new <code>Configuration</code> object.</p>",
        "operationId": "PostTerminalConfigurations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bbpos_wisepos_e": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "offline": {
                  "explode": true,
                  "style": "deepObject"
                },
                "reboot_window": {
                  "explode": true,
                  "style": "deepObject"
                },
                "stripe_s700": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verifone_p400": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bbpos_wisepos_e": {
                    "description": "An object containing device type specific settings for BBPOS WisePOS E readers",
                    "properties": {
                      "splashscreen": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "bbpos_wise_pose",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "name": {
                    "description": "Name of the configuration",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "offline": {
                    "anyOf": [
                      {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "offline",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Configurations for collecting transactions offline."
                  },
                  "reboot_window": {
                    "description": "Reboot time settings for readers that support customized reboot time configuration.",
                    "properties": {
                      "end_hour": {
                        "type": "integer"
                      },
                      "start_hour": {
                        "type": "integer"
                      }
                    },
                    "required": ["end_hour", "start_hour"],
                    "title": "reboot_window",
                    "type": "object"
                  },
                  "stripe_s700": {
                    "description": "An object containing device type specific settings for Stripe S700 readers",
                    "properties": {
                      "splashscreen": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "stripe_s700",
                    "type": "object"
                  },
                  "tipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "aud": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "cad": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "chf": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "czk": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "dkk": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "eur": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "gbp": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "hkd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "jpy": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "myr": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "nok": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "nzd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "pln": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "sek": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "sgd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "usd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          }
                        },
                        "title": "tipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Tipping configurations for readers supporting on-reader tips"
                  },
                  "verifone_p400": {
                    "description": "An object containing device type specific settings for Verifone P400 readers",
                    "properties": {
                      "splashscreen": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "verifone_p400",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Configuration"
      }
    },
    "/v1/terminal/configurations/{configuration}": {
      "delete": {
        "description": "<p>Deletes a <code>Configuration</code> object.</p>",
        "operationId": "DeleteTerminalConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_terminal.configuration"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a Configuration"
      },
      "get": {
        "description": "<p>Retrieves a <code>Configuration</code> object.</p>",
        "operationId": "GetTerminalConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.configuration"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.configuration"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Configuration"
      },
      "post": {
        "description": "<p>Updates a new <code>Configuration</code> object.</p>",
        "operationId": "PostTerminalConfigurationsConfiguration",
        "parameters": [
          {
            "in": "path",
            "name": "configuration",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "bbpos_wisepos_e": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "offline": {
                  "explode": true,
                  "style": "deepObject"
                },
                "reboot_window": {
                  "explode": true,
                  "style": "deepObject"
                },
                "stripe_s700": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tipping": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verifone_p400": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bbpos_wisepos_e": {
                    "anyOf": [
                      {
                        "properties": {
                          "splashscreen": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "bbpos_wise_pose",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "An object containing device type specific settings for BBPOS WisePOS E readers"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "name": {
                    "description": "Name of the configuration",
                    "maxLength": 100,
                    "type": "string"
                  },
                  "offline": {
                    "anyOf": [
                      {
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          }
                        },
                        "required": ["enabled"],
                        "title": "offline",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Configurations for collecting transactions offline."
                  },
                  "reboot_window": {
                    "anyOf": [
                      {
                        "properties": {
                          "end_hour": {
                            "type": "integer"
                          },
                          "start_hour": {
                            "type": "integer"
                          }
                        },
                        "required": ["end_hour", "start_hour"],
                        "title": "reboot_window",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Reboot time settings for readers that support customized reboot time configuration."
                  },
                  "stripe_s700": {
                    "anyOf": [
                      {
                        "properties": {
                          "splashscreen": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "stripe_s700",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "An object containing device type specific settings for Stripe S700 readers"
                  },
                  "tipping": {
                    "anyOf": [
                      {
                        "properties": {
                          "aud": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "cad": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "chf": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "czk": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "dkk": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "eur": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "gbp": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "hkd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "jpy": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "myr": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "nok": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "nzd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "pln": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "sek": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "sgd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          },
                          "usd": {
                            "properties": {
                              "fixed_amounts": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "percentages": {
                                "items": {
                                  "type": "integer"
                                },
                                "type": "array"
                              },
                              "smart_tip_threshold": {
                                "type": "integer"
                              }
                            },
                            "title": "currency_specific_config",
                            "type": "object"
                          }
                        },
                        "title": "tipping",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Tipping configurations for readers supporting on-reader tips"
                  },
                  "verifone_p400": {
                    "anyOf": [
                      {
                        "properties": {
                          "splashscreen": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "verifone_p400",
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "An object containing device type specific settings for Verifone P400 readers"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.configuration"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.configuration"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a Configuration"
      }
    },
    "/v1/terminal/connection_tokens": {
      "post": {
        "description": "<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p>",
        "operationId": "PostTerminalConnectionTokens",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "location": {
                    "description": "The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.connection_token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Connection Token"
      }
    },
    "/v1/terminal/locations": {
      "get": {
        "description": "<p>Returns a list of <code>Location</code> objects.</p>",
        "operationId": "GetTerminalLocations",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/terminal.location"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/terminal/locations",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TerminalLocationLocationList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Locations"
      },
      "post": {
        "description": "<p>Creates a new <code>Location</code> object.\nFor further details, including which address fields are required in each country, see the <a href=\"/docs/terminal/fleet/locations\">Manage locations</a> guide.</p>",
        "operationId": "PostTerminalLocations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "address": {
                    "description": "The full address of the location.",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["country"],
                    "title": "create_location_address_param",
                    "type": "object"
                  },
                  "configuration_overrides": {
                    "description": "The ID of a configuration that will be used to customize all readers in this location.",
                    "maxLength": 500,
                    "type": "string"
                  },
                  "display_name": {
                    "description": "A name for the location. Maximum length is 1000 characters.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "required": ["address", "display_name"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.location"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Location"
      }
    },
    "/v1/terminal/locations/{location}": {
      "delete": {
        "description": "<p>Deletes a <code>Location</code> object.</p>",
        "operationId": "DeleteTerminalLocationsLocation",
        "parameters": [
          {
            "in": "path",
            "name": "location",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_terminal.location"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a Location"
      },
      "get": {
        "description": "<p>Retrieves a <code>Location</code> object.</p>",
        "operationId": "GetTerminalLocationsLocation",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "location",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.location"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.location"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Location"
      },
      "post": {
        "description": "<p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostTerminalLocationsLocation",
        "parameters": [
          {
            "in": "path",
            "name": "location",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "address": {
                  "explode": true,
                  "style": "deepObject"
                },
                "configuration_overrides": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "address": {
                    "description": "The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.",
                    "properties": {
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line1": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "line2": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "optional_fields_address",
                    "type": "object"
                  },
                  "configuration_overrides": {
                    "anyOf": [
                      {
                        "maxLength": 1000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The ID of a configuration that will be used to customize all readers in this location."
                  },
                  "display_name": {
                    "description": "A name for the location.",
                    "maxLength": 1000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.location"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.location"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a Location"
      }
    },
    "/v1/terminal/readers": {
      "get": {
        "description": "<p>Returns a list of <code>Reader</code> objects.</p>",
        "operationId": "GetTerminalReaders",
        "parameters": [
          {
            "description": "Filters readers by device type",
            "in": "query",
            "name": "device_type",
            "required": false,
            "schema": {
              "enum": [
                "bbpos_chipper2x",
                "bbpos_wisepad3",
                "bbpos_wisepos_e",
                "mobile_phone_reader",
                "simulated_wisepos_e",
                "stripe_m2",
                "stripe_s700",
                "verifone_P400"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A location ID to filter the response list to only readers at the specific location",
            "in": "query",
            "name": "location",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Filters readers by serial number",
            "in": "query",
            "name": "serial_number",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A status filter to filter readers to only offline or online readers",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["offline", "online"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "A list of readers",
                      "items": {
                        "$ref": "#/components/schemas/terminal.reader"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TerminalReaderRetrieveReader",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Readers"
      },
      "post": {
        "description": "<p>Creates a new <code>Reader</code> object.</p>",
        "operationId": "PostTerminalReaders",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "label": {
                    "description": "Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "location": {
                    "description": "The location to assign the reader to.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "registration_code": {
                    "description": "A code generated by the reader used for registering to an account.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["registration_code"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a Reader"
      }
    },
    "/v1/terminal/readers/{reader}": {
      "delete": {
        "description": "<p>Deletes a <code>Reader</code> object.</p>",
        "operationId": "DeleteTerminalReadersReader",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a Reader"
      },
      "get": {
        "description": "<p>Retrieves a <code>Reader</code> object.</p>",
        "operationId": "GetTerminalReadersReader",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.reader"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.reader"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Reader"
      },
      "post": {
        "description": "<p>Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>",
        "operationId": "PostTerminalReadersReader",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "label": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "label": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The new label of the reader."
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/terminal.reader"
                    },
                    {
                      "$ref": "#/components/schemas/deleted_terminal.reader"
                    }
                  ]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a Reader"
      }
    },
    "/v1/terminal/readers/{reader}/cancel_action": {
      "post": {
        "description": "<p>Cancels the current reader action.</p>",
        "operationId": "PostTerminalReadersReaderCancelAction",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel the current reader action"
      }
    },
    "/v1/terminal/readers/{reader}/process_payment_intent": {
      "post": {
        "description": "<p>Initiates a payment flow on a Reader.</p>",
        "operationId": "PostTerminalReadersReaderProcessPaymentIntent",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "process_config": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "payment_intent": {
                    "description": "PaymentIntent ID",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "process_config": {
                    "description": "Configuration overrides",
                    "properties": {
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "enable_customer_cancellation": {
                        "type": "boolean"
                      },
                      "skip_tipping": {
                        "type": "boolean"
                      },
                      "tipping": {
                        "properties": {
                          "amount_eligible": {
                            "type": "integer"
                          }
                        },
                        "title": "tipping_config",
                        "type": "object"
                      }
                    },
                    "title": "process_config",
                    "type": "object"
                  }
                },
                "required": ["payment_intent"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Hand-off a PaymentIntent to a Reader"
      }
    },
    "/v1/terminal/readers/{reader}/process_setup_intent": {
      "post": {
        "description": "<p>Initiates a setup intent flow on a Reader.</p>",
        "operationId": "PostTerminalReadersReaderProcessSetupIntent",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "process_config": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "allow_redisplay": {
                    "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.",
                    "enum": ["always", "limited", "unspecified"],
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "process_config": {
                    "description": "Configuration overrides",
                    "properties": {
                      "enable_customer_cancellation": {
                        "type": "boolean"
                      }
                    },
                    "title": "process_setup_config",
                    "type": "object"
                  },
                  "setup_intent": {
                    "description": "SetupIntent ID",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["allow_redisplay", "setup_intent"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Hand-off a SetupIntent to a Reader"
      }
    },
    "/v1/terminal/readers/{reader}/refund_payment": {
      "post": {
        "description": "<p>Initiates a refund on a Reader</p>",
        "operationId": "PostTerminalReadersReaderRefundPayment",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "refund_payment_config": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer in __cents__ representing how much of this charge to refund.",
                    "type": "integer"
                  },
                  "charge": {
                    "description": "ID of the Charge to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "payment_intent": {
                    "description": "ID of the PaymentIntent to refund.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "refund_application_fee": {
                    "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.",
                    "type": "boolean"
                  },
                  "refund_payment_config": {
                    "description": "Configuration overrides",
                    "properties": {
                      "enable_customer_cancellation": {
                        "type": "boolean"
                      }
                    },
                    "title": "refund_payment_config",
                    "type": "object"
                  },
                  "reverse_transfer": {
                    "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Refund a Charge or a PaymentIntent in-person"
      }
    },
    "/v1/terminal/readers/{reader}/set_reader_display": {
      "post": {
        "description": "<p>Sets reader display to show cart details.</p>",
        "operationId": "PostTerminalReadersReaderSetReaderDisplay",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "cart": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "cart": {
                    "description": "Cart",
                    "properties": {
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "line_items": {
                        "items": {
                          "properties": {
                            "amount": {
                              "type": "integer"
                            },
                            "description": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "quantity": {
                              "type": "integer"
                            }
                          },
                          "required": ["amount", "description", "quantity"],
                          "title": "line_item",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "tax": {
                        "type": "integer"
                      },
                      "total": {
                        "type": "integer"
                      }
                    },
                    "required": ["currency", "line_items", "total"],
                    "title": "cart",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "type": {
                    "description": "Type",
                    "enum": ["cart"],
                    "type": "string"
                  }
                },
                "required": ["type"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Set reader display"
      }
    },
    "/v1/test_helpers/confirmation_tokens": {
      "post": {
        "description": "<p>Creates a test mode Confirmation Token server side for your integration tests.</p>",
        "operationId": "PostTestHelpersConfirmationTokens",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "shipping": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "payment_method": {
                    "description": "ID of an existing PaymentMethod.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "payment_method_data": {
                    "description": "If provided, this hash will be used to create a PaymentMethod.",
                    "properties": {
                      "acss_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "institution_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "transit_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": [
                          "account_number",
                          "institution_number",
                          "transit_number"
                        ],
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "affirm": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "afterpay_clearpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "alipay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "allow_redisplay": {
                        "enum": ["always", "limited", "unspecified"],
                        "type": "string"
                      },
                      "alma": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "amazon_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "au_becs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "bsb_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["account_number", "bsb_number"],
                        "title": "param",
                        "type": "object"
                      },
                      "bacs_debit": {
                        "properties": {
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "sort_code": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "bancontact": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "blik": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "boleto": {
                        "properties": {
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["tax_id"],
                        "title": "param",
                        "type": "object"
                      },
                      "cashapp": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "customer_balance": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "eps": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "arzte_und_apotheker_bank",
                              "austrian_anadi_bank_ag",
                              "bank_austria",
                              "bankhaus_carl_spangler",
                              "bankhaus_schelhammer_und_schattera_ag",
                              "bawag_psk_ag",
                              "bks_bank_ag",
                              "brull_kallmus_bank_ag",
                              "btv_vier_lander_bank",
                              "capital_bank_grawe_gruppe_ag",
                              "deutsche_bank_ag",
                              "dolomitenbank",
                              "easybank_ag",
                              "erste_bank_und_sparkassen",
                              "hypo_alpeadriabank_international_ag",
                              "hypo_bank_burgenland_aktiengesellschaft",
                              "hypo_noe_lb_fur_niederosterreich_u_wien",
                              "hypo_oberosterreich_salzburg_steiermark",
                              "hypo_tirol_bank_ag",
                              "hypo_vorarlberg_bank_ag",
                              "marchfelder_bank",
                              "oberbank_ag",
                              "raiffeisen_bankengruppe_osterreich",
                              "schoellerbank_ag",
                              "sparda_bank_wien",
                              "volksbank_gruppe",
                              "volkskreditbank_ag",
                              "vr_bank_braunau"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "fpx": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "affin_bank",
                              "agrobank",
                              "alliance_bank",
                              "ambank",
                              "bank_islam",
                              "bank_muamalat",
                              "bank_of_china",
                              "bank_rakyat",
                              "bsn",
                              "cimb",
                              "deutsche_bank",
                              "hong_leong_bank",
                              "hsbc",
                              "kfh",
                              "maybank2e",
                              "maybank2u",
                              "ocbc",
                              "pb_enterprise",
                              "public_bank",
                              "rhb",
                              "standard_chartered",
                              "uob"
                            ],
                            "maxLength": 5000,
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["bank"],
                        "title": "param",
                        "type": "object"
                      },
                      "giropay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "grabpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "ideal": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "abn_amro",
                              "asn_bank",
                              "bunq",
                              "handelsbanken",
                              "ing",
                              "knab",
                              "moneyou",
                              "n26",
                              "nn",
                              "rabobank",
                              "regiobank",
                              "revolut",
                              "sns_bank",
                              "triodos_bank",
                              "van_lanschot",
                              "yoursafe"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "interac_present": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kakao_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "klarna": {
                        "properties": {
                          "dob": {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth",
                            "type": "object"
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "konbini": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "kr_card": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "link": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "mobilepay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "multibanco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "naver_pay": {
                        "properties": {
                          "funding": {
                            "enum": ["card", "points"],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "oxxo": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "p24": {
                        "properties": {
                          "bank": {
                            "enum": [
                              "alior_bank",
                              "bank_millennium",
                              "bank_nowy_bfg_sa",
                              "bank_pekao_sa",
                              "banki_spbdzielcze",
                              "blik",
                              "bnp_paribas",
                              "boz",
                              "citi_handlowy",
                              "credit_agricole",
                              "envelobank",
                              "etransfer_pocztowy24",
                              "getin_bank",
                              "ideabank",
                              "ing",
                              "inteligo",
                              "mbank_mtransfer",
                              "nest_przelew",
                              "noble_pay",
                              "pbac_z_ipko",
                              "plus_bank",
                              "santander_przelew24",
                              "tmobile_usbugi_bankowe",
                              "toyota_bank",
                              "velobank",
                              "volkswagen_bank"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "title": "param",
                        "type": "object"
                      },
                      "pay_by_bank": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "payco": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paynow": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "paypal": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "pix": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "promptpay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "radar_options": {
                        "properties": {
                          "session": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "radar_options_with_hidden_options",
                        "type": "object"
                      },
                      "revolut_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "samsung_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "sepa_debit": {
                        "properties": {
                          "iban": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["iban"],
                        "title": "param",
                        "type": "object"
                      },
                      "sofort": {
                        "properties": {
                          "country": {
                            "enum": ["AT", "BE", "DE", "ES", "IT", "NL"],
                            "type": "string"
                          }
                        },
                        "required": ["country"],
                        "title": "param",
                        "type": "object"
                      },
                      "swish": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "twint": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "acss_debit",
                          "affirm",
                          "afterpay_clearpay",
                          "alipay",
                          "alma",
                          "amazon_pay",
                          "au_becs_debit",
                          "bacs_debit",
                          "bancontact",
                          "blik",
                          "boleto",
                          "cashapp",
                          "customer_balance",
                          "eps",
                          "fpx",
                          "giropay",
                          "grabpay",
                          "ideal",
                          "kakao_pay",
                          "klarna",
                          "konbini",
                          "kr_card",
                          "link",
                          "mobilepay",
                          "multibanco",
                          "naver_pay",
                          "oxxo",
                          "p24",
                          "pay_by_bank",
                          "payco",
                          "paynow",
                          "paypal",
                          "pix",
                          "promptpay",
                          "revolut_pay",
                          "samsung_pay",
                          "sepa_debit",
                          "sofort",
                          "swish",
                          "twint",
                          "us_bank_account",
                          "wechat_pay",
                          "zip"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      },
                      "wechat_pay": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      },
                      "zip": {
                        "properties": {},
                        "title": "param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data_params",
                    "type": "object"
                  },
                  "return_url": {
                    "description": "Return URL used to confirm the Intent.",
                    "type": "string"
                  },
                  "setup_future_usage": {
                    "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.",
                    "enum": ["off_session", "on_session"],
                    "type": "string"
                  },
                  "shipping": {
                    "description": "Shipping information for this ConfirmationToken.",
                    "properties": {
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "optional_fields_address",
                        "type": "object"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "anyOf": [
                          {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "required": ["address", "name"],
                    "title": "recipient_shipping_with_optional_fields_address",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/confirmation_token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test Confirmation Token"
      }
    },
    "/v1/test_helpers/customers/{customer}/fund_cash_balance": {
      "post": {
        "description": "<p>Create an incoming testmode bank transfer</p>",
        "operationId": "PostTestHelpersCustomersCustomerFundCashBalance",
        "parameters": [
          {
            "in": "path",
            "name": "customer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "reference": {
                    "description": "A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["amount", "currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/customer_cash_balance_transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Fund a test mode cash balance"
      }
    },
    "/v1/test_helpers/issuing/authorizations": {
      "post": {
        "description": "<p>Create a test-mode authorization.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizations",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "amount_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fleet": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fuel": {
                  "explode": true,
                  "style": "deepObject"
                },
                "merchant_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "network_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "verification_data": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "amount_details": {
                    "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "properties": {
                      "atm_fee": {
                        "type": "integer"
                      },
                      "cashback_amount": {
                        "type": "integer"
                      }
                    },
                    "title": "amount_details_specs",
                    "type": "object"
                  },
                  "authorization_method": {
                    "description": "How the card details were provided. Defaults to online.",
                    "enum": [
                      "chip",
                      "contactless",
                      "keyed_in",
                      "online",
                      "swipe"
                    ],
                    "type": "string"
                  },
                  "card": {
                    "description": "Card associated with this authorization.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "fleet": {
                    "description": "Fleet-specific information for authorizations using Fleet cards.",
                    "properties": {
                      "cardholder_prompt_data": {
                        "properties": {
                          "driver_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "odometer": {
                            "type": "integer"
                          },
                          "unspecified_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "user_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "vehicle_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "fleet_cardholder_prompt_data_specs",
                        "type": "object"
                      },
                      "purchase_type": {
                        "enum": [
                          "fuel_and_non_fuel_purchase",
                          "fuel_purchase",
                          "non_fuel_purchase"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "reported_breakdown": {
                        "properties": {
                          "fuel": {
                            "properties": {
                              "gross_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_fuel_specs",
                            "type": "object"
                          },
                          "non_fuel": {
                            "properties": {
                              "gross_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_non_fuel_specs",
                            "type": "object"
                          },
                          "tax": {
                            "properties": {
                              "local_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              },
                              "national_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_tax_specs",
                            "type": "object"
                          }
                        },
                        "title": "fleet_reported_breakdown_specs",
                        "type": "object"
                      },
                      "service_type": {
                        "enum": [
                          "full_service",
                          "non_fuel_transaction",
                          "self_service"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "fleet_testmode_authorization_specs",
                    "type": "object"
                  },
                  "fuel": {
                    "description": "Information about fuel that was purchased with this transaction.",
                    "properties": {
                      "industry_product_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "quantity_decimal": {
                        "format": "decimal",
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "diesel",
                          "other",
                          "unleaded_plus",
                          "unleaded_regular",
                          "unleaded_super"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "unit": {
                        "enum": [
                          "charging_minute",
                          "imperial_gallon",
                          "kilogram",
                          "kilowatt_hour",
                          "liter",
                          "other",
                          "pound",
                          "us_gallon"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "unit_cost_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "title": "fuel_specs",
                    "type": "object"
                  },
                  "is_amount_controllable": {
                    "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.",
                    "type": "boolean"
                  },
                  "merchant_amount": {
                    "description": "The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "merchant_currency": {
                    "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "merchant_data": {
                    "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
                    "properties": {
                      "category": {
                        "enum": [
                          "ac_refrigeration_repair",
                          "accounting_bookkeeping_services",
                          "advertising_services",
                          "agricultural_cooperative",
                          "airlines_air_carriers",
                          "airports_flying_fields",
                          "ambulance_services",
                          "amusement_parks_carnivals",
                          "antique_reproductions",
                          "antique_shops",
                          "aquariums",
                          "architectural_surveying_services",
                          "art_dealers_and_galleries",
                          "artists_supply_and_craft_shops",
                          "auto_and_home_supply_stores",
                          "auto_body_repair_shops",
                          "auto_paint_shops",
                          "auto_service_shops",
                          "automated_cash_disburse",
                          "automated_fuel_dispensers",
                          "automobile_associations",
                          "automotive_parts_and_accessories_stores",
                          "automotive_tire_stores",
                          "bail_and_bond_payments",
                          "bakeries",
                          "bands_orchestras",
                          "barber_and_beauty_shops",
                          "betting_casino_gambling",
                          "bicycle_shops",
                          "billiard_pool_establishments",
                          "boat_dealers",
                          "boat_rentals_and_leases",
                          "book_stores",
                          "books_periodicals_and_newspapers",
                          "bowling_alleys",
                          "bus_lines",
                          "business_secretarial_schools",
                          "buying_shopping_services",
                          "cable_satellite_and_other_pay_television_and_radio",
                          "camera_and_photographic_supply_stores",
                          "candy_nut_and_confectionery_stores",
                          "car_and_truck_dealers_new_used",
                          "car_and_truck_dealers_used_only",
                          "car_rental_agencies",
                          "car_washes",
                          "carpentry_services",
                          "carpet_upholstery_cleaning",
                          "caterers",
                          "charitable_and_social_service_organizations_fundraising",
                          "chemicals_and_allied_products",
                          "child_care_services",
                          "childrens_and_infants_wear_stores",
                          "chiropodists_podiatrists",
                          "chiropractors",
                          "cigar_stores_and_stands",
                          "civic_social_fraternal_associations",
                          "cleaning_and_maintenance",
                          "clothing_rental",
                          "colleges_universities",
                          "commercial_equipment",
                          "commercial_footwear",
                          "commercial_photography_art_and_graphics",
                          "commuter_transport_and_ferries",
                          "computer_network_services",
                          "computer_programming",
                          "computer_repair",
                          "computer_software_stores",
                          "computers_peripherals_and_software",
                          "concrete_work_services",
                          "construction_materials",
                          "consulting_public_relations",
                          "correspondence_schools",
                          "cosmetic_stores",
                          "counseling_services",
                          "country_clubs",
                          "courier_services",
                          "court_costs",
                          "credit_reporting_agencies",
                          "cruise_lines",
                          "dairy_products_stores",
                          "dance_hall_studios_schools",
                          "dating_escort_services",
                          "dentists_orthodontists",
                          "department_stores",
                          "detective_agencies",
                          "digital_goods_applications",
                          "digital_goods_games",
                          "digital_goods_large_volume",
                          "digital_goods_media",
                          "direct_marketing_catalog_merchant",
                          "direct_marketing_combination_catalog_and_retail_merchant",
                          "direct_marketing_inbound_telemarketing",
                          "direct_marketing_insurance_services",
                          "direct_marketing_other",
                          "direct_marketing_outbound_telemarketing",
                          "direct_marketing_subscription",
                          "direct_marketing_travel",
                          "discount_stores",
                          "doctors",
                          "door_to_door_sales",
                          "drapery_window_covering_and_upholstery_stores",
                          "drinking_places",
                          "drug_stores_and_pharmacies",
                          "drugs_drug_proprietaries_and_druggist_sundries",
                          "dry_cleaners",
                          "durable_goods",
                          "duty_free_stores",
                          "eating_places_restaurants",
                          "educational_services",
                          "electric_razor_stores",
                          "electric_vehicle_charging",
                          "electrical_parts_and_equipment",
                          "electrical_services",
                          "electronics_repair_shops",
                          "electronics_stores",
                          "elementary_secondary_schools",
                          "emergency_services_gcas_visa_use_only",
                          "employment_temp_agencies",
                          "equipment_rental",
                          "exterminating_services",
                          "family_clothing_stores",
                          "fast_food_restaurants",
                          "financial_institutions",
                          "fines_government_administrative_entities",
                          "fireplace_fireplace_screens_and_accessories_stores",
                          "floor_covering_stores",
                          "florists",
                          "florists_supplies_nursery_stock_and_flowers",
                          "freezer_and_locker_meat_provisioners",
                          "fuel_dealers_non_automotive",
                          "funeral_services_crematories",
                          "furniture_home_furnishings_and_equipment_stores_except_appliances",
                          "furniture_repair_refinishing",
                          "furriers_and_fur_shops",
                          "general_services",
                          "gift_card_novelty_and_souvenir_shops",
                          "glass_paint_and_wallpaper_stores",
                          "glassware_crystal_stores",
                          "golf_courses_public",
                          "government_licensed_horse_dog_racing_us_region_only",
                          "government_licensed_online_casions_online_gambling_us_region_only",
                          "government_owned_lotteries_non_us_region",
                          "government_owned_lotteries_us_region_only",
                          "government_services",
                          "grocery_stores_supermarkets",
                          "hardware_equipment_and_supplies",
                          "hardware_stores",
                          "health_and_beauty_spas",
                          "hearing_aids_sales_and_supplies",
                          "heating_plumbing_a_c",
                          "hobby_toy_and_game_shops",
                          "home_supply_warehouse_stores",
                          "hospitals",
                          "hotels_motels_and_resorts",
                          "household_appliance_stores",
                          "industrial_supplies",
                          "information_retrieval_services",
                          "insurance_default",
                          "insurance_underwriting_premiums",
                          "intra_company_purchases",
                          "jewelry_stores_watches_clocks_and_silverware_stores",
                          "landscaping_services",
                          "laundries",
                          "laundry_cleaning_services",
                          "legal_services_attorneys",
                          "luggage_and_leather_goods_stores",
                          "lumber_building_materials_stores",
                          "manual_cash_disburse",
                          "marinas_service_and_supplies",
                          "marketplaces",
                          "masonry_stonework_and_plaster",
                          "massage_parlors",
                          "medical_and_dental_labs",
                          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                          "medical_services",
                          "membership_organizations",
                          "mens_and_boys_clothing_and_accessories_stores",
                          "mens_womens_clothing_stores",
                          "metal_service_centers",
                          "miscellaneous_apparel_and_accessory_shops",
                          "miscellaneous_auto_dealers",
                          "miscellaneous_business_services",
                          "miscellaneous_food_stores",
                          "miscellaneous_general_merchandise",
                          "miscellaneous_general_services",
                          "miscellaneous_home_furnishing_specialty_stores",
                          "miscellaneous_publishing_and_printing",
                          "miscellaneous_recreation_services",
                          "miscellaneous_repair_shops",
                          "miscellaneous_specialty_retail",
                          "mobile_home_dealers",
                          "motion_picture_theaters",
                          "motor_freight_carriers_and_trucking",
                          "motor_homes_dealers",
                          "motor_vehicle_supplies_and_new_parts",
                          "motorcycle_shops_and_dealers",
                          "motorcycle_shops_dealers",
                          "music_stores_musical_instruments_pianos_and_sheet_music",
                          "news_dealers_and_newsstands",
                          "non_fi_money_orders",
                          "non_fi_stored_value_card_purchase_load",
                          "nondurable_goods",
                          "nurseries_lawn_and_garden_supply_stores",
                          "nursing_personal_care",
                          "office_and_commercial_furniture",
                          "opticians_eyeglasses",
                          "optometrists_ophthalmologist",
                          "orthopedic_goods_prosthetic_devices",
                          "osteopaths",
                          "package_stores_beer_wine_and_liquor",
                          "paints_varnishes_and_supplies",
                          "parking_lots_garages",
                          "passenger_railways",
                          "pawn_shops",
                          "pet_shops_pet_food_and_supplies",
                          "petroleum_and_petroleum_products",
                          "photo_developing",
                          "photographic_photocopy_microfilm_equipment_and_supplies",
                          "photographic_studios",
                          "picture_video_production",
                          "piece_goods_notions_and_other_dry_goods",
                          "plumbing_heating_equipment_and_supplies",
                          "political_organizations",
                          "postal_services_government_only",
                          "precious_stones_and_metals_watches_and_jewelry",
                          "professional_services",
                          "public_warehousing_and_storage",
                          "quick_copy_repro_and_blueprint",
                          "railroads",
                          "real_estate_agents_and_managers_rentals",
                          "record_stores",
                          "recreational_vehicle_rentals",
                          "religious_goods_stores",
                          "religious_organizations",
                          "roofing_siding_sheet_metal",
                          "secretarial_support_services",
                          "security_brokers_dealers",
                          "service_stations",
                          "sewing_needlework_fabric_and_piece_goods_stores",
                          "shoe_repair_hat_cleaning",
                          "shoe_stores",
                          "small_appliance_repair",
                          "snowmobile_dealers",
                          "special_trade_services",
                          "specialty_cleaning",
                          "sporting_goods_stores",
                          "sporting_recreation_camps",
                          "sports_and_riding_apparel_stores",
                          "sports_clubs_fields",
                          "stamp_and_coin_stores",
                          "stationary_office_supplies_printing_and_writing_paper",
                          "stationery_stores_office_and_school_supply_stores",
                          "swimming_pools_sales",
                          "t_ui_travel_germany",
                          "tailors_alterations",
                          "tax_payments_government_agencies",
                          "tax_preparation_services",
                          "taxicabs_limousines",
                          "telecommunication_equipment_and_telephone_sales",
                          "telecommunication_services",
                          "telegraph_services",
                          "tent_and_awning_shops",
                          "testing_laboratories",
                          "theatrical_ticket_agencies",
                          "timeshares",
                          "tire_retreading_and_repair",
                          "tolls_bridge_fees",
                          "tourist_attractions_and_exhibits",
                          "towing_services",
                          "trailer_parks_campgrounds",
                          "transportation_services",
                          "travel_agencies_tour_operators",
                          "truck_stop_iteration",
                          "truck_utility_trailer_rentals",
                          "typesetting_plate_making_and_related_services",
                          "typewriter_stores",
                          "u_s_federal_government_agencies_or_departments",
                          "uniforms_commercial_clothing",
                          "used_merchandise_and_secondhand_stores",
                          "utilities",
                          "variety_stores",
                          "veterinary_services",
                          "video_amusement_game_supplies",
                          "video_game_arcades",
                          "video_tape_rental_stores",
                          "vocational_trade_schools",
                          "watch_jewelry_repair",
                          "welding_repair",
                          "wholesale_clubs",
                          "wig_and_toupee_stores",
                          "wires_money_orders",
                          "womens_accessory_and_specialty_shops",
                          "womens_ready_to_wear_stores",
                          "wrecking_and_salvage_yards"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "network_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "terminal_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "url": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "merchant_data_specs",
                    "type": "object"
                  },
                  "network_data": {
                    "description": "Details about the authorization, such as identifiers, set by the card network.",
                    "properties": {
                      "acquiring_institution_id": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "network_data_specs",
                    "type": "object"
                  },
                  "verification_data": {
                    "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.",
                    "properties": {
                      "address_line1_check": {
                        "enum": ["match", "mismatch", "not_provided"],
                        "type": "string"
                      },
                      "address_postal_code_check": {
                        "enum": ["match", "mismatch", "not_provided"],
                        "type": "string"
                      },
                      "authentication_exemption": {
                        "properties": {
                          "claimed_by": {
                            "enum": ["acquirer", "issuer"],
                            "type": "string"
                          },
                          "type": {
                            "enum": [
                              "low_value_transaction",
                              "transaction_risk_analysis",
                              "unknown"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["claimed_by", "type"],
                        "title": "authentication_exemption_specs",
                        "type": "object"
                      },
                      "cvc_check": {
                        "enum": ["match", "mismatch", "not_provided"],
                        "type": "string"
                      },
                      "expiry_check": {
                        "enum": ["match", "mismatch", "not_provided"],
                        "type": "string"
                      },
                      "three_d_secure": {
                        "properties": {
                          "result": {
                            "enum": [
                              "attempt_acknowledged",
                              "authenticated",
                              "failed",
                              "required"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          }
                        },
                        "required": ["result"],
                        "title": "three_d_secure_specs",
                        "type": "object"
                      }
                    },
                    "title": "verification_data_specs",
                    "type": "object"
                  },
                  "wallet": {
                    "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.",
                    "enum": ["apple_pay", "google_pay", "samsung_pay"],
                    "type": "string"
                  }
                },
                "required": ["card"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test-mode authorization"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/capture": {
      "post": {
        "description": "<p>Capture a test-mode authorization.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "purchase_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "capture_amount": {
                    "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "close_authorization": {
                    "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "purchase_details": {
                    "description": "Additional purchase information that is optionally provided by the merchant.",
                    "properties": {
                      "fleet": {
                        "properties": {
                          "cardholder_prompt_data": {
                            "properties": {
                              "driver_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "odometer": {
                                "type": "integer"
                              },
                              "unspecified_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "user_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "vehicle_number": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "fleet_cardholder_prompt_data_specs",
                            "type": "object"
                          },
                          "purchase_type": {
                            "enum": [
                              "fuel_and_non_fuel_purchase",
                              "fuel_purchase",
                              "non_fuel_purchase"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "reported_breakdown": {
                            "properties": {
                              "fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_fuel_specs",
                                "type": "object"
                              },
                              "non_fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_non_fuel_specs",
                                "type": "object"
                              },
                              "tax": {
                                "properties": {
                                  "local_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "national_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_tax_specs",
                                "type": "object"
                              }
                            },
                            "title": "fleet_reported_breakdown_specs",
                            "type": "object"
                          },
                          "service_type": {
                            "enum": [
                              "full_service",
                              "non_fuel_transaction",
                              "self_service"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "fleet_specs",
                        "type": "object"
                      },
                      "flight": {
                        "properties": {
                          "departure_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "passenger_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "refundable": {
                            "type": "boolean"
                          },
                          "segments": {
                            "items": {
                              "properties": {
                                "arrival_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "carrier": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "departure_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "flight_number": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "service_class": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "stopover_allowed": {
                                  "type": "boolean"
                                }
                              },
                              "title": "flight_segment_specs",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "travel_agency": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "flight_specs",
                        "type": "object"
                      },
                      "fuel": {
                        "properties": {
                          "industry_product_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "quantity_decimal": {
                            "format": "decimal",
                            "type": "string"
                          },
                          "type": {
                            "enum": [
                              "diesel",
                              "other",
                              "unleaded_plus",
                              "unleaded_regular",
                              "unleaded_super"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit": {
                            "enum": [
                              "charging_minute",
                              "imperial_gallon",
                              "kilogram",
                              "kilowatt_hour",
                              "liter",
                              "other",
                              "pound",
                              "us_gallon"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit_cost_decimal": {
                            "format": "decimal",
                            "type": "string"
                          }
                        },
                        "title": "fuel_specs",
                        "type": "object"
                      },
                      "lodging": {
                        "properties": {
                          "check_in_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "nights": {
                            "type": "integer"
                          }
                        },
                        "title": "lodging_specs",
                        "type": "object"
                      },
                      "receipt": {
                        "items": {
                          "properties": {
                            "description": {
                              "maxLength": 26,
                              "type": "string"
                            },
                            "quantity": {
                              "format": "decimal",
                              "type": "string"
                            },
                            "total": {
                              "type": "integer"
                            },
                            "unit_cost": {
                              "type": "integer"
                            }
                          },
                          "title": "receipt_specs",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "reference": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "purchase_details_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Capture a test-mode authorization"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/expire": {
      "post": {
        "description": "<p>Expire a test-mode Authorization.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Expire a test-mode authorization"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": {
      "post": {
        "description": "<p>Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fleet": {
                  "explode": true,
                  "style": "deepObject"
                },
                "fuel": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "final_amount": {
                    "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "fleet": {
                    "description": "Fleet-specific information for authorizations using Fleet cards.",
                    "properties": {
                      "cardholder_prompt_data": {
                        "properties": {
                          "driver_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "odometer": {
                            "type": "integer"
                          },
                          "unspecified_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "user_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "vehicle_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "fleet_cardholder_prompt_data_specs",
                        "type": "object"
                      },
                      "purchase_type": {
                        "enum": [
                          "fuel_and_non_fuel_purchase",
                          "fuel_purchase",
                          "non_fuel_purchase"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "reported_breakdown": {
                        "properties": {
                          "fuel": {
                            "properties": {
                              "gross_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_fuel_specs",
                            "type": "object"
                          },
                          "non_fuel": {
                            "properties": {
                              "gross_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_non_fuel_specs",
                            "type": "object"
                          },
                          "tax": {
                            "properties": {
                              "local_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              },
                              "national_amount_decimal": {
                                "format": "decimal",
                                "type": "string"
                              }
                            },
                            "title": "fleet_reported_breakdown_tax_specs",
                            "type": "object"
                          }
                        },
                        "title": "fleet_reported_breakdown_specs",
                        "type": "object"
                      },
                      "service_type": {
                        "enum": [
                          "full_service",
                          "non_fuel_transaction",
                          "self_service"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "fleet_specs",
                    "type": "object"
                  },
                  "fuel": {
                    "description": "Information about fuel that was purchased with this transaction.",
                    "properties": {
                      "industry_product_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "quantity_decimal": {
                        "format": "decimal",
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "diesel",
                          "other",
                          "unleaded_plus",
                          "unleaded_regular",
                          "unleaded_super"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "unit": {
                        "enum": [
                          "charging_minute",
                          "imperial_gallon",
                          "kilogram",
                          "kilowatt_hour",
                          "liter",
                          "other",
                          "pound",
                          "us_gallon"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "unit_cost_decimal": {
                        "format": "decimal",
                        "type": "string"
                      }
                    },
                    "title": "fuel_specs",
                    "type": "object"
                  }
                },
                "required": ["final_amount"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Finalize a test-mode authorization's amount"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond": {
      "post": {
        "description": "<p>Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "confirmed": {
                    "description": "Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).",
                    "type": "boolean"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["confirmed"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Respond to fraud challenge"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/increment": {
      "post": {
        "description": "<p>Increment a test-mode Authorization.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "increment_amount": {
                    "description": "The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "is_amount_controllable": {
                    "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.",
                    "type": "boolean"
                  }
                },
                "required": ["increment_amount"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Increment a test-mode authorization"
      }
    },
    "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": {
      "post": {
        "description": "<p>Reverse a test-mode Authorization.</p>",
        "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse",
        "parameters": [
          {
            "in": "path",
            "name": "authorization",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "reverse_amount": {
                    "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.authorization"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reverse a test-mode authorization"
      }
    },
    "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": {
      "post": {
        "description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>delivered</code>.</p>",
        "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Deliver a testmode card"
      }
    },
    "/v1/test_helpers/issuing/cards/{card}/shipping/fail": {
      "post": {
        "description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>failure</code>.</p>",
        "operationId": "PostTestHelpersIssuingCardsCardShippingFail",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Fail a testmode card"
      }
    },
    "/v1/test_helpers/issuing/cards/{card}/shipping/return": {
      "post": {
        "description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>returned</code>.</p>",
        "operationId": "PostTestHelpersIssuingCardsCardShippingReturn",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Return a testmode card"
      }
    },
    "/v1/test_helpers/issuing/cards/{card}/shipping/ship": {
      "post": {
        "description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>shipped</code>.</p>",
        "operationId": "PostTestHelpersIssuingCardsCardShippingShip",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Ship a testmode card"
      }
    },
    "/v1/test_helpers/issuing/cards/{card}/shipping/submit": {
      "post": {
        "description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>submitted</code>. This method requires Stripe Version ‘2024-09-30.acacia’ or later.</p>",
        "operationId": "PostTestHelpersIssuingCardsCardShippingSubmit",
        "parameters": [
          {
            "in": "path",
            "name": "card",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.card"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Submit a testmode card"
      }
    },
    "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": {
      "post": {
        "description": "<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>active</code>.</p>",
        "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate",
        "parameters": [
          {
            "in": "path",
            "name": "personalization_design",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Activate a testmode personalization design"
      }
    },
    "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": {
      "post": {
        "description": "<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>inactive</code>.</p>",
        "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate",
        "parameters": [
          {
            "in": "path",
            "name": "personalization_design",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Deactivate a testmode personalization design"
      }
    },
    "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": {
      "post": {
        "description": "<p>Updates the <code>status</code> of the specified testmode personalization design object to <code>rejected</code>.</p>",
        "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject",
        "parameters": [
          {
            "in": "path",
            "name": "personalization_design",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "rejection_reasons": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "rejection_reasons": {
                    "description": "The reason(s) the personalization design was rejected.",
                    "properties": {
                      "card_logo": {
                        "items": {
                          "enum": [
                            "geographic_location",
                            "inappropriate",
                            "network_name",
                            "non_binary_image",
                            "non_fiat_currency",
                            "other",
                            "other_entity",
                            "promotional_material"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "carrier_text": {
                        "items": {
                          "enum": [
                            "geographic_location",
                            "inappropriate",
                            "network_name",
                            "non_fiat_currency",
                            "other",
                            "other_entity",
                            "promotional_material"
                          ],
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "title": "rejection_reasons_param",
                    "type": "object"
                  }
                },
                "required": ["rejection_reasons"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.personalization_design"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Reject a testmode personalization design"
      }
    },
    "/v1/test_helpers/issuing/settlements": {
      "post": {
        "description": "<p>Allows the user to create an Issuing settlement.</p>",
        "operationId": "PostTestHelpersIssuingSettlements",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "bin": {
                    "description": "The Bank Identification Number reflecting this settlement record.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "clearing_date": {
                    "description": "The date that the transactions are cleared and posted to user's accounts.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "interchange_fees": {
                    "description": "The total interchange received as reimbursement for the transactions.",
                    "type": "integer"
                  },
                  "net_total": {
                    "description": "The total net amount required to settle with the network.",
                    "type": "integer"
                  },
                  "network_settlement_identifier": {
                    "description": "The Settlement Identification Number assigned by the network.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "transaction_count": {
                    "description": "The total number of transactions reflected in this settlement.",
                    "type": "integer"
                  },
                  "transaction_volume": {
                    "description": "The total transaction amount reflected in this settlement.",
                    "type": "integer"
                  }
                },
                "required": ["bin", "clearing_date", "currency", "net_total"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.settlement"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test-mode settleemnt"
      }
    },
    "/v1/test_helpers/issuing/settlements/{settlement}/complete": {
      "post": {
        "description": "<p>Allows the user to mark an Issuing settlement as complete.</p>",
        "operationId": "PostTestHelpersIssuingSettlementsSettlementComplete",
        "parameters": [
          {
            "description": "The settlement token to mark as complete.",
            "in": "path",
            "name": "settlement",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.settlement"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Complete a test-mode settlement"
      }
    },
    "/v1/test_helpers/issuing/transactions/create_force_capture": {
      "post": {
        "description": "<p>Allows the user to capture an arbitrary amount, also known as a forced capture.</p>",
        "operationId": "PostTestHelpersIssuingTransactionsCreateForceCapture",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "merchant_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "purchase_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "card": {
                    "description": "Card associated with this transaction.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "merchant_data": {
                    "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
                    "properties": {
                      "category": {
                        "enum": [
                          "ac_refrigeration_repair",
                          "accounting_bookkeeping_services",
                          "advertising_services",
                          "agricultural_cooperative",
                          "airlines_air_carriers",
                          "airports_flying_fields",
                          "ambulance_services",
                          "amusement_parks_carnivals",
                          "antique_reproductions",
                          "antique_shops",
                          "aquariums",
                          "architectural_surveying_services",
                          "art_dealers_and_galleries",
                          "artists_supply_and_craft_shops",
                          "auto_and_home_supply_stores",
                          "auto_body_repair_shops",
                          "auto_paint_shops",
                          "auto_service_shops",
                          "automated_cash_disburse",
                          "automated_fuel_dispensers",
                          "automobile_associations",
                          "automotive_parts_and_accessories_stores",
                          "automotive_tire_stores",
                          "bail_and_bond_payments",
                          "bakeries",
                          "bands_orchestras",
                          "barber_and_beauty_shops",
                          "betting_casino_gambling",
                          "bicycle_shops",
                          "billiard_pool_establishments",
                          "boat_dealers",
                          "boat_rentals_and_leases",
                          "book_stores",
                          "books_periodicals_and_newspapers",
                          "bowling_alleys",
                          "bus_lines",
                          "business_secretarial_schools",
                          "buying_shopping_services",
                          "cable_satellite_and_other_pay_television_and_radio",
                          "camera_and_photographic_supply_stores",
                          "candy_nut_and_confectionery_stores",
                          "car_and_truck_dealers_new_used",
                          "car_and_truck_dealers_used_only",
                          "car_rental_agencies",
                          "car_washes",
                          "carpentry_services",
                          "carpet_upholstery_cleaning",
                          "caterers",
                          "charitable_and_social_service_organizations_fundraising",
                          "chemicals_and_allied_products",
                          "child_care_services",
                          "childrens_and_infants_wear_stores",
                          "chiropodists_podiatrists",
                          "chiropractors",
                          "cigar_stores_and_stands",
                          "civic_social_fraternal_associations",
                          "cleaning_and_maintenance",
                          "clothing_rental",
                          "colleges_universities",
                          "commercial_equipment",
                          "commercial_footwear",
                          "commercial_photography_art_and_graphics",
                          "commuter_transport_and_ferries",
                          "computer_network_services",
                          "computer_programming",
                          "computer_repair",
                          "computer_software_stores",
                          "computers_peripherals_and_software",
                          "concrete_work_services",
                          "construction_materials",
                          "consulting_public_relations",
                          "correspondence_schools",
                          "cosmetic_stores",
                          "counseling_services",
                          "country_clubs",
                          "courier_services",
                          "court_costs",
                          "credit_reporting_agencies",
                          "cruise_lines",
                          "dairy_products_stores",
                          "dance_hall_studios_schools",
                          "dating_escort_services",
                          "dentists_orthodontists",
                          "department_stores",
                          "detective_agencies",
                          "digital_goods_applications",
                          "digital_goods_games",
                          "digital_goods_large_volume",
                          "digital_goods_media",
                          "direct_marketing_catalog_merchant",
                          "direct_marketing_combination_catalog_and_retail_merchant",
                          "direct_marketing_inbound_telemarketing",
                          "direct_marketing_insurance_services",
                          "direct_marketing_other",
                          "direct_marketing_outbound_telemarketing",
                          "direct_marketing_subscription",
                          "direct_marketing_travel",
                          "discount_stores",
                          "doctors",
                          "door_to_door_sales",
                          "drapery_window_covering_and_upholstery_stores",
                          "drinking_places",
                          "drug_stores_and_pharmacies",
                          "drugs_drug_proprietaries_and_druggist_sundries",
                          "dry_cleaners",
                          "durable_goods",
                          "duty_free_stores",
                          "eating_places_restaurants",
                          "educational_services",
                          "electric_razor_stores",
                          "electric_vehicle_charging",
                          "electrical_parts_and_equipment",
                          "electrical_services",
                          "electronics_repair_shops",
                          "electronics_stores",
                          "elementary_secondary_schools",
                          "emergency_services_gcas_visa_use_only",
                          "employment_temp_agencies",
                          "equipment_rental",
                          "exterminating_services",
                          "family_clothing_stores",
                          "fast_food_restaurants",
                          "financial_institutions",
                          "fines_government_administrative_entities",
                          "fireplace_fireplace_screens_and_accessories_stores",
                          "floor_covering_stores",
                          "florists",
                          "florists_supplies_nursery_stock_and_flowers",
                          "freezer_and_locker_meat_provisioners",
                          "fuel_dealers_non_automotive",
                          "funeral_services_crematories",
                          "furniture_home_furnishings_and_equipment_stores_except_appliances",
                          "furniture_repair_refinishing",
                          "furriers_and_fur_shops",
                          "general_services",
                          "gift_card_novelty_and_souvenir_shops",
                          "glass_paint_and_wallpaper_stores",
                          "glassware_crystal_stores",
                          "golf_courses_public",
                          "government_licensed_horse_dog_racing_us_region_only",
                          "government_licensed_online_casions_online_gambling_us_region_only",
                          "government_owned_lotteries_non_us_region",
                          "government_owned_lotteries_us_region_only",
                          "government_services",
                          "grocery_stores_supermarkets",
                          "hardware_equipment_and_supplies",
                          "hardware_stores",
                          "health_and_beauty_spas",
                          "hearing_aids_sales_and_supplies",
                          "heating_plumbing_a_c",
                          "hobby_toy_and_game_shops",
                          "home_supply_warehouse_stores",
                          "hospitals",
                          "hotels_motels_and_resorts",
                          "household_appliance_stores",
                          "industrial_supplies",
                          "information_retrieval_services",
                          "insurance_default",
                          "insurance_underwriting_premiums",
                          "intra_company_purchases",
                          "jewelry_stores_watches_clocks_and_silverware_stores",
                          "landscaping_services",
                          "laundries",
                          "laundry_cleaning_services",
                          "legal_services_attorneys",
                          "luggage_and_leather_goods_stores",
                          "lumber_building_materials_stores",
                          "manual_cash_disburse",
                          "marinas_service_and_supplies",
                          "marketplaces",
                          "masonry_stonework_and_plaster",
                          "massage_parlors",
                          "medical_and_dental_labs",
                          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                          "medical_services",
                          "membership_organizations",
                          "mens_and_boys_clothing_and_accessories_stores",
                          "mens_womens_clothing_stores",
                          "metal_service_centers",
                          "miscellaneous_apparel_and_accessory_shops",
                          "miscellaneous_auto_dealers",
                          "miscellaneous_business_services",
                          "miscellaneous_food_stores",
                          "miscellaneous_general_merchandise",
                          "miscellaneous_general_services",
                          "miscellaneous_home_furnishing_specialty_stores",
                          "miscellaneous_publishing_and_printing",
                          "miscellaneous_recreation_services",
                          "miscellaneous_repair_shops",
                          "miscellaneous_specialty_retail",
                          "mobile_home_dealers",
                          "motion_picture_theaters",
                          "motor_freight_carriers_and_trucking",
                          "motor_homes_dealers",
                          "motor_vehicle_supplies_and_new_parts",
                          "motorcycle_shops_and_dealers",
                          "motorcycle_shops_dealers",
                          "music_stores_musical_instruments_pianos_and_sheet_music",
                          "news_dealers_and_newsstands",
                          "non_fi_money_orders",
                          "non_fi_stored_value_card_purchase_load",
                          "nondurable_goods",
                          "nurseries_lawn_and_garden_supply_stores",
                          "nursing_personal_care",
                          "office_and_commercial_furniture",
                          "opticians_eyeglasses",
                          "optometrists_ophthalmologist",
                          "orthopedic_goods_prosthetic_devices",
                          "osteopaths",
                          "package_stores_beer_wine_and_liquor",
                          "paints_varnishes_and_supplies",
                          "parking_lots_garages",
                          "passenger_railways",
                          "pawn_shops",
                          "pet_shops_pet_food_and_supplies",
                          "petroleum_and_petroleum_products",
                          "photo_developing",
                          "photographic_photocopy_microfilm_equipment_and_supplies",
                          "photographic_studios",
                          "picture_video_production",
                          "piece_goods_notions_and_other_dry_goods",
                          "plumbing_heating_equipment_and_supplies",
                          "political_organizations",
                          "postal_services_government_only",
                          "precious_stones_and_metals_watches_and_jewelry",
                          "professional_services",
                          "public_warehousing_and_storage",
                          "quick_copy_repro_and_blueprint",
                          "railroads",
                          "real_estate_agents_and_managers_rentals",
                          "record_stores",
                          "recreational_vehicle_rentals",
                          "religious_goods_stores",
                          "religious_organizations",
                          "roofing_siding_sheet_metal",
                          "secretarial_support_services",
                          "security_brokers_dealers",
                          "service_stations",
                          "sewing_needlework_fabric_and_piece_goods_stores",
                          "shoe_repair_hat_cleaning",
                          "shoe_stores",
                          "small_appliance_repair",
                          "snowmobile_dealers",
                          "special_trade_services",
                          "specialty_cleaning",
                          "sporting_goods_stores",
                          "sporting_recreation_camps",
                          "sports_and_riding_apparel_stores",
                          "sports_clubs_fields",
                          "stamp_and_coin_stores",
                          "stationary_office_supplies_printing_and_writing_paper",
                          "stationery_stores_office_and_school_supply_stores",
                          "swimming_pools_sales",
                          "t_ui_travel_germany",
                          "tailors_alterations",
                          "tax_payments_government_agencies",
                          "tax_preparation_services",
                          "taxicabs_limousines",
                          "telecommunication_equipment_and_telephone_sales",
                          "telecommunication_services",
                          "telegraph_services",
                          "tent_and_awning_shops",
                          "testing_laboratories",
                          "theatrical_ticket_agencies",
                          "timeshares",
                          "tire_retreading_and_repair",
                          "tolls_bridge_fees",
                          "tourist_attractions_and_exhibits",
                          "towing_services",
                          "trailer_parks_campgrounds",
                          "transportation_services",
                          "travel_agencies_tour_operators",
                          "truck_stop_iteration",
                          "truck_utility_trailer_rentals",
                          "typesetting_plate_making_and_related_services",
                          "typewriter_stores",
                          "u_s_federal_government_agencies_or_departments",
                          "uniforms_commercial_clothing",
                          "used_merchandise_and_secondhand_stores",
                          "utilities",
                          "variety_stores",
                          "veterinary_services",
                          "video_amusement_game_supplies",
                          "video_game_arcades",
                          "video_tape_rental_stores",
                          "vocational_trade_schools",
                          "watch_jewelry_repair",
                          "welding_repair",
                          "wholesale_clubs",
                          "wig_and_toupee_stores",
                          "wires_money_orders",
                          "womens_accessory_and_specialty_shops",
                          "womens_ready_to_wear_stores",
                          "wrecking_and_salvage_yards"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "network_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "terminal_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "url": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "merchant_data_specs",
                    "type": "object"
                  },
                  "purchase_details": {
                    "description": "Additional purchase information that is optionally provided by the merchant.",
                    "properties": {
                      "fleet": {
                        "properties": {
                          "cardholder_prompt_data": {
                            "properties": {
                              "driver_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "odometer": {
                                "type": "integer"
                              },
                              "unspecified_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "user_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "vehicle_number": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "fleet_cardholder_prompt_data_specs",
                            "type": "object"
                          },
                          "purchase_type": {
                            "enum": [
                              "fuel_and_non_fuel_purchase",
                              "fuel_purchase",
                              "non_fuel_purchase"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "reported_breakdown": {
                            "properties": {
                              "fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_fuel_specs",
                                "type": "object"
                              },
                              "non_fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_non_fuel_specs",
                                "type": "object"
                              },
                              "tax": {
                                "properties": {
                                  "local_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "national_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_tax_specs",
                                "type": "object"
                              }
                            },
                            "title": "fleet_reported_breakdown_specs",
                            "type": "object"
                          },
                          "service_type": {
                            "enum": [
                              "full_service",
                              "non_fuel_transaction",
                              "self_service"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "fleet_specs",
                        "type": "object"
                      },
                      "flight": {
                        "properties": {
                          "departure_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "passenger_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "refundable": {
                            "type": "boolean"
                          },
                          "segments": {
                            "items": {
                              "properties": {
                                "arrival_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "carrier": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "departure_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "flight_number": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "service_class": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "stopover_allowed": {
                                  "type": "boolean"
                                }
                              },
                              "title": "flight_segment_specs",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "travel_agency": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "flight_specs",
                        "type": "object"
                      },
                      "fuel": {
                        "properties": {
                          "industry_product_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "quantity_decimal": {
                            "format": "decimal",
                            "type": "string"
                          },
                          "type": {
                            "enum": [
                              "diesel",
                              "other",
                              "unleaded_plus",
                              "unleaded_regular",
                              "unleaded_super"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit": {
                            "enum": [
                              "charging_minute",
                              "imperial_gallon",
                              "kilogram",
                              "kilowatt_hour",
                              "liter",
                              "other",
                              "pound",
                              "us_gallon"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit_cost_decimal": {
                            "format": "decimal",
                            "type": "string"
                          }
                        },
                        "title": "fuel_specs",
                        "type": "object"
                      },
                      "lodging": {
                        "properties": {
                          "check_in_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "nights": {
                            "type": "integer"
                          }
                        },
                        "title": "lodging_specs",
                        "type": "object"
                      },
                      "receipt": {
                        "items": {
                          "properties": {
                            "description": {
                              "maxLength": 26,
                              "type": "string"
                            },
                            "quantity": {
                              "format": "decimal",
                              "type": "string"
                            },
                            "total": {
                              "type": "integer"
                            },
                            "unit_cost": {
                              "type": "integer"
                            }
                          },
                          "title": "receipt_specs",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "reference": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "purchase_details_specs",
                    "type": "object"
                  }
                },
                "required": ["amount", "card"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test-mode force capture"
      }
    },
    "/v1/test_helpers/issuing/transactions/create_unlinked_refund": {
      "post": {
        "description": "<p>Allows the user to refund an arbitrary amount, also known as a unlinked refund.</p>",
        "operationId": "PostTestHelpersIssuingTransactionsCreateUnlinkedRefund",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "merchant_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "purchase_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  },
                  "card": {
                    "description": "Card associated with this unlinked refund transaction.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "currency": {
                    "description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "merchant_data": {
                    "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
                    "properties": {
                      "category": {
                        "enum": [
                          "ac_refrigeration_repair",
                          "accounting_bookkeeping_services",
                          "advertising_services",
                          "agricultural_cooperative",
                          "airlines_air_carriers",
                          "airports_flying_fields",
                          "ambulance_services",
                          "amusement_parks_carnivals",
                          "antique_reproductions",
                          "antique_shops",
                          "aquariums",
                          "architectural_surveying_services",
                          "art_dealers_and_galleries",
                          "artists_supply_and_craft_shops",
                          "auto_and_home_supply_stores",
                          "auto_body_repair_shops",
                          "auto_paint_shops",
                          "auto_service_shops",
                          "automated_cash_disburse",
                          "automated_fuel_dispensers",
                          "automobile_associations",
                          "automotive_parts_and_accessories_stores",
                          "automotive_tire_stores",
                          "bail_and_bond_payments",
                          "bakeries",
                          "bands_orchestras",
                          "barber_and_beauty_shops",
                          "betting_casino_gambling",
                          "bicycle_shops",
                          "billiard_pool_establishments",
                          "boat_dealers",
                          "boat_rentals_and_leases",
                          "book_stores",
                          "books_periodicals_and_newspapers",
                          "bowling_alleys",
                          "bus_lines",
                          "business_secretarial_schools",
                          "buying_shopping_services",
                          "cable_satellite_and_other_pay_television_and_radio",
                          "camera_and_photographic_supply_stores",
                          "candy_nut_and_confectionery_stores",
                          "car_and_truck_dealers_new_used",
                          "car_and_truck_dealers_used_only",
                          "car_rental_agencies",
                          "car_washes",
                          "carpentry_services",
                          "carpet_upholstery_cleaning",
                          "caterers",
                          "charitable_and_social_service_organizations_fundraising",
                          "chemicals_and_allied_products",
                          "child_care_services",
                          "childrens_and_infants_wear_stores",
                          "chiropodists_podiatrists",
                          "chiropractors",
                          "cigar_stores_and_stands",
                          "civic_social_fraternal_associations",
                          "cleaning_and_maintenance",
                          "clothing_rental",
                          "colleges_universities",
                          "commercial_equipment",
                          "commercial_footwear",
                          "commercial_photography_art_and_graphics",
                          "commuter_transport_and_ferries",
                          "computer_network_services",
                          "computer_programming",
                          "computer_repair",
                          "computer_software_stores",
                          "computers_peripherals_and_software",
                          "concrete_work_services",
                          "construction_materials",
                          "consulting_public_relations",
                          "correspondence_schools",
                          "cosmetic_stores",
                          "counseling_services",
                          "country_clubs",
                          "courier_services",
                          "court_costs",
                          "credit_reporting_agencies",
                          "cruise_lines",
                          "dairy_products_stores",
                          "dance_hall_studios_schools",
                          "dating_escort_services",
                          "dentists_orthodontists",
                          "department_stores",
                          "detective_agencies",
                          "digital_goods_applications",
                          "digital_goods_games",
                          "digital_goods_large_volume",
                          "digital_goods_media",
                          "direct_marketing_catalog_merchant",
                          "direct_marketing_combination_catalog_and_retail_merchant",
                          "direct_marketing_inbound_telemarketing",
                          "direct_marketing_insurance_services",
                          "direct_marketing_other",
                          "direct_marketing_outbound_telemarketing",
                          "direct_marketing_subscription",
                          "direct_marketing_travel",
                          "discount_stores",
                          "doctors",
                          "door_to_door_sales",
                          "drapery_window_covering_and_upholstery_stores",
                          "drinking_places",
                          "drug_stores_and_pharmacies",
                          "drugs_drug_proprietaries_and_druggist_sundries",
                          "dry_cleaners",
                          "durable_goods",
                          "duty_free_stores",
                          "eating_places_restaurants",
                          "educational_services",
                          "electric_razor_stores",
                          "electric_vehicle_charging",
                          "electrical_parts_and_equipment",
                          "electrical_services",
                          "electronics_repair_shops",
                          "electronics_stores",
                          "elementary_secondary_schools",
                          "emergency_services_gcas_visa_use_only",
                          "employment_temp_agencies",
                          "equipment_rental",
                          "exterminating_services",
                          "family_clothing_stores",
                          "fast_food_restaurants",
                          "financial_institutions",
                          "fines_government_administrative_entities",
                          "fireplace_fireplace_screens_and_accessories_stores",
                          "floor_covering_stores",
                          "florists",
                          "florists_supplies_nursery_stock_and_flowers",
                          "freezer_and_locker_meat_provisioners",
                          "fuel_dealers_non_automotive",
                          "funeral_services_crematories",
                          "furniture_home_furnishings_and_equipment_stores_except_appliances",
                          "furniture_repair_refinishing",
                          "furriers_and_fur_shops",
                          "general_services",
                          "gift_card_novelty_and_souvenir_shops",
                          "glass_paint_and_wallpaper_stores",
                          "glassware_crystal_stores",
                          "golf_courses_public",
                          "government_licensed_horse_dog_racing_us_region_only",
                          "government_licensed_online_casions_online_gambling_us_region_only",
                          "government_owned_lotteries_non_us_region",
                          "government_owned_lotteries_us_region_only",
                          "government_services",
                          "grocery_stores_supermarkets",
                          "hardware_equipment_and_supplies",
                          "hardware_stores",
                          "health_and_beauty_spas",
                          "hearing_aids_sales_and_supplies",
                          "heating_plumbing_a_c",
                          "hobby_toy_and_game_shops",
                          "home_supply_warehouse_stores",
                          "hospitals",
                          "hotels_motels_and_resorts",
                          "household_appliance_stores",
                          "industrial_supplies",
                          "information_retrieval_services",
                          "insurance_default",
                          "insurance_underwriting_premiums",
                          "intra_company_purchases",
                          "jewelry_stores_watches_clocks_and_silverware_stores",
                          "landscaping_services",
                          "laundries",
                          "laundry_cleaning_services",
                          "legal_services_attorneys",
                          "luggage_and_leather_goods_stores",
                          "lumber_building_materials_stores",
                          "manual_cash_disburse",
                          "marinas_service_and_supplies",
                          "marketplaces",
                          "masonry_stonework_and_plaster",
                          "massage_parlors",
                          "medical_and_dental_labs",
                          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
                          "medical_services",
                          "membership_organizations",
                          "mens_and_boys_clothing_and_accessories_stores",
                          "mens_womens_clothing_stores",
                          "metal_service_centers",
                          "miscellaneous_apparel_and_accessory_shops",
                          "miscellaneous_auto_dealers",
                          "miscellaneous_business_services",
                          "miscellaneous_food_stores",
                          "miscellaneous_general_merchandise",
                          "miscellaneous_general_services",
                          "miscellaneous_home_furnishing_specialty_stores",
                          "miscellaneous_publishing_and_printing",
                          "miscellaneous_recreation_services",
                          "miscellaneous_repair_shops",
                          "miscellaneous_specialty_retail",
                          "mobile_home_dealers",
                          "motion_picture_theaters",
                          "motor_freight_carriers_and_trucking",
                          "motor_homes_dealers",
                          "motor_vehicle_supplies_and_new_parts",
                          "motorcycle_shops_and_dealers",
                          "motorcycle_shops_dealers",
                          "music_stores_musical_instruments_pianos_and_sheet_music",
                          "news_dealers_and_newsstands",
                          "non_fi_money_orders",
                          "non_fi_stored_value_card_purchase_load",
                          "nondurable_goods",
                          "nurseries_lawn_and_garden_supply_stores",
                          "nursing_personal_care",
                          "office_and_commercial_furniture",
                          "opticians_eyeglasses",
                          "optometrists_ophthalmologist",
                          "orthopedic_goods_prosthetic_devices",
                          "osteopaths",
                          "package_stores_beer_wine_and_liquor",
                          "paints_varnishes_and_supplies",
                          "parking_lots_garages",
                          "passenger_railways",
                          "pawn_shops",
                          "pet_shops_pet_food_and_supplies",
                          "petroleum_and_petroleum_products",
                          "photo_developing",
                          "photographic_photocopy_microfilm_equipment_and_supplies",
                          "photographic_studios",
                          "picture_video_production",
                          "piece_goods_notions_and_other_dry_goods",
                          "plumbing_heating_equipment_and_supplies",
                          "political_organizations",
                          "postal_services_government_only",
                          "precious_stones_and_metals_watches_and_jewelry",
                          "professional_services",
                          "public_warehousing_and_storage",
                          "quick_copy_repro_and_blueprint",
                          "railroads",
                          "real_estate_agents_and_managers_rentals",
                          "record_stores",
                          "recreational_vehicle_rentals",
                          "religious_goods_stores",
                          "religious_organizations",
                          "roofing_siding_sheet_metal",
                          "secretarial_support_services",
                          "security_brokers_dealers",
                          "service_stations",
                          "sewing_needlework_fabric_and_piece_goods_stores",
                          "shoe_repair_hat_cleaning",
                          "shoe_stores",
                          "small_appliance_repair",
                          "snowmobile_dealers",
                          "special_trade_services",
                          "specialty_cleaning",
                          "sporting_goods_stores",
                          "sporting_recreation_camps",
                          "sports_and_riding_apparel_stores",
                          "sports_clubs_fields",
                          "stamp_and_coin_stores",
                          "stationary_office_supplies_printing_and_writing_paper",
                          "stationery_stores_office_and_school_supply_stores",
                          "swimming_pools_sales",
                          "t_ui_travel_germany",
                          "tailors_alterations",
                          "tax_payments_government_agencies",
                          "tax_preparation_services",
                          "taxicabs_limousines",
                          "telecommunication_equipment_and_telephone_sales",
                          "telecommunication_services",
                          "telegraph_services",
                          "tent_and_awning_shops",
                          "testing_laboratories",
                          "theatrical_ticket_agencies",
                          "timeshares",
                          "tire_retreading_and_repair",
                          "tolls_bridge_fees",
                          "tourist_attractions_and_exhibits",
                          "towing_services",
                          "trailer_parks_campgrounds",
                          "transportation_services",
                          "travel_agencies_tour_operators",
                          "truck_stop_iteration",
                          "truck_utility_trailer_rentals",
                          "typesetting_plate_making_and_related_services",
                          "typewriter_stores",
                          "u_s_federal_government_agencies_or_departments",
                          "uniforms_commercial_clothing",
                          "used_merchandise_and_secondhand_stores",
                          "utilities",
                          "variety_stores",
                          "veterinary_services",
                          "video_amusement_game_supplies",
                          "video_game_arcades",
                          "video_tape_rental_stores",
                          "vocational_trade_schools",
                          "watch_jewelry_repair",
                          "welding_repair",
                          "wholesale_clubs",
                          "wig_and_toupee_stores",
                          "wires_money_orders",
                          "womens_accessory_and_specialty_shops",
                          "womens_ready_to_wear_stores",
                          "wrecking_and_salvage_yards"
                        ],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "city": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "network_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "postal_code": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "state": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "terminal_id": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "url": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "merchant_data_specs",
                    "type": "object"
                  },
                  "purchase_details": {
                    "description": "Additional purchase information that is optionally provided by the merchant.",
                    "properties": {
                      "fleet": {
                        "properties": {
                          "cardholder_prompt_data": {
                            "properties": {
                              "driver_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "odometer": {
                                "type": "integer"
                              },
                              "unspecified_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "user_id": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "vehicle_number": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "fleet_cardholder_prompt_data_specs",
                            "type": "object"
                          },
                          "purchase_type": {
                            "enum": [
                              "fuel_and_non_fuel_purchase",
                              "fuel_purchase",
                              "non_fuel_purchase"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "reported_breakdown": {
                            "properties": {
                              "fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_fuel_specs",
                                "type": "object"
                              },
                              "non_fuel": {
                                "properties": {
                                  "gross_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_non_fuel_specs",
                                "type": "object"
                              },
                              "tax": {
                                "properties": {
                                  "local_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  },
                                  "national_amount_decimal": {
                                    "format": "decimal",
                                    "type": "string"
                                  }
                                },
                                "title": "fleet_reported_breakdown_tax_specs",
                                "type": "object"
                              }
                            },
                            "title": "fleet_reported_breakdown_specs",
                            "type": "object"
                          },
                          "service_type": {
                            "enum": [
                              "full_service",
                              "non_fuel_transaction",
                              "self_service"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "fleet_specs",
                        "type": "object"
                      },
                      "flight": {
                        "properties": {
                          "departure_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "passenger_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "refundable": {
                            "type": "boolean"
                          },
                          "segments": {
                            "items": {
                              "properties": {
                                "arrival_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "carrier": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "departure_airport_code": {
                                  "maxLength": 3,
                                  "type": "string"
                                },
                                "flight_number": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "service_class": {
                                  "maxLength": 5000,
                                  "type": "string"
                                },
                                "stopover_allowed": {
                                  "type": "boolean"
                                }
                              },
                              "title": "flight_segment_specs",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "travel_agency": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "flight_specs",
                        "type": "object"
                      },
                      "fuel": {
                        "properties": {
                          "industry_product_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "quantity_decimal": {
                            "format": "decimal",
                            "type": "string"
                          },
                          "type": {
                            "enum": [
                              "diesel",
                              "other",
                              "unleaded_plus",
                              "unleaded_regular",
                              "unleaded_super"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit": {
                            "enum": [
                              "charging_minute",
                              "imperial_gallon",
                              "kilogram",
                              "kilowatt_hour",
                              "liter",
                              "other",
                              "pound",
                              "us_gallon"
                            ],
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "unit_cost_decimal": {
                            "format": "decimal",
                            "type": "string"
                          }
                        },
                        "title": "fuel_specs",
                        "type": "object"
                      },
                      "lodging": {
                        "properties": {
                          "check_in_at": {
                            "format": "unix-time",
                            "type": "integer"
                          },
                          "nights": {
                            "type": "integer"
                          }
                        },
                        "title": "lodging_specs",
                        "type": "object"
                      },
                      "receipt": {
                        "items": {
                          "properties": {
                            "description": {
                              "maxLength": 26,
                              "type": "string"
                            },
                            "quantity": {
                              "format": "decimal",
                              "type": "string"
                            },
                            "total": {
                              "type": "integer"
                            },
                            "unit_cost": {
                              "type": "integer"
                            }
                          },
                          "title": "receipt_specs",
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "reference": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "purchase_details_specs",
                    "type": "object"
                  }
                },
                "required": ["amount", "card"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test-mode unlinked refund"
      }
    },
    "/v1/test_helpers/issuing/transactions/{transaction}/refund": {
      "post": {
        "description": "<p>Refund a test-mode Transaction.</p>",
        "operationId": "PostTestHelpersIssuingTransactionsTransactionRefund",
        "parameters": [
          {
            "in": "path",
            "name": "transaction",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "refund_amount": {
                    "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
                    "type": "integer"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/issuing.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Refund a test-mode transaction"
      }
    },
    "/v1/test_helpers/refunds/{refund}/expire": {
      "post": {
        "description": "<p>Expire a refund with a status of <code>requires_action</code>.</p>",
        "operationId": "PostTestHelpersRefundsRefundExpire",
        "parameters": [
          {
            "in": "path",
            "name": "refund",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/refund"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Expire a pending refund."
      }
    },
    "/v1/test_helpers/terminal/readers/{reader}/present_payment_method": {
      "post": {
        "description": "<p>Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.</p>",
        "operationId": "PostTestHelpersTerminalReadersReaderPresentPaymentMethod",
        "parameters": [
          {
            "in": "path",
            "name": "reader",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "card_present": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "interac_present": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount_tip": {
                    "description": "Simulated on-reader tip amount.",
                    "type": "integer"
                  },
                  "card_present": {
                    "description": "Simulated data for the card_present payment method.",
                    "properties": {
                      "number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "card_present",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "interac_present": {
                    "description": "Simulated data for the interac_present payment method.",
                    "properties": {
                      "number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "interac_present",
                    "type": "object"
                  },
                  "type": {
                    "description": "Simulated payment type.",
                    "enum": ["card_present", "interac_present"],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/terminal.reader"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Simulate presenting a payment method"
      }
    },
    "/v1/test_helpers/test_clocks": {
      "get": {
        "description": "<p>Returns a list of your test clocks.</p>",
        "operationId": "GetTestHelpersTestClocks",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/test_helpers.test_clock"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/test_helpers/test_clocks",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "BillingClocksResourceBillingClockList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all test clocks"
      },
      "post": {
        "description": "<p>Creates a new test clock that can be attached to new customers and quotes.</p>",
        "operationId": "PostTestHelpersTestClocks",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "frozen_time": {
                    "description": "The initial frozen time for this test clock.",
                    "format": "unix-time",
                    "type": "integer"
                  },
                  "name": {
                    "description": "The name for this test clock.",
                    "maxLength": 300,
                    "type": "string"
                  }
                },
                "required": ["frozen_time"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a test clock"
      }
    },
    "/v1/test_helpers/test_clocks/{test_clock}": {
      "delete": {
        "description": "<p>Deletes a test clock.</p>",
        "operationId": "DeleteTestHelpersTestClocksTestClock",
        "parameters": [
          {
            "in": "path",
            "name": "test_clock",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_test_helpers.test_clock"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a test clock"
      },
      "get": {
        "description": "<p>Retrieves a test clock.</p>",
        "operationId": "GetTestHelpersTestClocksTestClock",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "test_clock",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a test clock"
      }
    },
    "/v1/test_helpers/test_clocks/{test_clock}/advance": {
      "post": {
        "description": "<p>Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to <code>Ready</code>.</p>",
        "operationId": "PostTestHelpersTestClocksTestClockAdvance",
        "parameters": [
          {
            "in": "path",
            "name": "test_clock",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "frozen_time": {
                    "description": "The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.",
                    "format": "unix-time",
                    "type": "integer"
                  }
                },
                "required": ["frozen_time"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/test_helpers.test_clock"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Advance a test clock"
      }
    },
    "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": {
      "post": {
        "description": "<p>Transitions a test mode created InboundTransfer to the <code>failed</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "failure_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "failure_details": {
                    "description": "Details about a failed InboundTransfer.",
                    "properties": {
                      "code": {
                        "enum": [
                          "account_closed",
                          "account_frozen",
                          "bank_account_restricted",
                          "bank_ownership_changed",
                          "debit_not_authorized",
                          "incorrect_account_holder_address",
                          "incorrect_account_holder_name",
                          "incorrect_account_holder_tax_id",
                          "insufficient_funds",
                          "invalid_account_number",
                          "invalid_currency",
                          "no_account",
                          "other"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "failure_details_param",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Fail an InboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/inbound_transfers/{id}/return": {
      "post": {
        "description": "<p>Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the <code>succeeded</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Return an InboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": {
      "post": {
        "description": "<p>Transitions a test mode created InboundTransfer to the <code>succeeded</code> status. The InboundTransfer must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Succeed an InboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/outbound_payments/{id}": {
      "post": {
        "description": "<p>Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the <code>canceled</code> or <code>failed</code> states.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundPaymentsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tracking_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "tracking_details": {
                    "description": "Details about network-specific tracking information.",
                    "properties": {
                      "ach": {
                        "properties": {
                          "trace_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["trace_id"],
                        "title": "ach_tracking_details_params",
                        "type": "object"
                      },
                      "type": {
                        "enum": ["ach", "us_domestic_wire"],
                        "type": "string"
                      },
                      "us_domestic_wire": {
                        "properties": {
                          "chips": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "imad": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "omad": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "us_domestic_wire_tracking_details_params",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "tracking_details_params",
                    "type": "object"
                  }
                },
                "required": ["tracking_details"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Update an OutboundPayment"
      }
    },
    "/v1/test_helpers/treasury/outbound_payments/{id}/fail": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundPayment to the <code>failed</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Fail an OutboundPayment"
      }
    },
    "/v1/test_helpers/treasury/outbound_payments/{id}/post": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundPayment to the <code>posted</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Post an OutboundPayment"
      }
    },
    "/v1/test_helpers/treasury/outbound_payments/{id}/return": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundPayment to the <code>returned</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "returned_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "returned_details": {
                    "description": "Optional hash to set the return code.",
                    "properties": {
                      "code": {
                        "enum": [
                          "account_closed",
                          "account_frozen",
                          "bank_account_restricted",
                          "bank_ownership_changed",
                          "declined",
                          "incorrect_account_holder_name",
                          "invalid_account_number",
                          "invalid_currency",
                          "no_account",
                          "other"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "returned_details_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Return an OutboundPayment"
      }
    },
    "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": {
      "post": {
        "description": "<p>Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the <code>canceled</code> or <code>failed</code> states.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer",
        "parameters": [
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "tracking_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "tracking_details": {
                    "description": "Details about network-specific tracking information.",
                    "properties": {
                      "ach": {
                        "properties": {
                          "trace_id": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["trace_id"],
                        "title": "ach_tracking_details_params",
                        "type": "object"
                      },
                      "type": {
                        "enum": ["ach", "us_domestic_wire"],
                        "type": "string"
                      },
                      "us_domestic_wire": {
                        "properties": {
                          "chips": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "imad": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "omad": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "us_domestic_wire_tracking_details_params",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "tracking_details_params",
                    "type": "object"
                  }
                },
                "required": ["tracking_details"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Update an OutboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundTransfer to the <code>failed</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail",
        "parameters": [
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Fail an OutboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundTransfer to the <code>posted</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost",
        "parameters": [
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Post an OutboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return": {
      "post": {
        "description": "<p>Transitions a test mode created OutboundTransfer to the <code>returned</code> status. The OutboundTransfer must already be in the <code>processing</code> state.</p>",
        "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn",
        "parameters": [
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "returned_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "returned_details": {
                    "description": "Details about a returned OutboundTransfer.",
                    "properties": {
                      "code": {
                        "enum": [
                          "account_closed",
                          "account_frozen",
                          "bank_account_restricted",
                          "bank_ownership_changed",
                          "declined",
                          "incorrect_account_holder_name",
                          "invalid_account_number",
                          "invalid_currency",
                          "no_account",
                          "other"
                        ],
                        "type": "string"
                      }
                    },
                    "title": "returned_details_params",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Return an OutboundTransfer"
      }
    },
    "/v1/test_helpers/treasury/received_credits": {
      "post": {
        "description": "<p>Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.</p>",
        "operationId": "PostTestHelpersTreasuryReceivedCredits",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "initiating_payment_method_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount (in cents) to be transferred.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "description": "The FinancialAccount to send funds to.",
                    "type": "string"
                  },
                  "initiating_payment_method_details": {
                    "description": "Initiating payment method details for the object.",
                    "properties": {
                      "type": {
                        "enum": ["us_bank_account"],
                        "type": "string"
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "us_bank_account_source_params",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "source_params",
                    "type": "object"
                  },
                  "network": {
                    "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
                    "enum": ["ach", "us_domestic_wire"],
                    "type": "string"
                  }
                },
                "required": [
                  "amount",
                  "currency",
                  "financial_account",
                  "network"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.received_credit"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Create a ReceivedCredit"
      }
    },
    "/v1/test_helpers/treasury/received_debits": {
      "post": {
        "description": "<p>Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.</p>",
        "operationId": "PostTestHelpersTreasuryReceivedDebits",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "initiating_payment_method_details": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount (in cents) to be transferred.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "description": "The FinancialAccount to pull funds from.",
                    "type": "string"
                  },
                  "initiating_payment_method_details": {
                    "description": "Initiating payment method details for the object.",
                    "properties": {
                      "type": {
                        "enum": ["us_bank_account"],
                        "type": "string"
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "us_bank_account_source_params",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "source_params",
                    "type": "object"
                  },
                  "network": {
                    "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.",
                    "enum": ["ach"],
                    "type": "string"
                  }
                },
                "required": [
                  "amount",
                  "currency",
                  "financial_account",
                  "network"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.received_debit"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Test mode: Create a ReceivedDebit"
      }
    },
    "/v1/tokens": {
      "post": {
        "description": "<p>Creates a single-use token that represents a bank account’s details.\nYou can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a <a href=\"#accounts\">connected account</a> where <a href=\"/api/accounts/object#account_object-controller-requirement_collection\">controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts.</p>",
        "operationId": "PostTokens",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "bank_account": {
                  "explode": true,
                  "style": "deepObject"
                },
                "card": {
                  "explode": true,
                  "style": "deepObject"
                },
                "cvc_update": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "person": {
                  "explode": true,
                  "style": "deepObject"
                },
                "pii": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "account": {
                    "description": "Information for the account this token represents.",
                    "properties": {
                      "business_type": {
                        "enum": [
                          "company",
                          "government_entity",
                          "individual",
                          "non_profit"
                        ],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "company": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 100,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "legal_entity_and_kyc_address_specs",
                            "type": "object"
                          },
                          "address_kana": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "town": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "japan_address_kana_specs",
                            "type": "object"
                          },
                          "address_kanji": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "town": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "japan_address_kanji_specs",
                            "type": "object"
                          },
                          "directors_provided": {
                            "type": "boolean"
                          },
                          "directorship_declaration": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "company_directorship_declaration",
                            "type": "object"
                          },
                          "executives_provided": {
                            "type": "boolean"
                          },
                          "export_license_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "export_purpose_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "name_kana": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "name_kanji": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "owners_provided": {
                            "type": "boolean"
                          },
                          "ownership_declaration": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "company_ownership_declaration",
                            "type": "object"
                          },
                          "ownership_declaration_shown_and_signed": {
                            "type": "boolean"
                          },
                          "ownership_exemption_reason": {
                            "enum": [
                              "",
                              "qualified_entity_exceeds_ownership_threshold",
                              "qualifies_as_financial_institution"
                            ],
                            "type": "string"
                          },
                          "phone": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "registration_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "structure": {
                            "enum": [
                              "",
                              "free_zone_establishment",
                              "free_zone_llc",
                              "government_instrumentality",
                              "governmental_unit",
                              "incorporated_non_profit",
                              "incorporated_partnership",
                              "limited_liability_partnership",
                              "llc",
                              "multi_member_llc",
                              "private_company",
                              "private_corporation",
                              "private_partnership",
                              "public_company",
                              "public_corporation",
                              "public_partnership",
                              "registered_charity",
                              "single_member_llc",
                              "sole_establishment",
                              "sole_proprietorship",
                              "tax_exempt_government_instrumentality",
                              "unincorporated_association",
                              "unincorporated_non_profit",
                              "unincorporated_partnership"
                            ],
                            "type": "string",
                            "x-stripeBypassValidation": true
                          },
                          "tax_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "tax_id_registrar": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "vat_id": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "verification": {
                            "properties": {
                              "document": {
                                "properties": {
                                  "back": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "front": {
                                    "maxLength": 500,
                                    "type": "string"
                                  }
                                },
                                "title": "verification_document_specs",
                                "type": "object"
                              }
                            },
                            "title": "verification_specs",
                            "type": "object"
                          }
                        },
                        "title": "connect_js_account_token_company_specs",
                        "type": "object"
                      },
                      "individual": {
                        "properties": {
                          "address": {
                            "properties": {
                              "city": {
                                "maxLength": 100,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "address_specs",
                            "type": "object"
                          },
                          "address_kana": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "town": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "japan_address_kana_specs",
                            "type": "object"
                          },
                          "address_kanji": {
                            "properties": {
                              "city": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "town": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "japan_address_kanji_specs",
                            "type": "object"
                          },
                          "dob": {
                            "anyOf": [
                              {
                                "properties": {
                                  "day": {
                                    "type": "integer"
                                  },
                                  "month": {
                                    "type": "integer"
                                  },
                                  "year": {
                                    "type": "integer"
                                  }
                                },
                                "required": ["day", "month", "year"],
                                "title": "date_of_birth_specs",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "type": "string"
                          },
                          "first_name": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "first_name_kana": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "first_name_kanji": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "full_name_aliases": {
                            "anyOf": [
                              {
                                "items": {
                                  "maxLength": 300,
                                  "type": "string"
                                },
                                "type": "array"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "gender": {
                            "type": "string"
                          },
                          "id_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "id_number_secondary": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "last_name": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "last_name_kana": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "last_name_kanji": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "maiden_name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "metadata": {
                            "anyOf": [
                              {
                                "additionalProperties": {
                                  "type": "string"
                                },
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "type": "string"
                          },
                          "political_exposure": {
                            "enum": ["existing", "none"],
                            "type": "string"
                          },
                          "registered_address": {
                            "properties": {
                              "city": {
                                "maxLength": 100,
                                "type": "string"
                              },
                              "country": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "line1": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "line2": {
                                "maxLength": 200,
                                "type": "string"
                              },
                              "postal_code": {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              "state": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "address_specs",
                            "type": "object"
                          },
                          "relationship": {
                            "properties": {
                              "director": {
                                "type": "boolean"
                              },
                              "executive": {
                                "type": "boolean"
                              },
                              "owner": {
                                "type": "boolean"
                              },
                              "percent_ownership": {
                                "anyOf": [
                                  {
                                    "type": "number"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              },
                              "title": {
                                "maxLength": 5000,
                                "type": "string"
                              }
                            },
                            "title": "individual_relationship_specs",
                            "type": "object"
                          },
                          "ssn_last_4": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "verification": {
                            "properties": {
                              "additional_document": {
                                "properties": {
                                  "back": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "front": {
                                    "maxLength": 500,
                                    "type": "string"
                                  }
                                },
                                "title": "person_verification_document_specs",
                                "type": "object"
                              },
                              "document": {
                                "properties": {
                                  "back": {
                                    "maxLength": 500,
                                    "type": "string"
                                  },
                                  "front": {
                                    "maxLength": 500,
                                    "type": "string"
                                  }
                                },
                                "title": "person_verification_document_specs",
                                "type": "object"
                              }
                            },
                            "title": "person_verification_specs",
                            "type": "object"
                          }
                        },
                        "title": "individual_specs",
                        "type": "object"
                      },
                      "tos_shown_and_accepted": {
                        "type": "boolean"
                      }
                    },
                    "title": "connect_js_account_token_specs",
                    "type": "object"
                  },
                  "bank_account": {
                    "description": "The bank account this token will represent.",
                    "properties": {
                      "account_holder_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "account_holder_type": {
                        "enum": ["company", "individual"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "account_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "account_type": {
                        "enum": ["checking", "futsu", "savings", "toza"],
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "country": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "currency": {
                        "format": "currency",
                        "type": "string"
                      },
                      "payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "routing_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["account_number", "country"],
                    "title": "token_create_bank_account",
                    "type": "object",
                    "x-stripeBypassValidation": true
                  },
                  "card": {
                    "anyOf": [
                      {
                        "properties": {
                          "address_city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "address_zip": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "currency": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "cvc": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_month": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "exp_year": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "name": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "networks": {
                            "properties": {
                              "preferred": {
                                "enum": [
                                  "cartes_bancaires",
                                  "mastercard",
                                  "visa"
                                ],
                                "type": "string"
                              }
                            },
                            "title": "networks_param_specs",
                            "type": "object"
                          },
                          "number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "required": ["exp_month", "exp_year", "number"],
                        "title": "credit_card_specs",
                        "type": "object"
                      },
                      {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    ],
                    "description": "The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.",
                    "x-stripeBypassValidation": true
                  },
                  "customer": {
                    "description": "Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "cvc_update": {
                    "description": "The updated CVC value this token represents.",
                    "properties": {
                      "cvc": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "required": ["cvc"],
                    "title": "cvc_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "person": {
                    "description": "Information for the person this token represents.",
                    "properties": {
                      "additional_tos_acceptances": {
                        "properties": {
                          "account": {
                            "properties": {
                              "date": {
                                "format": "unix-time",
                                "type": "integer"
                              },
                              "ip": {
                                "type": "string"
                              },
                              "user_agent": {
                                "anyOf": [
                                  {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  {
                                    "enum": [""],
                                    "type": "string"
                                  }
                                ]
                              }
                            },
                            "title": "settings_terms_of_service_specs",
                            "type": "object"
                          }
                        },
                        "title": "person_additional_tos_acceptances_specs",
                        "type": "object"
                      },
                      "address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "legal_entity_and_kyc_address_specs",
                        "type": "object"
                      },
                      "address_kana": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kana_specs",
                        "type": "object"
                      },
                      "address_kanji": {
                        "properties": {
                          "city": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "town": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "japan_address_kanji_specs",
                        "type": "object"
                      },
                      "dob": {
                        "anyOf": [
                          {
                            "properties": {
                              "day": {
                                "type": "integer"
                              },
                              "month": {
                                "type": "integer"
                              },
                              "year": {
                                "type": "integer"
                              }
                            },
                            "required": ["day", "month", "year"],
                            "title": "date_of_birth_specs",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "documents": {
                        "properties": {
                          "company_authorization": {
                            "properties": {
                              "files": {
                                "items": {
                                  "anyOf": [
                                    {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    {
                                      "enum": [""],
                                      "type": "string"
                                    }
                                  ]
                                },
                                "type": "array"
                              }
                            },
                            "title": "documents_param",
                            "type": "object"
                          },
                          "passport": {
                            "properties": {
                              "files": {
                                "items": {
                                  "anyOf": [
                                    {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    {
                                      "enum": [""],
                                      "type": "string"
                                    }
                                  ]
                                },
                                "type": "array"
                              }
                            },
                            "title": "documents_param",
                            "type": "object"
                          },
                          "visa": {
                            "properties": {
                              "files": {
                                "items": {
                                  "anyOf": [
                                    {
                                      "maxLength": 500,
                                      "type": "string"
                                    },
                                    {
                                      "enum": [""],
                                      "type": "string"
                                    }
                                  ]
                                },
                                "type": "array"
                              }
                            },
                            "title": "documents_param",
                            "type": "object"
                          }
                        },
                        "title": "person_documents_specs",
                        "type": "object"
                      },
                      "email": {
                        "type": "string"
                      },
                      "first_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "first_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "first_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "full_name_aliases": {
                        "anyOf": [
                          {
                            "items": {
                              "maxLength": 5000,
                              "type": "string"
                            },
                            "type": "array"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "gender": {
                        "type": "string"
                      },
                      "id_number": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "id_number_secondary": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name_kana": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "last_name_kanji": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "maiden_name": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "metadata": {
                        "anyOf": [
                          {
                            "additionalProperties": {
                              "type": "string"
                            },
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      },
                      "nationality": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "phone": {
                        "type": "string"
                      },
                      "political_exposure": {
                        "enum": ["existing", "none"],
                        "type": "string"
                      },
                      "registered_address": {
                        "properties": {
                          "city": {
                            "maxLength": 100,
                            "type": "string"
                          },
                          "country": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "line1": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "line2": {
                            "maxLength": 200,
                            "type": "string"
                          },
                          "postal_code": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "state": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "address_specs",
                        "type": "object"
                      },
                      "relationship": {
                        "properties": {
                          "authorizer": {
                            "type": "boolean"
                          },
                          "director": {
                            "type": "boolean"
                          },
                          "executive": {
                            "type": "boolean"
                          },
                          "legal_guardian": {
                            "type": "boolean"
                          },
                          "owner": {
                            "type": "boolean"
                          },
                          "percent_ownership": {
                            "anyOf": [
                              {
                                "type": "number"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "representative": {
                            "type": "boolean"
                          },
                          "title": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "relationship_specs",
                        "type": "object"
                      },
                      "ssn_last_4": {
                        "type": "string"
                      },
                      "verification": {
                        "properties": {
                          "additional_document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          },
                          "document": {
                            "properties": {
                              "back": {
                                "maxLength": 500,
                                "type": "string"
                              },
                              "front": {
                                "maxLength": 500,
                                "type": "string"
                              }
                            },
                            "title": "person_verification_document_specs",
                            "type": "object"
                          }
                        },
                        "title": "person_verification_specs",
                        "type": "object"
                      }
                    },
                    "title": "person_token_specs",
                    "type": "object"
                  },
                  "pii": {
                    "description": "The PII this token represents.",
                    "properties": {
                      "id_number": {
                        "maxLength": 5000,
                        "type": "string"
                      }
                    },
                    "title": "pii_token_specs",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a CVC update token"
      }
    },
    "/v1/tokens/{token}": {
      "get": {
        "description": "<p>Retrieves the token with the given ID.</p>",
        "operationId": "GetTokensToken",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "token",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/token"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a token"
      }
    },
    "/v1/topups": {
      "get": {
        "description": "<p>Returns a list of top-ups.</p>",
        "operationId": "GetTopups",
        "parameters": [
          {
            "description": "A positive integer representing how much to transfer.",
            "explode": true,
            "in": "query",
            "name": "amount",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["canceled", "failed", "pending", "succeeded"],
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/topup"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/topups",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TopupList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all top-ups"
      },
      "post": {
        "description": "<p>Top up the balance of an account</p>",
        "operationId": "PostTopups",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer representing how much to transfer.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "source": {
                    "description": "The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "statement_descriptor": {
                    "description": "Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.",
                    "maxLength": 15,
                    "type": "string"
                  },
                  "transfer_group": {
                    "description": "A string that identifies this top-up as part of a group.",
                    "type": "string"
                  }
                },
                "required": ["amount", "currency"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/topup"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a top-up"
      }
    },
    "/v1/topups/{topup}": {
      "get": {
        "description": "<p>Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.</p>",
        "operationId": "GetTopupsTopup",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "topup",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/topup"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a top-up"
      },
      "post": {
        "description": "<p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>",
        "operationId": "PostTopupsTopup",
        "parameters": [
          {
            "in": "path",
            "name": "topup",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/topup"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a top-up"
      }
    },
    "/v1/topups/{topup}/cancel": {
      "post": {
        "description": "<p>Cancels a top-up. Only pending top-ups can be canceled.</p>",
        "operationId": "PostTopupsTopupCancel",
        "parameters": [
          {
            "in": "path",
            "name": "topup",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/topup"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel a top-up"
      }
    },
    "/v1/transfers": {
      "get": {
        "description": "<p>Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.</p>",
        "operationId": "GetTransfers",
        "parameters": [
          {
            "description": "Only return transfers that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return transfers for the destination specified by this account ID.",
            "in": "query",
            "name": "destination",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return transfers with the specified transfer group.",
            "in": "query",
            "name": "transfer_group",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/transfer"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/transfers",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TransferList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all transfers"
      },
      "post": {
        "description": "<p>To send funds from your Stripe account to a connected account, you create a new transfer object. Your <a href=\"#balance\">Stripe balance</a> must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.</p>",
        "operationId": "PostTransfers",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer in cents (or local equivalent) representing how much to transfer.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination": {
                    "description": "The ID of a connected Stripe account. <a href=\"/docs/connect/separate-charges-and-transfers\">See the Connect documentation</a> for details.",
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "source_transaction": {
                    "description": "You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.",
                    "type": "string"
                  },
                  "source_type": {
                    "description": "The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`.",
                    "enum": ["bank_account", "card", "fpx"],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "transfer_group": {
                    "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.",
                    "type": "string"
                  }
                },
                "required": ["currency", "destination"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a transfer"
      }
    },
    "/v1/transfers/{id}/reversals": {
      "get": {
        "description": "<p>You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p>",
        "operationId": "GetTransfersIdReversals",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/transfer_reversal"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TransferReversalList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all reversals"
      },
      "post": {
        "description": "<p>When you create a new reversal, you must specify a transfer to create it on.</p>\n\n<p>When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.</p>\n\n<p>Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.</p>",
        "operationId": "PostTransfersIdReversals",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.",
                    "type": "integer"
                  },
                  "description": {
                    "description": "An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "refund_application_fee": {
                    "description": "Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.",
                    "type": "boolean"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a transfer reversal"
      }
    },
    "/v1/transfers/{transfer}": {
      "get": {
        "description": "<p>Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.</p>",
        "operationId": "GetTransfersTransfer",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a transfer"
      },
      "post": {
        "description": "<p>Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>\n\n<p>This request accepts only metadata as an argument.</p>",
        "operationId": "PostTransfersTransfer",
        "parameters": [
          {
            "in": "path",
            "name": "transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a transfer"
      }
    },
    "/v1/transfers/{transfer}/reversals/{id}": {
      "get": {
        "description": "<p>By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.</p>",
        "operationId": "GetTransfersTransferReversalsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a reversal"
      },
      "post": {
        "description": "<p>Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>\n\n<p>This request only accepts metadata and description as arguments.</p>",
        "operationId": "PostTransfersTransferReversalsId",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "in": "path",
            "name": "transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/transfer_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a reversal"
      }
    },
    "/v1/treasury/credit_reversals": {
      "get": {
        "description": "<p>Returns a list of CreditReversals.</p>",
        "operationId": "GetTreasuryCreditReversals",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return CreditReversals for the ReceivedCredit ID.",
            "in": "query",
            "name": "received_credit",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return CreditReversals for a given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["canceled", "posted", "processing"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.credit_reversal"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryReceivedCreditsResourceCreditReversalList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all CreditReversals"
      },
      "post": {
        "description": "<p>Reverses a ReceivedCredit and creates a CreditReversal object.</p>",
        "operationId": "PostTreasuryCreditReversals",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "received_credit": {
                    "description": "The ReceivedCredit to reverse.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["received_credit"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.credit_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a CreditReversal"
      }
    },
    "/v1/treasury/credit_reversals/{credit_reversal}": {
      "get": {
        "description": "<p>Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list</p>",
        "operationId": "GetTreasuryCreditReversalsCreditReversal",
        "parameters": [
          {
            "in": "path",
            "name": "credit_reversal",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.credit_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a CreditReversal"
      }
    },
    "/v1/treasury/debit_reversals": {
      "get": {
        "description": "<p>Returns a list of DebitReversals.</p>",
        "operationId": "GetTreasuryDebitReversals",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return DebitReversals for the ReceivedDebit ID.",
            "in": "query",
            "name": "received_debit",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return DebitReversals for a given resolution.",
            "in": "query",
            "name": "resolution",
            "required": false,
            "schema": {
              "enum": ["lost", "won"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return DebitReversals for a given status.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["canceled", "completed", "processing"],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.debit_reversal"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryReceivedDebitsResourceDebitReversalList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all DebitReversals"
      },
      "post": {
        "description": "<p>Reverses a ReceivedDebit and creates a DebitReversal object.</p>",
        "operationId": "PostTreasuryDebitReversals",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "received_debit": {
                    "description": "The ReceivedDebit to reverse.",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["received_debit"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.debit_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a DebitReversal"
      }
    },
    "/v1/treasury/debit_reversals/{debit_reversal}": {
      "get": {
        "description": "<p>Retrieves a DebitReversal object.</p>",
        "operationId": "GetTreasuryDebitReversalsDebitReversal",
        "parameters": [
          {
            "in": "path",
            "name": "debit_reversal",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.debit_reversal"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a DebitReversal"
      }
    },
    "/v1/treasury/financial_accounts": {
      "get": {
        "description": "<p>Returns a list of FinancialAccounts.</p>",
        "operationId": "GetTreasuryFinancialAccounts",
        "parameters": [
          {
            "description": "Only return FinancialAccounts that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "An object ID cursor for use in pagination.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit ranging from 1 to 100 (defaults to 10).",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "An object ID cursor for use in pagination.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/treasury.financial_account"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/treasury/financial_accounts",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryFinancialAccountsResourceFinancialAccountList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all FinancialAccounts"
      },
      "post": {
        "description": "<p>Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.</p>",
        "operationId": "PostTreasuryFinancialAccounts",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "nickname": {
                  "explode": true,
                  "style": "deepObject"
                },
                "platform_restrictions": {
                  "explode": true,
                  "style": "deepObject"
                },
                "supported_currencies": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.",
                    "properties": {
                      "card_issuing": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "deposit_insurance": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "financial_addresses": {
                        "properties": {
                          "aba": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "aba_access",
                            "type": "object"
                          }
                        },
                        "title": "financial_addresses",
                        "type": "object"
                      },
                      "inbound_transfers": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          }
                        },
                        "title": "inbound_transfers",
                        "type": "object"
                      },
                      "intra_stripe_flows": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "outbound_payments": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          },
                          "us_domestic_wire": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access",
                            "type": "object"
                          }
                        },
                        "title": "outbound_payments",
                        "type": "object"
                      },
                      "outbound_transfers": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          },
                          "us_domestic_wire": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access",
                            "type": "object"
                          }
                        },
                        "title": "outbound_transfers",
                        "type": "object"
                      }
                    },
                    "title": "feature_access",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "nickname": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The nickname for the FinancialAccount."
                  },
                  "platform_restrictions": {
                    "description": "The set of functionalities that the platform can restrict on the FinancialAccount.",
                    "properties": {
                      "inbound_flows": {
                        "enum": ["restricted", "unrestricted"],
                        "type": "string"
                      },
                      "outbound_flows": {
                        "enum": ["restricted", "unrestricted"],
                        "type": "string"
                      }
                    },
                    "title": "platform_restrictions",
                    "type": "object"
                  },
                  "supported_currencies": {
                    "description": "The currencies the FinancialAccount can hold a balance in.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "required": ["supported_currencies"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a FinancialAccount"
      }
    },
    "/v1/treasury/financial_accounts/{financial_account}": {
      "get": {
        "description": "<p>Retrieves the details of a FinancialAccount.</p>",
        "operationId": "GetTreasuryFinancialAccountsFinancialAccount",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "financial_account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a FinancialAccount"
      },
      "post": {
        "description": "<p>Updates the details of a FinancialAccount.</p>",
        "operationId": "PostTreasuryFinancialAccountsFinancialAccount",
        "parameters": [
          {
            "in": "path",
            "name": "financial_account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "features": {
                  "explode": true,
                  "style": "deepObject"
                },
                "forwarding_settings": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                },
                "nickname": {
                  "explode": true,
                  "style": "deepObject"
                },
                "platform_restrictions": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "features": {
                    "description": "Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated `status_details`. Stripe or the platform may control features via the requested field.",
                    "properties": {
                      "card_issuing": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "deposit_insurance": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "financial_addresses": {
                        "properties": {
                          "aba": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "aba_access",
                            "type": "object"
                          }
                        },
                        "title": "financial_addresses",
                        "type": "object"
                      },
                      "inbound_transfers": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          }
                        },
                        "title": "inbound_transfers",
                        "type": "object"
                      },
                      "intra_stripe_flows": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      },
                      "outbound_payments": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          },
                          "us_domestic_wire": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access",
                            "type": "object"
                          }
                        },
                        "title": "outbound_payments",
                        "type": "object"
                      },
                      "outbound_transfers": {
                        "properties": {
                          "ach": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access_with_ach_details",
                            "type": "object"
                          },
                          "us_domestic_wire": {
                            "properties": {
                              "requested": {
                                "type": "boolean"
                              }
                            },
                            "required": ["requested"],
                            "title": "access",
                            "type": "object"
                          }
                        },
                        "title": "outbound_transfers",
                        "type": "object"
                      }
                    },
                    "title": "feature_access",
                    "type": "object"
                  },
                  "forwarding_settings": {
                    "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0",
                    "properties": {
                      "financial_account": {
                        "type": "string"
                      },
                      "payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["financial_account", "payment_method"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "forwarding_settings",
                    "type": "object"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "nickname": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "The nickname for the FinancialAccount."
                  },
                  "platform_restrictions": {
                    "description": "The set of functionalities that the platform can restrict on the FinancialAccount.",
                    "properties": {
                      "inbound_flows": {
                        "enum": ["restricted", "unrestricted"],
                        "type": "string"
                      },
                      "outbound_flows": {
                        "enum": ["restricted", "unrestricted"],
                        "type": "string"
                      }
                    },
                    "title": "platform_restrictions",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a FinancialAccount"
      }
    },
    "/v1/treasury/financial_accounts/{financial_account}/close": {
      "post": {
        "description": "<p>Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.</p>",
        "operationId": "PostTreasuryFinancialAccountsFinancialAccountClose",
        "parameters": [
          {
            "in": "path",
            "name": "financial_account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "forwarding_settings": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "forwarding_settings": {
                    "description": "A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0",
                    "properties": {
                      "financial_account": {
                        "type": "string"
                      },
                      "payment_method": {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      "type": {
                        "enum": ["financial_account", "payment_method"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "forwarding_settings",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Close a FinancialAccount"
      }
    },
    "/v1/treasury/financial_accounts/{financial_account}/features": {
      "get": {
        "description": "<p>Retrieves Features information associated with the FinancialAccount.</p>",
        "operationId": "GetTreasuryFinancialAccountsFinancialAccountFeatures",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "financial_account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account_features"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve FinancialAccount Features"
      },
      "post": {
        "description": "<p>Updates the Features associated with a FinancialAccount.</p>",
        "operationId": "PostTreasuryFinancialAccountsFinancialAccountFeatures",
        "parameters": [
          {
            "in": "path",
            "name": "financial_account",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "card_issuing": {
                  "explode": true,
                  "style": "deepObject"
                },
                "deposit_insurance": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "financial_addresses": {
                  "explode": true,
                  "style": "deepObject"
                },
                "inbound_transfers": {
                  "explode": true,
                  "style": "deepObject"
                },
                "intra_stripe_flows": {
                  "explode": true,
                  "style": "deepObject"
                },
                "outbound_payments": {
                  "explode": true,
                  "style": "deepObject"
                },
                "outbound_transfers": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "card_issuing": {
                    "description": "Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.",
                    "properties": {
                      "requested": {
                        "type": "boolean"
                      }
                    },
                    "required": ["requested"],
                    "title": "access",
                    "type": "object"
                  },
                  "deposit_insurance": {
                    "description": "Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.",
                    "properties": {
                      "requested": {
                        "type": "boolean"
                      }
                    },
                    "required": ["requested"],
                    "title": "access",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_addresses": {
                    "description": "Contains Features that add FinancialAddresses to the FinancialAccount.",
                    "properties": {
                      "aba": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "aba_access",
                        "type": "object"
                      }
                    },
                    "title": "financial_addresses",
                    "type": "object"
                  },
                  "inbound_transfers": {
                    "description": "Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.",
                    "properties": {
                      "ach": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access_with_ach_details",
                        "type": "object"
                      }
                    },
                    "title": "inbound_transfers",
                    "type": "object"
                  },
                  "intra_stripe_flows": {
                    "description": "Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).",
                    "properties": {
                      "requested": {
                        "type": "boolean"
                      }
                    },
                    "required": ["requested"],
                    "title": "access",
                    "type": "object"
                  },
                  "outbound_payments": {
                    "description": "Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.",
                    "properties": {
                      "ach": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access_with_ach_details",
                        "type": "object"
                      },
                      "us_domestic_wire": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      }
                    },
                    "title": "outbound_payments",
                    "type": "object"
                  },
                  "outbound_transfers": {
                    "description": "Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.",
                    "properties": {
                      "ach": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access_with_ach_details",
                        "type": "object"
                      },
                      "us_domestic_wire": {
                        "properties": {
                          "requested": {
                            "type": "boolean"
                          }
                        },
                        "required": ["requested"],
                        "title": "access",
                        "type": "object"
                      }
                    },
                    "title": "outbound_transfers",
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.financial_account_features"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update FinancialAccount Features"
      }
    },
    "/v1/treasury/inbound_transfers": {
      "get": {
        "description": "<p>Returns a list of InboundTransfers sent from the specified FinancialAccount.</p>",
        "operationId": "GetTreasuryInboundTransfers",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["canceled", "failed", "processing", "succeeded"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.inbound_transfer"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryInboundTransfersResourceInboundTransferList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all InboundTransfers"
      },
      "post": {
        "description": "<p>Creates an InboundTransfer.</p>",
        "operationId": "PostTreasuryInboundTransfers",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount (in cents) to be transferred.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "description": "The FinancialAccount to send funds to.",
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "origin_payment_method": {
                    "description": "The origin payment method to be debited for the InboundTransfer.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "statement_descriptor": {
                    "description": "The complete description that appears on your customers' statements. Maximum 10 characters.",
                    "maxLength": 10,
                    "type": "string"
                  }
                },
                "required": [
                  "amount",
                  "currency",
                  "financial_account",
                  "origin_payment_method"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an InboundTransfer"
      }
    },
    "/v1/treasury/inbound_transfers/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing InboundTransfer.</p>",
        "operationId": "GetTreasuryInboundTransfersId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an InboundTransfer"
      }
    },
    "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel": {
      "post": {
        "description": "<p>Cancels an InboundTransfer.</p>",
        "operationId": "PostTreasuryInboundTransfersInboundTransferCancel",
        "parameters": [
          {
            "in": "path",
            "name": "inbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.inbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel an InboundTransfer"
      }
    },
    "/v1/treasury/outbound_payments": {
      "get": {
        "description": "<p>Returns a list of OutboundPayments sent from the specified FinancialAccount.</p>",
        "operationId": "GetTreasuryOutboundPayments",
        "parameters": [
          {
            "description": "Only return OutboundPayments that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "Only return OutboundPayments sent to this customer.",
            "in": "query",
            "name": "customer",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "canceled",
                "failed",
                "posted",
                "processing",
                "returned"
              ],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.outbound_payment"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/treasury/outbound_payments",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryOutboundPaymentsResourceOutboundPaymentList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all OutboundPayments"
      },
      "post": {
        "description": "<p>Creates an OutboundPayment.</p>",
        "operationId": "PostTreasuryOutboundPayments",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "destination_payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "destination_payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "end_user_details": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount (in cents) to be transferred.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "customer": {
                    "description": "ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination_payment_method": {
                    "description": "The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination_payment_method_data": {
                    "description": "Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.",
                    "properties": {
                      "billing_details": {
                        "properties": {
                          "address": {
                            "anyOf": [
                              {
                                "properties": {
                                  "city": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "country": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line1": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "line2": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "postal_code": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  },
                                  "state": {
                                    "maxLength": 5000,
                                    "type": "string"
                                  }
                                },
                                "title": "billing_details_address",
                                "type": "object"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "email": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "name": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          },
                          "phone": {
                            "anyOf": [
                              {
                                "maxLength": 5000,
                                "type": "string"
                              },
                              {
                                "enum": [""],
                                "type": "string"
                              }
                            ]
                          }
                        },
                        "title": "billing_details_inner_params",
                        "type": "object"
                      },
                      "financial_account": {
                        "type": "string"
                      },
                      "metadata": {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      "type": {
                        "enum": ["financial_account", "us_bank_account"],
                        "type": "string",
                        "x-stripeBypassValidation": true
                      },
                      "us_bank_account": {
                        "properties": {
                          "account_holder_type": {
                            "enum": ["company", "individual"],
                            "type": "string"
                          },
                          "account_number": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "account_type": {
                            "enum": ["checking", "savings"],
                            "type": "string"
                          },
                          "financial_connections_account": {
                            "maxLength": 5000,
                            "type": "string"
                          },
                          "routing_number": {
                            "maxLength": 5000,
                            "type": "string"
                          }
                        },
                        "title": "payment_method_param",
                        "type": "object"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data",
                    "type": "object"
                  },
                  "destination_payment_method_options": {
                    "description": "Payment method-specific configuration for this OutboundPayment.",
                    "properties": {
                      "us_bank_account": {
                        "anyOf": [
                          {
                            "properties": {
                              "network": {
                                "enum": ["ach", "us_domestic_wire"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_method_options",
                    "type": "object"
                  },
                  "end_user_details": {
                    "description": "End user details.",
                    "properties": {
                      "ip_address": {
                        "type": "string"
                      },
                      "present": {
                        "type": "boolean"
                      }
                    },
                    "required": ["present"],
                    "title": "end_user_details_params",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "description": "The FinancialAccount to pull funds from.",
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is \"payment\".",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["amount", "currency", "financial_account"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an OutboundPayment"
      }
    },
    "/v1/treasury/outbound_payments/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.</p>",
        "operationId": "GetTreasuryOutboundPaymentsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an OutboundPayment"
      }
    },
    "/v1/treasury/outbound_payments/{id}/cancel": {
      "post": {
        "description": "<p>Cancel an OutboundPayment.</p>",
        "operationId": "PostTreasuryOutboundPaymentsIdCancel",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_payment"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel an OutboundPayment"
      }
    },
    "/v1/treasury/outbound_transfers": {
      "get": {
        "description": "<p>Returns a list of OutboundTransfers sent from the specified FinancialAccount.</p>",
        "operationId": "GetTreasuryOutboundTransfers",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "canceled",
                "failed",
                "posted",
                "processing",
                "returned"
              ],
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.outbound_transfer"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryOutboundTransfersResourceOutboundTransferList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all OutboundTransfers"
      },
      "post": {
        "description": "<p>Creates an OutboundTransfer.</p>",
        "operationId": "PostTreasuryOutboundTransfers",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "destination_payment_method_data": {
                  "explode": true,
                  "style": "deepObject"
                },
                "destination_payment_method_options": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "amount": {
                    "description": "Amount (in cents) to be transferred.",
                    "type": "integer"
                  },
                  "currency": {
                    "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
                    "format": "currency",
                    "type": "string"
                  },
                  "description": {
                    "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination_payment_method": {
                    "description": "The PaymentMethod to use as the payment instrument for the OutboundTransfer.",
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "destination_payment_method_data": {
                    "description": "Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.",
                    "properties": {
                      "financial_account": {
                        "type": "string"
                      },
                      "type": {
                        "enum": ["financial_account"],
                        "type": "string"
                      }
                    },
                    "required": ["type"],
                    "title": "payment_method_data",
                    "type": "object"
                  },
                  "destination_payment_method_options": {
                    "description": "Hash describing payment method configuration details.",
                    "properties": {
                      "us_bank_account": {
                        "anyOf": [
                          {
                            "properties": {
                              "network": {
                                "enum": ["ach", "us_domestic_wire"],
                                "type": "string"
                              }
                            },
                            "title": "payment_method_options_param",
                            "type": "object"
                          },
                          {
                            "enum": [""],
                            "type": "string"
                          }
                        ]
                      }
                    },
                    "title": "payment_method_options",
                    "type": "object"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "financial_account": {
                    "description": "The FinancialAccount to pull funds from.",
                    "type": "string"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
                    "type": "object"
                  },
                  "statement_descriptor": {
                    "description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".",
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": ["amount", "currency", "financial_account"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create an OutboundTransfer"
      }
    },
    "/v1/treasury/outbound_transfers/{outbound_transfer}": {
      "get": {
        "description": "<p>Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.</p>",
        "operationId": "GetTreasuryOutboundTransfersOutboundTransfer",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve an OutboundTransfer"
      }
    },
    "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel": {
      "post": {
        "description": "<p>An OutboundTransfer can be canceled if the funds have not yet been paid out.</p>",
        "operationId": "PostTreasuryOutboundTransfersOutboundTransferCancel",
        "parameters": [
          {
            "in": "path",
            "name": "outbound_transfer",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.outbound_transfer"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Cancel an OutboundTransfer"
      }
    },
    "/v1/treasury/received_credits": {
      "get": {
        "description": "<p>Returns a list of ReceivedCredits.</p>",
        "operationId": "GetTreasuryReceivedCredits",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The FinancialAccount that received the funds.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "Only return ReceivedCredits described by the flow.",
            "explode": true,
            "in": "query",
            "name": "linked_flows",
            "required": false,
            "schema": {
              "properties": {
                "source_flow_type": {
                  "enum": [
                    "credit_reversal",
                    "other",
                    "outbound_payment",
                    "outbound_transfer",
                    "payout"
                  ],
                  "type": "string"
                }
              },
              "required": ["source_flow_type"],
              "title": "linked_flows_param",
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return ReceivedCredits that have the given status: `succeeded` or `failed`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["failed", "succeeded"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.received_credit"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryReceivedCreditsResourceReceivedCreditList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all ReceivedCredits"
      }
    },
    "/v1/treasury/received_credits/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.</p>",
        "operationId": "GetTreasuryReceivedCreditsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.received_credit"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a ReceivedCredit"
      }
    },
    "/v1/treasury/received_debits": {
      "get": {
        "description": "<p>Returns a list of ReceivedDebits.</p>",
        "operationId": "GetTreasuryReceivedDebits",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "The FinancialAccount that funds were pulled from.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["failed", "succeeded"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.received_debit"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryReceivedDebitsResourceReceivedDebitList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all ReceivedDebits"
      }
    },
    "/v1/treasury/received_debits/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list</p>",
        "operationId": "GetTreasuryReceivedDebitsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.received_debit"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a ReceivedDebit"
      }
    },
    "/v1/treasury/transaction_entries": {
      "get": {
        "description": "<p>Retrieves a list of TransactionEntry objects.</p>",
        "operationId": "GetTreasuryTransactionEntries",
        "parameters": [
          {
            "description": "Only return TransactionEntries that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "explode": true,
            "in": "query",
            "name": "effective_at",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.",
            "in": "query",
            "name": "order_by",
            "required": false,
            "schema": {
              "enum": ["created", "effective_at"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return TransactionEntries associated with this Transaction.",
            "in": "query",
            "name": "transaction",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.transaction_entry"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/treasury/transaction_entries",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryTransactionsResourceTransactionEntryList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all TransactionEntries"
      }
    },
    "/v1/treasury/transaction_entries/{id}": {
      "get": {
        "description": "<p>Retrieves a TransactionEntry object.</p>",
        "operationId": "GetTreasuryTransactionEntriesId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.transaction_entry"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a TransactionEntry"
      }
    },
    "/v1/treasury/transactions": {
      "get": {
        "description": "<p>Retrieves a list of Transaction objects.</p>",
        "operationId": "GetTreasuryTransactions",
        "parameters": [
          {
            "description": "Only return Transactions that were created during the given date interval.",
            "explode": true,
            "in": "query",
            "name": "created",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "properties": {
                    "gt": {
                      "type": "integer"
                    },
                    "gte": {
                      "type": "integer"
                    },
                    "lt": {
                      "type": "integer"
                    },
                    "lte": {
                      "type": "integer"
                    }
                  },
                  "title": "range_query_specs",
                  "type": "object"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "style": "deepObject"
          },
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "Returns objects associated with this FinancialAccount.",
            "in": "query",
            "name": "financial_account",
            "required": true,
            "schema": {
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.",
            "in": "query",
            "name": "order_by",
            "required": false,
            "schema": {
              "enum": ["created", "posted_at"],
              "type": "string",
              "x-stripeBypassValidation": true
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Only return Transactions that have the given status: `open`, `posted`, or `void`.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": ["open", "posted", "void"],
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.",
            "explode": true,
            "in": "query",
            "name": "status_transitions",
            "required": false,
            "schema": {
              "properties": {
                "posted_at": {
                  "anyOf": [
                    {
                      "properties": {
                        "gt": {
                          "type": "integer"
                        },
                        "gte": {
                          "type": "integer"
                        },
                        "lt": {
                          "type": "integer"
                        },
                        "lte": {
                          "type": "integer"
                        }
                      },
                      "title": "range_query_specs",
                      "type": "object"
                    },
                    {
                      "type": "integer"
                    }
                  ]
                }
              },
              "title": "status_transition_timestamp_specs",
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "description": "Details about each object.",
                      "items": {
                        "$ref": "#/components/schemas/treasury.transaction"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "TreasuryTransactionsResourceTransactionList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all Transactions"
      }
    },
    "/v1/treasury/transactions/{id}": {
      "get": {
        "description": "<p>Retrieves the details of an existing Transaction.</p>",
        "operationId": "GetTreasuryTransactionsId",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/treasury.transaction"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a Transaction"
      }
    },
    "/v1/webhook_endpoints": {
      "get": {
        "description": "<p>Returns a list of your webhook endpoints.</p>",
        "operationId": "GetWebhookEndpoints",
        "parameters": [
          {
            "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
            "in": "query",
            "name": "ending_before",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "style": "form"
          },
          {
            "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
            "in": "query",
            "name": "starting_after",
            "required": false,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "form"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "description": "",
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/webhook_endpoint"
                      },
                      "type": "array"
                    },
                    "has_more": {
                      "description": "True if this list has another page of items after this one that can be fetched.",
                      "type": "boolean"
                    },
                    "object": {
                      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
                      "enum": ["list"],
                      "type": "string"
                    },
                    "url": {
                      "description": "The URL where this list can be accessed.",
                      "maxLength": 5000,
                      "pattern": "^/v1/webhook_endpoints",
                      "type": "string"
                    }
                  },
                  "required": ["data", "has_more", "object", "url"],
                  "title": "NotificationWebhookEndpointList",
                  "type": "object",
                  "x-expandableFields": ["data"]
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "List all webhook endpoints"
      },
      "post": {
        "description": "<p>A webhook endpoint must have a <code>url</code> and a list of <code>enabled_events</code>. You may optionally specify the Boolean <code>connect</code> parameter. If set to true, then a Connect webhook endpoint that notifies the specified <code>url</code> about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified <code>url</code> only about events from your account is created. You can also create webhook endpoints in the <a href=\"https://dashboard.stripe.com/account/webhooks\">webhooks settings</a> section of the Dashboard.</p>",
        "operationId": "PostWebhookEndpoints",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "enabled_events": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "api_version": {
                    "description": "Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.",
                    "enum": [
                      "2011-01-01",
                      "2011-06-21",
                      "2011-06-28",
                      "2011-08-01",
                      "2011-09-15",
                      "2011-11-17",
                      "2012-02-23",
                      "2012-03-25",
                      "2012-06-18",
                      "2012-06-28",
                      "2012-07-09",
                      "2012-09-24",
                      "2012-10-26",
                      "2012-11-07",
                      "2013-02-11",
                      "2013-02-13",
                      "2013-07-05",
                      "2013-08-12",
                      "2013-08-13",
                      "2013-10-29",
                      "2013-12-03",
                      "2014-01-31",
                      "2014-03-13",
                      "2014-03-28",
                      "2014-05-19",
                      "2014-06-13",
                      "2014-06-17",
                      "2014-07-22",
                      "2014-07-26",
                      "2014-08-04",
                      "2014-08-20",
                      "2014-09-08",
                      "2014-10-07",
                      "2014-11-05",
                      "2014-11-20",
                      "2014-12-08",
                      "2014-12-17",
                      "2014-12-22",
                      "2015-01-11",
                      "2015-01-26",
                      "2015-02-10",
                      "2015-02-16",
                      "2015-02-18",
                      "2015-03-24",
                      "2015-04-07",
                      "2015-06-15",
                      "2015-07-07",
                      "2015-07-13",
                      "2015-07-28",
                      "2015-08-07",
                      "2015-08-19",
                      "2015-09-03",
                      "2015-09-08",
                      "2015-09-23",
                      "2015-10-01",
                      "2015-10-12",
                      "2015-10-16",
                      "2016-02-03",
                      "2016-02-19",
                      "2016-02-22",
                      "2016-02-23",
                      "2016-02-29",
                      "2016-03-07",
                      "2016-06-15",
                      "2016-07-06",
                      "2016-10-19",
                      "2017-01-27",
                      "2017-02-14",
                      "2017-04-06",
                      "2017-05-25",
                      "2017-06-05",
                      "2017-08-15",
                      "2017-12-14",
                      "2018-01-23",
                      "2018-02-05",
                      "2018-02-06",
                      "2018-02-28",
                      "2018-05-21",
                      "2018-07-27",
                      "2018-08-23",
                      "2018-09-06",
                      "2018-09-24",
                      "2018-10-31",
                      "2018-11-08",
                      "2019-02-11",
                      "2019-02-19",
                      "2019-03-14",
                      "2019-05-16",
                      "2019-08-14",
                      "2019-09-09",
                      "2019-10-08",
                      "2019-10-17",
                      "2019-11-05",
                      "2019-12-03",
                      "2020-03-02",
                      "2020-08-27",
                      "2022-08-01",
                      "2022-11-15",
                      "2023-08-16",
                      "2023-10-16",
                      "2024-04-10",
                      "2024-06-20",
                      "2024-09-30.acacia",
                      "2024-10-28.acacia",
                      "2024-11-20.acacia",
                      "2024-12-18.acacia",
                      "2025-01-27.acacia",
                      "2025-02-24.acacia"
                    ],
                    "maxLength": 5000,
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "connect": {
                    "description": "Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.",
                    "type": "boolean"
                  },
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "An optional description of what the webhook is used for."
                  },
                  "enabled_events": {
                    "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.",
                    "items": {
                      "enum": [
                        "*",
                        "account.application.authorized",
                        "account.application.deauthorized",
                        "account.external_account.created",
                        "account.external_account.deleted",
                        "account.external_account.updated",
                        "account.updated",
                        "application_fee.created",
                        "application_fee.refund.updated",
                        "application_fee.refunded",
                        "balance.available",
                        "billing.alert.triggered",
                        "billing_portal.configuration.created",
                        "billing_portal.configuration.updated",
                        "billing_portal.session.created",
                        "capability.updated",
                        "cash_balance.funds_available",
                        "charge.captured",
                        "charge.dispute.closed",
                        "charge.dispute.created",
                        "charge.dispute.funds_reinstated",
                        "charge.dispute.funds_withdrawn",
                        "charge.dispute.updated",
                        "charge.expired",
                        "charge.failed",
                        "charge.pending",
                        "charge.refund.updated",
                        "charge.refunded",
                        "charge.succeeded",
                        "charge.updated",
                        "checkout.session.async_payment_failed",
                        "checkout.session.async_payment_succeeded",
                        "checkout.session.completed",
                        "checkout.session.expired",
                        "climate.order.canceled",
                        "climate.order.created",
                        "climate.order.delayed",
                        "climate.order.delivered",
                        "climate.order.product_substituted",
                        "climate.product.created",
                        "climate.product.pricing_updated",
                        "coupon.created",
                        "coupon.deleted",
                        "coupon.updated",
                        "credit_note.created",
                        "credit_note.updated",
                        "credit_note.voided",
                        "customer.created",
                        "customer.deleted",
                        "customer.discount.created",
                        "customer.discount.deleted",
                        "customer.discount.updated",
                        "customer.source.created",
                        "customer.source.deleted",
                        "customer.source.expiring",
                        "customer.source.updated",
                        "customer.subscription.created",
                        "customer.subscription.deleted",
                        "customer.subscription.paused",
                        "customer.subscription.pending_update_applied",
                        "customer.subscription.pending_update_expired",
                        "customer.subscription.resumed",
                        "customer.subscription.trial_will_end",
                        "customer.subscription.updated",
                        "customer.tax_id.created",
                        "customer.tax_id.deleted",
                        "customer.tax_id.updated",
                        "customer.updated",
                        "customer_cash_balance_transaction.created",
                        "entitlements.active_entitlement_summary.updated",
                        "file.created",
                        "financial_connections.account.created",
                        "financial_connections.account.deactivated",
                        "financial_connections.account.disconnected",
                        "financial_connections.account.reactivated",
                        "financial_connections.account.refreshed_balance",
                        "financial_connections.account.refreshed_ownership",
                        "financial_connections.account.refreshed_transactions",
                        "identity.verification_session.canceled",
                        "identity.verification_session.created",
                        "identity.verification_session.processing",
                        "identity.verification_session.redacted",
                        "identity.verification_session.requires_input",
                        "identity.verification_session.verified",
                        "invoice.created",
                        "invoice.deleted",
                        "invoice.finalization_failed",
                        "invoice.finalized",
                        "invoice.marked_uncollectible",
                        "invoice.overdue",
                        "invoice.paid",
                        "invoice.payment_action_required",
                        "invoice.payment_failed",
                        "invoice.payment_succeeded",
                        "invoice.sent",
                        "invoice.upcoming",
                        "invoice.updated",
                        "invoice.voided",
                        "invoice.will_be_due",
                        "invoiceitem.created",
                        "invoiceitem.deleted",
                        "issuing_authorization.created",
                        "issuing_authorization.request",
                        "issuing_authorization.updated",
                        "issuing_card.created",
                        "issuing_card.updated",
                        "issuing_cardholder.created",
                        "issuing_cardholder.updated",
                        "issuing_dispute.closed",
                        "issuing_dispute.created",
                        "issuing_dispute.funds_reinstated",
                        "issuing_dispute.funds_rescinded",
                        "issuing_dispute.submitted",
                        "issuing_dispute.updated",
                        "issuing_personalization_design.activated",
                        "issuing_personalization_design.deactivated",
                        "issuing_personalization_design.rejected",
                        "issuing_personalization_design.updated",
                        "issuing_token.created",
                        "issuing_token.updated",
                        "issuing_transaction.created",
                        "issuing_transaction.purchase_details_receipt_updated",
                        "issuing_transaction.updated",
                        "mandate.updated",
                        "payment_intent.amount_capturable_updated",
                        "payment_intent.canceled",
                        "payment_intent.created",
                        "payment_intent.partially_funded",
                        "payment_intent.payment_failed",
                        "payment_intent.processing",
                        "payment_intent.requires_action",
                        "payment_intent.succeeded",
                        "payment_link.created",
                        "payment_link.updated",
                        "payment_method.attached",
                        "payment_method.automatically_updated",
                        "payment_method.detached",
                        "payment_method.updated",
                        "payout.canceled",
                        "payout.created",
                        "payout.failed",
                        "payout.paid",
                        "payout.reconciliation_completed",
                        "payout.updated",
                        "person.created",
                        "person.deleted",
                        "person.updated",
                        "plan.created",
                        "plan.deleted",
                        "plan.updated",
                        "price.created",
                        "price.deleted",
                        "price.updated",
                        "product.created",
                        "product.deleted",
                        "product.updated",
                        "promotion_code.created",
                        "promotion_code.updated",
                        "quote.accepted",
                        "quote.canceled",
                        "quote.created",
                        "quote.finalized",
                        "radar.early_fraud_warning.created",
                        "radar.early_fraud_warning.updated",
                        "refund.created",
                        "refund.failed",
                        "refund.updated",
                        "reporting.report_run.failed",
                        "reporting.report_run.succeeded",
                        "reporting.report_type.updated",
                        "review.closed",
                        "review.opened",
                        "setup_intent.canceled",
                        "setup_intent.created",
                        "setup_intent.requires_action",
                        "setup_intent.setup_failed",
                        "setup_intent.succeeded",
                        "sigma.scheduled_query_run.created",
                        "source.canceled",
                        "source.chargeable",
                        "source.failed",
                        "source.mandate_notification",
                        "source.refund_attributes_required",
                        "source.transaction.created",
                        "source.transaction.updated",
                        "subscription_schedule.aborted",
                        "subscription_schedule.canceled",
                        "subscription_schedule.completed",
                        "subscription_schedule.created",
                        "subscription_schedule.expiring",
                        "subscription_schedule.released",
                        "subscription_schedule.updated",
                        "tax.settings.updated",
                        "tax_rate.created",
                        "tax_rate.updated",
                        "terminal.reader.action_failed",
                        "terminal.reader.action_succeeded",
                        "test_helpers.test_clock.advancing",
                        "test_helpers.test_clock.created",
                        "test_helpers.test_clock.deleted",
                        "test_helpers.test_clock.internal_failure",
                        "test_helpers.test_clock.ready",
                        "topup.canceled",
                        "topup.created",
                        "topup.failed",
                        "topup.reversed",
                        "topup.succeeded",
                        "transfer.created",
                        "transfer.reversed",
                        "transfer.updated",
                        "treasury.credit_reversal.created",
                        "treasury.credit_reversal.posted",
                        "treasury.debit_reversal.completed",
                        "treasury.debit_reversal.created",
                        "treasury.debit_reversal.initial_credit_granted",
                        "treasury.financial_account.closed",
                        "treasury.financial_account.created",
                        "treasury.financial_account.features_status_updated",
                        "treasury.inbound_transfer.canceled",
                        "treasury.inbound_transfer.created",
                        "treasury.inbound_transfer.failed",
                        "treasury.inbound_transfer.succeeded",
                        "treasury.outbound_payment.canceled",
                        "treasury.outbound_payment.created",
                        "treasury.outbound_payment.expected_arrival_date_updated",
                        "treasury.outbound_payment.failed",
                        "treasury.outbound_payment.posted",
                        "treasury.outbound_payment.returned",
                        "treasury.outbound_payment.tracking_details_updated",
                        "treasury.outbound_transfer.canceled",
                        "treasury.outbound_transfer.created",
                        "treasury.outbound_transfer.expected_arrival_date_updated",
                        "treasury.outbound_transfer.failed",
                        "treasury.outbound_transfer.posted",
                        "treasury.outbound_transfer.returned",
                        "treasury.outbound_transfer.tracking_details_updated",
                        "treasury.received_credit.created",
                        "treasury.received_credit.failed",
                        "treasury.received_credit.succeeded",
                        "treasury.received_debit.created"
                      ],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "url": {
                    "description": "The URL of the webhook endpoint.",
                    "type": "string"
                  }
                },
                "required": ["enabled_events", "url"],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_endpoint"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Create a webhook endpoint"
      }
    },
    "/v1/webhook_endpoints/{webhook_endpoint}": {
      "delete": {
        "description": "<p>You can also delete webhook endpoints via the <a href=\"https://dashboard.stripe.com/account/webhooks\">webhook endpoint management</a> page of the Stripe dashboard.</p>",
        "operationId": "DeleteWebhookEndpointsWebhookEndpoint",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_endpoint",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deleted_webhook_endpoint"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Delete a webhook endpoint"
      },
      "get": {
        "description": "<p>Retrieves the webhook endpoint with the given ID.</p>",
        "operationId": "GetWebhookEndpointsWebhookEndpoint",
        "parameters": [
          {
            "description": "Specifies which fields in the response should be expanded.",
            "explode": true,
            "in": "query",
            "name": "expand",
            "required": false,
            "schema": {
              "items": {
                "maxLength": 5000,
                "type": "string"
              },
              "type": "array"
            },
            "style": "deepObject"
          },
          {
            "in": "path",
            "name": "webhook_endpoint",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {},
              "schema": {
                "additionalProperties": false,
                "properties": {},
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_endpoint"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Retrieve a webhook endpoint"
      },
      "post": {
        "description": "<p>Updates the webhook endpoint. You may edit the <code>url</code>, the list of <code>enabled_events</code>, and the status of your endpoint.</p>",
        "operationId": "PostWebhookEndpointsWebhookEndpoint",
        "parameters": [
          {
            "in": "path",
            "name": "webhook_endpoint",
            "required": true,
            "schema": {
              "maxLength": 5000,
              "type": "string"
            },
            "style": "simple"
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "encoding": {
                "description": {
                  "explode": true,
                  "style": "deepObject"
                },
                "enabled_events": {
                  "explode": true,
                  "style": "deepObject"
                },
                "expand": {
                  "explode": true,
                  "style": "deepObject"
                },
                "metadata": {
                  "explode": true,
                  "style": "deepObject"
                }
              },
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "description": {
                    "anyOf": [
                      {
                        "maxLength": 5000,
                        "type": "string"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "An optional description of what the webhook is used for."
                  },
                  "disabled": {
                    "description": "Disable the webhook endpoint if set to true.",
                    "type": "boolean"
                  },
                  "enabled_events": {
                    "description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.",
                    "items": {
                      "enum": [
                        "*",
                        "account.application.authorized",
                        "account.application.deauthorized",
                        "account.external_account.created",
                        "account.external_account.deleted",
                        "account.external_account.updated",
                        "account.updated",
                        "application_fee.created",
                        "application_fee.refund.updated",
                        "application_fee.refunded",
                        "balance.available",
                        "billing.alert.triggered",
                        "billing_portal.configuration.created",
                        "billing_portal.configuration.updated",
                        "billing_portal.session.created",
                        "capability.updated",
                        "cash_balance.funds_available",
                        "charge.captured",
                        "charge.dispute.closed",
                        "charge.dispute.created",
                        "charge.dispute.funds_reinstated",
                        "charge.dispute.funds_withdrawn",
                        "charge.dispute.updated",
                        "charge.expired",
                        "charge.failed",
                        "charge.pending",
                        "charge.refund.updated",
                        "charge.refunded",
                        "charge.succeeded",
                        "charge.updated",
                        "checkout.session.async_payment_failed",
                        "checkout.session.async_payment_succeeded",
                        "checkout.session.completed",
                        "checkout.session.expired",
                        "climate.order.canceled",
                        "climate.order.created",
                        "climate.order.delayed",
                        "climate.order.delivered",
                        "climate.order.product_substituted",
                        "climate.product.created",
                        "climate.product.pricing_updated",
                        "coupon.created",
                        "coupon.deleted",
                        "coupon.updated",
                        "credit_note.created",
                        "credit_note.updated",
                        "credit_note.voided",
                        "customer.created",
                        "customer.deleted",
                        "customer.discount.created",
                        "customer.discount.deleted",
                        "customer.discount.updated",
                        "customer.source.created",
                        "customer.source.deleted",
                        "customer.source.expiring",
                        "customer.source.updated",
                        "customer.subscription.created",
                        "customer.subscription.deleted",
                        "customer.subscription.paused",
                        "customer.subscription.pending_update_applied",
                        "customer.subscription.pending_update_expired",
                        "customer.subscription.resumed",
                        "customer.subscription.trial_will_end",
                        "customer.subscription.updated",
                        "customer.tax_id.created",
                        "customer.tax_id.deleted",
                        "customer.tax_id.updated",
                        "customer.updated",
                        "customer_cash_balance_transaction.created",
                        "entitlements.active_entitlement_summary.updated",
                        "file.created",
                        "financial_connections.account.created",
                        "financial_connections.account.deactivated",
                        "financial_connections.account.disconnected",
                        "financial_connections.account.reactivated",
                        "financial_connections.account.refreshed_balance",
                        "financial_connections.account.refreshed_ownership",
                        "financial_connections.account.refreshed_transactions",
                        "identity.verification_session.canceled",
                        "identity.verification_session.created",
                        "identity.verification_session.processing",
                        "identity.verification_session.redacted",
                        "identity.verification_session.requires_input",
                        "identity.verification_session.verified",
                        "invoice.created",
                        "invoice.deleted",
                        "invoice.finalization_failed",
                        "invoice.finalized",
                        "invoice.marked_uncollectible",
                        "invoice.overdue",
                        "invoice.paid",
                        "invoice.payment_action_required",
                        "invoice.payment_failed",
                        "invoice.payment_succeeded",
                        "invoice.sent",
                        "invoice.upcoming",
                        "invoice.updated",
                        "invoice.voided",
                        "invoice.will_be_due",
                        "invoiceitem.created",
                        "invoiceitem.deleted",
                        "issuing_authorization.created",
                        "issuing_authorization.request",
                        "issuing_authorization.updated",
                        "issuing_card.created",
                        "issuing_card.updated",
                        "issuing_cardholder.created",
                        "issuing_cardholder.updated",
                        "issuing_dispute.closed",
                        "issuing_dispute.created",
                        "issuing_dispute.funds_reinstated",
                        "issuing_dispute.funds_rescinded",
                        "issuing_dispute.submitted",
                        "issuing_dispute.updated",
                        "issuing_personalization_design.activated",
                        "issuing_personalization_design.deactivated",
                        "issuing_personalization_design.rejected",
                        "issuing_personalization_design.updated",
                        "issuing_token.created",
                        "issuing_token.updated",
                        "issuing_transaction.created",
                        "issuing_transaction.purchase_details_receipt_updated",
                        "issuing_transaction.updated",
                        "mandate.updated",
                        "payment_intent.amount_capturable_updated",
                        "payment_intent.canceled",
                        "payment_intent.created",
                        "payment_intent.partially_funded",
                        "payment_intent.payment_failed",
                        "payment_intent.processing",
                        "payment_intent.requires_action",
                        "payment_intent.succeeded",
                        "payment_link.created",
                        "payment_link.updated",
                        "payment_method.attached",
                        "payment_method.automatically_updated",
                        "payment_method.detached",
                        "payment_method.updated",
                        "payout.canceled",
                        "payout.created",
                        "payout.failed",
                        "payout.paid",
                        "payout.reconciliation_completed",
                        "payout.updated",
                        "person.created",
                        "person.deleted",
                        "person.updated",
                        "plan.created",
                        "plan.deleted",
                        "plan.updated",
                        "price.created",
                        "price.deleted",
                        "price.updated",
                        "product.created",
                        "product.deleted",
                        "product.updated",
                        "promotion_code.created",
                        "promotion_code.updated",
                        "quote.accepted",
                        "quote.canceled",
                        "quote.created",
                        "quote.finalized",
                        "radar.early_fraud_warning.created",
                        "radar.early_fraud_warning.updated",
                        "refund.created",
                        "refund.failed",
                        "refund.updated",
                        "reporting.report_run.failed",
                        "reporting.report_run.succeeded",
                        "reporting.report_type.updated",
                        "review.closed",
                        "review.opened",
                        "setup_intent.canceled",
                        "setup_intent.created",
                        "setup_intent.requires_action",
                        "setup_intent.setup_failed",
                        "setup_intent.succeeded",
                        "sigma.scheduled_query_run.created",
                        "source.canceled",
                        "source.chargeable",
                        "source.failed",
                        "source.mandate_notification",
                        "source.refund_attributes_required",
                        "source.transaction.created",
                        "source.transaction.updated",
                        "subscription_schedule.aborted",
                        "subscription_schedule.canceled",
                        "subscription_schedule.completed",
                        "subscription_schedule.created",
                        "subscription_schedule.expiring",
                        "subscription_schedule.released",
                        "subscription_schedule.updated",
                        "tax.settings.updated",
                        "tax_rate.created",
                        "tax_rate.updated",
                        "terminal.reader.action_failed",
                        "terminal.reader.action_succeeded",
                        "test_helpers.test_clock.advancing",
                        "test_helpers.test_clock.created",
                        "test_helpers.test_clock.deleted",
                        "test_helpers.test_clock.internal_failure",
                        "test_helpers.test_clock.ready",
                        "topup.canceled",
                        "topup.created",
                        "topup.failed",
                        "topup.reversed",
                        "topup.succeeded",
                        "transfer.created",
                        "transfer.reversed",
                        "transfer.updated",
                        "treasury.credit_reversal.created",
                        "treasury.credit_reversal.posted",
                        "treasury.debit_reversal.completed",
                        "treasury.debit_reversal.created",
                        "treasury.debit_reversal.initial_credit_granted",
                        "treasury.financial_account.closed",
                        "treasury.financial_account.created",
                        "treasury.financial_account.features_status_updated",
                        "treasury.inbound_transfer.canceled",
                        "treasury.inbound_transfer.created",
                        "treasury.inbound_transfer.failed",
                        "treasury.inbound_transfer.succeeded",
                        "treasury.outbound_payment.canceled",
                        "treasury.outbound_payment.created",
                        "treasury.outbound_payment.expected_arrival_date_updated",
                        "treasury.outbound_payment.failed",
                        "treasury.outbound_payment.posted",
                        "treasury.outbound_payment.returned",
                        "treasury.outbound_payment.tracking_details_updated",
                        "treasury.outbound_transfer.canceled",
                        "treasury.outbound_transfer.created",
                        "treasury.outbound_transfer.expected_arrival_date_updated",
                        "treasury.outbound_transfer.failed",
                        "treasury.outbound_transfer.posted",
                        "treasury.outbound_transfer.returned",
                        "treasury.outbound_transfer.tracking_details_updated",
                        "treasury.received_credit.created",
                        "treasury.received_credit.failed",
                        "treasury.received_credit.succeeded",
                        "treasury.received_debit.created"
                      ],
                      "type": "string",
                      "x-stripeBypassValidation": true
                    },
                    "type": "array"
                  },
                  "expand": {
                    "description": "Specifies which fields in the response should be expanded.",
                    "items": {
                      "maxLength": 5000,
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "anyOf": [
                      {
                        "additionalProperties": {
                          "type": "string"
                        },
                        "type": "object"
                      },
                      {
                        "enum": [""],
                        "type": "string"
                      }
                    ],
                    "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
                  },
                  "url": {
                    "description": "The URL of the webhook endpoint.",
                    "type": "string"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/webhook_endpoint"
                }
              }
            },
            "description": "Successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            },
            "description": "Error response."
          }
        },
        "summary": "Update a webhook endpoint"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.stripe.com/"
    }
  ]
}


================================================
FILE: legacy/packages/openapi-to-ts/fixtures/openapi/tic-tac-toe.json
================================================
{
  "openapi": "3.1.0",
  "info": {
    "title": "Tic Tac Toe",
    "description": "This API allows writing down marks on a Tic Tac Toe board\nand requesting the state of the board or of individual squares.\n",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "Gameplay"
    }
  ],
  "paths": {
    "/board": {
      "get": {
        "summary": "Get the whole board",
        "description": "Retrieves the current state of the board and the winner.",
        "tags": ["Gameplay"],
        "operationId": "get-board",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status"
                }
              }
            }
          }
        },
        "security": [
          {
            "defaultApiKey": []
          },
          {
            "app2AppOauth": ["board:read"]
          }
        ]
      }
    },
    "/board/{row}/{column}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/rowParam"
        },
        {
          "$ref": "#/components/parameters/columnParam"
        }
      ],
      "get": {
        "summary": "Get a single board square",
        "description": "Retrieves the requested square.",
        "tags": ["Gameplay"],
        "operationId": "get-square",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mark"
                }
              }
            }
          },
          "400": {
            "description": "The provided parameters are incorrect",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/errorMessage"
                },
                "example": "Illegal coordinates"
              }
            }
          }
        },
        "security": [
          {
            "bearerHttpAuthentication": []
          },
          {
            "user2AppOauth": ["board:read"]
          }
        ]
      },
      "put": {
        "summary": "Set a single board square",
        "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
        "tags": ["Gameplay"],
        "operationId": "put-square",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/mark"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status"
                }
              }
            }
          },
          "400": {
            "description": "The provided parameters are incorrect",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/errorMessage"
                },
                "examples": {
                  "illegalCoordinates": {
                    "value": "Illegal coordinates."
                  },
                  "notEmpty": {
                    "value": "Square is not empty."
                  },
                  "invalidMark": {
                    "value": "Invalid Mark (X or O)."
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerHttpAuthentication": []
          },
          {
            "user2AppOauth": ["board:write"]
          }
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "rowParam": {
        "description": "Board row (vertical coordinate)",
        "name": "row",
        "in": "path",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate"
        }
      },
      "columnParam": {
        "description": "Board column (horizontal coordinate)",
        "name": "column",
        "in": "path",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate"
        }
      }
    },
    "schemas": {
      "errorMessage": {
        "type": "string",
        "maxLength": 256,
        "description": "A text message describing an error"
      },
      "coordinate": {
        "type": "integer",
        "minimum": 1,
        "maximum": 3,
        "example": 1
      },
      "mark": {
        "type": "string",
        "enum": [".", "X", "O"],
        "description": "Possible values for a board square. `.` means empty square.",
        "example": "."
      },
      "board": {
        "type": "array",
        "maxItems": 3,
        "minItems": 3,
        "items": {
          "type": "array",
          "maxItems": 3,
          "minItems": 3,
          "items": {
            "$ref": "#/components/schemas/mark"
          }
        }
      },
      "winner": {
        "type": "string",
        "enum": [".", "X", "O"],
        "description": "Winner of the game. `.` means nobody has won yet.",
        "example": "."
      },
      "status": {
        "type": "object",
        "properties": {
          "winner": {
            "$ref": "#/components/schemas/winner"
          },
          "board": {
            "$ref": "#/components/schemas/board"
          }
        }
      }
    },
    "securitySchemes": {
      "defaultApiKey": {
        "description": "API key provided in console",
        "type": "apiKey",
        "name": "api-key",
        "in": "header"
      },
      "basicHttpAuthentication": {
        "description": "Basic HTTP Authentication",
        "type": "http",
        "scheme": "Basic"
      },
      "bearerHttpAuthentication": {
        "description": "Bearer token using a JWT",
        "type": "http",
        "scheme": "Bearer",
        "bearerFormat": "JWT"
      },
      "app2AppOauth": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
            "scopes": {
              "board:read": "Read the board"
            }
          }
        }
      },
      "user2AppOauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://learn.openapis.org/oauth/2.0/auth",
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
            "scopes": {
              "board:read": "Read the board",
              "board:write": "Write to the board"
            }
          }
        }
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/package.json
================================================
{
  "name": "@agentic/openapi-to-ts",
  "version": "7.6.9",
  "description": "Generate an Agentic TypeScript client from an OpenAPI spec.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/openapi-to-ts"
  },
  "type": "module",
  "bin": {
    "openapi-to-ts": "./dist/openapi-to-ts.js"
  },
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@apidevtools/swagger-parser": "catalog:",
    "camelcase": "catalog:",
    "cleye": "catalog:",
    "decamelize": "catalog:",
    "execa": "catalog:",
    "exit-hook": "catalog:",
    "json-schema-to-zod": "catalog:",
    "openapi-types": "catalog:",
    "zod": "catalog:"
  },
  "devDependencies": {
    "ky": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: legacy/packages/openapi-to-ts/src/__snapshots__/generate-ts-from-openapi.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`openapi-to-ts > firecrawl.json 1`] = `
"/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace firecrawl {
  export const apiBaseUrl = 'https://api.firecrawl.dev/v0'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const ScrapeResponseSchema = z.object({
    success: z.boolean().optional(),
    /** Warning message to let you know of any issues. */
    warning: z
      .string()
      .describe('Warning message to let you know of any issues.')
      .optional(),
    data: z
      .object({
        /** Markdown content of the page if the \`markdown\` format was specified (default) */
        markdown: z
          .string()
          .describe(
            'Markdown content of the page if the \`markdown\` format was specified (default)'
          )
          .optional(),
        /** HTML version of the content on page if the \`html\` format was specified */
        html: z
          .string()
          .describe(
            'HTML version of the content on page if the \`html\` format was specified'
          )
          .optional(),
        /** Raw HTML content of the page if the \`rawHtml\` format was specified */
        rawHtml: z
          .string()
          .describe(
            'Raw HTML content of the page if the \`rawHtml\` format was specified'
          )
          .optional(),
        /** Links on the page if the \`links\` format was specified */
        links: z
          .array(z.string().url())
          .describe('Links on the page if the \`links\` format was specified')
          .optional(),
        /** URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified */
        screenshot: z
          .string()
          .describe(
            'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified'
          )
          .optional(),
        metadata: z
          .object({
            title: z.string().optional(),
            description: z.string().optional(),
            language: z.string().optional(),
            sourceURL: z.string().url().optional(),
            '<any other metadata> ': z.string().optional(),
            /** The status code of the page */
            statusCode: z
              .number()
              .int()
              .describe('The status code of the page')
              .optional(),
            /** The error message of the page */
            error: z
              .string()
              .describe('The error message of the page')
              .optional()
          })
          .optional()
      })
      .optional()
  })
  export type ScrapeResponse = z.infer<typeof ScrapeResponseSchema>

  export const CrawlResponseSchema = z.object({
    success: z.boolean().optional(),
    id: z.string().optional(),
    url: z.string().url().optional()
  })
  export type CrawlResponse = z.infer<typeof CrawlResponseSchema>

  export const SearchResponseSchema = z.object({
    success: z.boolean().optional(),
    data: z.array(z.any()).optional()
  })
  export type SearchResponse = z.infer<typeof SearchResponseSchema>

  export const CrawlStatusResponseObjSchema = z.object({
    /** Markdown content of the page if the \`markdown\` format was specified (default) */
    markdown: z
      .string()
      .describe(
        'Markdown content of the page if the \`markdown\` format was specified (default)'
      )
      .optional(),
    /** HTML version of the content on page if the \`html\` format was specified */
    html: z
      .string()
      .describe(
        'HTML version of the content on page if the \`html\` format was specified'
      )
      .optional(),
    /** Raw HTML content of the page if the \`rawHtml\` format was specified */
    rawHtml: z
      .string()
      .describe(
        'Raw HTML content of the page if the \`rawHtml\` format was specified'
      )
      .optional(),
    /** Links on the page if the \`links\` format was specified */
    links: z
      .array(z.string().url())
      .describe('Links on the page if the \`links\` format was specified')
      .optional(),
    /** URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified */
    screenshot: z
      .string()
      .describe(
        'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified'
      )
      .optional(),
    metadata: z
      .object({
        title: z.string().optional(),
        description: z.string().optional(),
        language: z.string().optional(),
        sourceURL: z.string().url().optional(),
        '<any other metadata> ': z.string().optional(),
        /** The status code of the page */
        statusCode: z
          .number()
          .int()
          .describe('The status code of the page')
          .optional(),
        /** The error message of the page */
        error: z.string().describe('The error message of the page').optional()
      })
      .optional()
  })
  export type CrawlStatusResponseObj = z.infer<
    typeof CrawlStatusResponseObjSchema
  >

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const ScrapeParamsSchema = z.object({
    /** The URL to scrape */
    url: z.string().url().describe('The URL to scrape'),
    /**
     * Specific formats to return.
     *
     *  - markdown: The page in Markdown format.
     *  - html: The page's HTML, trimmed to include only meaningful content.
     *  - rawHtml: The page's original HTML.
     *  - links: The links on the page.
     *  - screenshot: A screenshot of the top of the page.
     *  - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)
     */
    formats: z
      .array(
        z.enum([
          'markdown',
          'html',
          'rawHtml',
          'links',
          'screenshot',
          'screenshot@fullPage'
        ])
      )
      .describe(
        "Specific formats to return.\\n\\n - markdown: The page in Markdown format.\\n - html: The page's HTML, trimmed to include only meaningful content.\\n - rawHtml: The page's original HTML.\\n - links: The links on the page.\\n - screenshot: A screenshot of the top of the page.\\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)"
      )
      .default(['markdown']),
    /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */
    headers: z
      .record(z.any())
      .describe(
        'Headers to send with the request. Can be used to send cookies, user-agent, etc.'
      )
      .optional(),
    /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */
    includeTags: z
      .array(z.string())
      .describe(
        "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
      )
      .optional(),
    /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */
    excludeTags: z
      .array(z.string())
      .describe(
        "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
      )
      .optional(),
    /** Only return the main content of the page excluding headers, navs, footers, etc. */
    onlyMainContent: z
      .boolean()
      .describe(
        'Only return the main content of the page excluding headers, navs, footers, etc.'
      )
      .default(true),
    /** Timeout in milliseconds for the request */
    timeout: z
      .number()
      .int()
      .describe('Timeout in milliseconds for the request')
      .default(30000),
    /** Wait x amount of milliseconds for the page to load to fetch content */
    waitFor: z
      .number()
      .int()
      .describe(
        'Wait x amount of milliseconds for the page to load to fetch content'
      )
      .default(0)
  })
  export type ScrapeParams = z.infer<typeof ScrapeParamsSchema>

  export const CrawlUrlsParamsSchema = z.object({
    /** The base URL to start crawling from */
    url: z.string().url().describe('The base URL to start crawling from'),
    crawlerOptions: z
      .object({
        /** URL patterns to include */
        includes: z
          .array(z.string())
          .describe('URL patterns to include')
          .optional(),
        /** URL patterns to exclude */
        excludes: z
          .array(z.string())
          .describe('URL patterns to exclude')
          .optional(),
        /** Generate alt text for images using LLMs (must have a paid plan) */
        generateImgAltText: z
          .boolean()
          .describe(
            'Generate alt text for images using LLMs (must have a paid plan)'
          )
          .default(false),
        /** If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents. */
        returnOnlyUrls: z
          .boolean()
          .describe(
            'If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.'
          )
          .default(false),
        /** Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern. */
        maxDepth: z
          .number()
          .int()
          .describe(
            'Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.'
          )
          .optional(),
        /** The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites. */
        mode: z
          .enum(['default', 'fast'])
          .describe(
            "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites."
          )
          .default('default'),
        /** Ignore the website sitemap when crawling */
        ignoreSitemap: z
          .boolean()
          .describe('Ignore the website sitemap when crawling')
          .default(false),
        /** Maximum number of pages to crawl */
        limit: z
          .number()
          .int()
          .describe('Maximum number of pages to crawl')
          .default(10000),
        /** Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product' */
        allowBackwardCrawling: z
          .boolean()
          .describe(
            "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'"
          )
          .default(false),
        /** Allows the crawler to follow links to external websites. */
        allowExternalContentLinks: z
          .boolean()
          .describe('Allows the crawler to follow links to external websites.')
          .default(false)
      })
      .optional(),
    pageOptions: z
      .object({
        /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */
        headers: z
          .record(z.any())
          .describe(
            'Headers to send with the request. Can be used to send cookies, user-agent, etc.'
          )
          .optional(),
        /** Include the HTML version of the content on page. Will output a html key in the response. */
        includeHtml: z
          .boolean()
          .describe(
            'Include the HTML version of the content on page. Will output a html key in the response.'
          )
          .default(false),
        /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */
        includeRawHtml: z
          .boolean()
          .describe(
            'Include the raw HTML content of the page. Will output a rawHtml key in the response.'
          )
          .default(false),
        /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */
        onlyIncludeTags: z
          .array(z.string())
          .describe(
            "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
          )
          .optional(),
        /** Only return the main content of the page excluding headers, navs, footers, etc. */
        onlyMainContent: z
          .boolean()
          .describe(
            'Only return the main content of the page excluding headers, navs, footers, etc.'
          )
          .default(false),
        /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */
        removeTags: z
          .array(z.string())
          .describe(
            "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
          )
          .optional(),
        /** Replace all relative paths with absolute paths for images and links */
        replaceAllPathsWithAbsolutePaths: z
          .boolean()
          .describe(
            'Replace all relative paths with absolute paths for images and links'
          )
          .default(false),
        /** Include a screenshot of the top of the page that you are scraping. */
        screenshot: z
          .boolean()
          .describe(
            'Include a screenshot of the top of the page that you are scraping.'
          )
          .default(false),
        /** Include a full page screenshot of the page that you are scraping. */
        fullPageScreenshot: z
          .boolean()
          .describe(
            'Include a full page screenshot of the page that you are scraping.'
          )
          .default(false),
        /** Wait x amount of milliseconds for the page to load to fetch content */
        waitFor: z
          .number()
          .int()
          .describe(
            'Wait x amount of milliseconds for the page to load to fetch content'
          )
          .default(0)
      })
      .optional()
  })
  export type CrawlUrlsParams = z.infer<typeof CrawlUrlsParamsSchema>

  export const CrawlUrlsResponseSchema = CrawlResponseSchema
  export type CrawlUrlsResponse = z.infer<typeof CrawlUrlsResponseSchema>

  export const SearchGoogleParamsSchema = z.object({
    /** The query to search for */
    query: z.string().url().describe('The query to search for'),
    pageOptions: z
      .object({
        /** Only return the main content of the page excluding headers, navs, footers, etc. */
        onlyMainContent: z
          .boolean()
          .describe(
            'Only return the main content of the page excluding headers, navs, footers, etc.'
          )
          .default(false),
        /** Fetch the content of each page. If false, defaults to a basic fast serp API. */
        fetchPageContent: z
          .boolean()
          .describe(
            'Fetch the content of each page. If false, defaults to a basic fast serp API.'
          )
          .default(true),
        /** Include the HTML version of the content on page. Will output a html key in the response. */
        includeHtml: z
          .boolean()
          .describe(
            'Include the HTML version of the content on page. Will output a html key in the response.'
          )
          .default(false),
        /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */
        includeRawHtml: z
          .boolean()
          .describe(
            'Include the raw HTML content of the page. Will output a rawHtml key in the response.'
          )
          .default(false)
      })
      .optional(),
    searchOptions: z
      .object({
        /** Maximum number of results. Max is 20 during beta. */
        limit: z
          .number()
          .int()
          .describe('Maximum number of results. Max is 20 during beta.')
          .optional()
      })
      .optional()
  })
  export type SearchGoogleParams = z.infer<typeof SearchGoogleParamsSchema>

  export const SearchGoogleResponseSchema = SearchResponseSchema
  export type SearchGoogleResponse = z.infer<typeof SearchGoogleResponseSchema>

  export const GetCrawlStatusParamsSchema = z.object({
    /** ID of the crawl job */
    jobId: z.string().describe('ID of the crawl job')
  })
  export type GetCrawlStatusParams = z.infer<typeof GetCrawlStatusParamsSchema>

  export const GetCrawlStatusResponseSchema = z.object({
    /** Status of the job (completed, active, failed, paused) */
    status: z
      .string()
      .describe('Status of the job (completed, active, failed, paused)')
      .optional(),
    /** Current page number */
    current: z.number().int().describe('Current page number').optional(),
    /** Total number of pages */
    total: z.number().int().describe('Total number of pages').optional(),
    /** Data returned from the job (null when it is in progress) */
    data: z
      .array(CrawlStatusResponseObjSchema)
      .describe('Data returned from the job (null when it is in progress)')
      .optional(),
    /** Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array. */
    partial_data: z
      .array(CrawlStatusResponseObjSchema)
      .describe(
        'Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.'
      )
      .optional()
  })
  export type GetCrawlStatusResponse = z.infer<
    typeof GetCrawlStatusResponseSchema
  >

  export const CancelCrawlJobParamsSchema = z.object({
    /** ID of the crawl job */
    jobId: z.string().describe('ID of the crawl job')
  })
  export type CancelCrawlJobParams = z.infer<typeof CancelCrawlJobParamsSchema>

  export const CancelCrawlJobResponseSchema = z.object({
    /** Returns cancelled. */
    status: z.string().describe('Returns cancelled.').optional()
  })
  export type CancelCrawlJobResponse = z.infer<
    typeof CancelCrawlJobResponseSchema
  >
}


/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  aiFunction,
  assert,
  getEnv,
  pick
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { firecrawl } from './firecrawl'

/**
 * Agentic Firecrawl client.
 *
 * API for interacting with Firecrawl services to perform web scraping and crawling tasks.
 */
export class FirecrawlClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('FIRECRAWL_API_KEY'),
    apiBaseUrl = firecrawl.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'FirecrawlClient missing required "apiKey" (defaults to "FIRECRAWL_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: apiKey
      }
    })
  }

  /**
   * Scrape a single URL.
   */
  @aiFunction({
    name: 'firecrawl_scrape',
    description: \`Scrape a single URL.\`,
    inputSchema: firecrawl.ScrapeParamsSchema,
    tags: ['Scraping']
  })
  async scrape(
    params: firecrawl.ScrapeParams
  ): Promise<firecrawl.ScrapeResponse> {
    return this.ky
      .post('/scrape', {
        json: pick(
          params,
          'url',
          'formats',
          'headers',
          'includeTags',
          'excludeTags',
          'onlyMainContent',
          'timeout',
          'waitFor'
        )
      })
      .json<firecrawl.ScrapeResponse>()
  }

  /**
   * Crawl multiple URLs based on options.
   */
  @aiFunction({
    name: 'firecrawl_crawl_urls',
    description: \`Crawl multiple URLs based on options.\`,
    inputSchema: firecrawl.CrawlUrlsParamsSchema,
    tags: ['Crawling']
  })
  async crawlUrls(
    params: firecrawl.CrawlUrlsParams
  ): Promise<firecrawl.CrawlUrlsResponse> {
    return this.ky
      .post('/crawl', {
        json: pick(params, 'url', 'crawlerOptions', 'pageOptions')
      })
      .json<firecrawl.CrawlUrlsResponse>()
  }

  /**
   * Search for a keyword in Google, returns top page results with markdown content for each page.
   */
  @aiFunction({
    name: 'firecrawl_search_google',
    description: \`Search for a keyword in Google, returns top page results with markdown content for each page.\`,
    inputSchema: firecrawl.SearchGoogleParamsSchema,
    tags: ['Search']
  })
  async searchGoogle(
    params: firecrawl.SearchGoogleParams
  ): Promise<firecrawl.SearchGoogleResponse> {
    return this.ky
      .post('/search', {
        json: pick(params, 'query', 'pageOptions', 'searchOptions')
      })
      .json<firecrawl.SearchGoogleResponse>()
  }

  /**
   * Get the status of a crawl job.
   */
  @aiFunction({
    name: 'firecrawl_get_crawl_status',
    description: \`Get the status of a crawl job.\`,
    inputSchema: firecrawl.GetCrawlStatusParamsSchema,
    tags: ['Crawl']
  })
  async getCrawlStatus(
    params: firecrawl.GetCrawlStatusParams
  ): Promise<firecrawl.GetCrawlStatusResponse> {
    return this.ky
      .get(\`/crawl/status/\${params['jobId']}\`)
      .json<firecrawl.GetCrawlStatusResponse>()
  }

  /**
   * Cancel a crawl job.
   */
  @aiFunction({
    name: 'firecrawl_cancel_crawl_job',
    description: \`Cancel a crawl job.\`,
    inputSchema: firecrawl.CancelCrawlJobParamsSchema,
    tags: ['Crawl']
  })
  async cancelCrawlJob(
    params: firecrawl.CancelCrawlJobParams
  ): Promise<firecrawl.CancelCrawlJobResponse> {
    return this.ky
      .delete(\`/crawl/cancel/\${params['jobId']}\`)
      .json<firecrawl.CancelCrawlJobResponse>()
  }
}
"
`;

exports[`openapi-to-ts > notion.json 1`] = `
"/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace notion {
  export const apiBaseUrl = 'https://api.notion.so'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const UserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string(),
    type: z.enum(['person', 'bot']),
    name: z.string(),
    avatar_url: z.string()
  })
  export type UserObjectResponse = z.infer<typeof UserObjectResponseSchema>

  export const AnnotationRequestSchema = z.object({
    bold: z.boolean().optional(),
    italic: z.boolean().optional(),
    strikethrough: z.boolean().optional(),
    underline: z.boolean().optional(),
    code: z.boolean().optional(),
    color: z
      .enum([
        'default',
        'gray',
        'brown',
        'orange',
        'yellow',
        'green',
        'blue',
        'purple',
        'pink',
        'red',
        'gray_background',
        'brown_background',
        'orange_background',
        'yellow_background',
        'green_background',
        'blue_background',
        'purple_background',
        'pink_background',
        'red_background'
      ])
      .optional()
  })
  export type AnnotationRequest = z.infer<typeof AnnotationRequestSchema>

  export const DateRequestSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]).optional(),
    time_zone: z.union([z.string(), z.null()]).optional()
  })
  export type DateRequest = z.infer<typeof DateRequestSchema>

  export const PageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    archived: z.boolean(),
    url: z.string()
  })
  export type PageObjectResponse = z.infer<typeof PageObjectResponseSchema>

  export const PartialPageObjectResponseSchema = z.object({
    object: z.literal('page'),
    id: z.string()
  })
  export type PartialPageObjectResponse = z.infer<
    typeof PartialPageObjectResponseSchema
  >

  export const PropertyItemObjectResponseSchema = z.object({
    type: z.string(),
    id: z.string()
  })
  export type PropertyItemObjectResponse = z.infer<
    typeof PropertyItemObjectResponseSchema
  >

  export const PartialBlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string()
  })
  export type PartialBlockObjectResponse = z.infer<
    typeof PartialBlockObjectResponseSchema
  >

  export const BlockObjectResponseSchema = z.object({
    object: z.literal('block'),
    id: z.string(),
    type: z.string(),
    created_time: z.string(),
    last_edited_time: z.string(),
    has_children: z.boolean(),
    archived: z.boolean()
  })
  export type BlockObjectResponse = z.infer<typeof BlockObjectResponseSchema>

  export const TitlePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('title'),
    title: z.record(z.any())
  })
  export type TitlePropertyResponse = z.infer<
    typeof TitlePropertyResponseSchema
  >

  export const RichTextPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rich_text'),
    rich_text: z.record(z.any())
  })
  export type RichTextPropertyResponse = z.infer<
    typeof RichTextPropertyResponseSchema
  >

  export const NumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('number'),
    number: z.object({ format: z.string() })
  })
  export type NumberPropertyResponse = z.infer<
    typeof NumberPropertyResponseSchema
  >

  export const SelectOptionSchema = z.object({
    id: z.string(),
    name: z.string(),
    color: z.string()
  })
  export type SelectOption = z.infer<typeof SelectOptionSchema>

  export const DatePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('date'),
    date: z.record(z.any())
  })
  export type DatePropertyResponse = z.infer<typeof DatePropertyResponseSchema>

  export const PeoplePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('people'),
    people: z.record(z.any())
  })
  export type PeoplePropertyResponse = z.infer<
    typeof PeoplePropertyResponseSchema
  >

  export const FilePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('files'),
    files: z.record(z.any())
  })
  export type FilePropertyResponse = z.infer<typeof FilePropertyResponseSchema>

  export const CheckboxPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('checkbox'),
    checkbox: z.record(z.any())
  })
  export type CheckboxPropertyResponse = z.infer<
    typeof CheckboxPropertyResponseSchema
  >

  export const UrlPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('url'),
    url: z.record(z.any())
  })
  export type UrlPropertyResponse = z.infer<typeof UrlPropertyResponseSchema>

  export const EmailPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('email'),
    email: z.record(z.any())
  })
  export type EmailPropertyResponse = z.infer<
    typeof EmailPropertyResponseSchema
  >

  export const PhoneNumberPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('phone_number'),
    phone_number: z.record(z.any())
  })
  export type PhoneNumberPropertyResponse = z.infer<
    typeof PhoneNumberPropertyResponseSchema
  >

  export const FormulaPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('formula'),
    formula: z.object({ expression: z.string() })
  })
  export type FormulaPropertyResponse = z.infer<
    typeof FormulaPropertyResponseSchema
  >

  export const RelationPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('relation'),
    relation: z.object({
      database_id: z.string(),
      synced_property_name: z.string(),
      synced_property_id: z.string()
    })
  })
  export type RelationPropertyResponse = z.infer<
    typeof RelationPropertyResponseSchema
  >

  export const RollupPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('rollup'),
    rollup: z.object({
      relation_property_name: z.string(),
      relation_property_id: z.string(),
      rollup_property_name: z.string(),
      rollup_property_id: z.string(),
      function: z.string()
    })
  })
  export type RollupPropertyResponse = z.infer<
    typeof RollupPropertyResponseSchema
  >

  export const CreatedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_time'),
    created_time: z.record(z.any())
  })
  export type CreatedTimePropertyResponse = z.infer<
    typeof CreatedTimePropertyResponseSchema
  >

  export const CreatedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('created_by'),
    created_by: z.record(z.any())
  })
  export type CreatedByPropertyResponse = z.infer<
    typeof CreatedByPropertyResponseSchema
  >

  export const LastEditedTimePropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_time'),
    last_edited_time: z.record(z.any())
  })
  export type LastEditedTimePropertyResponse = z.infer<
    typeof LastEditedTimePropertyResponseSchema
  >

  export const LastEditedByPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('last_edited_by'),
    last_edited_by: z.record(z.any())
  })
  export type LastEditedByPropertyResponse = z.infer<
    typeof LastEditedByPropertyResponseSchema
  >

  export const PartialUserObjectResponseSchema = z.object({
    object: z.literal('user'),
    id: z.string()
  })
  export type PartialUserObjectResponse = z.infer<
    typeof PartialUserObjectResponseSchema
  >

  export const AnnotationResponseSchema = z.object({
    bold: z.boolean(),
    italic: z.boolean(),
    strikethrough: z.boolean(),
    underline: z.boolean(),
    code: z.boolean(),
    color: z.enum([
      'default',
      'gray',
      'brown',
      'orange',
      'yellow',
      'green',
      'blue',
      'purple',
      'pink',
      'red',
      'gray_background',
      'brown_background',
      'orange_background',
      'yellow_background',
      'green_background',
      'blue_background',
      'purple_background',
      'pink_background',
      'red_background'
    ])
  })
  export type AnnotationResponse = z.infer<typeof AnnotationResponseSchema>

  export const DateResponseSchema = z.object({
    start: z.string(),
    end: z.union([z.string(), z.null()]),
    time_zone: z.union([z.string(), z.null()])
  })
  export type DateResponse = z.infer<typeof DateResponseSchema>

  export const PropertyUpdateSchemaSchema = z.object({
    name: z.string().optional(),
    type: z.string().optional()
  })
  export type PropertyUpdateSchema = z.infer<typeof PropertyUpdateSchemaSchema>

  export const TextPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    starts_with: z.string().optional(),
    ends_with: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type TextPropertyFilter = z.infer<typeof TextPropertyFilterSchema>

  export const NumberPropertyFilterSchema = z.object({
    equals: z.number().optional(),
    does_not_equal: z.number().optional(),
    greater_than: z.number().optional(),
    less_than: z.number().optional(),
    greater_than_or_equal_to: z.number().optional(),
    less_than_or_equal_to: z.number().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type NumberPropertyFilter = z.infer<typeof NumberPropertyFilterSchema>

  export const CheckboxPropertyFilterSchema = z.object({
    equals: z.boolean().optional(),
    does_not_equal: z.boolean().optional()
  })
  export type CheckboxPropertyFilter = z.infer<
    typeof CheckboxPropertyFilterSchema
  >

  export const SelectPropertyFilterSchema = z.object({
    equals: z.string().optional(),
    does_not_equal: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type SelectPropertyFilter = z.infer<typeof SelectPropertyFilterSchema>

  export const MultiSelectPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type MultiSelectPropertyFilter = z.infer<
    typeof MultiSelectPropertyFilterSchema
  >

  export const DatePropertyFilterSchema = z.object({
    equals: z.string().optional(),
    before: z.string().optional(),
    after: z.string().optional(),
    on_or_before: z.string().optional(),
    on_or_after: z.string().optional(),
    past_week: z.any().optional(),
    past_month: z.any().optional(),
    past_year: z.any().optional(),
    next_week: z.any().optional(),
    next_month: z.any().optional(),
    next_year: z.any().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type DatePropertyFilter = z.infer<typeof DatePropertyFilterSchema>

  export const PeoplePropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type PeoplePropertyFilter = z.infer<typeof PeoplePropertyFilterSchema>

  export const FilesPropertyFilterSchema = z.object({
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type FilesPropertyFilter = z.infer<typeof FilesPropertyFilterSchema>

  export const RelationPropertyFilterSchema = z.object({
    contains: z.string().optional(),
    does_not_contain: z.string().optional(),
    is_empty: z.boolean().optional(),
    is_not_empty: z.boolean().optional()
  })
  export type RelationPropertyFilter = z.infer<
    typeof RelationPropertyFilterSchema
  >

  export const PropertySchemaSchema = z.object({
    type: z.string(),
    name: z.union([z.string(), z.null()]).optional()
  })
  export type PropertySchema = z.infer<typeof PropertySchemaSchema>

  export const SearchParametersSchema = z.object({
    query: z.string().optional(),
    sort: z
      .object({
        direction: z.enum(['ascending', 'descending']),
        timestamp: z.literal('last_edited_time')
      })
      .optional(),
    filter: z
      .object({
        value: z.enum(['page', 'database']),
        property: z.literal('object')
      })
      .optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type SearchParameters = z.infer<typeof SearchParametersSchema>

  export const PartialCommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string()
  })
  export type PartialCommentObjectResponse = z.infer<
    typeof PartialCommentObjectResponseSchema
  >

  export const OauthTokenParametersSchema = z.object({
    grant_type: z.string(),
    code: z.string(),
    redirect_uri: z.string().optional(),
    external_account: z.object({ key: z.string(), name: z.string() }).optional()
  })
  export type OauthTokenParameters = z.infer<typeof OauthTokenParametersSchema>

  export const ListUsersResponseSchema = z.object({
    results: z.array(UserObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListUsersResponse = z.infer<typeof ListUsersResponseSchema>

  export const PropertyItemListResponseSchema = z.object({
    results: z.array(PropertyItemObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type PropertyItemListResponse = z.infer<
    typeof PropertyItemListResponseSchema
  >

  export const SelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('select'),
    select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type SelectPropertyResponse = z.infer<
    typeof SelectPropertyResponseSchema
  >

  export const MultiSelectPropertyResponseSchema = z.object({
    id: z.string(),
    type: z.literal('multi_select'),
    multi_select: z.object({ options: z.array(SelectOptionSchema) })
  })
  export type MultiSelectPropertyResponse = z.infer<
    typeof MultiSelectPropertyResponseSchema
  >

  export const TextRichTextItemResponseSchema = z.object({
    type: z.literal('text'),
    text: z.object({
      content: z.string(),
      link: z.union([z.object({ url: z.string() }), z.null()])
    }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type TextRichTextItemResponse = z.infer<
    typeof TextRichTextItemResponseSchema
  >

  export const EquationRichTextItemResponseSchema = z.object({
    type: z.literal('equation'),
    equation: z.object({ expression: z.string() }),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type EquationRichTextItemResponse = z.infer<
    typeof EquationRichTextItemResponseSchema
  >

  export const ListBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListBlockChildrenResponse = z.infer<
    typeof ListBlockChildrenResponseSchema
  >

  export const AppendBlockChildrenResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type AppendBlockChildrenResponse = z.infer<
    typeof AppendBlockChildrenResponseSchema
  >

  export const QueryDatabaseResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([PageObjectResponseSchema, PartialPageObjectResponseSchema])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type QueryDatabaseResponse = z.infer<
    typeof QueryDatabaseResponseSchema
  >

  export const OauthTokenResponseSchema = z.object({
    access_token: z.string(),
    token_type: z.literal('bearer'),
    bot_id: z.string(),
    workspace_name: z.union([z.string(), z.null()]),
    workspace_icon: z.union([z.string(), z.null()]),
    workspace_id: z.string(),
    owner: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          UserObjectResponseSchema,
          PartialUserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    duplicated_template_id: z.union([z.string(), z.null()])
  })
  export type OauthTokenResponse = z.infer<typeof OauthTokenResponseSchema>

  export const RichTextItemRequestSchema = z.union([
    z.object({
      text: z.object({
        content: z.string(),
        link: z.union([z.object({ url: z.string() }), z.null()]).optional()
      }),
      type: z.literal('text').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      mention: z.union([
        z.object({
          user: z.union([
            z.object({ id: z.string() }),
            UserObjectResponseSchema
          ])
        }),
        z.object({ page: z.object({ id: z.string() }) }),
        z.object({ database: z.object({ id: z.string() }) }),
        z.object({ date: DateRequestSchema })
      ]),
      type: z.literal('mention').optional(),
      annotations: AnnotationRequestSchema.optional()
    }),
    z.object({
      equation: z.object({ expression: z.string() }),
      type: z.literal('equation').optional(),
      annotations: AnnotationRequestSchema.optional()
    })
  ])
  export type RichTextItemRequest = z.infer<typeof RichTextItemRequestSchema>

  export const CreatePageParametersSchema = z.object({
    parent: z
      .record(z.any())
      .and(
        z.union([
          z.object({ type: z.literal('page_id'), page_id: z.string() }),
          z.object({ type: z.literal('database_id'), database_id: z.string() })
        ])
      ),
    properties: z.record(
      z.union([
        z.object({ title: z.array(RichTextItemRequestSchema) }),
        z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
        z.object({ number: z.union([z.number(), z.null()]) }),
        z.object({
          select: z.union([z.object({ name: z.string() }), z.null()])
        })
      ])
    )
  })
  export type CreatePageParameters = z.infer<typeof CreatePageParametersSchema>

  export const UpdatePageParametersSchema = z.object({
    properties: z
      .record(
        z.union([
          z.object({ title: z.array(RichTextItemRequestSchema) }),
          z.object({ rich_text: z.array(RichTextItemRequestSchema) }),
          z.object({ number: z.union([z.number(), z.null()]) }),
          z.object({
            select: z.union([z.object({ name: z.string() }), z.null()])
          })
        ])
      )
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdatePageParameters = z.infer<typeof UpdatePageParametersSchema>

  export const UpdateBlockParametersSchema = z.object({
    paragraph: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_1: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_2: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    heading_3: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    bulleted_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    numbered_list_item: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    quote: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    to_do: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        checked: z.boolean().optional(),
        color: z.string().optional()
      })
      .optional(),
    toggle: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        color: z.string().optional()
      })
      .optional(),
    code: z
      .object({
        rich_text: z.array(RichTextItemRequestSchema).optional(),
        language: z.string().optional()
      })
      .optional(),
    embed: z.object({ url: z.string().optional() }).optional(),
    image: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    video: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    file: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    pdf: z
      .object({ external: z.object({ url: z.string().optional() }).optional() })
      .optional(),
    bookmark: z.object({ url: z.string().optional() }).optional(),
    equation: z.object({ expression: z.string().optional() }).optional(),
    divider: z.record(z.any()).optional(),
    table_of_contents: z.object({ color: z.string().optional() }).optional(),
    breadcrumb: z.record(z.any()).optional(),
    column_list: z.record(z.any()).optional(),
    column: z.record(z.any()).optional(),
    link_to_page: z
      .object({
        type: z.enum(['page_id', 'database_id']).optional(),
        page_id: z.string().optional(),
        database_id: z.string().optional()
      })
      .optional(),
    table_row: z
      .object({ cells: z.array(z.array(RichTextItemRequestSchema)).optional() })
      .optional(),
    archived: z.boolean().optional()
  })
  export type UpdateBlockParameters = z.infer<
    typeof UpdateBlockParametersSchema
  >

  export const BlockObjectRequestSchema = z.union([
    z.object({
      object: z.literal('block'),
      type: z.literal('paragraph'),
      paragraph: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_1'),
      heading_1: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_2'),
      heading_2: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('heading_3'),
      heading_3: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bulleted_list_item'),
      bulleted_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('numbered_list_item'),
      numbered_list_item: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('to_do'),
      to_do: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        checked: z.boolean(),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('toggle'),
      toggle: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        color: z.string().optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('code'),
      code: z.object({
        rich_text: z.array(RichTextItemRequestSchema),
        language: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_page'),
      child_page: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('child_database'),
      child_database: z.object({ title: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('embed'),
      embed: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('image'),
      image: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('video'),
      video: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('file'),
      file: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('pdf'),
      pdf: z.object({
        external: z.object({ url: z.string() }),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('bookmark'),
      bookmark: z.object({
        url: z.string(),
        caption: z.array(RichTextItemRequestSchema).optional()
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('equation'),
      equation: z.object({ expression: z.string() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('divider'),
      divider: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_of_contents'),
      table_of_contents: z.object({ color: z.string().optional() })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column_list'),
      column_list: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('column'),
      column: z.record(z.any())
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('link_to_page'),
      link_to_page: z.union([
        z.object({ type: z.literal('page_id'), page_id: z.string() }),
        z.object({ type: z.literal('database_id'), database_id: z.string() })
      ])
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table'),
      table: z.object({
        table_width: z.number().int(),
        has_column_header: z.boolean().optional(),
        has_row_header: z.boolean().optional(),
        children: z.array(
          // TODO: Support recursive types for \`BlockObjectRequestSchema\`.
          z.any()
        )
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('table_row'),
      table_row: z.object({
        cells: z.array(z.array(RichTextItemRequestSchema))
      })
    }),
    z.object({
      object: z.literal('block'),
      type: z.literal('synced_block'),
      synced_block: z.object({
        synced_from: z
          .union([
            z.object({ type: z.literal('block_id'), block_id: z.string() }),
            z.null()
          ])
          .optional(),
        children: z
          .array(
            // TODO: Support recursive types for \`BlockObjectRequestSchema\`.
            z.any()
          )
          .optional()
      })
    })
  ])
  export type BlockObjectRequest = z.infer<typeof BlockObjectRequestSchema>

  export const MentionRichTextItemResponseSchema = z.object({
    type: z.literal('mention'),
    mention: z.union([
      z.object({
        type: z.literal('user'),
        user: z.union([
          PartialUserObjectResponseSchema,
          UserObjectResponseSchema
        ])
      }),
      z.object({ type: z.literal('date'), date: DateResponseSchema }),
      z.object({
        type: z.literal('link_preview'),
        link_preview: z.object({ url: z.string() })
      }),
      z.object({ type: z.literal('page'), page: z.object({ id: z.string() }) }),
      z.object({
        type: z.literal('database'),
        database: z.object({ id: z.string() })
      })
    ]),
    annotations: AnnotationResponseSchema,
    plain_text: z.string(),
    href: z.union([z.string(), z.null()])
  })
  export type MentionRichTextItemResponse = z.infer<
    typeof MentionRichTextItemResponseSchema
  >

  export const CreateCommentParametersSchema = z.union([
    z.object({
      parent: z.object({
        page_id: z.string(),
        type: z.literal('page_id').optional()
      }),
      rich_text: z.array(RichTextItemRequestSchema)
    }),
    z.object({
      discussion_id: z.string(),
      rich_text: z.array(RichTextItemRequestSchema)
    })
  ])
  export type CreateCommentParameters = z.infer<
    typeof CreateCommentParametersSchema
  >

  export const AppendBlockChildrenParametersSchema = z.object({
    children: z.array(BlockObjectRequestSchema)
  })
  export type AppendBlockChildrenParameters = z.infer<
    typeof AppendBlockChildrenParametersSchema
  >

  export const UpdateDatabaseParametersSchema = z.object({
    title: z.array(RichTextItemRequestSchema).optional(),
    description: z.array(RichTextItemRequestSchema).optional(),
    icon: z
      .union([
        z.object({ emoji: z.string(), type: z.literal('emoji') }),
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          external: z.object({ url: z.string() }),
          type: z.literal('external')
        }),
        z.null()
      ])
      .optional(),
    properties: z.record(PropertyUpdateSchemaSchema).optional(),
    is_inline: z.boolean().optional(),
    archived: z.boolean().optional()
  })
  export type UpdateDatabaseParameters = z.infer<
    typeof UpdateDatabaseParametersSchema
  >

  export const CreateDatabaseParametersSchema = z.object({
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('database_id'), database_id: z.string() })
    ]),
    properties: z.record(PropertySchemaSchema),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    title: z.array(RichTextItemRequestSchema),
    description: z.array(RichTextItemRequestSchema).optional(),
    is_inline: z.boolean().optional()
  })
  export type CreateDatabaseParameters = z.infer<
    typeof CreateDatabaseParametersSchema
  >

  export const RichTextItemResponseSchema = z.union([
    TextRichTextItemResponseSchema,
    MentionRichTextItemResponseSchema,
    EquationRichTextItemResponseSchema
  ])
  export type RichTextItemResponse = z.infer<typeof RichTextItemResponseSchema>

  export const CommentObjectResponseSchema = z.object({
    object: z.literal('comment'),
    id: z.string(),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('block_id'), block_id: z.string() })
    ]),
    discussion_id: z.string(),
    rich_text: z.array(RichTextItemResponseSchema),
    created_by: PartialUserObjectResponseSchema,
    created_time: z.string(),
    last_edited_time: z.string()
  })
  export type CommentObjectResponse = z.infer<
    typeof CommentObjectResponseSchema
  >

  export const PropertyFilterSchema = z.union([
    z.object({ property: z.string(), title: TextPropertyFilterSchema }),
    z.object({ property: z.string(), rich_text: TextPropertyFilterSchema }),
    z.object({ property: z.string(), number: NumberPropertyFilterSchema }),
    z.object({ property: z.string(), checkbox: CheckboxPropertyFilterSchema }),
    z.object({ property: z.string(), select: SelectPropertyFilterSchema }),
    z.object({
      property: z.string(),
      multi_select: MultiSelectPropertyFilterSchema
    }),
    z.object({ property: z.string(), date: DatePropertyFilterSchema }),
    z.object({ property: z.string(), people: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), files: FilesPropertyFilterSchema }),
    z.object({ property: z.string(), url: TextPropertyFilterSchema }),
    z.object({ property: z.string(), email: TextPropertyFilterSchema }),
    z.object({ property: z.string(), phone_number: TextPropertyFilterSchema }),
    z.object({ property: z.string(), relation: RelationPropertyFilterSchema }),
    z.object({ property: z.string(), created_by: PeoplePropertyFilterSchema }),
    z.object({ property: z.string(), created_time: DatePropertyFilterSchema }),
    z.object({
      property: z.string(),
      last_edited_by: PeoplePropertyFilterSchema
    }),
    z.object({
      property: z.string(),
      last_edited_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      created_time: DatePropertyFilterSchema
    }),
    z.object({
      timestamp: z.enum(['created_time', 'last_edited_time']),
      last_edited_time: DatePropertyFilterSchema
    })
  ])
  export type PropertyFilter = z.infer<typeof PropertyFilterSchema>

  export const ListCommentsResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(CommentObjectResponseSchema),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListCommentsResponse = z.infer<typeof ListCommentsResponseSchema>

  export const CompoundFilterSchema = z.object({
    and: z.array(PropertyFilterSchema).optional(),
    or: z.array(PropertyFilterSchema).optional()
  })
  export type CompoundFilter = z.infer<typeof CompoundFilterSchema>

  export const QueryDatabaseParametersSchema = z.object({
    sorts: z
      .array(
        z.union([
          z.object({
            property: z.string(),
            direction: z.enum(['ascending', 'descending'])
          }),
          z.object({
            timestamp: z.enum(['created_time', 'last_edited_time']),
            direction: z.enum(['ascending', 'descending'])
          })
        ])
      )
      .optional(),
    filter: z.union([PropertyFilterSchema, CompoundFilterSchema]).optional(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional(),
    archived: z.boolean().optional()
  })
  export type QueryDatabaseParameters = z.infer<
    typeof QueryDatabaseParametersSchema
  >

  export const DatabasePropertyConfigResponseSchema = z.union([
    TitlePropertyResponseSchema,
    RichTextPropertyResponseSchema,
    NumberPropertyResponseSchema,
    SelectPropertyResponseSchema,
    MultiSelectPropertyResponseSchema,
    DatePropertyResponseSchema,
    PeoplePropertyResponseSchema,
    FilePropertyResponseSchema,
    CheckboxPropertyResponseSchema,
    UrlPropertyResponseSchema,
    EmailPropertyResponseSchema,
    PhoneNumberPropertyResponseSchema,
    FormulaPropertyResponseSchema,
    RelationPropertyResponseSchema,
    RollupPropertyResponseSchema,
    CreatedTimePropertyResponseSchema,
    CreatedByPropertyResponseSchema,
    LastEditedTimePropertyResponseSchema,
    LastEditedByPropertyResponseSchema
  ])
  export type DatabasePropertyConfigResponse = z.infer<
    typeof DatabasePropertyConfigResponseSchema
  >

  export const PartialDatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    properties: z.record(DatabasePropertyConfigResponseSchema)
  })
  export type PartialDatabaseObjectResponse = z.infer<
    typeof PartialDatabaseObjectResponseSchema
  >

  export const DatabaseObjectResponseSchema = z.object({
    object: z.literal('database'),
    id: z.string(),
    cover: z
      .union([
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    icon: z
      .union([
        z.object({ type: z.literal('emoji'), emoji: z.string() }),
        z.object({
          type: z.literal('external'),
          external: z.object({ url: z.string() })
        }),
        z.null()
      ])
      .optional(),
    created_time: z.string(),
    created_by: PartialUserObjectResponseSchema,
    last_edited_time: z.string(),
    last_edited_by: PartialUserObjectResponseSchema,
    title: z.array(RichTextItemResponseSchema),
    description: z.array(RichTextItemResponseSchema),
    is_inline: z.boolean(),
    properties: z.record(DatabasePropertyConfigResponseSchema),
    parent: z.union([
      z.object({ type: z.literal('page_id'), page_id: z.string() }),
      z.object({ type: z.literal('workspace'), workspace: z.literal(true) })
    ]),
    url: z.string(),
    archived: z.boolean()
  })
  export type DatabaseObjectResponse = z.infer<
    typeof DatabaseObjectResponseSchema
  >

  export const ListDatabasesResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type ListDatabasesResponse = z.infer<
    typeof ListDatabasesResponseSchema
  >

  export const SearchResponseSchema = z.object({
    object: z.literal('list'),
    results: z.array(
      z.union([
        PageObjectResponseSchema,
        PartialPageObjectResponseSchema,
        PartialDatabaseObjectResponseSchema,
        DatabaseObjectResponseSchema
      ])
    ),
    next_cursor: z.union([z.string(), z.null()]),
    has_more: z.boolean()
  })
  export type SearchResponse = z.infer<typeof SearchResponseSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetSelfParamsSchema = z.object({})
  export type GetSelfParams = z.infer<typeof GetSelfParamsSchema>

  export const GetSelfResponseSchema = UserObjectResponseSchema
  export type GetSelfResponse = z.infer<typeof GetSelfResponseSchema>

  export const GetUserParamsSchema = z.object({ user_id: z.string() })
  export type GetUserParams = z.infer<typeof GetUserParamsSchema>

  export const GetUserResponseSchema = UserObjectResponseSchema
  export type GetUserResponse = z.infer<typeof GetUserResponseSchema>

  export const ListUsersParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListUsersParams = z.infer<typeof ListUsersParamsSchema>

  export const CreatePageParamsSchema = CreatePageParametersSchema
  export type CreatePageParams = z.infer<typeof CreatePageParamsSchema>

  export const CreatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type CreatePageResponse = z.infer<typeof CreatePageResponseSchema>

  export const GetPageParamsSchema = z.object({
    page_id: z.string(),
    filter_properties: z.array(z.string()).optional()
  })
  export type GetPageParams = z.infer<typeof GetPageParamsSchema>

  export const GetPageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type GetPageResponse = z.infer<typeof GetPageResponseSchema>

  export const UpdatePageParamsSchema = z
    .object({ page_id: z.string() })
    .merge(UpdatePageParametersSchema)
  export type UpdatePageParams = z.infer<typeof UpdatePageParamsSchema>

  export const UpdatePageResponseSchema = z.union([
    PageObjectResponseSchema,
    PartialPageObjectResponseSchema
  ])
  export type UpdatePageResponse = z.infer<typeof UpdatePageResponseSchema>

  export const GetPagePropertyParamsSchema = z.object({
    page_id: z.string(),
    property_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type GetPagePropertyParams = z.infer<
    typeof GetPagePropertyParamsSchema
  >

  export const GetPagePropertyResponseSchema = z.union([
    PropertyItemObjectResponseSchema,
    PropertyItemListResponseSchema
  ])
  export type GetPagePropertyResponse = z.infer<
    typeof GetPagePropertyResponseSchema
  >

  export const GetBlockParamsSchema = z.object({ block_id: z.string() })
  export type GetBlockParams = z.infer<typeof GetBlockParamsSchema>

  export const GetBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type GetBlockResponse = z.infer<typeof GetBlockResponseSchema>

  export const DeleteBlockParamsSchema = z.object({ block_id: z.string() })
  export type DeleteBlockParams = z.infer<typeof DeleteBlockParamsSchema>

  export const DeleteBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type DeleteBlockResponse = z.infer<typeof DeleteBlockResponseSchema>

  export const UpdateBlockParamsSchema = z
    .object({ block_id: z.string() })
    .merge(UpdateBlockParametersSchema)
  export type UpdateBlockParams = z.infer<typeof UpdateBlockParamsSchema>

  export const UpdateBlockResponseSchema = z.union([
    PartialBlockObjectResponseSchema,
    BlockObjectResponseSchema
  ])
  export type UpdateBlockResponse = z.infer<typeof UpdateBlockResponseSchema>

  export const ListBlockChildrenParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListBlockChildrenParams = z.infer<
    typeof ListBlockChildrenParamsSchema
  >

  export const AppendBlockChildrenParamsSchema = z
    .object({ block_id: z.string() })
    .merge(AppendBlockChildrenParametersSchema)
  export type AppendBlockChildrenParams = z.infer<
    typeof AppendBlockChildrenParamsSchema
  >

  export const GetDatabaseParamsSchema = z.object({ database_id: z.string() })
  export type GetDatabaseParams = z.infer<typeof GetDatabaseParamsSchema>

  export const GetDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type GetDatabaseResponse = z.infer<typeof GetDatabaseResponseSchema>

  export const UpdateDatabaseParamsSchema = z
    .object({ database_id: z.string() })
    .merge(UpdateDatabaseParametersSchema)
  export type UpdateDatabaseParams = z.infer<typeof UpdateDatabaseParamsSchema>

  export const UpdateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type UpdateDatabaseResponse = z.infer<
    typeof UpdateDatabaseResponseSchema
  >

  export const QueryDatabaseParamsSchema = z
    .object({
      database_id: z.string(),
      filter_properties: z.array(z.string()).optional()
    })
    .merge(QueryDatabaseParametersSchema)
  export type QueryDatabaseParams = z.infer<typeof QueryDatabaseParamsSchema>

  export const ListDatabasesParamsSchema = z.object({
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListDatabasesParams = z.infer<typeof ListDatabasesParamsSchema>

  export const CreateDatabaseParamsSchema = CreateDatabaseParametersSchema
  export type CreateDatabaseParams = z.infer<typeof CreateDatabaseParamsSchema>

  export const CreateDatabaseResponseSchema = z.union([
    PartialDatabaseObjectResponseSchema,
    DatabaseObjectResponseSchema
  ])
  export type CreateDatabaseResponse = z.infer<
    typeof CreateDatabaseResponseSchema
  >

  export const SearchParamsSchema = SearchParametersSchema
  export type SearchParams = z.infer<typeof SearchParamsSchema>

  export const ListCommentsParamsSchema = z.object({
    block_id: z.string(),
    start_cursor: z.string().optional(),
    page_size: z.number().int().optional()
  })
  export type ListCommentsParams = z.infer<typeof ListCommentsParamsSchema>

  export const CreateCommentParamsSchema = CreateCommentParametersSchema
  export type CreateCommentParams = z.infer<typeof CreateCommentParamsSchema>

  export const CreateCommentResponseSchema = z.union([
    CommentObjectResponseSchema,
    PartialCommentObjectResponseSchema
  ])
  export type CreateCommentResponse = z.infer<
    typeof CreateCommentResponseSchema
  >

  export const OauthTokenParamsSchema = OauthTokenParametersSchema
  export type OauthTokenParams = z.infer<typeof OauthTokenParamsSchema>
}


/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  aiFunction,
  assert,
  getEnv,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { notion } from './notion'

/**
 * Agentic Notion client.
 *
 * API specification for Notion.
 */
export class NotionClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('NOTION_API_KEY'),
    apiBaseUrl = notion.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'NotionClient missing required "apiKey" (defaults to "NOTION_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: \`Bearer \${apiKey}\`
      }
    })
  }

  /**
   * Get current user.
   */
  @aiFunction({
    name: 'notion_get_self',
    description: \`Get current user.\`,
    inputSchema: notion.GetSelfParamsSchema
  })
  async getSelf(
    _params: notion.GetSelfParams
  ): Promise<notion.GetSelfResponse> {
    return this.ky.get('/users/me').json<notion.GetSelfResponse>()
  }

  /**
   * Get user.
   */
  @aiFunction({
    name: 'notion_get_user',
    description: \`Get user.\`,
    inputSchema: notion.GetUserParamsSchema
  })
  async getUser(params: notion.GetUserParams): Promise<notion.GetUserResponse> {
    return this.ky
      .get(\`/users/\${params['user_id']}\`)
      .json<notion.GetUserResponse>()
  }

  /**
   * List users.
   */
  @aiFunction({
    name: 'notion_list_users',
    description: \`List users.\`,
    inputSchema: notion.ListUsersParamsSchema
  })
  async listUsers(
    params: notion.ListUsersParams
  ): Promise<notion.ListUsersResponse> {
    return this.ky
      .get('/users', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListUsersResponse>()
  }

  /**
   * Create page.
   */
  @aiFunction({
    name: 'notion_create_page',
    description: \`Create page.\`,
    inputSchema: notion.CreatePageParamsSchema
  })
  async createPage(
    params: notion.CreatePageParams
  ): Promise<notion.CreatePageResponse> {
    return this.ky
      .post('/pages', {
        json: pick(params, 'parent', 'properties')
      })
      .json<notion.CreatePageResponse>()
  }

  /**
   * Get page.
   */
  @aiFunction({
    name: 'notion_get_page',
    description: \`Get page.\`,
    inputSchema: notion.GetPageParamsSchema
  })
  async getPage(params: notion.GetPageParams): Promise<notion.GetPageResponse> {
    return this.ky
      .get(\`/pages/\${params['page_id']}\`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties'))
      })
      .json<notion.GetPageResponse>()
  }

  /**
   * Update page.
   */
  @aiFunction({
    name: 'notion_update_page',
    description: \`Update page.\`,
    inputSchema: notion.UpdatePageParamsSchema
  })
  async updatePage(
    params: notion.UpdatePageParams
  ): Promise<notion.UpdatePageResponse> {
    return this.ky
      .patch(\`/pages/\${params['page_id']}\`, {
        json: pick(params, 'properties', 'archived')
      })
      .json<notion.UpdatePageResponse>()
  }

  /**
   * Get page property.
   */
  @aiFunction({
    name: 'notion_get_page_property',
    description: \`Get page property.\`,
    inputSchema: notion.GetPagePropertyParamsSchema
  })
  async getPageProperty(
    params: notion.GetPagePropertyParams
  ): Promise<notion.GetPagePropertyResponse> {
    return this.ky
      .get(\`/pages/\${params['page_id']}/properties/\${params['property_id']}\`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.GetPagePropertyResponse>()
  }

  /**
   * Get block.
   */
  @aiFunction({
    name: 'notion_get_block',
    description: \`Get block.\`,
    inputSchema: notion.GetBlockParamsSchema
  })
  async getBlock(
    params: notion.GetBlockParams
  ): Promise<notion.GetBlockResponse> {
    return this.ky
      .get(\`/blocks/\${params['block_id']}\`)
      .json<notion.GetBlockResponse>()
  }

  /**
   * Delete block.
   */
  @aiFunction({
    name: 'notion_delete_block',
    description: \`Delete block.\`,
    inputSchema: notion.DeleteBlockParamsSchema
  })
  async deleteBlock(
    params: notion.DeleteBlockParams
  ): Promise<notion.DeleteBlockResponse> {
    return this.ky
      .delete(\`/blocks/\${params['block_id']}\`)
      .json<notion.DeleteBlockResponse>()
  }

  /**
   * Update block.
   */
  @aiFunction({
    name: 'notion_update_block',
    description: \`Update block.\`,
    inputSchema: notion.UpdateBlockParamsSchema
  })
  async updateBlock(
    params: notion.UpdateBlockParams
  ): Promise<notion.UpdateBlockResponse> {
    return this.ky
      .patch(\`/blocks/\${params['block_id']}\`, {
        json: pick(
          params,
          'paragraph',
          'heading_1',
          'heading_2',
          'heading_3',
          'bulleted_list_item',
          'numbered_list_item',
          'quote',
          'to_do',
          'toggle',
          'code',
          'embed',
          'image',
          'video',
          'file',
          'pdf',
          'bookmark',
          'equation',
          'divider',
          'table_of_contents',
          'breadcrumb',
          'column_list',
          'column',
          'link_to_page',
          'table_row',
          'archived'
        )
      })
      .json<notion.UpdateBlockResponse>()
  }

  /**
   * List block children.
   */
  @aiFunction({
    name: 'notion_list_block_children',
    description: \`List block children.\`,
    inputSchema: notion.ListBlockChildrenParamsSchema
  })
  async listBlockChildren(
    params: notion.ListBlockChildrenParams
  ): Promise<notion.ListBlockChildrenResponse> {
    return this.ky
      .get(\`/blocks/\${params['block_id']}/children\`, {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListBlockChildrenResponse>()
  }

  /**
   * Append block children.
   */
  @aiFunction({
    name: 'notion_append_block_children',
    description: \`Append block children.\`,
    inputSchema: notion.AppendBlockChildrenParamsSchema
  })
  async appendBlockChildren(
    params: notion.AppendBlockChildrenParams
  ): Promise<notion.AppendBlockChildrenResponse> {
    return this.ky
      .patch(\`/blocks/\${params['block_id']}/children\`, {
        json: pick(params, 'children')
      })
      .json<notion.AppendBlockChildrenResponse>()
  }

  /**
   * Get database.
   */
  @aiFunction({
    name: 'notion_get_database',
    description: \`Get database.\`,
    inputSchema: notion.GetDatabaseParamsSchema
  })
  async getDatabase(
    params: notion.GetDatabaseParams
  ): Promise<notion.GetDatabaseResponse> {
    return this.ky
      .get(\`/databases/\${params['database_id']}\`)
      .json<notion.GetDatabaseResponse>()
  }

  /**
   * Update database.
   */
  @aiFunction({
    name: 'notion_update_database',
    description: \`Update database.\`,
    inputSchema: notion.UpdateDatabaseParamsSchema
  })
  async updateDatabase(
    params: notion.UpdateDatabaseParams
  ): Promise<notion.UpdateDatabaseResponse> {
    return this.ky
      .patch(\`/databases/\${params['database_id']}\`, {
        json: pick(
          params,
          'title',
          'description',
          'icon',
          'cover',
          'properties',
          'is_inline',
          'archived'
        )
      })
      .json<notion.UpdateDatabaseResponse>()
  }

  /**
   * Query database.
   */
  @aiFunction({
    name: 'notion_query_database',
    description: \`Query database.\`,
    inputSchema: notion.QueryDatabaseParamsSchema
  })
  async queryDatabase(
    params: notion.QueryDatabaseParams
  ): Promise<notion.QueryDatabaseResponse> {
    return this.ky
      .post(\`/databases/\${params['database_id']}/query\`, {
        searchParams: sanitizeSearchParams(pick(params, 'filter_properties')),
        json: pick(
          params,
          'sorts',
          'filter',
          'start_cursor',
          'page_size',
          'archived'
        )
      })
      .json<notion.QueryDatabaseResponse>()
  }

  /**
   * List databases.
   */
  @aiFunction({
    name: 'notion_list_databases',
    description: \`List databases.\`,
    inputSchema: notion.ListDatabasesParamsSchema
  })
  async listDatabases(
    params: notion.ListDatabasesParams
  ): Promise<notion.ListDatabasesResponse> {
    return this.ky
      .get('/databases', {
        searchParams: sanitizeSearchParams(
          pick(params, 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListDatabasesResponse>()
  }

  /**
   * Create database.
   */
  @aiFunction({
    name: 'notion_create_database',
    description: \`Create database.\`,
    inputSchema: notion.CreateDatabaseParamsSchema
  })
  async createDatabase(
    params: notion.CreateDatabaseParams
  ): Promise<notion.CreateDatabaseResponse> {
    return this.ky
      .post('/databases', {
        json: pick(
          params,
          'parent',
          'properties',
          'icon',
          'cover',
          'title',
          'description',
          'is_inline'
        )
      })
      .json<notion.CreateDatabaseResponse>()
  }

  /**
   * Search.
   */
  @aiFunction({
    name: 'notion_search',
    description: \`Search.\`,
    inputSchema: notion.SearchParamsSchema
  })
  async search(params: notion.SearchParams): Promise<notion.SearchResponse> {
    return this.ky
      .post('/search', {
        json: pick(
          params,
          'query',
          'sort',
          'filter',
          'start_cursor',
          'page_size'
        )
      })
      .json<notion.SearchResponse>()
  }

  /**
   * List comments.
   */
  @aiFunction({
    name: 'notion_list_comments',
    description: \`List comments.\`,
    inputSchema: notion.ListCommentsParamsSchema
  })
  async listComments(
    params: notion.ListCommentsParams
  ): Promise<notion.ListCommentsResponse> {
    return this.ky
      .get('/comments', {
        searchParams: sanitizeSearchParams(
          pick(params, 'block_id', 'start_cursor', 'page_size')
        )
      })
      .json<notion.ListCommentsResponse>()
  }

  /**
   * Create comment.
   */
  @aiFunction({
    name: 'notion_create_comment',
    description: \`Create comment.\`,
    // TODO: Improve handling of union params
    inputSchema: notion.CreateCommentParamsSchema as any
  })
  async createComment(
    params: notion.CreateCommentParams
  ): Promise<notion.CreateCommentResponse> {
    return this.ky
      .post('/comments', {
        json: params
      })
      .json<notion.CreateCommentResponse>()
  }

  /**
   * OAuth token.
   */
  @aiFunction({
    name: 'notion_oauth_token',
    description: \`OAuth token.\`,
    inputSchema: notion.OauthTokenParamsSchema
  })
  async oauthToken(
    params: notion.OauthTokenParams
  ): Promise<notion.OauthTokenResponse> {
    return this.ky
      .post('/oauth/token', {
        json: pick(
          params,
          'grant_type',
          'code',
          'redirect_uri',
          'external_account'
        )
      })
      .json<notion.OauthTokenResponse>()
  }
}
"
`;

exports[`openapi-to-ts > pet-store.json 1`] = `
"/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace petstore {
  export const apiBaseUrl = 'http://petstore.swagger.io/v1'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const PetSchema = z.object({
    id: z.number().int(),
    name: z.string(),
    tag: z.string().optional()
  })
  export type Pet = z.infer<typeof PetSchema>

  export const PetsSchema = z.array(PetSchema).max(100)
  export type Pets = z.infer<typeof PetsSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const ListPetsParamsSchema = z.object({
    /** How many items to return at one time (max 100) */
    limit: z
      .number()
      .int()
      .lte(100)
      .describe('How many items to return at one time (max 100)')
      .optional()
  })
  export type ListPetsParams = z.infer<typeof ListPetsParamsSchema>

  export const ListPetsResponseSchema = PetsSchema
  export type ListPetsResponse = z.infer<typeof ListPetsResponseSchema>

  export const CreatePetsParamsSchema = PetSchema
  export type CreatePetsParams = z.infer<typeof CreatePetsParamsSchema>

  export type CreatePetsResponse = undefined

  export const ShowPetByIdParamsSchema = z.object({
    /** The id of the pet to retrieve */
    petId: z.string().describe('The id of the pet to retrieve')
  })
  export type ShowPetByIdParams = z.infer<typeof ShowPetByIdParamsSchema>

  export const ShowPetByIdResponseSchema = PetSchema
  export type ShowPetByIdResponse = z.infer<typeof ShowPetByIdResponseSchema>
}


/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  aiFunction,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { petstore } from './pet-store'

/**
 * Agentic PetStore client.
 */
export class PetStoreClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = petstore.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * List all pets.
   */
  @aiFunction({
    name: 'pet_store_list_pets',
    description: \`List all pets.\`,
    inputSchema: petstore.ListPetsParamsSchema,
    tags: ['pets']
  })
  async listPets(
    params: petstore.ListPetsParams
  ): Promise<petstore.ListPetsResponse> {
    return this.ky
      .get('/pets', {
        searchParams: sanitizeSearchParams(params)
      })
      .json<petstore.ListPetsResponse>()
  }

  /**
   * Create a pet.
   */
  @aiFunction({
    name: 'pet_store_create_pets',
    description: \`Create a pet.\`,
    inputSchema: petstore.CreatePetsParamsSchema,
    tags: ['pets']
  })
  async createPets(
    params: petstore.CreatePetsParams
  ): Promise<petstore.CreatePetsResponse> {
    return this.ky
      .post('/pets', {
        json: pick(params, 'id', 'name', 'tag')
      })
      .json<petstore.CreatePetsResponse>()
  }

  /**
   * Info for a specific pet.
   */
  @aiFunction({
    name: 'pet_store_show_pet_by_id',
    description: \`Info for a specific pet.\`,
    inputSchema: petstore.ShowPetByIdParamsSchema,
    tags: ['pets']
  })
  async showPetById(
    params: petstore.ShowPetByIdParams
  ): Promise<petstore.ShowPetByIdResponse> {
    return this.ky
      .get(\`/pets/\${params['petId']}\`)
      .json<petstore.ShowPetByIdResponse>()
  }
}
"
`;

exports[`openapi-to-ts > petstore-expanded.json 1`] = `
"/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace petstoreexpanded {
  export const apiBaseUrl = 'http://petstore.swagger.io/api'

  // -----------------------------------------------------------------------------
  // Component schemas
  // -----------------------------------------------------------------------------

  export const NewPetSchema = z.object({
    name: z.string(),
    tag: z.string().optional()
  })
  export type NewPet = z.infer<typeof NewPetSchema>

  export const PetSchema = z.intersection(
    NewPetSchema,
    z.object({ id: z.number().int() })
  )
  export type Pet = z.infer<typeof PetSchema>

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const FindPetsParamsSchema = z.object({
    /** tags to filter by */
    tags: z.array(z.string()).describe('tags to filter by').optional(),
    /** maximum number of results to return */
    limit: z
      .number()
      .int()
      .describe('maximum number of results to return')
      .optional()
  })
  export type FindPetsParams = z.infer<typeof FindPetsParamsSchema>

  export const FindPetsResponseSchema = z.array(PetSchema)
  export type FindPetsResponse = z.infer<typeof FindPetsResponseSchema>

  export const AddPetParamsSchema = NewPetSchema
  export type AddPetParams = z.infer<typeof AddPetParamsSchema>

  export const AddPetResponseSchema = PetSchema
  export type AddPetResponse = z.infer<typeof AddPetResponseSchema>

  export const FindPetByIdParamsSchema = z.object({
    /** ID of pet to fetch */
    id: z.number().int().describe('ID of pet to fetch')
  })
  export type FindPetByIdParams = z.infer<typeof FindPetByIdParamsSchema>

  export const FindPetByIdResponseSchema = PetSchema
  export type FindPetByIdResponse = z.infer<typeof FindPetByIdResponseSchema>

  export const DeletePetParamsSchema = z.object({
    /** ID of pet to delete */
    id: z.number().int().describe('ID of pet to delete')
  })
  export type DeletePetParams = z.infer<typeof DeletePetParamsSchema>

  export type DeletePetResponse = undefined
}


/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  aiFunction,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { petstoreexpanded } from './petstore-expanded'

/**
 * Agentic PetstoreExpanded client.
 *
 * A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification.
 */
export class PetstoreExpandedClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = petstoreexpanded.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
 * Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
 */
  @aiFunction({
    name: 'petstore_expanded_find_pets',
    description: \`Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\`,
    inputSchema: petstoreexpanded.FindPetsParamsSchema
  })
  async findPets(
    params: petstoreexpanded.FindPetsParams
  ): Promise<petstoreexpanded.FindPetsResponse> {
    return this.ky
      .get('/pets', {
        searchParams: sanitizeSearchParams(pick(params, 'tags', 'limit'))
      })
      .json<petstoreexpanded.FindPetsResponse>()
  }

  /**
   * Creates a new pet in the store. Duplicates are allowed.
   */
  @aiFunction({
    name: 'petstore_expanded_add_pet',
    description: \`Creates a new pet in the store. Duplicates are allowed.\`,
    inputSchema: petstoreexpanded.AddPetParamsSchema
  })
  async addPet(
    params: petstoreexpanded.AddPetParams
  ): Promise<petstoreexpanded.AddPetResponse> {
    return this.ky
      .post('/pets', {
        json: pick(params, 'name', 'tag')
      })
      .json<petstoreexpanded.AddPetResponse>()
  }

  /**
   * Returns a user based on a single ID, if the user does not have access to the pet.
   */
  @aiFunction({
    name: 'petstore_expanded_find_pet_by_id',
    description: \`Returns a user based on a single ID, if the user does not have access to the pet.\`,
    inputSchema: petstoreexpanded.FindPetByIdParamsSchema
  })
  async findPetById(
    params: petstoreexpanded.FindPetByIdParams
  ): Promise<petstoreexpanded.FindPetByIdResponse> {
    return this.ky
      .get(\`/pets/\${params['id']}\`)
      .json<petstoreexpanded.FindPetByIdResponse>()
  }

  /**
   * deletes a single pet based on the ID supplied.
   */
  @aiFunction({
    name: 'petstore_expanded_delete_pet',
    description: \`deletes a single pet based on the ID supplied.\`,
    inputSchema: petstoreexpanded.DeletePetParamsSchema
  })
  async deletePet(
    params: petstoreexpanded.DeletePetParams
  ): Promise<petstoreexpanded.DeletePetResponse> {
    return this.ky
      .delete(\`/pets/\${params['id']}\`)
      .json<petstoreexpanded.DeletePetResponse>()
  }
}
"
`;

exports[`openapi-to-ts > security.json 1`] = `
"/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'

export namespace security {
  export const apiBaseUrl = 'https://httpbin.org'

  // -----------------------------------------------------------------------------
  // Operation schemas
  // -----------------------------------------------------------------------------

  export const GetAnythingApiKeyParamsSchema = z.object({})
  export type GetAnythingApiKeyParams = z.infer<
    typeof GetAnythingApiKeyParamsSchema
  >

  export type GetAnythingApiKeyResponse = undefined

  export const PostAnythingApiKeyParamsSchema = z.object({})
  export type PostAnythingApiKeyParams = z.infer<
    typeof PostAnythingApiKeyParamsSchema
  >

  export type PostAnythingApiKeyResponse = undefined

  export const PutAnythingApiKeyParamsSchema = z.object({})
  export type PutAnythingApiKeyParams = z.infer<
    typeof PutAnythingApiKeyParamsSchema
  >

  export type PutAnythingApiKeyResponse = undefined

  export const PostAnythingBasicParamsSchema = z.object({})
  export type PostAnythingBasicParams = z.infer<
    typeof PostAnythingBasicParamsSchema
  >

  export type PostAnythingBasicResponse = undefined

  export const PostAnythingBearerParamsSchema = z.object({})
  export type PostAnythingBearerParams = z.infer<
    typeof PostAnythingBearerParamsSchema
  >

  export type PostAnythingBearerResponse = undefined

  export const PutAnythingBearerParamsSchema = z.object({})
  export type PutAnythingBearerParams = z.infer<
    typeof PutAnythingBearerParamsSchema
  >

  export type PutAnythingBearerResponse = undefined

  export const GetAnythingOauth2ParamsSchema = z.object({})
  export type GetAnythingOauth2Params = z.infer<
    typeof GetAnythingOauth2ParamsSchema
  >

  export type GetAnythingOauth2Response = undefined

  export const PostAnythingOauth2ParamsSchema = z.object({})
  export type PostAnythingOauth2Params = z.infer<
    typeof PostAnythingOauth2ParamsSchema
  >

  export type PostAnythingOauth2Response = undefined

  export const PutAnythingOauth2ParamsSchema = z.object({})
  export type PutAnythingOauth2Params = z.infer<
    typeof PutAnythingOauth2ParamsSchema
  >

  export type PutAnythingOauth2Response = undefined

  export const DeleteAnythingOauth2ParamsSchema = z.object({})
  export type DeleteAnythingOauth2Params = z.infer<
    typeof DeleteAnythingOauth2ParamsSchema
  >

  export type DeleteAnythingOauth2Response = undefined

  export const PatchAnythingOauth2ParamsSchema = z.object({})
  export type PatchAnythingOauth2Params = z.infer<
    typeof PatchAnythingOauth2ParamsSchema
  >

  export type PatchAnythingOauth2Response = undefined

  export const PostAnythingOpenIdConnectParamsSchema = z.object({})
  export type PostAnythingOpenIdConnectParams = z.infer<
    typeof PostAnythingOpenIdConnectParamsSchema
  >

  export type PostAnythingOpenIdConnectResponse = undefined

  export const PostAnythingNoAuthParamsSchema = z.object({})
  export type PostAnythingNoAuthParams = z.infer<
    typeof PostAnythingNoAuthParamsSchema
  >

  export type PostAnythingNoAuthResponse = undefined

  export const GetAnythingOptionalAuthParamsSchema = z.object({})
  export type GetAnythingOptionalAuthParams = z.infer<
    typeof GetAnythingOptionalAuthParamsSchema
  >

  export type GetAnythingOptionalAuthResponse = undefined

  export const PostStatus401ParamsSchema = z.object({})
  export type PostStatus401Params = z.infer<typeof PostStatus401ParamsSchema>

  export type PostStatus401Response = undefined
}


/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { AIFunctionsProvider, aiFunction } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { security } from './security'

/**
 * Agentic Security client.
 *
 * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject.
 */
export class SecurityClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance

  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = security.apiBaseUrl,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl
    })
  }

  /**
   * \`apiKey\` auth will be supplied within an \`apiKey\` query parameter.
   */
  @aiFunction({
    name: 'security_get_anything_api_key',
    description: \`\\\`apiKey\\\` auth will be supplied within an \\\`apiKey\\\` query parameter.\`,
    inputSchema: security.GetAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async getAnythingApiKey(
    _params: security.GetAnythingApiKeyParams
  ): Promise<security.GetAnythingApiKeyResponse> {
    return this.ky
      .get('/anything/apiKey')
      .json<security.GetAnythingApiKeyResponse>()
  }

  /**
   * \`apiKey\` auth will be supplied within an \`api_key\` cookie.
   */
  @aiFunction({
    name: 'security_post_anything_api_key',
    description: \`\\\`apiKey\\\` auth will be supplied within an \\\`api_key\\\` cookie.\`,
    inputSchema: security.PostAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async postAnythingApiKey(
    _params: security.PostAnythingApiKeyParams
  ): Promise<security.PostAnythingApiKeyResponse> {
    return this.ky
      .post('/anything/apiKey')
      .json<security.PostAnythingApiKeyResponse>()
  }

  /**
   * \`apiKey\` auth will be supplied within an \`X-API-KEY\` header.
   */
  @aiFunction({
    name: 'security_put_anything_api_key',
    description: \`\\\`apiKey\\\` auth will be supplied within an \\\`X-API-KEY\\\` header.\`,
    inputSchema: security.PutAnythingApiKeyParamsSchema,
    tags: ['API Key']
  })
  async putAnythingApiKey(
    _params: security.PutAnythingApiKeyParams
  ): Promise<security.PutAnythingApiKeyResponse> {
    return this.ky
      .put('/anything/apiKey')
      .json<security.PutAnythingApiKeyResponse>()
  }

  /**
 * Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.
 */
  @aiFunction({
    name: 'security_post_anything_basic',
    description: \`Authentication credentials will be supplied within a \\\`Basic\\\` \\\`Authorization\\\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`,
    inputSchema: security.PostAnythingBasicParamsSchema,
    tags: ['HTTP']
  })
  async postAnythingBasic(
    _params: security.PostAnythingBasicParams
  ): Promise<security.PostAnythingBasicResponse> {
    return this.ky
      .post('/anything/basic')
      .json<security.PostAnythingBasicResponse>()
  }

  /**
 * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.
 */
  @aiFunction({
    name: 'security_post_anything_bearer',
    description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`,
    inputSchema: security.PostAnythingBearerParamsSchema,
    tags: ['HTTP']
  })
  async postAnythingBearer(
    _params: security.PostAnythingBearerParams
  ): Promise<security.PostAnythingBearerResponse> {
    return this.ky
      .post('/anything/bearer')
      .json<security.PostAnythingBearerResponse>()
  }

  /**
 * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.
 */
  @aiFunction({
    name: 'security_put_anything_bearer',
    description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \\\`Bearer\\\` authentication token.\`,
    inputSchema: security.PutAnythingBearerParamsSchema,
    tags: ['HTTP']
  })
  async putAnythingBearer(
    _params: security.PutAnythingBearerParams
  ): Promise<security.PutAnythingBearerResponse> {
    return this.ky
      .put('/anything/bearer')
      .json<security.PutAnythingBearerResponse>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_get_anything_oauth2',
    description: \`> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`,
    inputSchema: security.GetAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async getAnythingOauth2(
    _params: security.GetAnythingOauth2Params
  ): Promise<security.GetAnythingOauth2Response> {
    return this.ky
      .get('/anything/oauth2')
      .json<security.GetAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_post_anything_oauth2',
    description: \`> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`,
    inputSchema: security.PostAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async postAnythingOauth2(
    _params: security.PostAnythingOauth2Params
  ): Promise<security.PostAnythingOauth2Response> {
    return this.ky
      .post('/anything/oauth2')
      .json<security.PostAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_put_anything_oauth2',
    description: \`> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`,
    inputSchema: security.PutAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async putAnythingOauth2(
    _params: security.PutAnythingOauth2Params
  ): Promise<security.PutAnythingOauth2Response> {
    return this.ky
      .put('/anything/oauth2')
      .json<security.PutAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_delete_anything_oauth2',
    description: \`> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`,
    inputSchema: security.DeleteAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async deleteAnythingOauth2(
    _params: security.DeleteAnythingOauth2Params
  ): Promise<security.DeleteAnythingOauth2Response> {
    return this.ky
      .delete('/anything/oauth2')
      .json<security.DeleteAnythingOauth2Response>()
  }

  /**
 * > ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.
 */
  @aiFunction({
    name: 'security_patch_anything_oauth2',
    description: \`> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`,
    inputSchema: security.PatchAnythingOauth2ParamsSchema,
    tags: ['OAuth 2']
  })
  async patchAnythingOauth2(
    _params: security.PatchAnythingOauth2Params
  ): Promise<security.PatchAnythingOauth2Response> {
    return this.ky
      .patch('/anything/oauth2')
      .json<security.PatchAnythingOauth2Response>()
  }

  /**
   * 🚧 This is not supported.
   */
  @aiFunction({
    name: 'security_post_anything_open_id_connect',
    description: \`🚧 This is not supported.\`,
    inputSchema: security.PostAnythingOpenIdConnectParamsSchema,
    tags: ['OpenID Connect']
  })
  async postAnythingOpenIdConnect(
    _params: security.PostAnythingOpenIdConnectParams
  ): Promise<security.PostAnythingOpenIdConnectResponse> {
    return this.ky
      .post('/anything/openIdConnect')
      .json<security.PostAnythingOpenIdConnectResponse>()
  }

  /**
   * This operation does not have any authentication requirements.
   */
  @aiFunction({
    name: 'security_post_anything_no_auth',
    description: \`This operation does not have any authentication requirements.\`,
    inputSchema: security.PostAnythingNoAuthParamsSchema,
    tags: ['Other']
  })
  async postAnythingNoAuth(
    _params: security.PostAnythingNoAuthParams
  ): Promise<security.PostAnythingNoAuthResponse> {
    return this.ky
      .post('/anything/no-auth')
      .json<security.PostAnythingNoAuthResponse>()
  }

  /**
 * The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.
 */
  @aiFunction({
    name: 'security_get_anything_optional_auth',
    description: \`The \\\`apiKey\\\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.\`,
    inputSchema: security.GetAnythingOptionalAuthParamsSchema,
    tags: ['Other']
  })
  async getAnythingOptionalAuth(
    _params: security.GetAnythingOptionalAuthParams
  ): Promise<security.GetAnythingOptionalAuthResponse> {
    return this.ky
      .get('/anything/optional-auth')
      .json<security.GetAnythingOptionalAuthResponse>()
  }

  /**
   * This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.
   */
  @aiFunction({
    name: 'security_post_status401',
    description: \`This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.\`,
    inputSchema: security.PostStatus401ParamsSchema,
    tags: ['Other']
  })
  async postStatus401(
    _params: security.PostStatus401Params
  ): Promise<security.PostStatus401Response> {
    return this.ky.post('/status/401').json<security.PostStatus401Response>()
  }
}
"
`;


================================================
FILE: legacy/packages/openapi-to-ts/src/generate-ts-from-openapi.test.ts
================================================
import path from 'node:path'
import { fileURLToPath } from 'node:url'

import { describe, expect, test } from 'vitest'

import { generateTSFromOpenAPI } from './generate-ts-from-openapi'

const fixtures = [
  'firecrawl.json',
  // 'github.json', // TODO: not working 100% yet
  'notion.json',
  // 'open-meteo.yaml',
  'pet-store.json',
  'petstore-expanded.json',
  'security.json'
  // 'stripe.json', // TODO: not working 100% yet
  // 'tic-tac-toe.json'
]

const dirname = path.join(fileURLToPath(import.meta.url), '..', '..')

describe('openapi-to-ts', () => {
  for (const fixture of fixtures) {
    test(
      fixture,
      {
        timeout: 60_000
      },
      async () => {
        const fixturePath = path.join(dirname, 'fixtures', 'openapi', fixture)
        const outputDir = path.join(dirname, 'fixtures', 'generated')

        const result = await generateTSFromOpenAPI({
          openapiFilePath: fixturePath,
          outputDir
        })
        expect(result).toMatchSnapshot()
      }
    )
  }
})


================================================
FILE: legacy/packages/openapi-to-ts/src/generate-ts-from-openapi.ts
================================================
/* eslint-disable no-template-curly-in-string */
import * as fs from 'node:fs/promises'
import path from 'node:path'

import type { IJsonSchema, OpenAPIV3 } from 'openapi-types'
import { assert } from '@agentic/core'
import SwaggerParser from '@apidevtools/swagger-parser'
import decamelize from 'decamelize'
import { execa } from 'execa'

import type { GenerateTSFromOpenAPIOptions } from './types'
import { convertParametersToJSONSchema } from './openapi-parameters-to-json-schema'
import {
  camelCase,
  dereference,
  dereferenceFull,
  getAndResolve,
  getComponentDisplayName,
  getDescription,
  getOperationParamsName,
  getOperationResponseName,
  jsonSchemaToZod,
  naiveMergeJSONSchemas,
  pascalCase,
  prettify
} from './utils'

const jsonContentType = 'application/json'
const multipartFormData = 'multipart/form-data'

const httpMethods = [
  'get',
  'post',
  'put',
  'delete',
  'options',
  'head',
  'patch',
  'trace'
] as const

export async function generateTSFromOpenAPI({
  openapiFilePath,
  outputDir,
  dryRun = false,
  prettier = true,
  eslint = true,
  zodSchemaJsDocs = true
}: GenerateTSFromOpenAPIOptions): Promise<string> {
  const parser = new SwaggerParser()
  const spec = (await parser.bundle(openapiFilePath)) as OpenAPIV3.Document
  // | OpenAPIV3_1.Document

  if (
    // TODO: make this less brittle
    spec.openapi !== '3.0.0' &&
    spec.openapi !== '3.1.0' &&
    spec.openapi !== '3.1.1' &&
    spec.openapi.split('.')[0] !== '3'
  ) {
    throw new Error(`Unexpected OpenAPI version "${spec.openapi}"`)
  }

  const openapiSpecName = path
    .basename(openapiFilePath)
    .replace(/\.json$/, '')
    .replace(/\.yaml$/, '')
  assert(
    openapiSpecName.toLowerCase() === openapiSpecName,
    `OpenAPI spec name "${openapiSpecName}" must be in kebab case`
  )
  const name = pascalCase(openapiSpecName)
  const nameLowerCase = name.toLowerCase()
  const nameSnakeCase = decamelize(name)
  const nameKebabCase = decamelize(name, { separator: '-' })
  const nameUpperCase = nameSnakeCase.toUpperCase()
  const clientName = `${name}Client`
  const namespaceName = nameLowerCase

  const destFileClient = path.join(outputDir, `${nameKebabCase}-client.ts`)
  const destFileTypes = path.join(outputDir, `${nameKebabCase}.ts`)
  const apiBaseUrl = spec.servers?.[0]?.url

  const securitySchemes = spec.components?.securitySchemes
  const resolvedSecuritySchemes: Record<
    string,
    OpenAPIV3.SecuritySchemeObject
  > = {}
  const apiKeyHeaderNames: string[] = []

  if (securitySchemes) {
    for (const [securitySchemaName, maybeSecuritySchema] of Object.entries(
      securitySchemes
    )) {
      const securitySchema = dereferenceFull(maybeSecuritySchema, parser.$refs)
      if (!securitySchema) continue

      resolvedSecuritySchemes[securitySchemaName] = securitySchema

      switch (securitySchema.type) {
        case 'apiKey':
          apiKeyHeaderNames.push(securitySchemaName)
          break

        case 'http':
          if (securitySchema.scheme === 'bearer') {
            apiKeyHeaderNames.push(securitySchemaName)
          }
          break

        case 'oauth2':
          apiKeyHeaderNames.push(securitySchemaName)
          break

        default:
          console.log(
            'unsupported security schema',
            securitySchemaName,
            securitySchema
          )
      }
    }
  }

  const hasGlobalApiKeyInHeader = apiKeyHeaderNames.length === 1
  const componentsToProcess = new Set<string>()

  const requestBodyJSONSchemaPaths = [
    'requestBody',
    'content',
    jsonContentType,
    'schema'
  ]

  const requestBodyFormDataJSONSchemaPaths = [
    'requestBody',
    'content',
    multipartFormData,
    'schema'
  ]

  const operationResponsePaths = [
    ['responses', '200', 'content', jsonContentType, 'schema'],
    ['responses', '201', 'content', jsonContentType, 'schema']
    // ['responses', 'default', 'content', jsonContentType, 'schema']
  ]

  const operationRequestPaths = [
    requestBodyJSONSchemaPaths,
    requestBodyFormDataJSONSchemaPaths
  ]

  const operationNames = new Set<string>()
  const operationSchemas: Record<string, string> = {}
  const componentSchemas: Record<string, string> = {}
  const aiClientMethods: string[] = []

  for (const path in spec.paths) {
    const pathItem = spec.paths[path]
    assert(pathItem)
    // console.log(JSON.stringify(pathItem, null, 2))

    for (const method of httpMethods) {
      const operation = pathItem[method]
      if (!operation) {
        continue
      }

      if (method === 'trace' || method === 'options') {
        continue
      }

      const operationId =
        operation.operationId || `${method}${path.replaceAll(/\W+/g, '_')}`
      assert(
        operationId,
        `Invalid operation id ${operationId} for path "${method} ${path}"`
      )

      const operationName = camelCase(operationId.replaceAll('/', '-'))
      assert(
        !operationNames.has(operationName),
        `Duplicate operation name "${operationName}"`
      )
      operationNames.add(operationName)
      const operationNameSnakeCaseTemp = decamelize(operationName)
      const operationNameSnakeCase = operationNameSnakeCaseTemp.startsWith(
        `${nameSnakeCase}_`
      )
        ? operationNameSnakeCaseTemp
        : `${nameSnakeCase}_${operationNameSnakeCaseTemp}`

      // if (path !== '/comments' || method !== 'post') continue
      // if (path !== '/crawl/status/{jobId}') continue
      // if (path !== '/pets' || method !== 'post') continue
      // console.log(method, path, operationName)

      const operationParamsJSONSchema = {
        type: 'object',
        properties: {} as Record<string, any>,
        required: [] as string[],
        $refs: [] as string[],
        oneOf: undefined as IJsonSchema[] | undefined,
        anyOf: undefined as IJsonSchema[] | undefined
        // TODO
        // allOf: undefined as IJsonSchema[] | undefined
      }

      const operationResponseJSONSchemas: Record<string, IJsonSchema> = {}

      const operationParamsSources: Record<string, Set<string>> = {}
      let operationParamsUnionSource: string | undefined

      // eslint-disable-next-line unicorn/consistent-function-scoping
      function addJSONSchemaParams(schema: IJsonSchema, source: string) {
        dereferenceFull(schema, parser.$refs, componentsToProcess)

        if (schema.$ref) {
          operationParamsJSONSchema.$refs.push(schema.$ref)

          const derefed = dereference(schema, parser.$refs, componentsToProcess)
          if (derefed?.properties) {
            for (const key of Object.keys(derefed.properties)) {
              // assert(
              //   !operationParamsSources[key],
              //   `Duplicate params key ${key} for operation ${operationName} from ${operationParamsSources[key]} and ${source}`
              // )
              operationParamsSources[key] = new Set([
                ...(operationParamsSources[key] || []),
                source
              ])
            }
          } else if (derefed?.anyOf || derefed?.oneOf) {
            const componentName = getComponentDisplayName(schema.$ref)
            operationParamsSources[componentName] = new Set([
              ...(operationParamsSources[componentName] || []),
              source
            ])

            // TODO: handle this case
            assert(
              !operationParamsUnionSource,
              `Duplicate union source ${source} for operation ${operationName}`
            )
            operationParamsUnionSource = source
          }
        } else {
          if (schema.properties) {
            operationParamsJSONSchema.properties = {
              ...operationParamsJSONSchema.properties,
              ...schema.properties
            }

            for (const key of Object.keys(schema.properties)) {
              // assert(
              //   !operationParamsSources[key],
              //   `Duplicate params key "${key}" for operation "${operationName}" from "${operationParamsSources[key]}" and "${source}"`
              // )
              operationParamsSources[key] = new Set([
                ...(operationParamsSources[key] || []),
                source
              ])
            }
          }

          if (schema.required) {
            operationParamsJSONSchema.required = [
              ...operationParamsJSONSchema.required,
              ...schema.required
            ]
          }

          if (schema.anyOf || schema.oneOf) {
            operationParamsJSONSchema.anyOf = schema.anyOf
            operationParamsJSONSchema.oneOf = schema.oneOf
            operationParamsSources[schema.title || '__union__'] = new Set([
              ...(operationParamsSources[schema.title || '__union__'] || []),
              source
            ])

            // TODO: handle this case
            assert(
              !operationParamsUnionSource,
              `Duplicate union source ${source} for operation ${operationName}`
            )
            operationParamsUnionSource = source
          }
        }
      }

      // eslint-disable-next-line unicorn/consistent-function-scoping
      function addJSONSchemaResponse(schema: IJsonSchema, status: string) {
        dereferenceFull(schema, parser.$refs, componentsToProcess)
        operationResponseJSONSchemas[status] = schema
      }

      for (const schemaPath of operationRequestPaths) {
        const res = getAndResolve(
          operation,
          schemaPath,
          parser.$refs,
          componentsToProcess
        )

        if (res) {
          addJSONSchemaParams(
            res,
            schemaPath[2] === jsonContentType ? 'body' : 'formData'
          )
          break
        }
      }

      for (const schemaPath of operationResponsePaths) {
        const res = getAndResolve(
          operation,
          schemaPath,
          parser.$refs,
          componentsToProcess
        )

        if (res) {
          const status = schemaPath[1]!
          assert(
            status,
            `Invalid status ${status} for operation ${operationName}`
          )

          addJSONSchemaResponse(res, status)
          break
        }
      }

      if (operation.parameters) {
        const parameters = operation.parameters.map((param) =>
          dereference(param, parser.$refs, componentsToProcess)
        )
        const params = convertParametersToJSONSchema(parameters)

        if (params.body) {
          addJSONSchemaParams(params.body, 'body')
        }

        if (params.formData) {
          addJSONSchemaParams(params.formData, 'formData')
        }

        if (params.headers) {
          addJSONSchemaParams(params.headers, 'headers')
        }

        if (params.path) {
          addJSONSchemaParams(params.path, 'path')
        }

        if (params.query) {
          addJSONSchemaParams(params.query, 'query')
        }
      }

      const operationParamsName = getOperationParamsName(
        operationName,
        componentSchemas
      )
      const operationResponseName = getOperationResponseName(operationName)
      let derefedParams: any = dereference(
        operationParamsJSONSchema,
        parser.$refs
      )
      for (const ref of derefedParams.$refs) {
        const temp: any = dereference({ $ref: ref }, parser.$refs)
        if (temp) {
          derefedParams = naiveMergeJSONSchemas(derefedParams, temp)
        }
      }
      // console.log(JSON.stringify(derefedParams, null, 2))
      const hasUnionParams = !!(derefedParams.anyOf || derefedParams.oneOf)
      const hasParams =
        Object.keys(derefedParams.properties ?? {}).length > 0 || hasUnionParams

      if (hasUnionParams !== !!operationParamsUnionSource) {
        console.log(
          JSON.stringify(
            { derefedParams, hasUnionParams, operationParamsUnionSource },
            null,
            2
          )
        )
      }

      assert(
        hasUnionParams === !!operationParamsUnionSource,
        `Unexpected union params for operation ${operationName}`
      )

      // TODO: handle empty params case

      {
        // Merge all operations params into one schema declaration
        // TODO: Don't generate this if it's only refs. We're currently handling
        // this in a hacky way by removing the `z.object({}).merge(...)` down
        // below.
        let operationsParamsSchema = jsonSchemaToZod(
          operationParamsJSONSchema,
          {
            name: `${operationParamsName}Schema`,
            type: operationParamsName,
            withJsdocs: zodSchemaJsDocs
          }
        )

        if (operationParamsJSONSchema.$refs.length) {
          const refSchemas = operationParamsJSONSchema.$refs.map(
            (ref) => `${getComponentDisplayName(ref)!}Schema`
          )

          operationsParamsSchema = operationsParamsSchema.replace(
            // eslint-disable-next-line security/detect-non-literal-regexp
            new RegExp(`(${operationParamsName}Schema = .*)$`, 'm'),
            // eslint-disable-next-line unicorn/no-array-reduce
            refSchemas.reduce(
              (acc, refSchema) => `${acc}.merge(${refSchema})`,
              '$1'
            )
          )
        }

        assert(
          !componentSchemas[operationParamsName],
          `Operation params name "${operationParamsName}" conflicts with component name`
        )
        operationSchemas[operationParamsName] = operationsParamsSchema
      }

      const operationResponseJSONSchema = operationResponseJSONSchemas['200']
      if (operationResponseJSONSchema) {
        let isDuplicateDefinition = false

        if (operationResponseJSONSchema.$ref) {
          const componentName = getComponentDisplayName(
            operationResponseJSONSchema.$ref
          )
          if (componentName === operationResponseName) {
            isDuplicateDefinition = true
          }
        }

        if (!isDuplicateDefinition) {
          const operationResponseSchema = jsonSchemaToZod(
            operationResponseJSONSchema,
            {
              name: `${operationResponseName}Schema`,
              type: operationResponseName,
              withJsdocs: zodSchemaJsDocs
            }
          )

          assert(
            !componentSchemas[operationResponseName],
            `Operation response name "${operationResponseName}" conflicts with component name`
          )
          operationSchemas[operationResponseName] = operationResponseSchema
        }
      } else {
        assert(
          !componentSchemas[operationResponseName],
          `Operation response name "${operationResponseName}" conflicts with component name`
        )
        operationSchemas[operationResponseName] =
          `export type ${operationResponseName} = undefined\n`
      }

      // console.log(
      //   JSON.stringify(
      //     {
      //       operationName,
      //       operationParamsSources,
      //       operationParamsJSONSchema
      //     },
      //     null,
      //     2
      //   )
      // )

      const queryParams = Object.keys(operationParamsSources).filter((key) =>
        operationParamsSources[key]?.has('query')
      )
      const hasQueryParams = queryParams.length > 0

      const bodyParams = Object.keys(operationParamsSources).filter((key) =>
        operationParamsSources[key]?.has('body')
      )
      const hasBodyParams = bodyParams.length > 0

      const formDataParams = Object.keys(operationParamsSources).filter((key) =>
        operationParamsSources[key]?.has('formData')
      )
      const hasFormDataParams = formDataParams.length > 0

      const pathParams = Object.keys(operationParamsSources).filter((key) =>
        operationParamsSources[key]?.has('path')
      )
      const hasPathParams = pathParams.length > 0

      const headersParams = Object.keys(operationParamsSources).filter((key) =>
        operationParamsSources[key]?.has('headers')
      )
      const hasHeadersParams = headersParams.length > 0

      const onlyHasOneParamsSource =
        new Set(Object.values(operationParamsSources)).size === 1
      const onlyHasPathParams = hasPathParams && onlyHasOneParamsSource

      const pathTemplate = hasPathParams
        ? '`' + path.replaceAll(/{([^}]+)}/g, '${params["$1"]}') + '`'
        : `'${path}'`

      const description = getDescription(
        operation.description || operation.summary
      )

      const { tags } = operation
      const hasTags = !!tags?.length

      const aiClientMethod = `
        ${description ? `/**\n * ${description}\n */` : ''}
        @aiFunction({
          name: '${operationNameSnakeCase}',
          ${description ? `description: \`${description.replaceAll('`', '\\`')}\`,` : ''}${hasUnionParams ? '\n// TODO: Improve handling of union params' : ''}
          inputSchema: ${namespaceName}.${operationParamsName}Schema${hasUnionParams ? ' as any' : ''}, ${hasTags ? `tags: [ '${tags.join("', '")}' ]` : ''}
        })
        async ${operationName}(${!hasParams ? '_' : ''}params: ${namespaceName}.${operationParamsName}): Promise<${namespaceName}.${operationResponseName}> {
          return this.ky.${method}(${pathTemplate}${
            !hasParams || onlyHasPathParams
              ? ''
              : `, {
            ${hasQueryParams ? (onlyHasOneParamsSource || hasUnionParams ? `searchParams: sanitizeSearchParams(params),` : `searchParams: sanitizeSearchParams(pick(params, '${queryParams.join("', '")}')),`) : ''}
            ${hasBodyParams ? (onlyHasOneParamsSource || hasUnionParams ? `json: params,` : `json: pick(params, '${bodyParams.join("', '")}'),`) : ''}
            ${hasFormDataParams ? (onlyHasOneParamsSource || hasUnionParams ? `form: params,` : `form: pick(params, '${formDataParams.join("', '")}'),`) : ''}
            ${hasHeadersParams ? (onlyHasOneParamsSource || hasUnionParams ? `headers: params,` : `headers: pick(params, '${headersParams.join("', '")}'),`) : ''}
          }`
          }).json<${namespaceName}.${operationResponseName}>()
        }
      `

      aiClientMethods.push(aiClientMethod)
    }
  }

  const processedComponents = new Set<string>()
  const componentToRefs: Record<
    string,
    { dereferenced: any; refs: Set<string> }
  > = {}

  for (const ref of componentsToProcess) {
    const component = { $ref: ref }

    const resolved = new Set<string>()
    const dereferenced = dereference(component, parser.$refs)
    dereferenceFull(component, parser.$refs, resolved)
    assert(dereferenced)

    for (const ref of resolved) {
      if (ref.startsWith('#/components/examples')) continue

      assert(
        componentsToProcess.has(ref),
        `Ref ${ref} not found in componentsToProcess`
      )
    }

    componentToRefs[ref] = { dereferenced, refs: resolved }
  }

  const sortedComponents = Object.keys(componentToRefs).sort(
    (a, b) => componentToRefs[a]!.refs.size - componentToRefs[b]!.refs.size
  )

  for (const ref of sortedComponents) {
    const type = getComponentDisplayName(ref)
    assert(type, `Invalid ref name ${ref}`)

    const name = `${type}Schema`

    const { dereferenced } = componentToRefs[ref]!
    if (processedComponents.has(ref)) {
      continue
    }

    processedComponents.add(ref)

    const schema = jsonSchemaToZod(dereferenced, {
      name,
      type,
      withJsdocs: zodSchemaJsDocs
    })
    componentSchemas[type] = schema
  }

  // console.log(
  //   '\ncomponents',
  //   JSON.stringify(
  //     sortedComponents.map((ref) => getComponentName(ref)),
  //     null,
  //     2
  //   )
  // )

  // console.log(
  //   '\nmodels',
  //   Object.fromEntries(
  //     await Promise.all(
  //       Object.entries(schemaInput).map(async ([key, value]) => {
  //         return [key, await prettify(value)]
  //       })
  //     )
  //   )
  // )

  const aiClientMethodsString = aiClientMethods.join('\n\n')

  const prettifyImpl = async (code: string) => {
    if (prettier) {
      code = await prettify(code)
    }

    return code
      .replaceAll(/z\s*\.object\({}\)\s*\.merge\(([^)]*)\)/gm, '$1')
      .replaceAll(/\/\*\*(\S.*\S)\*\//g, '/** $1 */')
  }

  const typesHeader = `
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import { z } from 'zod'`.trim()

  const clientHeader = `
/**
 * This file was auto-generated from an OpenAPI spec.
 */

import {
  AIFunctionsProvider,
  ${aiClientMethods.length > 0 ? 'aiFunction,' : ''}
  ${hasGlobalApiKeyInHeader ? 'assert,' : ''}
  ${hasGlobalApiKeyInHeader ? 'getEnv,' : ''}
  ${aiClientMethodsString.includes('pick(') ? 'pick,' : ''}
  ${aiClientMethodsString.includes('sanitizeSearchParams(') ? 'sanitizeSearchParams,' : ''}
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { ${namespaceName} } from './${nameKebabCase}'`.trim()

  const commentLine = `// ${'-'.repeat(77)}`
  const typesOutput = await prettifyImpl(
    [
      typesHeader,
      `export namespace ${namespaceName} {`,
      apiBaseUrl ? `export const apiBaseUrl = '${apiBaseUrl}'` : undefined,
      Object.values(componentSchemas).length
        ? `${commentLine}\n// Component schemas\n${commentLine}`
        : undefined,
      ...Object.values(componentSchemas),
      Object.values(operationSchemas).length
        ? `${commentLine}\n// Operation schemas\n${commentLine}`
        : undefined,
      ...Object.values(operationSchemas),
      '}'
    ]
      .filter(Boolean)
      .join('\n\n')
  )

  const description = getDescription(spec.info?.description)

  const clientOutput = await prettifyImpl(
    [
      clientHeader,
      `
/**
 * Agentic ${name} client.${description ? `\n *\n * ${description}` : ''}
 */
export class ${clientName} extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  ${hasGlobalApiKeyInHeader ? 'protected readonly apiKey: string' : ''}
  protected readonly apiBaseUrl: string

  constructor({
    ${hasGlobalApiKeyInHeader ? `apiKey = getEnv('${nameUpperCase}_API_KEY'),` : ''}
    apiBaseUrl${apiBaseUrl ? ` = ${namespaceName}.apiBaseUrl` : ''},
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    ${
      hasGlobalApiKeyInHeader
        ? `assert(
      apiKey,
      '${clientName} missing required "apiKey" (defaults to "${nameUpperCase}_API_KEY")'
    )`
        : ''
    }
    super()

    ${hasGlobalApiKeyInHeader ? `this.apiKey = apiKey` : ''}
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      ${
        hasGlobalApiKeyInHeader
          ? `headers: {
        ${apiKeyHeaderNames.map((name) => `'${(resolvedSecuritySchemes[name] as any).name || 'Authorization'}': ${(resolvedSecuritySchemes[name] as any).schema?.toLowerCase() === 'bearer' || resolvedSecuritySchemes[name]?.type?.toLowerCase() === 'oauth2' ? '`Bearer ${apiKey}`' : 'apiKey'}`).join(',\n')}
      },`
          : ''
      }
    })
  }
`,
      aiClientMethodsString,
      '}'
    ].join('\n\n')
  )

  const output = [typesOutput, clientOutput].join('\n\n')
  if (dryRun) {
    return output
  }

  await fs.mkdir(outputDir, { recursive: true })
  await fs.writeFile(destFileTypes, typesOutput)
  await fs.writeFile(destFileClient, clientOutput)

  if (eslint) {
    await execa('npx', [
      'eslint',
      '--fix',
      '--no-ignore',
      destFileClient,
      destFileTypes
    ])
  }

  return output
}


================================================
FILE: legacy/packages/openapi-to-ts/src/index.ts
================================================
export * from './generate-ts-from-openapi'
export type * from './types'


================================================
FILE: legacy/packages/openapi-to-ts/src/openapi-parameters-to-json-schema.ts
================================================
/**
 * This file is forked from: https://github.com/kogosoftwarellc/open-api/tree/main/packages/openapi-jsonschema-parameters
 *
 * Several fixes have been applied.
 *
 * The original code is licensed under the MIT license.
 */

import { type IJsonSchema, type OpenAPI } from 'openapi-types'

export interface OpenAPIParametersAsJSONSchema {
  body?: IJsonSchema
  formData?: IJsonSchema
  headers?: IJsonSchema
  path?: IJsonSchema
  query?: IJsonSchema
  cookie?: IJsonSchema
}

const VALIDATION_KEYWORDS = new Set([
  'additionalItems',
  'default',
  'example',
  'description',
  'enum',
  'examples',
  'exclusiveMaximum',
  'exclusiveMinimum',
  'format',
  'items',
  'maxItems',
  'maxLength',
  'maximum',
  'minItems',
  'minLength',
  'minimum',
  'multipleOf',
  'pattern',
  'title',
  'type',
  'uniqueItems'
])

const SUBSCHEMA_KEYWORDS = [
  'additionalItems',
  'items',
  'contains',
  'additionalProperties',
  'propertyNames',
  'not'
]

const SUBSCHEMA_ARRAY_KEYWORDS = ['items', 'allOf', 'anyOf', 'oneOf']

const SUBSCHEMA_OBJECT_KEYWORDS = [
  'definitions',
  'properties',
  'patternProperties',
  'dependencies'
]

export function convertParametersToJSONSchema(
  parameters: OpenAPI.Parameters
): OpenAPIParametersAsJSONSchema {
  const parametersSchema: OpenAPIParametersAsJSONSchema = {}
  const bodySchema = getBodySchema(parameters)
  const formDataSchema = getSchema(parameters, 'formData')
  const headerSchema = getSchema(parameters, 'header')
  const pathSchema = getSchema(parameters, 'path')
  const querySchema = getSchema(parameters, 'query')
  const cookieSchema = getSchema(parameters, 'cookie')

  if (bodySchema) {
    parametersSchema.body = bodySchema
  }

  if (formDataSchema) {
    parametersSchema.formData = formDataSchema
  }

  if (headerSchema) {
    parametersSchema.headers = headerSchema
  }

  if (pathSchema) {
    parametersSchema.path = pathSchema
  }

  if (querySchema) {
    parametersSchema.query = querySchema
  }

  if (cookieSchema) {
    parametersSchema.cookie = cookieSchema
  }

  return parametersSchema
}

function copyValidationKeywords(src: any) {
  const dst: any = {}
  for (let i = 0, keys = Object.keys(src), len = keys.length; i < len; i++) {
    const keyword = keys[i]
    if (!keyword) continue

    if (VALIDATION_KEYWORDS.has(keyword) || keyword.slice(0, 2) === 'x-') {
      dst[keyword] = src[keyword]
    }
  }
  return dst
}

function handleNullable(schema: IJsonSchema) {
  return { anyOf: [schema, { type: 'null' }] }
}

function handleNullableSchema(schema: any) {
  if (typeof schema !== 'object' || schema === null) {
    return schema
  }

  const newSchema = { ...schema }

  for (const keyword of SUBSCHEMA_KEYWORDS) {
    if (
      typeof schema[keyword] === 'object' &&
      schema[keyword] !== null &&
      !Array.isArray(schema[keyword])
    ) {
      newSchema[keyword] = handleNullableSchema(schema[keyword])
    }
  }

  for (const keyword of SUBSCHEMA_ARRAY_KEYWORDS) {
    if (Array.isArray(schema[keyword])) {
      newSchema[keyword] = schema[keyword].map(handleNullableSchema)
    }
  }

  for (const keyword of SUBSCHEMA_OBJECT_KEYWORDS) {
    if (typeof schema[keyword] === 'object' && schema[keyword] !== null) {
      newSchema[keyword] = { ...schema[keyword] }
      for (const prop of Object.keys(schema[keyword])) {
        newSchema[keyword][prop] = handleNullableSchema(schema[keyword][prop])
      }
    }
  }

  delete newSchema.$ref

  if (schema.nullable) {
    delete newSchema.nullable
    return handleNullable(newSchema)
  }
  return newSchema
}

function getBodySchema(parameters: any[]) {
  let bodySchema = parameters.find((param) => {
    return param.in === 'body' && param.schema
  })

  if (bodySchema) {
    bodySchema = bodySchema.schema
  }

  return bodySchema
}

function getSchema(parameters: any[], type: string) {
  const params = parameters.filter(byIn(type))
  let schema: any

  if (params.length) {
    schema = { type: 'object', properties: {} }

    for (const param of params) {
      let paramSchema = copyValidationKeywords(param)

      if ('schema' in param) {
        paramSchema = {
          ...paramSchema,
          ...handleNullableSchema(param.schema)
        }
        if ('examples' in param) {
          paramSchema.examples = getExamples(param.examples)
        }
        schema.properties[param.name] = paramSchema
      } else {
        if ('examples' in paramSchema) {
          paramSchema.examples = getExamples(paramSchema.examples)
        }
        schema.properties[param.name] = param.nullable
          ? handleNullable(paramSchema)
          : paramSchema
      }
    }

    schema.required = getRequiredParams(params)
  }

  return schema
}

function getRequiredParams(parameters: any[]) {
  return parameters.filter(byRequired).map(toName)
}

function getExamples(exampleSchema: any) {
  return Object.keys(exampleSchema).map((k) => exampleSchema[k].value)
}

function byIn(str: string) {
  return (param: any) => param.in === str && param.type !== 'file'
}

function byRequired(param: any) {
  return !!param.required
}

function toName(param: any) {
  return param.name
}


================================================
FILE: legacy/packages/openapi-to-ts/src/types.ts
================================================
export type GenerateTSFromOpenAPIOptions = {
  openapiFilePath: string
  outputDir: string
  dryRun?: boolean
  prettier?: boolean
  eslint?: boolean
  zodSchemaJsDocs?: boolean
}


================================================
FILE: legacy/packages/openapi-to-ts/src/utils.ts
================================================
import type SwaggerParser from '@apidevtools/swagger-parser'
import type { IJsonSchema, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
import { assert } from '@agentic/core'
import camelCaseImpl from 'camelcase'
import {
  type JsonSchema,
  jsonSchemaToZod as jsonSchemaToZodImpl,
  type ParserOverride
} from 'json-schema-to-zod'
import { format as prettierFormat } from 'prettier'

export function prettify(source: string): Promise<string> {
  return prettierFormat(source, {
    parser: 'typescript',
    semi: false,
    singleQuote: true,
    jsxSingleQuote: true,
    bracketSpacing: true,
    bracketSameLine: false,
    arrowParens: 'always',
    trailingComma: 'none'
  })
}

export function pascalCase(identifier: string): string {
  return camelCaseImpl(identifier, { pascalCase: true })
}

export function camelCase(identifier: string): string {
  return camelCaseImpl(identifier)
}

export function getAndResolve<T extends object = object>(
  obj: any,
  keys: string[],
  refs: SwaggerParser.$Refs,
  resolved?: Set<string>,
  depth = 0,
  maxDepth = 0
): T | null {
  if (obj === undefined) return null
  if (typeof obj !== 'object') return null

  if (!keys.length) {
    return dereference(obj, refs, resolved, depth, maxDepth) as T
  }

  if (obj.$ref) {
    const derefed = refs.get(obj.$ref)
    resolved?.add(obj.$ref)
    if (!derefed) {
      return null
    }
    obj = derefed
  }

  const key = keys[0]!
  const value = obj[key]
  keys = keys.slice(1)
  if (value === undefined) {
    return null
  }

  return getAndResolve<T>(value, keys, refs, resolved, depth, maxDepth)
}

export function dereferenceFull<T extends object = object>(
  obj: T,
  refs: SwaggerParser.$Refs,
  resolved?: Set<string>
): Exclude<T, OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject> {
  return dereference(obj, refs, resolved, 0, Number.POSITIVE_INFINITY) as any
}

export function dereference<T extends object = object>(
  obj: T,
  refs: SwaggerParser.$Refs,
  resolved?: Set<string>,
  depth = 0,
  maxDepth = 1,
  visited = new Set<string>()
): T {
  if (!obj) return obj

  if (depth >= maxDepth) {
    return obj
  }

  if (Array.isArray(obj)) {
    return obj.map((item) =>
      dereference(item, refs, resolved, depth + 1, maxDepth, visited)
    ) as T
  } else if (typeof obj === 'object') {
    if ('$ref' in obj) {
      const ref = obj.$ref as string
      if (visited?.has(ref)) {
        return obj
      }
      visited?.add(ref)
      const derefed = refs.get(ref)
      assert(derefed, `Invalid schema: $ref not found for ${ref}`)
      resolved?.add(ref)
      derefed.title ??= ref.split('/').pop()!
      return dereference(derefed, refs, resolved, depth + 1, maxDepth, visited)
    } else {
      return Object.fromEntries(
        Object.entries(obj).map(([key, value]) => [
          key,
          dereference(value, refs, resolved, depth + 1, maxDepth, visited)
        ])
      ) as T
    }
  } else {
    return obj
  }
}

function createParserOverride({
  type,
  withJsdocs
}: {
  type?: string
  withJsdocs: boolean
}): ParserOverride {
  const jsonSchemaToZodParserOverride: ParserOverride = (schema, _refs) => {
    if ('nullable' in schema && schema.nullable) {
      delete schema.nullable
    }

    if ('$ref' in schema) {
      const ref = schema.$ref as string
      assert(ref, `Invalid schema: $ref not found for ${schema.$ref}`)

      const name = getComponentDisplayName(ref)
      if (type === name) {
        // TODO: Support recursive types.
        return `\n// TODO: Support recursive types for \`${name}Schema\`.\nz.any()`
      }

      return `${name}Schema`
    } else if (schema.oneOf) {
      const { oneOf, ...partialSchema } = schema

      // Replace oneOf with anyOf because `json-schema-to-zod` treats oneOf
      // with a complicated `z.any().superRefine(...)` which we'd like messes
      // up the resulting types.
      const newSchema = {
        ...partialSchema,
        anyOf: oneOf
      }

      const res = jsonSchemaToZodImpl(newSchema, {
        withJsdocs,
        parserOverride: jsonSchemaToZodParserOverride
      })

      return res
    }
  }

  return jsonSchemaToZodParserOverride
}

export function jsonSchemaToZod(
  schema: JsonSchema,
  {
    name,
    type,
    withJsdocs = true
  }: {
    name?: string
    type?: string
    withJsdocs?: boolean
  } = {}
): string {
  return jsonSchemaToZodImpl(schema, {
    name,
    module: 'esm',
    withJsdocs,
    type: type ?? true,
    noImport: true,
    parserOverride: createParserOverride({ type, withJsdocs })
  })
}

const reservedWords = new Set([
  'Error',
  'Class',
  'Object',
  'interface',
  'type',
  'default',
  'switch',
  'for',
  'break',
  'case',
  'if',
  'else',
  'while',
  'do',
  'for',
  'return',
  'continue',
  'function',
  'console',
  'window',
  'global',
  'import',
  'export',
  'namespace',
  'using',
  'require',
  'module',
  'process',
  'async',
  'await',
  'const',
  'let',
  'var',
  'void',
  'undefined',
  'abstract',
  'extends',
  'implements',
  'private',
  'protected',
  'public',
  'Infinity',
  'Nan',
  'Math',
  'Date',
  'RegExp',
  'JSON',
  'Buffer',
  'Promise',
  'Symbol',
  'Map',
  'Set',
  'WeakMap',
  'WeakSet',
  'Array',
  'Object',
  'Boolean',
  'Number',
  'String',
  'Function',
  'Symbol'
])

export function getComponentName(ref: string) {
  const name = ref.split('/').pop()!
  assert(name, `Invalid ref name ${ref}`)

  return name
}

export function getComponentDisplayName(ref: string) {
  const name0 = getComponentName(ref)
  const name1 = pascalCase(name0)
  assert(name1, `Invalid ref name ${ref}`)

  if (reservedWords.has(name1)) {
    return `${name1}Type`
  }

  return name1
}

export function getOperationParamsName(
  operationName: string,
  schemas?: Record<string, string>
) {
  const name = `${pascalCase(operationName)}Params`
  if (!schemas) return name

  let tempName = name
  let index = 2
  while (schemas[tempName]) {
    tempName = `${name}${index}`
    ++index
  }

  return tempName
}

export function getOperationResponseName(
  operationName: string,
  schemas?: Record<string, string>
) {
  const name = `${pascalCase(operationName)}Response`
  if (!schemas) return name

  let tempName = name
  let index = 2
  while (schemas[tempName]) {
    tempName = `${name}${index}`
    ++index
  }

  return tempName
}

export function naiveMergeJSONSchemas(...schemas: IJsonSchema[]): IJsonSchema {
  const result: any = {}

  for (const ischema of schemas) {
    const schema = ischema as any
    const arrayKeys: string[] = []
    const objectKeys: string[] = []

    for (const [key, value] of Object.entries(schema)) {
      if (Array.isArray(value)) {
        arrayKeys.push(key)
      } else if (typeof value === 'object') {
        objectKeys.push(key)
      } else {
        result[key] = value
      }
    }

    for (const key of arrayKeys) {
      result[key] = [...(result[key] ?? []), ...(schema[key] ?? [])]
    }

    for (const key of objectKeys) {
      result[key] = { ...result[key], ...schema[key] }
    }
  }

  return result as IJsonSchema
}

export function getDescription(description?: string): string | undefined {
  if (!description) return undefined

  if (!/[!.?]$/.test(description)) {
    description += '.'
  }

  return description.replaceAll('/*', '\\/\\*').replaceAll('*/', '\\*\\/')
}


================================================
FILE: legacy/packages/openapi-to-ts/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "bin", "fixtures/**/*.ts", "*.config.ts"],
  "exclude": [
    "node_modules",
    "dist",
    "fixtures/generated/github*.ts",
    "fixtures/generated/tic-tac-toe*.ts",
    "fixtures/generated/open-meteo-client.ts"
  ]
}


================================================
FILE: legacy/packages/openapi-to-ts/tsup.config.ts
================================================
import { defineConfig } from 'tsup'

export default defineConfig([
  {
    entry: ['src/index.ts'],
    outDir: 'dist',
    target: 'node18',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  },
  {
    entry: ['bin/openapi-to-ts.ts'],
    outDir: 'dist',
    target: 'node18',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  }
])


================================================
FILE: legacy/packages/people-data-labs/package.json
================================================
{
  "name": "@agentic/people-data-labs",
  "version": "7.6.9",
  "description": "Agentic SDK for People Data Labs.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/people-data-labs"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/people-data-labs/src/index.ts
================================================
export * from './people-data-labs-client'


================================================
FILE: legacy/packages/people-data-labs/src/people-data-labs-client.ts
================================================
import { assert, getEnv, sanitizeSearchParams, throttleKy } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'

/**
 * TODO: I'm holding off on converting this client to an `AIFunctionsProvider`
 * because it seems to be significantly more expensive than other data sources,
 * and I'm not sure if it's worth the cost.
 */

export namespace peopledatalabs {
  export const BASE_URL = 'https://api.peopledatalabs.com/v5/'

  // Allow up to 10 requests per minute.
  export const throttle10PerMin = pThrottle({
    limit: 10,
    interval: 60 * 1000,
    strict: true
  })

  // Allow up to 100 requests per minute.
  export const throttle100PerMin = pThrottle({
    limit: 100,
    interval: 60 * 1000,
    strict: true
  })

  export const JobTitleLevels = [
    'cxo',
    'director',
    'entry',
    'manager',
    'owner',
    'partner',
    'senior',
    'training',
    'unpaid',
    'vp'
  ]

  export const JobTitleRoles = [
    'customer_service',
    'design',
    'education',
    'engineering',
    'finance',
    'health',
    'human_resources',
    'legal',
    'marketing',
    'media',
    'operations',
    'public_relations',
    'real_estate',
    'sales',
    'trades'
  ]

  // TODO configure this type to make pdl_id or name or profile or ticker or website required.
  // Only one is required
  export interface CompanyLookupOptions {
    pdl_id?: string
    name?: string
    profile?: string
    ticker?: string
    website?: string
    location?: string[]
    locality?: string
    region?: string
    country?: string
    street_address?: string
    postal_code?: string
    data_include?: string
    pretty?: boolean
  }

  export interface Naics {
    naics_code: string
    sector: string
    sub_sector: string
    industry_group: string
    naics_industry: string | null
    national_industry: string | null
  }

  export interface Sic {
    sic_code: string
    major_group: string
    industry_group: string
    industry_sector: string | null
  }

  export interface Location {
    name: string
    locality: string
    region: string
    metro: string
    country: string
    continent: string
    street_address: string
    address_line_2: string | null
    postal_code: string
    geo: string
  }

  export interface EmployeeCountByCountry {
    [country: string]: number
  }

  export interface CompanyLookupResponse {
    status: number
    name: string
    display_name: string
    size: string
    employee_count: number
    id: string
    founded: number
    industry: string
    naics: Naics[]
    sic: Sic[]
    location: Location
    linkedin_id: string
    linkedin_url: string
    facebook_url: string
    twitter_url: string
    profiles: string[]
    website: string
    ticker: string
    gics_sector: string | null
    mic_exchange: string | null
    type: string
    summary: string
    tags: string[]
    headline: string
    alternative_names: string[]
    alternative_domains: string[]
    affiliated_profiles: string[]
    employee_count_by_country: EmployeeCountByCountry
    likelihood: number
  }

  export interface CompanySearchOptions {
    limit?: number
    query: {
      website?: string
      tags?: string
      industry?: string
      'location.country'?: string
      'location.metro'?: string
      summary?: string
      size?: string[]
      affiliated_profiles?: string
    }
  }

  export type CompanySearchOptionsQueryKeys =
    keyof CompanySearchOptions['query']

  export interface CompanySearchResponse {
    status: number
    data: {
      name: string
      display_name: string
      size: string
      employee_count: number
      id: string
      founded: number
      industry: string
      naics: Naics[]
      sic: Sic[]
      location: Location
      linkedin_id: string
      linkedin_url: string
      facebook_url: string
      twitter_url: string
      profiles: string[]
      website: string
      ticker: string
      gics_sector: string | null
      mic_exchange: string | null
      type: string
      summary: string
      tags: string[]
      headline: string
      alternative_names: string[]
      alternative_domains: string[]
      affiliated_profiles: string[]
      employee_count_by_country: EmployeeCountByCountry
    }[]
    scroll_token: string
    total: number
  }

  export interface PersonSearchOptions {
    limit?: number
    query: {
      first_name?: string
      full_name?: string
      last_name?: string
      job_company_website?: string
      job_title_role?: string
      /**
       * The docs says this property should be an array of strings.
       * But when sending the array a 404 error is returned.
       * See: https://docs.peopledatalabs.com/docs/fields#job_title_levels
       */
      job_title_levels?: string
      job_company_name?: string
      job_company_location_country?: string
    }
  }

  export type PersonSearchOptionsQueryKeys = keyof PersonSearchOptions['query']

  // Person response
  export interface SearchPersonApiResponse {
    id: string
    full_name: string
    first_name: string
    middle_initial: null | string
    middle_name: null | string
    last_initial: string
    last_name: string
    gender: string
    birth_year: null | number
    birth_date: null | string
    linkedin_url: string
    linkedin_username: string
    linkedin_id: string
    facebook_url: null | string
    facebook_username: null | string
    facebook_id: null | string
    twitter_url: string
    twitter_username: string
    github_url: null | string
    github_username: null | string
    work_email: string
    personal_emails: string[]
    recommended_personal_email: null | string
    mobile_phone: null | string
    industry: null | string
    job_title: string
    job_title_role: null | string
    job_title_sub_role: null | string
    job_title_levels: string[]
    job_onet_code: string
    job_onet_major_group: string
    job_onet_minor_group: string
    job_onet_broad_occupation: string
    job_onet_specific_occupation: string
    job_onet_specific_occupation_detail: string
    job_company_id: string
    job_company_name: string
    job_company_website: string
    job_company_size: string
    job_company_founded: number
    job_company_industry: string
    job_company_linkedin_url: string
    job_company_linkedin_id: string
    job_company_facebook_url: string
    job_company_twitter_url: string
    job_company_type: string
    job_company_ticker: null | string
    job_company_location_name: string
    job_company_location_locality: string
    job_company_location_metro: string
    job_company_location_region: string
    job_company_location_geo: string
    job_company_location_street_address: string
    job_company_location_address_line_2: string
    job_company_location_postal_code: string
    job_company_location_country: string
    job_company_location_continent: string
    job_last_updated: string
    job_start_date: string
    job_summary: null | string
    location_name: null | string
    location_locality: null | string
    location_metro: null | string
    location_region: null | string
    location_country: null | string
    location_continent: null | string
    location_street_address: null | string
    location_address_line_2: null | string
    location_postal_code: null | string
    location_geo: null | string
    location_last_updated: null | string
    linkedin_connections: number
    facebook_friends: null | string
    inferred_salary: string
    inferred_years_experience: number
    summary: null | string
    phone_numbers: string[]
    phones: string[]
    emails: Email[]
    interests: string[]
    skills: string[]
    location_names: string[]
    regions: string[]
    countries: string[]
    street_addresses: string[]
    experience: Experience[]
    education: Education[]
    profiles: Profile[]
    name_aliases: string[]
    possible_emails: PossibleEmail[]
    possible_profiles: PossibleProfile[]
    possible_phones: PossiblePhone[]
    possible_street_addresses: string[]
    possible_location_names: string[]
    possible_birth_dates: string[]
    job_history: JobHistory[]
    certifications: string[]
    languages: string[]
    first_seen: string
    num_sources: number
    num_records: number
    version_status: VersionStatus
  }

  export interface Email {
    address: string
    type: null | string
    first_seen: string
    last_seen: string
    num_sources: number
  }

  export interface Experience {
    company: Company
    start_date: null | string
    end_date: null | string
    title: Title
    location_names: string[]
    is_primary: boolean
    summary: null | string
    num_sources: number
    first_seen: string
    last_seen: string
  }

  export interface Company {
    name: string
    size: string
    id: string
    founded: number
    industry: string
    location: Location
    linkedin_url: string
    linkedin_id: string
    facebook_url: null | string
    twitter_url: string
    website: string
    ticker: null | string
    type: string
    raw: string[]
    fuzzy_match: boolean
  }

  export interface Title {
    name: string
    raw: string[]
    role: null | string
    sub_role: null | string
    levels: string[]
  }

  export interface Education {
    school: School
    degrees: string[]
    start_date: string
    end_date: string
    majors: string[]
    minors: string[]
    gpa: null | string
    raw: string[]
    summary: null | string
  }

  export interface School {
    name: string
    type: string
    id: string
    location: Location
    linkedin_url: string
    facebook_url: string
    twitter_url: string
    linkedin_id: string
    website: string
    domain: string
    raw: string[]
  }

  export interface Profile {
    network: string
    id: null | string
    url: string
    username: string
    num_sources: number
    first_seen: string
    last_seen: string
  }

  export interface PossibleEmail {
    address: string
    type: null | string
    first_seen: string
    last_seen: string
    num_sources: number
  }

  export interface PossibleProfile {
    network: string
    id: null | string
    url: string
    username: null | string
    num_sources: number
    first_seen: string
    last_seen: string
  }

  export interface PossiblePhone {
    number: string
    first_seen: string
    last_seen: string
    num_sources: number
  }

  export interface VersionStatus {
    status: string
    contains: string[]
    previous_version: string
    current_version: string
  }

  export interface JobHistory {
    company_id: string
    company_name: string
    title: string
    first_seen: string
    last_seen: string
    num_sources: number
  }
}

/**
 * People & Company Data
 *
 * @see https://www.peopledatalabs.com
 */
export class PeopleDataLabsClient {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('PEOPLE_DATA_LABS_API_KEY'),
    apiBaseUrl = peopledatalabs.BASE_URL,
    timeoutMs = 30_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'PeopleDataLabsClient missing required "apiKey" (defaults to "PEOPLE_DATA_LABS_API_KEY")'
    )

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle
      ? throttleKy(ky, peopledatalabs.throttle10PerMin)
      : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        'x-api-key': `${this.apiKey}`
      }
    })
  }

  async companyLookup(options: peopledatalabs.CompanySearchOptions) {
    const terms = options.query
    const termsQuery = []

    for (const term of Object.keys(
      terms
    ) as peopledatalabs.CompanySearchOptionsQueryKeys[]) {
      termsQuery.push({ term: { [term]: terms[term] } })
    }

    return this.ky
      .get('company/search', {
        searchParams: {
          size: options.limit || 1,
          query: JSON.stringify({
            bool: {
              must: termsQuery
            }
          })
        }
      })
      .json<peopledatalabs.CompanySearchResponse>()
  }

  async companyProfile(options: peopledatalabs.CompanyLookupOptions) {
    return this.ky
      .get('company/enrich', {
        searchParams: sanitizeSearchParams({ ...options })
      })
      .json<peopledatalabs.CompanyLookupResponse>()
  }

  async personSearch(options: peopledatalabs.PersonSearchOptions) {
    const terms = options.query
    const termsQuery = []

    for (const term of Object.keys(
      terms
    ) as peopledatalabs.PersonSearchOptionsQueryKeys[]) {
      termsQuery.push({ term: { [term]: terms[term] } })
    }

    return this.ky
      .get('person/search', {
        searchParams: {
          size: options.limit || 10,
          query: JSON.stringify({
            bool: {
              must: termsQuery
            }
          })
        }
      })
      .json<peopledatalabs.SearchPersonApiResponse>()
  }
}


================================================
FILE: legacy/packages/people-data-labs/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/perigon/package.json
================================================
{
  "name": "@agentic/perigon",
  "version": "7.6.9",
  "description": "Agentic SDK for the Perigon News API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/perigon"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/perigon/src/index.ts
================================================
export * from './perigon-client'


================================================
FILE: legacy/packages/perigon/src/perigon-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

// TODO: https://docs.goperigon.com/docs/searching-sources
// TODO: https://docs.goperigon.com/docs/journalist-data
// TODO: https://docs.goperigon.com/docs/topics

export namespace perigon {
  // Allow up to 2 requests per second by default.
  export const throttle = pThrottle({
    limit: 2,
    interval: 1000,
    strict: true
  })

  export const DEFAULT_PAGE_SIZE = 10
  export const MAX_PAGE_SIZE = 100

  export const ArticleLabelSchema = z.union([
    z.literal('Opinion'),
    z.literal('Non-news'),
    z.literal('Paid News'),
    z.literal('Fact Check'),
    z.literal('Pop Culture'),
    z.literal('Roundup'),
    z.literal('Press Release')
  ])
  export type ArticleLabel = z.infer<typeof ArticleLabelSchema>

  export const CategoriesSchema = z.union([
    z.literal('Politics'),
    z.literal('Tech'),
    z.literal('Sports'),
    z.literal('Business'),
    z.literal('Finance'),
    z.literal('Entertainment'),
    z.literal('Health'),
    z.literal('Weather'),
    z.literal('Lifestyle'),
    z.literal('Auto'),
    z.literal('Science'),
    z.literal('Travel'),
    z.literal('Environment'),
    z.literal('World'),
    z.literal('General'),
    z.literal('none')
  ])
  export type Categories = z.infer<typeof CategoriesSchema>

  export const SourceGroupSchema = z.union([
    z.literal('top10').describe('Top 10 most popular sources globally'),
    z.literal('top100').describe('Top 100 most popular sources globally'),
    z
      .literal('top500English')
      .describe('Top 500 most popular (English) sources globally'),
    z
      .literal('top25crypto')
      .describe(
        'Top 25 most popular sources covering cryptocurrency & blockchain developments'
      ),
    z
      .literal('top25finance')
      .describe(
        'Top 25 most popular sources covering financial news, movement in the markets & public equities'
      ),
    z
      .literal('top50tech')
      .describe('Top 50 sources covering new technology & businesses in tech'),
    z
      .literal('top100sports')
      .describe(
        'Top 100 most popular (English) sources covering sports of all types'
      ),
    z
      .literal('top100leftUS')
      .describe(
        'Top 100 most popular (US) sources with an average political bias rating of Left or Leans Left'
      ),
    z
      .literal('top100rightUS')
      .describe(
        'Top 100 most popular (US) sources with an average political bias rating of Right or Leans Right'
      ),
    z
      .literal('top100centerUS')
      .describe(
        'Top 100 most popular (US) sources with an average political bias rating of Center or Middle'
      )
  ])
  export type SourceGroup = z.infer<typeof SourceGroupSchema>

  export const SortBySchema = z.union([
    z.literal('date'),
    z.literal('relevance'),
    z.literal('addDate'),
    z.literal('pubDate'),
    z.literal('refreshDate')
  ])
  export type SortBy = z.infer<typeof SortBySchema>

  export const ArticlesSearchOptionsSchema = z.object({
    q: z.string()
      .describe(`Search query. It may use boolean operators (AND, OR, NOT) and quotes for exact matching. Example search queries:

- election news
- "elon musk" AND tesla
- (upcoming release OR launch) AND apple
- (Google OR Amazon) AND NOT ("Jeff Bezos" OR Android)
- "climate change"
`),
    title: z
      .string()
      .optional()
      .describe(
        'Search query which applies only to article titles / headlines.'
      ),
    desc: z.string().optional(),
    content: z.string().optional(),
    url: z.string().optional(),
    from: z
      .string()
      .optional()
      .describe(
        'Filter to only return articles published after the specified date (ISO or "yyyy-mm-dd" format)'
      ),
    to: z
      .string()
      .optional()
      .describe(
        'Filter to only return articles published before the specified date (ISO or "yyyy-mm-dd" format)'
      ),
    addDateFrom: z.string().optional(),
    addDateTo: z.string().optional(),
    refreshDateFrom: z.string().optional(),
    refreshDateTo: z.string().optional(),
    articleId: z.string().optional(),
    clusterId: z.string().optional(),
    medium: z.union([z.literal('article'), z.literal('video')]).optional(),
    source: z
      .string()
      .optional()
      .describe("Filter articles from a specific publisher's source domain."),
    sourceGroup: SourceGroupSchema.optional().describe(
      'The source group to retrieve articles from.'
    ),
    excludeSource: z
      .string()
      .optional()
      .describe(
        'Source website domains which should be excluded from the search. Wildcards (* and ?) are suported (e.g. "*.cnn.com").'
      ),
    paywall: z
      .boolean()
      .optional()
      .describe(
        'Filter to show only results where the source has a paywall (true) or does not have a paywall (false).'
      ),
    country: z
      .string()
      .optional()
      .describe('Country code to filter by country.'),
    language: z.string().optional(),
    label: ArticleLabelSchema.optional().describe(
      'Labels to filter by, could be "Opinion", "Paid-news", "Non-news", etc. If multiple parameters are passed, they will be applied as OR operations.'
    ),
    excludeLabel: z
      .array(z.union([ArticleLabelSchema, z.literal('Low Content')]))
      .optional()
      .describe(
        'Exclude results that include specific labels ("Opinion", "Non-news", "Paid News", etc.). You can filter multiple by repeating the parameter.'
      ),
    byline: z.string().optional(),
    topic: z.string().optional(),
    category: CategoriesSchema.optional().describe(
      'Filter by categories. Categories are general themes that the article is about. Examples of categories: Tech, Politics, etc. If multiple parameters are passed, they will be applied as OR operations. Use "none" to search uncategorized articles.'
    ),
    journalistId: z.string().optional(),
    state: z
      .string()
      .optional()
      .describe(
        'Filters articles where a specified state plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the state in question.'
      ),
    city: z
      .string()
      .optional()
      .describe(
        'Filters articles where a specified city plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the urban area in question.'
      ),
    area: z
      .string()
      .optional()
      .describe(
        'Filters articles where a specified area, such as a neighborhood, borough, or district, plays a central role in the content, beyond mere mentions, to ensure the results are deeply relevant to the area in question.'
      ),
    location: z.string().optional(),
    sortBy: SortBySchema.default('relevance')
      .optional()
      .describe('How to sort the article results.'),
    showReprints: z
      .boolean()
      .optional()
      .describe(
        'Whether to return reprints in the response or not. Reprints are usually wired articles from sources like AP or Reuters that are reprinted in multiple sources at the same time. By default, this parameter is "true".'
      ),
    showNumResults: z.boolean().optional(),
    type: z
      .union([z.literal('all'), z.literal('local'), z.literal('world')])
      .optional(),
    linkTo: z.string().optional(),
    reprintGroupId: z.string().optional(),
    personWikidataId: z.array(z.string()).optional(),
    personName: z
      .array(z.string())
      .optional()
      .describe('List of person names for exact matches.'),
    companyId: z.array(z.string()).optional(),
    companyName: z.string().optional().describe('Search by company name.'),
    companyDomain: z
      .array(z.string())
      .optional()
      .describe('Search by company domain.'),
    companySymbol: z
      .array(z.string())
      .optional()
      .describe('Search by company stock ticker symbol.'),
    maxDistance: z.number().optional(),
    lat: z.number().optional(),
    lon: z.number().optional(),
    searchTranslation: z
      .boolean()
      .optional()
      .describe(
        'Expand a query to search the translation, translatedTitle, and translatedDescription fields for non-English articles.'
      ),
    page: z
      .number()
      .int()
      .max(10_000)
      .default(0)
      .optional()
      .describe('Page number of results to return (zero-based)'),
    size: z
      .number()
      .int()
      .max(DEFAULT_PAGE_SIZE)
      .optional()
      .describe('Number of results to return per page')
  })
  export type ArticlesSearchOptions = z.infer<
    typeof ArticlesSearchOptionsSchema
  >

  export const StoriesSearchOptionsSchema = ArticlesSearchOptionsSchema.pick({
    q: true,
    clusterId: true,
    topic: true,
    category: true,
    from: true,
    to: true,
    state: true,
    city: true,
    area: true,
    showNumResults: true,
    page: true,
    size: true,
    sourceGroup: true,
    personWikidataId: true,
    personName: true,
    companyId: true,
    companyName: true,
    companyDomain: true,
    companySymbol: true
  }).extend({
    name: z.string().optional().describe('Search stories by name.'),
    nameExists: z.boolean().optional(),
    initializedFrom: z.string().optional(),
    initializedTo: z.string().optional(),
    updatedFrom: z.string().optional(),
    updatedTo: z.string().optional(),
    minClusterSize: z.number().optional(),
    maxClusterSize: z.number().optional(),
    showDuplicates: z
      .boolean()
      .optional()
      .describe(
        'Stories are deduplicated by default. If a story is deduplicated, all future articles are merged into the original story. `duplicateOf` field contains the original cluster id. When showDuplicates=true, all stories are shown.'
      ),
    sortBy: z
      .union([
        z.literal('count'),
        z.literal('createdAt'),
        z.literal('updatedAt')
      ])
      .optional()
      .describe('How to sort the results.')
  })
  export type StoriesSearchOptions = z.infer<typeof StoriesSearchOptionsSchema>

  export const PeopleSearchOptionsSchema = z.object({
    name: z
      .string()
      .describe(
        'Person name query to search for. It may use boolean operators (AND, OR, NOT) and quotes for exact matching.'
      ),
    wikidataId: z
      .array(z.string())
      .optional()
      .describe('Search by ID of Wikidata entity.'),
    occupationId: z
      .array(z.string())
      .optional()
      .describe('Search by Wikidata occupation ID.'),
    occupationLabel: z
      .string()
      .optional()
      .describe('Search by occupation name.'),
    size: z
      .number()
      .int()
      .max(DEFAULT_PAGE_SIZE)
      .optional()
      .describe('Number of results to return per page')
  })
  export type PeopleSearchOptions = z.infer<typeof PeopleSearchOptionsSchema>

  export const CompanySearchOptionsSchema = z.object({
    q: z
      .string()
      .optional()
      .describe(
        'Company search query. It may use boolean operators (AND, OR, NOT) and quotes for exact matching.'
      ),
    name: z
      .string()
      .optional()
      .describe(
        'Search by company name. It may use boolean operators (AND, OR, NOT) and quotes for exact matching.'
      ),
    industry: z
      .string()
      .optional()
      .describe(
        'Search by company industry. It may use boolean operators (AND, OR, NOT) and quotes for exact matching.'
      ),
    sector: z
      .string()
      .optional()
      .describe(
        'Search by company sector. It may use boolean operators (AND, OR, NOT) and quotes for exact matching.'
      ),
    id: z.array(z.string()).optional().describe('Search by company ID.'),
    symbol: z
      .array(z.string())
      .optional()
      .describe('Search by company stock ticker symbol.'),
    domain: z
      .array(z.string())
      .optional()
      .describe('Search by company domain.'),
    country: z.string().optional().describe('Search by country.'),
    exchange: z.string().optional().describe('Search by exchange name.'),
    numEmployeesFrom: z
      .number()
      .int()
      .optional()
      .describe('Minimum number of employees.'),
    numEmployeesTo: z
      .number()
      .int()
      .optional()
      .describe('Maximum number of employees.'),
    ipoFrom: z
      .string()
      .optional()
      .describe('Starting IPO date (ISO or "yyyy-mm-dd" format)'),
    ipoTo: z
      .string()
      .optional()
      .describe('Ending IPO date (ISO or "yyyy-mm-dd" format)'),
    size: z
      .number()
      .int()
      .max(DEFAULT_PAGE_SIZE)
      .optional()
      .describe('Number of results to return per page')
  })
  export type CompanySearchOptions = z.infer<typeof CompanySearchOptionsSchema>

  export type ArticlesSearchResponse = {
    status: number
    numResults: number
    articles: Article[]
  }

  export type Article = {
    url: string
    authorsByline: string
    articleId: string
    clusterId: string
    source: {
      domain: string
    }
    imageUrl: string
    country: string
    language: string
    pubDate: string
    addDate: string
    refreshDate: string
    score: number
    title: string
    description: string
    content: string
    medium: string
    links: string[]
    labels: string[]
    matchedAuthors: string[]
    claim: string
    verdict: string
    keywords: {
      name: string
      weight: number
    }[]
    topics: {
      name: string
    }[]
    categories: {
      name: string
    }[]
    entities: {
      data: string
      type: string
      mentions: number
    }[]
    sentiment: {
      positive: number
      negative: number
      neutral: number
    }
    summary: string
    translation: string
    locations: string[]
    reprint: boolean
    reprintGroupId: string
    places: null
  }

  export type StoriesSearchResponse = {
    status: number
    numResults: number
    results: Story[]
  }

  export type Story = {
    createdAt: string
    updatedAt: string
    initializedAt: string
    id: string
    name: string
    summary: string
    summaryReferences: Array<any>
    keyPoints: Array<{
      point: string
      references: Array<string>
    }>
    sentiment: {
      positive: number
      negative: number
      neutral: number
    }
    uniqueCount: number
    reprintCount: number
    totalCount: number
    countries: Array<{
      name: string
      count: number
    }>
    topCountries: Array<string>
    topics: Array<{
      name: string
      count: number
    }>
    topTopics: Array<{ name: string }>
    categories: Array<{
      name: string
      count: number
    }>
    topCategories: Array<{ name: string }>
    people: Array<{ wikidataId: string; name: string; count: number }>
    topPeople: Array<{ wikidataId: string; name: string }>
    companies: Array<{
      id: string
      name: string
      domains: Array<string>
      symbols: Array<string>
      count: number
    }>
    topCompanies: Array<{
      id: string
      name: string
      domains: Array<string>
      symbols: Array<string>
    }>
    locations: Array<{
      state: string
      city?: string
      area?: string
      county?: string
      count: number
    }>
    topLocations: Array<{
      state: string
      city?: string
      area?: string
      county?: string
    }>
  }

  export interface PeopleSearchResponse {
    status: number
    numResults: number
    results: Person[]
  }

  export interface Person {
    wikidataId: string
    name: string
    gender: Gender
    dateOfBirth: DateOfBirth
    dateOfDeath: any
    description: string
    aliases: string[]
    occupation: Occupation[]
    position: Position[]
    politicalParty: PoliticalParty[]
    image?: Image
    abstract: string
  }

  export interface Gender {
    wikidataId: string
    label: string
  }

  export interface DateOfBirth {
    time: string
    precision: string
  }

  export interface Occupation {
    wikidataId: string
    label: string
  }

  export interface Position {
    wikidataId: string
    label: string
    startTime: any
    endTime: any
    employer: any
  }

  export interface PoliticalParty {
    wikidataId: string
    label: string
    startTime: any
    endTime: any
  }

  export interface Image {
    url: string
  }

  export interface CompanySearchResponse {
    status: number
    numResults: number
    results: Company[]
  }

  export interface Company {
    id: string
    name: string
    altNames: string[]
    domains: string[]
    monthlyVisits: number
    globalRank?: number
    description: string
    ceo: any
    industry: string
    sector: any
    country: string
    fullTimeEmployees?: number
    address: any
    city: any
    state: any
    zip: any
    logo?: string
    favicon?: string
    isEtf: boolean
    isActivelyTrading: any
    isFund: boolean
    isAdr: boolean
    symbols: any[]
  }
}

/**
 * **The intelligent news API**
 *
 * Real-time global news and web content data from 140,000+ sources.
 *
 * - search news articles
 * - search news stories (clusters of related news articles)
 * - search people, companies, topics, and journalists
 *
 * @see https://www.goperigon.com/products/news-api
 */
export class PerigonClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string

  constructor({
    apiKey = getEnv('PERIGON_API_KEY'),
    timeoutMs = 30_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    throttle?: boolean
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'PerigonClient missing required "apiKey" (defaults to "PERIGON_API_KEY")'
    )
    super()

    this.apiKey = apiKey

    const throttledKy = throttle ? throttleKy(ky, perigon.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: 'https://api.goperigon.com/v1/',
      timeout: timeoutMs
    })
  }

  /**
   * @see https://docs.goperigon.com/docs/overview
   * @see https://docs.goperigon.com/reference/all-news
   */
  @aiFunction({
    name: 'search_news_articles',
    description:
      'Search for news articles indexed by Perigon. Articles can optionally be filtered by various parameters.',
    inputSchema: perigon.ArticlesSearchOptionsSchema.pick({
      q: true,
      title: true,
      from: true,
      to: true,
      source: true,
      sourceGroup: true,
      excludeSource: true,
      category: true,
      personName: true,
      companyName: true,
      companyDomain: true,
      sortBy: true
    })
  })
  async searchArticles(opts: perigon.ArticlesSearchOptions) {
    return this.ky
      .get('all', {
        searchParams: sanitizeSearchParams({
          sortBy: 'relevance',
          ...opts,
          apiKey: this.apiKey,
          size: Math.max(
            1,
            Math.min(
              perigon.MAX_PAGE_SIZE,
              opts.size || perigon.DEFAULT_PAGE_SIZE
            )
          )
        })
      })
      .json<perigon.ArticlesSearchResponse>()
  }

  /**
   * @see https://docs.goperigon.com/docs/stories-overview
   * @see https://docs.goperigon.com/reference/stories-1
   */
  @aiFunction({
    name: 'search_news_stories',
    description:
      'Search for news stories indexed by Perigon. Stories are clusters of related news articles and are useful for finding top stories and trending headlines. Stories can optionally be filtered by various parameters.',
    inputSchema: perigon.StoriesSearchOptionsSchema.pick({
      q: true,
      name: true,
      from: true,
      to: true,
      sourceGroup: true,
      category: true,
      personName: true,
      companyName: true,
      companyDomain: true,
      sortBy: true
    })
  })
  async searchStories(opts: perigon.StoriesSearchOptions) {
    return this.ky
      .get('stories/all', {
        searchParams: sanitizeSearchParams({
          sortBy: 'relevance',
          ...opts,
          apiKey: this.apiKey,
          size: Math.max(
            1,
            Math.min(
              perigon.MAX_PAGE_SIZE,
              opts.size || perigon.DEFAULT_PAGE_SIZE
            )
          )
        })
      })
      .json<perigon.StoriesSearchResponse>()
  }

  /**
   * @see https://docs.goperigon.com/docs/people-data
   * @see https://docs.goperigon.com/reference/people
   */
  @aiFunction({
    name: 'search_people',
    description: 'Search for well-known people indexed by Perigon.',
    inputSchema: perigon.PeopleSearchOptionsSchema
  })
  async searchPeople(opts: perigon.PeopleSearchOptions) {
    return this.ky
      .get('people/all', {
        searchParams: sanitizeSearchParams({
          ...opts,
          apiKey: this.apiKey,
          size: Math.max(
            1,
            Math.min(
              perigon.MAX_PAGE_SIZE,
              opts.size || perigon.DEFAULT_PAGE_SIZE
            )
          )
        })
      })
      .json<perigon.PeopleSearchResponse>()
  }

  /**
   * @see https://docs.goperigon.com/docs/company-data
   * @see https://docs.goperigon.com/reference/companies
   */
  @aiFunction({
    name: 'search_companies',
    description:
      'Search for companies indexed by Perigon. Includes public and private companies sourced from public records and Wikidata.',
    inputSchema: perigon.CompanySearchOptionsSchema
  })
  async searchCompanies(opts: perigon.CompanySearchOptions) {
    return this.ky
      .get('companies/all', {
        searchParams: sanitizeSearchParams({
          ...opts,
          apiKey: this.apiKey,
          size: Math.max(
            1,
            Math.min(
              perigon.MAX_PAGE_SIZE,
              opts.size || perigon.DEFAULT_PAGE_SIZE
            )
          )
        })
      })
      .json<perigon.CompanySearchResponse>()
  }
}


================================================
FILE: legacy/packages/perigon/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/polygon/package.json
================================================
{
  "name": "@agentic/polygon",
  "version": "7.6.9",
  "description": "Agentic SDK for the Polygon stock API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/polygon"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/polygon/src/index.ts
================================================
export * from './polygon-client'


================================================
FILE: legacy/packages/polygon/src/polygon-client.ts
================================================
import { AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'

// TODO: add aiFunction decorator to select methods

export namespace polygon {
  export const API_BASE_URL = 'https://api.polygon.io'

  /**
   * Asset classes available on Polygon.
   */
  export type ASSET_CLASS = 'stocks' | 'options' | 'crypto' | 'fx'

  /**
   * Supported time spans for Polygon's indicator APIs.
   */
  export type TIMESPAN =
    | 'minute'
    | 'hour'
    | 'day'
    | 'week'
    | 'month'
    | 'quarter'
    | 'year'

  /**
   * Supported series types for Polygon's indicator APIs.
   */
  export type SERIES_TYPE = 'close' | 'open' | 'high' | 'low'

  /**
   * Order types available on Polygon.
   */
  export type ORDER_TYPE = 'asc' | 'desc'

  /**
   * Input parameters for the aggregates API.
   */
  export interface AggregatesInput {
    /** The ticker symbol of the stock/equity. */
    ticker: string

    /** The size of the timespan multiplier. */
    multiplier: number

    /** The size of the time window. */
    timespan: TIMESPAN

    /** The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. */
    from: string | number

    /** The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. */
    to: string | number

    /** Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. */
    adjusted?: boolean

    /** Sort the results by timestamp. "asc" will return results in ascending order (oldest at the top), "desc" will return results in descending order (newest at the top). */
    sort?: ORDER_TYPE

    /** Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. */
    limit?: number
  }

  /**
   * Output parameters for the aggregates API.
   */
  export interface AggregatesOutput {
    /** The exchange symbol that this item is traded under. */
    ticker: string

    /** Whether or not this response was adjusted for splits. */
    adjusted: boolean

    /** The number of aggregates (minute or day) used to generate the response. */
    queryCount: number

    /** A request id assigned by the server. */
    request_id: string

    /** The total number of results for this request. */
    resultsCount: number

    /** The status of this request's response. */
    status: string

    /** The results of the query. */
    results: Aggregate[]

    /** If present, this value can be used to fetch the next page of data. */
    next_url?: string
  }

  /**
   * Input parameters for the grouped daily API.
   */
  export type GroupedDailyInput = {
    /** The beginning date for the aggregate window. */
    date: string

    /** Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. */
    adjusted?: boolean
  }

  /**
   * Input parameters for the grouped daily API for stocks.
   */
  export interface GroupedDailyInputStocks extends GroupedDailyInput {
    /** Include OTC securities in the response. Default is false (don't include OTC securities). */
    include_otc?: boolean
  }

  /**
   * Output parameters for the grouped daily API.
   */
  export interface GroupedDailyOutput {
    /** Whether or not this response was adjusted for splits. */
    adjusted: boolean

    /** The number of aggregates (minute or day) used to generate the response. */
    queryCount: number

    /** A request id assigned by the server. */
    request_id: string

    /** The total number of results for this request. */
    resultsCount: number

    /** The status of this request's response. */
    status: string

    /** The results of the query. */
    results: AggregateDaily[]
  }

  /**
   * AggregateDaily parameters.
   */
  export interface AggregateDaily extends Aggregate {
    /** The exchange symbol that this item is traded under. */
    T: string
  }

  /**
   * Ticker Details v3 input parameters.
   */
  export type TickerDetailsInput = {
    /** The ticker symbol of the asset. */
    ticker: string

    /** Specify a point in time to get information about the ticker available on that date (formatted as YYYY-MM-DD). */
    date?: string
  }

  /**
   * Daily Open/Close input parameters.
   */
  export type DailyOpenCloseInput = {
    /** The ticker symbol */
    ticker: string

    /** The date of the requested open/close in the format YYYY-MM-DD. */
    date: string

    /** Whether or not the results are adjusted for splits. By default, results are adjusted. */
    adjusted?: boolean
  }

  /**
   * Result returned by the Daily Open/Close API.
   */
  export interface DailyOpenCloseOutput {
    /** The close price of the ticker symbol in after-hours trading. */
    afterHours: number

    /** The close price for the symbol in the given time period. */
    close: number

    /** The requested date. */
    from: string

    /** The highest price for the symbol in the given time period. */
    high: number

    /** The lowest price for the symbol in the given time period. */
    low: number

    /** The open price for the symbol in the given time period. */
    open: number

    /** The open price of the ticker symbol in pre-market trading. */
    preMarket: number

    /** The status of this request's response. */
    status: string

    /** The exchange symbol that this item is traded under. */
    symbol: string

    /** The trading volume of the symbol in the given time period. */
    volume: number
  }

  /**
   * Result returned by the Previous Close API.
   */
  export interface PreviousCloseOutput {
    /** Whether or not this response was adjusted for splits. */
    adjusted: boolean

    /** The number of aggregates (minute or day) used to generate the response. */
    queryCount: number

    /** A request id assigned by the server. */
    requestId: string

    /** Array of results, each containing details for the symbol in the given time period. */
    results: {
      /** The exchange symbol that this item is traded under. */
      T: string

      /** The close price for the symbol in the given time period. */
      c: number

      /** The highest price for the symbol in the given time period. */
      h: number

      /** The lowest price for the symbol in the given time period. */
      l: number

      /** The open price for the symbol in the given time period. */
      o: number

      /** The Unix Msec timestamp for the start of the aggregate window. */
      t: number

      /** The trading volume of the symbol in the given time period. */
      v: number

      /** The volume weighted average price. */
      vw: number
    }[]

    /** The total number of results for this request. */
    resultsCount: number

    /** The status of this request's response. */
    status: string

    /** The exchange symbol that this item is traded under. */
    ticker: string
  }

  /**
   * Result returned by the Ticker Details v3 API.
   */
  export interface TickerDetailsOutput {
    /** A request id assigned by the server. */
    requestId: string

    /** Detailed results for the specific ticker. */
    results: {
      /** Whether the ticker is actively traded. */
      active: boolean

      /** Address of the company. */
      address: {
        /** The first line of the company's headquarters address. */
        address1: string

        /** The city of the company's headquarters address. */
        city: string

        /** The postal code of the company's headquarters address. */
        postalCode: string

        /** The state of the company's headquarters address. */
        state: string
      }

      /** Branding details of the company. */
      branding: {
        /** A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance. */
        iconUrl: string

        /** A link to this ticker's company's logo. Note that you must provide an API key when accessing this URL. See the "Authentication" section at the top of this page for more details. */
        logoUrl: string
      }

      /** Central Index Key (CIK) of the company. */
      cik: string

      /** Composite Financial Instrument Global Identifier (FIGI). */
      compositeFigi: string

      /** Name of the currency in which the company trades. */
      currencyName: string

      /** Date and time the company was delisted, if applicable. */
      delistedUtc?: string

      /** Description of the company. */
      description: string

      /** The company's homepage URL. */
      homepageUrl: string

      /** The date when the company was listed. */
      listDate: string

      /** Locale of the company. */
      locale: string

      /** Market in which the company trades. */
      market: string

      /** Market capitalization of the company. */
      marketCap: number

      /** Name of the company. */
      name: string

      /** Phone number of the company. */
      phoneNumber: string

      /** The primary exchange on which the company trades. */
      primaryExchange: string

      /** Round lot size for the company's stock. */
      roundLot: number

      /** Share class FIGI. */
      shareClassFigi: string

      /** The number of outstanding shares for the share class. */
      shareClassSharesOutstanding: number

      /** The Standard Industrial Classification (SIC) code of the company. */
      sicCode: string

      /** Description of the SIC code. */
      sicDescription: string

      /** The ticker symbol of the company. */
      ticker: string

      /** The root of the ticker symbol. */
      tickerRoot: string

      /** The suffix of the ticker symbol, if applicable. */
      tickerSuffix?: string

      /** The total number of employees in the company. */
      totalEmployees: number

      /** The type of the ticker (e.g., common stock, preferred stock, etc.). */
      type: string

      /** The number of weighted outstanding shares. */
      weightedSharesOutstanding: number
    }

    /** The status of this request's response. */
    status: string
  }

  /**
   * Input parameters for technical indicators.
   */
  export type IndicatorInput = {
    /** The ticker symbol for which to get data. */
    ticker: string

    /** Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. */
    timestamp?: string

    /** The size of the aggregate time window. */
    timespan?: TIMESPAN

    /** Whether or not the aggregates are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. */
    adjusted?: boolean

    /** The window size used to calculate the indicator. i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. */
    window?: number

    /** The price in the aggregate which will be used to calculate the indicator. */
    series_type?: SERIES_TYPE

    /** Whether or not to include the aggregates used to calculate this indicator in the response. */
    expand_underlying?: boolean

    /** The order in which to return the results, ordered by timestamp. */
    order?: ORDER_TYPE

    /** Limit the number of results returned, default is 10 and max is 5000 */
    limit?: number
  }

  /**
   * Represents an aggregate, which includes data for a given time period.
   */
  export interface Aggregate {
    /** The close price for the symbol in the given time period. */
    c: number

    /** The highest price for the symbol in the given time period. */
    h: number

    /** The lowest price for the symbol in the given time period. */
    l: number

    /** The number of transactions in the aggregate window. */
    n: number

    /** The open price for the symbol in the given time period. */
    o: number

    /** Whether or not this aggregate is for an OTC ticker. This field will be left off if false. */
    otc?: boolean

    /** The Unix Msec timestamp for the start of the aggregate window. */
    t: number

    /** The trading volume of the symbol in the given time period. */
    v: number

    /** The volume weighted average price. */
    vw?: number
  }

  /**
   * Represents a value of the indicator, which includes timestamp and value itself.
   */
  export interface IndicatorValue {
    /** The Unix Msec timestamp from the last aggregate used in this calculation. */
    timestamp: number

    /** The indicator value for this period. */
    value: number
  }

  /**
   * The output response from the technical indicator API.
   */
  export interface IndicatorOutput {
    /** If present, this value can be used to fetch the next page of data. */
    next_url: string

    /** A request id assigned by the server. */
    request_id: string

    /** Results object containing underlying aggregates and values array. */
    results: {
      /** Underlying object containing aggregates and a URL to fetch underlying data. */
      underlying: {
        /** Array of aggregates used for calculation. */
        aggregates: Aggregate[]

        /** The URL which can be used to request the underlying aggregates used in this request. */
        url: string
      }

      /** Array of calculated indicator values. */
      values: IndicatorValue[]
    }

    /** The status of this request's response. */
    status: string
  }

  /**
   * Input parameters for the /v3/reference/tickers API.
   */
  export type TickerInput = {
    /** Specify a ticker symbol. Defaults to empty string which queries all tickers. */
    ticker?: string

    /** Specify the type of the tickers. */
    type?: string

    /** Filter by market type. */
    market?: 'crypto'

    /** Specify the primary exchange of the asset in the ISO code format. */
    exchange?: string

    /** Specify the CUSIP code of the asset you want to search for. */
    cusip?: string

    /** Specify the CIK of the asset you want to search for. */
    cik?: string

    /** Specify a point in time to retrieve tickers available on that date. */
    date?: string

    /** Search for terms within the ticker and/or company name. */
    search?: string

    /** Specify if the tickers returned should be actively traded on the queried date. */
    active?: boolean

    /** Order results based on the sort field. */
    order?: ORDER_TYPE

    /** Limit the number of results returned. */
    limit?: number

    /** Sort field used for ordering. */
    sort?: string
  }

  /**
   * Represents a ticker that matches the query.
   */
  export interface Ticker {
    /** Whether or not the asset is actively traded. */
    active: boolean

    /** The CIK number for this ticker. */
    cik: string

    /** The composite OpenFIGI number for this ticker. */
    composite_figi: string

    /** The name of the currency that this asset is traded with. */
    currency_name: string

    /** The last date that the asset was traded. */
    delisted_utc: string

    /** The information is accurate up to this time. */
    last_updated_utc: string

    /** The locale of the asset. */
    locale: 'us' | 'global'

    /** The market type of the asset. */
    market: 'stocks' | 'crypto' | 'fx' | 'otc' | 'indices'

    /** The name of the asset. */
    name: string

    /** The ISO code of the primary listing exchange for this asset. */
    primary_exchange: string

    /** The share Class OpenFIGI number for this ticker. */
    share_class_figi: string

    /** The exchange symbol that this item is traded under. */
    ticker: string

    /** The type of the asset. */
    type: string
  }

  /**
   * The output response from the /v3/reference/tickers API.
   */
  export interface TickerOutput {
    /** The total number of results for this request. */
    count: number

    /** If present, this value can be used to fetch the next page of data. */
    next_url: string

    /** A request id assigned by the server. */
    request_id: string

    /** An array of tickers that match your query. */
    results: Ticker[]

    /** The status of this request's response. */
    status: string
  }

  /**
   * Output parameters for the market status API.
   */
  export interface MarketStatusOutput {
    /** Whether or not the market is in post-market hours. */
    afterHours: boolean

    /** The status of the crypto and forex markets. */
    currencies: {
      /** The status of the crypto market. */
      crypto: string
      /** The status of the forex market. */
      fx: string
    }

    /** Whether or not the market is in pre-market hours. */
    earlyHours: boolean

    /** The status of the Nasdaq, NYSE and OTC markets. */
    exchanges: {
      /** The status of the Nasdaq market. */
      nasdaq: string
      /** The status of the NYSE market. */
      nyse: string
      /** The status of the OTC market. */
      otc: string
    }

    /** The status of the market as a whole. */
    market: string

    /** The current time of the server. */
    serverTime: string
  }

  /**
   * Output parameters for the market holidays API.
   */
  export interface MarketHolidayOutput {
    /** The market close time on the holiday (if it's not closed). */
    close?: string

    /** The date of the holiday. */
    date: string

    /** Which market the record is for. */
    exchange: string

    /** The name of the holiday. */
    name: string

    /** The market open time on the holiday (if it's not closed). */
    open?: string

    /** The status of the market on the holiday. */
    status: string
  }

  /**
   * Input parameters for the ticker types API.
   */
  export type TickerTypesInput = {
    /** Filter by asset class. */
    asset_class?: ASSET_CLASS

    /** Filter by locale. */
    locale?: string
  }

  /**
   * Output parameters for the ticker types API.
   */
  export interface TickerTypesOutput {
    /** The total number of results for this request. */
    count: number

    /** A request ID assigned by the server. */
    request_id: string

    /** The results of the query. */
    results: TickerType[]

    /** The status of this request's response. */
    status: string
  }

  /**
   * Ticker type parameters.
   */
  export interface TickerType {
    /** An identifier for a group of similar financial instruments. */
    asset_class: ASSET_CLASS

    /** A code used by Polygon.io to refer to this ticker type. */
    code: string

    /** A short description of this ticker type. */
    description: string

    /** An identifier for a geographical location. */
    locale: string
  }

  /**
   * Input parameters for the ticker news API.
   */
  export type TickerNewsInput = {
    /** Ticker symbol to return results for. */
    ticker: string

    /** Date to return results published on, before, or after. */
    published_utc?: string

    /** Order results based on the sort field. */
    order?: ORDER_TYPE

    /** Limit the number of results returned, default is 10 and max is 1000. */
    limit?: number

    /** Sort field used for ordering. */
    sort?: string
  }

  /**
   * Output parameters for the ticker news API.
   */
  export interface TickerNewsOutput {
    /** The total number of results for this request. */
    count: number

    /** If present, this value can be used to fetch the next page of data. */
    next_url: string

    /** A request id assigned by the server. */
    request_id: string

    /** The results of the query. */
    results: TickerNews[]

    /** The status of this request's response. */
    status: string
  }

  /**
   * Ticker news parameters.
   */
  export interface TickerNews {
    /** The mobile friendly Accelerated Mobile Page (AMP) URL. */
    amp_url?: string

    /** A link to the news article. */
    article_url: string

    /** The article's author. */
    author: string

    /** A description of the article. */
    description?: string

    /** Unique identifier for the article. */
    id: string

    /** The article's image URL. */
    image_url?: string

    /** The keywords associated with the article (which will vary depending on the publishing source). */
    keywords?: string[]

    /** The date the article was published on. */
    published_utc: string

    /** The publisher's details. */
    publisher: Publisher

    /** The ticker symbols associated with the article. */
    tickers: string[]

    /** The title of the news article. */
    title: string
  }

  /**
   * Publisher parameters.
   */
  export interface Publisher {
    /** The publisher's homepage favicon URL. */
    favicon_url?: string

    /** The publisher's homepage URL. */
    homepage_url: string

    /** The publisher's logo URL. */
    logo_url: string

    /** The publisher's name. */
    name: string
  }

  /**
   * Input parameters for the exchanges API.
   */
  export type ExchangesInput = {
    /** Filter by asset class. */
    asset_class?: ASSET_CLASS

    /** Filter by locale. */
    locale?: string
  }

  /**
   * Output parameters for the exchanges API.
   */
  export interface ExchangesOutput {
    /** The total number of results for this request. */
    count: number

    /** A request ID assigned by the server. */
    request_id: string

    /** The results of the query. */
    results: Exchange[]

    /** The status of this request's response. */
    status: string
  }

  /**
   * Exchange parameters.
   */
  export interface Exchange {
    /** A commonly used abbreviation for this exchange. */
    acronym?: string

    /** An identifier for a group of similar financial instruments. */
    asset_class: ASSET_CLASS

    /** A unique identifier used by Polygon.io for this exchange. */
    id: number

    /** An identifier for a geographical location. */
    locale: 'us' | 'global'

    /** The Market Identifer Code of this exchange (see ISO 10383). */
    mic: string

    /** Name of this exchange. */
    name: string

    /** The MIC of the entity that operates this exchange. */
    operating_mic: string

    /** The ID used by SIP's to represent this exchange. */
    participant_id?: string

    /** Represents the type of exchange. */
    type: 'exchange' | 'TRF' | 'SIP'

    /** A link to this exchange's website, if one exists. */
    url?: string
  }
}

/**
 * Client for the Polygon.io API that lets you query the latest market data
 * from all US stock exchanges. You can also find data on company financials,
 * stock market holidays, corporate actions, and more.
 *
 * @see {@link https://polygon.io/docs}
 */
export class PolygonClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('POLYGON_API_KEY'),
    apiBaseUrl = polygon.API_BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'PolygonClient missing required "apiKey" (defaults to "POLYGON_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      headers: {
        Authorization: `Bearer ${this.apiKey}`
      }
    })
  }

  /**
   * Returns detailed information about a single ticker.
   *
   * @param params - input parameters (`ticker` symbol and optional `date`)
   * @returns promise that resolves to detailed information about a single ticker
   */
  async tickerDetails(params: polygon.TickerDetailsInput) {
    let searchParams
    if (params.date) {
      searchParams = {
        date: params.date
      }
    }

    return this.ky
      .get(`v3/reference/tickers/${params.ticker}`, {
        searchParams
      })
      .json<polygon.TickerDetailsOutput>()
  }

  /**
   * Returns the open, close and after hours prices of a stock symbol on a certain date.
   *
   * @param params - input parameters (`ticker` symbol and `date`)
   * @returns promise that resolves to the open, close and after hours prices of a stock symbol on a certain date
   */
  async dailyOpenClose(params: polygon.DailyOpenCloseInput) {
    return this.ky
      .get(`v1/open-close/${params.ticker}/${params.date}`, {
        searchParams: {
          adjusted: params.adjusted ?? true
        }
      })
      .json<polygon.DailyOpenCloseOutput>()
  }

  /**
   * Returns the previous day's open, high, low, and close (OHLC) for the specified stock ticker.
   *
   * @param ticker - ticker symbol of the stock/equity
   * @param adjusted - whether or not the results are adjusted for splits
   * @returns promise that resolves to the previous day's open, high, low, and close (OHLC) for the specified stock ticker
   */
  async previousClose(ticker: string, adjusted = true) {
    return this.ky
      .get(`v2/aggs/ticker/${ticker}/prev`, {
        searchParams: {
          adjusted
        }
      })
      .json<polygon.PreviousCloseOutput>()
  }

  /**
   * Get the simple moving average (SMA) for a ticker symbol over a given time range.
   *
   * @param params - input parameters
   * @returns promise that resolves to the simple moving average (SMA) for a ticker symbol over a given time range
   */
  async sma(params: polygon.IndicatorInput) {
    return this.ky
      .get(`v1/indicators/sma/${params.ticker}`, {
        searchParams: params
      })
      .json<polygon.IndicatorOutput>()
  }

  /**
   * Get the exponential moving average (EMA) for a ticker symbol over a given time range.
   *
   * @param params - input parameters
   * @returns promise that resolves to the exponential moving average (EMA) for a ticker symbol over a given time range
   */
  async ema(params: polygon.IndicatorInput) {
    return this.ky
      .get(`v1/indicators/ema/${params.ticker}`, {
        searchParams: params
      })
      .json<polygon.IndicatorOutput>()
  }

  /**
   * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range.
   *
   * @param params - input parameters
   * @returns promise that resolves to the moving average convergence/divergence (MACD) for a ticker symbol over a given time range
   */
  async macd(params: polygon.IndicatorInput) {
    return this.ky
      .get(`v1/indicators/ema/${params.ticker}`, {
        searchParams: params
      })
      .json<polygon.IndicatorOutput>()
  }

  /**
   * Get the relative strength index (RSI) for a ticker symbol over a given time range.
   *
   * @param params - input parameters
   * @returns promise that resolves to the relative strength index (RSI) for a ticker symbol over a given time range
   */
  async rsi(params: polygon.IndicatorInput) {
    return this.ky
      .get(`v1/indicators/rsi/${params.ticker}`, {
        searchParams: params
      })
      .json<polygon.IndicatorOutput>()
  }

  /**
   * Query all ticker symbols which are supported by Polygon.io. Currently includes Stocks/Equities, Indices, Forex, and Crypto.
   *
   * @param params - input parameters to filter the list of ticker symbols
   * @returns promise that resolves to a list of ticker symbols and their details
   */
  async tickers(params: polygon.TickerInput): Promise<polygon.TickerOutput> {
    return this.ky
      .get('v3/reference/tickers', { searchParams: params })
      .json<polygon.TickerOutput>()
  }

  /**
   * List all ticker types that Polygon.io has.
   *
   * @param params - input parameters (`asset_class` and `locale`)
   * @returns promise that resolves to ticker types
   */
  async tickerTypes(params: polygon.TickerTypesInput = {}) {
    return this.ky
      .get('v3/reference/tickers/types', { searchParams: params })
      .json<polygon.TickerTypesOutput>()
  }

  /**
   * Get the most recent news articles relating to a stock ticker symbol.
   *
   * @param params - input parameters (`ticker`, `published_utc`, `order`, `limit`, `sort`)
   * @returns promise that resolves to ticker news
   */
  async tickerNews(params: polygon.TickerNewsInput) {
    return this.ky
      .get('v2/reference/news', { searchParams: params })
      .json<polygon.TickerNewsOutput>()
  }

  /**
   * Returns the current trading status of the exchanges and overall financial markets.
   *
   * @returns promise that resolves to the market status
   */
  async marketStatus() {
    return this.ky.get('v1/marketstatus/now').json<polygon.MarketStatusOutput>()
  }

  /**
   * Gets upcoming market holidays and their open/close times.
   *
   * @returns promise that resolves to an array of market holidays
   */
  async marketHolidays(): Promise<polygon.MarketHolidayOutput[]> {
    return this.ky
      .get('v1/marketstatus/upcoming')
      .json<polygon.MarketHolidayOutput[]>()
  }

  /**
   * List all exchanges that Polygon.io knows about.
   *
   * @param params - input parameters (`asset_class`, `locale`)
   * @returns promise that resolves to list of exchanges
   */
  async exchanges(params: polygon.ExchangesInput = {}) {
    return this.ky
      .get('v3/reference/exchanges', { searchParams: params })
      .json<polygon.ExchangesOutput>()
  }

  /**
   * Get aggregate bars for a stock over a given date range in custom time window sizes.
   *
   * @param params - input parameters
   * @returns promise that resolves to list of aggregates
   */
  async aggregates(params: polygon.AggregatesInput) {
    const { ticker, multiplier, timespan, from, to, ...otherParams } = params
    const endpoint = `v2/aggs/ticker/${ticker}/range/${multiplier}/${timespan}/${from}/${to}`
    return this.ky
      .get(endpoint, { searchParams: otherParams })
      .json<polygon.AggregatesOutput>()
  }

  /**
   * Get the daily open, high, low, and close (OHLC) for the entire markets.
   *
   * @param assetClass - the asset class to get data for
   * @param params - input parameters (`date`, `adjusted`)
   * @returns promise that resolves to list of aggregates
   */
  async groupedDaily(
    assetClass: polygon.ASSET_CLASS,
    params: polygon.GroupedDailyInput
  ) {
    const { date, ...otherParams } = params
    const endpoint = `v2/aggs/grouped/locale/us/market/${assetClass}/${date}`
    return this.ky
      .get(endpoint, { searchParams: otherParams })
      .json<polygon.GroupedDailyOutput>()
  }
}


================================================
FILE: legacy/packages/polygon/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/predict-leads/package.json
================================================
{
  "name": "@agentic/predict-leads",
  "version": "7.6.9",
  "description": "Agentic SDK for Predict Leads.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/predict-leads"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/predict-leads/src/index.ts
================================================
export * from './predict-leads-client'


================================================
FILE: legacy/packages/predict-leads/src/predict-leads-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  type DeepNullable,
  getEnv,
  pruneUndefined,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

// TODO: improve `domain` validation for fast-fail

export namespace predictleads {
  // Allow up to 20 requests per minute by default.
  export const throttle = pThrottle({
    limit: 20,
    interval: 60 * 1000
  })

  export const DEFAULT_PAGE_SIZE = 100
  export const MAX_PAGE_SIZE = 1000

  export type Meta = DeepNullable<{
    count: number
    message?: string | null
    message_type?: string
  }>

  export type GenericSuccessResponse = {
    success: {
      type: string
      message: string
    }
  }

  export type FollowedCompaniesResponse = {
    data: DeepNullable<
      Array<{
        domain: string
        custom_company_identifier: string | null
      }>
    >
    meta: Meta
  }

  export type Relationship = Record<
    string,
    {
      data: {
        id: string
        type: string
      }
    }
  >

  export type AdditionalData = {
    relationships: {
      companies: [string, string]
    }
    date: string
    location: string
    location_data: {
      region?: string
      continent?: string
      country?: string
      state?: string
      zip_code?: string
      city?: string
      fuzzy_match?: boolean
    }
    contact?: string
    job_title?: string
    product?: string
    product_tags?: string[]
    amount?: number
    recognition?: string
    assets?: string
    asset_tags?: string[]
    headcount?: number
    award?: string
    financing_type?: string
    financing_type_tags?: string[]
    funding_round?: string
    division?: string
    conference?: string
    vulnerability?: string
    planning?: boolean
    article_title?: string
    article_sentence?: string
    article_body?: string
    article_source?: string
    article_published_at?: string
    article_image_url?: string
  }

  export type Event = {
    id: string
    type: string
    attributes: {
      categories: string[]
      title: string
      url: string
      found_at: string
      additional_data: AdditionalData
      domain: string
      location: string
      location_data: {
        state: string
        country: string
      }
      company_name: string
      friendly_company_name: string
      ticker: null
      meta_title: string
      meta_description: string
      published_at: string
      post_type: string
      post_url: string
      company_domain: string
      fuzzy_match: boolean
    }
    relationships: Relationship
  }

  export type Response = DeepNullable<{
    data: Event[]
    included: Relationship
    meta: Meta
  }>

  export type JobOpeningData = {
    id: string
    type: string
    attributes: {
      title: string
      url: string
      description: string
      salary: string
      salary_data: {
        salary_low: number
        salary_high: number
        salary_currency: string
        salary_low_usd: number
        salary_high_usd: number
        salary_time_unit: string
      }
      job_opening_closed: boolean
      location: string
      contract_types: string[]
      first_seen_at: string
      last_seen_at: string
      last_processed_at: string
      categories: string[]
      onet_code: string
      additional_data: {
        job_title_seniority: string
        tags: string[]
        location_data: {
          country: string
          city: string
          fuzzy_match: boolean
        }
      }
    }
    relationships: {
      company: {
        data: {
          id: string
          type: string
        }
      }
    }
  }

  export type CompanyData = {
    id: string
    type: string
    attributes: {
      domain: string
      company_name: string
      ticker: string | null
    }
  }

  export type JobOpeningResponse = DeepNullable<{
    data: JobOpeningData[]
    included: CompanyData[]
    meta: {
      count: number
    }
  }>

  export type JobOpeningByIdResponse = Omit<JobOpeningResponse, 'meta'>

  export const EventCategorySchema = z
    .union([
      z
        .literal('hires')
        .describe(
          'Company hired new executive or senior personnel. (leadership)'
        ),
      z
        .literal('promotes')
        .describe(
          'Company promoted existing executive or senior personnel. (leadership)'
        ),
      z
        .literal('leaves')
        .describe(
          'Executive or senior personnel left the company. (leadership)'
        ),
      z
        .literal('retires')
        .describe(
          'Executive or senior personnel retires from the company. (leadership)'
        ),
      z
        .literal('acquires')
        .describe('Company acquired other company. (acquisition)'),
      z
        .literal('merges_with')
        .describe('Company merges with other company. (acquisition)'),
      z
        .literal('sells_assets_to')
        .describe(
          'Company sells assets (like properties or warehouses) to other company. (acquisition)'
        ),
      z
        .literal('expands_offices_to')
        .describe(
          'Company opens new offices in another town, state, country or continent. (expansion)'
        ),
      z
        .literal('expands_offices_in')
        .describe('Company expands existing offices. (expansion)'),
      z
        .literal('expands_facilities')
        .describe(
          'Company opens new or expands existing facilities like warehouses, data centers, manufacturing plants etc. (expansion)'
        ),
      z
        .literal('opens_new_location')
        .describe(
          'Company opens new service location like hotels, restaurants, bars, hospitals etc. (expansion)'
        ),
      z
        .literal('increases_headcount_by')
        .describe('Company offers new job vacancies. (expansion)'),
      z
        .literal('launches')
        .describe('Company launches new offering. (new_offering)'),
      z
        .literal('integrates_with')
        .describe('Company integrates with other company. (new_offering)'),
      z
        .literal('is_developing')
        .describe(
          'Company begins development of a new offering. (new_offering)'
        ),
      z
        .literal('receives_financing')
        .describe(
          'Company receives investment like venture funding, loan, grant etc. (investment)'
        ),
      z
        .literal('invests_into')
        .describe('Company invests into other company. (investment)'),
      z
        .literal('invests_into_assets')
        .describe(
          'Company invests into assets like property, trucks, facilities etc. (investment)'
        ),
      z
        .literal('goes_public')
        .describe(
          'Company issues shares to the public for the first time. (investment)'
        ),
      z
        .literal('closes_offices_in')
        .describe('Company closes existing offices. (cost_cutting)'),
      z
        .literal('decreases_headcount_by')
        .describe('Company lays off employees. (cost_cutting)'),
      z
        .literal('partners_with')
        .describe('Company partners with other company. (partnership)'),
      z
        .literal('receives_award')
        .describe(
          'Company or person at the company receives an award. (recognition)'
        ),
      z
        .literal('recognized_as')
        .describe(
          'Company or person at the company receives recognition. (recognition)'
        ),
      z
        .literal('signs_new_client')
        .describe('Company signs new client. (contract)'),
      z
        .literal('files_suit_against')
        .describe(
          'Company files suit against other company. (corporate_challenges)'
        ),
      z
        .literal('has_issues_with')
        .describe('Company has vulnerability problems. (corporate_challenges)'),
      z
        .literal('identified_as_competitor_of')
        .describe('New or existing competitor was identified. (relational)')
    ])
    .describe('Event category')
  export type EventCategory = z.infer<typeof EventCategorySchema>

  export const CompanyParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company')
  })
  export type CompanyParams = z.infer<typeof CompanyParamsSchema>

  export const CompanyEventsParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    categories: z.array(EventCategorySchema).optional(),
    found_at_from: z
      .string()
      .optional()
      .describe('Signals found from specified date (ISO 8601).'),
    found_at_until: z
      .string()
      .optional()
      .describe('Signals found until specified date (ISO 8601).'),
    page: z.number().int().default(1).optional(),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional(),
    with_news_article_bodies: z
      .boolean()
      .optional()
      .describe('Whether or not to include the body contents of news articles.')
  })
  export type CompanyEventsParams = z.infer<typeof CompanyEventsParamsSchema>

  export const CompanyFinancingEventsParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company')
  })
  export type CompanyFinancingEventsParams = z.infer<
    typeof CompanyFinancingEventsParamsSchema
  >

  export const CompanyJobOpeningsParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    categories: z.array(EventCategorySchema).optional(),
    found_at_from: z
      .string()
      .optional()
      .describe('Signals found from specified date (ISO 8601).'),
    found_at_until: z
      .string()
      .optional()
      .describe('Signals found until specified date (ISO 8601).'),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional(),
    with_job_descriptions: z
      .boolean()
      .optional()
      .describe('Whether or not to include the full descriptions of the jobs.'),
    with_description_only: z
      .boolean()
      .optional()
      .describe('If set, only returns job openings with descriptions.'),
    with_location_only: z
      .boolean()
      .optional()
      .describe('If set, only returns job openings with locations.'),
    active_only: z
      .boolean()
      .optional()
      .describe(
        'If set, only returns job openings that are not closed, have `last_seen_at` more recent than 5 days and were found in the last year.'
      ),
    not_closed: z
      .boolean()
      .optional()
      .describe(
        'Similar to `active_only`, but without considering `last_seen_at` timestamp.'
      )
  })
  export type CompanyJobOpeningsParams = z.infer<
    typeof CompanyJobOpeningsParamsSchema
  >

  export const CompanyTechnologiesParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    categories: z.array(EventCategorySchema).optional(),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional()
  })
  export type CompanyTechnologiesParams = z.infer<
    typeof CompanyTechnologiesParamsSchema
  >

  export const CompanyConnectionsParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    categories: z.array(EventCategorySchema).optional(),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional()
  })
  export type CompanyConnectionsParams = z.infer<
    typeof CompanyConnectionsParamsSchema
  >

  export const CompanyWebsiteEvolutionParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional()
  })
  export type CompanyWebsiteEvolutionParams = z.infer<
    typeof CompanyWebsiteEvolutionParamsSchema
  >

  export const CompanyGitHubReposParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional()
  })
  export type CompanyGitHubReposParams = z.infer<
    typeof CompanyGitHubReposParamsSchema
  >

  export const CompanyProductsParamsSchema = z.object({
    domain: z.string().min(3).describe('domain of the company'),
    sources: z.array(z.string()).optional(),
    limit: z
      .number()
      .int()
      .max(MAX_PAGE_SIZE)
      .default(DEFAULT_PAGE_SIZE)
      .optional()
  })
  export type CompanyProductsParams = z.infer<
    typeof CompanyProductsParamsSchema
  >
}

/**
 * In-depth company data, including signals like fundraising announcemnts,
 * hiring intent, new customers signed, technologies used, product launches,
 * location expansions, awards received, etc.
 *
 * @see https://predictleads.com
 */
export class PredictLeadsClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiToken: string

  constructor({
    apiKey = getEnv('PREDICT_LEADS_API_KEY'),
    apiToken = getEnv('PREDICT_LEADS_API_TOKEN'),
    timeoutMs = 30_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiToken?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'PredictLeadsClient missing required "apiKey" (defaults to "PREDICT_LEADS_API_KEY")'
    )
    assert(
      apiToken,
      'PredictLeadsClient missing required "apiToken" (defaults to "PREDICT_LEADS_API_TOKEN")'
    )
    super()

    this.apiKey = apiKey
    this.apiToken = apiToken

    const throttledKy = throttle ? throttleKy(ky, predictleads.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: 'https://predictleads.com/api',
      timeout: timeoutMs,
      headers: {
        'x-api-key': apiKey,
        'x-api-token': apiToken
      }
    })
  }

  /**
   * Returns basic information about a company given its `domain` like location, name, stock ticker, description, etc.
   */
  @aiFunction({
    name: 'get_company',
    description:
      'Returns basic information about a company given its `domain` like location, name, stock ticker, description, etc.',
    inputSchema: predictleads.CompanyParamsSchema
  })
  async getCompany(domainOrOpts: string | predictleads.CompanyParams) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky.get(`v2/companies/${domain}`).json<predictleads.Response>()
  }

  /**
   * Returns a list of events from news for a given company. Events are found in press releases, industry news, blogs, social media, and other online sources.
   */
  @aiFunction({
    name: 'get_company_events',
    description:
      'Returns a list of events from news for a given company. Events are found in press releases, industry news, blogs, social media, and other online sources.',
    inputSchema: predictleads.CompanyEventsParamsSchema
  })
  async getCompanyEvents(
    domainOrOpts: string | predictleads.CompanyEventsParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const {
      domain,
      page = 1,
      limit = predictleads.DEFAULT_PAGE_SIZE,
      ...params
    } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/events`, {
        searchParams: sanitizeSearchParams({
          page,
          limit,
          ...params
        })
      })
      .json<predictleads.Response>()
  }

  async getEventById(id: string) {
    return this.ky.get(`v2/events/${id}`).json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_financing_events',
    description:
      'Returns a list of financing events for a given company. Financing events include fundraising announcements and quarterly earning reports for public companies. They are sourced from press releases, industry news, blogs, social media, and other online sources.',
    inputSchema: predictleads.CompanyFinancingEventsParamsSchema
  })
  async getCompanyFinancingEvents(
    domainOrOpts: string | predictleads.CompanyFinancingEventsParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/financing_events`)
      .json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_job_openings',
    description:
      'Returns a list of job openings for a given company. Job openings are found on companies’ career sites and job boards.',
    inputSchema: predictleads.CompanyJobOpeningsParamsSchema
  })
  async getCompanyJobOpenings(
    domainOrOpts: string | predictleads.CompanyJobOpeningsParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/job_openings`, {
        searchParams: sanitizeSearchParams({
          limit,
          ...params
        })
      })
      .json<predictleads.JobOpeningResponse>()
  }

  async getJobOpeningById(id: string) {
    return this.ky
      .get(`v2/job_openings/${id}`)
      .json<predictleads.JobOpeningByIdResponse>()
  }

  @aiFunction({
    name: 'get_company_technologies',
    description: 'Returns a list of technology providers for a given company.',
    inputSchema: predictleads.CompanyTechnologiesParamsSchema
  })
  async getCompanyTechnologies(
    domainOrOpts: string | predictleads.CompanyTechnologiesParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/technologies`, {
        searchParams: sanitizeSearchParams({
          limit,
          ...params
        })
      })
      .json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_connections',
    description:
      'Returns a list of categorized business connections. Business connections can be found via backlinks or logos on /our-customers, /case-studies, /portfolio, /clients etc. pages. Business connections enable you to eg. calculate network health of a company, to build systems when new high value connections are made… Connections can be of many types: partner, vendor, investor, parent…',
    inputSchema: predictleads.CompanyConnectionsParamsSchema
  })
  async getCompanyConnections(
    domainOrOpts: string | predictleads.CompanyConnectionsParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/connections`, {
        searchParams: sanitizeSearchParams({
          limit,
          ...params
        })
      })
      .json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_website_evolution',
    description:
      'Returns insights into how a website has changed over time. E.g., when pages like “Blog”, “Privacy policy”, “Pricing”, “Product”, “API Docs”, “Team”, “Support pages” etc were added. This can serve as a proxy to how quickly a website is growing, to determine the growth stage they are at and also to help segment websites.',
    inputSchema: predictleads.CompanyWebsiteEvolutionParamsSchema
  })
  async getCompanyWebsiteEvolution(
    domainOrOpts: string | predictleads.CompanyWebsiteEvolutionParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/website_evolution`, {
        searchParams: sanitizeSearchParams({ limit, ...params })
      })
      .json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_github_repos',
    description:
      'Returns insights into how frequently a company is contributing to its public GitHub repositories.',
    inputSchema: predictleads.CompanyGitHubReposParamsSchema
  })
  async getCompanyGitHubRepositories(
    domainOrOpts: string | predictleads.CompanyGitHubReposParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/github_repositories`, {
        searchParams: sanitizeSearchParams({ limit, ...params })
      })
      .json<predictleads.Response>()
  }

  @aiFunction({
    name: 'get_company_products',
    description:
      'Returns what kind of products / solutions / features a company is offering.',
    inputSchema: predictleads.CompanyProductsParamsSchema
  })
  async getCompanyProducts(
    domainOrOpts: string | predictleads.CompanyProductsParams
  ) {
    const opts =
      typeof domainOrOpts === 'string' ? { domain: domainOrOpts } : domainOrOpts
    const { domain, limit = predictleads.DEFAULT_PAGE_SIZE, ...params } = opts
    assert(domain, 'Missing required company "domain"')

    return this.ky
      .get(`v2/companies/${domain}/products`, {
        searchParams: sanitizeSearchParams({
          limit,
          ...params
        })
      })
      .json<predictleads.Response>()
  }

  async discoverStartupJobsHN(params?: {
    post_datetime_from?: string
    post_datetime_until?: string
    min_score?: string
    limit?: string
  }) {
    return this.ky
      .get(`v2/discover/startup_platform/jobs_hn`, {
        searchParams: params
      })
      .json<predictleads.Response>()
  }

  async discoverStartupShowHN(params?: {
    post_datetime_from?: string
    post_datetime_until?: string
    min_score?: string
    limit?: string
  }) {
    return this.ky
      .get(`v2/discover/startup_platform/show_hn`, {
        searchParams: params
      })
      .json<predictleads.Response>()
  }

  // --------------------------------------------------------------------------
  // Stateful endpoints which should generally not be used as AI functions.
  // --------------------------------------------------------------------------

  async followCompany(domain: string, customCompanyIdentifier?: string) {
    return this.ky
      .post(`v2/companies/${domain}/follow`, {
        json: pruneUndefined({ customCompanyIdentifier })
      })
      .json<predictleads.GenericSuccessResponse>()
  }

  async getFollowingCompanies(limit: number = predictleads.DEFAULT_PAGE_SIZE) {
    return this.ky
      .get(`v2/followings`, {
        searchParams: sanitizeSearchParams({ limit })
      })
      .json<predictleads.FollowedCompaniesResponse>()
  }

  async unfollowCompany(domain: string, customCompanyIdentifier?: string) {
    return this.ky
      .post(`v2/companies/${domain}/unfollow`, {
        json: pruneUndefined({ customCompanyIdentifier })
      })
      .json<predictleads.GenericSuccessResponse>()
  }
}


================================================
FILE: legacy/packages/predict-leads/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/proxycurl/package.json
================================================
{
  "name": "@agentic/proxycurl",
  "version": "7.6.9",
  "description": "Agentic SDK for Proxycurl.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/proxycurl"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/proxycurl/src/index.ts
================================================
export * from './proxycurl-client'


================================================
FILE: legacy/packages/proxycurl/src/proxycurl-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams,
  type Simplify,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

// All proxycurl types are auto-generated from their openapi spec
export namespace proxycurl {
  // Allow up to 300 requests per minute by default (enforced at 5 minute intervals).
  export const throttle = pThrottle({
    limit: 1500,
    interval: 5 * 60 * 1000
  })

  export const CompanyTypeSchema = z.enum([
    'EDUCATIONAL',
    'GOVERNMENT_AGENCY',
    'NON_PROFIT',
    'PARTNERSHIP',
    'PRIVATELY_HELD',
    'PUBLIC_COMPANY',
    'SELF_EMPLOYED',
    'SELF_OWNED'
  ])
  export type CompanyType = z.infer<typeof CompanyTypeSchema>

  export const OptionalFieldSchema = z.enum(['exclude', 'include']).optional()
  export type OptionalField = z.infer<typeof OptionalFieldSchema>

  export const OptionalEnrichFieldSchema = z.enum(['skip', 'enrich']).optional()
  export type OptionalEnrichField = z.infer<typeof OptionalEnrichFieldSchema>

  export const UseCacheSchema = z.enum(['if-present', 'if-recent']).optional()
  export type UseCache = z.infer<typeof UseCacheSchema>

  export const FallbackToCacheSchema = z.enum(['on-error', 'never']).optional()
  export type FallbackToCache = z.infer<typeof FallbackToCacheSchema>

  export const CompanyProfileEndpointParamsQueryClassSchema = z.object({
    url: z.string(),
    acquisitions: OptionalFieldSchema,
    categories: OptionalFieldSchema,
    exit_data: OptionalFieldSchema,
    extra: OptionalFieldSchema,
    funding_data: OptionalFieldSchema,
    resolve_numeric_id: z.boolean().optional(),
    fallback_to_cache: FallbackToCacheSchema,
    use_cache: UseCacheSchema
  })
  export type CompanyProfileEndpointParamsQueryClass = z.infer<
    typeof CompanyProfileEndpointParamsQueryClassSchema
  >

  /**
   * Requires one of:
   * - `facebook_profile_url`
   * - `linkedin_profile_url`
   * - `twitter_profile_url`
   */
  export const PersonProfileEndpointParamsQueryClassSchema = z.object({
    facebook_profile_url: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    twitter_profile_url: z.string().optional(),
    facebook_profile_id: OptionalFieldSchema,
    twitter_profile_id: OptionalFieldSchema,
    extra: OptionalFieldSchema,
    github_profile_id: OptionalFieldSchema,
    inferred_salary: OptionalFieldSchema,
    personal_contact_number: OptionalFieldSchema,
    personal_email: OptionalFieldSchema,
    skills: OptionalFieldSchema,
    fallback_to_cache: FallbackToCacheSchema,
    use_cache: UseCacheSchema
  })
  export type PersonProfileEndpointParamsQueryClass = Simplify<
    z.infer<typeof PersonProfileEndpointParamsQueryClassSchema>
  >

  export const PersonLookupEndpointParamsQueryClassSchema = z.object({
    company_domain: z
      .string()
      .describe('The domain URL of the company the person works at'),
    first_name: z.string(),
    last_name: z.string().optional(),
    location: z.string().optional(),
    similarity_checks: z
      .union([z.literal('include'), z.literal('skip')])
      .optional(),
    title: z.string().optional(),
    enrich_profile: OptionalEnrichFieldSchema
  })
  export type PersonLookupEndpointParamsQueryClass = z.infer<
    typeof PersonLookupEndpointParamsQueryClassSchema
  >

  export const RoleLookupEndpointParamsQueryClassSchema = z.object({
    company_name: z.string(),
    role: z.string(),
    enrich_profile: OptionalEnrichFieldSchema
  })
  export type RoleLookupEndpointParamsQueryClass = z.infer<
    typeof RoleLookupEndpointParamsQueryClassSchema
  >

  export const CompanyLookupEndpointParamsQueryClassSchema = z.object({
    company_domain: z.string().optional(),
    company_location: z.string().optional(),
    company_name: z.string().optional(),
    enrich_profile: OptionalEnrichFieldSchema
  })
  export type CompanyLookupEndpointParamsQueryClass = z.infer<
    typeof CompanyLookupEndpointParamsQueryClassSchema
  >

  export const ReverseEmailLookupEndpointParamsQueryClassSchema = z.object({
    email: z.string(),
    enrich_profile: OptionalEnrichFieldSchema,
    lookup_depth: z.string().optional()
  })
  export type ReverseEmailLookupEndpointParamsQueryClass = z.infer<
    typeof ReverseEmailLookupEndpointParamsQueryClassSchema
  >

  export const CompanySearchEndpointParamsQueryClassSchema = z.object({
    city: z.string().optional(),
    country: z.string().optional(),
    description: z.string().optional(),
    employee_count_max: z.string().optional(),
    employee_count_min: z.string().optional(),
    follower_count_max: z.string().optional(),
    follower_count_min: z.string().optional(),
    founded_after_year: z.string().optional(),
    founded_before_year: z.string().optional(),
    funding_amount_max: z.string().optional(),
    funding_amount_min: z.string().optional(),
    funding_raised_after: z.string().optional(),
    funding_raised_before: z.string().optional(),
    industry: z.string().optional(),
    name: z.string().optional(),
    page_size: z.string().optional(),
    public_identifier_in_list: z.string().optional(),
    public_identifier_not_in_list: z.string().optional(),
    region: z.string().optional(),
    type: z.string().optional(),
    enrich_profiles: z.string().optional()
  })
  export type CompanySearchEndpointParamsQueryClass = z.infer<
    typeof CompanySearchEndpointParamsQueryClassSchema
  >

  export const PersonSearchEndpointParamsQueryClassSchema = z.object({
    city: z.string().optional(),
    country: z.string(),
    current_company_city: z.string().optional(),
    current_company_country: z.string().optional(),
    current_company_description: z.string().optional(),
    current_company_employee_count_max: z.string().optional(),
    current_company_employee_count_min: z.string().optional(),
    current_company_follower_count_max: z.string().optional(),
    current_company_follower_count_min: z.string().optional(),
    current_company_founded_after_year: z.string().optional(),
    current_company_founded_before_year: z.string().optional(),
    current_company_funding_amount_max: z.string().optional(),
    current_company_funding_amount_min: z.string().optional(),
    current_company_funding_raised_after: z.string().optional(),
    current_company_funding_raised_before: z.string().optional(),
    current_company_industry: z.string().optional(),
    current_company_linkedin_profile_url: z.string().optional(),
    current_company_name: z.string().optional(),
    current_company_region: z.string().optional(),
    current_company_type: z.string().optional(),
    current_job_description: z.string().optional(),
    current_role_after: z.string().optional(),
    current_role_before: z.string().optional(),
    current_role_title: z.string().optional(),
    education_degree_name: z.string().optional(),
    education_field_of_study: z.string().optional(),
    education_school_linkedin_profile_url: z.string().optional(),
    education_school_name: z.string().optional(),
    enrich_profiles: z.string().optional(),
    first_name: z.string().optional(),
    headline: z.string().optional(),
    industries: z.string().optional(),
    interests: z.string().optional(),
    languages: z.string().optional(),
    last_name: z.string().optional(),
    linkedin_groups: z.string().optional(),
    page_size: z.string().optional(),
    past_company_linkedin_profile_url: z.string().optional(),
    past_company_name: z.string().optional(),
    past_job_description: z.string().optional(),
    past_role_title: z.string().optional(),
    public_identifier_in_list: z.string().optional(),
    public_identifier_not_in_list: z.string().optional(),
    region: z.string().optional(),
    skills: z.string().optional(),
    summary: z.string().optional()
  })
  export type PersonSearchEndpointParamsQueryClass = z.infer<
    typeof PersonSearchEndpointParamsQueryClassSchema
  >

  export const CourseSchema = z.object({
    name: z.string().optional(),
    number: z.string().optional()
  })
  export type Course = z.infer<typeof CourseSchema>

  export const Date0Schema = z.object({
    day: z.number().optional(),
    month: z.number().optional(),
    year: z.number().optional()
  })
  export type Date0 = z.infer<typeof Date0Schema>

  export const PersonExtraSchema = z.object({
    facebook_profile_id: z.string().optional(),
    github_profile_id: z.string().optional(),
    twitter_profile_id: z.string().optional(),
    website: z.string().optional()
  })
  export type PersonExtra = z.infer<typeof PersonExtraSchema>

  export const PeopleAlsoViewedSchema = z.object({
    link: z.string().optional(),
    location: z.string().optional(),
    name: z.string().optional(),
    summary: z.string().optional()
  })
  export type PeopleAlsoViewed = z.infer<typeof PeopleAlsoViewedSchema>

  export const ActivitySchema = z.object({
    activity_status: z.string().optional(),
    link: z.string().optional(),
    title: z.string().optional()
  })
  export type Activity = z.infer<typeof ActivitySchema>

  export const PersonGroupSchema = z.object({
    name: z.string().optional(),
    profile_pic_url: z.string().optional(),
    url: z.string().optional()
  })
  export type PersonGroup = z.infer<typeof PersonGroupSchema>

  export const InferredSalarySchema = z.object({
    max: z.number().optional(),
    min: z.number().optional()
  })
  export type InferredSalary = z.infer<typeof InferredSalarySchema>

  export const AffiliatedCompanySchema = z.object({
    industry: z.string().optional(),
    link: z.string().optional(),
    location: z.string().optional(),
    name: z.string().optional()
  })
  export type AffiliatedCompany = z.infer<typeof AffiliatedCompanySchema>

  export const ExitSchema = z.object({
    crunchbase_profile_url: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    name: z.string().optional()
  })
  export type Exit = z.infer<typeof ExitSchema>

  export const InvestorSchema = z.object({
    linkedin_profile_url: z.string().optional(),
    name: z.string().optional(),
    type: z.string().optional()
  })
  export type Investor = z.infer<typeof InvestorSchema>

  export const CompanyLocationSchema = z.object({
    city: z.string().optional(),
    country: z.string().optional(),
    is_hq: z.boolean().optional(),
    line_1: z.string().optional(),
    postal_code: z.string().optional(),
    state: z.string().optional()
  })
  export type CompanyLocation = z.infer<typeof CompanyLocationSchema>

  export const SimilarCompanySchema = z.object({
    industry: z.string().optional(),
    link: z.string().optional(),
    location: z.string().optional(),
    name: z.string().optional()
  })
  export type SimilarCompany = z.infer<typeof SimilarCompanySchema>

  export const HonourAwardSchema = z.object({
    description: z.string().optional(),
    issued_on: Date0Schema.optional(),
    issuer: z.string().optional(),
    title: z.string().optional()
  })
  export type HonourAward = z.infer<typeof HonourAwardSchema>

  export const AccomplishmentOrgSchema = z.object({
    description: z.string().optional(),
    ends_at: Date0Schema.optional(),
    org_name: z.string().optional(),
    starts_at: Date0Schema.optional(),
    title: z.string().optional()
  })
  export type AccomplishmentOrg = z.infer<typeof AccomplishmentOrgSchema>

  export const PatentSchema = z.object({
    application_number: z.string().optional(),
    description: z.string().optional(),
    issued_on: Date0Schema.optional(),
    issuer: z.string().optional(),
    patent_number: z.string().optional(),
    title: z.string().optional(),
    url: z.string().optional()
  })
  export type Patent = z.infer<typeof PatentSchema>

  export const ProjectSchema = z.object({
    description: z.string().optional(),
    ends_at: Date0Schema.optional(),
    starts_at: Date0Schema.optional(),
    title: z.string().optional(),
    url: z.string().optional()
  })
  export type Project = z.infer<typeof ProjectSchema>

  export const PublicationSchema = z.object({
    description: z.string().optional(),
    name: z.string().optional(),
    published_on: Date0Schema.optional(),
    publisher: z.string().optional(),
    url: z.string().optional()
  })
  export type Publication = z.infer<typeof PublicationSchema>

  export const TestScoreSchema = z.object({
    date_on: Date0Schema.optional(),
    description: z.string().optional(),
    name: z.string().optional(),
    score: z.string().optional()
  })
  export type TestScore = z.infer<typeof TestScoreSchema>

  export const ArticleSchema = z.object({
    author: z.string().optional(),
    image_url: z.string().optional(),
    link: z.string().optional(),
    published_date: Date0Schema.optional(),
    title: z.string().optional()
  })
  export type Article = z.infer<typeof ArticleSchema>

  export const CertificationSchema = z.object({
    authority: z.string().optional(),
    display_source: z.string().optional(),
    ends_at: Date0Schema.optional(),
    license_number: z.string().optional(),
    name: z.string().optional(),
    starts_at: Date0Schema.optional(),
    url: z.string().optional()
  })
  export type Certification = z.infer<typeof CertificationSchema>

  export const EducationSchema = z.object({
    activities_and_societies: z.string().optional(),
    degree_name: z.string().optional(),
    description: z.string().optional(),
    ends_at: Date0Schema.optional(),
    field_of_study: z.string().optional(),
    grade: z.string().optional(),
    logo_url: z.string().optional(),
    school: z.string().optional(),
    school_facebook_profile_url: z.string().optional(),
    school_linkedin_profile_url: z.string().optional(),
    starts_at: Date0Schema.optional()
  })
  export type Education = z.infer<typeof EducationSchema>

  export const ExperienceSchema = z.object({
    company: z.string().optional(),
    company_facebook_profile_url: z.string().optional(),
    company_linkedin_profile_url: z.string().optional(),
    description: z.string().optional(),
    ends_at: Date0Schema.optional(),
    location: z.string().optional(),
    logo_url: z.string().optional(),
    starts_at: Date0Schema.optional(),
    title: z.string().optional()
  })
  export type Experience = z.infer<typeof ExperienceSchema>

  export const VolunteeringExperienceSchema = z.object({
    cause: z.string().optional(),
    company: z.string().optional(),
    company_linkedin_profile_url: z.string().optional(),
    description: z.string().optional(),
    ends_at: Date0Schema.optional(),
    logo_url: z.string().optional(),
    starts_at: Date0Schema.optional(),
    title: z.string().optional()
  })
  export type VolunteeringExperience = z.infer<
    typeof VolunteeringExperienceSchema
  >

  export const AcquiredCompanySchema = z.object({
    announced_date: Date0Schema.optional(),
    crunchbase_profile_url: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    price: z.number().optional()
  })
  export type AcquiredCompany = z.infer<typeof AcquiredCompanySchema>

  export const AcquisitorSchema = z.object({
    announced_date: Date0Schema.optional(),
    crunchbase_profile_url: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    price: z.number().optional()
  })
  export type Acquisitor = z.infer<typeof AcquisitorSchema>

  export const CompanyDetailsSchema = z.object({
    company_type: z.string().optional(),
    contact_email: z.string().optional(),
    crunchbase_profile_url: z.string().optional(),
    crunchbase_rank: z.number().optional(),
    facebook_id: z.string().optional(),
    founding_date: Date0Schema.optional(),
    ipo_date: Date0Schema.optional(),
    ipo_status: z.string().optional(),
    number_of_acquisitions: z.number().optional(),
    number_of_exits: z.number().optional(),
    number_of_funding_rounds: z.number().optional(),
    number_of_investments: z.number().optional(),
    number_of_investors: z.number().optional(),
    number_of_lead_investments: z.number().optional(),
    number_of_lead_investors: z.number().optional(),
    operating_status: z.string().optional(),
    phone_number: z.string().optional(),
    stock_symbol: z.string().optional(),
    total_fund_raised: z.number().optional(),
    total_funding_amount: z.number().optional(),
    twitter_id: z.string().optional()
  })
  export type CompanyDetails = z.infer<typeof CompanyDetailsSchema>

  export const FundingSchema = z.object({
    announced_date: Date0Schema.optional(),
    funding_type: z.string().optional(),
    investor_list: z.array(InvestorSchema).optional(),
    money_raised: z.number().optional(),
    number_of_investor: z.number().optional()
  })
  export type Funding = z.infer<typeof FundingSchema>

  export const CompanyUpdateSchema = z.object({
    article_link: z.string().optional(),
    image: z.string().optional(),
    posted_on: Date0Schema.optional(),
    text: z.string().optional(),
    total_likes: z.number().optional()
  })
  export type CompanyUpdate = z.infer<typeof CompanyUpdateSchema>

  export const PersonLookupUrlEnrichResultProfileSchema = z.object({
    accomplishment_courses: z.array(CourseSchema).optional(),
    accomplishment_honors_awards: z.array(HonourAwardSchema).optional(),
    accomplishment_organisations: z.array(AccomplishmentOrgSchema).optional(),
    accomplishment_patents: z.array(PatentSchema).optional(),
    accomplishment_projects: z.array(ProjectSchema).optional(),
    accomplishment_publications: z.array(PublicationSchema).optional(),
    accomplishment_test_scores: z.array(TestScoreSchema).optional(),
    activities: z.array(ActivitySchema).optional(),
    articles: z.array(ArticleSchema).optional(),
    background_cover_image_url: z.string().optional(),
    birth_date: Date0Schema.optional(),
    certifications: z.array(CertificationSchema).optional(),
    city: z.string().optional(),
    connections: z.number().optional(),
    country: z.string().optional(),
    country_full_name: z.string().optional(),
    education: z.array(EducationSchema).optional(),
    experiences: z.array(ExperienceSchema).optional(),
    extra: PersonExtraSchema.optional(),
    first_name: z.string().optional(),
    follower_count: z.number().optional(),
    full_name: z.string().optional(),
    gender: z.string().optional(),
    groups: z.array(PersonGroupSchema).optional(),
    headline: z.string().optional(),
    industry: z.string().optional(),
    inferred_salary: InferredSalarySchema.optional(),
    interests: z.array(z.string()).optional(),
    languages: z.array(z.string()).optional(),
    last_name: z.string().optional(),
    occupation: z.string().optional(),
    people_also_viewed: z.array(PeopleAlsoViewedSchema).optional(),
    personal_emails: z.array(z.string()).optional(),
    personal_numbers: z.array(z.string()).optional(),
    profile_pic_url: z.string().optional(),
    public_identifier: z.string().optional(),
    recommendations: z.array(z.string()).optional(),
    similarly_named_profiles: z.array(PeopleAlsoViewedSchema).optional(),
    skills: z.array(z.string()).optional(),
    state: z.string().optional(),
    summary: z.string().optional(),
    volunteer_work: z.array(VolunteeringExperienceSchema).optional()
  })
  export type PersonLookupUrlEnrichResultProfile = z.infer<
    typeof PersonLookupUrlEnrichResultProfileSchema
  >

  export const RoleSearchEnrichedResultProfileSchema = z.object({
    accomplishment_courses: z.array(CourseSchema).optional(),
    accomplishment_honors_awards: z.array(HonourAwardSchema).optional(),
    accomplishment_organisations: z.array(AccomplishmentOrgSchema).optional(),
    accomplishment_patents: z.array(PatentSchema).optional(),
    accomplishment_projects: z.array(ProjectSchema).optional(),
    accomplishment_publications: z.array(PublicationSchema).optional(),
    accomplishment_test_scores: z.array(TestScoreSchema).optional(),
    activities: z.array(ActivitySchema).optional(),
    articles: z.array(ArticleSchema).optional(),
    background_cover_image_url: z.string().optional(),
    birth_date: Date0Schema.optional(),
    certifications: z.array(CertificationSchema).optional(),
    city: z.string().optional(),
    connections: z.number().optional(),
    country: z.string().optional(),
    country_full_name: z.string().optional(),
    education: z.array(EducationSchema).optional(),
    experiences: z.array(ExperienceSchema).optional(),
    extra: PersonExtraSchema.optional(),
    first_name: z.string().optional(),
    follower_count: z.number().optional(),
    full_name: z.string().optional(),
    gender: z.string().optional(),
    groups: z.array(PersonGroupSchema).optional(),
    headline: z.string().optional(),
    industry: z.string().optional(),
    inferred_salary: InferredSalarySchema.optional(),
    interests: z.array(z.string()).optional(),
    languages: z.array(z.string()).optional(),
    last_name: z.string().optional(),
    occupation: z.string().optional(),
    people_also_viewed: z.array(PeopleAlsoViewedSchema).optional(),
    personal_emails: z.array(z.string()).optional(),
    personal_numbers: z.array(z.string()).optional(),
    profile_pic_url: z.string().optional(),
    public_identifier: z.string().optional(),
    recommendations: z.array(z.string()).optional(),
    similarly_named_profiles: z.array(PeopleAlsoViewedSchema).optional(),
    skills: z.array(z.string()).optional(),
    state: z.string().optional(),
    summary: z.string().optional(),
    volunteer_work: z.array(VolunteeringExperienceSchema).optional()
  })
  export type RoleSearchEnrichedResultProfile = z.infer<
    typeof RoleSearchEnrichedResultProfileSchema
  >

  export const ReverseEmailUrlEnrichResultProfileSchema = z.object({
    accomplishment_courses: z.array(CourseSchema).optional(),
    accomplishment_honors_awards: z.array(HonourAwardSchema).optional(),
    accomplishment_organisations: z.array(AccomplishmentOrgSchema).optional(),
    accomplishment_patents: z.array(PatentSchema).optional(),
    accomplishment_projects: z.array(ProjectSchema).optional(),
    accomplishment_publications: z.array(PublicationSchema).optional(),
    accomplishment_test_scores: z.array(TestScoreSchema).optional(),
    activities: z.array(ActivitySchema).optional(),
    articles: z.array(ArticleSchema).optional(),
    background_cover_image_url: z.string().optional(),
    birth_date: Date0Schema.optional(),
    certifications: z.array(CertificationSchema).optional(),
    city: z.string().optional(),
    connections: z.number().optional(),
    country: z.string().optional(),
    country_full_name: z.string().optional(),
    education: z.array(EducationSchema).optional(),
    experiences: z.array(ExperienceSchema).optional(),
    extra: PersonExtraSchema.optional(),
    first_name: z.string().optional(),
    follower_count: z.number().optional(),
    full_name: z.string().optional(),
    gender: z.string().optional(),
    groups: z.array(PersonGroupSchema).optional(),
    headline: z.string().optional(),
    industry: z.string().optional(),
    inferred_salary: InferredSalarySchema.optional(),
    interests: z.array(z.string()).optional(),
    languages: z.array(z.string()).optional(),
    last_name: z.string().optional(),
    occupation: z.string().optional(),
    people_also_viewed: z.array(PeopleAlsoViewedSchema).optional(),
    personal_emails: z.array(z.string()).optional(),
    personal_numbers: z.array(z.string()).optional(),
    profile_pic_url: z.string().optional(),
    public_identifier: z.string().optional(),
    recommendations: z.array(z.string()).optional(),
    similarly_named_profiles: z.array(PeopleAlsoViewedSchema).optional(),
    skills: z.array(z.string()).optional(),
    state: z.string().optional(),
    summary: z.string().optional(),
    volunteer_work: z.array(VolunteeringExperienceSchema).optional()
  })
  export type ReverseEmailUrlEnrichResultProfile = z.infer<
    typeof ReverseEmailUrlEnrichResultProfileSchema
  >

  export const PersonProfileSchema = z.object({
    accomplishment_courses: z.array(CourseSchema).optional(),
    accomplishment_honors_awards: z.array(HonourAwardSchema).optional(),
    accomplishment_organisations: z.array(AccomplishmentOrgSchema).optional(),
    accomplishment_patents: z.array(PatentSchema).optional(),
    accomplishment_projects: z.array(ProjectSchema).optional(),
    accomplishment_publications: z.array(PublicationSchema).optional(),
    accomplishment_test_scores: z.array(TestScoreSchema).optional(),
    activities: z.array(ActivitySchema).optional(),
    articles: z.array(ArticleSchema).optional(),
    background_cover_image_url: z.string().optional(),
    birth_date: Date0Schema.optional(),
    certifications: z.array(CertificationSchema).optional(),
    city: z.string().optional(),
    connections: z.number().optional(),
    country: z.string().optional(),
    country_full_name: z.string().optional(),
    education: z.array(EducationSchema).optional(),
    experiences: z.array(ExperienceSchema).optional(),
    first_name: z.string().optional(),
    follower_count: z.number().optional(),
    full_name: z.string().optional(),
    gender: z.string().optional(),
    groups: z.array(PersonGroupSchema).optional(),
    headline: z.string().optional(),
    industry: z.string().optional(),
    inferred_salary: InferredSalarySchema.optional(),
    languages: z.array(z.string()).optional(),
    last_name: z.string().optional(),
    occupation: z.string().optional(),
    people_also_viewed: z.array(PeopleAlsoViewedSchema).optional(),
    personal_emails: z.array(z.string()).optional(),
    personal_numbers: z.array(z.string()).optional(),
    profile_pic_url: z.string().optional(),
    public_identifier: z.string().optional(),
    recommendations: z.array(z.string()).optional(),
    similarly_named_profiles: z.array(PeopleAlsoViewedSchema).optional(),
    skills: z.array(z.string()).optional(),
    state: z.string().optional(),
    summary: z.string().optional(),
    volunteer_work: z.array(VolunteeringExperienceSchema).optional()
  })
  export type PersonProfile = z.infer<typeof PersonProfileSchema>

  export type ResolvedPersonProfile = {
    profile?: PersonProfile
    url?: string
    name_similarity_score?: number
    company_similarity_score?: number
    title_similarity_score?: number
    location_similarity_score?: number
    last_updated?: string
  }

  export const AcquisitionSchema = z.object({
    acquired: z.array(AcquiredCompanySchema).optional(),
    acquired_by: AcquisitorSchema.optional()
  })
  export type Acquisition = z.infer<typeof AcquisitionSchema>

  export const PersonLookupUrlEnrichResultSchema = z.object({
    company_similarity_score: z.number().optional(),
    last_updated: z.string().optional(),
    location_similarity_score: z.number().optional(),
    name_similarity_score: z.number().optional(),
    profile: PersonLookupUrlEnrichResultProfileSchema.optional(),
    title_similarity_score: z.number().optional(),
    url: z.string().optional()
  })
  export type PersonLookupUrlEnrichResult = z.infer<
    typeof PersonLookupUrlEnrichResultSchema
  >

  export const RoleSearchEnrichedResultSchema = z.object({
    last_updated: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    profile: RoleSearchEnrichedResultProfileSchema.optional()
  })
  export type RoleSearchEnrichedResult = z.infer<
    typeof RoleSearchEnrichedResultSchema
  >

  export const ReverseEmailUrlEnrichResultSchema = z.object({
    backwards_compatibility_notes: z.string().optional(),
    facebook_profile_url: z.string().optional(),
    last_updated: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    profile: ReverseEmailUrlEnrichResultProfileSchema.optional(),
    similarity_score: z.number().optional(),
    twitter_profile_url: z.string().optional(),
    url: z.string().optional()
  })
  export type ReverseEmailUrlEnrichResult = z.infer<
    typeof ReverseEmailUrlEnrichResultSchema
  >

  export const SearchResultSchema = z.object({
    last_updated: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    profile: PersonProfileSchema.optional()
  })
  export type SearchResult = z.infer<typeof SearchResultSchema>

  export const ResultProfileSchema = z.object({
    linkedin_url: z.string().optional(),
    acquisitions: AcquisitionSchema.optional(),
    affiliated_companies: z.array(AffiliatedCompanySchema).optional(),
    background_cover_image_url: z.string().optional(),
    categories: z.array(z.string()).optional(),
    company_size: z.array(z.number()).optional(),
    company_size_on_linkedin: z.number().optional(),
    company_type: CompanyTypeSchema.optional(),
    customer_list: z.array(z.string()).optional(),
    description: z.string().optional(),
    exit_data: z.array(ExitSchema).optional(),
    extra: CompanyDetailsSchema.optional(),
    follower_count: z.number().optional(),
    founded_year: z.number().optional(),
    funding_data: z.array(FundingSchema).optional(),
    hq: CompanyLocationSchema.optional(),
    industry: z.string().optional(),
    linkedin_internal_id: z.string().optional(),
    locations: z.array(CompanyLocationSchema).optional(),
    name: z.string().optional(),
    profile_pic_url: z.string().optional(),
    search_id: z.string().optional(),
    similar_companies: z.array(SimilarCompanySchema).optional(),
    specialities: z.array(z.string()).optional(),
    tagline: z.string().optional(),
    universal_name_id: z.string().optional(),
    updates: z.array(CompanyUpdateSchema).optional(),
    website: z.string().optional()
  })
  export type CompanyProfile = z.infer<typeof ResultProfileSchema>
  export type ResolvedCompanyProfile = {
    url: string
    last_updated: string
    profile: CompanyProfile
  }

  export const CompanyUrlEnrichResultProfileSchema = z.object({
    acquisitions: AcquisitionSchema.optional(),
    affiliated_companies: z.array(AffiliatedCompanySchema).optional(),
    background_cover_image_url: z.string().optional(),
    categories: z.array(z.string()).optional(),
    company_size: z.array(z.number()).optional(),
    company_size_on_linkedin: z.number().optional(),
    company_type: CompanyTypeSchema.optional(),
    customer_list: z.array(z.string()).optional(),
    description: z.string().optional(),
    exit_data: z.array(ExitSchema).optional(),
    extra: CompanyDetailsSchema.optional(),
    follower_count: z.number().optional(),
    founded_year: z.number().optional(),
    funding_data: z.array(FundingSchema).optional(),
    hq: CompanyLocationSchema.optional(),
    industry: z.string().optional(),
    linkedin_internal_id: z.string().optional(),
    locations: z.array(CompanyLocationSchema).optional(),
    name: z.string().optional(),
    profile_pic_url: z.string().optional(),
    search_id: z.string().optional(),
    similar_companies: z.array(SimilarCompanySchema).optional(),
    specialities: z.array(z.string()).optional(),
    tagline: z.string().optional(),
    universal_name_id: z.string().optional(),
    updates: z.array(CompanyUpdateSchema).optional(),
    website: z.string().optional()
  })
  export type CompanyUrlEnrichResultProfile = z.infer<
    typeof CompanyUrlEnrichResultProfileSchema
  >

  export const PersonSearchResultSchema = z.object({
    next_page: z.string().optional(),
    results: z.array(SearchResultSchema).optional(),
    total_result_count: z.number().optional()
  })
  export type PersonSearchResult = z.infer<typeof PersonSearchResultSchema>

  export const CSearchResultSchema = z.object({
    last_updated: z.string().optional(),
    linkedin_profile_url: z.string().optional(),
    profile: ResultProfileSchema.optional()
  })
  export type CSearchResult = z.infer<typeof CSearchResultSchema>

  export const CompanyUrlEnrichResultSchema = z.object({
    last_updated: z.string().optional(),
    profile: CompanyUrlEnrichResultProfileSchema.optional(),
    url: z.string().optional()
  })
  export type CompanyUrlEnrichResult = z.infer<
    typeof CompanyUrlEnrichResultSchema
  >

  export const CompanySearchResultSchema = z.object({
    next_page: z.string().optional(),
    results: z.array(CSearchResultSchema).optional(),
    total_result_count: z.number().optional()
  })
  export type CompanySearchResult = z.infer<typeof CompanySearchResultSchema>
}

/**
 * Pull rich data about people and companies.
 *
 * Essentially a wrapper around LinkedIn & Crunchbase.
 *
 * @see https://nubela.co/proxycurl/
 */
export class ProxycurlClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('PROXYCURL_API_KEY'),
    apiBaseUrl = getEnv('PROXYCURL_API_BASE_URL') ??
      'https://nubela.co/proxycurl',
    throttle = true,
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    throttle?: boolean
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'ProxycurlClient missing required "apiKey" (defaults to "PROXYCURL_API_KEY")'
    )
    assert(
      apiBaseUrl,
      'ProxycurlClient missing required "apiBaseUrl" (defaults to "PROXYCURL_API_BASE_URL")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, proxycurl.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  /** Gets the LinkedIn profile for a company given it's domain `url`. */
  @aiFunction({
    name: 'get_linkedin_company',
    description:
      "Gets the LinkedIn profile for a company given it's domain `url`.",
    inputSchema: proxycurl.CompanyProfileEndpointParamsQueryClassSchema
  })
  async getLinkedInCompany(
    opts: proxycurl.CompanyProfileEndpointParamsQueryClass
  ): Promise<proxycurl.CompanyProfile> {
    const res = await this.ky
      .get('api/linkedin/company', {
        searchParams: sanitizeSearchParams({
          funding_data: 'include',
          exit_data: 'include',
          extra_data: 'include',
          ...opts
        })
      })
      .json<proxycurl.CompanyProfile>()

    return {
      linkedin_url: opts.url,
      ...res
    }
  }

  /** Gets the LinkedIn profile for a person given some unique, identifying information about them. */
  @aiFunction({
    name: 'get_linkedin_person',
    description:
      'Gets the LinkedIn profile for a person given some unique, identifying information about them.',
    inputSchema: proxycurl.PersonProfileEndpointParamsQueryClassSchema
  })
  async getLinkedInPerson(
    opts: proxycurl.PersonProfileEndpointParamsQueryClass
  ): Promise<proxycurl.PersonProfile> {
    return this.ky
      .get('api/v2/linkedin', {
        searchParams: sanitizeSearchParams(opts)
      })
      .json<proxycurl.PersonProfile>()
  }

  /** Resolves the LinkedIn profile for a person given their `first_name` and `company_domain` URL. */
  @aiFunction({
    name: 'resolve_linkedin_person',
    description:
      'Resolves the LinkedIn profile for a person given their `first_name` and `company_domain` URL.',
    inputSchema: proxycurl.PersonLookupEndpointParamsQueryClassSchema
  })
  async resolveLinkedInPerson(
    opts: proxycurl.PersonLookupEndpointParamsQueryClass
  ): Promise<proxycurl.ResolvedPersonProfile> {
    return this.ky
      .get('api/linkedin/profile/resolve', {
        searchParams: sanitizeSearchParams({
          similarity_checks: 'include',
          enrich_profile: 'enrich',
          ...opts
        })
      })
      .json<proxycurl.ResolvedPersonProfile>()
  }

  /** Resolves the LinkedIn profile for a person given their `email`. */
  @aiFunction({
    name: 'resolve_linkedin_person_by_email',
    description:
      'Resolves the LinkedIn profile for a person given their `email`.',
    inputSchema: proxycurl.ReverseEmailLookupEndpointParamsQueryClassSchema
  })
  async resolveLinkedInPersonByEmail(
    opts: proxycurl.ReverseEmailLookupEndpointParamsQueryClass
  ) {
    return this.ky
      .get('api/linkedin/profile/resolve/email', {
        searchParams: sanitizeSearchParams({
          enrich_profile: 'enrich',
          ...opts
        })
      })
      .json<proxycurl.ReverseEmailUrlEnrichResult>()
  }

  /** Resolves the LinkedIn profile for a person at a given `company_name` and `role`. */
  @aiFunction({
    name: 'resolve_linkedin_person_at_company_by_role',
    description:
      'Resolves the LinkedIn profile for a person at a given `company_name` and `role`.',
    inputSchema: proxycurl.RoleLookupEndpointParamsQueryClassSchema
  })
  async resolveLinkedInPersonAtCompanyByRole(
    opts: proxycurl.RoleLookupEndpointParamsQueryClass
  ): Promise<proxycurl.ResolvedPersonProfile> {
    return this.ky
      .get('api/find/company/role/', {
        searchParams: sanitizeSearchParams({
          enrich_profile: 'enrich',
          ...opts
        })
      })
      .json<proxycurl.ResolvedPersonProfile>()
  }

  /** Resolves the LinkedIn profile for a company given the `company_name` and/or `company_domain`. */
  @aiFunction({
    name: 'resolve_linkedin_company',
    description:
      'Resolves the LinkedIn profile for a company given the `company_name` and/or `company_domain`.',
    inputSchema: proxycurl.CompanyLookupEndpointParamsQueryClassSchema
  })
  async resolveLinkedInCompany(
    opts: proxycurl.CompanyLookupEndpointParamsQueryClass
  ): Promise<proxycurl.CompanyProfile> {
    const res = await this.ky
      .get('api/linkedin/company/resolve', {
        searchParams: sanitizeSearchParams({
          enrich_profile: 'enrich',
          ...opts
        })
      })
      .json<proxycurl.ResolvedCompanyProfile>()

    return {
      linkedin_url: res.url,
      ...res.profile
    }
  }

  /** Searches LinkedIn company profiles based on a set of criteria such as `name`, `industry`, `region`, `description`, `city`, number of employees, founding date, funding raised, etc. */
  @aiFunction({
    name: 'search_linkedin_companies',
    description:
      'Searches LinkedIn company profiles based on a set of criteria such as `name`, `industry`, `region`, `description`, `city`, number of employees, founding date, funding raised, etc.',
    inputSchema: proxycurl.CompanySearchEndpointParamsQueryClassSchema
  })
  async searchCompanies(opts: proxycurl.CompanySearchEndpointParamsQueryClass) {
    return this.ky
      .get('api/v2/search/company', {
        searchParams: sanitizeSearchParams(opts)
      })
      .json<proxycurl.CompanySearchResult>()
  }

  /** Searches LinkedIn people profiles based on a set of criteria such as `country`, `first_name`, `last_name`, `current_company_name`, `headline`, `industries`, `past_company_name`, `summary`, `city`, `education_school_name`, etc. */
  @aiFunction({
    name: 'search_linkedin_people',
    description:
      'Searches LinkedIn people profiles based on a set of criteria such as `country`, `first_name`, `last_name`, `current_company_name`, `headline`, `industries`, `past_company_name`, `summary`, `city`, `education_school_name`, etc.',
    inputSchema: proxycurl.PersonSearchEndpointParamsQueryClassSchema
  })
  async searchPeople(opts: proxycurl.PersonSearchEndpointParamsQueryClass) {
    return this.ky
      .get('api/v2/search/person/', {
        searchParams: sanitizeSearchParams(opts)
      })
      .json<proxycurl.PersonSearchResult>()
  }
}


================================================
FILE: legacy/packages/proxycurl/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/reddit/package.json
================================================
{
  "name": "@agentic/reddit",
  "version": "7.6.9",
  "description": "Agentic SDK for Reddit.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/reddit"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/reddit/src/index.ts
================================================
export * from './reddit-client'


================================================
FILE: legacy/packages/reddit/src/reddit-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  pick,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace reddit {
  export const BASE_URL = 'https://www.reddit.com'

  export interface Post {
    id: string
    name: string // name is `t3_<id>`
    title: string
    subreddit: string
    selftext?: string
    author: string
    author_fullname: string
    url: string
    permalink: string
    thumbnail?: string
    thumbnail_width?: number
    thumbnail_height?: number
    score: number
    ups: number
    downs: number
    num_comments: number
    created_utc: number
    is_self: boolean
    is_video: boolean
  }

  export interface FullPost {
    id: string
    name: string
    author: string
    title: string
    subreddit: string
    subreddit_name_prefixed: string
    score: number
    approved_at_utc: string | null
    selftext?: string
    author_fullname: string
    is_self: boolean
    saved: boolean
    url: string
    permalink: string
    mod_reason_title: string | null
    gilded: number
    clicked: boolean
    link_flair_richtext: any[]
    hidden: boolean
    pwls: number
    link_flair_css_class: string
    downs: number
    thumbnail_height: any
    top_awarded_type: any
    hide_score: boolean
    quarantine: boolean
    link_flair_text_color: string
    upvote_ratio: number
    author_flair_background_color: any
    subreddit_type: string
    ups: number
    total_awards_received: number
    media_embed?: any
    secure_media_embed?: any
    thumbnail_width: any
    author_flair_template_id: any
    is_original_content: boolean
    user_reports: any[]
    secure_media: any
    is_reddit_media_domain: boolean
    is_meta: boolean
    category: any
    link_flair_text: string
    can_mod_post: boolean
    approved_by: any
    is_created_from_ads_ui: boolean
    author_premium: boolean
    thumbnail?: string
    edited: boolean
    author_flair_css_class: any
    author_flair_richtext: any[]
    gildings?: any
    content_categories: any
    mod_note: any
    created: number
    link_flair_type: string
    wls: number
    removed_by_category: any
    banned_by: any
    author_flair_type: string
    domain: string
    allow_live_comments: boolean
    selftext_html: string
    likes: any
    suggested_sort: any
    banned_at_utc: any
    view_count: any
    archived: boolean
    no_follow: boolean
    is_crosspostable: boolean
    pinned: boolean
    over_18: boolean
    all_awardings: any[]
    awarders: any[]
    media_only: boolean
    link_flair_template_id: string
    can_gild: boolean
    spoiler: boolean
    locked: boolean
    author_flair_text: any
    treatment_tags: any[]
    visited: boolean
    removed_by: any
    num_reports: any
    distinguished: any
    subreddit_id: string
    author_is_blocked: boolean
    mod_reason_by: any
    removal_reason: any
    link_flair_background_color: string
    is_robot_indexable: boolean
    report_reasons: any
    discussion_type: any
    num_comments: number
    send_replies: boolean
    contest_mode: boolean
    mod_reports: any[]
    author_patreon_flair: boolean
    author_flair_text_color: any
    stickied: boolean
    subreddit_subscribers: number
    created_utc: number
    num_crossposts: number
    media?: any
    is_video: boolean

    // preview images
    preview?: {
      enabled: boolean
      images: Array<{
        id: string
        source: Image
        resolutions: Image[]
        variants?: Record<
          string,
          {
            id: string
            source: Image
            resolutions: Image[]
          }
        >
      }>
    }
  }

  export interface Image {
    url: string
    width: number
    height: number
  }

  export interface PostT3 {
    kind: 't3'
    data: FullPost
  }

  export interface PostListingResponse {
    kind: 'Listing'
    data: {
      after: string
      dist: number
      modhash: string
      geo_filter?: null
      children: PostT3[]
    }
    before?: null
  }

  export type PostFilter = 'hot' | 'top' | 'new' | 'rising'

  export type GeoFilter =
    | 'GLOBAL'
    | 'US'
    | 'AR'
    | 'AU'
    | 'BG'
    | 'CA'
    | 'CL'
    | 'CO'
    | 'HR'
    | 'CZ'
    | 'FI'
    | 'FR'
    | 'DE'
    | 'GR'
    | 'HU'
    | 'IS'
    | 'IN'
    | 'IE'
    | 'IT'
    | 'JP'
    | 'MY'
    | 'MX'
    | 'NZ'
    | 'PH'
    | 'PL'
    | 'PT'
    | 'PR'
    | 'RO'
    | 'RS'
    | 'SG'
    | 'ES'
    | 'SE'
    | 'TW'
    | 'TH'
    | 'TR'
    | 'GB'
    | 'US_WA'
    | 'US_DE'
    | 'US_DC'
    | 'US_WI'
    | 'US_WV'
    | 'US_HI'
    | 'US_FL'
    | 'US_WY'
    | 'US_NH'
    | 'US_NJ'
    | 'US_NM'
    | 'US_TX'
    | 'US_LA'
    | 'US_NC'
    | 'US_ND'
    | 'US_NE'
    | 'US_TN'
    | 'US_NY'
    | 'US_PA'
    | 'US_CA'
    | 'US_NV'
    | 'US_VA'
    | 'US_CO'
    | 'US_AK'
    | 'US_AL'
    | 'US_AR'
    | 'US_VT'
    | 'US_IL'
    | 'US_GA'
    | 'US_IN'
    | 'US_IA'
    | 'US_OK'
    | 'US_AZ'
    | 'US_ID'
    | 'US_CT'
    | 'US_ME'
    | 'US_MD'
    | 'US_MA'
    | 'US_OH'
    | 'US_UT'
    | 'US_MO'
    | 'US_MN'
    | 'US_MI'
    | 'US_RI'
    | 'US_KS'
    | 'US_MT'
    | 'US_MS'
    | 'US_SC'
    | 'US_KY'
    | 'US_OR'
    | 'US_SD'

  export type TimePeriod = 'hour' | 'day' | 'week' | 'month' | 'year' | 'all'

  export type GetSubredditPostsOptions = {
    subreddit: string
    type?: PostFilter

    // Pagination size and offset (count)
    limit?: number
    count?: number

    // Pagination by fullnames of posts
    before?: string
    after?: string

    /**
     * Geographical filter. Only applicable to 'hot' posts.
     */
    geo?: GeoFilter

    /**
     * Filter by time period. Only applicable to 'top' posts.
     */
    time?: TimePeriod
  }

  export interface PostListingResult {
    subreddit: string
    type: PostFilter
    geo?: GeoFilter
    time?: TimePeriod
    posts: Post[]
  }
}

/**
 * Basic readonly Reddit API for fetching top/hot/new/rising posts from subreddits.
 *
 * Uses Reddit's legacy JSON API aimed at RSS feeds.
 *
 * @see https://old.reddit.com/dev/api
 */
export class RedditClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly baseUrl: string

  constructor({
    baseUrl = reddit.BASE_URL,
    userAgent = 'agentic-reddit-client/1.0.0',
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    baseUrl?: string
    userAgent?: string
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    super()

    this.baseUrl = baseUrl

    this.ky = ky.extend({
      prefixUrl: this.baseUrl,
      timeout: timeoutMs,
      headers: {
        'User-Agent': userAgent
      }
    })
  }

  /**
   * Fetches posts from a subreddit.
   *
   * @see https://old.reddit.com/dev/api/#GET_hot
   */
  @aiFunction({
    name: 'get_subreddit_posts',
    description: 'Fetches posts from a subreddit.',
    inputSchema: z.object({
      subreddit: z.string().describe('The subreddit to fetch posts from.'),
      type: z
        .union([
          z.literal('hot'),
          z.literal('top'),
          z.literal('new'),
          z.literal('rising')
        ])
        .optional()
        .describe('Type of posts to fetch (defaults to "hot").'),
      limit: z
        .number()
        .int()
        .max(100)
        .optional()
        .describe('Max number of posts to return (defaults to 5).'),
      count: z
        .number()
        .int()
        .optional()
        .describe('Number of posts to offset by (defaults to 0).'),
      time: z
        .union([
          z.literal('hour'),
          z.literal('day'),
          z.literal('week'),
          z.literal('month'),
          z.literal('year'),
          z.literal('all')
        ])
        .optional()
        .describe(
          'Time period to filter posts by (defaults to "all"). Only applicable to "top" posts type.'
        )
    })
  })
  async getSubredditPosts(
    subredditOrOpts: string | reddit.GetSubredditPostsOptions
  ): Promise<reddit.PostListingResult> {
    const params =
      typeof subredditOrOpts === 'string'
        ? { subreddit: subredditOrOpts }
        : subredditOrOpts
    const { subreddit, type = 'hot', limit = 5, geo, time, ...opts } = params

    const res = await this.ky
      .get(`r/${subreddit}/${type}.json`, {
        searchParams: sanitizeSearchParams({
          ...opts,
          limit,
          g: type === 'hot' ? geo : undefined,
          t: type === 'top' ? time : undefined
        })
      })
      .json<reddit.PostListingResponse>()

    return {
      subreddit,
      type,
      geo: type === 'hot' ? geo : undefined,
      time: type === 'top' ? time : undefined,
      posts: res.data.children.map((child) => {
        const post = child.data

        // Trim the post data to only include the bare minimum
        // TODO: add preview images
        // TODO: add video media info
        return {
          ...pick(
            post,
            'id',
            'name',
            'title',
            'subreddit',
            'selftext',
            'author',
            'author_fullname',
            'url',
            'permalink',
            'thumbnail',
            'thumbnail_width',
            'thumbnail_height',
            'score',
            'ups',
            'downs',
            'num_comments',
            'created_utc',
            'is_self',
            'is_video'
          ),
          permalink: `${this.baseUrl}${post.permalink}`,
          thumbnail:
            post.thumbnail !== 'self' &&
            post.thumbnail !== 'default' &&
            post.thumbnail !== 'spoiler' &&
            post.thumbnail !== 'nsfw'
              ? post.thumbnail
              : undefined
        }
      })
    }
  }
}


================================================
FILE: legacy/packages/reddit/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/rocketreach/package.json
================================================
{
  "name": "@agentic/rocketreach",
  "version": "7.6.9",
  "description": "Agentic SDK for RocketReach.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/rocketreach"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/rocketreach/src/index.ts
================================================
export * from './rocketreach-client'


================================================
FILE: legacy/packages/rocketreach/src/rocketreach-client.ts
================================================
import {
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'

export namespace rocketreach {
  export const API_BASE_URL = 'https://api.rocketreach.co'

  // Allow up to 5 requests per second by default.
  export const throttle = pThrottle({
    limit: 5,
    interval: 1000
  })

  export interface EnrichPersonOptions {
    // RocketReach internal person ID returned by searches.
    id?: number

    // Must specify along with current_employer.
    name?: string

    // Must specify along with name.
    current_employer?: string

    // Desired prospect's job title. May improve match rate.
    title?: string

    // LinkedIn URL of prospect to lookup.
    linkedin_url?: string

    // A known email address of the prospect. May improve match rate.
    email?: string

    // An NPI number for a US healthcare professional. Can be used as a unique match criteria.
    npi_number?: number

    // Specify an alternative lookup type to use (if available).
    lookup_type?:
      | 'standard'
      | 'premium'
      | 'premium (feeds disabled)'
      | 'bulk'
      | 'phone'
      | 'enrich'
  }

  export interface Person {
    id: number
    status: string
    name: string
    profile_pic: string
    linkedin_url: string
    links: Record<string, string>
    location: string
    current_title: string
    current_employer: string
    current_employer_id: number
    current_employer_domain: string
    current_employer_website: string
    current_employer_linkedin_url: string
    job_history: JobHistory[]
    education: Education[]
    skills: string[]
    birth_year: number
    region_latitude: number
    region_longitude: number
    city: string
    region: string
    country: string
    country_code: string
    npi_data: NpiData
    recommended_email: string
    recommended_personal_email: string
    recommended_professional_email: string
    current_work_email: string
    current_personal_email: string
    emails: Email[]
    phones: Phone[]
    profile_list: ProfileList
  }

  export interface ProfileList {
    id: number
    name: string
  }

  export interface JobHistory {
    start_date: string
    end_date: string
    company: string
    company_name: string
    company_id: number
    company_linkedin_url: string
    department: string
    title: string
    highest_level: string
    description: string
    last_updated: string
    sub_department: string
    is_current: boolean
  }

  export interface Education {
    major: string
    school: string
    degree: string
    start: number
    end: number
  }

  export interface NpiData {
    npi_number: string
    credentials: string
    license_number: string
    specialization: string
  }

  export interface Email {
    email: string
    smtp_valid: string
    type: string
    last_validation_check: string
    grade: string
  }

  export interface Phone {
    number: string
    type: string
    validity: string
    recommended: boolean
    premium: boolean
    last_checked: string
  }
}

/**
 * RocketReach is a B2B person and company enrichment API.
 *
 * @see https://rocketreach.co/api/v2/docs
 */
export class RocketReachClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('ROCKETREACH_API_KEY'),
    apiBaseUrl = rocketreach.API_BASE_URL,
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      `RocketReachClient missing required "apiKey" (defaults to "ROCKETREACH_API_KEY")`
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, rocketreach.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        'Api-Key': apiKey
      }
    })
  }

  async lookupPerson(opts: rocketreach.EnrichPersonOptions) {
    return this.ky
      .get('api/v2/person/lookup', { searchParams: sanitizeSearchParams(opts) })
      .json<rocketreach.Person>()
  }
}


================================================
FILE: legacy/packages/rocketreach/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/searxng/package.json
================================================
{
  "name": "@agentic/searxng",
  "version": "7.6.9",
  "description": "Agentic SDK for the SearXNG meta search engine.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/searxng"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/searxng/src/index.ts
================================================
export * from './searxng-client'


================================================
FILE: legacy/packages/searxng/src/searxng-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  omit,
  pick,
  pruneUndefined
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace searxng {
  export const SearchCategorySchema = z.enum([
    'general',
    'images',
    'videos',
    'news',
    'map',
    'music',
    'it',
    'science',
    'files',
    'social media'
  ])
  export type SearchCategory = z.infer<typeof SearchCategorySchema>

  export const SearchEngineSchema = z.enum([
    '9gag',
    'annas archive',
    'apk mirror',
    'apple app store',
    'ahmia',
    'anaconda',
    'arch linux wiki',
    'artic',
    'arxiv',
    'ask',
    'bandcamp',
    'wikipedia',
    'bilibili',
    'bing',
    'bing images',
    'bing news',
    'bing videos',
    'bitbucket',
    'bpb',
    'btdigg',
    'ccc-tv',
    'openverse',
    'chefkoch',
    'crossref',
    'crowdview',
    'yep',
    'yep images',
    'yep news',
    'curlie',
    'currency',
    'bahnhof',
    'deezer',
    'destatis',
    'deviantart',
    'ddg definitions',
    'docker hub',
    'erowid',
    'wikidata',
    'duckduckgo',
    'duckduckgo images',
    'duckduckgo videos',
    'duckduckgo news',
    'duckduckgo weather',
    'apple maps',
    'emojipedia',
    'tineye',
    'etymonline',
    '1x',
    'fdroid',
    'flickr',
    'free software directory',
    'frinkiac',
    'fyyd',
    'genius',
    'gentoo',
    'gitlab',
    'github',
    'codeberg',
    'goodreads',
    'google',
    'google images',
    'google news',
    'google videos',
    'google scholar',
    'google play apps',
    'google play movies',
    'material icons',
    'gpodder',
    'habrahabr',
    'hackernews',
    'hoogle',
    'imdb',
    'imgur',
    'ina',
    'invidious',
    'jisho',
    'kickass',
    'lemmy communities',
    'lemmy users',
    'lemmy posts',
    'lemmy comments',
    'library genesis',
    'z-library',
    'library of congress',
    'lingva',
    'lobste.rs',
    'mastodon users',
    'mastodon hashtags',
    'mdn',
    'metacpan',
    'mixcloud',
    'mozhi',
    'mwmbl',
    'npm',
    'nyaa',
    'mankier',
    'odysee',
    'openairedatasets',
    'openairepublications',
    'openstreetmap',
    'openrepos',
    'packagist',
    'pdbe',
    'photon',
    'pinterest',
    'piped',
    'piped.music',
    'piratebay',
    'podcastindex',
    'presearch',
    'presearch images',
    'presearch videos',
    'presearch news',
    'pub.dev',
    'pubmed',
    'pypi',
    'qwant',
    'qwant news',
    'qwant images',
    'qwant videos',
    'radio browser',
    'reddit',
    'rottentomatoes',
    'sepiasearch',
    'soundcloud',
    'stackoverflow',
    'askubuntu',
    'internetarchivescholar',
    'superuser',
    'searchcode code',
    'semantic scholar',
    'startpage',
    'tokyotoshokan',
    'solidtorrents',
    'tagesschau',
    'tmdb',
    'torch',
    'unsplash',
    'yandex music',
    'yahoo',
    'yahoo news',
    'youtube',
    'dailymotion',
    'vimeo',
    'wiby',
    'alexandria',
    'wikibooks',
    'wikinews',
    'wikiquote',
    'wikisource',
    'wikispecies',
    'wiktionary',
    'wikiversity',
    'wikivoyage',
    'wikicommons.images',
    'wolframalpha',
    'dictzone',
    'mymemory translated',
    '1337x',
    'duden',
    'seznam',
    'mojeek',
    'moviepilot',
    'naver',
    'rubygems',
    'peertube',
    'mediathekviewweb',
    'yacy',
    'yacy images',
    'rumble',
    'livespace',
    'wordnik',
    'woxikon.de synonyme',
    'seekr news',
    'seekr images',
    'seekr videos',
    'sjp.pwn',
    'stract',
    'svgrepo',
    'tootfinder',
    'wallhaven',
    'wikimini',
    'wttr.in',
    'yummly',
    'brave',
    'brave.images',
    'brave.videos',
    'brave.news',
    'lib.rs',
    'sourcehut',
    'goo',
    'bt4g',
    'pkg.go.dev'
  ])
  export type SearchEngine = z.infer<typeof SearchEngineSchema>

  export const SearchOptionsSchema = z.object({
    query: z.string().describe('search query'),
    categories: z
      .array(SearchCategorySchema)
      .optional()
      .describe(
        'narrows the search to only use search engines in specific categories'
      ),
    engines: z
      .array(SearchEngineSchema)
      .optional()
      .describe('narrows the search to only use specific search engines'),
    language: z.string().optional(),
    pageno: z.number().int().optional()
  })
  export type SearchOptions = z.infer<typeof SearchOptionsSchema>

  export interface SearchResult {
    title: string
    url: string
    img_src?: string
    thumbnail_src?: string
    thumbnail?: string
    content?: string
    author?: string
    iframe_src?: string
    category?: SearchCategory
    engine?: SearchEngine
    publishedDate?: string
  }

  export interface SearchResponse {
    results: SearchResult[]
    suggestions: string[]
    query: string
  }
}

/**
 * Open source meta search engine capable of searching across many different
 * sources and search engines.
 *
 * The most important search engines are:
 *
 * - "reddit" (Reddit posts)
 * - "google" (Google web search)
 * - "google news" (Google News search)
 * - "brave" (Brave web search)
 * - "arxiv" (academic papers)
 * - "genius" (Genius.com for song lyrics)
 * - "imdb" (movies and TV shows)
 * - "hackernews" (Hacker News)
 * - "wikidata" (Wikidata)
 * - "wolframalpha" (Wolfram Alpha)
 * - "youtube" (YouTube videos)
 * - "github" (GitHub code and repositories)
 *
 * @see https://docs.searxng.org
 *
 * NOTE: You'll need to run a local instance of Searxng to use this client.
 *
 * See [perplexica](https://github.com/ItzCrazyKns/Perplexica/blob/master/docker-compose.yaml) for an example of how to set this up.
 */
export class SearxngClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiBaseUrl: string

  constructor({
    apiBaseUrl = getEnv('SEARXNG_API_BASE_URL'),
    ky = defaultKy
  }: {
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiBaseUrl,
      'SearxngClient missing required "apiBaseUrl" (defaults to "SEARXNG_API_BASE_URL")'
    )
    super()

    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({ prefixUrl: apiBaseUrl })
  }

  /**
   * Searches across multiple search engines using a local instance of Searxng. To search only specific engines, use the `engines` parameter.
   *
   * The most important search engines are:
   *
   * - "reddit" (Reddit posts)
   * - "google" (Google web search)
   * - "google news" (Google News search)
   * - "brave" (Brave web search)
   * - "arxiv" (academic papers)
   * - "genius" (Genius.com for song lyrics)
   * - "imdb" (movies and TV shows)
   * - "hackernews" (Hacker News)
   * - "wikidata" (Wikidata)
   * - "wolframalpha" (Wolfram Alpha)
   * - "youtube" (YouTube videos)
   */
  @aiFunction({
    name: 'searxng',
    description: `Searches across multiple search engines using a local instance of Searxng. To search only specific engines, use the \`engines\` parameter.

The most important search engines are:

- "reddit" (Reddit posts)
- "google" (Google web search)
- "google news" (Google News search)
- "brave" (Brave web search)
- "arxiv" (academic papers)
- "genius" (Genius.com for song lyrics)
- "imdb" (movies and TV shows)
- "hackernews" (Hacker News)
- "wikidata" (Wikidata)
- "wolframalpha" (Wolfram Alpha)
- "youtube" (YouTube videos)
- "github" (GitHub code and repositories)
`,
    inputSchema: searxng.SearchOptionsSchema
  })
  async search({
    query,
    ...opts
  }: searxng.SearchOptions): Promise<searxng.SearchResponse> {
    const res = await this.ky
      .get('search', {
        searchParams: pruneUndefined({
          ...opts,
          q: query,
          categories: opts.categories?.join(','),
          engines: opts.engines?.join(','),
          format: 'json'
        })
      })
      .json<searxng.SearchResponse>()

    res.results = res.results?.map(
      (result: any) =>
        omit(
          result,
          'parsed_url',
          'engines',
          'positions',
          'template'
        ) as searxng.SearchResult
    )

    return pick(res, 'results', 'suggestions', 'query')
  }
}


================================================
FILE: legacy/packages/searxng/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/slack/package.json
================================================
{
  "name": "@agentic/slack",
  "version": "7.6.9",
  "description": "Agentic SDK for Slack.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/slack"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/slack/src/index.ts
================================================
export * from './slack'
export * from './slack-client'


================================================
FILE: legacy/packages/slack/src/slack-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  delay,
  getEnv,
  TimeoutError
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

import { slack } from './slack'

// TODO: need to expose more aiFunctions

/**
 * Minimal Slack API client for sending and receiving Slack messages.
 *
 * @see https://api.slack.com/docs
 */
export class SlackClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly defaultChannel?: string

  constructor({
    apiKey = getEnv('SLACK_API_KEY'),
    apiBaseUrl = slack.API_BASE_URL,
    defaultChannel = getEnv('SLACK_DEFAULT_CHANNEL'),
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    defaultChannel?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'SlackClient missing required "apiKey" (defaults to "SLACK_API_KEY")'
    )

    super()

    this.defaultChannel = defaultChannel

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: `Bearer ${apiKey}`
      }
    })
  }

  /**
   * Sends a message to a channel.
   */
  @aiFunction({
    name: 'slack_send_message',
    description: 'Sends a slack message to a slack channel',
    inputSchema: z.object({
      text: z
        .string()
        .describe('Formatted text of the message to be published.'),
      channel: z
        .string()
        .describe(
          'Channel, private group, or IM channel to send the message to. Can be an encoded ID, or a name.'
        )
    })
  })
  public async sendMessage(options: slack.PostMessageParams) {
    if (!options.channel && !this.defaultChannel) {
      throw new Error('Error no channel specified')
    }

    return this.ky
      .post('chat.postMessage', {
        json: {
          channel: this.defaultChannel,
          ...options
        }
      })
      .json<slack.Message>()
  }

  /**
   * Fetches a conversation's history of messages and events.
   */
  public async fetchConversationHistory(
    options: slack.ConversationHistoryParams
  ) {
    return this.ky
      .get('conversations.history', {
        searchParams: options
      })
      .json<slack.Replies>()
  }

  /**
   * Fetches replies to a message in a channel.
   */
  protected async fetchReplies(options: slack.ConversationRepliesParams) {
    return this.ky
      .get('conversations.replies', {
        searchParams: options
      })
      .json<slack.Replies>()
  }

  /**
   * Returns a list of messages that were sent in a channel after a given
   * timestamp both directly and in threads.
   */
  private async fetchCandidates(channel: string, ts: string) {
    const history = await this.fetchConversationHistory({ channel })
    const directReplies = await this.fetchReplies({ channel, ts })

    let candidates: slack.Message[] = []

    if (directReplies.ok) {
      candidates = candidates.concat(directReplies.messages)
    }

    if (history.ok) {
      candidates = candidates.concat(history.messages)
    }

    // Filter out older messages before the message was sent and drop bot messages:
    candidates = candidates.filter(
      (message) => message.ts > ts && !message.bot_id
    )

    // Sort by timestamp so that the most recent messages come first:
    candidates.sort((a, b) => {
      return Number.parseFloat(b.ts) - Number.parseFloat(a.ts)
    })

    return candidates
  }

  /**
   * Sends a message to a channel and waits for a reply to the message, which
   * is returned if it passes validation.
   */
  public async sendMessageAndWaitForReply({
    text,
    channel = this.defaultChannel,
    timeoutMs = slack.DEFAULT_TIMEOUT_MS,
    intervalMs = slack.DEFAULT_INTERVAL_MS,
    validate = () => true,
    stopSignal
  }: slack.SendAndWaitOptions) {
    if (!channel) {
      throw new Error('SlackClient missing required "channel"')
    }

    let aborted = false
    stopSignal?.addEventListener(
      'abort',
      () => {
        aborted = true
      },
      { once: true }
    )

    const res = await this.sendMessage({ text, channel })

    if (!res.ts) {
      throw new Error('Missing ts in response')
    }

    const start = Date.now()
    let nUserMessages = 0

    do {
      if (aborted) {
        const reason = stopSignal?.reason || 'Aborted waiting for reply'

        if (reason instanceof Error) {
          throw reason
        } else {
          throw new TypeError(reason)
        }
      }

      const candidates = await this.fetchCandidates(channel, res.ts)

      if (candidates.length > 0) {
        const candidate = candidates[0]!

        if (validate(candidate)) {
          return candidate
        }

        if (nUserMessages !== candidates.length) {
          await this.sendMessage({
            text: `Invalid response: ${candidate.text}. Please try again following the instructions.`,
            channel,
            thread_ts: candidate.ts
          })
        }

        nUserMessages = candidates.length
      }

      await delay(intervalMs)
    } while (Date.now() - start < timeoutMs)

    throw new TimeoutError('SlackClient timed out waiting for reply')
  }
}


================================================
FILE: legacy/packages/slack/src/slack.ts
================================================
export namespace slack {
  export const API_BASE_URL = 'https://slack.com/api'

  export const DEFAULT_TIMEOUT_MS = 120_000
  export const DEFAULT_INTERVAL_MS = 5000

  export interface BotProfile {
    id: string
    app_id: string
    name: string
    icons: Record<string, unknown>
    deleted: boolean
    updated: number
    team_id: string
  }

  export interface Replies {
    messages: Message[]
    has_more: boolean
    ok: boolean
    response_metadata: ResponseMetadata
  }

  export interface Message {
    bot_id?: string
    client_msg_id?: string
    type: string
    text: string
    user: string
    ts: string
    app_id?: string
    blocks?: Record<string, unknown>[]
    reply_count?: number
    subscribed?: boolean
    last_read?: string
    unread_count?: number
    team?: string
    thread_ts: string
    parent_user_id?: string
    bot_profile?: BotProfile
  }

  export interface ResponseMetadata {
    next_cursor: string
  }

  export type Attachment = {
    [key: string]: any
  }

  export type Block = {
    [key: string]: any
  }

  /**
   * Parameters for the Slack API's `chat.postMessage` method.
   *
   * @see {@link https://api.slack.com/methods/chat.postMessage}
   */
  export type PostMessageParams = {
    /**
     * The formatted text of the message to be published.
     */
    text: string

    /**
     * Channel, private group, or IM channel to send the message to. Can be an encoded ID, or a name.
     */
    channel?: string

    /**
     * Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
     */
    thread_ts?: string

    /**
     * A JSON-based array of structured attachments, presented as a URL-encoded string.
     */
    attachments?: Attachment[]

    /**
     * A JSON-based array of structured blocks, presented as a URL-encoded string.
     */
    blocks?: Block[]

    /**
     * Emoji to use as the icon for this message. Overrides icon_url.
     */
    icon_emoji?: string

    /**
     * URL to an image to use as the icon for this message.
     */
    icon_url?: string

    /**
     * If set to true, user group handles (to name just one example) will be linked in the message text.
     */
    link_names?: boolean

    /**
     * Change how messages are treated (default: 'none').
     */
    parse?: 'full' | 'none'

    /**
     * Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation.
     */
    reply_broadcast?: boolean

    /**
     * Pass true to enable unfurling of primarily text-based content.
     */
    unfurl_links?: boolean

    /**
     * Pass false to disable unfurling of media content.
     */
    unfurl_media?: boolean

    /**
     * Set your bot's user name.
     */
    username?: string
  }

  /**
   * Parameters for the Slack API's `conversations.history` method.
   *
   * @see {@link https://api.slack.com/methods/conversations.history}
   */
  export type ConversationHistoryParams = {
    /**
     * The conversation ID to fetch history for.
     */
    channel: string

    /**
     * Only messages after this Unix timestamp will be included in results (default: `0`).
     */
    oldest?: string

    /**
     * The cursor value used for pagination of results (default: first page).
     */
    cursor?: string

    /**
     * Only messages before this Unix timestamp will be included in results (default: now).
     */
    latest?: string

    /**
     * The maximum number of items to return (default: `100`).
     */
    limit?: number

    /**
     * Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified (default: `false`).
     */
    inclusive?: boolean

    /**
     * Return all metadata associated with the messages (default: `false`).
     */
    include_all_metadata?: boolean
  }

  /**
   * Parameters for the Slack API's `conversations.replies` method.
   *
   * @see {@link https://api.slack.com/methods/conversations.replies}
   */
  export type ConversationRepliesParams = {
    /**
     * The conversation ID to fetch the thread from.
     */
    channel: string

    /**
     * Unique identifier of either a thread’s parent message or a message in the thread.
     *
     * ### Notes
     *
     * -   ts must be the timestamp of an existing message with 0 or more replies.
     * -   If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.
     */
    ts: string

    /**
     * The cursor value used for pagination of results.
     * Set this to the `next_cursor` attribute returned by a previous request's response_metadata.
     */
    cursor?: string

    /**
     * Only messages before this Unix timestamp will be included in results.
     */
    latest?: string

    /**
     * Only messages after this Unix timestamp will be included in results.
     */
    oddest?: string

    /**
     * The maximum number of items to return.
     * Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
     */
    limit?: number

    /**
     * Include messages with the oldest or latest timestamps in results. Ignored unless either timestamp is specified.
     */
    inclusive?: boolean

    /**
     * Return all metadata associated with this message.
     */
    include_thread_metadata?: boolean
  }

  export type SendAndWaitOptions = {
    /**
     * The text of the message to send.
     */
    text: string

    /**
     * The ID of the channel to send the message to.
     */
    channel?: string

    /**
     * The timeout in milliseconds to wait for a reply before throwing an error.
     */
    timeoutMs?: number

    /**
     * The interval in milliseconds to poll for replies.
     */
    intervalMs?: number

    /**
     * A function to validate the reply message. If the function returns `true`, the reply is considered valid and the function will return the message. If the function returns `false`, the reply is considered invalid and the function will continue to wait for a reply until the timeout is reached.
     */
    validate?: (message: Message) => boolean

    /**
     * A stop signal from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), which can be used to abort retrying. More specifically, when `AbortController.abort(reason)` is called, the function will throw an error with the `reason` argument as the error message.
     */
    stopSignal?: AbortSignal
  }

  export interface ListChannelsArgs {
    limit?: number
    cursor?: string
  }

  export interface PostMessageArgs {
    channel_id: string
    text: string
  }

  export interface ReplyToThreadArgs {
    channel_id: string
    thread_ts: string
    text: string
  }

  export interface AddReactionArgs {
    channel_id: string
    timestamp: string
    reaction: string
  }

  export interface GetChannelHistoryArgs {
    channel_id: string
    limit?: number
  }

  export interface GetThreadRepliesArgs {
    channel_id: string
    thread_ts: string
  }

  export interface GetUsersArgs {
    cursor?: string
    limit?: number
  }

  export interface GetUserProfileArgs {
    user_id: string
  }
}


================================================
FILE: legacy/packages/slack/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/social-data/package.json
================================================
{
  "name": "@agentic/social-data",
  "version": "7.6.9",
  "description": "Agentic SDK for accessing Twitter via Social Data.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/social-data"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/social-data/src/index.ts
================================================
export * from './social-data-client'


================================================
FILE: legacy/packages/social-data/src/social-data-client.ts
================================================
import {
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'

// TODO: need to add `aiFunction` wrappers for each method

export namespace socialdata {
  export const API_BASE_URL = 'https:///api.socialdata.tools'

  // Allow up to 120 requests per minute by default.
  export const throttle = pThrottle({
    limit: 120,
    interval: 60 * 1000
  })

  export type GetTweetByIdOptions = {
    id: string
  }

  export type GetUsersByTweetByIdOptions = {
    tweetId: string
    cursor?: string
  }

  export type SearchTweetOptions = {
    query: string
    cursor?: string
    type?: 'Latest' | 'Top'
  }

  export type SearchUsersOptions = {
    query: string
  }

  export type GetUserByIdOptions = {
    userId: string
  }

  export type GetUserByUsernameOptions = {
    username: string
  }

  export type GetUsersByIdOptions = {
    userId: string
    cursor?: string
  }

  export type UserFollowingOptions = {
    // The numeric ID of the desired follower.
    sourceUserId: string
    // The numeric ID of the desired user being followed.
    targetUserId: string
    // Maximum number of followers for target_user to look through.
    maxCount?: number
  }

  export type GetTweetsByUserIdOptions = {
    userId: string
    cursor?: string
    replies?: boolean
  }

  export type TweetResponse = Tweet | ErrorResponse
  export type UserResponse = User | ErrorResponse

  export type UsersResponse =
    | {
        next_cursor: string
        users: User[]
      }
    | ErrorResponse

  export type TweetsResponse =
    | {
        next_cursor: string
        tweets: Tweet[]
      }
    | ErrorResponse

  export type UserFollowingResponse = UserFollowingStatus | ErrorResponse

  export interface ErrorResponse {
    status: 'error'
    message: string
  }

  export interface Tweet {
    tweet_created_at: string
    id: number
    id_str: string
    text: string | null
    full_text: string
    source: string
    truncated: boolean
    in_reply_to_status_id: number | null
    in_reply_to_status_id_str: string | null
    in_reply_to_user_id: number | null
    in_reply_to_user_id_str: string | null
    in_reply_to_screen_name: string | null
    user: User
    lang: string
    quoted_status_id: number | null
    quoted_status_id_str: string | null
    is_quote_status: boolean
    is_pinned: boolean
    quote_count: number
    reply_count: number
    retweet_count: number
    favorite_count: number
    views_count: number
    bookmark_count: number
    quoted_status: Tweet | null
    retweeted_status: Tweet | null
    entities: Entities
  }

  export interface User {
    id: number
    id_str: string
    name: string
    screen_name: string
    location: string
    url: string | null
    description: string
    protected: boolean
    verified: boolean
    followers_count: number
    friends_count: number
    listed_count: number
    favourites_count: number
    statuses_count: number
    created_at: string
    profile_banner_url: string
    profile_image_url_https: string
    can_dm: boolean
  }

  export interface Entities {
    urls?: any[]
    user_mentions?: any[]
    hashtags?: any[]
    symbols?: any[]
    media?: any[]
    timestamps?: any[]
  }

  export interface UserFollowingStatus {
    status: string
    source_user_id: string
    target_user_id: string
    is_following: boolean
    followers_checked_count: number
  }
}

/**
 * SocialData API is a scalable and reliable API that simplifies the process of
 * fetching data from social media websites. At the moment, we only support X
 * (formerly Twitter), but working on adding more integrations.
 *
 * With SocialData API, you can easily retrieve tweets, user profiles, user
 * followers/following and other information without the need for proxies or
 * parsing Twitter responses. This ensures a seamless and hassle-free
 * integration with your application, saving you valuable time and effort.
 *
 * @see https://socialdata.tools
 */
export class SocialDataClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('SOCIAL_DATA_API_KEY'),
    apiBaseUrl = socialdata.API_BASE_URL,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'SocialDataClient missing required "apiKey" (defaults to "SOCIAL_DATA_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, socialdata.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: this.apiBaseUrl,
      headers: {
        Authorization: `Bearer ${this.apiKey}`
      }
    })
  }

  /**
   * Retrieve tweet details.
   */
  async getTweetById(idOrOpts: string | socialdata.GetTweetByIdOptions) {
    const options = typeof idOrOpts === 'string' ? { id: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get('twitter/statuses/show', {
          searchParams: sanitizeSearchParams(options)
        })
        .json<socialdata.TweetResponse>()
    )
  }

  /**
   * Retrieve all users who liked a tweet.
   */
  async getUsersWhoLikedTweetById(
    idOrOpts: string | socialdata.GetUsersByTweetByIdOptions
  ) {
    const { tweetId, ...params } =
      typeof idOrOpts === 'string' ? { tweetId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get(`twitter/tweets/${tweetId}/liking_users`, {
          searchParams: sanitizeSearchParams(params)
        })
        .json<socialdata.UsersResponse>()
    )
  }

  /**
   * Retrieve all users who retweeted a tweet.
   */
  async getUsersWhoRetweetedTweetById(
    idOrOpts: string | socialdata.GetUsersByTweetByIdOptions
  ) {
    const { tweetId, ...params } =
      typeof idOrOpts === 'string' ? { tweetId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get(`twitter/tweets/${tweetId}/retweeted_by`, {
          searchParams: sanitizeSearchParams(params)
        })
        .json<socialdata.UsersResponse>()
    )
  }

  /**
   * Returns array of tweets provided by Twitter search page. Typically Twitter
   * returns ~20 results per page. You can request additional search results by
   * sending another request to the same endpoint using cursor parameter.
   *
   * Search `type` defaults to `Top`.
   */
  async searchTweets(queryOrOpts: string | socialdata.SearchTweetOptions) {
    const options =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    return this._handleResponse(
      this.ky
        .get('twitter/search', {
          searchParams: sanitizeSearchParams({
            type: 'top',
            ...options
          })
        })
        .json<socialdata.TweetsResponse>()
    )
  }

  /**
   * Retrieve user profile details by user ID.
   */
  async getUserById(idOrOpts: string | socialdata.GetUserByIdOptions) {
    const { userId } =
      typeof idOrOpts === 'string' ? { userId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky.get(`twitter/user/${userId}`).json<socialdata.UserResponse>()
    )
  }

  /**
   * Retrieve user profile details by username.
   */
  async getUserByUsername(
    usernameOrOptions: string | socialdata.GetUserByUsernameOptions
  ) {
    const { username } =
      typeof usernameOrOptions === 'string'
        ? { username: usernameOrOptions }
        : usernameOrOptions

    return this._handleResponse(
      this.ky.get(`twitter/user/${username}`).json<socialdata.UserResponse>()
    )
  }

  /**
   * Returns array of tweets from the user's tweets and replies timeline.
   * Typically Twitter returns ~20 results per page. You can request additional
   * search results by sending another request to the same endpoint using
   * cursor parameter.
   */
  async getTweetsByUserId(
    idOrOpts: string | socialdata.GetTweetsByUserIdOptions
  ) {
    const {
      userId,
      replies = false,
      ...params
    } = typeof idOrOpts === 'string' ? { userId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get(
          `twitter/user/${userId}/${replies ? 'tweets-and-replies' : 'tweets'}`,
          {
            searchParams: sanitizeSearchParams(params)
          }
        )
        .json<socialdata.TweetsResponse>()
    )
  }

  /**
   * Returns array of tweets from the user's likes timeline. Typically Twitter
   * returns ~20 results per page. You can request additional search results
   * by sending another request to the same endpoint using cursor parameter.
   */
  async getTweetsLikedByUserId(
    idOrOpts: string | socialdata.GetTweetsByUserIdOptions
  ) {
    const { userId, ...params } =
      typeof idOrOpts === 'string' ? { userId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get(`twitter/user/${userId}/likes`, {
          searchParams: sanitizeSearchParams(params)
        })
        .json<socialdata.TweetsResponse>()
    )
  }

  /**
   * Retrieve user followers.
   */
  async getFollowersForUserId(
    idOrOpts: string | socialdata.GetUsersByIdOptions
  ) {
    const { userId: user_id, ...params } =
      typeof idOrOpts === 'string' ? { userId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get('twitter/followers/list', {
          searchParams: sanitizeSearchParams({
            user_id,
            ...params
          })
        })
        .json<socialdata.UsersResponse>()
    )
  }

  /**
   * Retrieve user followers.
   */
  async getFollowingForUserId(
    idOrOpts: string | socialdata.GetUsersByIdOptions
  ) {
    const { userId: user_id, ...params } =
      typeof idOrOpts === 'string' ? { userId: idOrOpts } : idOrOpts

    return this._handleResponse(
      this.ky
        .get('twitter/friends/list', {
          searchParams: sanitizeSearchParams({
            user_id,
            ...params
          })
        })
        .json<socialdata.UsersResponse>()
    )
  }

  /**
   * This endpoint provides a convenient way to check if a user is following
   * another user. This will recursively retrieve all recent followers of
   * target user (up to [max_count] total results) and check if the
   * source_user_id is present among the retrieved followers.
   */
  async isUserFollowingUser(opts: socialdata.UserFollowingOptions) {
    const { sourceUserId, targetUserId, ...params } = opts

    return this._handleResponse(
      this.ky
        .get(`twitter/user/${sourceUserId}/following/${targetUserId}`, {
          searchParams: sanitizeSearchParams(params)
        })
        .json<socialdata.UserFollowingResponse>()
    )
  }

  /**
   * Returns a list of users with screenname or full name matching the search query.
   */
  async searchUsersByUsername(
    queryOrOpts: string | socialdata.SearchUsersOptions
  ) {
    const params =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    return this._handleResponse(
      this.ky
        .get('twitter/search-users', {
          searchParams: sanitizeSearchParams(params)
        })
        .json<socialdata.UsersResponse>()
    )
  }

  protected async _handleResponse<T extends object | socialdata.ErrorResponse>(
    resP: Promise<T>
  ): Promise<Exclude<T, socialdata.ErrorResponse>> {
    const res = await resP

    if ((res as socialdata.ErrorResponse).status === 'error') {
      throw new Error((res as socialdata.ErrorResponse).message)
    }

    return res as unknown as Exclude<T, socialdata.ErrorResponse>
  }
}


================================================
FILE: legacy/packages/social-data/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/stdlib/package.json
================================================
{
  "name": "@agentic/stdlib",
  "version": "7.6.9",
  "description": "Standard library of AI functions which work with any LLM and TypeScript AI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/stdlib"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/airtable": "workspace:*",
    "@agentic/apollo": "workspace:*",
    "@agentic/arxiv": "workspace:*",
    "@agentic/bing": "workspace:*",
    "@agentic/brave-search": "workspace:*",
    "@agentic/calculator": "workspace:*",
    "@agentic/clearbit": "workspace:*",
    "@agentic/core": "workspace:*",
    "@agentic/diffbot": "workspace:*",
    "@agentic/duck-duck-go": "workspace:*",
    "@agentic/exa": "workspace:*",
    "@agentic/firecrawl": "workspace:*",
    "@agentic/github": "workspace:*",
    "@agentic/google-custom-search": "workspace:*",
    "@agentic/google-docs": "workspace:*",
    "@agentic/google-drive": "workspace:*",
    "@agentic/gravatar": "workspace:*",
    "@agentic/hacker-news": "workspace:*",
    "@agentic/hunter": "workspace:*",
    "@agentic/jina": "workspace:*",
    "@agentic/leadmagic": "workspace:*",
    "@agentic/midjourney": "workspace:*",
    "@agentic/notion": "workspace:*",
    "@agentic/novu": "workspace:*",
    "@agentic/open-meteo": "workspace:*",
    "@agentic/people-data-labs": "workspace:*",
    "@agentic/perigon": "workspace:*",
    "@agentic/polygon": "workspace:*",
    "@agentic/predict-leads": "workspace:*",
    "@agentic/proxycurl": "workspace:*",
    "@agentic/reddit": "workspace:*",
    "@agentic/rocketreach": "workspace:*",
    "@agentic/searxng": "workspace:*",
    "@agentic/serpapi": "workspace:*",
    "@agentic/serper": "workspace:*",
    "@agentic/slack": "workspace:*",
    "@agentic/social-data": "workspace:*",
    "@agentic/tavily": "workspace:*",
    "@agentic/twilio": "workspace:*",
    "@agentic/twitter": "workspace:*",
    "@agentic/typeform": "workspace:*",
    "@agentic/weather": "workspace:*",
    "@agentic/wikidata": "workspace:*",
    "@agentic/wikipedia": "workspace:*",
    "@agentic/wolfram-alpha": "workspace:*",
    "@agentic/youtube": "workspace:*",
    "@agentic/zoominfo": "workspace:*"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  },
  "keywords": [
    "agentic",
    "ai",
    "sdk",
    "openai",
    "llm",
    "tools",
    "functions",
    "stdlib",
    "standard",
    "library",
    "functions",
    "typescript",
    "agent",
    "agents",
    "ai tools",
    "ai functions",
    "ai function calling",
    "ai tool calling",
    "tool use"
  ]
}


================================================
FILE: legacy/packages/stdlib/src/index.ts
================================================
export * from '@agentic/airtable'
export * from '@agentic/apollo'
export * from '@agentic/arxiv'
export * from '@agentic/bing'
export * from '@agentic/brave-search'
export * from '@agentic/calculator'
export * from '@agentic/clearbit'
export * from '@agentic/diffbot'
export * from '@agentic/duck-duck-go'
export * from '@agentic/exa'
export * from '@agentic/firecrawl'
export * from '@agentic/github'
export * from '@agentic/google-custom-search'
export * from '@agentic/google-docs'
export * from '@agentic/google-drive'
export * from '@agentic/gravatar'
export * from '@agentic/hacker-news'
export * from '@agentic/hunter'
export * from '@agentic/jina'
export * from '@agentic/leadmagic'
export * from '@agentic/midjourney'
export * from '@agentic/notion'
export * from '@agentic/novu'
export * from '@agentic/open-meteo'
export * from '@agentic/people-data-labs'
export * from '@agentic/perigon'
export * from '@agentic/polygon'
export * from '@agentic/predict-leads'
export * from '@agentic/proxycurl'
export * from '@agentic/reddit'
export * from '@agentic/rocketreach'
export * from '@agentic/searxng'
export * from '@agentic/serpapi'
export * from '@agentic/serper'
export * from '@agentic/slack'
export * from '@agentic/social-data'
export * from '@agentic/tavily'
export * from '@agentic/twilio'
export * from '@agentic/twitter'
export * from '@agentic/typeform'
export * from '@agentic/weather'
export * from '@agentic/wikidata'
export * from '@agentic/wikipedia'
export * from '@agentic/wolfram-alpha'
export * from '@agentic/youtube'
export * from '@agentic/zoominfo'


================================================
FILE: legacy/packages/stdlib/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/tavily/package.json
================================================
{
  "name": "@agentic/tavily",
  "version": "7.6.9",
  "description": "Agentic SDK for the Tavily search API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/tavily"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/tavily/src/index.ts
================================================
export * from './tavily-client'


================================================
FILE: legacy/packages/tavily/src/tavily-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  pruneNullOrUndefined,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace tavily {
  export const API_BASE_URL = 'https://api.tavily.com'

  // Allow up to 20 requests per minute by default.
  export const throttle = pThrottle({
    limit: 20,
    interval: 60 * 1000
  })

  export interface SearchOptions {
    /** Search query. (required) */
    query: string

    /**
     * The category of the search.
     * This will determine which of our agents willbe used for the search.
     * Currently, only "general" and "news" are supported.
     * Default is "general".
     */
    topic?: string

    /**
     * The depth of the search. It can be basic or advanced. Default is basic
     * for quick results and advanced for indepth high quality results but
     * longer response time. Advanced calls equals 2 requests.
     */
    search_depth?: 'basic' | 'advanced'

    /** Include a synthesized answer in the search results. Default is `false`. */
    include_answer?: boolean

    /** Include a list of query related images in the response. Default is `false`. */
    include_images?: boolean

    /** Include raw content in the search results. Default is `false`. */
    include_raw_content?: boolean

    /** The number of maximum search results to return. Default is `5`. */
    max_results?: number

    /**
     * A list of domains to specifically include in the search results.
     * Default is `undefined`, which includes all domains.
     */
    include_domains?: string[]

    /**
     * A list of domains to specifically exclude from the search results.
     * Default is `undefined`, which doesn't exclude any domains.
     */
    exclude_domains?: string[]
  }

  export interface SearchResponse {
    /** The search query. */
    query: string

    /** A list of sorted search results ranked by relevancy. */
    results: SearchResult[]

    /** The answer to your search query. */
    answer?: string

    /** A list of query related image urls. */
    images?: string[]

    /** A list of suggested research follow up questions related to original query. */
    follow_up_questions?: string[]

    /** How long it took to generate a response. */
    response_time: string
  }

  export interface SearchResult {
    /** The url of the search result. */
    url: string

    /** The title of the search result page. */
    title: string

    /**
     * The most query related content from the scraped url. We use proprietary
     * AI and algorithms to extract only the most relevant content from each
     * url, to optimize for context quality and size.
     */
    content: string

    /** The parsed and cleaned HTML of the site. For now includes parsed text only. */
    raw_content?: string

    /** The relevance score of the search result. */
    score: string
  }
}

/**
 * Tavily provides a web search API tailored for LLMs.
 *
 * @see https://tavily.com
 */
export class TavilyClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('TAVILY_API_KEY'),
    apiBaseUrl = tavily.API_BASE_URL,
    throttle = true,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'TavilyClient missing required "apiKey" (defaults to "TAVILY_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, tavily.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: this.apiBaseUrl
    })
  }

  /**
   * Searches the web for pages relevant to the given query and summarizes the results.
   */
  @aiFunction({
    name: 'search',
    description:
      'Searches the web to find the most relevant pages for a given query and summarizes the results. Very useful for finding up-to-date news and information about any topic.',
    inputSchema: z.object({
      query: z
        .string()
        .describe('The query to search for. Accepts any Google search query.'),
      search_depth: z
        .enum(['basic', 'advanced'])
        .optional()
        .describe(
          'How deep of a search to perform. Use "basic" for quick results and "advanced" for slower, in-depth results.'
        ),
      include_answer: z
        .boolean()
        .optional()
        .describe(
          'Whether or not to include an answer summary in the results.'
        ),
      include_images: z
        .boolean()
        .optional()
        .describe('Whether or not to include images in the results.'),
      max_results: z
        .number()
        .int()
        .default(5)
        .optional()
        .describe('Max number of search results to return.')
      // include_domains: z
      //   .array(z.string())
      //   .optional()
      //   .describe(
      //     'List of domains to specifically include in the search results.'
      //   ),
      // exclude_domains: z
      //   .array(z.string())
      //   .optional()
      //   .describe(
      //     'List of domains to specifically exclude from the search results.'
      //   )
    })
  })
  async search(queryOrOpts: string | tavily.SearchOptions) {
    const options =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    const res = await this.ky
      .post('search', {
        json: {
          ...options,
          api_key: this.apiKey
        }
      })
      .json<tavily.SearchResponse>()

    return pruneNullOrUndefined({
      ...res,
      results: res.results?.map(pruneNullOrUndefined)
    })
  }
}


================================================
FILE: legacy/packages/tavily/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/twilio/package.json
================================================
{
  "name": "@agentic/twilio",
  "version": "7.6.9",
  "description": "Agentic SDK for Twilio.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/twilio"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/twilio/src/index.ts
================================================
export * from './twilio-client'


================================================
FILE: legacy/packages/twilio/src/twilio-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  delay,
  getEnv,
  TimeoutError
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace twilio {
  export const CONVERSATION_API_BASE_URL = 'https://conversations.twilio.com/v1'

  export const DEFAULT_TIMEOUT_MS = 1_800_000
  export const DEFAULT_INTERVAL_MS = 5000
  export const DEFAULT_BOT_NAME = 'agentic'

  /**
   * Twilio recommends keeping SMS messages to a length of 320 characters or less, so we'll use that as the maximum.
   *
   * @see {@link https://support.twilio.com/hc/en-us/articles/360033806753-Maximum-Message-Length-with-Twilio-Programmable-Messaging}
   */
  export const SMS_LENGTH_SOFT_LIMIT = 320
  export const SMS_LENGTH_HARD_LIMIT = 1600

  export interface Conversation {
    unique_name?: string
    date_updated: Date
    friendly_name: string
    timers: null
    account_sid: string
    url: string
    state: string
    date_created: Date
    messaging_service_sid: string
    sid: string
    attributes: string
    bindings: null
    chat_service_sid: string
    links: ConversationLinks
  }

  export interface ConversationLinks {
    participants: string
    messages: string
    webhooks: string
  }

  export interface ConversationMessage {
    body: string
    index: number
    author: string
    date_updated: Date
    media: null
    participant_sid: string | null
    conversation_sid: string
    account_sid: string
    delivery: null
    url: string
    date_created: Date
    content_sid: string | null
    sid: string
    attributes: string
    links: {
      delivery_receipts: string
    }
  }

  export interface ConversationParticipant {
    last_read_message_index: null
    date_updated: Date
    last_read_timestamp: null
    conversation_sid: string
    account_sid: string
    url: string
    date_created: Date
    role_sid: string
    sid: string
    attributes: string
    identity?: string
    messaging_binding: ConversationMessagingBinding
  }

  export interface ConversationMessagingBinding {
    proxy_address: string
    type: string
    address: string
  }

  export interface ConversationMessages {
    messages: ConversationMessage[]
    meta: {
      page: number
      page_size: number
      first_page_url: string
      previous_page_url: string | null
      url: string
      next_page_url: string | null
      key: string
    }
  }

  /**
   * Participant Conversation Resource.
   *
   * This interface represents a participant in a conversation, along with the conversation details.
   */
  export interface ParticipantConversation {
    /** The unique ID of the Account responsible for this conversation. */
    account_sid: string

    /** The unique ID of the Conversation Service this conversation belongs to. */
    chat_service_sid: string

    /** The unique ID of the Participant. */
    participant_sid: string

    /** The unique string that identifies the conversation participant as Conversation User. */
    participant_user_sid: string

    /**
     * A unique string identifier for the conversation participant as Conversation User.
     * This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate.
     */
    participant_identity: string

    /**
     * Information about how this participant exchanges messages with the conversation.
     * A JSON parameter consisting of type and address fields of the participant.
     */
    participant_messaging_binding: object

    /** The unique ID of the Conversation this Participant belongs to. */
    conversation_sid: string

    /** An application-defined string that uniquely identifies the Conversation resource. */
    conversation_unique_name: string

    /** The human-readable name of this conversation, limited to 256 characters. */
    conversation_friendly_name: string

    /**
     * An optional string metadata field you can use to store any data you wish.
     * The string value must contain structurally valid JSON if specified.
     */
    conversation_attributes: string

    /** The date that this conversation was created, given in ISO 8601 format. */
    conversation_date_created: string

    /** The date that this conversation was last updated, given in ISO 8601 format. */
    conversation_date_updated: string

    /** Identity of the creator of this Conversation. */
    conversation_created_by: string

    /** The current state of this User Conversation. One of inactive, active or closed. */
    conversation_state: 'inactive' | 'active' | 'closed'

    /** Timer date values representing state update for this conversation. */
    conversation_timers: object

    /** Contains absolute URLs to access the participant and conversation of this conversation. */
    links: { participant: string; conversation: string }
  }

  export type SendAndWaitOptions = {
    /**
     * The recipient's phone number in E.164 format (e.g. +14565551234).
     */
    recipientPhoneNumber?: string

    /**
     * The text of the message to send (or an array of strings to send as separate messages).
     */
    text: string | string[]

    /**
     * Friendly name of the conversation.
     */
    name: string

    /**
     * The timeout in milliseconds to wait for a reply before throwing an error.
     */
    timeoutMs?: number

    /**
     * The interval in milliseconds to poll for replies.
     */
    intervalMs?: number

    /**
     * A function to validate the reply message. If the function returns `true`, the reply is considered valid and the function will return the message. If the function returns `false`, the reply is considered invalid and the function will continue to wait for a reply until the timeout is reached.
     */
    validate?: (message: ConversationMessage) => boolean

    /**
     * A stop signal from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController), which can be used to abort retrying. More specifically, when `AbortController.abort(reason)` is called, the function will throw an error with the `reason` argument as the error message.
     */
    stopSignal?: AbortSignal
  }

  /**
   * Chunks a string into an array of chunks.
   *
   * @param text - string to chunk
   * @param maxLength - maximum length of each chunk
   *
   * @returns array of chunks
   */
  export function chunkString(text: string, maxLength: number): string[] {
    const words = text.split(' ')
    const chunks: string[] = []
    let chunk = ''

    for (const word of words) {
      if (word.length > maxLength) {
        // Truncate the word if it's too long and indicate that it was truncated:
        chunks.push(word.slice(0, Math.max(0, maxLength - 3)) + '...')
      } else if ((chunk + ' ' + word).length > maxLength) {
        chunks.push(chunk.trim())
        chunk = word
      } else {
        chunk += (chunk ? ' ' : '') + word
      }
    }

    if (chunk) {
      chunks.push(chunk.trim())
    }

    return chunks
  }

  /**
   * Chunks an array of strings into an array of chunks while preserving
   * existing sections.
   *
   * @param textSections - array of strings to chunk
   * @param maxLength - maximum length of each chunk
   *
   * @returns array of chunks
   */
  export function chunkMultipleStrings(
    textSections: string[],
    maxLength: number
  ): string[] {
    return textSections.flatMap((section) => chunkString(section, maxLength))
  }
}

/**
 * A client for interacting with the Twilio Conversations API to send automated
 * messages and wait for replies.
 *
 * @see {@link https://www.twilio.com/docs/conversations/api}
 */
export class TwilioClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly phoneNumber: string
  protected readonly botName: string
  protected readonly defaultRecipientPhoneNumber?: string

  constructor({
    accountSid = getEnv('TWILIO_ACCOUNT_SID'),
    authToken = getEnv('TWILIO_AUTH_TOKEN'),
    phoneNumber = getEnv('TWILIO_PHONE_NUMBER'),
    defaultRecipientPhoneNumber = getEnv(
      'TWILIO_DEFAULT_RECIPIENT_PHONE_NUMBER'
    ),
    apiBaseUrl = twilio.CONVERSATION_API_BASE_URL,
    botName = twilio.DEFAULT_BOT_NAME,
    ky = defaultKy
  }: {
    accountSid?: string
    authToken?: string
    phoneNumber?: string
    defaultRecipientPhoneNumber?: string
    apiBaseUrl?: string
    botName?: string
    ky?: KyInstance
  } = {}) {
    assert(
      accountSid,
      'TwilioClient missing required "accountSid" (defaults to "TWILIO_ACCOUNT_SID")'
    )
    assert(
      authToken,
      'TwilioClient missing required "authToken" (defaults to "TWILIO_AUTH_TOKEN")'
    )
    assert(
      phoneNumber,
      'TwilioClient missing required "phoneNumber" (defaults to "TWILIO_PHONE_NUMBER")'
    )
    super()

    if (defaultRecipientPhoneNumber) {
      this.defaultRecipientPhoneNumber = defaultRecipientPhoneNumber
    }

    this.botName = botName
    this.phoneNumber = phoneNumber

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization:
          'Basic ' +
          Buffer.from(`${accountSid}:${authToken}`).toString('base64'),
        'Content-Type': 'application/x-www-form-urlencoded'
      }
    })
  }

  /**
   * Deletes a conversation and all its messages.
   */
  async deleteConversation(conversationSid: string) {
    return this.ky.delete(`Conversations/${conversationSid}`)
  }

  /**
   * Removes a participant from a conversation.
   */
  async removeParticipant({
    conversationSid,
    participantSid
  }: {
    conversationSid: string
    participantSid: string
  }) {
    return this.ky.delete(
      `Conversations/${conversationSid}/Participants/${participantSid}`
    )
  }

  /**
   * Fetches all conversations a participant as identified by their phone number is a part of.
   */
  async findParticipantConversations(participantPhoneNumber: string) {
    const encodedPhoneNumber = encodeURIComponent(participantPhoneNumber)
    return this.ky
      .get(`ParticipantConversations?Address=${encodedPhoneNumber}`)
      .json<{ conversations: twilio.ParticipantConversation[] }>()
  }

  /**
   * Creates a new conversation.
   */
  async createConversation(friendlyName: string) {
    const params = new URLSearchParams()
    params.set('FriendlyName', friendlyName)
    return this.ky
      .post('Conversations', {
        body: params
      })
      .json<twilio.Conversation>()
  }

  /**
   * Adds a participant to a conversation.
   */
  async addParticipant({
    conversationSid,
    recipientPhoneNumber
  }: {
    conversationSid: string
    recipientPhoneNumber: string
  }) {
    const params = new URLSearchParams()
    params.set('MessagingBinding.Address', recipientPhoneNumber)
    params.set('MessagingBinding.ProxyAddress', this.phoneNumber)
    return this.ky
      .post(`Conversations/${conversationSid}/Participants`, {
        body: params
      })
      .json<twilio.ConversationParticipant>()
  }

  /**
   * Chunks a long text message into smaller parts and sends them as separate messages.
   */
  async sendTextWithChunking({
    conversationSid,
    text
  }: {
    conversationSid: string
    text: string | string[]
    maxChunkLength?: number
  }) {
    let chunks
    if (Array.isArray(text)) {
      chunks = twilio.chunkMultipleStrings(text, twilio.SMS_LENGTH_SOFT_LIMIT)
    } else {
      chunks = twilio.chunkString(text, twilio.SMS_LENGTH_SOFT_LIMIT)
    }

    const out: twilio.ConversationMessage[] = []
    for (const chunk of chunks) {
      const sent = await this.sendMessage({
        conversationSid,
        text: chunk
      })
      out.push(sent)
    }

    return out
  }

  /**
   * Posts a message to a conversation.
   */
  @aiFunction({
    name: 'twilio_send_message',
    description:
      'Sends an text SMS message via the Twilio Conversation API to a specific conversation.',
    inputSchema: z.object({
      text: z
        .string()
        .describe(
          'Text of the SMS content to sent. Must be brief as SMS has strict character limits.'
        ),
      conversationSid: z
        .string()
        .describe('ID of the Twilio Conversation to the send the emssage to.')
    })
  })
  async sendMessage({
    conversationSid,
    text
  }: {
    conversationSid: string
    text: string
  }) {
    // Truncate the text if it exceeds the hard limit and add an ellipsis:
    if (text.length > twilio.SMS_LENGTH_HARD_LIMIT) {
      text =
        text.slice(0, Math.max(0, twilio.SMS_LENGTH_HARD_LIMIT - 3)) + '...'
    }

    const params = new URLSearchParams()
    params.set('Body', text)
    params.set('Author', this.botName)
    return this.ky
      .post(`Conversations/${conversationSid}/Messages`, {
        body: params
      })
      .json<twilio.ConversationMessage>()
  }

  /**
   * Fetches all messages in a conversation.
   */
  @aiFunction({
    name: 'twilio_get_messages',
    description:
      'Retrieves all SMS messages contained within a specific Twilio Conversation.',
    inputSchema: z.object({
      conversationSid: z
        .string()
        .describe(
          'ID of the Twilio Conversation to the retrieve the messages for.'
        )
    })
  })
  async fetchMessages(
    conversationSidOrOptions: string | { conversationSid: string }
  ) {
    const conversationSid =
      typeof conversationSidOrOptions === 'string'
        ? conversationSidOrOptions
        : conversationSidOrOptions.conversationSid

    return this.ky
      .get(`Conversations/${conversationSid}/Messages`)
      .json<twilio.ConversationMessages>()
  }

  /**
   * Sends a SMS to a recipient and waits for a reply to the message, which is returned if it passes validation.
   */
  public async sendAndWaitForReply({
    text,
    name,
    recipientPhoneNumber = this.defaultRecipientPhoneNumber,
    timeoutMs = twilio.DEFAULT_TIMEOUT_MS,
    intervalMs = twilio.DEFAULT_INTERVAL_MS,
    validate = () => true,
    stopSignal
  }: twilio.SendAndWaitOptions) {
    if (!recipientPhoneNumber) {
      throw new Error(
        'TwilioClient error missing required "recipientPhoneNumber"'
      )
    }

    let aborted = false
    stopSignal?.addEventListener(
      'abort',
      () => {
        aborted = true
      },
      { once: true }
    )

    const { sid: conversationSid } = await this.createConversation(name)

    // Find and remove participant from conversation they are currently in, if any:
    const { conversations } =
      await this.findParticipantConversations(recipientPhoneNumber)

    for (const conversation of conversations) {
      await this.removeParticipant({
        conversationSid: conversation.conversation_sid,
        participantSid: conversation.participant_sid
      })
    }

    const { sid: participantSid } = await this.addParticipant({
      conversationSid,
      recipientPhoneNumber
    })
    await this.sendTextWithChunking({ conversationSid, text })

    const start = Date.now()
    let nUserMessages = 0

    do {
      if (aborted) {
        await this.removeParticipant({ conversationSid, participantSid })
        const reason = stopSignal?.reason || 'Aborted waiting for reply'

        if (reason instanceof Error) {
          throw reason
        } else {
          throw new TypeError(reason)
        }
      }

      const response = await this.fetchMessages(conversationSid)
      const candidates = response.messages.filter(
        (message) => message.author !== this.botName
      )

      if (candidates.length > 0) {
        const candidate = candidates.at(-1)!

        if (candidate && validate(candidate)) {
          await this.removeParticipant({ conversationSid, participantSid })
          return candidate
        }

        if (nUserMessages !== candidates.length) {
          await this.sendMessage({
            text: `Invalid response: ${candidate.body}. Please try again with a valid response format.`,
            conversationSid
          })
        }

        nUserMessages = candidates.length
      }

      await delay(intervalMs)
    } while (Date.now() - start < timeoutMs)

    await this.removeParticipant({ conversationSid, participantSid })
    throw new TimeoutError('Twilio timeout waiting for reply')
  }
}


================================================
FILE: legacy/packages/twilio/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/twitter/package.json
================================================
{
  "name": "@agentic/twitter",
  "version": "7.6.9",
  "description": "Agentic SDK for Twitter.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/twitter"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@nangohq/node": "catalog:",
    "ky": "catalog:",
    "p-throttle": "catalog:",
    "twitter-api-sdk": "catalog:",
    "type-fest": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/twitter/src/client.ts
================================================
import { assert, getEnv } from '@agentic/core'
import { auth, Client as TwitterV2Client } from 'twitter-api-sdk'

import { getNango, validateNangoConnectionOAuthScopes } from './nango'

// Auth new Nango accounts here: https://app.nango.dev/connections

// The Twitter OAuth2User class requires a client id, which we don't have
// since we're using Nango for auth, so instead we just pass a dummy value
// and allow Nango to handle all auth/refresh/access token management.
const dummyTwitterClientId = 'agentic'

export const defaultTwitterOAuthScopes = [
  'tweet.read',
  'users.read',
  'offline.access',
  'tweet.write'
]

async function createTwitterAuth({
  scopes,
  nangoConnectionId,
  nangoCallbackUrl,
  nangoProviderConfigKey
}: {
  scopes: string[]
  nangoConnectionId: string
  nangoCallbackUrl: string
  nangoProviderConfigKey: string
}): Promise<auth.OAuth2User> {
  const nango = getNango()
  const connection = await nango.getConnection(
    nangoProviderConfigKey,
    nangoConnectionId
  )

  validateNangoConnectionOAuthScopes({
    connection,
    scopes
  })

  const token = connection.credentials.raw
  assert(token)

  return new auth.OAuth2User({
    client_id: dummyTwitterClientId,
    callback: nangoCallbackUrl,
    scopes: scopes as any[],
    token
  })
}

export async function createTwitterV2Client({
  scopes = defaultTwitterOAuthScopes,
  nangoConnectionId = getEnv('NANGO_CONNECTION_ID'),
  nangoCallbackUrl = getEnv('NANGO_CALLBACK_URL') ??
    'https://api.nango.dev/oauth/callback',
  nangoProviderConfigKey = 'twitter-v2'
}: {
  scopes?: string[]
  nangoConnectionId?: string
  nangoCallbackUrl?: string
  nangoProviderConfigKey?: string
} = {}): Promise<TwitterV2Client> {
  assert(nangoConnectionId, 'twitter client missing nangoConnectionId')
  assert(nangoCallbackUrl, 'twitter client missing nangoCallbackUrl')

  // NOTE: Nango handles refreshing the oauth access token for us
  const twitterAuth = await createTwitterAuth({
    scopes,
    nangoConnectionId,
    nangoCallbackUrl,
    nangoProviderConfigKey
  })

  // Twitter API v2 using OAuth 2.0
  return new TwitterV2Client(twitterAuth)
}


================================================
FILE: legacy/packages/twitter/src/error.ts
================================================
export type TwitterErrorType =
  | 'twitter:forbidden'
  | 'twitter:auth'
  | 'twitter:rate-limit'
  | 'twitter:unknown'
  | 'network'

export class TwitterError extends Error {
  type: TwitterErrorType
  isFinal: boolean
  status?: number

  constructor(
    message: string,
    {
      type,
      isFinal = false,
      status,
      ...opts
    }: ErrorOptions & {
      type: TwitterErrorType
      isFinal?: boolean
      status?: number
    }
  ) {
    super(message, opts)

    this.type = type
    this.isFinal = isFinal
    this.status = status ?? (opts.cause as any)?.status
  }
}


================================================
FILE: legacy/packages/twitter/src/index.ts
================================================
export * from './client'
export * from './error'
export * from './nango'
export * from './twitter-client'
export type * from './types'
export * from './utils'


================================================
FILE: legacy/packages/twitter/src/nango.ts
================================================
import { getEnv } from '@agentic/core'
import { type Connection, Nango } from '@nangohq/node'

// This is intentionally left as a global singleton to avoid re-creating the
// Nango connection instance on successive calls in serverless environments.
let _nango: Nango | null = null

export function getNango(): Nango {
  if (!_nango) {
    const secretKey = getEnv('NANGO_SECRET_KEY')?.trim()
    if (!secretKey) {
      throw new Error(`Missing required "NANGO_SECRET_KEY"`)
    }

    _nango = new Nango({ secretKey })
  }

  return _nango
}

export function validateNangoConnectionOAuthScopes({
  connection,
  scopes
}: {
  connection: Connection
  scopes: string[]
}) {
  const connectionScopes = new Set<string>(
    (connection.credentials as any).raw.scope.split(' ')
  )
  const missingScopes = new Set<string>()

  for (const scope of scopes) {
    if (!connectionScopes.has(scope)) {
      missingScopes.add(scope)
    }
  }

  if (missingScopes.size > 0) {
    throw new Error(
      `Nango connection ${connection.id} is missing required OAuth scopes: ${[
        ...missingScopes.values()
      ].join(', ')}`
    )
  }
}


================================================
FILE: legacy/packages/twitter/src/twitter-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import pThrottle from 'p-throttle'
import { z } from 'zod'

import type * as types from './types'
import { handleTwitterError } from './utils'

/**
 * This file contains rate-limited wrappers around all of the core Twitter API
 * methods that this project uses.
 *
 * NOTE: Twitter has different API rate limits and quotas per plan, so in order
 * to rate-limit effectively, our throttles need to either use the lowest common
 * denominator OR vary based on the twitter developer plan you're using. We
 * chose to go with the latter.
 *
 * @see https://docs.x.com/x-api/fundamentals/rate-limits
 */

type TwitterApiMethod =
  | 'createTweet'
  | 'getTweetById'
  | 'getTweetsById'
  | 'searchRecentTweets'
  | 'listTweetMentionsByUserId'
  | 'listTweetsLikedByUserId'
  | 'listTweetsByUserId'
  | 'getUserById'
  | 'getUserByUsername'

const TWENTY_FOUR_HOURS_MS = 24 * 60 * 60 * 1000
const FIFTEEN_MINUTES_MS = 15 * 60 * 1000

const twitterApiRateLimitsByPlan: Record<
  types.TwitterApiPlan,
  Record<
    TwitterApiMethod,
    {
      readonly limit: number
      readonly interval: number
    }
  >
> = {
  free: {
    // 50 per 24h per user
    // 50 per 24h per app
    createTweet: { limit: 50, interval: TWENTY_FOUR_HOURS_MS },

    getTweetById: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    getTweetsById: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    searchRecentTweets: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    listTweetMentionsByUserId: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    listTweetsLikedByUserId: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    listTweetsByUserId: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    getUserById: { limit: 1, interval: FIFTEEN_MINUTES_MS },
    getUserByUsername: { limit: 1, interval: FIFTEEN_MINUTES_MS }
  },

  basic: {
    // 100 per 24h per user
    // 1667 per 24h per app
    createTweet: { limit: 100, interval: TWENTY_FOUR_HOURS_MS },

    // 15 per 15m per user
    // 15 per 15m per app
    getTweetById: { limit: 15, interval: FIFTEEN_MINUTES_MS },
    getTweetsById: { limit: 15, interval: FIFTEEN_MINUTES_MS },

    // 60 per 15m per user
    // 60 per 15m per app
    searchRecentTweets: { limit: 60, interval: FIFTEEN_MINUTES_MS },

    // 10 per 15m per user
    // 10 per 15m per app
    listTweetMentionsByUserId: { limit: 180, interval: FIFTEEN_MINUTES_MS },

    // 5 per 15min per user
    // 5 per 15min per app
    listTweetsLikedByUserId: { limit: 5, interval: FIFTEEN_MINUTES_MS },

    // 5 per 15min per user
    // 10 per 15min per app
    listTweetsByUserId: { limit: 5, interval: FIFTEEN_MINUTES_MS },

    // 100 per 24h per user
    // 500 per 24h per app
    getUserById: { limit: 100, interval: TWENTY_FOUR_HOURS_MS },
    getUserByUsername: { limit: 100, interval: TWENTY_FOUR_HOURS_MS }
  },

  pro: {
    // 100 per 15m per user
    // 10k per 24h per app
    createTweet: { limit: 100, interval: FIFTEEN_MINUTES_MS },

    // TODO: why would the per-user rate-limit be more than the per-app one?!
    // 900 per 15m per user
    // 450 per 15m per app
    getTweetById: { limit: 450, interval: FIFTEEN_MINUTES_MS },
    getTweetsById: { limit: 450, interval: FIFTEEN_MINUTES_MS },

    // 300 per 15m per user
    // 450 per 15m per app
    searchRecentTweets: { limit: 300, interval: FIFTEEN_MINUTES_MS },

    // 300 per 15m per user
    // 450 per 15m per app
    listTweetMentionsByUserId: { limit: 300, interval: FIFTEEN_MINUTES_MS },

    // 75 per 15min per user
    // 75 per 15min per app
    listTweetsLikedByUserId: { limit: 75, interval: FIFTEEN_MINUTES_MS },

    // 900 per 15min per user
    // 1500 per 15min per app
    listTweetsByUserId: { limit: 900, interval: FIFTEEN_MINUTES_MS },

    // 900 per 15m per user
    // 300 per 15m per app
    getUserById: { limit: 300, interval: FIFTEEN_MINUTES_MS },
    getUserByUsername: { limit: 300, interval: FIFTEEN_MINUTES_MS }
  },

  enterprise: {
    // NOTE: these are just placeholders; the enterprise plan seems to be
    // completely customizable, but it's still useful to define rate limits
    // for robustness. These values just 10x those of the pro plan.
    createTweet: { limit: 1000, interval: FIFTEEN_MINUTES_MS },

    getTweetById: { limit: 4500, interval: FIFTEEN_MINUTES_MS },
    getTweetsById: { limit: 4500, interval: FIFTEEN_MINUTES_MS },

    searchRecentTweets: { limit: 3000, interval: FIFTEEN_MINUTES_MS },
    listTweetMentionsByUserId: { limit: 3000, interval: FIFTEEN_MINUTES_MS },
    listTweetsLikedByUserId: { limit: 750, interval: FIFTEEN_MINUTES_MS },
    listTweetsByUserId: { limit: 9000, interval: FIFTEEN_MINUTES_MS },

    getUserById: { limit: 3000, interval: FIFTEEN_MINUTES_MS },
    getUserByUsername: { limit: 3000, interval: FIFTEEN_MINUTES_MS }
  }
}

/**
 * Twitter/X API v2 client wrapper with rate-limited methods and `@aiFunction`
 * compatibility.
 *
 * Rate limits differ by plan, so make sure the `twitterApiPlan` parameter is
 * properly set to maximize your rate-limit usage.
 *
 * @note This class does not handle distributed rate-limits. It assumes a
 * single, local client is accessing the API at a time, which is a better fit
 * for serverful environments.
 *
 * @see https://docs.x.com/x-api/fundamentals/rate-limits
 * @see https://docs.x.com/x-api
 */
export class TwitterClient extends AIFunctionsProvider {
  readonly client: types.TwitterV2Client
  readonly twitterApiPlan: types.TwitterApiPlan

  constructor({
    client,
    twitterApiPlan = (getEnv('TWITTER_API_PLAN') as types.TwitterApiPlan) ??
      'free'
  }: {
    client: types.TwitterV2Client
    twitterApiPlan?: types.TwitterApiPlan
  }) {
    assert(
      client,
      'TwitterClient missing required "client" which should be an instance of "twitter-api-sdk" (use `getTwitterV2Client` to initialize the underlying V2 Twitter SDK using Nango OAuth)'
    )
    assert(twitterApiPlan, 'TwitterClient missing required "twitterApiPlan"')

    super()

    this.client = client
    this.twitterApiPlan = twitterApiPlan

    const twitterApiRateLimits = twitterApiRateLimitsByPlan[twitterApiPlan]!
    assert(twitterApiRateLimits, `Invalid twitter api plan: ${twitterApiPlan}`)

    const createTweetThrottle = pThrottle(twitterApiRateLimits.createTweet)
    const getTweetByIdThrottle = pThrottle(twitterApiRateLimits.getTweetById)
    const getTweetsByIdThrottle = pThrottle(twitterApiRateLimits.getTweetsById)
    const searchRecentTweetsThrottle = pThrottle(
      twitterApiRateLimits.searchRecentTweets
    )
    const listTweetMentionsByUserIdThrottle = pThrottle(
      twitterApiRateLimits.listTweetMentionsByUserId
    )
    const listTweetsLikedByUserIdThrottle = pThrottle(
      twitterApiRateLimits.listTweetsLikedByUserId
    )
    const listTweetsByUserIdThrottle = pThrottle(
      twitterApiRateLimits.listTweetsByUserId
    )
    const getUserByIdThrottle = pThrottle(twitterApiRateLimits.getUserById)
    const getUserByUsernameThrottle = pThrottle(
      twitterApiRateLimits.getUserByUsername
    )

    this._createTweet = createTweetThrottle(createTweetImpl(this.client))
    this._getTweetById = getTweetByIdThrottle(getTweetByIdImpl(this.client))
    this._getTweetsById = getTweetsByIdThrottle(getTweetsByIdImpl(this.client))
    this._searchRecentTweets = searchRecentTweetsThrottle(
      searchRecentTweetsImpl(this.client)
    )
    this._listTweetMentionsByUserId = listTweetMentionsByUserIdThrottle(
      listTweetMentionsByUserIdImpl(this.client)
    )
    this._listTweetsLikedByUserId = listTweetsLikedByUserIdThrottle(
      listTweetsLikedByUserIdImpl(this.client)
    )
    this._listTweetsByUserId = listTweetsByUserIdThrottle(
      listTweetsByUserIdImpl(this.client)
    )
    this._getUserById = getUserByIdThrottle(getUserByIdImpl(this.client))
    this._getUserByUsername = getUserByUsernameThrottle(
      getUserByUsernameImpl(this.client)
    )
  }

  protected _createTweet: ReturnType<typeof createTweetImpl>
  protected _getTweetById: ReturnType<typeof getTweetByIdImpl>
  protected _getTweetsById: ReturnType<typeof getTweetsByIdImpl>
  protected _searchRecentTweets: ReturnType<typeof searchRecentTweetsImpl>
  protected _listTweetMentionsByUserId: ReturnType<
    typeof listTweetMentionsByUserIdImpl
  >
  protected _listTweetsLikedByUserId: ReturnType<
    typeof listTweetsLikedByUserIdImpl
  >
  protected _listTweetsByUserId: ReturnType<typeof listTweetsByUserIdImpl>
  protected _getUserById: ReturnType<typeof getUserByIdImpl>
  protected _getUserByUsername: ReturnType<typeof getUserByUsernameImpl>

  /**
   * Creates a new tweet
   */
  @aiFunction({
    name: 'create_tweet',
    description: 'Creates a new tweet',
    inputSchema: z.object({
      text: z.string().nonempty()
    })
  })
  async createTweet(
    params: types.CreateTweetParams
  ): Promise<types.CreatedTweet> {
    return this._createTweet(params)
  }

  /**
   * Fetch a tweet by its ID
   */
  @aiFunction({
    name: 'get_tweet_by_id',
    description: 'Fetch a tweet by its ID',
    inputSchema: z.object({
      id: z.string().nonempty()
    })
  })
  async getTweetById(params: { id: string } & types.GetTweetByIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.getTweetById is not supported on free plan'
    )

    return this._getTweetById(params.id, params)
  }

  /**
   * Fetch an array of tweets by their IDs
   */
  @aiFunction({
    name: 'get_tweets_by_id',
    description: 'Fetch an array of tweets by their IDs',
    inputSchema: z.object({
      ids: z.array(z.string().nonempty())
    })
  })
  async getTweetsById({ ids, ...params }: types.GetTweetsByIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.getTweetsById is not supported on free plan'
    )

    return this._getTweetsById(ids, params)
  }

  /**
   * Searches for recent tweets
   */
  @aiFunction({
    name: 'search_recent_tweets',
    description: 'Searches for recent tweets',
    inputSchema: z.object({
      query: z.string().nonempty(),
      sort_order: z
        .enum(['recency', 'relevancy'])
        .default('relevancy')
        .optional(),
      max_results: z.number().min(10).max(100).optional(),
      pagination_token: z.string().optional()
    })
  })
  async searchRecentTweets(params: types.SearchRecentTweetsParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.searchRecentTweets is not supported on free plan'
    )

    return this._searchRecentTweets(params)
  }

  /**
   * Lists tweets which mention the given user.
   */
  @aiFunction({
    name: 'list_tweet_mentions_by_user_id',
    description: 'Lists tweets which mention the given user.',
    inputSchema: z.object({
      userId: z.string().nonempty(),
      max_results: z.number().min(5).max(100).optional(),
      pagination_token: z.string().optional()
    })
  })
  async listTweetMentionsByUserId({
    userId,
    ...params
  }: { userId: string } & types.ListTweetMentionsByUserIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.listTweetMentionsByUserId is not supported on free plan'
    )

    return this._listTweetMentionsByUserId(userId, params)
  }

  /**
   * Lists tweets liked by a user.
   */
  @aiFunction({
    name: 'list_tweets_liked_by_user_id',
    description: 'Lists tweets liked by a user.',
    inputSchema: z.object({
      userId: z.string().nonempty(),
      max_results: z.number().min(5).max(100).optional(),
      pagination_token: z.string().optional()
    })
  })
  async listTweetsLikedByUserId({
    userId,
    ...params
  }: { userId: string } & types.ListTweetsLikedByUserIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.listTweetsLikedByUserId is not supported on free plan'
    )

    return this._listTweetsLikedByUserId(userId, params)
  }

  /**
   * Lists tweets authored by a user.
   */
  @aiFunction({
    name: 'list_tweets_by_user_id',
    description: 'Lists tweets authored by a user.',
    inputSchema: z.object({
      userId: z.string().nonempty(),
      max_results: z.number().min(5).max(100).optional(),
      pagination_token: z.string().optional(),
      exclude: z
        .array(z.union([z.literal('replies'), z.literal('retweets')]))
        .optional()
        .describe(
          'By default, replies and retweets are included. Use this parameter if you want to exclude either or both of them.'
        )
    })
  })
  async listTweetsByUserId({
    userId,
    ...params
  }: { userId: string } & types.ListTweetsByUserIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.listTweetsByUserId is not supported on free plan'
    )

    return this._listTweetsByUserId(userId, params)
  }

  /**
   * Fetch a twitter user by ID
   */
  @aiFunction({
    name: 'get_twitter_user_by_id',
    description: 'Fetch a twitter user by ID',
    inputSchema: z.object({
      id: z.string().min(1)
    })
  })
  async getUserById({
    id,
    ...params
  }: { id: string } & types.GetUserByIdParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.getUserById not supported on free plan'
    )

    return this._getUserById(id, params)
  }

  /**
   * Fetch a twitter user by username
   */
  @aiFunction({
    name: 'get_twitter_user_by_username',
    description: 'Fetch a twitter user by username',
    inputSchema: z.object({
      username: z.string().min(1)
    })
  })
  async getUserByUsername({
    username,
    ...params
  }: { username: string } & types.GetUserByUsernameParams) {
    assert(
      this.twitterApiPlan !== 'free',
      'TwitterClient.getUserByUsername not supported on free plan'
    )

    return this._getUserByUsername(username, params)
  }
}

const defaultTwitterQueryTweetFields: types.TwitterQueryTweetFields = [
  'attachments',
  'author_id',
  'conversation_id',
  'created_at',
  'entities',
  'geo',
  'id',
  'in_reply_to_user_id',
  'lang',
  'public_metrics',
  'possibly_sensitive',
  'referenced_tweets',
  'text'
  // 'context_annotations', // not needed (way too verbose and noisy)
  // 'edit_controls', / not needed
  // 'non_public_metrics', // don't have access to
  // 'organic_metrics', // don't have access to
  // 'promoted_metrics, // don't have access to
  // 'reply_settings', / not needed
  // 'source', // not needed
  // 'withheld' // not needed
]

const defaultTwitterQueryUserFields: types.TwitterQueryUserFields = [
  'created_at',
  'description',
  'entities',
  'id',
  'location',
  'name',
  'pinned_tweet_id',
  'profile_image_url',
  'protected',
  'public_metrics',
  'url',
  'username',
  'verified'
  // 'most_recent_tweet_id',
  // 'verified_type',
  // 'withheld'
]

const defaultTweetQueryParams: types.TweetsQueryOptions = {
  // https://developer.twitter.com/en/docs/twitter-api/expansions
  expansions: [
    'author_id',
    'in_reply_to_user_id',
    'referenced_tweets.id',
    'referenced_tweets.id.author_id',
    'entities.mentions.username',
    // TODO
    'attachments.media_keys',
    'geo.place_id',
    'attachments.poll_ids'
  ],
  'tweet.fields': defaultTwitterQueryTweetFields,
  'user.fields': defaultTwitterQueryUserFields
}

const defaultUserQueryParams: types.TwitterUserQueryOptions = {
  // https://developer.twitter.com/en/docs/twitter-api/expansions
  expansions: ['pinned_tweet_id'],
  'tweet.fields': defaultTwitterQueryTweetFields,
  'user.fields': defaultTwitterQueryUserFields
}

function createTweetImpl(client: types.TwitterV2Client) {
  return async (
    params: types.CreateTweetParams
  ): Promise<types.CreatedTweet> => {
    try {
      const { data: tweet } = await client.tweets.createTweet(params)

      if (!tweet?.id) {
        throw new Error('invalid createTweet response')
      }

      return tweet
    } catch (err: any) {
      console.error('error creating tweet', JSON.stringify(err, null, 2))

      handleTwitterError(err, { label: 'error creating tweet' })
    }
  }
}

function getTweetByIdImpl(client: types.TwitterV2Client) {
  return async (tweetId: string, params?: types.GetTweetByIdParams) => {
    try {
      return await client.tweets.findTweetById(tweetId, {
        ...defaultTweetQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, { label: `error fetching tweet ${tweetId}` })
    }
  }
}

function getTweetsByIdImpl(client: types.TwitterV2Client) {
  return async (
    ids: string[],
    params?: Omit<types.GetTweetsByIdParams, 'ids'>
  ) => {
    try {
      return await client.tweets.findTweetsById({
        ...defaultTweetQueryParams,
        ...params,
        ids
      })
    } catch (err: any) {
      handleTwitterError(err, { label: `error fetching ${ids.length} tweets` })
    }
  }
}

function searchRecentTweetsImpl(client: types.TwitterV2Client) {
  return async (params: types.SearchRecentTweetsParams) => {
    try {
      return await client.tweets.tweetsRecentSearch({
        ...defaultTweetQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error searching tweets query "${params.query}"`
      })
    }
  }
}

function getUserByIdImpl(client: types.TwitterV2Client) {
  return async (userId: string, params?: types.GetUserByIdParams) => {
    try {
      return await client.users.findUserById(userId, {
        ...defaultUserQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error fetching user ${userId}`
      })
    }
  }
}

function getUserByUsernameImpl(client: types.TwitterV2Client) {
  return async (username: string, params?: types.GetUserByUsernameParams) => {
    try {
      return await client.users.findUserByUsername(username, {
        ...defaultUserQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error fetching user with username ${username}`
      })
    }
  }
}

function listTweetMentionsByUserIdImpl(client: types.TwitterV2Client) {
  return async (
    userId: string,
    params?: types.ListTweetMentionsByUserIdParams
  ) => {
    try {
      return await client.tweets.usersIdMentions(userId, {
        ...defaultTweetQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error fetching tweets mentions for user ${userId}`
      })
    }
  }
}

function listTweetsLikedByUserIdImpl(client: types.TwitterV2Client) {
  return async (
    userId: string,
    params?: types.ListTweetsLikedByUserIdParams
  ) => {
    try {
      return await client.tweets.usersIdLikedTweets(userId, {
        ...defaultTweetQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error fetching tweets liked by user ${userId}`
      })
    }
  }
}

function listTweetsByUserIdImpl(client: types.TwitterV2Client) {
  return async (userId: string, params?: types.ListTweetsByUserIdParams) => {
    try {
      return await client.tweets.usersIdTweets(userId, {
        ...defaultTweetQueryParams,
        ...params
      })
    } catch (err: any) {
      handleTwitterError(err, {
        label: `error fetching tweets by user ${userId}`
      })
    }
  }
}


================================================
FILE: legacy/packages/twitter/src/types.ts
================================================
import type { AsyncReturnType, Simplify } from 'type-fest'
import { type Client as TwitterV2Client } from 'twitter-api-sdk'

export { type Client as TwitterV2Client } from 'twitter-api-sdk'

export type TwitterApiPlan = 'free' | 'basic' | 'pro' | 'enterprise'

export type TweetsQueryOptions = Simplify<
  Pick<
    Parameters<TwitterV2Client['tweets']['findTweetsById']>[0],
    'expansions' | 'tweet.fields' | 'user.fields'
  >
>

export type TwitterUserQueryOptions = Simplify<
  Pick<
    NonNullable<Parameters<TwitterV2Client['users']['findUserById']>[1]>,
    'expansions' | 'tweet.fields' | 'user.fields'
  >
>

export type TwitterQueryTweetFields = TweetsQueryOptions['tweet.fields']
export type TwitterQueryUserFields = TweetsQueryOptions['user.fields']

export type TwitterUserIdMentionsQueryOptions = Simplify<
  NonNullable<Parameters<TwitterV2Client['tweets']['usersIdMentions']>[1]>
>

export type CreateTweetParams = Simplify<
  Parameters<TwitterV2Client['tweets']['createTweet']>[0]
>

export type ListTweetMentionsByUserIdParams = Simplify<
  Parameters<TwitterV2Client['tweets']['usersIdMentions']>[1]
>

export type GetTweetByIdParams = Simplify<
  Parameters<TwitterV2Client['tweets']['findTweetById']>[1]
>

export type GetTweetsByIdParams = Simplify<
  Parameters<TwitterV2Client['tweets']['findTweetsById']>[0]
>

export type SearchRecentTweetsParams = Simplify<
  Parameters<TwitterV2Client['tweets']['tweetsRecentSearch']>[0]
>

export type GetUserByIdParams = Simplify<
  Parameters<TwitterV2Client['users']['findUserById']>[1]
>

export type GetUserByUsernameParams = Simplify<
  Parameters<TwitterV2Client['users']['findUserByUsername']>[1]
>

export type ListTweetsLikedByUserIdParams = Simplify<
  Parameters<TwitterV2Client['tweets']['usersIdLikedTweets']>[1]
>

export type ListTweetsByUserIdParams = Simplify<
  Parameters<TwitterV2Client['tweets']['usersIdTweets']>[1]
>

type Unpacked<T> = T extends (infer U)[] ? U : T

export type Tweet = Simplify<
  NonNullable<
    Unpacked<
      AsyncReturnType<TwitterV2Client['tweets']['findTweetsById']>['data']
    >
  >
>
export type TwitterUser = Simplify<
  NonNullable<AsyncReturnType<TwitterV2Client['users']['findMyUser']>['data']>
>
export type CreatedTweet = Simplify<
  NonNullable<AsyncReturnType<TwitterV2Client['tweets']['createTweet']>['data']>
>

export type TwitterUrl = Simplify<
  Unpacked<NonNullable<NonNullable<Tweet['entities']>['urls']>>
>


================================================
FILE: legacy/packages/twitter/src/utils.ts
================================================
import { omit } from '@agentic/core'

import type * as types from './types'
import { TwitterError } from './error'

/**
 * Error handler which takes in an unknown Error object and converts it to a
 * structured TwitterError object for a set of common Twitter API errors.
 *
 * Re-throws the error if not recognized and will never return.
 */
export function handleTwitterError(
  err: any,
  { label = '' }: { label?: string } = {}
): never {
  if (err.status === 403) {
    // user may have deleted the tweet we're trying to respond to
    throw new TwitterError(err.error?.detail || `${label}: 403 forbidden`, {
      type: 'twitter:forbidden',
      isFinal: true,
      cause: err
    })
  } else if (err.status === 401) {
    throw new TwitterError(`${label}: unauthorized`, {
      type: 'twitter:auth',
      cause: err
    })
  } else if (err.status === 400) {
    if (
      /value passed for the token was invalid/i.test(
        err.error?.error_description
      )
    ) {
      throw new TwitterError(`${label}: invalid auth token`, {
        type: 'twitter:auth',
        cause: err
      })
    }
  } else if (err.status === 429) {
    throw new TwitterError(`${label}: too many requests`, {
      type: 'twitter:rate-limit',
      cause: err
    })
  } else if (err.status === 404) {
    throw new TwitterError(err.toString(), {
      type: 'twitter:forbidden',
      isFinal: true,
      cause: err
    })
  }

  if (err.status >= 400 && err.status < 500) {
    throw new TwitterError(
      `${label}: ${err.status} ${err.error?.description || err.toString()}`,
      {
        type: 'twitter:unknown',
        isFinal: true,
        cause: err
      }
    )
  } else if (err.status >= 500) {
    throw new TwitterError(
      `${label}: ${err.status} ${err.error?.description || err.toString()}`,
      {
        type: 'twitter:unknown',
        isFinal: false,
        cause: err
      }
    )
  }

  const reason = err.toString().toLowerCase()

  if (reason.includes('fetcherror') || reason.includes('enotfound')) {
    throw new TwitterError(err.toString(), {
      type: 'network',
      cause: err
    })
  }

  // Otherwise, propagate the original error
  throw err
}

export function getPrunedTweet(
  tweet: Partial<types.Tweet>
): Partial<types.Tweet> {
  const urls = tweet.entities?.urls
  let text = tweet.text

  if (text && urls) {
    for (const url of urls) {
      if (url.expanded_url && url.url) {
        text = text!.replaceAll(url.url, url.expanded_url!)
      }
    }
  }

  return {
    ...omit(
      tweet,
      'conversation_id',
      'public_metrics',
      'created_at',
      'entities',
      'possibly_sensitive'
    ),
    text
  }
}

export function getPrunedTwitterUser(
  twitterUser: Partial<types.TwitterUser>
): Partial<types.TwitterUser> {
  const urls = twitterUser.entities?.description?.urls
  let description = twitterUser.description

  if (description && urls) {
    for (const url of urls) {
      if (url.expanded_url && url.url) {
        description = description!.replaceAll(url.url, url.expanded_url!)
      }
    }
  }

  return {
    ...omit(
      twitterUser,
      'public_metrics',
      'created_at',
      'verified',
      'protected',
      'url',
      'entities'
    ),
    description
  }
}


================================================
FILE: legacy/packages/twitter/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/typeform/package.json
================================================
{
  "name": "@agentic/typeform",
  "version": "7.6.9",
  "description": "Agentic SDK for the Typeform API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/typeform"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/typeform/src/index.ts
================================================
export * from './typeform-client'


================================================
FILE: legacy/packages/typeform/src/typeform-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace typeform {
  export const API_BASE_URL = 'https://api.typeform.com'

  export interface GetInsightsForFormResponse {
    fields: Array<{
      dropoffs: number
      id: string
      label: string
      ref: string
      title: string
      type: string
      views: number
    }>
    form: {
      platforms: Array<{
        average_time: number
        completion_rate: number
        platform: string
        responses_count: number
        total_visits: number
        unique_visits: number
      }>
      summary: {
        average_time: number
        completion_rate: number
        responses_count: number
        total_visits: number
        unique_visits: number
      }
    }
  }

  export interface GetResponsesForFormParams {
    formId: string
    pageSize?: number
    since?: string
    until?: string
    completed?: boolean
  }

  export interface GetResponsesForFormResponse {
    total_items: number
    page_count: number
    items: Array<{
      landing_id: string
      token: string
      landed_at: string
      submitted_at: string
      metadata: {
        user_agent: string
        platform: string
        referer: string
        network_id: string
        browser: string
      }
      answers: Array<{
        field: {
          id: string
          type: string
          ref: string
        }
        type: string
        [key: string]: any
      }>
      hidden: Record<string, any>
      calculated: {
        score: number
      }
      variables: Array<{
        key: string
        type: string
        [key: string]: any
      }>
    }>
  }
}

/**
 * Readonly Typeform API client for fetching form insights and responses.
 *
 * @see https://www.typeform.com/developers/get-started/
 */
export class TypeformClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('TYPEFORM_API_KEY'),
    apiBaseUrl = typeform.API_BASE_URL,
    timeoutMs = 60_000,
    ky = defaultKy
  }: {
    /** Typeform Personal Access Token */
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'TypeformClient missing required "apiKey" (defaults to "TYPEFORM_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      timeout: timeoutMs,
      headers: {
        Authorization: `Bearer ${this.apiKey}`
      }
    })
  }

  /**
   * Retrieves insights and analytics for a Typeform form.
   */
  @aiFunction({
    name: 'typeform_get_insights_for_form',
    description: 'Retrieve insights and analytics for a Typeform form.',
    inputSchema: z.object({
      formId: z
        .string()
        .describe('The ID of the Typeform form to get insights for.')
    })
  })
  async getInsightsForForm(
    formIdOrOptions: string | { formId: string }
  ): Promise<typeform.GetInsightsForFormResponse> {
    const { formId } =
      typeof formIdOrOptions === 'string'
        ? { formId: formIdOrOptions }
        : formIdOrOptions

    const encodedFormId = encodeURIComponent(formId)
    return this.ky
      .get(`insights/${encodedFormId}/summary`)
      .json<typeform.GetInsightsForFormResponse>()
  }

  /**
   * Retrieves responses for a Typeform form.
   */
  @aiFunction({
    name: 'typeform_get_responses_for_form',
    description: 'Retrieve responses for a Typeform form.',
    inputSchema: z.object({
      formId: z
        .string()
        .describe('The ID of the Typeform form to get responses for.'),
      pageSize: z
        .number()
        .describe('The number of responses to retrieve per page.')
        .optional(),
      since: z
        .string()
        .describe('The date to start retrieving responses from.')
        .optional(),
      until: z
        .string()
        .describe('The date to stop retrieving responses at.')
        .optional(),
      completed: z
        .boolean()
        .describe('Filter responses by completion status.')
        .optional()
    })
  })
  async getResponsesForForm(
    formIdOrOptions: string | typeform.GetResponsesForFormParams
  ): Promise<typeform.GetResponsesForFormResponse> {
    const { formId, ...params } =
      typeof formIdOrOptions === 'string'
        ? { formId: formIdOrOptions }
        : formIdOrOptions

    const encodedFormId = encodeURIComponent(formId)
    return this.ky
      .get(`forms/${encodedFormId}/responses`, {
        searchParams: sanitizeSearchParams(params)
      })
      .json<typeform.GetResponsesForFormResponse>()
  }
}


================================================
FILE: legacy/packages/typeform/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/weather/package.json
================================================
{
  "name": "@agentic/weather",
  "version": "7.6.9",
  "description": "Agentic SDK for weatherapi.com.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/weather"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/weather/src/index.ts
================================================
export * from './weather-client'


================================================
FILE: legacy/packages/weather/src/weather-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace weatherapi {
  export const BASE_URL = 'https://api.weatherapi.com/v1'

  export interface CurrentWeatherResponse {
    current: CurrentWeather
    location: WeatherLocation
  }

  export interface CurrentWeather {
    cloud: number
    condition: WeatherCondition
    feelslike_c: number
    feelslike_f: number
    gust_kph: number
    gust_mph: number
    humidity: number
    is_day: number
    last_updated: string
    last_updated_epoch: number
    precip_in: number
    precip_mm: number
    pressure_in: number
    pressure_mb: number
    temp_c: number
    temp_f: number
    uv: number
    vis_km: number
    vis_miles: number
    wind_degree: number
    wind_dir: string
    wind_kph: number
    wind_mph: number
  }

  export interface WeatherCondition {
    code: number
    icon: string
    text: string
  }

  export interface WeatherLocation {
    country: string
    lat: number
    localtime: string
    localtime_epoch: number
    lon: number
    name: string
    region: string
    tz_id: string
  }

  export interface WeatherIPInfoResponse {
    ip: string
    type: string
    continent_code: string
    continent_name: string
    country_code: string
    country_name: string
    is_eu: string
    geoname_id: number
    city: string
    region: string
    lat: number
    lon: number
    tz_id: string
    localtime_epoch: number
    localtime: string
  }
}

/**
 * Simple Weather API client for accessing weather data based on location.
 *
 * @see https://www.weatherapi.com
 */
export class WeatherClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('WEATHER_API_KEY'),
    apiBaseUrl = weatherapi.BASE_URL,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'WeatherClient missing required "apiKey" (defaults to "WEATHER_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({ prefixUrl: apiBaseUrl })
  }

  /**
   * Gets info about the current weather at a given location.
   */
  @aiFunction({
    name: 'get_current_weather',
    description: 'Gets info about the current weather at a given location.',
    inputSchema: z.object({
      q: z
        .string()
        .describe(
          'Location to get the weather for. Can be a city name, zipcode, IP address, or lat/lng coordinates. Example: "London"'
        )
    })
  })
  async getCurrentWeather(queryOrOptions: string | { q: string }) {
    const options =
      typeof queryOrOptions === 'string'
        ? { q: queryOrOptions }
        : queryOrOptions

    return this.ky
      .get('current.json', {
        searchParams: sanitizeSearchParams({
          key: this.apiKey,
          ...options
        })
      })
      .json<weatherapi.CurrentWeatherResponse>()
  }
}


================================================
FILE: legacy/packages/weather/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/wikidata/package.json
================================================
{
  "name": "@agentic/wikidata",
  "version": "7.6.9",
  "description": "Agentic SDK for Wikidata.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/wikidata"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:",
    "wikibase-sdk": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/wikidata/src/index.ts
================================================
export * from './wikidata-client'


================================================
FILE: legacy/packages/wikidata/src/wikidata-client.ts
================================================
import type * as wikibase from 'wikibase-sdk'
import { AIFunctionsProvider, assert, getEnv, throttleKy } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import wdk from 'wikibase-sdk/wikidata.org'

export namespace wikidata {
  // Allow up to 200 requests per second by default.
  export const throttle = pThrottle({
    limit: 200,
    interval: 1000
  })

  export type SimplifiedEntityMap = Record<string, SimplifiedEntity>

  export interface SimplifiedEntity {
    id: string
    type: string
    claims: Claims
    modified: string
    labels?: Descriptions
    descriptions?: Descriptions
    aliases?: any
    sitelinks?: Sitelinks
  }

  export interface Claims {
    [key: string]: Claim[]
  }

  export interface Claim {
    value: string
    qualifiers: Record<string, string[] | number[]>
    references: Record<string, string[]>[]
  }

  export type Descriptions = Record<string, string>
  export type Sitelinks = Record<string, string>
}

/**
 * Basic Wikidata client.
 *
 * @see https://github.com/maxlath/wikibase-sdk
 *
 * TODO: support any wikibase instance
 */
export class WikidataClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiUserAgent: string

  constructor({
    apiUserAgent = getEnv('WIKIDATA_API_USER_AGENT') ??
      'Agentic (https://github.com/transitive-bullshit/agentic)',
    throttle = true,
    ky = defaultKy
  }: {
    apiBaseUrl?: string
    apiUserAgent?: string
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(apiUserAgent, 'WikidataClient missing required "apiUserAgent"')
    super()

    this.apiUserAgent = apiUserAgent

    const throttledKy = throttle ? throttleKy(ky, wikidata.throttle) : ky

    this.ky = throttledKy.extend({
      headers: {
        'user-agent': apiUserAgent
      }
    })
  }

  async getEntityById(
    idOrOpts: string | { id: string; languages?: string[] }
  ): Promise<wikidata.SimplifiedEntity> {
    const { id, languages = ['en'] } =
      typeof idOrOpts === 'string' ? { id: idOrOpts } : idOrOpts

    const url = wdk.getEntities({
      ids: id as wikibase.EntityId,
      languages
    })

    const res = await this.ky.get(url).json<any>()
    const entities = wdk.simplify.entities(res.entities, {
      // TODO: Make this configurable and double-check defaults.
      keepQualifiers: true,
      keepReferences: true
    })

    const entity = entities[id]
    return entity as wikidata.SimplifiedEntity
  }

  async getEntitiesByIds(
    idsOrOpts: string[] | { ids: string; languages?: string[] }
  ): Promise<wikidata.SimplifiedEntityMap> {
    const { ids, languages = ['en'] } = Array.isArray(idsOrOpts)
      ? { ids: idsOrOpts }
      : idsOrOpts

    // TODO: Separate between wdk.getEntities and wdk.getManyEntities depending
    // on how many `ids` there are.
    const url = wdk.getEntities({
      ids: ids as wikibase.EntityId[],
      languages
    })

    const res = await this.ky.get(url).json<any>()
    const entities = wdk.simplify.entities(res.entities, {
      keepQualifiers: true,
      keepReferences: true
    })

    return entities as wikidata.SimplifiedEntityMap
  }
}


================================================
FILE: legacy/packages/wikidata/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/wikipedia/package.json
================================================
{
  "name": "@agentic/wikipedia",
  "version": "7.6.9",
  "description": "Agentic SDK for wikipedia.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/wikipedia"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:",
    "p-throttle": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/wikipedia/src/index.ts
================================================
export * from './wikipedia-client'


================================================
FILE: legacy/packages/wikipedia/src/wikipedia-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  throttleKy
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace wikipedia {
  // Allow up to 200 requests per second by default.
  export const throttle = pThrottle({
    limit: 200,
    interval: 1000
  })

  export interface SearchOptions {
    query: string
    limit?: number
  }

  export interface PageSearchResponse {
    pages: Page[]
  }

  export interface Page {
    id: number
    key: string
    title: string
    matched_title: null
    excerpt: string
    description: null | string
    thumbnail: Thumbnail | null
  }

  export interface Thumbnail {
    url: string
    width: number
    height: number
    mimetype: string
    duration: null
  }

  export interface PageSummaryOptions {
    title: string
    redirect?: boolean
    acceptLanguage?: string
  }

  export interface PageSummaryResponse {
    ns?: number
    index?: number
    type: string
    title: string
    displaytitle: string
    namespace: { id: number; text: string }
    wikibase_item: string
    titles: { canonical: string; normalized: string; display: string }
    pageid: number
    thumbnail: {
      source: string
      width: number
      height: number
    }
    originalimage: {
      source: string
      width: number
      height: number
    }
    lang: string
    dir: string
    revision: string
    tid: string
    timestamp: string
    description: string
    description_source: string
    content_urls: {
      desktop: {
        page: string
        revisions: string
        edit: string
        talk: string
      }
      mobile: {
        page: string
        revisions: string
        edit: string
        talk: string
      }
    }
    extract: string
    extract_html: string
    normalizedtitle?: string
    coordinates?: {
      lat: number
      lon: number
    }
  }
}

/**
 * Basic Wikipedia API client for searching wiki pages and resolving page data.
 *
 * @see https://www.mediawiki.org/wiki/API
 */
export class WikipediaClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiBaseUrl: string
  protected readonly apiUserAgent: string

  constructor({
    apiBaseUrl = getEnv('WIKIPEDIA_API_BASE_URL') ??
      'https://en.wikipedia.org/api/rest_v1',
    apiUserAgent = getEnv('WIKIPEDIA_API_USER_AGENT') ??
      'Agentic (https://github.com/transitive-bullshit/agentic)',
    throttle = true,
    ky = defaultKy
  }: {
    apiBaseUrl?: string
    apiUserAgent?: string
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(apiBaseUrl, 'WikipediaClient missing required "apiBaseUrl"')
    assert(apiUserAgent, 'WikipediaClient missing required "apiUserAgent"')
    super()

    this.apiBaseUrl = apiBaseUrl
    this.apiUserAgent = apiUserAgent

    const throttledKy = throttle ? throttleKy(ky, wikipedia.throttle) : ky

    this.ky = throttledKy.extend({
      headers: {
        'api-user-agent': apiUserAgent
      }
    })
  }

  /**
   * Searches Wikipedia for pages matching the given query. */
  @aiFunction({
    name: 'wikipedia_search',
    description: 'Searches Wikipedia for pages matching the given query.',
    inputSchema: z.object({
      query: z.string().describe('Search query')
    })
  })
  async search({ query, ...opts }: wikipedia.SearchOptions) {
    return (
      // https://www.mediawiki.org/wiki/API:REST_API
      this.ky
        .get('https://en.wikipedia.org/w/rest.php/v1/search/page', {
          searchParams: { q: query, ...opts }
        })
        .json<wikipedia.PageSearchResponse>()
    )
  }

  /**
   * Gets a summary of the given Wikipedia page.
   */
  @aiFunction({
    name: 'wikipedia_get_page_summary',
    description: 'Gets a summary of the given Wikipedia page.',
    inputSchema: z.object({
      title: z.string().describe('Wikipedia page title'),
      acceptLanguage: z
        .string()
        .optional()
        .default('en-us')
        .describe('Locale code for the language to use.')
    })
  })
  async getPageSummary({
    title,
    acceptLanguage = 'en-us',
    redirect = true,
    ...opts
  }: wikipedia.PageSummaryOptions) {
    title = title.trim().replaceAll(' ', '_')

    // https://en.wikipedia.org/api/rest_v1/
    return this.ky
      .get(`page/summary/${title}`, {
        prefixUrl: this.apiBaseUrl,
        searchParams: { redirect, ...opts },
        headers: {
          'accept-language': acceptLanguage
        }
      })
      .json<wikipedia.PageSummaryResponse>()
  }
}


================================================
FILE: legacy/packages/wikipedia/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/wolfram-alpha/package.json
================================================
{
  "name": "@agentic/wolfram-alpha",
  "version": "7.6.9",
  "description": "Agentic SDK for Wolfram Alpha.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/wolfram-alpha"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/wolfram-alpha/src/index.ts
================================================
export * from './wolfram-alpha-client'


================================================
FILE: legacy/packages/wolfram-alpha/src/wolfram-alpha-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace wolframalpha {
  export const API_BASE_URL = 'https://www.wolframalpha.com/api/'

  export const AskWolframAlphaOptionsSchema = z.object({
    input: z.string().describe('english query'),
    maxchars: z
      .number()
      .int()
      .default(6000)
      .optional()
      .describe('max characters to generate in the response')
  })
  export type AskWolframAlphaOptions = z.infer<
    typeof AskWolframAlphaOptionsSchema
  >
}

/**
 * Wolfram Alpha LLM API client for answering computational, mathematical, and
 * scientific questions.
 *
 * @see https://products.wolframalpha.com/llm-api/documentation
 */
export class WolframAlphaClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly appId: string
  protected readonly apiBaseUrl: string

  constructor({
    appId = getEnv('WOLFRAM_APP_ID'),
    apiBaseUrl = wolframalpha.API_BASE_URL,
    ky = defaultKy
  }: {
    appId?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } = {}) {
    assert(
      appId,
      'WolframAlphaClient missing required "appId" (defaults to "WOLFRAM_APP_ID")'
    )
    super()

    this.appId = appId
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,
      headers: {
        Authorization: `Bearer ${appId}`
      }
    })
  }

  /**
   * Answers computational, mathematical, and scientific questions.
   *
   * WolframAlpha understands natural language queries about entities in chemistry, physics, geography, history, art, astronomy, and more.
   *
   * WolframAlpha performs mathematical calculations, date and unit conversions, formula solving, etc.
   */
  @aiFunction({
    name: 'ask_wolfram_alpha',
    description: `
- WolframAlpha understands natural language queries about entities in chemistry, physics, geography, history, art, astronomy, and more.
- WolframAlpha performs mathematical calculations, date and unit conversions, formula solving, etc.
- Convert inputs to simplified keyword queries whenever possible (e.g. convert "how many people live in France" to "France population").
- Send queries in English only; translate non-English queries before sending, then respond in the original language.
- ALWAYS use this exponent notation: \`6*10^14\`, NEVER \`6e14\`.
- ALWAYS use proper Markdown formatting for all math, scientific, and chemical formulas, symbols, etc.:  '$$\n[expression]\n$$' for standalone cases and '( [expression] )' when inline.
- Use ONLY single-letter variable names, with or without integer subscript (e.g., n, n1, n_1).
- Use named physical constants (e.g., 'speed of light') without numerical substitution.
- Include a space between compound units (e.g., "Ω m" for "ohm*meter").
- To solve for a variable in an equation with units, consider solving a corresponding equation without units; exclude counting units (e.g., books), include genuine units (e.g., kg).
- If a WolframAlpha result is not relevant to the query:
  - If Wolfram provides multiple 'Assumptions' for a query, choose the more relevant one(s) without explaining the initial result. If you are unsure, ask the user to choose.
  - Re-send the exact same 'input' with NO modifications, and add the 'assumption' parameter, formatted as a list, with the relevant values.
  - ONLY simplify or rephrase the initial query if a more relevant 'Assumption' or other input suggestions are not provided.
`.trim(),
    inputSchema: wolframalpha.AskWolframAlphaOptionsSchema
  })
  async ask(queryOrOptions: string | wolframalpha.AskWolframAlphaOptions) {
    const options =
      typeof queryOrOptions === 'string'
        ? { input: queryOrOptions }
        : queryOrOptions

    return this.ky
      .get('v1/llm-api', { searchParams: sanitizeSearchParams(options) })
      .text()
  }
}


================================================
FILE: legacy/packages/wolfram-alpha/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/xsai/package.json
================================================
{
  "name": "@agentic/xsai",
  "version": "7.6.9",
  "description": "Agentic adapter for the xsAI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/xsai"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*"
  },
  "peerDependencies": {
    "@xsai/tool": "catalog:"
  },
  "devDependencies": {
    "@xsai/tool": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: legacy/packages/xsai/src/index.ts
================================================
export * from './xsai'


================================================
FILE: legacy/packages/xsai/src/xsai.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { expect, test } from 'vitest'

import { createXSAITools, createXSAIToolsFromIdentifier } from './xsai'

test('createXSAITools', async () => {
  const tools = await createXSAITools(new EchoAITool())
  expect(tools).toHaveLength(1)
  expect(tools[0]!.function.name).toBe('echo')
})

test('createXSAIToolsFromIdentifier', async () => {
  const tools = await createXSAIToolsFromIdentifier('@agentic/search')
  expect(tools).toHaveLength(1)
  expect(tools[0]!.function.name).toBe('search')
})


================================================
FILE: legacy/packages/xsai/src/xsai.ts
================================================
import { type AIFunctionLike, AIFunctionSet, isZodSchema } from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { tool } from '@xsai/tool'

export type XSAITool = Awaited<ReturnType<typeof tool>>

/**
 * Converts a set of Agentic stdlib AI functions to an object compatible with
 * the [xsAI SDK's](https://github.com/moeru-ai/xsai) `tools` parameter.
 */
export function createXSAITools(
  ...aiFunctionLikeTools: AIFunctionLike[]
): Promise<XSAITool[]> {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return Promise.all(
    fns.map((fn) => {
      if (!isZodSchema(fn.inputSchema)) {
        throw new Error(
          `xsAI tools only support Standard schemas like Zod: ${fn.spec.name} tool uses a custom JSON Schema, which is currently not supported.`
        )
      }

      return tool({
        name: fn.spec.name,
        description: fn.spec.description,
        parameters: fn.inputSchema,
        execute: fn.execute
      })
    })
  )
}

/**
 * Creates an array of xsAI tools from a hosted Agentic project or deployment
 * identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const tools = await createXSAIToolsFromIdentifier('@agentic/search')
 * ```
 */
export async function createXSAIToolsFromIdentifier(
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<XSAITool[]> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createXSAITools(agenticToolClient)
}


================================================
FILE: legacy/packages/xsai/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/youtube/package.json
================================================
{
  "name": "@agentic/youtube",
  "version": "7.6.9",
  "description": "Agentic SDK for the YouTube data API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/youtube"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/youtube/src/index.ts
================================================
export * from './youtube-client'


================================================
FILE: legacy/packages/youtube/src/youtube-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  sanitizeSearchParams
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace youtube {
  export const API_BASE_URL = 'https://www.googleapis.com/youtube/v3'

  export interface SearchOptions {
    query: string
    maxResults?: number
    pageToken?: string
    channelId?: string
    channelType?: 'any' | 'show'
    eventType?: 'live' | 'completed' | 'upcoming'
    location?: string
    locationRadius?: string
    order?:
      | 'relevance'
      | 'date'
      | 'rating'
      | 'title'
      | 'videoCount'
      | 'viewCount'
    // The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
    publishedAfter?: string
    publishedBefore?: string
    // The regionCode parameter instructs the API to return search results for videos that can be viewed in the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.
    regionCode?: string
    relevanceLanguage?: string
    safeSearch?: 'moderate' | 'none' | 'strict'
    topicId?: string
    videoCaption?: 'any' | 'closedCaption' | 'none'
    videoCategoryId?: string
    videoDefinition?: 'any' | 'high' | 'standard'
    videoDimension?: '2d' | '3d' | 'any'
    videoDuration?: 'any' | 'long' | 'medium' | 'short'
    videoEmbeddable?: 'any' | 'true'
    videoLicense?: 'any' | 'creativeCommon' | 'youtube'
    videoPaidProductPlacement?: 'any' | 'true'
    videoSyndicated?: 'any' | 'true'
    videoType?: 'any' | 'episode' | 'movie'
  }

  export type SearchType = 'video' | 'channel' | 'playlist'

  export interface SearchVideosResult {
    videoId: string
    title: string
    description: string
    thumbnail: string
    channelId: string
    channelTitle: string
    publishedAt: string
    url: string
  }

  export interface SearchChannelsResult {
    channelId: string
    title: string
    description: string
    thumbnail: string
    publishedAt: string
    url: string
  }

  export type SearchResponse<T extends SearchType> = {
    results: T extends 'video'
      ? SearchVideosResult[]
      : T extends 'channel'
        ? SearchChannelsResult[]
        : never
    totalResults: number
    prevPageToken?: string
    nextPageToken?: string
  }

  export type SearchVideosResponse = SearchResponse<'video'>
  export type SearchChannelsResponse = SearchResponse<'channel'>
}

/**
 * YouTube data API v3 client.
 *
 * @see https://developers.google.com/youtube/v3
 */
export class YouTubeClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string

  constructor({
    apiKey = getEnv('YOUTUBE_API_KEY'),
    apiBaseUrl = youtube.API_BASE_URL,
    timeoutMs = 30_000,
    ky = defaultKy
  }: {
    apiKey?: string
    apiBaseUrl?: string
    timeoutMs?: number
    ky?: KyInstance
  } = {}) {
    assert(
      apiKey,
      'YouTubeClient missing required "apiKey" (defaults to "YOUTUBE_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      timeout: timeoutMs
    })
  }

  /**
   * Searches for videos on YouTube.
   *
   * @see https://developers.google.com/youtube/v3/docs/search/list
   */
  @aiFunction({
    name: 'youtube_search_videos',
    description: 'Searches for videos on YouTube.',
    inputSchema: z.object({
      query: z.string().describe(`The query to search for.

Your request can optionally use the Boolean NOT (-) and OR (|) operators to exclude videos or to find videos that are associated with one of several search terms. For example, to search for videos matching either "boating" or "sailing", set the query parameter value to boating|sailing. Similarly, to search for videos matching either "boating" or "sailing" but not "fishing", set the query parameter value to boating|sailing -fishing.`),
      maxResults: z
        .number()
        .int()
        .optional()
        .describe('The maximum number of results to return (defaults to 5).')
    })
  })
  async searchVideos(
    queryOrOpts: string | youtube.SearchOptions
  ): Promise<youtube.SearchVideosResponse> {
    const opts =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    const data = await this._search({
      ...opts,
      type: 'video'
    })

    const results = (data.items || [])
      .map((item: any) => {
        const snippet = item.snippet
        if (!snippet) return null

        const videoId = item.id?.videoId
        if (!videoId) return null

        const thumbnails = snippet.thumbnails
        if (!thumbnails) return null

        return {
          videoId,
          title: snippet.title,
          description: snippet.description,
          // https://i.ytimg.com/vi/MRtg6A1f2Ko/maxresdefault.jpg
          thumbnail:
            thumbnails.high?.url ||
            thumbnails.medium?.url ||
            thumbnails.default?.url ||
            `https://i.ytimg.com/vi/${videoId}/maxresdefault.jpg`,
          channelId: snippet.channelId,
          channelTitle: snippet.channelTitle,
          publishedAt: snippet.publishedAt,
          url: `https://www.youtube.com/watch?v=${videoId}`
        }
      })
      .filter(Boolean)

    return {
      results,
      totalResults: data.pageInfo?.totalResults || 0,
      prevPageToken: data.prevPageToken,
      nextPageToken: data.nextPageToken
    }
  }

  /**
   * Searches for channels on YouTube.
   *
   * @see https://developers.google.com/youtube/v3/docs/search/list
   */
  @aiFunction({
    name: 'youtube_search_channels',
    description: 'Searches for channels on YouTube.',
    inputSchema: z.object({
      query: z.string().describe('The query to search for.'),
      maxResults: z
        .number()
        .int()
        .optional()
        .describe('The maximum number of results to return (defaults to 5).')
    })
  })
  async searchChannels(
    queryOrOpts: string | youtube.SearchOptions
  ): Promise<youtube.SearchChannelsResponse> {
    const opts =
      typeof queryOrOpts === 'string' ? { query: queryOrOpts } : queryOrOpts

    const data = await this._search({
      ...opts,
      type: 'channel'
    })

    const results = (data.items || [])
      .map((item: any) => {
        const snippet = item.snippet
        if (!snippet) return null

        const channelId = item.id?.channelId
        if (!channelId) return null

        const thumbnails = snippet.thumbnails
        if (!thumbnails) return null

        return {
          channelId,
          title: snippet.title,
          description: snippet.description,
          thumbnail:
            thumbnails.high?.url ||
            thumbnails.medium?.url ||
            thumbnails.default?.url,
          publishedAt: snippet.publishedAt,
          url: `https://www.youtube.com/channel/${channelId}`
        }
      })
      .filter(Boolean)

    return {
      results,
      totalResults: data.pageInfo?.totalResults || 0,
      prevPageToken: data.prevPageToken,
      nextPageToken: data.nextPageToken
    }
  }

  protected async _search(
    opts: youtube.SearchOptions & {
      type: youtube.SearchType
    }
  ) {
    const { query, ...params } = opts

    return this.ky
      .get('search', {
        searchParams: sanitizeSearchParams({
          q: query,
          part: 'snippet',
          maxResults: 5,
          ...params,
          key: this.apiKey
        })
      })
      .json<any>()
  }
}


================================================
FILE: legacy/packages/youtube/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/packages/zoominfo/package.json
================================================
{
  "name": "@agentic/zoominfo",
  "version": "7.6.9",
  "description": "Agentic SDK for ZoomInfo.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/zoominfo"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "jsrsasign": "catalog:",
    "ky": "catalog:",
    "p-throttle": "catalog:",
    "zoominfo-api-auth-client": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "devDependencies": {
    "@types/jsrsasign": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: legacy/packages/zoominfo/src/index.ts
================================================
export * from './zoominfo-client'


================================================
FILE: legacy/packages/zoominfo/src/zoominfo-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  throttleKy
} from '@agentic/core'
import { KJUR } from 'jsrsasign'
import defaultKy, { type KyInstance } from 'ky'
import pThrottle from 'p-throttle'
import { z } from 'zod'

export namespace zoominfo {
  export const API_BASE_URL = 'https://api.zoominfo.com'

  // Access tokens expire after 60 minutes, so renew them every 57 minutes.
  export const ACCESS_TOKEN_EXPIRATION_MS = 57 * 60 * 1000

  // Allow up to 1500 requests per minute by default.
  // https://api-docs.zoominfo.com/#rate-and-usage-limits
  export const throttle = pThrottle({
    limit: 1500,
    interval: 60_000
  })

  export interface EnrichContactOptions {
    personId?: string
    emailAddress?: string
    hashedEmail?: string
    phone?: string

    firstName?: string
    lastName?: string
    companyId?: string
    companyName?: string

    fullName?: string

    jobTitle?: string
    externalURL?: string
    lastUpdatedDateAfter?: string
    validDateAfter?: string
    contactAccuracyScoreMin?: number

    outputFields?: string[]
  }

  export interface EnrichCompanyOptions {
    /**
     * Unique ZoomInfo identifier for a company
     */
    companyId?: string
    /**
     * Company name
     */
    companyName?: string
    /**
     * Company website URL in http://www.example.com format
     */
    companyWebsite?: string
    /**
     * Company stock ticker symbol
     */
    companyTicker?: string
    /**
     * Phone number of the company headquarters
     */
    companyPhone?: string
    /**
     * Fax number of the company headquarters
     */
    companyFax?: string
    /**
     * Street address for the company's primary address
     */
    companyStreet?: string
    /**
     * City for the company's primary address
     */
    companyCity?: string
    /**
     * Company state (U.S.) or province (Canada). You can use free text state or province names (e.g., "new hampshire"), the two-letter common abbreviation for a U.S. state (e.g., "nh"), or values provided in the State lookup endpoint.
     */
    companyState?: string
    /**
     * Zip Code or Postal Code for the company's primary address
     */
    companyZipCode?: string
    /**
     * Country for the company's primary address. You can use free text or see the Country lookup endpoint for values.
     */
    companyCountry?: string
    /**
     * IP address associated with the company
     */
    ipAddress?: string

    outputFields?: string[]
  }

  export interface EnrichContactResponse {
    success: boolean
    data: {
      outputFields: string[][]
      result: EnrichContactResult[]
    }
  }

  export type MatchStatus =
    | 'NO_MATCH'
    | 'FULL_MATCH'
    | 'CONTACT_ONLY_MATCH'
    | 'COMPANY_ONLY_MATCH'
    | 'NON_MATCH_BY_REQUIRED_FIELDS'
    | 'NON_MATCH_BY_LAST_UPDATED_DATE'
    | 'NON_MATCH_BY_VALID_DATE'
    | 'NON_MATCH_BY_CONTACT_ACCURACY_MIN'
    | 'INVALID_INPUT'
    | 'LIMIT_EXCEEDED'
    | 'SERVICE_ERROR'
    | 'OPT_OUT'

  export interface EnrichContactResult {
    input: Partial<Omit<EnrichContactOptions, 'outputFields'>>
    data: EnrichedContact[]
    matchStatus?: MatchStatus
  }

  export interface EnrichedContact {
    id: number
    firstName: string
    middleName: string
    lastName: string
    email: string
    hasCanadianEmail: string
    phone: string
    directPhoneDoNotCall: boolean
    street: string
    city: string
    region: string
    metroArea: string
    zipCode: string
    state: string
    country: string
    personHasMoved: string
    withinEu: boolean
    withinCalifornia: boolean
    withinCanada: boolean
    lastUpdatedDate: string
    noticeProvidedDate: string
    salutation: string
    suffix: string
    jobTitle: string
    jobFunction: JobFunction[]
    education: Education[]
    hashedEmails: string[]
    picture: string
    mobilePhoneDoNotCall: boolean
    externalUrls: ExternalUrl[]
    contactAccuracyScore: number
    isDefunct: boolean
    employmentHistory: EmploymentHistory[]
    managementLevel: string[]
    locationCompanyId: number
    company: Company
  }

  export interface JobFunction {
    name: string
    department: string
  }

  export interface Education {
    school: string
    educationDegree: EducationDegree
  }

  export interface EducationDegree {
    degree: string
    areaOfStudy: string
  }

  export interface ExternalUrl {
    type: string
    url: string
  }

  export interface EmploymentHistory {
    jobTitle: string
    managementLevel: string[]
    fromDate: string
    toDate: string
    company: {
      companyId: number
      companyName: string
      companyPhone?: string
      companyWebsite?: string
    }
  }

  export interface Company {
    id: number
    name: string
    type: string
    division: string
    descriptionList: DescriptionList[]
    phone: string
    fax: string
    street: string
    city: string
    state: string
    zipCode: string
    country: string
    logo: string
    sicCodes: Code[]
    naicsCodes: Code[]
    website: string
    revenue: string
    revenueNumeric: number
    employeeCount: number
    ticker: string
    ranking: string[]
    socialMediaUrls: any[]
    primaryIndustry: string[]
    industries: string[]
    revenueRange: string
    employeeRange: string
  }

  export interface DescriptionList {
    description: string
  }

  export interface Code {
    id: string
    name: string
  }

  export interface EnrichCompanyResponse {
    success: boolean
    data: {
      outputFields: string[][]
      result: EnrichCompanyResult[]
    }
  }

  export interface EnrichCompanyResult {
    input: Partial<EnrichCompanyOptions>
    data: EnrichedCompany[]
    matchStatus?: MatchStatus
  }

  export interface EnrichedCompany {
    id: number
    ticker: string
    name: string
    website: string
    domainList: string[]
    logo: string
    socialMediaUrls: SocialMediaUrl[]
    revenue: number
    employeeCount: number
    numberOfContactsInZoomInfo: number
    phone: string
    fax: string
    street: string
    city: string
    state: string
    zipCode: string
    country: string
    continent: string
    companyStatus: string
    companyStatusDate: string
    descriptionList: DescriptionList[]
    sicCodes: Code[]
    naicsCodes: Code[]
    competitors: Competitor[]
    ultimateParentId: number
    ultimateParentName: string
    ultimateParentRevenue: number
    ultimateParentEmployees: number
    subUnitCodes: any[]
    subUnitType: string
    subUnitIndustries: string[]
    primaryIndustry: string[]
    industries: string[]
    parentId: number
    parentName: string
    locationCount: number
    alexaRank: string
    metroArea: string
    lastUpdatedDate: string
    createdDate: string
    certificationDate: string
    certified: boolean
    hashtags: Hashtag[]
    products: any[]
    techAttributes: TechAttribute[]
    revenueRange: string
    employeeRange: string
    companyFunding: CompanyFunding[]
    recentFundingAmount: number
    recentFundingDate: string
    totalFundingAmount: number
    employeeGrowth: EmployeeGrowth
  }

  export interface SocialMediaUrl {
    type: string
    url: string
    followerCount: string
  }

  export interface DescriptionList {
    description: string
  }

  export interface Competitor {
    rank: number
    id: number
    name: string
    website: string
    employeeCount: number
  }

  export interface Hashtag {
    tag: string
    external_id: any
    searchString: string
    displayLabel: string
    description: string
    group: string
    score: any
    priority?: number
    parentCategory: string
    displayScore: string
    inverseScoreBase?: number
    scoreMultipler: any
    scoreUnit: string
    hidden: boolean
    label: string
    categorizedFlag: boolean
  }

  export interface TechAttribute {
    tag: string
    categoryParent: string
    category: string
    vendor: string
    product: string
    attribute: string
    website: string
    logo?: string
    domain?: string
    createdTime: string
    modifiedTime: string
    description: string
  }

  export interface CompanyFunding {
    date: string
    type: string
    amount: number
  }

  export interface EmployeeGrowth {
    oneYearGrowthRate: string
    twoYearGrowthRate: string
    employeeGrowthDataPoints: EmployeeGrowthDataPoint[]
  }

  export interface EmployeeGrowthDataPoint {
    label: string
    employeeCount: number
  }

  export interface SearchContactsOptions {
    /**
     * Limits the results returned to the given number of results per page. Default is 25.
     */
    rpp?: number
    /**
     * Provides the results for the given page, used in conjunction with rpp
     */
    page?: number
    /**
     * Provide sortBy if specifying sortOrder. Valid values are asc, ascending, desc, and descending. By default, results are sorted in descending order.
     */
    sortOrder?: string
    /**
     * Sort results by valid output fields: contactAccuracyScore, lastName, companyName, hierarchy, sourceCount, lastMentioned, relevance
     */
    sortBy?: string
    /**
     * Unique ZoomInfo identifier for the contact. Can include a comma-separated list.
     */
    personId?: string
    /**
     * Work email address for the contact in example@example.com format
     */
    emailAddress?: string
    /**
     * Supplemental email address for the contact in example@example.com format
     */
    supplementalEmail?: string[]
    /**
     * Hashed email value for the contact. Allows searching via an email address with the extra security of not exposing the email. Supported hash algorithms are: MD5, SHA1, SHA256 and SHA512.
     */
    hashedEmail?: string
    /**
     * List of person phones or mobile numbers. Here's an example list - any of the following phone number formats are acceptable: ["(123)-456-7890", "1234567890", "123 456 7890", "123-445-7890"]. Alphabetical characters are not allowed.
     */
    phone?: string[]
    /**
     * Contact full name
     */
    fullName?: string
    /**
     * Contact first name
     */
    firstName?: string
    /**
     * Contact middle initial
     */
    middleInitial?: string
    /**
     * Contact last name
     */
    lastName?: string
    /**
     * Contact title at current place of employment. Use OR to input multiple job titles.
     */
    jobTitle?: string
    /**
     * Exclude comma-separated list of job titles
     */
    excludeJobTitle?: string
    /**
     * Contact management level at current place of employment. See the Management Levels lookup endpoint for values.
     */
    managementLevel?: string
    /**
     * Exclude contact based on management level. See the Management Levels lookup endpoint for values.
     */
    excludeManagementLevel?: string
    /**
     * Contact department at current place of employment. See the Contact Departments lookup endpoint for values.
     */
    department?: string
    /**
     * Exclude or include board members from search results. By default, the API includes board members in results. See the Board Members lookup endpoint for values.
     */
    boardMember?: string
    /**
     * Contacts who do not have an active company associated with them are considered partial profiles. Exclude contacts with a partial profile from search results.
     */
    excludePartialProfiles?: boolean
    /**
     * Return only executives
     */
    executivesOnly?: boolean
    /**
     * Specify a list of required fields for each record returned. Can include email, phone (direct or company), directPhone, personalEmail, and mobilePhone. Can include a comma-separated list of these fields. For example, requiring direct phone (directPhone) will only return contacts which have the Direct Phone Number field populated.
     */
    requiredFields?: string
    /**
     * Minimum accuracy score for search results. This score indicates the likelihood that a contact is reachable and still employed by the company listed. Minimum score is 70 and maximum is 99.
     */
    contactAccuracyScoreMin?: string
    /**
     * Maximum accuracy score for search results. This score indicates the likelihood that a contact is reachable and still employed by the company listed. Minimum score is 70 and maximum is 99.
     */
    contactAccuracyScoreMax?: string
    /**
     * Contact job function at their current place of employment. See the Job Function lookup endpoint for values.
     */
    jobFunction?: string
    /**
     * The date after which the contact's profile was last updated in YYYY-MM-DD format
     */
    lastUpdatedDateAfter?: string
    /**
     * The date after which the contact's profile was last validated in YYYY-MM-DD format
     */
    validDateAfter?: string
    /**
     * Number of months within which the contact's profile was last updated. For example, if lastUpdatedinMonths is 12 only contacts that were updated in the last 12 months will be returned.
     */
    lastUpdatedInMonths?: number
    /**
     * Contacts who have been notified of inclusion in ZoomInfo's database. Values are exclude, include, and only.
     */
    hasBeenNotified?: string
    /**
     * Returns companies based on a contact's work history. Values are present (default), past, and pastAndPresent.
     */
    companyPastOrPresent?: string
    /**
     * Contact educational institution
     */
    school?: string
    /**
     * Contact education degree
     */
    degree?: string
    /**
     * Searches by contact's location IDs. Use the Location Enrich endpoint to obtain a list of location IDs for a company.
     */
    locationCompanyId?: string[]
    /**
     * ZoomInfo unique identifier for the company. Will accept a comma-separated list.
     */
    companyId?: string
    /**
     * Company name. Can use OR and NOT operators to include or exclude companies by name. For example, "Vodaphone OR Comcast NOT Verizon"
     */
    companyName?: string
    /**
     * URL to the company website in http://www.example.com format
     */
    companyWebsite?: string
    /**
     * Company stock ticker symbol
     */
    companyTicker?: string[]
    /**
     * Text description unique to the company you want to use as search criteria
     */
    companyDescription?: string
    /**
     * ZoomInfo Company ID for parent company
     */
    parentId?: string
    /**
     * ZoomInfo Company ID for ultimate parent company
     */
    ultimateParentId?: string
    /**
     * Company type (private, public, and so on). See the Company Type lookup endpoint for values.
     */
    companyType?: string
    /**
     * Company address
     */
    address?: string
    /**
     * Company street
     */
    street?: string
    /**
     * Company state (U.S.) or province (Canada). You can use free text state or province names (e.g., "new hampshire"), the two-letter common abbreviation for a U.S. state (e.g., "nh"), or values provided in the State lookup endpoint.
     */
    state?: string
    /**
     * Zip Code of the company's primary address.
     */
    zipCode?: string
    /**
     * Country for the company's primary address. You can use free text or see the Country lookup endpoint for values.
     */
    country?: string
    /**
     * Continent for the company's primary address. See the Continent lookup endpoint for values.
     */
    continent?: string
    /**
     * Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided.
     */
    zipCodeRadiusMiles?: string
    /**
     * Hash tags for a company. Can include a comma-separated list.
     */
    hashTagString?: string
    /**
     * Specify technology product tags. See the Tech - Product lookup endpoint for values. This string uses a numerical dot notation format similar to an IP address. The notation denotes the hierarchical structure: parent-category.category.vendor. For example, 333.202.28. You can use wildcards in the notation (e.g., 333.202.\\\\\\*, \\\\\\*.202.\\\\\\*, and so on).
     */
    techAttributeTagList?: string
    /**
     * Company sub types (e.g., division, subsidiary and so on). See the Sub Unit Type lookup endpoint for values.
     */
    subUnitTypes?: string
    /**
     * Used in conjunction with the industryCodes input parameter. When set to true, any result returned must have one of the specified industries as a primary industry. If no industries are specified, then this parameter will be ignored. Default is false.
     */
    primaryIndustriesOnly?: boolean
    /**
     * Top-level industry that the contact works in. A contact can have multiple top level industries. Tags are based on the contact's current company. Can include a comma-separated list. See the Industry Codes lookup endpoint for values.
     */
    industryCodes?: string
    /**
     * Industry keywords associated with a company. Can include a comma-separated list.
     */
    industryKeywords?: string
    /**
     * The Standard Industrial Classification is a system for classifying industries by a four-digit code. See the SIC Codes lookup endpoint for values.
     */
    sicCodes?: string
    /**
     * The North American Industry Classification System (NAICS) is the standard used by Federal statistical agencies in classifying business establishments for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. See the NAICS Codes lookup endpoint for values.
     */
    naicsCodes?: string
    /**
     * Minimum annual revenue for a company in U.S. dollars. Use with revenueMax to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.
     */
    revenueMin?: number
    /**
     * Maximum annual revenue for a company in U.S. dollars. Use with revenueMin to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.
     */
    revenueMax?: number
    /**
     * Annual revenue range in U.S. dollars. Accepts a comma-separated list of values. See the Revenue Range lookup endpoint for values. Alternatively, to get more granular ranges, you can use the revenueMin and revenueMax parameters.
     */
    revenue?: string
    /**
     * Minimum employee count for a company. Use with employeeRangeMax to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.
     */
    employeeRangeMin?: string
    /**
     * Maximum employee count for a company. Use with employeeRangeMin to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.
     */
    employeeRangeMax?: string
    /**
     * Employee count range. Accepts a comma-separated list of values. See the Employee Count lookup endpoint for values. Alternatively, to get more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters.
     */
    employeeCount?: string
    /**
     * Company ranking list (e.g., Fortune 500 and so on). See the Company Ranking lookup endpoint for values.
     */
    companyRanking?: string
    /**
     * Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.
     */
    metroRegion?: string
    /**
     * Location criteria for search. Values are PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ.
     */
    locationSearchType?: string
    /**
     * Minimum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMin is used without fundingAmountMax, the result will be the amount specified or greater.
     */
    fundingAmountMin?: number
    /**
     * Maximum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMax is used without fundingAmountMin, the result will be the amount specified or less.
     */
    fundingAmountMax?: number
    /**
     * Start date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.
     */
    fundingStartDate?: string
    /**
     * End date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.
     */
    fundingEndDate?: string
    /**
     * Exclude a company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.
     */
    excludedRegions?: string
    /**
     * Minimum number of ZoomInfo contacts associated with company
     */
    zoominfoContactsMin?: string
    /**
     * Maximum number of ZoomInfo contacts associated with company
     */
    zoominfoContactsMax?: string
    /**
     * Company hierarchical structure
     */
    companyStructureIncludedSubUnitTypes?: string
    /**
     * Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range.
     */
    oneYearEmployeeGrowthRateMin?: string
    /**
     * Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range.
     */
    oneYearEmployeeGrowthRateMax?: string
    /**
     * Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range.
     */
    twoYearEmployeeGrowthRateMin?: string
    /**
     * Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range.
     */
    twoYearEmployeeGrowthRateMax?: string
    /**
     * Minimum date for when a contact began current employment. Use with positionStartDateMax to set a range.
     */
    positionStartDateMin?: string
    /**
     * Maximum date for when a contact began current employment. Use with positionStartDateMin to set a range.
     */
    positionStartDateMax?: string
    /**
     * List of web references for a contact. Default criteria is OR between multiple values. Should only contain english letters and numbers.
     */
    webReferences?: string[]
    /**
     * Boolean flag for Buying Committee. Setting this to TRUE will filter the results based on the Buying Committees set for the account. Default is FALSE.
     */
    filterByBuyingCommittee?: boolean
    /**
     * List of technology skills for a contact. Default criteria is OR between multiple values. Should only contain string numbers
     */
    techSkills?: string[]
    /**
     * Years of overall experience. Must be a comma-separated string of values. See the Years of Experience lookup endpoint for values.
     */
    yearsOfExperience?: string
    /**
     * Engagement start date in YYYY-MM-DD format.
     */
    engagementStartDate?: string
    /**
     * Engagement end date in YYYY-MM-DD format. EngagementStartDate is required.
     */
    engagementEndDate?: string
    /**
     * List of engagement types to search for. Accepted values are a list of email, phone, online meeting.
     */
    engagementType?: string[]
  }

  export interface SearchCompaniesOptions {
    /**
     * Limits the results returned to the given number of results per page. Default is 25.
     */
    rpp?: number
    /**
     * Provides the results for the given page, used in conjunction with rpp
     */
    page?: number
    /**
     * Provide sortBy if specifying sortOrder. Valid values are asc, ascending, desc, and descending. By default, results are sorted in descending order.
     */
    sortOrder?: string
    /**
     * Sort results by valid output fields: name, employeeCount, revenue
     */
    sortBy?: string
    /**
     * ZoomInfo unique identifier for the company. Will accept-comma-separated list.
     */
    companyId?: string
    /**
     * Company name
     */
    companyName?: string
    /**
     * URL to the company website in http://www.example.com format
     */
    companyWebsite?: string
    /**
     * Text description unique to the company you want to use as search criteria
     */
    companyDescription?: string
    /**
     * ZoomInfo Company ID for parent company
     */
    parentId?: string
    /**
     * ZoomInfo Company ID for ultimate parent company
     */
    ultimateParentId?: string
    /**
     * Company stock ticker symbol
     */
    companyTicker?: string[]
    /**
     * Company type (private, public, and so on). See the Company Type lookup endpoint for values.
     */
    companyType?: string
    /**
     * Search using Business Model (B2C, B2B, B2G) for a company. Default is All
     */
    businessModel?: string[]
    /**
     * Company address
     */
    address?: string
    /**
     * Company street
     */
    street?: string
    /**
     * Company state (U.S.) or province (Canada). You can use free text state or province names (e.g., "new hampshire"), the two-letter common abbreviation for a U.S. state (e.g., "nh"), or values provided in the State lookup endpoint. Do not use state in conjunction with country in a search request, as the system uses OR logic between these two fields. If both are included in the request, the returned results will reflect all states.
     */
    state?: string
    /**
     * Zip Code of the company's primary address.
     */
    zipCode?: string
    /**
     * Country for the company's primary address. You can use free text or see the Country lookup endpoint for values. Do not use country in conjunction with state in a search request, as the system uses OR logic between these two fields. If both are included in the request, the returned results will reflect all states.
     */
    country?: string
    /**
     * Continent for the company's primary address. See the Continent lookup endpoint for values.
     */
    continent?: string
    /**
     * Used in conjunction with zipCode, designates a geographical radius (in miles) from the zipCode provided.
     */
    zipCodeRadiusMiles?: string
    /**
     * Hash tags for a company. Can include a comma-separated list.
     */
    hashTagString?: string
    /**
     * Specify technology product tags. See the Tech - Product lookup endpoint for values. This string uses a numerical dot notation format similar to an IP address. The notation denotes the hierarchical structure: parent-category.category.vendor. For example, 333.202.28. You can use wildcards in the notation (e.g., 333.202.\\\\*, \\\\*.202.\\\\*, and so on).
     */
    techAttributeTagList?: string
    /**
     * Company sub types (e.g., division, subsidiary and so on). See the Sub Unit Type lookup endpoint for values.
     */
    subUnitTypes?: string
    /**
     * Used in conjunction with the industryCodes input parameter. When set to true, any result returned must have one of the specified industries as a primary industry. If no industries are specified, then this parameter will be ignored. Default is false.
     */
    primaryIndustriesOnly?: boolean
    /**
     * Top-level Industry that the contact works in. A contact can have multiple top level industries. Tags are based on the contact's current company. Can include a comma-separated list. See the Industry Codes lookup endpoint for values.
     */
    industryCodes?: string
    /**
     * Industry keywords associated with a company. Can include either 'AND' or 'OR' operators. For example, 'software AND security' or 'software OR security'.
     */
    industryKeywords?: string
    /**
     * The Standard Industrial Classification is a system for classifying industries by a four-digit code. See the SIC Codes lookup endpoint for values.
     */
    sicCodes?: string
    /**
     * The North American Industry Classification System (NAICS) is the standard used by Federal statistical agencies in classifying business establishments for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. See the NAICS Codes lookup endpoint for values.
     */
    naicsCodes?: string
    /**
     * Minimum annual revenue for a company in U.S. dollars. Use with revenueMax to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.
     */
    revenueMin?: number
    /**
     * Maximum annual revenue for a company in U.S. dollars. Use with revenueMin to set a range. Alternatively, you can use the revenue parameter to search for pre-defined ranges.
     */
    revenueMax?: number
    /**
     * Annual revenue range in U.S. dollars. Accepts a comma-separated list of values. See the Revenue Range lookup endpoint for values. Alternatively, to get more granular ranges, you can use the revenueMin and revenueMax parameters.
     */
    revenue?: string
    /**
     * Minimum employee count for a company. Use with employeeRangeMax to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.
     */
    employeeRangeMin?: string
    /**
     * Maximum employee count for a company. Use with employeeRangeMin to set a range. Alternatively, you can use the employeeCount parameter to search for pre-defined ranges.
     */
    employeeRangeMax?: string
    /**
     * Employee count range. Accepts a comma-separated list of values. See the Employee Count lookup endpoint for values. Alternatively, to get more granular ranges, you can use the employeeRangeMin and employeeRangeMax parameters.
     */
    employeeCount?: string
    /**
     * Company ranking list (e.g., Fortune 500 and so on). See the Company Ranking lookup endpoint for values.
     */
    companyRanking?: string
    /**
     * Company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.
     */
    metroRegion?: string
    /**
     * Location criteria for search. Values are PersonOrHQ, PersonAndHQ, Person, HQ, PersonThenHQ.
     */
    locationSearchType?: string
    /**
     * Minimum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMin is used without fundingAmountMax, the result will be the amount specified or greater.
     */
    fundingAmountMin?: number
    /**
     * Maximum funding amount in thousands (e.g., 1 = 1000, 500 = 500,000). If fundingAmountMax is used without fundingAmountMin, the result will be the amount specified or less.
     */
    fundingAmountMax?: number
    /**
     * Start date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.
     */
    fundingStartDate?: string
    /**
     * End date of the funding in YYYY-MM-DD format. If fundingStartDate and fundingEndDate are both specified, they will be used as a range. Start date after end date returns an error. If start date and end date are the same, will return results for exact date.
     */
    fundingEndDate?: string
    /**
     * Exclude a company metro area. Accepts a comma-separated list of U.S. and Canada metro areas. See the Metro Area lookup endpoint for values.
     */
    excludedRegions?: string
    /**
     * Minimum number of ZoomInfo contacts associated with company
     */
    zoominfoContactsMin?: string
    /**
     * Maximum number of ZoomInfo contacts associated with company
     */
    zoominfoContactsMax?: string
    /**
     * Company hierarchical structure
     */
    companyStructureIncludedSubUnitTypes?: string
    /**
     * Denotes if ZoomInfo's research and data team has confirmed activity within the past 12 months
     */
    certified?: number
    /**
     * Include or exclude defunct companies. The default value is false.
     */
    excludeDefunctCompanies?: boolean
    /**
     * Minimum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMax to set a range.
     */
    oneYearEmployeeGrowthRateMin?: string
    /**
     * Maximum one year employee growth rate for a company. Use with oneYearEmployeeGrowthRateMin to set a range.
     */
    oneYearEmployeeGrowthRateMax?: string
    /**
     * Minimum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMax to set a range.
     */
    twoYearEmployeeGrowthRateMin?: string
    /**
     * Maximum two year employee growth rate for a company. Use with twoYearEmployeeGrowthRateMin to set a range.
     */
    twoYearEmployeeGrowthRateMax?: string
    /**
     * Engagement start date in YYYY-MM-DD format.
     */
    engagementStartDate?: string
    /**
     * Engagement end date in YYYY-MM-DD format. EngagementStartDate is required.
     */
    engagementEndDate?: string
    /**
     * List of engagement types to search for. Accepted values are a list of email, phone, online meeting.
     */
    engagementType?: string[]
  }

  export interface SearchResult<T> {
    maxResults: number
    totalResults: number
    currentPage: number
    data: T[]
  }

  export type SearchContactsResponse = SearchResult<ContactSearchResult>
  export type SearchCompaniesResponse = SearchResult<CompanySearchResult>

  export interface ContactSearchResult {
    id: number
    firstName: string
    middleName: string
    lastName: string
    validDate: string
    lastUpdatedDate: string
    jobTitle: string
    contactAccuracyScore: number
    hasEmail: boolean
    hasSupplementalEmail: boolean
    hasDirectPhone: boolean
    hasMobilePhone: boolean
    hasCompanyIndustry: boolean
    hasCompanyPhone: boolean
    hasCompanyStreet: boolean
    hasCompanyState: boolean
    hasCompanyZipCode: boolean
    hasCompanyCountry: boolean
    hasCompanyRevenue: boolean
    hasCompanyEmployeeCount: boolean
    company: CompanySearchResult
  }

  export interface CompanySearchResult {
    id: number
    name: string
  }

  export const defaultEnrichContactOutputFields = [
    'id',
    'firstName',
    'middleName',
    'lastName',
    'email',
    'hasCanadianEmail',
    'phone',
    'directPhoneDoNotCall',
    'street',
    'city',
    'region',
    'metroArea',
    'zipCode',
    'state',
    'country',
    'personHasMoved',
    'withinEu',
    'withinCalifornia',
    'withinCanada',
    'lastUpdatedDate',
    'noticeProvidedDate',
    'salutation',
    'suffix',
    'jobTitle',
    'jobFunction',
    'companyDivision',
    'education',
    'hashedEmails',
    'picture',
    'mobilePhoneDoNotCall',
    'externalUrls',
    'companyId',
    'companyName',
    'companyDescriptionList',
    'companyPhone',
    'companyFax',
    'companyStreet',
    'companyCity',
    'companyState',
    'companyZipCode',
    'companyCountry',
    'companyLogo',
    'companySicCodes',
    'companyNaicsCodes',
    'contactAccuracyScore',
    'companyWebsite',
    'companyRevenue',
    'companyRevenueNumeric',
    'companyEmployeeCount',
    'companyType',
    'companyTicker',
    'companyRanking',
    'isDefunct',
    'companySocialMediaUrls',
    'companyPrimaryIndustry',
    'companyIndustries',
    'companyRevenueRange',
    'companyEmployeeRange',
    'employmentHistory',
    'managementLevel',
    'locationCompanyId'
  ] as const

  export const defaultEnrichCompanyOutputFields = [
    'id',
    'name',
    'website',
    'domainList',
    'logo',
    'ticker',
    'revenue',
    'socialMediaUrls',
    'employeeCount',
    'numberOfContactsInZoomInfo',
    'phone',
    'fax',
    'street',
    'city',
    'state',
    'zipCode',
    'country',
    'continent',
    'companyStatus',
    'companyStatusDate',
    'descriptionList',
    'sicCodes',
    'naicsCodes',
    'competitors',
    'ultimateParentId',
    'ultimateParentName',
    'ultimateParentRevenue',
    'ultimateParentEmployees',
    'subUnitCodes',
    'subUnitType',
    'subUnitIndustries',
    'primaryIndustry',
    'industries',
    'parentId',
    'parentName',
    'locationCount',
    'metroArea',
    'lastUpdatedDate',
    'createdDate',
    'certificationDate',
    'certified',
    'hashtags',
    'products',
    'techAttributes',
    'revenueRange',
    'employeeRange',
    'companyFunding',
    'recentFundingAmount',
    'recentFundingDate',
    'totalFundingAmount',
    'employeeGrowth'
  ] as const

  export interface UsageResponse {
    usage: Usage[]
  }

  export interface Usage {
    limitType: string
    description: string
    limit: number
    currentUsage: number
    usageRemaining: number
  }
}

/**
 * ZoomInfo is a robust B2B enrichment and search API for people and companies.
 *
 * @see https://api-docs.zoominfo.com
 * @see https://tech-docs.zoominfo.com/enterprise-api-getting-started-guide.pdf
 */
export class ZoomInfoClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiBaseUrl: string

  protected readonly username: string
  protected readonly password: string | undefined
  protected readonly clientId: string | undefined
  protected readonly privateKey: string | undefined

  protected accessToken: string | undefined
  protected accessTokenDateMS: number | undefined

  constructor({
    username = getEnv('ZOOMINFO_USERNAME'),
    password = getEnv('ZOOMINFO_PASSWORD'),
    clientId = getEnv('ZOOMINFO_CLIENT_ID'),
    privateKey = getEnv('ZOOMINFO_PRIVATE_KEY'),
    apiBaseUrl = zoominfo.API_BASE_URL,
    timeoutMs = 60_000,
    throttle = true,
    ky = defaultKy
  }: {
    username?: string
    password?: string
    clientId?: string
    privateKey?: string
    apiBaseUrl?: string
    apiKnowledgeGraphBaseUrl?: string
    timeoutMs?: number
    throttle?: boolean
    ky?: KyInstance
  } = {}) {
    assert(
      username,
      `ZoomInfoClient missing required "username" (defaults to "ZOOMINFO_USERNAME")`
    )
    assert(
      password || (clientId && privateKey),
      `ZoomInfoClient missing required "password" for basic auth or "clientId" and "privateKey" for PKI auth (defaults to "ZOOMINFO_PASSWORD", "ZOOMINFO_CLIENT_ID", and "ZOOMINFO_PRIVATE_KEY")`
    )
    super()

    this.username = username
    this.password = password
    this.clientId = clientId
    this.privateKey = privateKey

    this.apiBaseUrl = apiBaseUrl

    const throttledKy = throttle ? throttleKy(ky, zoominfo.throttle) : ky

    this.ky = throttledKy.extend({
      prefixUrl: apiBaseUrl,
      timeout: timeoutMs
    })
  }

  /**
   * Attempts to authenticate with ZoomInfo using the provided credentials
   * (either basic auth or PKI auth). If there's already a valid access token,
   * then it will be reused unless `force` is set to `true`.
   *
   * NOTE: All API methods call this internally, so there is no reason to call
   * this yourself unless you need to force a re-authentication.
   */
  async authenticate({
    force = false
  }: { force?: boolean } = {}): Promise<void> {
    if (
      !force &&
      this.accessToken &&
      this.accessTokenDateMS! + zoominfo.ACCESS_TOKEN_EXPIRATION_MS > Date.now()
    ) {
      // Access token is still valid.
      return
    }

    if (this.username && this.password) {
      this.accessTokenDateMS = Date.now()
      this.accessToken = await this.getAccessTokenViaBasicAuth({
        username: this.username,
        password: this.password
      })

      assert(
        this.accessToken,
        'ZoomInfo failed to get access token via basic auth'
      )
      return
    }

    if (this.username && this.clientId && this.privateKey) {
      this.accessTokenDateMS = Date.now()
      this.accessToken = await this.getAccessTokenViaPKI({
        username: this.username,
        clientId: this.clientId,
        privateKey: this.privateKey
      })

      assert(
        this.accessToken,
        'ZoomInfo failed to get access token via PKI auth'
      )
      return
    }

    throw new Error(
      'ZoomInfoClient missing required authentication credentials'
    )
  }

  /**
   * This method is used internally and should not be called directly except
   * for advanced use cases.
   */
  async getAccessTokenViaBasicAuth({
    username,
    password
  }: {
    username: string
    password: string
  }): Promise<string> {
    const res = await this.ky
      .post('authenticate', {
        json: {
          username,
          password
        },
        headers: {
          'cache-control': 'no-cache'
        }
      })
      .json<{ jwt: string }>()

    return res.jwt
  }

  /**
   * This method is used internally and should not be called directly except
   * for advanced use cases.
   */
  async getAccessTokenViaPKI({
    username,
    clientId,
    privateKey
  }: {
    username: string
    clientId: string
    privateKey: string
  }): Promise<string> {
    const dtNow = Date.now()
    const header = {
      typ: 'JWT',
      alg: 'RS256'
    }
    const data = {
      aud: 'enterprise_api',
      iss: 'api-client@zoominfo.com',
      username,
      client_id: clientId,
      iat: getIAT(dtNow),
      exp: getEXP(dtNow)
    }
    const sHeader = JSON.stringify(header)
    const sPayload = JSON.stringify(data)

    const clientJWT = KJUR.jws.JWS.sign(
      header.alg,
      sHeader,
      sPayload,
      privateKey
    )

    const res = await this.ky
      .post('authenticate', {
        json: {},
        headers: {
          Authorization: `Bearer ${clientJWT}`,
          'cache-control': 'no-cache'
        }
      })
      .json<{ jwt: string }>()

    return res.jwt
  }

  /**
   * Attempts to enrich a person contact with ZoomInfo data
   */
  @aiFunction({
    name: 'zoominfo_enrich_contact',
    description: `Attempts to enrich a person contact with ZoomInfo data. To match a contact, you must use one of the following combinations of parameters to construct your input:

personId OR emailAddress OR hashedEmail OR phone. Because these values are unique to a single person, you can use any one of these values to search without providing any additional parameters. You can optionally combine one of these values with a companyId/companyName.

firstName AND lastName AND companyId/companyName. Combining these values effectively results in a unique person.

fullName AND companyId/companyName. Combining these values effectively results in a unique person.`,
    inputSchema: z.object({
      firstName: z.string().optional().describe('First name of the person.'),
      lastName: z.string().optional().describe('Last name of the person.'),
      companyId: z
        .string()
        .optional()
        .describe("Unique ZoomInfo identifier of the person's company."),
      companyName: z
        .string()
        .optional()
        .describe(
          'Name of the company where the contact works, or has worked.'
        ),
      personId: z
        .string()
        .optional()
        .describe('Unique ZoomInfo identifier of the person.'),
      emailAddress: z.string().optional(),
      hashedEmail: z.string().optional(),
      phone: z.string().optional(),
      fullName: z.string().optional(),
      jobTitle: z.string().optional(),
      externalURL: z.string().optional(),
      lastUpdatedDateAfter: z.string().optional(),
      validDateAfter: z.string().optional(),
      contactAccuracyScoreMin: z.number().optional(),
      outputFields: z.array(z.string()).optional()
    })
  })
  async enrichContact(opts: zoominfo.EnrichContactOptions) {
    await this.authenticate()

    const {
      outputFields = zoominfo.defaultEnrichContactOutputFields,
      ...matchPersonInput
    } = opts

    return this.ky
      .post('enrich/contact', {
        json: {
          matchPersonInput: [matchPersonInput],
          outputFields
        },
        headers: {
          Authorization: `Bearer ${this.accessToken}`
        }
      })
      .json<zoominfo.EnrichContactResponse>()
  }

  /**
   * Attempts to enrich a company with ZoomInfo data.
   */
  @aiFunction({
    name: 'zoominfo_enrich_company',
    description:
      'Attempts to enrich a company with ZoomInfo data. To match a company, you should ideally provide the `companyName` and `companyWebsite`.',
    inputSchema: z.object({
      companyId: z
        .string()
        .optional()
        .describe('Unique ZoomInfo identifier of company.'),
      companyName: z.string().optional().describe('Name of the company.'),
      companyWebsite: z.string().optional(),
      companyTicker: z.string().optional(),
      companyPhone: z.string().optional(),
      companyFax: z.string().optional(),
      companyStreet: z.string().optional(),
      companyCity: z.string().optional(),
      companyState: z.string().optional(),
      companyZipCode: z.string().optional(),
      companyCountry: z.string().optional(),
      ipAddress: z.string().optional(),
      outputFields: z.array(z.string()).optional()
    })
  })
  async enrichCompany(opts: zoominfo.EnrichCompanyOptions) {
    await this.authenticate()

    const {
      outputFields = zoominfo.defaultEnrichCompanyOutputFields,
      ...matchCompanyInput
    } = opts

    return this.ky
      .post('enrich/company', {
        json: {
          matchCompanyInput: [matchCompanyInput],
          outputFields
        },
        headers: {
          Authorization: `Bearer ${this.accessToken}`
        }
      })
      .json<zoominfo.EnrichCompanyResponse>()
  }

  /**
   * Returns a list of Contacts from ZoomInfo's data that meet the specified
   * search criteria.
   */
  @aiFunction({
    name: 'zoominfo_search_contacts',
    description:
      "Returns a list of Contacts from ZoomInfo's data that meet the specified search criteria.",
    inputSchema: z.object({
      rpp: z.number().optional(),
      page: z.number().optional(),
      sortOrder: z.string().optional(),
      sortBy: z.string().optional(),
      personId: z.string().optional(),
      emailAddress: z.string().optional(),
      supplementalEmail: z.array(z.string()).optional(),
      hashedEmail: z.string().optional(),
      phone: z.array(z.string()).optional(),
      fullName: z.string().optional(),
      firstName: z.string().optional(),
      middleInitial: z.string().optional(),
      lastName: z.string().optional(),
      jobTitle: z.string().optional(),
      excludeJobTitle: z.string().optional(),
      managementLevel: z.string().optional(),
      excludeManagementLevel: z.string().optional(),
      department: z.string().optional(),
      boardMember: z.string().optional(),
      excludePartialProfiles: z.boolean().optional(),
      executivesOnly: z.boolean().optional(),
      requiredFields: z.string().optional(),
      contactAccuracyScoreMin: z.string().optional(),
      contactAccuracyScoreMax: z.string().optional(),
      jobFunction: z.string().optional(),
      lastUpdatedDateAfter: z.string().optional(),
      validDateAfter: z.string().optional(),
      lastUpdatedInMonths: z.number().optional(),
      hasBeenNotified: z.string().optional(),
      companyPastOrPresent: z.string().optional(),
      school: z.string().optional(),
      degree: z.string().optional(),
      locationCompanyId: z.array(z.string()).optional(),
      companyId: z.string().optional(),
      companyName: z.string().optional(),
      companyWebsite: z.string().optional(),
      companyTicker: z.array(z.string()).optional(),
      companyDescription: z.string().optional(),
      parentId: z.string().optional(),
      ultimateParentId: z.string().optional(),
      companyType: z.string().optional(),
      address: z.string().optional(),
      street: z.string().optional(),
      state: z.string().optional(),
      zipCode: z.string().optional(),
      country: z.string().optional(),
      continent: z.string().optional(),
      zipCodeRadiusMiles: z.string().optional(),
      hashTagString: z.string().optional(),
      techAttributeTagList: z.string().optional(),
      subUnitTypes: z.string().optional(),
      primaryIndustriesOnly: z.boolean().optional(),
      industryCodes: z.string().optional(),
      industryKeywords: z.string().optional(),
      sicCodes: z.string().optional(),
      naicsCodes: z.string().optional(),
      revenueMin: z.number().optional(),
      revenueMax: z.number().optional(),
      revenue: z.string().optional(),
      employeeRangeMin: z.string().optional(),
      employeeRangeMax: z.string().optional(),
      employeeCount: z.string().optional(),
      companyRanking: z.string().optional(),
      metroRegion: z.string().optional(),
      locationSearchType: z.string().optional(),
      fundingAmountMin: z.number().optional(),
      fundingAmountMax: z.number().optional(),
      fundingStartDate: z.string().optional(),
      fundingEndDate: z.string().optional(),
      excludedRegions: z.string().optional(),
      zoominfoContactsMin: z.string().optional(),
      zoominfoContactsMax: z.string().optional(),
      companyStructureIncludedSubUnitTypes: z.string().optional(),
      oneYearEmployeeGrowthRateMin: z.string().optional(),
      oneYearEmployeeGrowthRateMax: z.string().optional(),
      twoYearEmployeeGrowthRateMin: z.string().optional(),
      twoYearEmployeeGrowthRateMax: z.string().optional(),
      positionStartDateMin: z.string().optional(),
      positionStartDateMax: z.string().optional(),
      webReferences: z.array(z.string()).optional(),
      filterByBuyingCommittee: z.boolean().optional(),
      techSkills: z.array(z.string()).optional(),
      yearsOfExperience: z.string().optional(),
      engagementStartDate: z.string().optional(),
      engagementEndDate: z.string().optional(),
      engagementType: z.array(z.string()).optional()
    })
  })
  async searchContacts(opts: zoominfo.SearchContactsOptions) {
    await this.authenticate()

    return this.ky
      .post('search/contact', {
        json: opts,
        headers: {
          Authorization: `Bearer ${this.accessToken}`
        }
      })
      .json<zoominfo.SearchContactsResponse>()
  }

  /**
   * Returns a list of Companies from ZoomInfo's data which meet the specified
   * search criteria.
   */
  @aiFunction({
    name: 'zoominfo_search_companies',
    description:
      "Returns a list of Companies from ZoomInfo's data that meet the specified search criteria.",
    inputSchema: z.object({
      rpp: z.number().optional(),
      page: z.number().optional(),
      sortOrder: z.string().optional(),
      sortBy: z.string().optional(),
      companyId: z.string().optional(),
      companyName: z.string().optional(),
      companyWebsite: z.string().optional(),
      companyDescription: z.string().optional(),
      parentId: z.string().optional(),
      ultimateParentId: z.string().optional(),
      companyTicker: z.array(z.string()).optional(),
      companyType: z.string().optional(),
      businessModel: z.array(z.string()).optional(),
      address: z.string().optional(),
      street: z.string().optional(),
      state: z.string().optional(),
      zipCode: z.string().optional(),
      country: z.string().optional(),
      continent: z.string().optional(),
      zipCodeRadiusMiles: z.string().optional(),
      hashTagString: z.string().optional(),
      techAttributeTagList: z.string().optional(),
      subUnitTypes: z.string().optional(),
      primaryIndustriesOnly: z.boolean().optional(),
      industryCodes: z.string().optional(),
      industryKeywords: z.string().optional(),
      sicCodes: z.string().optional(),
      naicsCodes: z.string().optional(),
      revenueMin: z.number().optional(),
      revenueMax: z.number().optional(),
      revenue: z.string().optional(),
      employeeRangeMin: z.string().optional(),
      employeeRangeMax: z.string().optional(),
      employeeCount: z.string().optional(),
      companyRanking: z.string().optional(),
      metroRegion: z.string().optional(),
      locationSearchType: z.string().optional(),
      fundingAmountMin: z.number().optional(),
      fundingAmountMax: z.number().optional(),
      fundingStartDate: z.string().optional(),
      fundingEndDate: z.string().optional(),
      excludedRegions: z.string().optional(),
      zoominfoContactsMin: z.string().optional(),
      zoominfoContactsMax: z.string().optional(),
      companyStructureIncludedSubUnitTypes: z.string().optional(),
      certified: z.number().optional(),
      excludeDefunctCompanies: z.boolean().optional(),
      oneYearEmployeeGrowthRateMin: z.string().optional(),
      oneYearEmployeeGrowthRateMax: z.string().optional(),
      twoYearEmployeeGrowthRateMin: z.string().optional(),
      twoYearEmployeeGrowthRateMax: z.string().optional(),
      engagementStartDate: z.string().optional(),
      engagementEndDate: z.string().optional(),
      engagementType: z.array(z.string()).optional()
    })
  })
  async searchCompanies(opts: zoominfo.SearchCompaniesOptions) {
    await this.authenticate()

    return this.ky
      .post('search/company', {
        json: opts,
        headers: {
          Authorization: `Bearer ${this.accessToken}`
        }
      })
      .json<zoominfo.SearchCompaniesResponse>()
  }

  /**
   * Retrieve current usage stats and available data depending on your
   * ZoomInfo plan.
   */
  @aiFunction({
    name: 'zoominfo_get_usage',
    description:
      'Retrieves current usage stats for available data depending on your ZoomInfo plan.',
    inputSchema: z.object({})
  })
  async getUsage() {
    await this.authenticate()

    return this.ky
      .get('lookup/usage', {
        headers: {
          Authorization: `Bearer ${this.accessToken}`,
          'cache-control': 'no-cache'
        }
      })
      .json<zoominfo.UsageResponse>()
  }
}

function getIAT(dtNow: number) {
  const iat = Math.floor(dtNow / 1000)
  return iat - 60
}

function getEXP(dtNow: number) {
  const exp = Math.floor(dtNow / 1000) + 5 * 60
  return exp - 60
}


================================================
FILE: legacy/packages/zoominfo/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/pnpm-workspace.yaml
================================================
packages:
  - packages/*
  - examples/*

catalog:
  '@ai-sdk/openai': ^1.3.22
  '@apidevtools/swagger-parser': ^10.1.1
  '@dexaai/dexter': ^4.1.1
  '@e2b/code-interpreter': ^1.5.1
  '@fisch0920/config': ^1.1.4
  '@googleapis/customsearch': ^4.0.1
  '@langchain/core': ^0.3.60
  '@langchain/openai': ^0.5.14
  '@llamaindex/openai': ^0.4.4
  '@llamaindex/workflow': ^1.1.9
  '@mastra/core': ^0.10.6
  '@modelcontextprotocol/sdk': ^1.13.0
  '@nangohq/node': 0.42.22
  '@types/jsrsasign': ^10.5.15
  '@types/node': ^24.0.4
  '@xsai/tool': ^0.3.0-beta.4
  ai: ^4.3.16
  bumpp: ^10.2.0
  camelcase: ^8.0.0
  cleye: ^1.3.4
  decamelize: ^6.0.0
  dedent: ^1.6.0
  del-cli: ^6.0.0
  delay: ^6.0.0
  dotenv: ^16.5.0
  duck-duck-scrape: ^2.2.7
  eslint: ^9.29.0
  execa: ^9.6.0
  exit-hook: ^4.0.0
  fast-xml-parser: ^5.2.5
  genkit: ^1.13.0
  genkitx-openai: ^0.22.3
  google-auth-library: ^9.15.1
  googleapis: ^150.0.1
  json-schema-to-zod: ^2.6.1
  jsonrepair: ^3.12.0
  jsrsasign: ^10.9.0
  ky: ^1.8.1
  langchain: ^0.3.29
  lint-staged: ^16.1.2
  llamaindex: ^0.11.8
  mathjs: ^13.2.3
  npm-run-all2: ^8.0.4
  octokit: ^5.0.3
  only-allow: ^1.2.1
  openai: ^5.5.1
  openai-fetch: ^3.4.2
  openai-zod-to-json-schema: ^1.0.3
  openapi-types: ^12.1.3
  p-map: ^7.0.3
  p-throttle: 6.2.0
  prettier: ^3.6.0
  restore-cursor: ^5.1.0
  simple-git-hooks: ^2.13.0
  string-strip-html: ^13.4.12
  syncpack: 14.0.0-alpha.10
  tsup: ^8.5.0
  tsx: ^4.20.3
  turbo: ^2.5.4
  twitter-api-sdk: ^1.2.1
  type-fest: ^4.41.0
  typescript: ^5.8.3
  vitest: ^3.2.4
  wikibase-sdk: ^10.2.3
  xsai: ^0.3.0-beta.4
  zod: ^3.25.67
  zod-validation-error: ^3.5.2
  zoominfo-api-auth-client: ^1.0.1

ignoredBuiltDependencies:
  - '@fisch0920/config'

updateConfig:
  ignoreDependencies:
    - p-throttle
    - '@nangohq/node'


================================================
FILE: legacy/readme.md
================================================
> [!IMPORTANT]
> (_June 28, 2025_) As part of an upcoming major Agentic 2.0 release, our site and docs will be undergoing breaking changes over the next few days. Please be patient if the site / docs don't load correctly until the transition is complete. Thank you && really excited to share more about Agentic's new direction soon!! 🙏

<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="/docs/media/agentic-header.jpg" width="308">
  </a>
</p>

<p align="center">
  <em>AI agent stdlib that works with any LLM and TypeScript AI SDK.</em>
</p>

<p align="center">
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/stdlib"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/stdlib.svg" /></a>
  <a href="https://github.com/transitive-bullshit/agentic/blob/main/license"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# Agentic <!-- omit from toc -->

- [Intro](#intro)
  - [Using Multiple Tools](#using-multiple-tools)
- [Features](#features)
- [Docs](#docs)
- [AI SDKs](#ai-sdks)
  - [Vercel AI SDK](#vercel-ai-sdk)
  - [Mastra](#mastra)
  - [LangChain](#langchain)
  - [LlamaIndex](#llamaindex)
  - [Firebase Genkit](#firebase-genkit)
  - [Dexa Dexter](#dexa-dexter)
  - [OpenAI](#openai)
  - [GenAIScript](#genaiscript)
  - [xsAI SDK](#xsai-sdk)
- [Tools](#tools)
- [Contributors](#contributors)
- [License](#license)

## Intro

Agentic is a **standard library of AI functions / tools** which are **optimized for both normal TS-usage as well as LLM-based usage**. Agentic works with all of the major TS AI SDKs (Vercel AI SDK, Mastra, LangChain, LlamaIndex, OpenAI SDK, MCP, etc).

Agentic clients like `WeatherClient` can be used as normal TS classes:

```ts
import { WeatherClient } from '@agentic/stdlib'

// Requires `process.env.WEATHER_API_KEY` (free from weatherapi.com)
const weather = new WeatherClient()

const result = await weather.getCurrentWeather({
  q: 'San Francisco'
})
console.log(result)
```

Or you can use these clients as **LLM-based tools**. Here's an example using [Vercel's AI SDK](https://github.com/vercel/ai):

```ts
// sdk-specific imports
import { openai } from '@ai-sdk/openai'
import { generateText } from 'ai'
import { createAISDKTools } from '@agentic/ai-sdk'

// sdk-agnostic imports
import { WeatherClient } from '@agentic/stdlib'

const weather = new WeatherClient()

const result = await generateText({
  model: openai('gpt-4o-mini'),
  // this is the key line which uses the `@agentic/ai-sdk` adapter
  tools: createAISDKTools(weather),
  toolChoice: 'required',
  prompt: 'What is the weather in San Francisco?'
})

console.log(result.toolResults[0])
```

You can use our standard library of thoroughly tested AI functions with your favorite AI SDK – without having to write any glue code!

### Using Multiple Tools

All adapters (like `createAISDKTools`) accept a very flexible var args of `AIFunctionLike` parameters, so you can pass as many tools as you'd like.

They also expose a `.functions` property which is an `AIFunctionSet`. This combination makes it really easy to mix & match different tools together.

```ts
import { SerperClient, WikipediaClient, FirecrawlClient } from '@agentic/stdlib'
import { createAIFunction } from '@agentic/core'
import { z } from 'zod'

const googleSearch = new SerperClient()
const wikipedia = new WikipediaClient()
const firecrawl = new FirecrawlClient()

const result = await generateText({
  model: openai('gpt-4o-mini'),
  // This example uses tools from 4 different sources. You can pass as many
  // AIFunctionLike objects as you want.
  tools: createAISDKTools(
    googleSearch,
    wikipedia,
    // Pick a single function from the firecrawl client's set of AI functions
    firecrawl.functions.pick('firecrawl_search'),
    // Create a custom AI function (based off of Anthropic's think tool: https://www.anthropic.com/engineering/claude-think-tool)
    createAIFunction({
      name: 'think',
      description: `Use this tool to think about something. It will not obtain new information or change the database, but just append the thought to the log. Use it when complex reasoning or some cache memory is needed.`,
      inputSchema: z.object({
        thought: z.string().describe('A thought to think about.')
      }),
      execute: ({ thought }) => thought
    })
  ),
  prompt:
    'What year did Jurassic Park the movie come out, and what else happened that year?'
})
```

An `AIFunctionLike` can be any agentic client instance, a single `AIFunction` selected from the client's `.functions` property (which holds an `AIFunctionSet` of available AI functions), or an AI function created manually via `createAIFunction`.

`AIFunctionLike` and `AIFunctionSet` are implementation details that you likely won't have to touch directly, but they're important because of their flexibility.

## Features

- ✅ All tools are thoroughly tested in production
- ✅ Tools work across all leading TS AI SDKs
- ✅ Tools are hand-coded and extremely minimal
- ✅ Tools have both a good manual DX and LLM DX via the `@aiFunction` decorator
- ✅ Tools use native `fetch`
- ✅ Tools use [ky](https://github.com/sindresorhus/ky) to wrap `fetch`, so HTTP options, throttling, retries, etc are easy to customize
- ✅ Supports tools from any MCP server ([createMcpTools(...)](https://agentic.so/tools/mcp))
- ✅ Generate new Agentic tool clients from OpenAPI specs ([@agentic/openapi-to-ts](./packages/openapi-to-ts))
- ✅ 100% open source && not trying to sell you anything 💯

## Docs

Full docs are available at [agentic.so](https://agentic.so).

## AI SDKs

### Vercel AI SDK

[Agentic adapter docs for the Vercel AI SDK](https://agentic.so/sdks/ai-sdk)

### Mastra

[Agentic adapter docs for the Mastra AI Agent framework](https://agentic.so/sdks/mastra)

### LangChain

[Agentic adapter docs for LangChain](https://agentic.so/sdks/langchain)

### LlamaIndex

[Agentic adapter docs for LlamaIndex](https://agentic.so/sdks/llamaindex)

### Firebase Genkit

[Agentic adapter docs for Genkit](https://agentic.so/sdks/genkit)

### Dexa Dexter

[Agentic adapter docs for Dexter](https://agentic.so/sdks/dexter)

### OpenAI

[Agentic adapter docs for OpenAI](https://agentic.so/sdks/openai)

### GenAIScript

[Agentic support in GenAIScript](https://agentic.so/sdks/genaiscript)

### xsAI SDK

[Agentic adapter docs for the xsAI SDK](https://agentic.so/sdks/xsai)

## Tools

| Service / Tool                                                                  | Package                         | Docs                                                  | Description                                                                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------- | ------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Airtable](https://airtable.com/developers/web/api/introduction)                | `@agentic/airtable`             | [docs](https://agentic.so/tools/airtable)             | No-code spreadsheets, CRM, and database.                                                                                                                                                                                                                       |
| [Apollo](https://docs.apollo.io)                                                | `@agentic/apollo`               | [docs](https://agentic.so/tools/apollo)               | B2B person and company enrichment API.                                                                                                                                                                                                                         |
| [ArXiv](https://arxiv.org)                                                      | `@agentic/arxiv`                | [docs](https://agentic.so/tools/arxiv)                | Search for research articles.                                                                                                                                                                                                                                  |
| [Bing](https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)           | `@agentic/bing`                 | [docs](https://agentic.so/tools/bing)                 | Bing web search.                                                                                                                                                                                                                                               |
| [Brave Search](https://brave.com/search/api)                                    | `@agentic/brave-search`         | [docs](https://agentic.so/tools/brave-search)         | Brave web search and local places search.                                                                                                                                                                                                                      |
| [Calculator](https://github.com/josdejong/mathjs)                               | `@agentic/calculator`           | [docs](https://agentic.so/tools/calculator)           | Basic calculator for simple mathematical expressions.                                                                                                                                                                                                          |
| [Clearbit](https://dashboard.clearbit.com/docs)                                 | `@agentic/clearbit`             | [docs](https://agentic.so/tools/clearbit)             | Resolving and enriching people and company data.                                                                                                                                                                                                               |
| [Dexa](https://dexa.ai)                                                         | `@agentic/dexa`                 | [docs](https://agentic.so/tools/dexa)                 | Answers questions from the world's best podcasters.                                                                                                                                                                                                            |
| [Diffbot](https://docs.diffbot.com)                                             | `@agentic/diffbot`              | [docs](https://agentic.so/tools/diffbot)              | Web page classification and scraping; person and company data enrichment.                                                                                                                                                                                      |
| [DuckDuckGo](https://duckduckgo.com)                                            | `@agentic/duck-duck-go`         | [docs](https://agentic.so/tools/duck-duck-go)         | Privacy-focused web search API.                                                                                                                                                                                                                                |
| [E2B](https://e2b.dev)                                                          | `@agentic/e2b`                  | [docs](https://agentic.so/tools/e2b)                  | Hosted Python code interpreter sandbox which is really useful for data analysis, flexible code execution, and advanced reasoning on-the-fly.                                                                                                                   |
| [Exa](https://docs.exa.ai)                                                      | `@agentic/exa`                  | [docs](https://agentic.so/tools/exa)                  | Web search tailored for LLMs.                                                                                                                                                                                                                                  |
| [Firecrawl](https://www.firecrawl.dev)                                          | `@agentic/firecrawl`            | [docs](https://agentic.so/tools/firecrawl)            | Website scraping and structured data extraction.                                                                                                                                                                                                               |
| [Google Custom Search](https://developers.google.com/custom-search/v1/overview) | `@agentic/google-custom-search` | [docs](https://agentic.so/tools/google-custom-search) | Official Google Custom Search API.                                                                                                                                                                                                                             |
| [Google Drive](https://developers.google.com/workspace/drive/api)               | `@agentic/google-drive`         | [docs](https://agentic.so/tools/google-drive)         | Simplified Google Drive API.                                                                                                                                                                                                                                   |
| [Google Docs](https://developers.google.com/workspace/docs/api)                 | `@agentic/google-docs`          | [docs](https://agentic.so/tools/google-docs)          | Simplified Google Docs API.                                                                                                                                                                                                                                    |
| [Gravatar](https://docs.gravatar.com/api/profiles/rest-api/)                    | `@agentic/gravatar`             | [docs](https://agentic.so/tools/gravatar)             | Gravatar profile API.                                                                                                                                                                                                                                          |
| [HackerNews](https://github.com/HackerNews/API)                                 | `@agentic/hacker-news`          | [docs](https://agentic.so/tools/hacker-news)          | Official HackerNews API.                                                                                                                                                                                                                                       |
| [Hunter](https://hunter.io)                                                     | `@agentic/hunter`               | [docs](https://agentic.so/tools/hunter)               | Email finder, verifier, and enrichment.                                                                                                                                                                                                                        |
| [Jina](https://jina.ai/reader)                                                  | `@agentic/jina`                 | [docs](https://agentic.so/tools/jina)                 | URL scraper and web search.                                                                                                                                                                                                                                    |
| [LeadMagic](https://leadmagic.io)                                               | `@agentic/leadmagic`            | [docs](https://agentic.so/tools/leadmagic)            | B2B person, company, and email enrichment API.                                                                                                                                                                                                                 |
| [Midjourney](https://www.imagineapi.dev)                                        | `@agentic/midjourney`           | [docs](https://agentic.so/tools/midjourney)           | Unofficial Midjourney client for generative images.                                                                                                                                                                                                            |
| [McpTools](https://modelcontextprotocol.io)                                     | `@agentic/mcp`                  | [docs](https://agentic.so/tools/mcp)                  | Model Context Protocol (MCP) client, supporting any MCP server. Use [createMcpTools](https://agentic.so/tools/mcp) to spawn or connect to an MCP server.                                                                                                       |
| [Notion](https://developers.notion.com/docs)                                    | `@agentic/notion`               | [docs](https://agentic.so/tools/notion)               | Official Notion API for accessing pages, databases, and content.                                                                                                                                                                                               |
| [Novu](https://novu.co)                                                         | `@agentic/novu`                 | [docs](https://agentic.so/tools/novu)                 | Sending notifications (email, SMS, in-app, push, etc).                                                                                                                                                                                                         |
| [Open Meteo](https://open-meteo.com)                                            | `@agentic/open-meteo`           | [docs](https://agentic.so/tools/open-meteo)           | Free weather API (no API key required).                                                                                                                                                                                                                        |
| [People Data Labs](https://www.peopledatalabs.com)                              | `@agentic/people-data-labs`     | [docs](https://agentic.so/tools/people-data-labs)     | People & company data (WIP).                                                                                                                                                                                                                                   |
| [Perigon](https://www.goperigon.com/products/news-api)                          | `@agentic/perigon`              | [docs](https://agentic.so/tools/perigon)              | Real-time news API and web content data from 140,000+ sources. Structured and enriched by AI, primed for LLMs.                                                                                                                                                 |
| [Polygon](https://polygon.io)                                                   | `@agentic/polygon`              | [docs](https://agentic.so/tools/polygon)              | Stock market and company financial data.                                                                                                                                                                                                                       |
| [PredictLeads](https://predictleads.com)                                        | `@agentic/predict-leads`        | [docs](https://agentic.so/tools/predict-leads)        | In-depth company data including signals like fundraising events, hiring news, product launches, technologies used, etc.                                                                                                                                        |
| [Proxycurl](https://nubela.co/proxycurl)                                        | `@agentic/proxycurl`            | [docs](https://agentic.so/tools/proxycurl)            | People and company data from LinkedIn & Crunchbase.                                                                                                                                                                                                            |
| [Reddit](https://old.reddit.com/dev/api)                                        | `@agentic/reddit`               | [docs](https://agentic.so/tools/reddit)               | Basic readonly Reddit API for getting top/hot/new/rising posts from subreddits.                                                                                                                                                                                |
| [RocketReach](https://rocketreach.co/api/v2/docs)                               | `@agentic/rocketreach`          | [docs](https://agentic.so/tools/rocketreach)          | B2B person and company enrichment API.                                                                                                                                                                                                                         |
| [Searxng](https://docs.searxng.org)                                             | `@agentic/searxng`              | [docs](https://agentic.so/tools/searxng)              | OSS meta search engine capable of searching across many providers like Reddit, Google, Brave, Arxiv, Genius, IMDB, Rotten Tomatoes, Wikidata, Wolfram Alpha, YouTube, GitHub, [etc](https://docs.searxng.org/user/configured_engines.html#configured-engines). |
| [SerpAPI](https://serpapi.com/search-api)                                       | `@agentic/serpapi`              | [docs](https://agentic.so/tools/serpapi)              | Lightweight wrapper around SerpAPI for Google search.                                                                                                                                                                                                          |
| [Serper](https://serper.dev)                                                    | `@agentic/serper`               | [docs](https://agentic.so/tools/serper)               | Lightweight wrapper around Serper for Google search.                                                                                                                                                                                                           |
| [Slack](https://api.slack.com/docs)                                             | `@agentic/slack`                | [docs](https://agentic.so/tools/slack)                | Send and receive Slack messages.                                                                                                                                                                                                                               |
| [SocialData](https://socialdata.tools)                                          | `@agentic/social-data`          | [docs](https://agentic.so/tools/social-data)          | Unofficial Twitter / X client (readonly) which is much cheaper than the official Twitter API.                                                                                                                                                                  |
| [Tavily](https://tavily.com)                                                    | `@agentic/tavily`               | [docs](https://agentic.so/tools/tavily)               | Web search API tailored for LLMs.                                                                                                                                                                                                                              |
| [Twilio](https://www.twilio.com/docs/conversations/api)                         | `@agentic/twilio`               | [docs](https://agentic.so/tools/twilio)               | Twilio conversation API to send and receive SMS messages.                                                                                                                                                                                                      |
| [Twitter](https://developer.x.com/en/docs/twitter-api)                          | `@agentic/twitter`              | [docs](https://agentic.so/tools/twitter)              | Basic Twitter API methods for fetching users, tweets, and searching recent tweets. Includes support for plan-aware rate-limiting. Uses [Nango](https://www.nango.dev) for OAuth support.                                                                       |
| [Typeform](https://www.typeform.com/developers/get-started/)                    | `@agentic/typeform`             | [docs](https://agentic.so/tools/typeform)             | Readonly Typeform client for fetching form insights and responses.                                                                                                                                                                                             |
| [Weather](https://www.weatherapi.com)                                           | `@agentic/weather`              | [docs](https://agentic.so/tools/weather)              | Basic access to current weather data based on location.                                                                                                                                                                                                        |
| [Wikidata](https://www.wikidata.org/wiki/Wikidata:Data_access)                  | `@agentic/wikidata`             | [docs](https://agentic.so/tools/wikidata)             | Basic Wikidata client.                                                                                                                                                                                                                                         |
| [Wikipedia](https://www.mediawiki.org/wiki/API)                                 | `@agentic/wikipedia`            | [docs](https://agentic.so/tools/wikipedia)            | Wikipedia page search and summaries.                                                                                                                                                                                                                           |
| [Wolfram Alpha](https://products.wolframalpha.com/llm-api/documentation)        | `@agentic/wolfram-alpha`        | [docs](https://agentic.so/tools/wolfram-alpha)        | Wolfram Alpha LLM API client for answering computational, mathematical, and scientific questions.                                                                                                                                                              |
| [YouTube](https://developers.google.com/youtube/v3)                             | `@agentic/youtube`              | [docs](https://agentic.so/tools/youtube)              | YouTube data API v3 for searching YT videos and channels.                                                                                                                                                                                                      |
| [ZoomInfo](https://api-docs.zoominfo.com)                                       | `@agentic/zoominfo`             | [docs](https://agentic.so/tools/zoominfo)             | Powerful B2B person and company data enrichment.                                                                                                                                                                                                               |

> [!NOTE]
> Missing a tool or want to add your own tool to this list? If you have an OpenAPI v3 spec for your tool's API, we make it extremely easy to add support using our [@agentic/openapi-to-ts](./packages/openapi-to-ts) CLI. Otherwise, feel free to [open an issue to discuss](https://github.com/transitive-bullshit/agentic/issues/new?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) or submit a PR.

For more details on tool usage, see the [docs](https://agentic.so).

## Contributors

- [Travis Fischer](https://x.com/transitive_bs)
- [David Zhang](https://x.com/dzhng)
- [Philipp Burckhardt](https://x.com/burckhap)
- And all of these [amazing OSS contributors](https://github.com/transitive-bullshit/agentic/graphs/contributors):

<p align="center">
  <a href="https://github.com/transitive-bullshit/agentic/graphs/contributors">
    <img src="https://contrib.rocks/image?repo=transitive-bullshit/agentic&max=150" width="600" />
  </a>
</p>

## License

MIT © [Travis Fischer](https://x.com/transitive_bs)

To stay up to date or learn more, follow [@transitive_bs](https://x.com/transitive_bs) on Twitter.


================================================
FILE: legacy/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: legacy/tsup.config.ts
================================================
import { defineConfig } from 'tsup'

export default defineConfig([
  {
    entry: ['src/index.ts'],
    outDir: 'dist',
    target: 'node18',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  }
])


================================================
FILE: legacy/turbo.json
================================================
{
  "$schema": "https://turbo.build/schema.json",
  "ui": "stream",
  "tasks": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**"],
      "outputLogs": "new-only"
    },
    "clean": {
      "cache": false,
      "dependsOn": ["^clean"]
    },
    "test": {
      "dependsOn": ["test:format", "test:lint", "test:typecheck", "test:unit"]
    },
    "test:lint": {
      "dependsOn": ["^test:lint"],
      "outputLogs": "errors-only"
    },
    "test:typecheck": {
      "dependsOn": ["^test:typecheck"],
      "outputLogs": "errors-only"
    },
    "test:unit": {
      "dependsOn": ["^test:unit"],
      "outputLogs": "errors-only"
    },
    "test:format": {
      "dependsOn": ["//#test:format", "^test:format"]
    },
    "//#test:format": {},
    "dev": {
      "cache": false,
      "persistent": true
    }
  }
}


================================================
FILE: legacy/vite.config.ts
================================================
import { defineConfig } from 'vitest/config'

export default defineConfig({
  esbuild: {
    target: 'es2022'
  }
})


================================================
FILE: license
================================================
Agentic is open source licensed under the [GNU AGPL 3.0 license](https://choosealicense.com/licenses/agpl-3.0/).

Some of Agentic's public packages are licensed under the more permissive [MIT license](https://choosealicense.com/licenses/mit/). If a directory includes an MIT license file, that overrides the default. If it doesn't, then that code and all code under that subdirectory defaults to Agentic's general [GNU AGPL 3.0 license](https://choosealicense.com/licenses/agpl-3.0/).

All Agentic packages under the `apps/`, `examples/`, `docs/`, and `packages/` folders are AGPL-3.0 licensed.

All Agentic packages under the `stdlib/` folder are MIT licensed.

---

                    GNU AFFERO GENERAL PUBLIC LICENSE
                       Version 3, 19 November 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

                            Preamble

The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.

When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.

A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.

The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.

An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.

The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

0. Definitions.

"This License" refers to version 3 of the GNU Affero General Public License.

"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.

To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

A "covered work" means either the unmodified Program or a work based
on the Program.

To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

1. Source Code.

The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.

A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

The Corresponding Source for a work in source code form is that
same work.

2. Basic Permissions.

All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.

3. Protecting Users' Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.

An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

11. Patents.

A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".

A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

13. Remote Network Interaction; Use with the GNU General Public License.

Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.

Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.

If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.


================================================
FILE: package.json
================================================
{
  "name": "agentic",
  "private": true,
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git"
  },
  "packageManager": "pnpm@10.17.0",
  "engines": {
    "node": ">=20"
  },
  "type": "module",
  "scripts": {
    "build": "turbo build --filter=!web --concurrency=32",
    "dev": "turbo dev --continue --filter=!./examples/**/*",
    "docs": "turbo run docs",
    "clean": "turbo clean",
    "fix": "run-s fix:*",
    "cli": "cd ./packages/cli && pnpm run cli",
    "fix:format": "prettier --write \"**/*.{js,ts,tsx}\"",
    "test": "turbo test --concurrency=32",
    "test:format": "prettier --check \"**/*.{js,ts,tsx}\"",
    "test:lint": "eslint --cache .",
    "test:typecheck": "turbo test:typecheck --concurrency=32",
    "test:unit": "turbo test:unit --concurrency=32",
    "pretest": "run-s build",
    "preinstall": "npx only-allow pnpm",
    "prerelease": "run-s build",
    "prepare": "simple-git-hooks",
    "release": "bumpp -r && run-s build && pnpm publish -r",
    "knip": "knip"
  },
  "devDependencies": {
    "@dotenvx/dotenvx": "catalog:",
    "@fisch0920/config": "catalog:",
    "@types/node": "catalog:",
    "bumpp": "catalog:",
    "del-cli": "catalog:",
    "dotenv": "catalog:",
    "eslint": "catalog:",
    "eslint-plugin-drizzle": "catalog:",
    "knip": "catalog:",
    "lint-staged": "catalog:",
    "npm-run-all2": "catalog:",
    "only-allow": "catalog:",
    "prettier": "catalog:",
    "simple-git-hooks": "catalog:",
    "tsup": "catalog:",
    "tsx": "catalog:",
    "turbo": "catalog:",
    "typescript": "catalog:",
    "vite-tsconfig-paths": "catalog:",
    "vitest": "catalog:",
    "zod": "catalog:"
  },
  "prettier": "@fisch0920/config/prettier",
  "simple-git-hooks": {
    "pre-commit": "pnpm lint-staged"
  },
  "lint-staged": {
    "*.{ts,tsx}": [
      "prettier --ignore-unknown --write",
      "eslint --cache --fix"
    ]
  }
}


================================================
FILE: packages/api-client/package.json
================================================
{
  "name": "@agentic/platform-api-client",
  "version": "8.4.4",
  "description": "TypeScript API client for the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/api-client"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@standard-schema/spec": "catalog:",
    "file-type": "^21.0.0",
    "ky": "catalog:",
    "type-fest": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/api-client/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-api-client"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-api-client.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-api-client <!-- omit from toc -->

> TypeScript API client for the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this package directly. See [@agentic/cli](https://github.com/transitive-bullshit/agentic/tree/main/packages/cli), [@agentic/platform](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform), and [@agentic/platform-tool-client](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform-tool-client) for more public-facing packages.

## Install

```bash
npm i @agentic/platform-api-client
```

## Usage

```ts
import { AgenticApiClient } from '@agentic/platform-api-client'

// Takes an optional `apiKey`
const agenticApiClient = new AgenticApiClient()

const searchProject = await agenticApiClient.getPublicProjectByIdentifier({
  projectIdentifier: '@agentic/search'
})
console.log(searchProject)
```

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/api-client/src/agentic-api-client.ts
================================================
import type {
  AdminConsumer,
  AdminDeployment,
  AuthSession,
  Consumer,
  Deployment,
  openapi,
  Project,
  Team,
  TeamMember,
  User
} from '@agentic/platform-types'
import type { Simplify } from 'type-fest'
import { assert, sanitizeSearchParams, sha256 } from '@agentic/platform-core'
import { fileTypeFromBuffer } from 'file-type'
import defaultKy, { type KyInstance } from 'ky'

import type { OnUpdateAuthSessionFunction } from './types'

export class AgenticApiClient {
  static readonly DEFAULT_API_BASE_URL = 'https://api.agentic.so'

  public readonly apiBaseUrl: string
  public readonly apiKey?: string
  public readonly ky: KyInstance
  public readonly onUpdateAuth?: OnUpdateAuthSessionFunction

  // protected _authClient: AuthClient
  protected _authSession?: AuthSession

  constructor({
    apiBaseUrl = AgenticApiClient.DEFAULT_API_BASE_URL,
    apiKey,
    ky = defaultKy,
    onUpdateAuth
  }: {
    apiBaseUrl?: string
    apiKey?: string
    ky?: KyInstance
    onUpdateAuth?: OnUpdateAuthSessionFunction
  } = {}) {
    assert(apiBaseUrl, 'AgenticApiClient missing required "apiBaseUrl"')

    this.apiBaseUrl = apiBaseUrl
    this.apiKey = apiKey
    this.onUpdateAuth = onUpdateAuth

    // this._authClient = createAuthClient({
    //   issuer: apiBaseUrl,
    //   clientId: 'agentic-api-client'
    // })

    this.ky = ky.extend({
      prefixUrl: apiBaseUrl,

      // Set a longer timeout on localhost to account for backend debugging / breakpoints.
      timeout: apiBaseUrl.startsWith('http://localhost') ? 120_000 : undefined,

      headers: apiKey
        ? {
            Authorization: `Bearer ${apiKey}`
          }
        : undefined,

      hooks: {
        beforeRequest: [
          async (request) => {
            if (!this.apiKey && this._authSession) {
              // Always verify freshness of auth tokens before making a request
              // TODO: handle refreshing auth tokens
              // await this.verifyAuthAndRefreshIfNecessary()
              // assert(this._authSession, 'Not authenticated')

              request.headers.set(
                'Authorization',
                `Bearer ${this._authSession.token}`
              )
            }
          }
        ]
      }
    })
  }

  get isAuthenticated(): boolean {
    return !!this._authSession
  }

  get authSession(): AuthSession | undefined {
    return structuredClone(this._authSession)
  }

  set authSession(authSession: AuthSession | undefined) {
    // TODO: validate auth sessino with zod
    this._authSession = structuredClone(authSession)
  }

  // async verifyAuthAndRefreshIfNecessary(): Promise<AuthSession> {
  //   this._ensureNoApiKey()

  //   if (!this._authTokens) {
  //     throw new Error('This method requires authentication.')
  //   }

  //   const verified = await this._authClient.verify(
  //     authSubjects,
  //     this._authTokens.access,
  //     {
  //       refresh: this._authTokens.refresh
  //     }
  //   )

  //   if (verified.err) {
  //     throw verified.err
  //   }

  //   if (verified.tokens) {
  //     this._authTokens = verified.tokens
  //   }

  //   this.onUpdateAuth?.({
  //     session: this._authTokens,
  //     user: verified.subject.properties
  //   })

  //   return verified.subject.properties
  // }

  // async exchangeAuthCode({
  //   code,
  //   redirectUri,
  //   verifier
  // }: {
  //   code: string
  //   redirectUri: string
  //   verifier?: string
  // }): Promise<AuthSession> {
  //   this._ensureNoApiKey()
  //   const result = await this._authClient.exchange(code, redirectUri, verifier)

  //   if (result.err) {
  //     throw result.err
  //   }

  //   this._authTokens = result.tokens
  //   return this.verifyAuthAndRefreshIfNecessary()
  // }

  // async initAuthFlow({
  //   redirectUri,
  //   provider
  // }: {
  //   redirectUri: string
  //   provider: 'github'
  // }): Promise<AuthorizeResult> {
  //   this._ensureNoApiKey()

  //   return this._authClient.authorize(redirectUri, 'code', {
  //     provider
  //   })
  // }

  async logout(): Promise<void> {
    this._authSession = undefined
    this.onUpdateAuth?.()
  }

  protected _ensureNoApiKey() {
    assert(
      !this.apiKey,
      'AgenticApiClient was initialized with an API key. This method is only supported with wnon-API-key-based authentication.'
    )
  }

  /** Signs in with email + password. */
  async signInWithPassword(
    json: OperationBody<'signInWithPassword'>
    // searchParams?: OperationParameters<'signInWithPassword'>
  ): Promise<AuthSession> {
    this._authSession = await this.ky
      .post('v1/auth/password/signin', { json })
      .json<AuthSession>()

    this.onUpdateAuth?.(this._authSession)
    return this._authSession
  }

  /** Registers a new account with username + email + password. */
  async signUpWithPassword(
    json: OperationBody<'signUpWithPassword'>
    // searchParams?: OperationParameters<'signUpWithPassword'>
  ): Promise<AuthSession> {
    this._authSession = await this.ky
      .post('v1/auth/password/signup', { json })
      .json()

    this.onUpdateAuth?.(this._authSession)
    return this._authSession
  }

  // TODO
  async initAuthFlowWithGitHub({
    redirectUri,
    scope = 'user:email',
    clientId = 'Iv23lizZv3CnggDT7JED'
  }: {
    redirectUri: string
    scope?: string
    clientId?: string
  }): Promise<string> {
    const url = new URL(`${this.apiBaseUrl}/v1/auth/github/init`)
    url.searchParams.append('client_id', clientId)
    url.searchParams.append('scope', scope)
    url.searchParams.append('redirect_uri', redirectUri)

    return url.toString()
  }

  // TODO
  async exchangeOAuthCodeWithGitHub(
    json: OperationBody<'exchangeOAuthCodeWithGitHub'>
  ): Promise<AuthSession> {
    this._authSession = await this.ky
      .post('v1/auth/github/exchange', { json })
      .json()

    this.onUpdateAuth?.(this._authSession)
    return this._authSession
  }

  /** Gets the currently authenticated user. */
  async getMe(): Promise<User> {
    // const user = await this.verifyAuthAndRefreshIfNecessary()
    const userId = this._authSession?.user.id
    assert(userId, 'This method requires authentication.')

    return this.ky.get(`v1/users/${userId}`).json()
  }

  /** Gets a user by ID. */
  async getUser({
    userId,
    ...searchParams
  }: OperationParameters<'getUser'>): Promise<User> {
    return this.ky.get(`v1/users/${userId}`, { searchParams }).json()
  }

  /** Updates a user. */
  async updateUser(
    user: OperationBody<'updateUser'>,
    { userId, ...searchParams }: OperationParameters<'updateUser'>
  ): Promise<User> {
    return this.ky
      .post(`v1/users/${userId}`, { json: user, searchParams })
      .json()
  }

  /** Lists all teams the authenticated user belongs to. */
  async listTeams(
    searchParams: OperationParameters<'listTeams'> = {}
  ): Promise<Array<Team>> {
    return this.ky
      .get('v1/teams', { searchParams: sanitizeSearchParams(searchParams) })
      .json()
  }

  /** Creates a team. */
  async createTeam(
    team: OperationBody<'createTeam'>,
    searchParams: OperationParameters<'createTeam'> = {}
  ): Promise<Team> {
    return this.ky
      .post('v1/teams', {
        json: team,
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Gets a team by ID. */
  async getTeam({
    teamId,
    ...searchParams
  }: OperationParameters<'getTeam'>): Promise<Team> {
    return this.ky.get(`v1/teams/${teamId}`, { searchParams }).json()
  }

  /** Updates a team. */
  async updateTeam(
    team: OperationBody<'updateTeam'>,
    { teamId, ...searchParams }: OperationParameters<'updateTeam'>
  ): Promise<Team> {
    return this.ky
      .post(`v1/teams/${teamId}`, { json: team, searchParams })
      .json()
  }

  /** Deletes a team by ID. */
  async deleteTeam({
    teamId,
    ...searchParams
  }: OperationParameters<'deleteTeam'>): Promise<Team> {
    return this.ky.delete(`v1/teams/${teamId}`, { searchParams }).json()
  }

  /** Creates a new team member. */
  async createTeamMember(
    member: OperationBody<'createTeamMember'>,
    { teamId, ...searchParams }: OperationParameters<'createTeamMember'>
  ): Promise<TeamMember> {
    return this.ky
      .post(`v1/teams/${teamId}/members`, { json: member, searchParams })
      .json()
  }

  /** Updates a team member. */
  async updateTeamMember(
    member: OperationBody<'updateTeamMember'>,
    { teamId, userId, ...searchParams }: OperationParameters<'updateTeamMember'>
  ): Promise<TeamMember> {
    return this.ky
      .post(`v1/teams/${teamId}/members/${userId}`, {
        json: member,
        searchParams
      })
      .json()
  }

  /** Deletes a team member. */
  async deleteTeamMember({
    teamId,
    userId,
    ...searchParams
  }: OperationParameters<'deleteTeamMember'>): Promise<TeamMember> {
    return this.ky
      .delete(`v1/teams/${teamId}/members/${userId}`, { searchParams })
      .json()
  }

  /**
   * Gets a signed URL for uploading a file to Agentic's blob storage.
   *
   * Files are namespaced to a given project and are identified by a key that
   * should be a hash of the file's contents, with the correct file extension.
   *
   * @example
   * ```ts
   * const { signedUploadUrl, publicObjectUrl } = await client.getSignedStorageUploadUrl({
   *   projectIdentifier: '@username/my-project',
   *   key: '9f86d081884c7d659a2feaa0c55ad015a.png'
   * })
   * ```
   */
  async getSignedStorageUploadUrl(
    searchParams: OperationParameters<'getSignedStorageUploadUrl'>
  ): Promise<{
    /** The signed upload URL. */
    signedUploadUrl: string

    /** The public URL the object will have once uploaded. */
    publicObjectUrl: string
  }> {
    return this.ky
      .get(`v1/storage/signed-upload-url`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Uploads a file to Agentic's blob storage for a given project.
   *
   * @example
   * ```ts
   * const publicObjectUrl = await client.uploadFileUrlToStorage(
   *   new URL('https://example.com/image.png'),
   *   { projectIdentifier: '@username/my-project' }
   * )
   * ```
   */
  async uploadFileUrlToStorage(
    source: string | ArrayBuffer | URL,
    {
      projectIdentifier
    }: {
      projectIdentifier: string
    }
  ): Promise<string> {
    let sourceBuffer: ArrayBuffer

    if (typeof source === 'string') {
      try {
        source = new URL(source)
      } catch {
        // Not a URL
        throw new Error(`Invalid source file URL: ${source}`)
      }
    }

    if (source instanceof URL) {
      if (source.hostname === 'storage.agentic.so') {
        // The source is already a public URL hosted on Agentic's blob storage.
        return source.toString()
      }

      sourceBuffer = await defaultKy.get(source).arrayBuffer()
    } else if (source instanceof ArrayBuffer) {
      sourceBuffer = source
    } else {
      throw new Error(`Invalid source file: ${source}`)
    }

    const [hash, fileType] = await Promise.all([
      sha256(sourceBuffer),
      fileTypeFromBuffer(sourceBuffer)
    ])

    const key = fileType ? `${hash}.${fileType.ext}` : hash

    const { signedUploadUrl, publicObjectUrl } =
      await this.getSignedStorageUploadUrl({
        projectIdentifier,
        key
      })

    try {
      // Check if the object already exists.
      await defaultKy.head(publicObjectUrl)
    } catch {
      // Object doesn't exist yet, so upload it.
      await defaultKy.post(signedUploadUrl, {
        body: sourceBuffer,
        headers: {
          'Content-Type': fileType?.mime ?? 'application/octet-stream'
        }
      })
    }

    return publicObjectUrl
  }

  /** Lists projects that have been published publicly to the marketplace. */
  async listPublicProjects<
    TPopulate extends NonNullable<
      OperationParameters<'listPublicProjects'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'listPublicProjects'> & {
      populate?: TPopulate[]
    } = {}
  ): Promise<Array<PopulateProject<TPopulate>>> {
    return this.ky
      .get('v1/projects/public', {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Gets a public project by ID. The project must be publicly available on
   * the marketplace.
   */
  async getPublicProject<
    TPopulate extends NonNullable<
      OperationParameters<'getPublicProject'>['populate']
    >[number]
  >({
    projectId,
    ...searchParams
  }: OperationParameters<'getPublicProject'> & {
    populate?: TPopulate[]
  }): Promise<PopulateProject<TPopulate>> {
    return this.ky
      .get(`v1/projects/public/${projectId}`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Gets a public project by its identifier. The project must be publicly
   * available on the marketplace.
   */
  async getPublicProjectByIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'getPublicProjectByIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'getPublicProjectByIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateProject<TPopulate>> {
    return this.ky
      .get('v1/projects/public/by-identifier', {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Lists projects the authenticated user has access to.
   */
  async listProjects<
    TPopulate extends NonNullable<
      OperationParameters<'listProjects'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'listProjects'> & {
      populate?: TPopulate[]
    } = {}
  ): Promise<Array<PopulateProject<TPopulate>>> {
    return this.ky
      .get(`v1/projects`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Creates a new project. */
  async createProject(
    project: OperationBody<'createProject'>,
    searchParams: OperationParameters<'createProject'> = {}
  ): Promise<Project> {
    return this.ky.post('v1/projects', { json: project, searchParams }).json()
  }

  /**
   * Gets a project by ID. Authenticated user must have access to the project.
   */
  async getProject<
    TPopulate extends NonNullable<
      OperationParameters<'getProject'>['populate']
    >[number]
  >({
    projectId,
    ...searchParams
  }: OperationParameters<'getProject'> & {
    populate?: TPopulate[]
  }): Promise<PopulateProject<TPopulate>> {
    return this.ky
      .get(`v1/projects/${projectId}`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Gets a project by its identifier. Authenticated user must have access to
   * the project.
   */
  async getProjectByIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'getProjectByIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'getProjectByIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateProject<TPopulate>> {
    return this.ky
      .get(`v1/projects/by-identifier`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Updates a project. Authenticated user must have access to the project.
   */
  async updateProject(
    project: OperationBody<'updateProject'>,
    { projectId, ...searchParams }: OperationParameters<'updateProject'>
  ): Promise<Project> {
    return this.ky
      .post(`v1/projects/${projectId}`, { json: project, searchParams })
      .json()
  }

  /** Gets a consumer by ID. */
  async getConsumer<
    TPopulate extends NonNullable<
      OperationParameters<'getConsumer'>['populate']
    >[number]
  >({
    consumerId,
    ...searchParams
  }: OperationParameters<'getConsumer'> & {
    populate?: TPopulate[]
  }): Promise<PopulateConsumer<TPopulate>> {
    return this.ky
      .get(`v1/consumers/${consumerId}`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Gets a consumer by ID. */
  async getConsumerByProjectIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'getConsumerByProjectIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'getConsumerByProjectIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateConsumer<TPopulate>> {
    return this.ky
      .get(`v1/consumers/by-project-identifier`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Updates a consumer's subscription to a different deployment or pricing
   * plan. Set `plan` to undefined to cancel the subscription.
   */
  async updateConsumer(
    consumer: OperationBody<'updateConsumer'>,
    { consumerId, ...searchParams }: OperationParameters<'updateConsumer'>
  ): Promise<Consumer> {
    return this.ky
      .post(`v1/consumers/${consumerId}`, { json: consumer, searchParams })
      .json()
  }

  /**
   * Creates a new consumer by subscribing a customer to a project.
   *
   * @deprecated Use `createConsumerCheckoutSession` instead. This method will
   * be removed in a future version.
   */
  async createConsumer(
    consumer: OperationBody<'createConsumer'>,
    searchParams: OperationParameters<'createConsumer'> = {}
  ): Promise<Consumer> {
    return this.ky
      .post('v1/consumers', {
        json: consumer,
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Creates a Stripe Checkout Session for a customer to modify their
   * subscription to a project.
   */
  async createConsumerCheckoutSession(
    consumer: OperationBody<'createConsumerCheckoutSession'>,
    searchParams: OperationParameters<'createConsumerCheckoutSession'> = {}
  ): Promise<{
    checkoutSession: {
      id: string
      url: string
    }
    consumer: Consumer
  }> {
    return this.ky
      .post('v1/consumers/checkout', {
        json: consumer,
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Creates a Stripe Billing Portal Session for the authenticated user.
   */
  async createBillingPortalSession(
    searchParams: OperationParameters<'createBillingPortalSession'> = {}
  ): Promise<{
    url: string
  }> {
    return this.ky
      .post(`v1/consumers/billing-portal`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Creates a Stripe Billing Portal Session for a customer.
   */
  async createConsumerBillingPortalSession({
    consumerId,
    ...searchParams
  }: OperationParameters<'createConsumerBillingPortalSession'>): Promise<{
    url: string
  }> {
    return this.ky
      .post(`v1/consumers/${consumerId}/billing-portal`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Refreshes a consumer's API key. */
  async refreshConsumerApiKey({
    consumerId,
    ...searchParams
  }: OperationParameters<'refreshConsumerApiKey'>): Promise<Consumer> {
    return this.ky
      .post(`v1/consumers/${consumerId}/refresh-api-key`, { searchParams })
      .json()
  }

  /** Lists all of the customers. */
  async listConsumers<
    TPopulate extends NonNullable<
      OperationParameters<'listConsumers'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'listConsumers'> & {
      populate?: TPopulate[]
    } = {}
  ): Promise<Array<PopulateConsumer<TPopulate>>> {
    return this.ky
      .get('v1/consumers', {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Lists all of the customers for a project. */
  async listConsumersForProject<
    TPopulate extends NonNullable<
      OperationParameters<'listConsumersForProject'>['populate']
    >[number]
  >({
    projectId,
    ...searchParams
  }: OperationParameters<'listConsumersForProject'> & {
    populate?: TPopulate[]
  }): Promise<Array<PopulateConsumer<TPopulate>>> {
    return this.ky
      .get(`v1/projects/${projectId}/consumers`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Gets a deployment by its ID. */
  async getDeployment<
    TPopulate extends NonNullable<
      OperationParameters<'getDeployment'>['populate']
    >[number]
  >({
    deploymentId,
    ...searchParams
  }: OperationParameters<'getDeployment'> & {
    populate?: TPopulate[]
  }): Promise<PopulateDeployment<TPopulate>> {
    return this.ky
      .get(`v1/deployments/${deploymentId}`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Gets a deployment by its identifier. */
  async getDeploymentByIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'getDeploymentByIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'getDeploymentByIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateDeployment<TPopulate>> {
    return this.ky
      .get(`v1/deployments/by-identifier`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Gets a public deployment by its identifier. */
  async getPublicDeploymentByIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'getPublicDeploymentByIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'getPublicDeploymentByIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateDeployment<TPopulate>> {
    return this.ky
      .get(`v1/deployments/public/by-identifier`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Updates a deployment. */
  async updateDeployment(
    deployment: OperationBody<'updateDeployment'>,
    { deploymentId, ...searchParams }: OperationParameters<'updateDeployment'>
  ): Promise<Deployment> {
    return this.ky
      .post(`v1/deployments/${deploymentId}`, {
        json: deployment,
        searchParams
      })
      .json()
  }

  /**
   * Lists deployments the user or team has access to, optionally filtering by
   * project.
   */
  async listDeployments<
    TPopulate extends NonNullable<
      OperationParameters<'listDeployments'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'listDeployments'> & {
      populate?: TPopulate[]
    } = {}
  ): Promise<Array<PopulateDeployment<TPopulate>>> {
    return this.ky
      .get('v1/deployments', {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /** Creates a new deployment within a project. */
  async createDeployment(
    deployment: OperationBody<'createDeployment'>,
    searchParams: OperationParameters<'createDeployment'> = {}
  ): Promise<Deployment> {
    return this.ky
      .post('v1/deployments', { json: deployment, searchParams })
      .json()
  }

  /** Publishes a deployment. */
  async publishDeployment(
    deployment: OperationBody<'publishDeployment'>,
    { deploymentId, ...searchParams }: OperationParameters<'publishDeployment'>
  ): Promise<Deployment> {
    return this.ky
      .post(`v1/deployments/${deploymentId}/publish`, {
        json: deployment,
        searchParams
      })
      .json()
  }

  /**
   * Gets a consumer by API key. This method is admin-only.
   *
   * @internal
   */
  async adminGetConsumerByApiKey<
    TPopulate extends NonNullable<
      OperationParameters<'adminGetConsumerByApiKey'>['populate']
    >[number]
  >({
    apiKey,
    ...searchParams
  }: OperationParameters<'adminGetConsumerByApiKey'> & {
    populate?: TPopulate[]
  }): Promise<PopulateConsumer<TPopulate, AdminConsumer>> {
    return this.ky
      .get(`v1/admin/consumers/api-keys/${apiKey}`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Activates a consumer signifying that at least one API call has been made
   * using the consumer's API key. This method is idempotent and admin-only.
   *
   * @internal
   */
  async adminActivateConsumer({
    consumerId,
    ...searchParams
  }: OperationParameters<'adminActivateConsumer'>): Promise<AdminConsumer> {
    return this.ky
      .put(`v1/admin/consumers/${consumerId}/activate`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }

  /**
   * Gets a deployment by its public identifier. This method is admin-only.
   *
   * @internal
   */
  async adminGetDeploymentByIdentifier<
    TPopulate extends NonNullable<
      OperationParameters<'adminGetDeploymentByIdentifier'>['populate']
    >[number]
  >(
    searchParams: OperationParameters<'adminGetDeploymentByIdentifier'> & {
      populate?: TPopulate[]
    }
  ): Promise<PopulateDeployment<TPopulate, AdminDeployment>> {
    return this.ky
      .get(`v1/admin/deployments/by-identifier`, {
        searchParams: sanitizeSearchParams(searchParams)
      })
      .json()
  }
}

type Operations = openapi.operations

type OperationParameters<
  T extends keyof Operations,
  Q = NonNullable<Operations[T]['parameters']['query']>,
  P = NonNullable<Operations[T]['parameters']['path']>
> = Simplify<
  ([Q] extends [never] ? unknown : Q) & ([P] extends [never] ? unknown : P)
>

// Currently unused because some types need customization (e.g. Deployment) over
// the default OpenAPI types.
// type OperationResponse<T extends keyof Operations> =
//   Operations[T]['responses'][200]['content']['application/json']

type OperationKeysWithRequestBody = {
  [K in keyof Operations]: Operations[K]['requestBody'] extends {
    content: {
      'application/json': unknown
    }
  }
    ? K
    : never
}[keyof Operations]

type OperationBody<
  T extends OperationKeysWithRequestBody,
  B extends
    | object
    | undefined = Operations[T]['requestBody']['content']['application/json']
> = B

type PopulateProject<TPopulate> = Simplify<
  Project &
    (TPopulate extends 'user'
      ? {
          user: User
        }
      : unknown) &
    (TPopulate extends 'team'
      ? {
          team: Team
        }
      : unknown) &
    (TPopulate extends 'lastPublishedDeployment'
      ? {
          lastPublishedDeployment?: Deployment
        }
      : unknown) &
    (TPopulate extends 'lastDeployment'
      ? {
          lastDeployment?: Deployment
        }
      : unknown)
>

type PopulateDeployment<
  TPopulate,
  TDeployment extends Deployment = Deployment
> = Simplify<
  TDeployment &
    (TPopulate extends 'user'
      ? {
          user: User
        }
      : unknown) &
    (TPopulate extends 'team'
      ? {
          team: Team
        }
      : unknown) &
    (TPopulate extends 'project'
      ? {
          project: Project
        }
      : unknown)
>

type PopulateConsumer<
  TPopulate,
  TConsumer extends Consumer = Consumer
> = Simplify<
  TConsumer &
    (TPopulate extends 'user'
      ? {
          user: User
        }
      : unknown) &
    (TPopulate extends 'project'
      ? {
          project: Project
        }
      : unknown) &
    (TPopulate extends 'deployment'
      ? {
          deployment: Deployment
        }
      : unknown)
>


================================================
FILE: packages/api-client/src/index.ts
================================================
export * from './agentic-api-client'
export type * from './types'


================================================
FILE: packages/api-client/src/types.ts
================================================
import type { AuthSession } from '@agentic/platform-types'

export type { AuthSession } from '@agentic/platform-types'

export type OnUpdateAuthSessionFunction = (update?: AuthSession) => unknown


================================================
FILE: packages/api-client/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/cli/package.json
================================================
{
  "name": "@agentic/cli",
  "version": "8.4.4",
  "description": "CLI for the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/cli"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "source": "./src/cli.ts",
  "bin": {
    "agentic": "./dist/cli.js"
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "cli": "AGENTIC_API_BASE_URL=\"http://localhost:3001\" tsx ./src/cli.ts"
  },
  "dependencies": {
    "@agentic/platform": "workspace:*",
    "@agentic/platform-api-client": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@clack/prompts": "catalog:",
    "@hono/node-server": "catalog:",
    "commander": "catalog:",
    "conf": "catalog:",
    "exit-hook": "catalog:",
    "get-port": "catalog:",
    "hono": "catalog:",
    "ky": "catalog:",
    "open": "catalog:",
    "ora": "catalog:",
    "restore-cursor": "catalog:",
    "semver": "catalog:"
  },
  "devDependencies": {
    "@commander-js/extra-typings": "catalog:",
    "@types/semver": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: packages/cli/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/cli"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/cli.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/cli <!-- omit from toc -->

> CLI for the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so/publishing)

## Install

```bash
npm i -g @agentic/cli
```

## Usage

```sh
Usage: agentic [options] [command]

Options:
  -j, --json                                Print output as JSON
  -V, --version                             output the version number
  -h, --help                                display help for command

Commands:
  login|signin [options]                    Signs in to Agentic. If no credentials are provided, uses GitHub auth.
  signup [options]                          Creates a new account for Agentic. If no credentials are provided, uses
                                            GitHub auth.
  whoami                                    Displays info about the current user.
  logout|signout                            Signs the current user out.
  deploy [options]                          Creates a new deployment.
  publish [options] [deploymentIdentifier]  Publishes a deployment. Defaults to the most recent deployment for the
                                            project in the target directory. If a deployment identifier is provided, it
                                            will be used instead.
  get <deploymentIdentifier>                Gets details for a specific deployment.
  list|ls [options] [identifier]            Lists deployments.
  debug [options]                           Prints config for a local project.
  help [command]                            display help for command
```

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/cli/src/cli.ts
================================================
#!/usr/bin/env node

import { AgenticApiClient } from '@agentic/platform-api-client'
import { Command } from 'commander'

import type { Context } from './types'
import { version } from '../package.json'
import { registerDebugCommand } from './commands/debug'
import { registerDeployCommand } from './commands/deploy'
import { registerGetDeploymentCommand } from './commands/get'
import { registerListDeploymentsCommand } from './commands/list'
import { registerPublishCommand } from './commands/publish'
import { registerSigninCommand } from './commands/signin'
import { registerSignoutCommand } from './commands/signout'
import { registerSignupCommand } from './commands/signup'
import { registerWhoAmICommand } from './commands/whoami'
import { AuthStore } from './lib/auth-store'
import { agenticApiBaseUrl } from './lib/env'
import { initExitHooks } from './lib/exit-hooks'
import { createErrorHandler } from './lib/handle-error'

async function main() {
  initExitHooks()

  // Initialize the API client
  const client = new AgenticApiClient({
    apiBaseUrl: agenticApiBaseUrl,
    onUpdateAuth: (update) => {
      if (update) {
        AuthStore.setAuth(update)
      } else {
        AuthStore.clearAuth()
      }
    }
  })

  // Initialize the existing auth session if one exists
  const authSession = AuthStore.tryGetAuth()
  if (authSession) {
    try {
      client.authSession = authSession
    } catch {
      console.warn('Existing auth session is invalid; logging out.\n')
      AuthStore.clearAuth()
    }
  }

  // Initialize the CLI program
  const program = new Command('agentic')
    .option('-j, --json', 'Print output as JSON')
    .version(version)
    .showHelpAfterError()

  const logger = {
    log: (...args: any[]) => {
      if (program.opts().json) {
        console.log(
          args.length === 1
            ? JSON.stringify(args[0], null, 2)
            : JSON.stringify(args, null, 2)
        )
      } else {
        console.log(...args)
      }
    },
    info: (...args: any[]) => {
      console.info(...args)
    },
    error: (...args: any[]) => {
      console.error(...args)
    }
  }

  const partialCtx = {
    client,
    program,
    logger
  }

  const errorHandler = createErrorHandler(partialCtx)
  const ctx: Context = {
    ...partialCtx,
    handleError: errorHandler
  }

  // Register all commands
  registerSigninCommand(ctx)
  registerSignupCommand(ctx)
  registerWhoAmICommand(ctx)
  registerSignoutCommand(ctx)
  registerDeployCommand(ctx)
  registerPublishCommand(ctx)
  registerGetDeploymentCommand(ctx)
  registerListDeploymentsCommand(ctx)
  registerDebugCommand(ctx)

  program.parse()
}

await main()


================================================
FILE: packages/cli/src/commands/debug.ts
================================================
import { loadAgenticConfig } from '@agentic/platform'
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'
import { oraPromise } from 'ora'

import type { Context } from '../types'

export function registerDebugCommand({
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('debug')
    .description('Prints config for a local project.')
    .option(
      '-c, --cwd <dir>',
      'The directory to load the Agentic project config from (defaults to the cwd). This directory must contain an "agentic.config.{ts,js,json}" project file.'
    )
    .action(async (opts) => {
      try {
        // Load the Agentic project config, parse, and validate it. This will also
        // validate any origin adapter config such as OpenAPI or MCP specs and
        // embed them if they point to local files or URLs. Note that the server
        // also performs validation; this is just a client-side convenience for
        // failing fast and sharing 99% of the validation code between server and
        // client.
        const config = await oraPromise(
          loadAgenticConfig({
            cwd: opts.cwd
          }),
          {
            text: `Loading Agentic config from ${opts.cwd ?? process.cwd()}`,
            successText: `Agentic config loaded successfully.`,
            failText: 'Failed to load Agentic config.'
          }
        )

        // TODO: we may want to resolve the resulting agentic config so we see
        // the inferred `tools` (and `toolToOperationMap` for mcp servers)

        logger.log(config)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/deploy.ts
================================================
import { loadAgenticConfig } from '@agentic/platform'
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'
import { oraPromise } from 'ora'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'

export function registerDeployCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('deploy')
    .description('Creates a new deployment.')
    .option(
      '-c, --cwd <dir>',
      'The directory to load the Agentic project config from (defaults to the cwd). This directory must contain an "agentic.config.{ts,js,json}" project file.'
    )
    .option('-d, --debug', 'Print out the parsed agentic config and return.')
    // TODO
    //.option('-p, --publish', 'Publishes the deployment after creating it.')
    .action(async (opts) => {
      AuthStore.requireAuth()

      try {
        // Load the Agentic project config, parse, and validate it. This will also
        // validate any origin adapter config such as OpenAPI or MCP specs and
        // embed them if they point to local files or URLs. Note that the server
        // also performs validation; this is just a client-side convenience for
        // failing fast and sharing 99% of the validation code between server and
        // client.
        const config = await oraPromise(
          loadAgenticConfig({
            cwd: opts.cwd
          }),
          {
            text: `Loading Agentic config from ${opts.cwd ?? process.cwd()}`,
            successText: `Agentic config loaded successfully.`,
            failText: 'Failed to load Agentic config.'
          }
        )

        if (opts.debug) {
          logger.log(config)
          gracefulExit(0)
          return
        }

        // Create the deployment on the backend, validating it in the process.
        // Note that the backend performs more validation than the client does
        // and is the ultimate source of truth.
        const deployment = await oraPromise(
          client.createDeployment(
            config
            // TODO: need to prompt to get or confirm version before publishing
            // {
            //   publish: opts.publish ? 'true' : 'false'
            // }
          ),
          {
            text: `Creating deployment for project "${config.slug}"`,
            successText: `Deployment created successfully`,
            failText: 'Failed to create deployment'
          }
        )

        logger.log(deployment)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/get.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'
import { oraPromise } from 'ora'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'

export function registerGetDeploymentCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('get')
    .description('Gets details for a specific deployment.')
    .argument('<deploymentIdentifier>', 'Deployment ID or identifier')
    .action(async (deploymentIdentifier) => {
      AuthStore.requireAuth()

      try {
        const deployment = await oraPromise(
          client.getDeploymentByIdentifier({
            deploymentIdentifier
          }),
          {
            text: 'Resolving deployment...',
            successText: 'Resolved deployment',
            failText: 'Failed to resolve deployment'
          }
        )

        logger.log(deployment)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/list.ts
================================================
import type { Deployment } from '@agentic/platform-types'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'
import { oraPromise } from 'ora'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'
import { pruneDeployment } from '../lib/utils'

export function registerListDeploymentsCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('list')
    .alias('ls')
    .description('Lists deployments.')
    .argument(
      '[identifier]',
      'Optional project or deployment identifier to filter by.'
    )
    .option('-v, --verbose', 'Display full deployments', false)
    .action(async (identifier, opts) => {
      AuthStore.requireAuth()

      try {
        const query: Parameters<typeof client.listDeployments>[0] = {}
        let label = 'Fetching all projects and deployments'

        if (identifier) {
          const parsedDeploymentIdentifier = parseDeploymentIdentifier(
            identifier,
            {
              strict: false
            }
          )

          query.projectIdentifier = parsedDeploymentIdentifier.projectIdentifier
          label = `Fetching deployments for project "${query.projectIdentifier}"`

          // TODO: this logic needs tweaking.
          if (
            parsedDeploymentIdentifier.deploymentVersion !== 'latest' ||
            identifier.includes('@latest')
          ) {
            query.deploymentIdentifier =
              parsedDeploymentIdentifier.deploymentIdentifier
            label = `Fetching deployment "${query.deploymentIdentifier}"`
          }
        }

        const deployments = await oraPromise(
          client.listDeployments(query),
          label
        )

        const projectIdToDeploymentsMap: Record<string, Deployment[]> = {}
        const sortedProjects: {
          projectId: string
          deployments: Deployment[]
        }[] = []

        // Aggregate deployments by project
        for (const deployment of deployments) {
          const prunedDeployment = pruneDeployment(deployment, opts)

          const { projectId } = deployment
          if (!projectIdToDeploymentsMap[projectId]) {
            projectIdToDeploymentsMap[projectId] = []
          }

          projectIdToDeploymentsMap[projectId].push(prunedDeployment)
        }

        // Sort deployments within each project with recently created first
        for (const projectId of Object.keys(projectIdToDeploymentsMap)) {
          const deployments = projectIdToDeploymentsMap[projectId]!
          deployments.sort(
            (a, b) =>
              new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime()
          )

          sortedProjects.push({
            projectId,
            deployments
          })
        }

        // Sort projects with most recently created first
        sortedProjects.sort(
          (a, b) =>
            new Date(b.deployments[0]!.createdAt).getTime() -
            new Date(a.deployments[0]!.createdAt).getTime()
        )

        // TODO: better output formatting
        logger.log(sortedProjects)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/publish.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'
import { oraPromise } from 'ora'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'
import { promptForDeploymentVersion } from '../lib/prompt-for-deployment-version'
import { resolveDeployment } from '../lib/resolve-deployment'

export function registerPublishCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('publish')
    .description(
      'Publishes a deployment. Defaults to the most recent deployment for the project in the target directory. If a deployment identifier is provided, it will be used instead.'
    )
    .argument('[deploymentIdentifier]', 'Optional deployment identifier')
    .option(
      '-c, --cwd <dir>',
      'The directory to load the Agentic project config from (defaults to cwd). This directory must contain an "agentic.config.{ts,js,json}" project file.'
    )
    .action(async (deploymentIdentifier, opts) => {
      AuthStore.requireAuth()

      if (deploymentIdentifier) {
        // TODO: parseToolIdentifier
      }

      try {
        const deployment = await oraPromise(
          resolveDeployment({
            client,
            deploymentIdentifier,
            fuzzyDeploymentIdentifierVersion: 'dev',
            cwd: opts.cwd,
            populate: ['project']
          }),
          {
            text: 'Resolving deployment...',
            successText: 'Resolved deployment',
            failText: 'Failed to resolve deployment'
          }
        )
        const { project } = deployment

        if (deployment.published) {
          logger.error(
            deploymentIdentifier
              ? `Deployment "${deploymentIdentifier}" is already published`
              : `Latest deployment "${deployment.identifier}" is already published`
          )
          return gracefulExit(1)
        }

        if (!project) {
          logger.error(
            deploymentIdentifier
              ? `Deployment "${deploymentIdentifier}" failed to fetch project "${deployment.projectId}"`
              : `Latest deployment "${deployment.identifier}" failed to fetch project "${deployment.projectId}"`
          )
          return gracefulExit(1)
        }

        const version = await promptForDeploymentVersion({
          deployment,
          project,
          logger
        })

        if (!version || typeof version !== 'string') {
          logger.error('No version selected')
          return gracefulExit(1)
        }

        const publishedDeployment = await client.publishDeployment(
          {
            version
          },
          {
            deploymentId: deployment.id
          }
        )

        logger.info(
          `Deployment "${publishedDeployment.identifier}" published with version "${publishedDeployment.version}"`
        )
        logger.log(publishedDeployment)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/signin.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'

import type { Context } from '../types'
import { auth } from '../lib/auth'

export function registerSigninCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('login')
    .alias('signin')
    .description(
      'Signs in to Agentic. If no credentials are provided, uses GitHub auth.'
    )
    .option('-e, --email <email>', 'Account email')
    .option('-p, --password <password>', 'Account password')
    .action(async (opts) => {
      if (!!opts.email !== !!opts.password) {
        logger.error(
          'either pass email and password or neither (which will use github auth)'
        )
        program.outputHelp()
        return gracefulExit(1)
      }

      try {
        if (opts.email && opts.password) {
          await client.signInWithPassword({
            email: opts.email,
            password: opts.password
          })
        } else {
          await auth({ client, provider: 'github' })
        }

        const user = await client.getMe()
        logger.log(user)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/signout.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'

export function registerSignoutCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('logout')
    .alias('signout')
    .description('Signs the current user out.')
    .action(async () => {
      if (!client.isAuthenticated) {
        logger.log('You are already signed out')
        return gracefulExit(0)
      }

      try {
        await client.logout()
        AuthStore.clearAuth()

        logger.log('Signed out')
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/signup.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'

import type { Context } from '../types'
import { auth } from '../lib/auth'

export function registerSignupCommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('signup')
    .description(
      'Creates a new account for Agentic. If no credentials are provided, uses GitHub auth.'
    )
    .option('-e, --email <email>', 'Account email')
    .option('-u, --username <username>', 'Account username')
    .option('-p, --password <password>', 'Account password')
    .action(async (opts) => {
      if (
        !!opts.email !== !!opts.password ||
        !!opts.email !== !!opts.username
      ) {
        logger.error(
          'either pass email, username, and password or none of them (which will use github auth)'
        )
        program.outputHelp()
        return gracefulExit(1)
      }

      try {
        if (opts.email && opts.username && opts.password) {
          await client.signUpWithPassword({
            email: opts.email,
            username: opts.username,
            password: opts.password
          })
        } else {
          await auth({ client, provider: 'github' })
        }

        const user = await client.getMe()
        logger.log(user)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/commands/whoami.ts
================================================
import { Command } from 'commander'
import { gracefulExit } from 'exit-hook'

import type { Context } from '../types'
import { AuthStore } from '../lib/auth-store'

export function registerWhoAmICommand({
  client,
  program,
  logger,
  handleError
}: Context) {
  const command = new Command('whoami')
    .description('Displays info about the current user.')
    .action(async () => {
      AuthStore.requireAuth()

      try {
        const res = await client.getMe()
        logger.log(res)
        gracefulExit(0)
      } catch (err) {
        handleError(err)
      }
    })

  program.addCommand(command)
}


================================================
FILE: packages/cli/src/lib/auth-store.ts
================================================
import type { AuthSession } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import Conf from 'conf'

import { agenticApiBaseUrl } from './env'

const keyAuthSession = `authSession:${agenticApiBaseUrl}`

export const AuthStore = {
  store: new Conf<{
    [keyAuthSession]: AuthSession
  }>({ projectName: 'agentic' }),

  isAuthenticated() {
    return this.store.has(keyAuthSession)
  },

  requireAuth() {
    assert(
      this.isAuthenticated(),
      'This command requires authentication. Please login first.'
    )
  },

  tryGetAuth(): AuthSession | undefined {
    if (!this.isAuthenticated()) {
      return undefined
    }

    return this.store.get(keyAuthSession)
  },

  getAuth(): AuthSession {
    this.requireAuth()
    return this.tryGetAuth()!
  },

  setAuth(authSession: AuthSession) {
    this.store.set(keyAuthSession, authSession)
  },

  clearAuth() {
    this.store.delete(keyAuthSession)
  }

  // switchTeam(team?: { id: string; slug: string }) {
  //   if (team?.id) {
  //     this.store.set(keyTeamId, team.id)
  //     this.store.set(keyTeamSlug, team.slug)
  //   } else {
  //     this.store.delete(keyTeamId)
  //     this.store.delete(keyTeamSlug)
  //   }
  // }
}


================================================
FILE: packages/cli/src/lib/auth.ts
================================================
import type {
  AgenticApiClient,
  AuthSession
} from '@agentic/platform-api-client'
import { assert } from '@agentic/platform-core'
import { serve } from '@hono/node-server'
import getPort from 'get-port'
import { Hono } from 'hono'
import open from 'open'
import { oraPromise } from 'ora'

import { AuthStore } from './auth-store'

const providerToLabel = {
  github: 'GitHub'
  // password: 'email and password'
}

export async function auth({
  client,
  provider,
  preferredPort = 6013
}: {
  client: AgenticApiClient
  provider: 'github' // | 'password'
  preferredPort?: number
}): Promise<AuthSession> {
  const providerLabel = providerToLabel[provider]
  assert(providerLabel, `Missing required provider: ${provider}`)

  const port = await getPort({ port: preferredPort })
  const app = new Hono()

  const redirectUri = `http://localhost:${port}/callback/${provider}/success`
  let _resolveAuth: any
  let _rejectAuth: any

  // NOTE: Promise.withResolvers requires Node.js 22+
  const authP = new Promise<AuthSession>((resolve, reject) => {
    _resolveAuth = resolve
    _rejectAuth = reject
  })

  app.get(`/callback/${provider}/success`, async (c) => {
    // console.log(`/callback/${provider}/success`, c.req.method, c.req.url, {
    //   headers: c.req.header(),
    //   query: c.req.query()
    // })

    const code = c.req.query('code')
    assert(code, 'Missing required code query parameter')

    await client.exchangeOAuthCodeWithGitHub({ code })
    assert(
      client.authSession,
      `Error ${providerLabel} auth: failed to exchange auth code for token`
    )

    // await client.exchangeAuthCode({
    //   code,
    //   redirectUri,
    //   verifier: authorizeResult.challenge?.verifier
    // })
    // assert(
    //   client.authSession,
    //   `Error ${providerLabel} auth: failed to exchange auth code for token`
    // )

    // AuthStore should be updated via the onUpdateAuth callback
    const session = AuthStore.tryGetAuth()
    assert(session && session?.token === client.authSession?.token)
    _resolveAuth(session)

    return c.text(
      `Huzzah! You are now signed in to the Agentic CLI.\n\nYou may close this browser tab. 😄`
    )
  })

  const server = serve({
    fetch: app.fetch,
    port
  })

  // TODO: clean these up
  process.on('SIGINT', () => {
    server.close()
    process.exit(0)
  })
  process.on('SIGTERM', () => {
    server.close((err) => {
      if (err) {
        console.error(err)
        process.exit(1)
      }
      process.exit(0)
    })
  })

  const url = await client.initAuthFlowWithGitHub({
    redirectUri
  })
  await open(url.toString())

  // TODO
  // const authorizeResult = await client.initAuthFlow({
  //   provider,
  //   redirectUri
  // })
  // assert(authorizeResult.url, `Error signing in with ${providerLabel}`)
  // await open(authorizeResult.url)

  const authSession = await oraPromise(authP, {
    text: `Signing in with ${providerLabel}`,
    successText: 'You are now signed in.',
    failText: 'Failed to sign in.'
  })
  server.close()

  return authSession
}


================================================
FILE: packages/cli/src/lib/commander.d.ts
================================================
declare module 'commander' {
  export * from '@commander-js/extra-typings'
}


================================================
FILE: packages/cli/src/lib/env.ts
================================================
export const agenticApiBaseUrl =
  process.env.AGENTIC_API_BASE_URL || 'https://api.agentic.so'


================================================
FILE: packages/cli/src/lib/exit-hooks.ts
================================================
import restoreCursor from 'restore-cursor'

export function initExitHooks() {
  // Gracefully restore the cursor if run from a TTY
  restoreCursor()

  process.on('SIGINT', () => {
    process.exit(0)
  })

  process.on('SIGTERM', () => {
    process.exit(0)
  })
}


================================================
FILE: packages/cli/src/lib/handle-error.ts
================================================
import { gracefulExit } from 'exit-hook'
import { HTTPError } from 'ky'

import type { Context } from '../types'

export function createErrorHandler(ctx: Omit<Context, 'handleError'>) {
  return async function handleError(error: any) {
    let message: string | undefined
    let details: Error | undefined

    if (typeof error === 'string') {
      message = error
    } else if (error instanceof Error) {
      details = error
      message = error.message

      if (error instanceof HTTPError) {
        if (error.response) {
          try {
            message = error.response.statusText

            const body = await error.response.json()
            if (body.error && typeof body.error === 'string') {
              message = JSON.stringify(
                {
                  ...body,
                  details: error.toString()
                },
                null,
                2
              )
              details = undefined
            }
          } catch {
            // TODO
          }
        }
      }
    }

    ctx.logger.error([message, details].filter(Boolean).join('\n'))
    gracefulExit(1)
  }
}


================================================
FILE: packages/cli/src/lib/prompt-for-deployment-version.ts
================================================
import type { Deployment, Project } from '@agentic/platform-types'
import { select } from '@clack/prompts'
import { gracefulExit } from 'exit-hook'
import semver from 'semver'

import type { Context } from '../types'

export async function promptForDeploymentVersion({
  deployment,
  project,
  logger
}: {
  deployment: Deployment
  project: Project
  logger: Context['logger']
}): Promise<string | undefined> {
  const initialVersion = deployment.version
  const baseVersion =
    initialVersion || project.lastPublishedDeploymentVersion || '0.0.0'

  const options = [
    initialVersion ? { value: initialVersion, label: initialVersion } : null,
    {
      value: semver.inc(baseVersion, 'patch'),
      label: `${semver.inc(baseVersion, 'patch')} (patch)`
    },
    {
      value: semver.inc(baseVersion, 'minor'),
      label: `${semver.inc(baseVersion, 'minor')} (minor)`
    },
    {
      value: semver.inc(baseVersion, 'major'),
      label: `${semver.inc(baseVersion, 'major')} (major)`
    }
  ].filter(Boolean)

  if (project.lastPublishedDeploymentVersion) {
    logger.info(
      `Project "${project.identifier}" latest published version is "${project.lastPublishedDeploymentVersion}".\n`
    )
  } else {
    logger.info(`Project "${project.identifier}" is not published yet.\n`)
  }

  const version = await select({
    message: `Select version of deployment "${deployment.identifier}" to publish:`,
    options
  })

  if (!version || typeof version !== 'string') {
    logger.error('No version selected')
    gracefulExit(1)
    return
  }

  return version
}


================================================
FILE: packages/cli/src/lib/reset.d.ts
================================================
import '@fisch0920/config/ts-reset'


================================================
FILE: packages/cli/src/lib/resolve-deployment.ts
================================================
import type { AgenticApiClient } from '@agentic/platform-api-client'
import type { Deployment } from '@agentic/platform-types'
import { loadAgenticConfig } from '@agentic/platform'

import { AuthStore } from './auth-store'

export async function resolveDeployment({
  client,
  deploymentIdentifier,
  fuzzyDeploymentIdentifierVersion,
  cwd,
  populate
}: {
  client: AgenticApiClient
  deploymentIdentifier?: string
  fuzzyDeploymentIdentifierVersion?: 'dev' | 'latest'
  cwd?: string
  populate?: ('user' | 'team' | 'project')[]
}): Promise<Deployment> {
  if (!deploymentIdentifier) {
    const config = await loadAgenticConfig({
      cwd
    })

    // TODO: re-add team support
    const auth = AuthStore.getAuth()
    const namespace = auth.user.username

    // TODO: resolve deploymentIdentifier; config identifier may include namespace?
    // TODO: this needs work...

    deploymentIdentifier = `@${namespace}/${config.slug}${fuzzyDeploymentIdentifierVersion ? `@${fuzzyDeploymentIdentifierVersion}` : ''}`
  }

  const deployment = await client.getDeploymentByIdentifier({
    deploymentIdentifier,
    populate
  })

  return deployment
}


================================================
FILE: packages/cli/src/lib/utils.ts
================================================
import type { Deployment } from '@agentic/platform-types'

export function pruneDeployment(
  deployment: Deployment,
  { verbose = false }: { verbose?: boolean }
): Deployment {
  if (!verbose) {
    const d = structuredClone(deployment)

    if (d.readme) {
      d.readme = '<omitted>'
    }

    // if (d.origin?.type === 'openapi') {
    //   d.origin.spec = '<omitted>'
    //   d.origin.toolToOperationMap = '<omitted>' as any
    // }

    return d
  }

  return deployment
}


================================================
FILE: packages/cli/src/types.ts
================================================
import type { AgenticApiClient } from '@agentic/platform-api-client'
import type { Command } from 'commander'

export type Context = {
  client: AgenticApiClient
  program: Command
  logger: {
    log: (...args: any[]) => void
    info: (...args: any[]) => void
    error: (...args: any[]) => void
  }
  handleError: (error: any) => void
}


================================================
FILE: packages/cli/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/cli/tsup.config.ts
================================================
import { defineConfig } from 'tsup'

export default defineConfig([
  {
    entry: ['src/cli.ts'],
    outDir: 'dist',
    target: 'node18',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  }
])


================================================
FILE: packages/emails/package.json
================================================
{
  "name": "@agentic/platform-emails",
  "private": true,
  "version": "8.4.4",
  "description": "Email templates for the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/emails"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "preview": "email dev --dir src/emails --port 3030",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@react-email/components": "catalog:",
    "react": "catalog:",
    "react-dom": "catalog:",
    "resend": "catalog:"
  },
  "devDependencies": {
    "@types/react": "catalog:",
    "@types/react-dom": "catalog:",
    "react-email": "catalog:"
  }
}


================================================
FILE: packages/emails/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-emails <!-- omit from toc -->

> Internal email templates for the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this private package unless you are contributing to Agentic directly.

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/emails/src/emails/send-verify-code-email.tsx
================================================
import {
  Body,
  Container,
  Head,
  Heading,
  Hr,
  Html,
  Img,
  Preview,
  Section,
  Tailwind,
  Text
} from '@react-email/components'
import React from 'react'

export interface SendVerifyCodeEmailProps {
  code: string
}

const logoUrl =
  'https://mintlify.s3.us-west-1.amazonaws.com/agentic/media/agentic-logo-light.svg'

function SendVerifyCodeEmail({ code }: SendVerifyCodeEmailProps) {
  const previewText = 'Verify your email address'

  return (
    <Html>
      <Head />
      <Tailwind>
        <Body className='mx-auto my-auto bg-white px-2 font-sans'>
          <Preview>{previewText}</Preview>

          <Container className='mx-auto my-[40px] max-w-[465px] rounded border border-[#eaeaea] border-solid p-[20px]'>
            <Section className='mt-[32px]'>
              <Img
                src={logoUrl}
                width='203'
                height='48'
                alt='Agentic Logo'
                className='mx-auto my-0'
              />
            </Section>

            <Heading className='mx-0 my-[30px] p-0 text-center font-normal text-[24px] text-black'>
              Verify your email address
            </Heading>

            <Section style={verificationSection}>
              <Text style={verifyText}>Verification code</Text>

              <Text style={codeText}>{code}</Text>
            </Section>

            <Hr className='mx-0 my-[26px] w-full border border-[#eaeaea] border-solid' />

            <Text className='text-[#666666] text-[12px] leading-[24px]'>
              If you didn’t sign up for Agentic, you can safely ignore this
              email. Someone else might have typed your email address by
              mistake.
            </Text>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  )
}

const text = {
  color: '#333',
  fontSize: '14px',
  margin: '24px 0'
}

const verifyText = {
  ...text,
  margin: 0,
  textAlign: 'center' as const
}

const codeText = {
  ...text,
  fontSize: '36px',
  margin: '12px 0',
  textAlign: 'center' as const
}

const verificationSection = {
  display: 'flex',
  alignItems: 'center',
  justifyContent: 'center'
}

SendVerifyCodeEmail.PreviewProps = {
  code: '123456'
} as SendVerifyCodeEmailProps

export default SendVerifyCodeEmail


================================================
FILE: packages/emails/src/index.ts
================================================
export * from './resend-email-client'


================================================
FILE: packages/emails/src/resend-email-client.tsx
================================================
import { assert } from '@agentic/platform-core'
import React from 'react'
import { Resend as ResendClient } from 'resend'

import SendVerifyCodeEmail from './emails/send-verify-code-email'

export class ResendEmailClient {
  protected readonly resend: ResendClient
  protected readonly from: string

  constructor({
    apiKey,
    from = 'Agentic <no-reply@notifications.agentic.so>'
  }: {
    apiKey: string
    from?: string
  }) {
    assert(apiKey, 'ResendEmailClient missing required "apiKey"')
    this.resend = new ResendClient(apiKey)
    this.from = from
  }

  async sendVerifyCodeEmail({
    code,
    to
  }: {
    code: string
    to: string
  }): Promise<string> {
    const result = await this.resend.emails.send({
      from: this.from,
      to,
      subject: 'Verify your email address',
      text: 'Verify your email address',
      react: <SendVerifyCodeEmail code={code} />
    })

    if (result.error) {
      throw new Error(result.error.message)
    }

    assert(result.data?.id, 'Failed to send verify code email')
    return result.data.id
  }
}


================================================
FILE: packages/emails/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "src/emails"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/hono/package.json
================================================
{
  "name": "@agentic/platform-hono",
  "private": true,
  "version": "8.4.4",
  "description": "Internal Hono utilities for the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/hono"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@hono/sentry": "catalog:",
    "@sentry/core": "catalog:",
    "dotenv": "catalog:",
    "eventid": "catalog:",
    "hono": "catalog:",
    "ky": "catalog:",
    "type-fest": "catalog:"
  },
  "devDependencies": {
    "@sentry/cloudflare": "catalog:",
    "@sentry/node": "catalog:"
  }
}


================================================
FILE: packages/hono/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-hono <!-- omit from toc -->

> Internal Hono utilities for the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this private package unless you are contributing to Agentic directly.

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/hono/src/env.ts
================================================
import 'dotenv/config'

import type { Simplify } from 'type-fest'
import { parseZodSchema } from '@agentic/platform-core'
import { z } from 'zod'

import { logLevelsSchema } from './logger'

export const envSchema = z
  .object({
    ENVIRONMENT: z
      .enum(['development', 'test', 'production'])
      .default('development'),

    SERVICE: z.enum(['api', 'gateway']),

    LOG_LEVEL: logLevelsSchema.default('info'),

    SENTRY_DSN: z.string().url().optional()
  })
  .strip()

export function parseEnv(inputEnv: unknown) {
  const env = parseZodSchema(envSchema, inputEnv, {
    error: 'Invalid environment variables'
  })

  const isDev = env.ENVIRONMENT === 'development'
  const isTest = env.ENVIRONMENT === 'test'
  const isProd = env.ENVIRONMENT === 'production'
  const isBrowser = (globalThis as any).window !== undefined

  if (isProd && !env.SENTRY_DSN) {
    throw new Error(
      'Internal error: missing required "SENTRY_DSN" environment variable in production'
    )
  }

  return {
    ...env,
    isDev,
    isTest,
    isProd,
    isBrowser
  }
}

export type Env = Simplify<ReturnType<typeof parseEnv>>


================================================
FILE: packages/hono/src/error-handler.ts
================================================
import type { Context } from 'hono'
import type { HTTPResponseError } from 'hono/types'
import type { ContentfulStatusCode } from 'hono/utils/http-status'
import { HttpError, JsonRpcError } from '@agentic/platform-core'
import { captureException } from '@sentry/core'
import { HTTPException } from 'hono/http-exception'
import { HTTPError } from 'ky'

import { applyHeaders } from './header-utils'
import {
  httpStatusCodeToJsonRpcErrorCode,
  JsonRpcErrorCodes
} from './json-rpc-errors'

// Don't log 429 errors because they may happen frequently and are just noise.
// Our access-logger should still log the 429 result, just not the whole error.
export const suppressedHttpStatuses = new Set([429])

/**
 * Hono error handler that sanitizes all types of internal, http, json-rpc, and
 * unexpected errors and responds with an appropate HTTP Response.
 *
 * @note This function is synchronous and should never throw.
 */
export function errorHandler(
  err: Error | HTTPResponseError,
  ctx: Context
): Response {
  const isProd = ctx.env?.isProd ?? true
  const logger = ctx.get('logger') ?? console
  const requestId = ctx.get('requestId')
  let isJsonRpcRequest = !!ctx.get('isJsonRpcRequest')
  let jsonRpcId: string | number | null = null
  let jsonRpcErrorCode: number | undefined

  let message = 'Internal Server Error'
  let status: ContentfulStatusCode = 500

  if (err instanceof HttpError) {
    message = err.message
    status = err.statusCode as ContentfulStatusCode

    // This is where rate-limit headers will be set, since `RateLimitError`
    // is a subclass of `HttpError`.
    applyHeaders({ res: ctx.res, headers: err.headers })
  } else if (err instanceof HTTPException) {
    message = err.message
    status = err.status
  } else if (err instanceof HTTPError) {
    message = err.message
    status = err.response.status as ContentfulStatusCode
  } else if (err instanceof JsonRpcError) {
    message = err.message
    status = err.statusCode as ContentfulStatusCode
    jsonRpcId = err.jsonRpcId
    jsonRpcErrorCode = err.jsonRpcErrorCode
    isJsonRpcRequest = true
  } else if (!isProd && err.message) {
    message = err.message
  }

  if (!Number.isSafeInteger(status)) {
    status = 500
  }

  if (!suppressedHttpStatuses.has(status)) {
    if (status >= 500) {
      logger.error(status, err)

      if (isProd) {
        try {
          captureException(err)
        } catch (err_) {
          // eslint-disable-next-line no-console
          console.error('Error Sentry.captureException failed', err, err_)
        }
      }
    } else if (status !== 404) {
      logger.warn(status, err)
    }
  }

  if (isJsonRpcRequest) {
    if (jsonRpcErrorCode === undefined) {
      jsonRpcErrorCode = httpStatusCodeToJsonRpcErrorCode(status)
    }

    if (!Number.isSafeInteger(jsonRpcErrorCode)) {
      jsonRpcErrorCode = JsonRpcErrorCodes.InternalError
    }

    return ctx.json(
      {
        jsonrpc: '2.0',
        error: {
          message,
          code: jsonRpcErrorCode
        },
        id: jsonRpcId
      },
      status
    )
  } else {
    return ctx.json({ error: message, requestId }, status)
  }
}


================================================
FILE: packages/hono/src/header-utils.ts
================================================
import {
  getRateLimitHeaders,
  type RateLimitResult
} from '@agentic/platform-core'

export function applyHeaders({
  res,
  headers
}: {
  res: Response
  headers?: Record<string, string>
}) {
  if (!headers) return

  for (const [key, value] of Object.entries(headers)) {
    res.headers.set(key, value)
  }
}

export function applyRateLimitHeaders({
  res,
  rateLimitResult
}: {
  res: Response
  rateLimitResult?: RateLimitResult
}) {
  const rateLimitHeaders = getRateLimitHeaders(rateLimitResult)

  applyHeaders({ res, headers: rateLimitHeaders })
}


================================================
FILE: packages/hono/src/index.ts
================================================
export * from './env'
export * from './error-handler'
export * from './header-utils'
export * from './json-rpc-errors'
export * from './logger'
export * from './middleware'
export type * from './types'


================================================
FILE: packages/hono/src/json-rpc-errors.ts
================================================
import type { ContentfulStatusCode } from 'hono/utils/http-status'

/**
 * Error codes defined by the JSON-RPC specification.
 *
 * @see https://www.jsonrpc.org/specification
 */
export enum JsonRpcErrorCodes {
  ConnectionClosed = -32_000,
  RequestTimeout = -32_001,
  ParseError = -32_700,
  InvalidRequest = -32_600,
  MethodNotFound = -32_601,
  InvalidParams = -32_602,
  InternalError = -32_603,

  // Non-standard error codes
  // @see https://json-rpc.dev/docs/reference/error-codes
  RateLimitExceeded = -32_002
}

export function httpStatusCodeToJsonRpcErrorCode(
  statusCode: ContentfulStatusCode
): number {
  if (statusCode === 429) {
    return JsonRpcErrorCodes.RateLimitExceeded
  }

  if (statusCode >= 400 && statusCode < 500) {
    return JsonRpcErrorCodes.InvalidRequest
  }

  return JsonRpcErrorCodes.InternalError
}


================================================
FILE: packages/hono/src/logger/index.ts
================================================
export * from './logger'
export * from './utils'


================================================
FILE: packages/hono/src/logger/logger.ts
================================================
import { assert, type Logger } from '@agentic/platform-core'
import { captureException } from '@sentry/core'
import { z } from 'zod'

import type { Env, Environment, Service } from '../types'
import { getTraceId } from './utils'

const rawLogLevels = ['trace', 'debug', 'info', 'warn', 'error'] as const
export const logLevelsSchema = z.enum(rawLogLevels)
export type LogLevel = z.infer<typeof logLevelsSchema>

export const logLevelsMap = rawLogLevels.reduce(
  (acc, level, index) => {
    acc[level] = index
    return acc
  },
  {} as Record<LogLevel, number>
)

const globalConsole = console

export class ConsoleLogger implements Logger {
  protected readonly env: Env
  protected readonly environment: Environment
  protected readonly service: Service
  protected readonly requestId: string
  protected readonly metadata: Record<string, unknown>
  protected readonly console: Console
  protected readonly logLevel: LogLevel

  constructor(
    env: Env,
    {
      requestId,
      service = env.SERVICE,
      environment = env.ENVIRONMENT,
      logLevel = env.LOG_LEVEL,
      metadata = {},
      console = globalConsole
    }: {
      requestId: string
      service?: Service
      environment?: Environment
      logLevel?: LogLevel
      metadata?: Record<string, unknown>
      console?: Console
    }
  ) {
    assert(env, 500, '`env` is required for ConsoleLogger')
    assert(console, 500, '`console` is required for ConsoleLogger')

    this.env = env
    this.requestId = requestId
    this.service = service
    this.environment = environment
    this.metadata = metadata
    this.console = console
    this.logLevel = logLevel
  }

  trace(message?: any, ...detail: any[]) {
    if (logLevelsMap[this.logLevel] > logLevelsMap.trace) {
      return
    }

    this.console.trace(message, ...detail)
    if (this.environment === 'production') {
      this.console.trace(this._marshal('trace', message, ...detail))
    }
  }

  debug(message?: any, ...detail: any[]) {
    if (logLevelsMap[this.logLevel] > logLevelsMap.debug) {
      return
    }

    this.console.debug(message, ...detail)
    if (this.environment === 'production') {
      this.console.debug(this._marshal('debug', message, ...detail))
    }
  }

  info(message?: any, ...detail: any[]) {
    if (logLevelsMap[this.logLevel] > logLevelsMap.info) {
      return
    }

    this.console.info(message, ...detail)
    if (this.environment === 'production') {
      this.console.info(this._marshal('info', message, ...detail))
    }
  }

  warn(message?: any, ...detail: any[]) {
    if (logLevelsMap[this.logLevel] > logLevelsMap.warn) {
      return
    }

    this.console.warn(message, ...detail)
    if (this.environment === 'production') {
      this.console.warn(this._marshal('warn', message, ...detail))
    }
  }

  error(message?: any, ...detail: any[]) {
    if (logLevelsMap[this.logLevel] > logLevelsMap.error) {
      return
    }

    this.console.error(message, ...detail)
    if (this.environment === 'production') {
      this.console.error(this._marshal('error', message, ...detail))
    }
  }

  protected _marshal(level: LogLevel, message?: any, ...detail: any[]): string {
    const log = {
      type: 'log',
      level,
      message,
      detail,
      time: Date.now(),
      env: this.environment,
      service: this.service,
      requestId: this.requestId,
      traceId: getTraceId(),
      metadata: this.metadata
    }

    if (level === 'error') {
      let foundError: Error | undefined
      for (const arg of detail) {
        if (!arg) {
          continue
        }

        if (arg instanceof Error) {
          foundError = arg
          break
        }

        if (typeof arg !== 'object') {
          continue
        }

        if ('err' in arg && arg.err instanceof Error) {
          foundError = arg.err
          break
        }

        if ('error' in arg && arg.error instanceof Error) {
          foundError = arg.error
          break
        }
      }

      if (foundError) {
        captureException(foundError)
      }
    }

    return JSON.stringify(log, null, this.environment === 'development' ? 2 : 0)
  }
}


================================================
FILE: packages/hono/src/logger/utils.ts
================================================
import { captureException, getActiveSpan, getRootSpan } from '@sentry/core'

/** Get the ID of the trace from the root span of the current span. */
export function getTraceId(): string | undefined {
  try {
    const activeSpan = getActiveSpan()
    const rootSpan = activeSpan ? getRootSpan(activeSpan) : undefined
    if (rootSpan) {
      const { traceId } = rootSpan.spanContext()
      return traceId
    }
    return undefined
  } catch (err) {
    captureException(err)
    return undefined
  }
}

/** Get the Sentry trace URL for the current span. */
export function getSentryTraceURL(): string {
  const traceId = getTraceId()
  return `https://agentic-platform.sentry.io/performance/trace/${traceId}`
}


================================================
FILE: packages/hono/src/middleware/access-logger.ts
================================================
import { createMiddleware } from 'hono/factory'
import { logger as honoLogger } from 'hono/logger'

import type { DefaultHonoEnv } from '../types'
import { unless } from './unless'

export const accessLogger = unless(
  createMiddleware<DefaultHonoEnv>(async (ctx, next) => {
    const logger = ctx.get('logger')
    const { isProd } = ctx.env

    const logMethod = isProd
      ? logger.trace.bind(logger)
      : logger.info.bind(logger)

    await honoLogger(logMethod)(ctx, next)
  }),
  // Ignore health check route
  '/v1/health',
  // Ignore openauth routes
  // '/authorize',
  '/userinfo',
  '/token',
  '/.well-known/jwks.json',
  '/.well-known/oauth-authorization-server'
)


================================================
FILE: packages/hono/src/middleware/index.ts
================================================
export * from './access-logger'
export * from './init'
export * from './response-time'
export * from './unless'
export { sentry } from '@hono/sentry'
export { compress } from 'hono/compress'
export { cors } from 'hono/cors'


================================================
FILE: packages/hono/src/middleware/init.ts
================================================
import { assert } from '@agentic/platform-core'
import { EventId } from 'eventid'
import { createMiddleware } from 'hono/factory'

import type { DefaultHonoEnv } from '../types'
import { ConsoleLogger } from '../logger'

// Monotonically increasing request IDs for logging / tracing.
let eventIdGenerator: EventId | undefined

export const init = createMiddleware<DefaultHonoEnv>(
  async function initMiddleware(ctx, next) {
    assert(ctx.env, 'env is required')

    if (!eventIdGenerator) {
      eventIdGenerator = new EventId()
    }

    const requestId = eventIdGenerator.new()
    ctx.set('requestId', requestId)
    ctx.res.headers.set('X-Request-Id', requestId)

    const logger = new ConsoleLogger(ctx.env, { requestId })
    ctx.set('logger', logger)
    ctx.set('isJsonRpcRequest', false)

    const ip =
      ctx.req.header('cf-connecting-ip') || ctx.req.header('x-forwarded-for')
    ctx.set('ip', ip)

    await next()
  }
)


================================================
FILE: packages/hono/src/middleware/response-time.ts
================================================
import { createMiddleware } from 'hono/factory'

import type { DefaultHonoEnv } from '../types'

export const responseTime = createMiddleware<DefaultHonoEnv>(
  async function responseTimeMiddleware(ctx, next) {
    const start = Date.now()
    await next()

    if (!ctx.finalized) {
      const duration = Date.now() - start
      ctx.res.headers.set('x-response-time', `${duration}ms`)
    }
  }
)


================================================
FILE: packages/hono/src/middleware/unless.ts
================================================
import type { MiddlewareHandler } from 'hono'

/**
 * Creates a hono middleware that only runs if the request path is not in the
 * excluded paths.
 */
export function unless(
  middleware: MiddlewareHandler,
  ...excluded: string[]
): MiddlewareHandler {
  const excludedPaths = new Set(excluded)

  return async (c, next) => {
    if (excludedPaths.has(c.req.path)) {
      return next()
    } else {
      return middleware(c, next)
    }
  }
}


================================================
FILE: packages/hono/src/sentry.test.ts
================================================
import * as SentryCloudflare from '@sentry/cloudflare'
import * as SentryNode from '@sentry/node'
import { expectTypeOf, test } from 'vitest'

import type { Sentry } from './sentry'

test('@sentry/node is compatible with simplified Sentry type', () => {
  expectTypeOf(SentryNode).toExtend<Sentry>()
  const sN: Sentry = SentryNode
  expectTypeOf(sN).toExtend<Sentry>()
})

test('@sentry/cloudflare is compatible with simplified Sentry type', () => {
  expectTypeOf(SentryCloudflare).toExtend<Sentry>()
  const sC: Sentry = SentryCloudflare
  expectTypeOf(sC).toExtend<Sentry>()
})


================================================
FILE: packages/hono/src/sentry.ts
================================================
import type { getActiveSpan, getRootSpan } from '@sentry/core'
import * as SentryCloudflare from '@sentry/cloudflare'
import * as SentryNode from '@sentry/node'

export type Sentry = {
  // Simplify the type a bit because the optional second hint argument has
  // changed between different core versions quite a bit.
  captureException: (exception: unknown) => void | string
  getActiveSpan: typeof getActiveSpan
  getRootSpan: typeof getRootSpan
}

export const sN: Sentry = SentryNode
export const sC: Sentry = SentryCloudflare


================================================
FILE: packages/hono/src/types.ts
================================================
import type { Logger } from '@agentic/platform-core'
import type { Context } from 'hono'
import type { Simplify } from 'type-fest'

import type { Env } from './env'
import type { Sentry } from './sentry'

export type { Env } from './env'
export type { Sentry } from './sentry'

export type Environment = Env['ENVIRONMENT']
export type Service = Env['SERVICE']

export type DefaultHonoVariables = {
  sentry: Sentry
  requestId: string
  logger: Logger
  isJsonRpcRequest?: boolean
  ip?: string
}

export type DefaultHonoBindings = Simplify<
  Env & {
    sentry: Sentry
  }
>

export type DefaultHonoEnv = {
  Bindings: DefaultHonoBindings
  Variables: DefaultHonoVariables
}

export type DefaultHonoContext = Context<DefaultHonoEnv>


================================================
FILE: packages/hono/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "../core/src/rate-limit-headers.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/json-schema/license
================================================
MIT License

Copyright (c) 2025 Travis Fischer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: packages/json-schema/package.json
================================================
{
  "name": "@agentic/json-schema",
  "version": "8.4.4",
  "description": "A JSON schema validator that will run on Cloudflare workers. Supports drafts 4, 7, 2019-09, and 2020-12.",
  "authors": [
    "Jeremy Danyow <jdanyow@gmail.com>",
    "Travis Fischer <travis@transitivebullsh.it>"
  ],
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/json-schema"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "devDependencies": {
    "json-schema-test-suite": "github:json-schema-org/JSON-Schema-Test-Suite#76b529f",
    "ky": "catalog:",
    "p-map": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  },
  "keywords": [
    "json-schema",
    "jsonschema",
    "json",
    "schema",
    "cloudflare",
    "worker",
    "workers",
    "service-worker"
  ]
}


================================================
FILE: packages/json-schema/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/json-schema"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-api-client.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

> [!NOTE]
> This package is a fork of [@cfworker/json-schema](https://github.com/cfworker/cfworker) which adds support for [ajv-style type coercion](https://ajv.js.org/coercion.html). Coercion is disabled by default, but can be enabled with a boolean flag.

# @agentic/json-schema

![](https://badgen.net/bundlephobia/minzip/@cfworker/json-schema)
![](https://badgen.net/bundlephobia/min/@cfworker/json-schema)
![](https://badgen.net/bundlephobia/dependency-count/@cfworker/json-schema)
![](https://badgen.net/bundlephobia/tree-shaking/@cfworker/json-schema)
![](https://badgen.net/npm/types/@cfworker/json-schema?icon=typescript)

A JSON schema validator that will run on Cloudflare workers. Supports drafts 4, 7, 2019-09, and 2020-12.

This library is validated against the [json-schema-test-suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite), a series of approximately 4,500 assertions maintained along with the json-schema specification. A small set of test cases are intentionally not supported due to performance constraints or lack of feature use. These list of unsupported features are maintained in [test/unsupported.ts](./test/unsupported.ts). While this library is not the fastest due to lack of code generation, it's consistently among the [most spec compliant](https://json-schema.org/implementations.html#benchmarks).

## Background

_Why another JSON schema validator?_

Cloudflare workers do not have APIs required by [Ajv](https://ajv.js.org/) schema compilation (`eval` or `new Function(code)`).
If possible use Ajv in a build step to precompile your schema. Otherwise this library could work for you.

## Basic usage

```js
import { Validator } from '@cfworker/json-schema'

const validator = new Validator({ type: 'number' })

const result = validator.validate(7)
```

## Specify meta schema draft

```js
const validator = new Validator({ type: 'number' }, '4') // draft-4
```

## Add schemas

```js
const validator = new Validator({
  $id: 'https://foo.bar/baz',
  $ref: '/beep'
})

validator.addSchema({ $id: 'https://foo.bar/beep', type: 'boolean' })
```

## Include all errors

By default the validator stops processing after the first error. Set the `shortCircuit` parameter to `false` to emit all errors.

```js
const shortCircuit = false;

const draft = '2019-09';

const schema = {
  type: 'object',
  required: ['name', 'email', 'number', 'bool'],
  properties: {
    name: { type: 'string' },
    email: { type: 'string', format: 'email' },
    number: { type: 'number' },
    bool: { type: 'boolean' }
  }
};

const validator = new Validator(schema, draft, shortCircuit);

const result = validator.validate({
  name: 'hello',
  email: 5, // invalid type
  number: 'Hello' // invalid type
  bool: 'false' // invalid type
});
```


================================================
FILE: packages/json-schema/src/coercion.ts
================================================
import type { InstanceType } from './types'

export function getInstanceType(
  instance: any
): Exclude<InstanceType, 'integer'> {
  const rawInstanceType = typeof instance
  switch (rawInstanceType) {
    case 'boolean':
    case 'number':
    case 'string':
      return rawInstanceType
    case 'object':
      if (instance === null) {
        return 'null'
      } else if (Array.isArray(instance)) {
        return 'array'
      } else {
        return 'object'
      }
    default:
      // undefined, bigint, function, symbol
      throw new Error(
        `Instances of "${rawInstanceType}" type are not supported.`
      )
  }
}

export function coerceValue({
  instanceType,
  instance,
  $type,
  recur = true
}: {
  instanceType: Exclude<InstanceType, 'integer'>
  instance: any
  $type: InstanceType
  recur?: boolean
}): any | undefined {
  if ($type === undefined) {
    return instance
  }

  if (Number.isNaN(instance)) {
    return undefined
  }

  let valid = true

  if ($type === 'integer') {
    if (instanceType !== 'number' || instance % 1 || Number.isNaN(instance)) {
      valid = false
    }
  } else if (instanceType !== $type) {
    valid = false
  }

  if (valid) {
    return instance
  }

  if (!recur) {
    return
  }

  switch ($type) {
    case 'integer':
    case 'number':
      switch (instanceType) {
        case 'string':
          instance = +instance
          break

        case 'boolean':
          instance = instance === true ? 1 : 0
          break

        case 'null':
          instance = 0
          break

        case 'array':
          if (instance.length === 1) {
            instance = instance[0]
          }
          break
      }

      if ($type === 'integer' && typeof instance === 'number') {
        instance = Math.floor(instance)
      }
      break

    case 'string':
      switch (instanceType) {
        case 'boolean':
          instance = instance === true ? 'true' : 'false'
          break

        case 'number':
          instance = String(instance)
          break

        case 'null':
          instance = ''
          break

        case 'array':
          if (instance.length === 1) {
            instance = instance[0]
          }
          break
      }
      break

    case 'boolean':
      switch (instanceType) {
        case 'string':
          if (instance === 'true') {
            instance = true
          } else if (instance === 'false') {
            instance = false
          }
          break

        case 'number':
          if (instance === 1) {
            instance = true
          } else if (instance === 0) {
            instance = false
          }
          break

        case 'null':
          instance = false
          break

        case 'array':
          if (instance.length === 1) {
            instance = instance[0]
          }
          break
      }
      break

    case 'null':
      switch (instanceType) {
        case 'string':
          if (instance === '') {
            instance = null
          }
          break

        case 'number':
          if (instance === 0) {
            instance = null
          }
          break

        case 'boolean':
          if (instance === false) {
            instance = null
          }
          break

        case 'array':
          if (instance.length === 1 && instance[0] === null) {
            instance = null
          }
          break
      }
      break

    case 'array':
      switch (instanceType) {
        case 'string':
          instance = [instance]
          break

        case 'number':
          instance = [instance]
          break

        case 'boolean':
          instance = [instance]
          break

        case 'null':
          instance = [null]
          break
      }
      break
  }

  return coerceValue({
    instanceType: getInstanceType(instance),
    instance,
    $type,
    recur: false
  })
}


================================================
FILE: packages/json-schema/src/deep-compare-strict.ts
================================================
export function deepCompareStrict(a: any, b: any): boolean {
  const typeofa = typeof a
  if (typeofa !== typeof b) {
    return false
  }
  if (Array.isArray(a)) {
    if (!Array.isArray(b)) {
      return false
    }
    const length = a.length
    if (length !== b.length) {
      return false
    }
    for (let i = 0; i < length; i++) {
      if (!deepCompareStrict(a[i], b[i])) {
        return false
      }
    }
    return true
  }
  if (typeofa === 'object') {
    if (!a || !b) {
      return a === b
    }
    const aKeys = Object.keys(a)
    const bKeys = Object.keys(b)
    const length = aKeys.length
    if (length !== bKeys.length) {
      return false
    }
    for (const k of aKeys) {
      if (!deepCompareStrict(a[k], b[k])) {
        return false
      }
    }
    return true
  }
  return a === b
}


================================================
FILE: packages/json-schema/src/dereference.ts
================================================
/* eslint-disable unicorn/no-thenable */
import type { Schema } from './types'
import { encodePointer } from './pointer'

export const schemaKeyword: Record<string, boolean> = {
  additionalItems: true,
  unevaluatedItems: true,
  items: true,
  contains: true,
  additionalProperties: true,
  unevaluatedProperties: true,
  propertyNames: true,
  not: true,
  if: true,
  then: true,
  else: true
}

export const schemaArrayKeyword: Record<string, boolean> = {
  prefixItems: true,
  items: true,
  allOf: true,
  anyOf: true,
  oneOf: true
}

export const schemaMapKeyword: Record<string, boolean> = {
  $defs: true,
  definitions: true,
  properties: true,
  patternProperties: true,
  dependentSchemas: true
}

export const ignoredKeyword: Record<string, boolean> = {
  id: true,
  $id: true,
  $ref: true,
  $schema: true,
  $anchor: true,
  $vocabulary: true,
  $comment: true,
  default: true,
  enum: true,
  const: true,
  required: true,
  type: true,
  maximum: true,
  minimum: true,
  exclusiveMaximum: true,
  exclusiveMinimum: true,
  multipleOf: true,
  maxLength: true,
  minLength: true,
  pattern: true,
  format: true,
  maxItems: true,
  minItems: true,
  uniqueItems: true,
  maxProperties: true,
  minProperties: true
}

/**
 * Default base URI for schemas without an $id.
 * https://json-schema.org/draft/2019-09/json-schema-core.html#initial-base
 * https://tools.ietf.org/html/rfc3986#section-5.1
 */
export const initialBaseURI: URL = (globalThis as any)?.self?.location?.origin
  ? new URL(
      (globalThis as any).self.location.origin +
        (globalThis as any).self.location.pathname +
        (globalThis as any).self.location.search
    )
  : new URL('https://github.com/transitive-bullshit/agentic')

export function dereference(
  schema: Schema | boolean,
  lookup: Record<string, Schema | boolean> = Object.create(null),
  baseURI: URL = initialBaseURI,
  basePointer = ''
): Record<string, Schema | boolean> {
  if (schema && typeof schema === 'object' && !Array.isArray(schema)) {
    const id: string = schema.$id || schema.id
    if (id) {
      const url = new URL(id, baseURI.href)
      if (url.hash.length > 1) {
        lookup[url.href] = schema
      } else {
        url.hash = '' // normalize hash https://url.spec.whatwg.org/#dom-url-hash
        if (basePointer === '') {
          baseURI = url
        } else {
          dereference(schema, lookup, baseURI)
        }
      }
    }
  } else if (schema !== true && schema !== false) {
    return lookup
  }

  // compute the schema's URI and add it to the mapping.
  const schemaURI = baseURI.href + (basePointer ? '#' + basePointer : '')
  if (lookup[schemaURI] !== undefined) {
    throw new Error(`Duplicate schema URI "${schemaURI}".`)
  }
  lookup[schemaURI] = schema

  // exit early if this is a boolean schema.
  if (schema === true || schema === false) {
    return lookup
  }

  // set the schema's absolute URI.
  if (schema.__absolute_uri__ === undefined) {
    Object.defineProperty(schema, '__absolute_uri__', {
      enumerable: false,
      value: schemaURI
    })
  }

  // if a $ref is found, resolve it's absolute URI.
  if (schema.$ref && schema.__absolute_ref__ === undefined) {
    const url = new URL(schema.$ref, baseURI.href)
    // eslint-disable-next-line no-self-assign
    url.hash = url.hash // normalize hash https://url.spec.whatwg.org/#dom-url-hash
    Object.defineProperty(schema, '__absolute_ref__', {
      enumerable: false,
      value: url.href
    })
  }

  // if a $recursiveRef is found, resolve it's absolute URI.
  if (schema.$recursiveRef && schema.__absolute_recursive_ref__ === undefined) {
    const url = new URL(schema.$recursiveRef, baseURI.href)
    // eslint-disable-next-line no-self-assign
    url.hash = url.hash // normalize hash https://url.spec.whatwg.org/#dom-url-hash
    Object.defineProperty(schema, '__absolute_recursive_ref__', {
      enumerable: false,
      value: url.href
    })
  }

  // if an $anchor is found, compute it's URI and add it to the mapping.
  if (schema.$anchor) {
    const url = new URL('#' + schema.$anchor, baseURI.href)
    lookup[url.href] = schema
  }

  // process subschemas.
  for (const key in schema) {
    if (ignoredKeyword[key]) {
      continue
    }
    const keyBase = `${basePointer}/${encodePointer(key)}`
    const subSchema = schema[key]
    if (Array.isArray(subSchema)) {
      if (schemaArrayKeyword[key]) {
        const length = subSchema.length
        for (let i = 0; i < length; i++) {
          dereference(subSchema[i]!, lookup, baseURI, `${keyBase}/${i}`)
        }
      }
    } else if (schemaMapKeyword[key]) {
      for (const subKey in subSchema) {
        dereference(
          subSchema[subKey]!,
          lookup,
          baseURI,
          `${keyBase}/${encodePointer(subKey)}`
        )
      }
    } else {
      dereference(subSchema, lookup, baseURI, keyBase)
    }
  }

  return lookup
}

// schema identification examples
// https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.appendix.A
// $ref delegation
// https://github.com/json-schema-org/json-schema-spec/issues/514
// output format
// https://json-schema.org/draft/2019-09/json-schema-core.html#output
// JSON pointer
// https://tools.ietf.org/html/rfc6901
// JSON relative pointer
// https://tools.ietf.org/html/draft-handrews-relative-json-pointer-01


================================================
FILE: packages/json-schema/src/format.ts
================================================
/* eslint-disable @typescript-eslint/naming-convention */
/* eslint-disable no-control-regex */
/* eslint-disable security/detect-unsafe-regex */
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-nocheck
// based on https://github.com/epoberezkin/ajv/blob/master/lib/compile/formats.js

const DATE = /^(\d\d\d\d)-(\d\d)-(\d\d)$/
const DAYS = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
const TIME = /^(\d\d):(\d\d):(\d\d)(\.\d+)?(z|[+-]\d\d(?::?\d\d)?)?$/i
const HOSTNAME =
  /^(?=.{1,253}\.?$)[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[-0-9a-z]{0,61}[0-9a-z])?)*\.?$/i
// const URI = /^(?:[a-z][a-z0-9+\-.]*:)(?:\/?\/(?:(?:[a-z0-9\-._~!$&'()*+,;=:]|%[0-9a-f]{2})*@)?(?:\[(?:(?:(?:(?:[0-9a-f]{1,4}:){6}|::(?:[0-9a-f]{1,4}:){5}|(?:[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){4}|(?:(?:[0-9a-f]{1,4}:){0,1}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){3}|(?:(?:[0-9a-f]{1,4}:){0,2}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){2}|(?:(?:[0-9a-f]{1,4}:){0,3}[0-9a-f]{1,4})?::[0-9a-f]{1,4}:|(?:(?:[0-9a-f]{1,4}:){0,4}[0-9a-f]{1,4})?::)(?:[0-9a-f]{1,4}:[0-9a-f]{1,4}|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?))|(?:(?:[0-9a-f]{1,4}:){0,5}[0-9a-f]{1,4})?::[0-9a-f]{1,4}|(?:(?:[0-9a-f]{1,4}:){0,6}[0-9a-f]{1,4})?::)|[Vv][0-9a-f]+\.[a-z0-9\-._~!$&'()*+,;=:]+)\]|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?)|(?:[a-z0-9\-._~!$&'()*+,;=]|%[0-9a-f]{2})*)(?::\d*)?(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*|\/(?:(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*)?|(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*)(?:\?(?:[a-z0-9\-._~!$&'()*+,;=:@/?]|%[0-9a-f]{2})*)?(?:#(?:[a-z0-9\-._~!$&'()*+,;=:@/?]|%[0-9a-f]{2})*)?$/i;
const URIREF =
  /^(?:[a-z][a-z0-9+\-.]*:)?(?:\/?\/(?:(?:[a-z0-9\-._~!$&'()*+,;=:]|%[0-9a-f]{2})*@)?(?:\[(?:(?:(?:(?:[0-9a-f]{1,4}:){6}|::(?:[0-9a-f]{1,4}:){5}|(?:[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){4}|(?:(?:[0-9a-f]{1,4}:){0,1}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){3}|(?:(?:[0-9a-f]{1,4}:){0,2}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){2}|(?:(?:[0-9a-f]{1,4}:){0,3}[0-9a-f]{1,4})?::[0-9a-f]{1,4}:|(?:(?:[0-9a-f]{1,4}:){0,4}[0-9a-f]{1,4})?::)(?:[0-9a-f]{1,4}:[0-9a-f]{1,4}|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?))|(?:(?:[0-9a-f]{1,4}:){0,5}[0-9a-f]{1,4})?::[0-9a-f]{1,4}|(?:(?:[0-9a-f]{1,4}:){0,6}[0-9a-f]{1,4})?::)|[Vv][0-9a-f]+\.[a-z0-9\-._~!$&'()*+,;=:]+)\]|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?)|(?:[a-z0-9\-._~!$&'"()*+,;=]|%[0-9a-f]{2})*)(?::\d*)?(?:\/(?:[a-z0-9\-._~!$&'"()*+,;=:@]|%[0-9a-f]{2})*)*|\/(?:(?:[a-z0-9\-._~!$&'"()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'"()*+,;=:@]|%[0-9a-f]{2})*)*)?|(?:[a-z0-9\-._~!$&'"()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'"()*+,;=:@]|%[0-9a-f]{2})*)*)?(?:\?(?:[a-z0-9\-._~!$&'"()*+,;=:@/?]|%[0-9a-f]{2})*)?(?:#(?:[a-z0-9\-._~!$&'"()*+,;=:@/?]|%[0-9a-f]{2})*)?$/i
// uri-template: https://tools.ietf.org/html/rfc6570
const URITEMPLATE =
  /^(?:(?:[^\u0000-\u0020"'<>%\\^`{|}]|%[0-9a-f]{2})|\{[+#./;?&=,!@|]?(?:[a-z0-9_]|%[0-9a-f]{2})+(?::[1-9][0-9]{0,3}|\*)?(?:,(?:[a-z0-9_]|%[0-9a-f]{2})+(?::[1-9][0-9]{0,3}|\*)?)*\})*$/i
// For the source: https://gist.github.com/dperini/729294
// For test cases: https://mathiasbynens.be/demo/url-regex
const URL_ =
  /^(?:(?:https?|ftp):\/\/)(?:\S+(?::\S*)?@)?(?:(?!10(?:\.\d{1,3}){3})(?!127(?:\.\d{1,3}){3})(?!169\.254(?:\.\d{1,3}){2})(?!192\.168(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u{00A1}-\u{FFFF}0-9]+-?)*[a-z\u{00A1}-\u{FFFF}0-9]+)(?:\.(?:[a-z\u{00A1}-\u{FFFF}0-9]+-?)*[a-z\u{00A1}-\u{FFFF}0-9]+)*(?:\.(?:[a-z\u{00A1}-\u{FFFF}]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/iu
const UUID = /^(?:urn:uuid:)?[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/i
const JSON_POINTER = /^(?:\/(?:[^~/]|~0|~1)*)*$/
const JSON_POINTER_URI_FRAGMENT =
  /^#(?:\/(?:[a-z0-9_\-.!$&'()*+,;:=@]|%[0-9a-f]{2}|~0|~1)*)*$/i
const RELATIVE_JSON_POINTER = /^(?:0|[1-9][0-9]*)(?:#|(?:\/(?:[^~/]|~0|~1)*)*)$/

// // date: http://tools.ietf.org/html/rfc3339#section-5.6
// const FASTDATE = /^\d\d\d\d-[0-1]\d-[0-3]\d$/;
// // date-time: http://tools.ietf.org/html/rfc3339#section-5.6
// const FASTTIME =
//   /^(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:z|[+-]\d\d(?::?\d\d)?)?$/i;
// const FASTDATETIME =
//   /^\d\d\d\d-[0-1]\d-[0-3]\d[t\s](?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:z|[+-]\d\d(?::?\d\d)?)$/i;
// // uri: https://github.com/mafintosh/is-my-json-valid/blob/master/formats.js
// // const FASTURI = /^(?:[a-z][a-z0-9+-.]*:)(?:\/?\/)?[^\s]*$/i;
// const FASTURIREFERENCE =
//   /^(?:(?:[a-z][a-z0-9+-.]*:)?\/?\/)?(?:[^\\\s#][^\s#]*)?(?:#[^\\\s]*)?$/i;

// https://github.com/ExodusMovement/schemasafe/blob/master/src/formats.js
const EMAIL = (input: string) => {
  if (input[0] === '"') return false
  const [name, host, ...rest] = input.split('@')
  if (
    !name ||
    !host ||
    rest.length !== 0 ||
    name.length > 64 ||
    host.length > 253
  )
    return false
  if (name[0] === '.' || name.endsWith('.') || name.includes('..')) return false
  if (
    !/^[a-z0-9.-]+$/i.test(host) ||
    !/^[a-z0-9.!#$%&'*+/=?^_`{|}~-]+$/i.test(name)
  )
    return false
  return host
    .split('.')
    .every((part) => /^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$/i.test(part))
}

// optimized https://www.safaribooksonline.com/library/view/regular-expressions-cookbook/9780596802837/ch07s16.html
const IPV4 =
  /^(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?)$/
// optimized http://stackoverflow.com/questions/53497/regular-expression-that-matches-valid-ipv6-addresses
const IPV6 =
  /^((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))$/i

// https://github.com/ExodusMovement/schemasafe/blob/master/src/formats.js
const DURATION = (input: string) =>
  input.length > 1 &&
  input.length < 80 &&
  (/^P\d+([.,]\d+)?W$/.test(input) ||
    (/^P[\dYMDTHS]*(\d[.,]\d+)?[YMDHS]$/.test(input) &&
      /^P([.,\d]+Y)?([.,\d]+M)?([.,\d]+D)?(T([.,\d]+H)?([.,\d]+M)?([.,\d]+S)?)?$/.test(
        input
      )))

function bind(r: RegExp) {
  return r.test.bind(r)
}

export const format: Record<string, (s: string) => boolean> = {
  date,
  time: time.bind(undefined, false),
  'date-time': date_time,
  duration: DURATION,
  uri,
  'uri-reference': bind(URIREF),
  'uri-template': bind(URITEMPLATE),
  url: bind(URL_),
  email: EMAIL,
  hostname: bind(HOSTNAME),
  ipv4: bind(IPV4),
  ipv6: bind(IPV6),
  regex,
  uuid: bind(UUID),
  'json-pointer': bind(JSON_POINTER),
  'json-pointer-uri-fragment': bind(JSON_POINTER_URI_FRAGMENT),
  'relative-json-pointer': bind(RELATIVE_JSON_POINTER)
}

function isLeapYear(year: number) {
  // https://tools.ietf.org/html/rfc3339#appendix-C
  return year % 4 === 0 && (year % 100 !== 0 || year % 400 === 0)
}

function date(str: string) {
  // full-date from http://tools.ietf.org/html/rfc3339#section-5.6
  const matches = str.match(DATE)
  if (!matches) return false

  const year = +matches[1]
  const month = +matches[2]
  const day = +matches[3]

  return (
    month >= 1 &&
    month <= 12 &&
    day >= 1 &&
    day <= (month === 2 && isLeapYear(year) ? 29 : DAYS[month])
  )
}

function time(full: boolean, str: string) {
  const matches = str.match(TIME)
  if (!matches) return false

  const hour = +matches[1]
  const minute = +matches[2]
  const second = +matches[3]
  const timeZone = !!matches[5]
  return (
    ((hour <= 23 && minute <= 59 && second <= 59) ||
      (hour === 23 && minute === 59 && second === 60)) &&
    (!full || timeZone)
  )
}

const DATE_TIME_SEPARATOR = /t|\s/i
function date_time(str: string) {
  // http://tools.ietf.org/html/rfc3339#section-5.6
  const dateTime = str.split(DATE_TIME_SEPARATOR)
  return dateTime.length === 2 && date(dateTime[0]) && time(true, dateTime[1])
}

const NOT_URI_FRAGMENT = /\/|:/
const URI_PATTERN =
  /^(?:[a-z][a-z0-9+\-.]*:)(?:\/?\/(?:(?:[a-z0-9\-._~!$&'()*+,;=:]|%[0-9a-f]{2})*@)?(?:\[(?:(?:(?:(?:[0-9a-f]{1,4}:){6}|::(?:[0-9a-f]{1,4}:){5}|(?:[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){4}|(?:(?:[0-9a-f]{1,4}:){0,1}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){3}|(?:(?:[0-9a-f]{1,4}:){0,2}[0-9a-f]{1,4})?::(?:[0-9a-f]{1,4}:){2}|(?:(?:[0-9a-f]{1,4}:){0,3}[0-9a-f]{1,4})?::[0-9a-f]{1,4}:|(?:(?:[0-9a-f]{1,4}:){0,4}[0-9a-f]{1,4})?::)(?:[0-9a-f]{1,4}:[0-9a-f]{1,4}|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?))|(?:(?:[0-9a-f]{1,4}:){0,5}[0-9a-f]{1,4})?::[0-9a-f]{1,4}|(?:(?:[0-9a-f]{1,4}:){0,6}[0-9a-f]{1,4})?::)|[Vv][0-9a-f]+\.[a-z0-9\-._~!$&'()*+,;=:]+)\]|(?:(?:25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d?)|(?:[a-z0-9\-._~!$&'()*+,;=]|%[0-9a-f]{2})*)(?::\d*)?(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*|\/(?:(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*)?|(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})+(?:\/(?:[a-z0-9\-._~!$&'()*+,;=:@]|%[0-9a-f]{2})*)*)(?:\?(?:[a-z0-9\-._~!$&'()*+,;=:@/?]|%[0-9a-f]{2})*)?(?:#(?:[a-z0-9\-._~!$&'()*+,;=:@/?]|%[0-9a-f]{2})*)?$/i

function uri(str: string): boolean {
  // http://jmrware.com/articles/2009/uri_regexp/URI_regex.html + optional protocol + required "."
  return NOT_URI_FRAGMENT.test(str) && URI_PATTERN.test(str)
}

const Z_ANCHOR = /[^\\]\\Z/
function regex(str: string) {
  if (Z_ANCHOR.test(str)) return false
  try {
    // eslint-disable-next-line security/detect-non-literal-regexp
    new RegExp(str, 'u')
    return true
  } catch {
    return false
  }
}


================================================
FILE: packages/json-schema/src/index.ts
================================================
export * from './coercion'
export * from './deep-compare-strict'
export * from './dereference'
export * from './format'
export * from './pointer'
export * from './types'
export * from './ucs2-length'
export * from './validate'
export * from './validator'


================================================
FILE: packages/json-schema/src/pointer.ts
================================================
export function encodePointer(p: string): string {
  return encodeURI(escapePointer(p))
}

export function escapePointer(p: string): string {
  return p.replaceAll('~', '~0').replaceAll('/', '~1')
}


================================================
FILE: packages/json-schema/src/types.ts
================================================
export type SchemaDraft = '4' | '7' | '2019-09' | '2020-12'

export const enum OutputFormat {
  Flag = 1,
  Basic = 2,
  Detailed = 4
}

export type InstanceType =
  | 'array'
  | 'boolean'
  | 'integer'
  | 'null'
  | 'number'
  | 'object'
  | 'string'

export interface Schema {
  $id?: string
  $anchor?: string
  $recursiveAnchor?: boolean
  $ref?: string
  $recursiveRef?: '#'
  $schema?: string
  $comment?: string
  $defs?: any
  $vocabulary?: Record<string, boolean>

  type?: InstanceType | InstanceType[]
  const?: any
  enum?: any[]
  required?: string[]
  not?: Schema
  anyOf?: Schema[]
  allOf?: Schema[]
  oneOf?: Schema[]
  if?: Schema
  then?: Schema
  else?: Schema

  format?: string

  properties?: Record<string | number, Schema | boolean>
  patternProperties?: Record<string, Schema | boolean>
  additionalProperties?: Schema | boolean
  unevaluatedProperties?: Schema | boolean
  minProperties?: number
  maxProperties?: number
  propertyNames?: Schema
  dependentRequired?: Record<string, string[]>
  dependentSchemas?: Record<string, Schema>
  dependencies?: Record<string, Schema | string[]>

  prefixItems?: Array<Schema | boolean>
  items?: Schema | boolean | Array<Schema | boolean>
  additionalItems?: Schema | boolean
  unevaluatedItems?: Schema | boolean
  contains?: Schema | boolean
  minContains?: number
  maxContains?: number
  minItems?: number
  maxItems?: number
  uniqueItems?: boolean

  minimum?: number
  maximum?: number
  exclusiveMinimum?: number | boolean
  exclusiveMaximum?: number | boolean
  multipleOf?: number

  minLength?: number
  maxLength?: number
  pattern?: string

  __absolute_ref__?: string
  __absolute_recursive_ref__?: string
  __absolute_uri__?: string

  [key: string]: any
}

export interface OutputUnit {
  keyword: string
  keywordLocation: string
  instanceLocation: string
  error: string
}

export type ValidationResult = {
  valid: boolean
  errors: OutputUnit[]
  instance: any
}


================================================
FILE: packages/json-schema/src/ucs2-length.ts
================================================
/* eslint-disable eqeqeq */
/* eslint-disable unicorn/prefer-code-point */

/**
 * Get UCS-2 length of a string
 * https://mathiasbynens.be/notes/javascript-encoding
 * https://github.com/bestiejs/punycode.js - punycode.ucs2.decode
 */
export function ucs2length(s: string): number {
  const length = s.length
  let result = 0
  let index = 0
  let charCode: number
  while (index < length) {
    result++
    charCode = s.charCodeAt(index++)
    if (charCode >= 0xd8_00 && charCode <= 0xdb_ff && index < length) {
      // high surrogate, and there is a next character
      charCode = s.charCodeAt(index)
      if ((charCode & 0xfc_00) == 0xdc_00) {
        // low surrogate
        index++
      }
    }
  }
  return result
}


================================================
FILE: packages/json-schema/src/validate.ts
================================================
/* eslint-disable security/detect-non-literal-regexp */
import type { OutputUnit, Schema, SchemaDraft, ValidationResult } from './types'
import { coerceValue, getInstanceType } from './coercion'
import { deepCompareStrict } from './deep-compare-strict'
import { dereference } from './dereference'
import { format } from './format'
import { encodePointer } from './pointer'
import { ucs2length } from './ucs2-length'

export type Evaluated = Record<string | number, boolean>

export function validate(
  instance: any,
  schema: Schema | boolean,
  opts: {
    draft?: SchemaDraft
    lookup?: Record<string, Schema | boolean>
    coerce?: boolean
    shortCircuit?: boolean
    recursiveAnchor?: Schema | null
    instanceLocation?: string
    schemaLocation?: string
    evaluated?: Evaluated
    strictAdditionalProperties?: boolean
  } = {}
): ValidationResult {
  const {
    draft = '2019-09',
    lookup = dereference(schema),
    coerce = false,
    shortCircuit = true,
    instanceLocation = '#',
    schemaLocation = '#',
    evaluated = Object.create(null),
    strictAdditionalProperties = false
  } = opts
  let { recursiveAnchor = null } = opts

  if (schema === true) {
    return { valid: true, errors: [], instance }
  }

  if (schema === false) {
    return {
      valid: false,
      instance,
      errors: [
        {
          instanceLocation,
          keyword: 'false',
          keywordLocation: instanceLocation,
          error: 'False boolean schema.'
        }
      ]
    }
  }

  let instanceType = getInstanceType(instance)

  const {
    $ref,
    $recursiveRef,
    $recursiveAnchor,
    type: $type,
    const: $const,
    enum: $enum,
    required: $required,
    not: $not,
    anyOf: $anyOf,
    allOf: $allOf,
    oneOf: $oneOf,
    if: $if,
    then: $then,
    else: $else,

    format: $format,

    properties: $properties,
    patternProperties: $patternProperties,
    additionalProperties: $additionalProperties,
    unevaluatedProperties: $unevaluatedProperties,
    minProperties: $minProperties,
    maxProperties: $maxProperties,
    propertyNames: $propertyNames,
    dependentRequired: $dependentRequired,
    dependentSchemas: $dependentSchemas,
    dependencies: $dependencies,

    prefixItems: $prefixItems,
    items: $items,
    additionalItems: $additionalItems,
    unevaluatedItems: $unevaluatedItems,
    contains: $contains,
    minContains: $minContains,
    maxContains: $maxContains,
    minItems: $minItems,
    maxItems: $maxItems,
    uniqueItems: $uniqueItems,

    minimum: $minimum,
    maximum: $maximum,
    exclusiveMinimum: $exclusiveMinimum,
    exclusiveMaximum: $exclusiveMaximum,
    multipleOf: $multipleOf,

    minLength: $minLength,
    maxLength: $maxLength,
    pattern: $pattern,

    // eslint-disable-next-line @typescript-eslint/naming-convention
    __absolute_ref__,

    // eslint-disable-next-line @typescript-eslint/naming-convention
    __absolute_recursive_ref__
  } = schema

  const errors: OutputUnit[] = []

  if ($recursiveAnchor === true && recursiveAnchor === null) {
    recursiveAnchor = schema
  }

  if ($recursiveRef === '#') {
    const refSchema =
      recursiveAnchor === null
        ? (lookup[__absolute_recursive_ref__!] as Schema)
        : recursiveAnchor
    const keywordLocation = `${schemaLocation}/$recursiveRef`
    const result = validate(
      instance,
      recursiveAnchor === null ? schema : recursiveAnchor,
      {
        ...opts,
        lookup,
        recursiveAnchor: refSchema,
        instanceLocation,
        schemaLocation: keywordLocation,
        evaluated
      }
    )
    if (result.valid) {
      instance = result.instance
    } else {
      errors.push(
        {
          instanceLocation,
          keyword: '$recursiveRef',
          keywordLocation,
          error: 'A subschema had errors.'
        },
        ...result.errors
      )
    }
  }

  if ($ref !== undefined) {
    const uri = __absolute_ref__ || $ref
    const refSchema = lookup[uri]
    if (refSchema === undefined) {
      let message = `Unresolved $ref "${$ref}".`
      if (__absolute_ref__ && __absolute_ref__ !== $ref) {
        message += `  Absolute URI "${__absolute_ref__}".`
      }
      message += `\nKnown schemas:\n- ${Object.keys(lookup).join('\n- ')}`
      throw new Error(message)
    }
    const keywordLocation = `${schemaLocation}/$ref`
    const result = validate(instance, refSchema, {
      ...opts,
      lookup,
      recursiveAnchor,
      instanceLocation,
      schemaLocation: keywordLocation,
      evaluated
    })
    if (result.valid) {
      instance = result.instance
    } else {
      errors.push(
        {
          instanceLocation,
          keyword: '$ref',
          keywordLocation,
          error: 'A subschema had errors.'
        },
        ...result.errors
      )
    }
    if (draft === '4' || draft === '7') {
      return { valid: errors.length === 0, instance, errors }
    }
  }

  if (Array.isArray($type)) {
    const length = $type.length
    let valid = false
    for (let i = 0; i < length; i++) {
      if (
        instanceType === $type[i] ||
        ($type[i] === 'integer' &&
          instanceType === 'number' &&
          instance % 1 === 0 &&
          Number.isNaN(instance))
      ) {
        valid = true
        break
      }
    }
    if (!valid) {
      errors.push({
        instanceLocation,
        keyword: 'type',
        keywordLocation: `${schemaLocation}/type`,
        error: `Instance type "${instanceType}" is invalid. Expected "${$type.join(
          '", "'
        )}".`
      })
    }
  } else if ($type === 'integer') {
    if (instanceType !== 'number' || instance % 1 || Number.isNaN(instance)) {
      const coercedInstance = coerce
        ? coerceValue({
            instance,
            instanceType,
            $type
          })
        : undefined

      if (coercedInstance !== undefined) {
        instance = coercedInstance
        instanceType = getInstanceType(instance)
      } else {
        errors.push({
          instanceLocation,
          keyword: 'type',
          keywordLocation: `${schemaLocation}/type`,
          error: `Instance type "${instanceType}" is invalid. Expected "${$type}".`
        })
      }
    }
  } else if ($type !== undefined && instanceType !== $type) {
    const coercedInstance = coerce
      ? coerceValue({
          instance,
          instanceType,
          $type
        })
      : undefined

    if (coercedInstance !== undefined) {
      instance = coercedInstance
      instanceType = getInstanceType(instance)
    } else {
      errors.push({
        instanceLocation,
        keyword: 'type',
        keywordLocation: `${schemaLocation}/type`,
        error: `Instance type "${instanceType}" is invalid. Expected "${$type}".`
      })
    }
  }

  if ($const !== undefined) {
    if (instanceType === 'object' || instanceType === 'array') {
      if (!deepCompareStrict(instance, $const)) {
        errors.push({
          instanceLocation,
          keyword: 'const',
          keywordLocation: `${schemaLocation}/const`,
          error: `Instance does not match ${JSON.stringify($const)}.`
        })
      }
    } else if (instance !== $const) {
      errors.push({
        instanceLocation,
        keyword: 'const',
        keywordLocation: `${schemaLocation}/const`,
        error: `Instance does not match ${JSON.stringify($const)}.`
      })
    }
  }

  if ($enum !== undefined) {
    if (instanceType === 'object' || instanceType === 'array') {
      if (!$enum.some((value) => deepCompareStrict(instance, value))) {
        errors.push({
          instanceLocation,
          keyword: 'enum',
          keywordLocation: `${schemaLocation}/enum`,
          error: `Instance does not match any of ${JSON.stringify($enum)}.`
        })
      }
    } else if (!$enum.includes(instance)) {
      errors.push({
        instanceLocation,
        keyword: 'enum',
        keywordLocation: `${schemaLocation}/enum`,
        error: `Instance does not match any of ${JSON.stringify($enum)}.`
      })
    }
  }

  // TODO: type coercion
  if ($not !== undefined) {
    const keywordLocation = `${schemaLocation}/not`
    const result = validate(instance, $not, {
      ...opts,
      lookup,
      recursiveAnchor,
      instanceLocation,
      schemaLocation: keywordLocation
      // evaluated
    })
    if (result.valid) {
      errors.push({
        instanceLocation,
        keyword: 'not',
        keywordLocation,
        error: 'Instance matched "not" schema.'
      })
    }
  }

  const subEvaluateds: Array<Evaluated> = []

  // TODO: type coercion
  if ($anyOf !== undefined) {
    const keywordLocation = `${schemaLocation}/anyOf`
    const errorsLength = errors.length
    let anyValid = false
    for (const [i, subSchema] of $anyOf.entries()) {
      const subEvaluated: Evaluated = Object.create(evaluated)
      const result = validate(instance, subSchema, {
        ...opts,
        lookup,
        recursiveAnchor: $recursiveAnchor === true ? recursiveAnchor : null,
        instanceLocation,
        schemaLocation: `${keywordLocation}/${i}`,
        evaluated: subEvaluated
      })
      errors.push(...result.errors)
      anyValid = anyValid || result.valid
      if (result.valid) {
        subEvaluateds.push(subEvaluated)
      }
    }
    if (anyValid) {
      errors.length = errorsLength
    } else {
      errors.splice(errorsLength, 0, {
        instanceLocation,
        keyword: 'anyOf',
        keywordLocation,
        error: 'Instance does not match any subschemas.'
      })
    }
  }

  // TODO: type coercion
  if ($allOf !== undefined) {
    const keywordLocation = `${schemaLocation}/allOf`
    const errorsLength = errors.length
    let allValid = true
    for (const [i, subSchema] of $allOf.entries()) {
      const subEvaluated: Evaluated = Object.create(evaluated)
      const result = validate(instance, subSchema, {
        ...opts,
        lookup,
        recursiveAnchor: $recursiveAnchor === true ? recursiveAnchor : null,
        instanceLocation,
        schemaLocation: `${keywordLocation}/${i}`,
        evaluated: subEvaluated
      })
      errors.push(...result.errors)
      allValid = allValid && result.valid
      if (result.valid) {
        subEvaluateds.push(subEvaluated)
      }
    }
    if (allValid) {
      errors.length = errorsLength
    } else {
      errors.splice(errorsLength, 0, {
        instanceLocation,
        keyword: 'allOf',
        keywordLocation,
        error: `Instance does not match every subschema.`
      })
    }
  }

  // TODO: type coercion
  if ($oneOf !== undefined) {
    const keywordLocation = `${schemaLocation}/oneOf`
    const errorsLength = errors.length
    const matches = $oneOf.filter((subSchema, i) => {
      const subEvaluated: Evaluated = Object.create(evaluated)
      const result = validate(instance, subSchema, {
        ...opts,
        lookup,
        recursiveAnchor: $recursiveAnchor === true ? recursiveAnchor : null,
        instanceLocation,
        schemaLocation: `${keywordLocation}/${i}`,
        evaluated: subEvaluated
      })
      errors.push(...result.errors)
      if (result.valid) {
        subEvaluateds.push(subEvaluated)
      }
      return result.valid
    }).length
    if (matches === 1) {
      errors.length = errorsLength
    } else {
      errors.splice(errorsLength, 0, {
        instanceLocation,
        keyword: 'oneOf',
        keywordLocation,
        error: `Instance does not match exactly one subschema (${matches} matches).`
      })
    }
  }

  if (instanceType === 'object' || instanceType === 'array') {
    Object.assign(evaluated, ...subEvaluateds)
  }

  if ($if !== undefined) {
    const keywordLocation = `${schemaLocation}/if`
    const conditionResult = validate(instance, $if, {
      ...opts,
      lookup,
      recursiveAnchor,
      instanceLocation,
      schemaLocation: keywordLocation,
      evaluated
    }).valid
    if (conditionResult) {
      if ($then !== undefined) {
        const thenResult = validate(instance, $then, {
          ...opts,
          lookup,
          recursiveAnchor,
          instanceLocation,
          schemaLocation: `${schemaLocation}/then`,
          evaluated
        })
        if (thenResult.valid) {
          instance = thenResult.instance
        } else {
          errors.push(
            {
              instanceLocation,
              keyword: 'if',
              keywordLocation,
              error: `Instance does not match "then" schema.`
            },
            ...thenResult.errors
          )
        }
      }
    } else if ($else !== undefined) {
      const elseResult = validate(instance, $else, {
        ...opts,
        lookup,
        recursiveAnchor,
        instanceLocation,
        schemaLocation: `${schemaLocation}/else`,
        evaluated
      })
      if (elseResult.valid) {
        instance = elseResult.instance
      } else {
        errors.push(
          {
            instanceLocation,
            keyword: 'if',
            keywordLocation,
            error: `Instance does not match "else" schema.`
          },
          ...elseResult.errors
        )
      }
    }
  }

  if (instanceType === 'object') {
    if ($required !== undefined) {
      for (const key of $required) {
        if (!(key in instance)) {
          errors.push({
            instanceLocation,
            keyword: 'required',
            keywordLocation: `${schemaLocation}/required`,
            error: `Instance does not have required property "${key}".`
          })
        }
      }
    }

    const keys = Object.keys(instance)

    if ($minProperties !== undefined && keys.length < $minProperties) {
      errors.push({
        instanceLocation,
        keyword: 'minProperties',
        keywordLocation: `${schemaLocation}/minProperties`,
        error: `Instance does not have at least ${$minProperties} properties.`
      })
    }

    if ($maxProperties !== undefined && keys.length > $maxProperties) {
      errors.push({
        instanceLocation,
        keyword: 'maxProperties',
        keywordLocation: `${schemaLocation}/maxProperties`,
        error: `Instance does not have at least ${$maxProperties} properties.`
      })
    }

    if ($propertyNames !== undefined) {
      const keywordLocation = `${schemaLocation}/propertyNames`
      for (const key in instance) {
        const subInstancePointer = `${instanceLocation}/${encodePointer(key)}`
        const result = validate(key, $propertyNames, {
          ...opts,
          lookup,
          recursiveAnchor,
          instanceLocation: subInstancePointer,
          schemaLocation: keywordLocation
        })
        if (!result.valid) {
          errors.push(
            {
              instanceLocation,
              keyword: 'propertyNames',
              keywordLocation,
              error: `Property name "${key}" does not match schema.`
            },
            ...result.errors
          )
        }
      }
    }

    if ($dependentRequired !== undefined) {
      const keywordLocation = `${schemaLocation}/dependantRequired`
      for (const key in $dependentRequired) {
        if (key in instance) {
          const required = $dependentRequired[key] as string[]
          for (const dependantKey of required) {
            if (!(dependantKey in instance)) {
              errors.push({
                instanceLocation,
                keyword: 'dependentRequired',
                keywordLocation,
                error: `Instance has "${key}" but does not have "${dependantKey}".`
              })
            }
          }
        }
      }
    }

    if ($dependentSchemas !== undefined) {
      for (const key in $dependentSchemas) {
        const keywordLocation = `${schemaLocation}/dependentSchemas`
        if (key in instance) {
          const result = validate(instance, $dependentSchemas[key]!, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation,
            schemaLocation: `${keywordLocation}/${encodePointer(key)}`,
            evaluated
          })
          if (!result.valid) {
            errors.push(
              {
                instanceLocation,
                keyword: 'dependentSchemas',
                keywordLocation,
                error: `Instance has "${key}" but does not match dependant schema.`
              },
              ...result.errors
            )
          }
        }
      }
    }

    if ($dependencies !== undefined) {
      const keywordLocation = `${schemaLocation}/dependencies`
      for (const key in $dependencies) {
        if (key in instance) {
          const propsOrSchema = $dependencies[key] as Schema | string[]
          if (Array.isArray(propsOrSchema)) {
            for (const dependantKey of propsOrSchema) {
              if (!(dependantKey in instance)) {
                errors.push({
                  instanceLocation,
                  keyword: 'dependencies',
                  keywordLocation,
                  error: `Instance has "${key}" but does not have "${dependantKey}".`
                })
              }
            }
          } else {
            const result = validate(instance, propsOrSchema, {
              ...opts,
              lookup,
              recursiveAnchor,
              instanceLocation,
              schemaLocation: `${keywordLocation}/${encodePointer(key)}`
            })
            if (!result.valid) {
              errors.push(
                {
                  instanceLocation,
                  keyword: 'dependencies',
                  keywordLocation,
                  error: `Instance has "${key}" but does not match dependant schema.`
                },
                ...result.errors
              )
            }
          }
        }
      }
    }

    const thisEvaluated = Object.create(null)

    let stop = false

    if ($properties !== undefined) {
      const keywordLocation = `${schemaLocation}/properties`
      for (const key in $properties) {
        if (!(key in instance)) {
          continue
        }
        const subInstancePointer = `${instanceLocation}/${encodePointer(key)}`
        const result = validate(instance[key], $properties[key]!, {
          ...opts,
          lookup,
          recursiveAnchor,
          instanceLocation: subInstancePointer,
          schemaLocation: `${keywordLocation}/${encodePointer(key)}`
        })
        if (result.valid) {
          evaluated[key] = thisEvaluated[key] = true
          instance[key] = result.instance
        } else {
          stop = shortCircuit
          errors.push(
            {
              instanceLocation,
              keyword: 'properties',
              keywordLocation,
              error: `Property "${key}" does not match schema.`
            },
            ...result.errors
          )
          if (stop) break
        }
      }
    }

    if (!stop && $patternProperties !== undefined) {
      const keywordLocation = `${schemaLocation}/patternProperties`
      for (const pattern in $patternProperties) {
        const regex = new RegExp(pattern, 'u')
        const subSchema = $patternProperties[pattern]
        for (const key in instance) {
          if (!regex.test(key)) {
            continue
          }
          const subInstancePointer = `${instanceLocation}/${encodePointer(key)}`
          const result = validate(instance[key], subSchema!, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: subInstancePointer,
            schemaLocation: `${keywordLocation}/${encodePointer(pattern)}`
          })
          if (result.valid) {
            evaluated[key] = thisEvaluated[key] = true
            instance[key] = result.instance
          } else {
            stop = shortCircuit
            errors.push(
              {
                instanceLocation,
                keyword: 'patternProperties',
                keywordLocation,
                error: `Property "${key}" matches pattern "${pattern}" but does not match associated schema.`
              },
              ...result.errors
            )
          }
        }
      }
    }

    if (
      !stop &&
      ($additionalProperties !== undefined || strictAdditionalProperties)
    ) {
      const keywordLocation = `${schemaLocation}/additionalProperties`
      for (const key in instance) {
        if (thisEvaluated[key]) {
          continue
        }
        const subInstancePointer = `${instanceLocation}/${encodePointer(key)}`
        const result = validate(
          instance[key],
          $additionalProperties ?? !strictAdditionalProperties,
          {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: subInstancePointer,
            schemaLocation: keywordLocation
          }
        )
        if (result.valid) {
          evaluated[key] = true
          instance[key] = result.instance
        } else {
          stop = shortCircuit
          errors.push(
            {
              instanceLocation,
              keyword: 'additionalProperties',
              keywordLocation,
              error: `Property "${key}" does not match additional properties schema.`
            },
            ...result.errors
          )
        }
      }
    } else if (!stop && $unevaluatedProperties !== undefined) {
      const keywordLocation = `${schemaLocation}/unevaluatedProperties`
      for (const key in instance) {
        if (!evaluated[key]) {
          const subInstancePointer = `${instanceLocation}/${encodePointer(key)}`
          const result = validate(instance[key], $unevaluatedProperties, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: subInstancePointer,
            schemaLocation: keywordLocation
          })
          if (result.valid) {
            evaluated[key] = true
            instance[key] = result.instance
          } else {
            errors.push(
              {
                instanceLocation,
                keyword: 'unevaluatedProperties',
                keywordLocation,
                error: `Property "${key}" does not match unevaluated properties schema.`
              },
              ...result.errors
            )
          }
        }
      }
    }
  } else if (instanceType === 'array') {
    if ($maxItems !== undefined && instance.length > $maxItems) {
      errors.push({
        instanceLocation,
        keyword: 'maxItems',
        keywordLocation: `${schemaLocation}/maxItems`,
        error: `Array has too many items (${instance.length} > ${$maxItems}).`
      })
    }

    if ($minItems !== undefined && instance.length < $minItems) {
      errors.push({
        instanceLocation,
        keyword: 'minItems',
        keywordLocation: `${schemaLocation}/minItems`,
        error: `Array has too few items (${instance.length} < ${$minItems}).`
      })
    }

    const length: number = instance.length
    let i = 0
    let stop = false

    if ($prefixItems !== undefined) {
      const keywordLocation = `${schemaLocation}/prefixItems`
      const length2 = Math.min($prefixItems.length, length)
      for (; i < length2; i++) {
        const result = validate(instance[i], $prefixItems[i]!, {
          ...opts,
          lookup,
          recursiveAnchor,
          instanceLocation: `${instanceLocation}/${i}`,
          schemaLocation: `${keywordLocation}/${i}`
        })
        evaluated[i] = true
        if (!result.valid) {
          stop = shortCircuit
          errors.push(
            {
              instanceLocation,
              keyword: 'prefixItems',
              keywordLocation,
              error: `Items did not match schema.`
            },
            ...result.errors
          )
          if (stop) break
        }
      }
    }

    if ($items !== undefined) {
      const keywordLocation = `${schemaLocation}/items`
      if (Array.isArray($items)) {
        const length2 = Math.min($items.length, length)
        for (; i < length2; i++) {
          const result = validate(instance[i], $items[i]!, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: `${instanceLocation}/${i}`,
            schemaLocation: `${keywordLocation}/${i}`
          })
          evaluated[i] = true
          if (result.valid) {
            instance[i] = result.instance
          } else {
            stop = shortCircuit
            errors.push(
              {
                instanceLocation,
                keyword: 'items',
                keywordLocation,
                error: `Items did not match schema.`
              },
              ...result.errors
            )
            if (stop) break
          }
        }
      } else {
        for (; i < length; i++) {
          const result = validate(instance[i], $items, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: `${instanceLocation}/${i}`,
            schemaLocation: keywordLocation
          })
          evaluated[i] = true
          if (result.valid) {
            instance[i] = result.instance
          } else {
            stop = shortCircuit
            errors.push(
              {
                instanceLocation,
                keyword: 'items',
                keywordLocation,
                error: `Items did not match schema.`
              },
              ...result.errors
            )
            if (stop) break
          }
        }
      }

      if (!stop && $additionalItems !== undefined) {
        const keywordLocation = `${schemaLocation}/additionalItems`
        for (; i < length; i++) {
          const result = validate(instance[i], $additionalItems, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: `${instanceLocation}/${i}`,
            schemaLocation: keywordLocation
          })
          evaluated[i] = true
          if (result.valid) {
            instance[i] = result.instance
          } else if (!result.valid) {
            stop = shortCircuit
            errors.push(
              {
                instanceLocation,
                keyword: 'additionalItems',
                keywordLocation,
                error: `Items did not match additional items schema.`
              },
              ...result.errors
            )
          }
        }
      }
    }

    if ($contains !== undefined) {
      if (length === 0 && $minContains === undefined) {
        errors.push({
          instanceLocation,
          keyword: 'contains',
          keywordLocation: `${schemaLocation}/contains`,
          error: `Array is empty. It must contain at least one item matching the schema.`
        })
      } else if ($minContains !== undefined && length < $minContains) {
        errors.push({
          instanceLocation,
          keyword: 'minContains',
          keywordLocation: `${schemaLocation}/minContains`,
          error: `Array has less items (${length}) than minContains (${$minContains}).`
        })
      } else {
        const keywordLocation = `${schemaLocation}/contains`
        const errorsLength = errors.length
        let contained = 0
        for (let j = 0; j < length; j++) {
          const result = validate(instance[j], $contains, {
            ...opts,
            lookup,
            recursiveAnchor,
            instanceLocation: `${instanceLocation}/${j}`,
            schemaLocation: keywordLocation
          })
          if (result.valid) {
            evaluated[j] = true
            contained++
          } else {
            errors.push(...result.errors)
          }
        }

        if (contained >= ($minContains || 0)) {
          errors.length = errorsLength
        }

        if (
          $minContains === undefined &&
          $maxContains === undefined &&
          contained === 0
        ) {
          errors.splice(errorsLength, 0, {
            instanceLocation,
            keyword: 'contains',
            keywordLocation,
            error: `Array does not contain item matching schema.`
          })
        } else if ($minContains !== undefined && contained < $minContains) {
          errors.push({
            instanceLocation,
            keyword: 'minContains',
            keywordLocation: `${schemaLocation}/minContains`,
            error: `Array must contain at least ${$minContains} items matching schema. Only ${contained} items were found.`
          })
        } else if ($maxContains !== undefined && contained > $maxContains) {
          errors.push({
            instanceLocation,
            keyword: 'maxContains',
            keywordLocation: `${schemaLocation}/maxContains`,
            error: `Array may contain at most ${$maxContains} items matching schema. ${contained} items were found.`
          })
        }
      }
    }

    if (!stop && $unevaluatedItems !== undefined) {
      const keywordLocation = `${schemaLocation}/unevaluatedItems`
      for (i; i < length; i++) {
        if (evaluated[i]) {
          continue
        }
        const result = validate(instance[i], $unevaluatedItems, {
          ...opts,
          lookup,
          recursiveAnchor,
          instanceLocation: `${instanceLocation}/${i}`,
          schemaLocation: keywordLocation
        })
        evaluated[i] = true
        if (result.valid) {
          instance[i] = result.instance
        } else {
          errors.push(
            {
              instanceLocation,
              keyword: 'unevaluatedItems',
              keywordLocation,
              error: `Items did not match unevaluated items schema.`
            },
            ...result.errors
          )
        }
      }
    }

    if ($uniqueItems) {
      for (let j = 0; j < length; j++) {
        const a = instance[j]
        const ao = typeof a === 'object' && a !== null
        for (let k = 0; k < length; k++) {
          if (j === k) {
            continue
          }
          const b = instance[k]
          const bo = typeof b === 'object' && b !== null
          if (a === b || (ao && bo && deepCompareStrict(a, b))) {
            errors.push({
              instanceLocation,
              keyword: 'uniqueItems',
              keywordLocation: `${schemaLocation}/uniqueItems`,
              error: `Duplicate items at indexes ${j} and ${k}.`
            })
            j = Number.MAX_SAFE_INTEGER
            k = Number.MAX_SAFE_INTEGER
          }
        }
      }
    }
  } else if (instanceType === 'number') {
    if (draft === '4') {
      if (
        $minimum !== undefined &&
        (($exclusiveMinimum === true && instance <= $minimum) ||
          instance < $minimum)
      ) {
        errors.push({
          instanceLocation,
          keyword: 'minimum',
          keywordLocation: `${schemaLocation}/minimum`,
          error: `${instance} is less than ${
            $exclusiveMinimum ? 'or equal to ' : ''
          } ${$minimum}.`
        })
      }
      if (
        $maximum !== undefined &&
        (($exclusiveMaximum === true && instance >= $maximum) ||
          instance > $maximum)
      ) {
        errors.push({
          instanceLocation,
          keyword: 'maximum',
          keywordLocation: `${schemaLocation}/maximum`,
          error: `${instance} is greater than ${
            $exclusiveMaximum ? 'or equal to ' : ''
          } ${$maximum}.`
        })
      }
    } else {
      if ($minimum !== undefined && instance < $minimum) {
        errors.push({
          instanceLocation,
          keyword: 'minimum',
          keywordLocation: `${schemaLocation}/minimum`,
          error: `${instance} is less than ${$minimum}.`
        })
      }
      if ($maximum !== undefined && instance > $maximum) {
        errors.push({
          instanceLocation,
          keyword: 'maximum',
          keywordLocation: `${schemaLocation}/maximum`,
          error: `${instance} is greater than ${$maximum}.`
        })
      }
      if ($exclusiveMinimum !== undefined && instance <= $exclusiveMinimum) {
        errors.push({
          instanceLocation,
          keyword: 'exclusiveMinimum',
          keywordLocation: `${schemaLocation}/exclusiveMinimum`,
          error: `${instance} is less than ${$exclusiveMinimum}.`
        })
      }
      if ($exclusiveMaximum !== undefined && instance >= $exclusiveMaximum) {
        errors.push({
          instanceLocation,
          keyword: 'exclusiveMaximum',
          keywordLocation: `${schemaLocation}/exclusiveMaximum`,
          error: `${instance} is greater than or equal to ${$exclusiveMaximum}.`
        })
      }
    }
    if ($multipleOf !== undefined) {
      const remainder = instance % $multipleOf
      if (
        Math.abs(0 - remainder) >= 1.192_092_9e-7 &&
        Math.abs($multipleOf - remainder) >= 1.192_092_9e-7
      ) {
        errors.push({
          instanceLocation,
          keyword: 'multipleOf',
          keywordLocation: `${schemaLocation}/multipleOf`,
          error: `${instance} is not a multiple of ${$multipleOf}.`
        })
      }
    }
  } else if (instanceType === 'string') {
    const length =
      $minLength === undefined && $maxLength === undefined
        ? 0
        : ucs2length(instance)
    if ($minLength !== undefined && length < $minLength) {
      errors.push({
        instanceLocation,
        keyword: 'minLength',
        keywordLocation: `${schemaLocation}/minLength`,
        error: `String is too short (${length} < ${$minLength}).`
      })
    }
    if ($maxLength !== undefined && length > $maxLength) {
      errors.push({
        instanceLocation,
        keyword: 'maxLength',
        keywordLocation: `${schemaLocation}/maxLength`,
        error: `String is too long (${length} > ${$maxLength}).`
      })
    }
    if ($pattern !== undefined && !new RegExp($pattern, 'u').test(instance)) {
      errors.push({
        instanceLocation,
        keyword: 'pattern',
        keywordLocation: `${schemaLocation}/pattern`,
        error: `String does not match pattern.`
      })
    }
    if (
      $format !== undefined &&
      format[$format] &&
      !format[$format](instance)
    ) {
      errors.push({
        instanceLocation,
        keyword: 'format',
        keywordLocation: `${schemaLocation}/format`,
        error: `String does not match format "${$format}".`
      })
    }
  }

  return { valid: errors.length === 0, instance, errors }
}


================================================
FILE: packages/json-schema/src/validator.ts
================================================
import type { Schema, SchemaDraft, ValidationResult } from './types'
import { dereference } from './dereference'
import { validate } from './validate'

export class Validator {
  protected readonly lookup: ReturnType<typeof dereference>
  protected readonly schema: Schema | boolean
  protected readonly draft: SchemaDraft
  protected readonly shortCircuit: boolean
  protected readonly coerce: boolean
  protected readonly strictAdditionalProperties: boolean

  constructor({
    schema,
    draft = '2019-09',
    shortCircuit = true,
    coerce = false,
    strictAdditionalProperties = false
  }: {
    schema: Schema | boolean
    draft?: SchemaDraft
    shortCircuit?: boolean
    coerce?: boolean
    strictAdditionalProperties?: boolean
  }) {
    this.schema = schema
    this.draft = draft
    this.shortCircuit = shortCircuit
    this.coerce = coerce
    this.strictAdditionalProperties = strictAdditionalProperties
    this.lookup = dereference(schema)
  }

  public validate(instance: any): ValidationResult {
    return validate(structuredClone(instance), this.schema, {
      draft: this.draft,
      lookup: this.lookup,
      coerce: this.coerce,
      shortCircuit: this.shortCircuit,
      strictAdditionalProperties: this.strictAdditionalProperties
    })
  }

  public addSchema(schema: Schema, id?: string): void {
    if (id) {
      schema = { ...schema, $id: id }
    }
    dereference(schema, this.lookup)
  }
}


================================================
FILE: packages/json-schema/test/coercion.test.ts
================================================
import { describe, expect, it } from 'vitest'

import { validate } from '../src/index'

describe('json-schema coercion', () => {
  it('string => number coercion', () => {
    const result = validate('7', { type: 'number' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(7)
  })

  it('boolean => number coercion', () => {
    const result = validate(true, { type: 'number' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(1)
  })

  it('null => number coercion', () => {
    const result = validate(null, { type: 'number' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(0)
  })

  it('array => number coercion', () => {
    const result = validate([1], { type: 'number' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(1)
  })

  it('boolean => string coercion', () => {
    const result = validate(true, { type: 'string' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal('true')
  })

  it('number => string coercion', () => {
    const result = validate(72.3, { type: 'string' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal('72.3')
  })

  it('null => string coercion', () => {
    const result = validate(null, { type: 'string' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal('')
  })

  it('array => string coercion', () => {
    const result = validate(['nala'], { type: 'string' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal('nala')
  })

  it('string => boolean coercion', () => {
    const result = validate('true', { type: 'boolean' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(true)
  })

  it('string => null coercion', () => {
    const result = validate('', { type: 'null' }, { coerce: true })

    expect(result.valid).to.equal(true)
    expect(result.instance).to.equal(null)
  })

  it('object property coercion', () => {
    const result = validate(
      {
        name: null,
        cool: 'true',
        cool2: 0,
        number: '5.12',
        integer: '5.12'
      },
      {
        type: 'object',
        properties: {
          name: { type: 'string' },
          cool: { type: 'boolean' },
          cool2: { type: 'boolean' },
          number: { type: 'number' },
          integer: { type: 'integer' }
        }
      },
      { coerce: true }
    )

    expect(result.valid).to.equal(true)
    expect(result.instance).to.deep.equal({
      name: '',
      cool: true,
      cool2: false,
      number: 5.12,
      integer: 5
    })
  })

  it('strictAdditionalProperties false', () => {
    const result = validate(
      {
        name: 'nala',
        extra: true
      },
      {
        type: 'object',
        properties: {
          name: { type: 'string' }
        }
      }
    )

    expect(result.valid).to.equal(true)
    expect(result.instance).to.deep.equal({
      name: 'nala',
      extra: true
    })
  })

  it('strictAdditionalProperties true', () => {
    const result = validate(
      {
        name: 'nala',
        extra: true
      },
      {
        type: 'object',
        properties: {
          name: { type: 'string' }
        }
      },
      { strictAdditionalProperties: true }
    )

    expect(result.valid).to.equal(false)
  })
})


================================================
FILE: packages/json-schema/test/index.test.ts
================================================
import { describe, expect, it } from 'vitest'

import { dereference, validate, type ValidationResult } from '../src/index.js'
import { remotes, suites } from './json-schema-test-suite.js'
import { loadMeta } from './meta-schema.js'
import { unsupportedTests } from './unsupported.js'

const remotesLookup = Object.create(null)
for (const { name, schema } of remotes) {
  dereference(schema, remotesLookup, new URL(name))
}
Object.freeze(remotesLookup)
;(globalThis as any).location = {
  origin: 'https://example.com',
  host: 'example.com',
  hostname: 'example.com',
  pathname: '/',
  search: '',
  hash: ''
}

describe('json-schema', () => {
  const failures: Record<string, Record<string, Record<string, true>>> = {}
  for (const { draft, name, tests: tests0 } of suites) {
    if (name.endsWith('/unknownKeyword')) {
      continue
    }

    describe(name, () => {
      for (const { schema, description: description1, tests } of tests0) {
        const schemaLookup = dereference(schema)

        const supportedTests = tests.filter((test) => {
          return !unsupportedTests[name]?.[description1]?.[test.description]
        })
        if (!supportedTests.length) {
          continue
        }

        describe(description1, () => {
          for (const {
            data,
            valid,
            description: description2,
            debug
          } of tests) {
            if (unsupportedTests[name]?.[description1]?.[description2]) {
              continue
            }
            ;(debug ? it.only : it)(description2, async () => {
              if (debug) {
                // eslint-disable-next-line no-debugger
                debugger
              }
              const metaLookup = await loadMeta()
              const lookup = {
                ...metaLookup,
                ...remotesLookup,
                ...schemaLookup
              }
              let result: ValidationResult | undefined
              try {
                result = validate(data, schema, { draft, lookup })
              } catch {}
              if (result?.valid !== valid) {
                failures[name] = failures[name] ?? {}
                failures[name][description1] =
                  failures[name][description1] ?? {}
                failures[name][description1][description2] = true
              }
              expect(result?.valid).to.equal(valid, description2)
            })
          }
        })
      }
    })
  }

  // after(() => console.log(JSON.stringify(failures, null, 2)));
})


================================================
FILE: packages/json-schema/test/json-schema-test-suite.ts
================================================
// @ts-nocheck

// @ts-ignore
import remote_baseUriChange_folderInteger from 'json-schema-test-suite/remotes/baseUriChange/folderInteger.json'
// @ts-ignore
import remote_baseUriChangeFolder_folderInteger from 'json-schema-test-suite/remotes/baseUriChangeFolder/folderInteger.json'
// @ts-ignore
import remote_baseUriChangeFolderInSubschema_folderInteger from 'json-schema-test-suite/remotes/baseUriChangeFolderInSubschema/folderInteger.json'
// @ts-ignore
import remote_integer from 'json-schema-test-suite/remotes/integer.json'
// @ts-ignore
import remote_name from 'json-schema-test-suite/remotes/name.json'
// @ts-ignore
import remote_name_defs from 'json-schema-test-suite/remotes/name-defs.json'
// @ts-ignore
import remote_ref_and_definitions from 'json-schema-test-suite/remotes/ref-and-definitions.json'
// @ts-ignore
import remote_ref_and_defs from 'json-schema-test-suite/remotes/ref-and-defs.json'
// @ts-ignore
import remote_subSchemas from 'json-schema-test-suite/remotes/subSchemas.json'
// @ts-ignore
import remote_subSchemas_defs from 'json-schema-test-suite/remotes/subSchemas-defs.json'
// @ts-ignore
import draft4_additionalItems from 'json-schema-test-suite/tests/draft4/additionalItems.json'
// @ts-ignore
import draft4_additionalProperties from 'json-schema-test-suite/tests/draft4/additionalProperties.json'
// @ts-ignore
import draft4_allOf from 'json-schema-test-suite/tests/draft4/allOf.json'
// @ts-ignore
import draft4_anyOf from 'json-schema-test-suite/tests/draft4/anyOf.json'
// @ts-ignore
import draft4_default from 'json-schema-test-suite/tests/draft4/default.json'
// @ts-ignore
import draft4_definitions from 'json-schema-test-suite/tests/draft4/definitions.json'
// @ts-ignore
import draft4_dependencies from 'json-schema-test-suite/tests/draft4/dependencies.json'
// @ts-ignore
import draft4_enum from 'json-schema-test-suite/tests/draft4/enum.json'
// @ts-ignore
import draft4_format from 'json-schema-test-suite/tests/draft4/format.json'
// @ts-ignore
import draft4_id from 'json-schema-test-suite/tests/draft4/id.json'
// @ts-ignore
import draft4_infinite_loop_detection from 'json-schema-test-suite/tests/draft4/infinite-loop-detection.json'
// @ts-ignore
import draft4_items from 'json-schema-test-suite/tests/draft4/items.json'
// @ts-ignore
import draft4_maximum from 'json-schema-test-suite/tests/draft4/maximum.json'
// @ts-ignore
import draft4_maxItems from 'json-schema-test-suite/tests/draft4/maxItems.json'
// @ts-ignore
import draft4_maxLength from 'json-schema-test-suite/tests/draft4/maxLength.json'
// @ts-ignore
import draft4_maxProperties from 'json-schema-test-suite/tests/draft4/maxProperties.json'
// @ts-ignore
import draft4_minimum from 'json-schema-test-suite/tests/draft4/minimum.json'
// @ts-ignore
import draft4_minItems from 'json-schema-test-suite/tests/draft4/minItems.json'
// @ts-ignore
import draft4_minLength from 'json-schema-test-suite/tests/draft4/minLength.json'
// @ts-ignore
import draft4_minProperties from 'json-schema-test-suite/tests/draft4/minProperties.json'
// @ts-ignore
import draft4_multipleOf from 'json-schema-test-suite/tests/draft4/multipleOf.json'
// @ts-ignore
import draft4_not from 'json-schema-test-suite/tests/draft4/not.json'
// @ts-ignore
import draft4_oneOf from 'json-schema-test-suite/tests/draft4/oneOf.json'
// @ts-ignore
import draft4_optional_bignum from 'json-schema-test-suite/tests/draft4/optional/bignum.json'
// @ts-ignore
import draft4_optional_ecmascript_regex from 'json-schema-test-suite/tests/draft4/optional/ecmascript-regex.json'
// @ts-ignore
import draft4_optional_float_overflow from 'json-schema-test-suite/tests/draft4/optional/float-overflow.json'
// @ts-ignore
import draft4_optional_format_date_time from 'json-schema-test-suite/tests/draft4/optional/format/date-time.json'
// @ts-ignore
import draft4_optional_format_email from 'json-schema-test-suite/tests/draft4/optional/format/email.json'
// @ts-ignore
import draft4_optional_format_hostname from 'json-schema-test-suite/tests/draft4/optional/format/hostname.json'
// @ts-ignore
import draft4_optional_format_ipv4 from 'json-schema-test-suite/tests/draft4/optional/format/ipv4.json'
// @ts-ignore
import draft4_optional_format_ipv6 from 'json-schema-test-suite/tests/draft4/optional/format/ipv6.json'
// @ts-ignore
import draft4_optional_format_uri from 'json-schema-test-suite/tests/draft4/optional/format/uri.json'
// @ts-ignore
import draft4_optional_non_bmp_regex from 'json-schema-test-suite/tests/draft4/optional/non-bmp-regex.json'
// @ts-ignore
import draft4_optional_unicode from 'json-schema-test-suite/tests/draft4/optional/unicode.json'
// @ts-ignore
// import draft4_optional_zeroTerminatedFloats from 'json-schema-test-suite/tests/draft4/optional/zeroTerminatedFloats.json'
// @ts-ignore
import draft4_pattern from 'json-schema-test-suite/tests/draft4/pattern.json'
// @ts-ignore
import draft4_patternProperties from 'json-schema-test-suite/tests/draft4/patternProperties.json'
// @ts-ignore
import draft4_properties from 'json-schema-test-suite/tests/draft4/properties.json'
// @ts-ignore
import draft4_ref from 'json-schema-test-suite/tests/draft4/ref.json'
// @ts-ignore
import draft4_refRemote from 'json-schema-test-suite/tests/draft4/refRemote.json'
// @ts-ignore
import draft4_required from 'json-schema-test-suite/tests/draft4/required.json'
// @ts-ignore
import draft4_type from 'json-schema-test-suite/tests/draft4/type.json'
// @ts-ignore
import draft4_uniqueItems from 'json-schema-test-suite/tests/draft4/uniqueItems.json'
// @ts-ignore
import draft7_additionalItems from 'json-schema-test-suite/tests/draft7/additionalItems.json'
// @ts-ignore
import draft7_additionalProperties from 'json-schema-test-suite/tests/draft7/additionalProperties.json'
// @ts-ignore
import draft7_allOf from 'json-schema-test-suite/tests/draft7/allOf.json'
// @ts-ignore
import draft7_anyOf from 'json-schema-test-suite/tests/draft7/anyOf.json'
// @ts-ignore
import draft7_boolean_schema from 'json-schema-test-suite/tests/draft7/boolean_schema.json'
// @ts-ignore
import draft7_const from 'json-schema-test-suite/tests/draft7/const.json'
// @ts-ignore
import draft7_contains from 'json-schema-test-suite/tests/draft7/contains.json'
// @ts-ignore
import draft7_default from 'json-schema-test-suite/tests/draft7/default.json'
// @ts-ignore
// import draft7_definitions from 'json-schema-test-suite/tests/draft7/definitions.json'
// @ts-ignore
import draft7_dependencies from 'json-schema-test-suite/tests/draft7/dependencies.json'
// @ts-ignore
import draft7_enum from 'json-schema-test-suite/tests/draft7/enum.json'
// @ts-ignore
import draft7_exclusiveMaximum from 'json-schema-test-suite/tests/draft7/exclusiveMaximum.json'
// @ts-ignore
import draft7_exclusiveMinimum from 'json-schema-test-suite/tests/draft7/exclusiveMinimum.json'
// @ts-ignore
import draft7_format from 'json-schema-test-suite/tests/draft7/format.json'
// @ts-ignore
import draft7_id from 'json-schema-test-suite/tests/draft7/id.json'
// @ts-ignore
import draft7_if_then_else from 'json-schema-test-suite/tests/draft7/if-then-else.json'
// @ts-ignore
import draft7_infinite_loop_detection from 'json-schema-test-suite/tests/draft7/infinite-loop-detection.json'
// @ts-ignore
import draft7_items from 'json-schema-test-suite/tests/draft7/items.json'
// @ts-ignore
import draft7_maximum from 'json-schema-test-suite/tests/draft7/maximum.json'
// @ts-ignore
import draft7_maxItems from 'json-schema-test-suite/tests/draft7/maxItems.json'
// @ts-ignore
import draft7_maxLength from 'json-schema-test-suite/tests/draft7/maxLength.json'
// @ts-ignore
import draft7_maxProperties from 'json-schema-test-suite/tests/draft7/maxProperties.json'
// @ts-ignore
import draft7_minimum from 'json-schema-test-suite/tests/draft7/minimum.json'
// @ts-ignore
import draft7_minItems from 'json-schema-test-suite/tests/draft7/minItems.json'
// @ts-ignore
import draft7_minLength from 'json-schema-test-suite/tests/draft7/minLength.json'
// @ts-ignore
import draft7_minProperties from 'json-schema-test-suite/tests/draft7/minProperties.json'
// @ts-ignore
import draft7_multipleOf from 'json-schema-test-suite/tests/draft7/multipleOf.json'
// @ts-ignore
import draft7_not from 'json-schema-test-suite/tests/draft7/not.json'
// @ts-ignore
import draft7_oneOf from 'json-schema-test-suite/tests/draft7/oneOf.json'
// @ts-ignore
import draft7_optional_bignum from 'json-schema-test-suite/tests/draft7/optional/bignum.json'
// @ts-ignore
import draft7_optional_content from 'json-schema-test-suite/tests/draft7/optional/content.json'
// @ts-ignore
import draft7_optional_ecmascript_regex from 'json-schema-test-suite/tests/draft7/optional/ecmascript-regex.json'
// @ts-ignore
import draft7_optional_float_overflow from 'json-schema-test-suite/tests/draft7/optional/float-overflow.json'
// @ts-ignore
import draft7_optional_format_date from 'json-schema-test-suite/tests/draft7/optional/format/date.json'
// @ts-ignore
import draft7_optional_format_date_time from 'json-schema-test-suite/tests/draft7/optional/format/date-time.json'
// @ts-ignore
import draft7_optional_format_email from 'json-schema-test-suite/tests/draft7/optional/format/email.json'
// @ts-ignore
import draft7_optional_format_hostname from 'json-schema-test-suite/tests/draft7/optional/format/hostname.json'
// @ts-ignore
import draft7_optional_format_idn_email from 'json-schema-test-suite/tests/draft7/optional/format/idn-email.json'
// @ts-ignore
import draft7_optional_format_idn_hostname from 'json-schema-test-suite/tests/draft7/optional/format/idn-hostname.json'
// @ts-ignore
import draft7_optional_format_ipv4 from 'json-schema-test-suite/tests/draft7/optional/format/ipv4.json'
// @ts-ignore
import draft7_optional_format_ipv6 from 'json-schema-test-suite/tests/draft7/optional/format/ipv6.json'
// @ts-ignore
import draft7_optional_format_iri from 'json-schema-test-suite/tests/draft7/optional/format/iri.json'
// @ts-ignore
import draft7_optional_format_iri_reference from 'json-schema-test-suite/tests/draft7/optional/format/iri-reference.json'
// @ts-ignore
import draft7_optional_format_json_pointer from 'json-schema-test-suite/tests/draft7/optional/format/json-pointer.json'
// @ts-ignore
import draft7_optional_format_regex from 'json-schema-test-suite/tests/draft7/optional/format/regex.json'
// @ts-ignore
import draft7_optional_format_relative_json_pointer from 'json-schema-test-suite/tests/draft7/optional/format/relative-json-pointer.json'
// @ts-ignore
import draft7_optional_format_time from 'json-schema-test-suite/tests/draft7/optional/format/time.json'
// @ts-ignore
import draft7_optional_format_uri from 'json-schema-test-suite/tests/draft7/optional/format/uri.json'
// @ts-ignore
import draft7_optional_format_uri_reference from 'json-schema-test-suite/tests/draft7/optional/format/uri-reference.json'
// @ts-ignore
import draft7_optional_format_uri_template from 'json-schema-test-suite/tests/draft7/optional/format/uri-template.json'
// @ts-ignore
import draft7_optional_non_bmp_regex from 'json-schema-test-suite/tests/draft7/optional/non-bmp-regex.json'
// @ts-ignore
import draft7_optional_unicode from 'json-schema-test-suite/tests/draft7/optional/unicode.json'
// @ts-ignore
import draft7_pattern from 'json-schema-test-suite/tests/draft7/pattern.json'
// @ts-ignore
import draft7_patternProperties from 'json-schema-test-suite/tests/draft7/patternProperties.json'
// @ts-ignore
import draft7_properties from 'json-schema-test-suite/tests/draft7/properties.json'
// @ts-ignore
import draft7_propertyNames from 'json-schema-test-suite/tests/draft7/propertyNames.json'
// @ts-ignore
import draft7_ref from 'json-schema-test-suite/tests/draft7/ref.json'
// @ts-ignore
import draft7_refRemote from 'json-schema-test-suite/tests/draft7/refRemote.json'
// @ts-ignore
import draft7_required from 'json-schema-test-suite/tests/draft7/required.json'
// @ts-ignore
import draft7_type from 'json-schema-test-suite/tests/draft7/type.json'
// @ts-ignore
import draft7_uniqueItems from 'json-schema-test-suite/tests/draft7/uniqueItems.json'
// @ts-ignore
import draft7_unknownKeyword from 'json-schema-test-suite/tests/draft7/unknownKeyword.json'
// @ts-ignore
// import draft2019_09_additionalItems from 'json-schema-test-suite/tests/draft2019-09/additionalItems.json'
// @ts-ignore
import draft2019_09_additionalProperties from 'json-schema-test-suite/tests/draft2019-09/additionalProperties.json'
// @ts-ignore
import draft2019_09_allOf from 'json-schema-test-suite/tests/draft2019-09/allOf.json'
// @ts-ignore
import draft2019_09_anchor from 'json-schema-test-suite/tests/draft2019-09/anchor.json'
// @ts-ignore
import draft2019_09_anyOf from 'json-schema-test-suite/tests/draft2019-09/anyOf.json'
// @ts-ignore
import draft2019_09_boolean_schema from 'json-schema-test-suite/tests/draft2019-09/boolean_schema.json'
// @ts-ignore
import draft2019_09_const from 'json-schema-test-suite/tests/draft2019-09/const.json'
// @ts-ignore
import draft2019_09_contains from 'json-schema-test-suite/tests/draft2019-09/contains.json'
// @ts-ignore
import draft2019_09_content from 'json-schema-test-suite/tests/draft2019-09/content.json'
// @ts-ignore
import draft2019_09_default from 'json-schema-test-suite/tests/draft2019-09/default.json'
// @ts-ignore
import draft2019_09_defs from 'json-schema-test-suite/tests/draft2019-09/defs.json'
// @ts-ignore
import draft2019_09_dependentRequired from 'json-schema-test-suite/tests/draft2019-09/dependentRequired.json'
// @ts-ignore
import draft2019_09_dependentSchemas from 'json-schema-test-suite/tests/draft2019-09/dependentSchemas.json'
// @ts-ignore
import draft2019_09_enum from 'json-schema-test-suite/tests/draft2019-09/enum.json'
// @ts-ignore
import draft2019_09_exclusiveMaximum from 'json-schema-test-suite/tests/draft2019-09/exclusiveMaximum.json'
// @ts-ignore
import draft2019_09_exclusiveMinimum from 'json-schema-test-suite/tests/draft2019-09/exclusiveMinimum.json'
// @ts-ignore
import draft2019_09_format from 'json-schema-test-suite/tests/draft2019-09/format.json'
// @ts-ignore
// import draft2019_09_id from 'json-schema-test-suite/tests/draft2019-09/id.json'
// @ts-ignore
import draft2019_09_if_then_else from 'json-schema-test-suite/tests/draft2019-09/if-then-else.json'
// @ts-ignore
import draft2019_09_infinite_loop_detection from 'json-schema-test-suite/tests/draft2019-09/infinite-loop-detection.json'
// @ts-ignore
import draft2019_09_items from 'json-schema-test-suite/tests/draft2019-09/items.json'
// @ts-ignore
import draft2019_09_maxContains from 'json-schema-test-suite/tests/draft2019-09/maxContains.json'
// @ts-ignore
import draft2019_09_maximum from 'json-schema-test-suite/tests/draft2019-09/maximum.json'
// @ts-ignore
import draft2019_09_maxItems from 'json-schema-test-suite/tests/draft2019-09/maxItems.json'
// @ts-ignore
import draft2019_09_maxLength from 'json-schema-test-suite/tests/draft2019-09/maxLength.json'
// @ts-ignore
import draft2019_09_maxProperties from 'json-schema-test-suite/tests/draft2019-09/maxProperties.json'
// @ts-ignore
import draft2019_09_minContains from 'json-schema-test-suite/tests/draft2019-09/minContains.json'
// @ts-ignore
import draft2019_09_minimum from 'json-schema-test-suite/tests/draft2019-09/minimum.json'
// @ts-ignore
import draft2019_09_minItems from 'json-schema-test-suite/tests/draft2019-09/minItems.json'
// @ts-ignore
import draft2019_09_minLength from 'json-schema-test-suite/tests/draft2019-09/minLength.json'
// @ts-ignore
import draft2019_09_minProperties from 'json-schema-test-suite/tests/draft2019-09/minProperties.json'
// @ts-ignore
import draft2019_09_multipleOf from 'json-schema-test-suite/tests/draft2019-09/multipleOf.json'
// @ts-ignore
import draft2019_09_not from 'json-schema-test-suite/tests/draft2019-09/not.json'
// @ts-ignore
import draft2019_09_oneOf from 'json-schema-test-suite/tests/draft2019-09/oneOf.json'
// @ts-ignore
import draft2019_09_optional_bignum from 'json-schema-test-suite/tests/draft2019-09/optional/bignum.json'
// @ts-ignore
import draft2019_09_optional_ecmascript_regex from 'json-schema-test-suite/tests/draft2019-09/optional/ecmascript-regex.json'
// @ts-ignore
import draft2019_09_optional_float_overflow from 'json-schema-test-suite/tests/draft2019-09/optional/float-overflow.json'
// @ts-ignore
import draft2019_09_optional_format_date from 'json-schema-test-suite/tests/draft2019-09/optional/format/date.json'
// @ts-ignore
import draft2019_09_optional_format_date_time from 'json-schema-test-suite/tests/draft2019-09/optional/format/date-time.json'
// @ts-ignore
import draft2019_09_optional_format_duration from 'json-schema-test-suite/tests/draft2019-09/optional/format/duration.json'
// @ts-ignore
import draft2019_09_optional_format_email from 'json-schema-test-suite/tests/draft2019-09/optional/format/email.json'
// @ts-ignore
import draft2019_09_optional_format_hostname from 'json-schema-test-suite/tests/draft2019-09/optional/format/hostname.json'
// @ts-ignore
import draft2019_09_optional_format_idn_email from 'json-schema-test-suite/tests/draft2019-09/optional/format/idn-email.json'
// @ts-ignore
import draft2019_09_optional_format_idn_hostname from 'json-schema-test-suite/tests/draft2019-09/optional/format/idn-hostname.json'
// @ts-ignore
import draft2019_09_optional_format_ipv4 from 'json-schema-test-suite/tests/draft2019-09/optional/format/ipv4.json'
// @ts-ignore
import draft2019_09_optional_format_ipv6 from 'json-schema-test-suite/tests/draft2019-09/optional/format/ipv6.json'
// @ts-ignore
import draft2019_09_optional_format_iri from 'json-schema-test-suite/tests/draft2019-09/optional/format/iri.json'
// @ts-ignore
import draft2019_09_optional_format_iri_reference from 'json-schema-test-suite/tests/draft2019-09/optional/format/iri-reference.json'
// @ts-ignore
import draft2019_09_optional_format_json_pointer from 'json-schema-test-suite/tests/draft2019-09/optional/format/json-pointer.json'
// @ts-ignore
import draft2019_09_optional_format_regex from 'json-schema-test-suite/tests/draft2019-09/optional/format/regex.json'
// @ts-ignore
import draft2019_09_optional_format_relative_json_pointer from 'json-schema-test-suite/tests/draft2019-09/optional/format/relative-json-pointer.json'
// @ts-ignore
import draft2019_09_optional_format_time from 'json-schema-test-suite/tests/draft2019-09/optional/format/time.json'
// @ts-ignore
import draft2019_09_optional_format_uri from 'json-schema-test-suite/tests/draft2019-09/optional/format/uri.json'
// @ts-ignore
import draft2019_09_optional_format_uri_reference from 'json-schema-test-suite/tests/draft2019-09/optional/format/uri-reference.json'
// @ts-ignore
import draft2019_09_optional_format_uri_template from 'json-schema-test-suite/tests/draft2019-09/optional/format/uri-template.json'
// @ts-ignore
import draft2019_09_optional_format_uuid from 'json-schema-test-suite/tests/draft2019-09/optional/format/uuid.json'
// @ts-ignore
import draft2019_09_optional_non_bmp_regex from 'json-schema-test-suite/tests/draft2019-09/optional/non-bmp-regex.json'
// @ts-ignore
import draft2019_09_optional_refOfUnknownKeyword from 'json-schema-test-suite/tests/draft2019-09/optional/refOfUnknownKeyword.json'
// @ts-ignore
import draft2019_09_optional_unicode from 'json-schema-test-suite/tests/draft2019-09/optional/unicode.json'
// @ts-ignore
import draft2019_09_pattern from 'json-schema-test-suite/tests/draft2019-09/pattern.json'
// @ts-ignore
import draft2019_09_patternProperties from 'json-schema-test-suite/tests/draft2019-09/patternProperties.json'
// @ts-ignore
import draft2019_09_properties from 'json-schema-test-suite/tests/draft2019-09/properties.json'
// @ts-ignore
import draft2019_09_propertyNames from 'json-schema-test-suite/tests/draft2019-09/propertyNames.json'
// @ts-ignore
import draft2019_09_recursiveRef from 'json-schema-test-suite/tests/draft2019-09/recursiveRef.json'
// @ts-ignore
import draft2019_09_ref from 'json-schema-test-suite/tests/draft2019-09/ref.json'
// @ts-ignore
import draft2019_09_refRemote from 'json-schema-test-suite/tests/draft2019-09/refRemote.json'
// @ts-ignore
import draft2019_09_required from 'json-schema-test-suite/tests/draft2019-09/required.json'
// @ts-ignore
import draft2019_09_type from 'json-schema-test-suite/tests/draft2019-09/type.json'
// @ts-ignore
import draft2019_09_unevaluatedItems from 'json-schema-test-suite/tests/draft2019-09/unevaluatedItems.json'
// @ts-ignore
import draft2019_09_unevaluatedProperties from 'json-schema-test-suite/tests/draft2019-09/unevaluatedProperties.json'
// @ts-ignore
import draft2019_09_uniqueItems from 'json-schema-test-suite/tests/draft2019-09/uniqueItems.json'
// @ts-ignore
import draft2019_09_unknownKeyword from 'json-schema-test-suite/tests/draft2019-09/unknownKeyword.json'
// @ts-ignore
import draft2020_12_additionalProperties from 'json-schema-test-suite/tests/draft2020-12/additionalProperties.json'
// @ts-ignore
import draft2020_12_allOf from 'json-schema-test-suite/tests/draft2020-12/allOf.json'
// @ts-ignore
import draft2020_12_anchor from 'json-schema-test-suite/tests/draft2020-12/anchor.json'
// @ts-ignore
import draft2020_12_anyOf from 'json-schema-test-suite/tests/draft2020-12/anyOf.json'
// @ts-ignore
import draft2020_12_boolean_schema from 'json-schema-test-suite/tests/draft2020-12/boolean_schema.json'
// @ts-ignore
import draft2020_12_const from 'json-schema-test-suite/tests/draft2020-12/const.json'
// @ts-ignore
import draft2020_12_contains from 'json-schema-test-suite/tests/draft2020-12/contains.json'
// @ts-ignore
import draft2020_12_content from 'json-schema-test-suite/tests/draft2020-12/content.json'
// @ts-ignore
import draft2020_12_default from 'json-schema-test-suite/tests/draft2020-12/default.json'
// @ts-ignore
import draft2020_12_defs from 'json-schema-test-suite/tests/draft2020-12/defs.json'
// @ts-ignore
import draft2020_12_dependentRequired from 'json-schema-test-suite/tests/draft2020-12/dependentRequired.json'
// @ts-ignore
import draft2020_12_dependentSchemas from 'json-schema-test-suite/tests/draft2020-12/dependentSchemas.json'
// @ts-ignore
import draft2020_12_dynamicRef from 'json-schema-test-suite/tests/draft2020-12/dynamicRef.json'
// @ts-ignore
import draft2020_12_enum from 'json-schema-test-suite/tests/draft2020-12/enum.json'
// @ts-ignore
import draft2020_12_exclusiveMaximum from 'json-schema-test-suite/tests/draft2020-12/exclusiveMaximum.json'
// @ts-ignore
import draft2020_12_exclusiveMinimum from 'json-schema-test-suite/tests/draft2020-12/exclusiveMinimum.json'
// @ts-ignore
import draft2020_12_format from 'json-schema-test-suite/tests/draft2020-12/format.json'
// @ts-ignore
import draft2020_12_id from 'json-schema-test-suite/tests/draft2020-12/id.json'
// @ts-ignore
import draft2020_12_if_then_else from 'json-schema-test-suite/tests/draft2020-12/if-then-else.json'
// @ts-ignore
import draft2020_12_infinite_loop_detection from 'json-schema-test-suite/tests/draft2020-12/infinite-loop-detection.json'
// @ts-ignore
import draft2020_12_items from 'json-schema-test-suite/tests/draft2020-12/items.json'
// @ts-ignore
import draft2020_12_maxContains from 'json-schema-test-suite/tests/draft2020-12/maxContains.json'
// @ts-ignore
import draft2020_12_maximum from 'json-schema-test-suite/tests/draft2020-12/maximum.json'
// @ts-ignore
import draft2020_12_maxItems from 'json-schema-test-suite/tests/draft2020-12/maxItems.json'
// @ts-ignore
import draft2020_12_maxLength from 'json-schema-test-suite/tests/draft2020-12/maxLength.json'
// @ts-ignore
import draft2020_12_maxProperties from 'json-schema-test-suite/tests/draft2020-12/maxProperties.json'
// @ts-ignore
import draft2020_12_minContains from 'json-schema-test-suite/tests/draft2020-12/minContains.json'
// @ts-ignore
import draft2020_12_minimum from 'json-schema-test-suite/tests/draft2020-12/minimum.json'
// @ts-ignore
import draft2020_12_minItems from 'json-schema-test-suite/tests/draft2020-12/minItems.json'
// @ts-ignore
import draft2020_12_minLength from 'json-schema-test-suite/tests/draft2020-12/minLength.json'
// @ts-ignore
import draft2020_12_minProperties from 'json-schema-test-suite/tests/draft2020-12/minProperties.json'
// @ts-ignore
import draft2020_12_multipleOf from 'json-schema-test-suite/tests/draft2020-12/multipleOf.json'
// @ts-ignore
import draft2020_12_not from 'json-schema-test-suite/tests/draft2020-12/not.json'
// @ts-ignore
import draft2020_12_oneOf from 'json-schema-test-suite/tests/draft2020-12/oneOf.json'
// @ts-ignore
import draft2020_12_optional_bignum from 'json-schema-test-suite/tests/draft2020-12/optional/bignum.json'
// @ts-ignore
import draft2020_12_optional_ecmascript_regex from 'json-schema-test-suite/tests/draft2020-12/optional/ecmascript-regex.json'
// @ts-ignore
import draft2020_12_optional_float_overflow from 'json-schema-test-suite/tests/draft2020-12/optional/float-overflow.json'
// @ts-ignore
import draft2020_12_optional_format_date from 'json-schema-test-suite/tests/draft2020-12/optional/format/date.json'
// @ts-ignore
import draft2020_12_optional_format_date_time from 'json-schema-test-suite/tests/draft2020-12/optional/format/date-time.json'
// @ts-ignore
import draft2020_12_optional_format_duration from 'json-schema-test-suite/tests/draft2020-12/optional/format/duration.json'
// @ts-ignore
import draft2020_12_optional_format_email from 'json-schema-test-suite/tests/draft2020-12/optional/format/email.json'
// @ts-ignore
import draft2020_12_optional_format_hostname from 'json-schema-test-suite/tests/draft2020-12/optional/format/hostname.json'
// @ts-ignore
import draft2020_12_optional_format_idn_email from 'json-schema-test-suite/tests/draft2020-12/optional/format/idn-email.json'
// @ts-ignore
import draft2020_12_optional_format_idn_hostname from 'json-schema-test-suite/tests/draft2020-12/optional/format/idn-hostname.json'
// @ts-ignore
import draft2020_12_optional_format_ipv4 from 'json-schema-test-suite/tests/draft2020-12/optional/format/ipv4.json'
// @ts-ignore
import draft2020_12_optional_format_ipv6 from 'json-schema-test-suite/tests/draft2020-12/optional/format/ipv6.json'
// @ts-ignore
import draft2020_12_optional_format_iri from 'json-schema-test-suite/tests/draft2020-12/optional/format/iri.json'
// @ts-ignore
import draft2020_12_optional_format_iri_reference from 'json-schema-test-suite/tests/draft2020-12/optional/format/iri-reference.json'
// @ts-ignore
import draft2020_12_optional_format_json_pointer from 'json-schema-test-suite/tests/draft2020-12/optional/format/json-pointer.json'
// @ts-ignore
import draft2020_12_optional_format_regex from 'json-schema-test-suite/tests/draft2020-12/optional/format/regex.json'
// @ts-ignore
import draft2020_12_optional_format_relative_json_pointer from 'json-schema-test-suite/tests/draft2020-12/optional/format/relative-json-pointer.json'
// @ts-ignore
import draft2020_12_optional_format_time from 'json-schema-test-suite/tests/draft2020-12/optional/format/time.json'
// @ts-ignore
import draft2020_12_optional_format_uri from 'json-schema-test-suite/tests/draft2020-12/optional/format/uri.json'
// @ts-ignore
import draft2020_12_optional_format_uri_reference from 'json-schema-test-suite/tests/draft2020-12/optional/format/uri-reference.json'
// @ts-ignore
import draft2020_12_optional_format_uri_template from 'json-schema-test-suite/tests/draft2020-12/optional/format/uri-template.json'
// @ts-ignore
import draft2020_12_optional_format_uuid from 'json-schema-test-suite/tests/draft2020-12/optional/format/uuid.json'
// @ts-ignore
import draft2020_12_optional_non_bmp_regex from 'json-schema-test-suite/tests/draft2020-12/optional/non-bmp-regex.json'
// @ts-ignore
import draft2020_12_optional_refOfUnknownKeyword from 'json-schema-test-suite/tests/draft2020-12/optional/refOfUnknownKeyword.json'
// @ts-ignore
import draft2020_12_optional_unicode from 'json-schema-test-suite/tests/draft2020-12/optional/unicode.json'
// @ts-ignore
import draft2020_12_pattern from 'json-schema-test-suite/tests/draft2020-12/pattern.json'
// @ts-ignore
import draft2020_12_patternProperties from 'json-schema-test-suite/tests/draft2020-12/patternProperties.json'
// @ts-ignore
import draft2020_12_prefixItems from 'json-schema-test-suite/tests/draft2020-12/prefixItems.json'
// @ts-ignore
import draft2020_12_properties from 'json-schema-test-suite/tests/draft2020-12/properties.json'
// @ts-ignore
import draft2020_12_propertyNames from 'json-schema-test-suite/tests/draft2020-12/propertyNames.json'
// @ts-ignore
import draft2020_12_ref from 'json-schema-test-suite/tests/draft2020-12/ref.json'
// @ts-ignore
import draft2020_12_refRemote from 'json-schema-test-suite/tests/draft2020-12/refRemote.json'
// @ts-ignore
import draft2020_12_required from 'json-schema-test-suite/tests/draft2020-12/required.json'
// @ts-ignore
import draft2020_12_type from 'json-schema-test-suite/tests/draft2020-12/type.json'
// @ts-ignore
import draft2020_12_unevaluatedItems from 'json-schema-test-suite/tests/draft2020-12/unevaluatedItems.json'
// @ts-ignore
import draft2020_12_unevaluatedProperties from 'json-schema-test-suite/tests/draft2020-12/unevaluatedProperties.json'
// @ts-ignore
import draft2020_12_uniqueItems from 'json-schema-test-suite/tests/draft2020-12/uniqueItems.json'
// @ts-ignore
import draft2020_12_unknownKeyword from 'json-schema-test-suite/tests/draft2020-12/unknownKeyword.json'

import type { Remote, SchemaTestSuite } from './types'

export const suites: SchemaTestSuite[] = [
  // {
  //   draft: '2019-09',
  //   name: 'draft2019-09/additionalItems',
  //   tests: draft2019_09_additionalItems
  // },
  {
    draft: '2019-09',
    name: 'draft2019-09/additionalProperties',
    tests: draft2019_09_additionalProperties
  },
  { draft: '2019-09', name: 'draft2019-09/allOf', tests: draft2019_09_allOf },
  { draft: '2019-09', name: 'draft2019-09/anchor', tests: draft2019_09_anchor },
  { draft: '2019-09', name: 'draft2019-09/anyOf', tests: draft2019_09_anyOf },
  {
    draft: '2019-09',
    name: 'draft2019-09/boolean_schema',
    tests: draft2019_09_boolean_schema
  },
  { draft: '2019-09', name: 'draft2019-09/const', tests: draft2019_09_const },
  {
    draft: '2019-09',
    name: 'draft2019-09/contains',
    tests: draft2019_09_contains
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/content',
    tests: draft2019_09_content
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/default',
    tests: draft2019_09_default
  },
  { draft: '2019-09', name: 'draft2019-09/defs', tests: draft2019_09_defs },
  {
    draft: '2019-09',
    name: 'draft2019-09/dependentRequired',
    tests: draft2019_09_dependentRequired
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/dependentSchemas',
    tests: draft2019_09_dependentSchemas
  },
  { draft: '2019-09', name: 'draft2019-09/enum', tests: draft2019_09_enum },
  {
    draft: '2019-09',
    name: 'draft2019-09/exclusiveMaximum',
    tests: draft2019_09_exclusiveMaximum
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/exclusiveMinimum',
    tests: draft2019_09_exclusiveMinimum
  },
  { draft: '2019-09', name: 'draft2019-09/format', tests: draft2019_09_format },
  // { draft: '2019-09', name: 'draft2019-09/id', tests: draft2019_09_id },
  {
    draft: '2019-09',
    name: 'draft2019-09/if-then-else',
    tests: draft2019_09_if_then_else
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/infinite-loop-detection',
    tests: draft2019_09_infinite_loop_detection
  },
  { draft: '2019-09', name: 'draft2019-09/items', tests: draft2019_09_items },
  {
    draft: '2019-09',
    name: 'draft2019-09/maxContains',
    tests: draft2019_09_maxContains
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/maxItems',
    tests: draft2019_09_maxItems
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/maxLength',
    tests: draft2019_09_maxLength
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/maxProperties',
    tests: draft2019_09_maxProperties
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/maximum',
    tests: draft2019_09_maximum
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/minContains',
    tests: draft2019_09_minContains
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/minItems',
    tests: draft2019_09_minItems
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/minLength',
    tests: draft2019_09_minLength
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/minProperties',
    tests: draft2019_09_minProperties
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/minimum',
    tests: draft2019_09_minimum
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/multipleOf',
    tests: draft2019_09_multipleOf
  },
  { draft: '2019-09', name: 'draft2019-09/not', tests: draft2019_09_not },
  { draft: '2019-09', name: 'draft2019-09/oneOf', tests: draft2019_09_oneOf },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/bignum',
    tests: draft2019_09_optional_bignum
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/ecmascript-regex',
    tests: draft2019_09_optional_ecmascript_regex
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/float-overflow',
    tests: draft2019_09_optional_float_overflow
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/date-time',
    tests: draft2019_09_optional_format_date_time
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/date',
    tests: draft2019_09_optional_format_date
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/duration',
    tests: draft2019_09_optional_format_duration
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/email',
    tests: draft2019_09_optional_format_email
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/hostname',
    tests: draft2019_09_optional_format_hostname
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/idn-email',
    tests: draft2019_09_optional_format_idn_email
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/idn-hostname',
    tests: draft2019_09_optional_format_idn_hostname
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/ipv4',
    tests: draft2019_09_optional_format_ipv4
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/ipv6',
    tests: draft2019_09_optional_format_ipv6
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/iri-reference',
    tests: draft2019_09_optional_format_iri_reference
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/iri',
    tests: draft2019_09_optional_format_iri
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/json-pointer',
    tests: draft2019_09_optional_format_json_pointer
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/regex',
    tests: draft2019_09_optional_format_regex
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/relative-json-pointer',
    tests: draft2019_09_optional_format_relative_json_pointer
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/time',
    tests: draft2019_09_optional_format_time
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/uri-reference',
    tests: draft2019_09_optional_format_uri_reference
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/uri-template',
    tests: draft2019_09_optional_format_uri_template
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/uri',
    tests: draft2019_09_optional_format_uri
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/format/uuid',
    tests: draft2019_09_optional_format_uuid
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/non-bmp-regex',
    tests: draft2019_09_optional_non_bmp_regex
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/refOfUnknownKeyword',
    tests: draft2019_09_optional_refOfUnknownKeyword
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/optional/unicode',
    tests: draft2019_09_optional_unicode
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/pattern',
    tests: draft2019_09_pattern
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/patternProperties',
    tests: draft2019_09_patternProperties
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/properties',
    tests: draft2019_09_properties
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/propertyNames',
    tests: draft2019_09_propertyNames
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/recursiveRef',
    tests: draft2019_09_recursiveRef
  },
  { draft: '2019-09', name: 'draft2019-09/ref', tests: draft2019_09_ref },
  {
    draft: '2019-09',
    name: 'draft2019-09/refRemote',
    tests: draft2019_09_refRemote
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/required',
    tests: draft2019_09_required
  },
  { draft: '2019-09', name: 'draft2019-09/type', tests: draft2019_09_type },
  {
    draft: '2019-09',
    name: 'draft2019-09/unevaluatedItems',
    tests: draft2019_09_unevaluatedItems
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/unevaluatedProperties',
    tests: draft2019_09_unevaluatedProperties
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/uniqueItems',
    tests: draft2019_09_uniqueItems
  },
  {
    draft: '2019-09',
    name: 'draft2019-09/unknownKeyword',
    tests: draft2019_09_unknownKeyword
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/additionalProperties',
    tests: draft2020_12_additionalProperties
  },
  { draft: '2020-12', name: 'draft2020-12/allOf', tests: draft2020_12_allOf },
  { draft: '2020-12', name: 'draft2020-12/anchor', tests: draft2020_12_anchor },
  { draft: '2020-12', name: 'draft2020-12/anyOf', tests: draft2020_12_anyOf },
  {
    draft: '2020-12',
    name: 'draft2020-12/boolean_schema',
    tests: draft2020_12_boolean_schema
  },
  { draft: '2020-12', name: 'draft2020-12/const', tests: draft2020_12_const },
  {
    draft: '2020-12',
    name: 'draft2020-12/contains',
    tests: draft2020_12_contains
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/content',
    tests: draft2020_12_content
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/default',
    tests: draft2020_12_default
  },
  { draft: '2020-12', name: 'draft2020-12/defs', tests: draft2020_12_defs },
  {
    draft: '2020-12',
    name: 'draft2020-12/dependentRequired',
    tests: draft2020_12_dependentRequired
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/dependentSchemas',
    tests: draft2020_12_dependentSchemas
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/dynamicRef',
    tests: draft2020_12_dynamicRef
  },
  { draft: '2020-12', name: 'draft2020-12/enum', tests: draft2020_12_enum },
  {
    draft: '2020-12',
    name: 'draft2020-12/exclusiveMaximum',
    tests: draft2020_12_exclusiveMaximum
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/exclusiveMinimum',
    tests: draft2020_12_exclusiveMinimum
  },
  { draft: '2020-12', name: 'draft2020-12/format', tests: draft2020_12_format },
  { draft: '2020-12', name: 'draft2020-12/id', tests: draft2020_12_id },
  {
    draft: '2020-12',
    name: 'draft2020-12/if-then-else',
    tests: draft2020_12_if_then_else
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/infinite-loop-detection',
    tests: draft2020_12_infinite_loop_detection
  },
  { draft: '2020-12', name: 'draft2020-12/items', tests: draft2020_12_items },
  {
    draft: '2020-12',
    name: 'draft2020-12/maxContains',
    tests: draft2020_12_maxContains
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/maxItems',
    tests: draft2020_12_maxItems
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/maxLength',
    tests: draft2020_12_maxLength
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/maxProperties',
    tests: draft2020_12_maxProperties
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/maximum',
    tests: draft2020_12_maximum
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/minContains',
    tests: draft2020_12_minContains
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/minItems',
    tests: draft2020_12_minItems
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/minLength',
    tests: draft2020_12_minLength
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/minProperties',
    tests: draft2020_12_minProperties
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/minimum',
    tests: draft2020_12_minimum
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/multipleOf',
    tests: draft2020_12_multipleOf
  },
  { draft: '2020-12', name: 'draft2020-12/not', tests: draft2020_12_not },
  { draft: '2020-12', name: 'draft2020-12/oneOf', tests: draft2020_12_oneOf },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/bignum',
    tests: draft2020_12_optional_bignum
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/ecmascript-regex',
    tests: draft2020_12_optional_ecmascript_regex
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/float-overflow',
    tests: draft2020_12_optional_float_overflow
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/date-time',
    tests: draft2020_12_optional_format_date_time
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/date',
    tests: draft2020_12_optional_format_date
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/duration',
    tests: draft2020_12_optional_format_duration
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/email',
    tests: draft2020_12_optional_format_email
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/hostname',
    tests: draft2020_12_optional_format_hostname
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/idn-email',
    tests: draft2020_12_optional_format_idn_email
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/idn-hostname',
    tests: draft2020_12_optional_format_idn_hostname
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/ipv4',
    tests: draft2020_12_optional_format_ipv4
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/ipv6',
    tests: draft2020_12_optional_format_ipv6
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/iri-reference',
    tests: draft2020_12_optional_format_iri_reference
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/iri',
    tests: draft2020_12_optional_format_iri
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/json-pointer',
    tests: draft2020_12_optional_format_json_pointer
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/regex',
    tests: draft2020_12_optional_format_regex
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/relative-json-pointer',
    tests: draft2020_12_optional_format_relative_json_pointer
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/time',
    tests: draft2020_12_optional_format_time
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/uri-reference',
    tests: draft2020_12_optional_format_uri_reference
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/uri-template',
    tests: draft2020_12_optional_format_uri_template
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/uri',
    tests: draft2020_12_optional_format_uri
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/format/uuid',
    tests: draft2020_12_optional_format_uuid
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/non-bmp-regex',
    tests: draft2020_12_optional_non_bmp_regex
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/refOfUnknownKeyword',
    tests: draft2020_12_optional_refOfUnknownKeyword
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/optional/unicode',
    tests: draft2020_12_optional_unicode
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/pattern',
    tests: draft2020_12_pattern
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/patternProperties',
    tests: draft2020_12_patternProperties
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/prefixItems',
    tests: draft2020_12_prefixItems
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/properties',
    tests: draft2020_12_properties
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/propertyNames',
    tests: draft2020_12_propertyNames
  },
  { draft: '2020-12', name: 'draft2020-12/ref', tests: draft2020_12_ref },
  {
    draft: '2020-12',
    name: 'draft2020-12/refRemote',
    tests: draft2020_12_refRemote
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/required',
    tests: draft2020_12_required
  },
  { draft: '2020-12', name: 'draft2020-12/type', tests: draft2020_12_type },
  {
    draft: '2020-12',
    name: 'draft2020-12/unevaluatedItems',
    tests: draft2020_12_unevaluatedItems
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/unevaluatedProperties',
    tests: draft2020_12_unevaluatedProperties
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/uniqueItems',
    tests: draft2020_12_uniqueItems
  },
  {
    draft: '2020-12',
    name: 'draft2020-12/unknownKeyword',
    tests: draft2020_12_unknownKeyword
  },
  { draft: '4', name: 'draft4/additionalItems', tests: draft4_additionalItems },
  {
    draft: '4',
    name: 'draft4/additionalProperties',
    tests: draft4_additionalProperties
  },
  { draft: '4', name: 'draft4/allOf', tests: draft4_allOf },
  { draft: '4', name: 'draft4/anyOf', tests: draft4_anyOf },
  { draft: '4', name: 'draft4/default', tests: draft4_default },
  { draft: '4', name: 'draft4/definitions', tests: draft4_definitions },
  { draft: '4', name: 'draft4/dependencies', tests: draft4_dependencies },
  { draft: '4', name: 'draft4/enum', tests: draft4_enum },
  { draft: '4', name: 'draft4/format', tests: draft4_format },
  { draft: '4', name: 'draft4/id', tests: draft4_id },
  {
    draft: '4',
    name: 'draft4/infinite-loop-detection',
    tests: draft4_infinite_loop_detection
  },
  { draft: '4', name: 'draft4/items', tests: draft4_items },
  { draft: '4', name: 'draft4/maxItems', tests: draft4_maxItems },
  { draft: '4', name: 'draft4/maxLength', tests: draft4_maxLength },
  { draft: '4', name: 'draft4/maxProperties', tests: draft4_maxProperties },
  { draft: '4', name: 'draft4/maximum', tests: draft4_maximum },
  { draft: '4', name: 'draft4/minItems', tests: draft4_minItems },
  { draft: '4', name: 'draft4/minLength', tests: draft4_minLength },
  { draft: '4', name: 'draft4/minProperties', tests: draft4_minProperties },
  { draft: '4', name: 'draft4/minimum', tests: draft4_minimum },
  { draft: '4', name: 'draft4/multipleOf', tests: draft4_multipleOf },
  { draft: '4', name: 'draft4/not', tests: draft4_not },
  { draft: '4', name: 'draft4/oneOf', tests: draft4_oneOf },
  { draft: '4', name: 'draft4/optional/bignum', tests: draft4_optional_bignum },
  {
    draft: '4',
    name: 'draft4/optional/ecmascript-regex',
    tests: draft4_optional_ecmascript_regex
  },
  {
    draft: '4',
    name: 'draft4/optional/float-overflow',
    tests: draft4_optional_float_overflow
  },
  {
    draft: '4',
    name: 'draft4/optional/format/date-time',
    tests: draft4_optional_format_date_time
  },
  {
    draft: '4',
    name: 'draft4/optional/format/email',
    tests: draft4_optional_format_email
  },
  {
    draft: '4',
    name: 'draft4/optional/format/hostname',
    tests: draft4_optional_format_hostname
  },
  {
    draft: '4',
    name: 'draft4/optional/format/ipv4',
    tests: draft4_optional_format_ipv4
  },
  {
    draft: '4',
    name: 'draft4/optional/format/ipv6',
    tests: draft4_optional_format_ipv6
  },
  {
    draft: '4',
    name: 'draft4/optional/format/uri',
    tests: draft4_optional_format_uri
  },
  {
    draft: '4',
    name: 'draft4/optional/non-bmp-regex',
    tests: draft4_optional_non_bmp_regex
  },
  {
    draft: '4',
    name: 'draft4/optional/unicode',
    tests: draft4_optional_unicode
  },
  // {
  //   draft: '4',
  //   name: 'draft4/optional/zeroTerminatedFloats',
  //   tests: draft4_optional_zeroTerminatedFloats
  // },
  { draft: '4', name: 'draft4/pattern', tests: draft4_pattern },
  {
    draft: '4',
    name: 'draft4/patternProperties',
    tests: draft4_patternProperties
  },
  { draft: '4', name: 'draft4/properties', tests: draft4_properties },
  { draft: '4', name: 'draft4/ref', tests: draft4_ref },
  { draft: '4', name: 'draft4/refRemote', tests: draft4_refRemote },
  { draft: '4', name: 'draft4/required', tests: draft4_required },
  { draft: '4', name: 'draft4/type', tests: draft4_type },
  { draft: '4', name: 'draft4/uniqueItems', tests: draft4_uniqueItems },
  { draft: '7', name: 'draft7/additionalItems', tests: draft7_additionalItems },
  {
    draft: '7',
    name: 'draft7/additionalProperties',
    tests: draft7_additionalProperties
  },
  { draft: '7', name: 'draft7/allOf', tests: draft7_allOf },
  { draft: '7', name: 'draft7/anyOf', tests: draft7_anyOf },
  { draft: '7', name: 'draft7/boolean_schema', tests: draft7_boolean_schema },
  { draft: '7', name: 'draft7/const', tests: draft7_const },
  { draft: '7', name: 'draft7/contains', tests: draft7_contains },
  { draft: '7', name: 'draft7/default', tests: draft7_default },
  // { draft: '7', name: 'draft7/definitions', tests: draft7_definitions },
  { draft: '7', name: 'draft7/dependencies', tests: draft7_dependencies },
  { draft: '7', name: 'draft7/enum', tests: draft7_enum },
  {
    draft: '7',
    name: 'draft7/exclusiveMaximum',
    tests: draft7_exclusiveMaximum
  },
  {
    draft: '7',
    name: 'draft7/exclusiveMinimum',
    tests: draft7_exclusiveMinimum
  },
  { draft: '7', name: 'draft7/format', tests: draft7_format },
  { draft: '7', name: 'draft7/id', tests: draft7_id },
  { draft: '7', name: 'draft7/if-then-else', tests: draft7_if_then_else },
  {
    draft: '7',
    name: 'draft7/infinite-loop-detection',
    tests: draft7_infinite_loop_detection
  },
  { draft: '7', name: 'draft7/items', tests: draft7_items },
  { draft: '7', name: 'draft7/maxItems', tests: draft7_maxItems },
  { draft: '7', name: 'draft7/maxLength', tests: draft7_maxLength },
  { draft: '7', name: 'draft7/maxProperties', tests: draft7_maxProperties },
  { draft: '7', name: 'draft7/maximum', tests: draft7_maximum },
  { draft: '7', name: 'draft7/minItems', tests: draft7_minItems },
  { draft: '7', name: 'draft7/minLength', tests: draft7_minLength },
  { draft: '7', name: 'draft7/minProperties', tests: draft7_minProperties },
  { draft: '7', name: 'draft7/minimum', tests: draft7_minimum },
  { draft: '7', name: 'draft7/multipleOf', tests: draft7_multipleOf },
  { draft: '7', name: 'draft7/not', tests: draft7_not },
  { draft: '7', name: 'draft7/oneOf', tests: draft7_oneOf },
  { draft: '7', name: 'draft7/optional/bignum', tests: draft7_optional_bignum },
  {
    draft: '7',
    name: 'draft7/optional/content',
    tests: draft7_optional_content
  },
  {
    draft: '7',
    name: 'draft7/optional/ecmascript-regex',
    tests: draft7_optional_ecmascript_regex
  },
  {
    draft: '7',
    name: 'draft7/optional/float-overflow',
    tests: draft7_optional_float_overflow
  },
  {
    draft: '7',
    name: 'draft7/optional/format/date-time',
    tests: draft7_optional_format_date_time
  },
  {
    draft: '7',
    name: 'draft7/optional/format/date',
    tests: draft7_optional_format_date
  },
  {
    draft: '7',
    name: 'draft7/optional/format/email',
    tests: draft7_optional_format_email
  },
  {
    draft: '7',
    name: 'draft7/optional/format/hostname',
    tests: draft7_optional_format_hostname
  },
  {
    draft: '7',
    name: 'draft7/optional/format/idn-email',
    tests: draft7_optional_format_idn_email
  },
  {
    draft: '7',
    name: 'draft7/optional/format/idn-hostname',
    tests: draft7_optional_format_idn_hostname
  },
  {
    draft: '7',
    name: 'draft7/optional/format/ipv4',
    tests: draft7_optional_format_ipv4
  },
  {
    draft: '7',
    name: 'draft7/optional/format/ipv6',
    tests: draft7_optional_format_ipv6
  },
  {
    draft: '7',
    name: 'draft7/optional/format/iri-reference',
    tests: draft7_optional_format_iri_reference
  },
  {
    draft: '7',
    name: 'draft7/optional/format/iri',
    tests: draft7_optional_format_iri
  },
  {
    draft: '7',
    name: 'draft7/optional/format/json-pointer',
    tests: draft7_optional_format_json_pointer
  },
  {
    draft: '7',
    name: 'draft7/optional/format/regex',
    tests: draft7_optional_format_regex
  },
  {
    draft: '7',
    name: 'draft7/optional/format/relative-json-pointer',
    tests: draft7_optional_format_relative_json_pointer
  },
  {
    draft: '7',
    name: 'draft7/optional/format/time',
    tests: draft7_optional_format_time
  },
  {
    draft: '7',
    name: 'draft7/optional/format/uri-reference',
    tests: draft7_optional_format_uri_reference
  },
  {
    draft: '7',
    name: 'draft7/optional/format/uri-template',
    tests: draft7_optional_format_uri_template
  },
  {
    draft: '7',
    name: 'draft7/optional/format/uri',
    tests: draft7_optional_format_uri
  },
  {
    draft: '7',
    name: 'draft7/optional/non-bmp-regex',
    tests: draft7_optional_non_bmp_regex
  },
  {
    draft: '7',
    name: 'draft7/optional/unicode',
    tests: draft7_optional_unicode
  },
  { draft: '7', name: 'draft7/pattern', tests: draft7_pattern },
  {
    draft: '7',
    name: 'draft7/patternProperties',
    tests: draft7_patternProperties
  },
  { draft: '7', name: 'draft7/properties', tests: draft7_properties },
  { draft: '7', name: 'draft7/propertyNames', tests: draft7_propertyNames },
  { draft: '7', name: 'draft7/ref', tests: draft7_ref },
  { draft: '7', name: 'draft7/refRemote', tests: draft7_refRemote },
  { draft: '7', name: 'draft7/required', tests: draft7_required },
  { draft: '7', name: 'draft7/type', tests: draft7_type },
  { draft: '7', name: 'draft7/uniqueItems', tests: draft7_uniqueItems },
  { draft: '7', name: 'draft7/unknownKeyword', tests: draft7_unknownKeyword }
]
export const remotes: Remote[] = [
  {
    name: 'http://localhost:1234/baseUriChange/folderInteger.json',
    schema: remote_baseUriChange_folderInteger
  },
  {
    name: 'http://localhost:1234/baseUriChangeFolder/folderInteger.json',
    schema: remote_baseUriChangeFolder_folderInteger
  },
  {
    name: 'http://localhost:1234/baseUriChangeFolderInSubschema/folderInteger.json',
    schema: remote_baseUriChangeFolderInSubschema_folderInteger
  },
  { name: 'http://localhost:1234/integer.json', schema: remote_integer },
  { name: 'http://localhost:1234/name-defs.json', schema: remote_name_defs },
  { name: 'http://localhost:1234/name.json', schema: remote_name },
  {
    name: 'http://localhost:1234/ref-and-definitions.json',
    schema: remote_ref_and_definitions
  },
  {
    name: 'http://localhost:1234/ref-and-defs.json',
    schema: remote_ref_and_defs
  },
  {
    name: 'http://localhost:1234/subSchemas-defs.json',
    schema: remote_subSchemas_defs
  },
  { name: 'http://localhost:1234/subSchemas.json', schema: remote_subSchemas }
]


================================================
FILE: packages/json-schema/test/meta-schema.ts
================================================
import ky from 'ky'
import pMap from 'p-map'

import { dereference, type Schema } from '../src/index'

let lookup: Record<string, Schema> | undefined

export async function loadMeta() {
  if (lookup) {
    return lookup
  }

  lookup = Object.create({})
  const ids = [
    'http://json-schema.org/draft-04/schema',
    'http://json-schema.org/draft-07/schema',
    'https://json-schema.org/draft/2019-09/schema',
    'https://json-schema.org/draft/2019-09/meta/core',
    'https://json-schema.org/draft/2019-09/meta/applicator',
    'https://json-schema.org/draft/2019-09/meta/validation',
    'https://json-schema.org/draft/2019-09/meta/meta-data',
    'https://json-schema.org/draft/2019-09/meta/format',
    'https://json-schema.org/draft/2019-09/meta/content',
    'https://json-schema.org/draft/2020-12/schema',
    'https://json-schema.org/draft/2020-12/meta/core',
    'https://json-schema.org/draft/2020-12/meta/applicator',
    'https://json-schema.org/draft/2020-12/meta/validation',
    'https://json-schema.org/draft/2020-12/meta/meta-data',
    'https://json-schema.org/draft/2020-12/meta/format-annotation',
    'https://json-schema.org/draft/2020-12/meta/content',
    'https://json-schema.org/draft/2020-12/meta/unevaluated'
  ]

  await pMap(
    ids,
    async (id) => {
      const schema = await ky.get(id).json<Schema>()
      dereference(schema, lookup)
    },
    {
      concurrency: 4
    }
  )

  Object.freeze(lookup)
  return lookup
}


================================================
FILE: packages/json-schema/test/types.ts
================================================
import type { Schema, SchemaDraft } from '../src/types'

export interface SchemaTestSuite {
  draft: SchemaDraft
  name: string
  tests: SchemaTest[]
}

export interface SchemaTest {
  description: string
  schema: any
  tests: SchemaTestCase[]
}

export interface SchemaTestCase {
  description: string
  data: any
  valid: boolean
  debug?: true
}

export interface Remote {
  name: string
  schema: Schema
}


================================================
FILE: packages/json-schema/test/unsupported.ts
================================================
export const unsupportedTests: Record<
  string,
  Record<string, Record<string, boolean>>
> = {
  'draft2019-09/format': {
    'email format': {
      'invalid email string is only an annotation by default': true
    },
    'regex format': {
      'invalid regex string is only an annotation by default': true
    },
    'ipv4 format': {
      'invalid ipv4 string is only an annotation by default': true
    },
    'ipv6 format': {
      'invalid ipv6 string is only an annotation by default': true
    },
    'hostname format': {
      'invalid hostname string is only an annotation by default': true
    },
    'date format': {
      'invalid date string is only an annotation by default': true
    },
    'date-time format': {
      'invalid date-time string is only an annotation by default': true
    },
    'time format': {
      'invalid time string is only an annotation by default': true
    },
    'json-pointer format': {
      'invalid json-pointer string is only an annotation by default': true
    },
    'relative-json-pointer format': {
      'invalid relative-json-pointer string is only an annotation by default': true
    },
    'uri format': {
      'invalid uri string is only an annotation by default': true
    },
    'uri-reference format': {
      'invalid uri-reference string is only an annotation by default': true
    },
    'uri-template format': {
      'invalid uri-template string is only an annotation by default': true
    },
    'uuid format': {
      'invalid uuid string is only an annotation by default': true
    },
    'duration format': {
      'invalid duration string is only an annotation by default': true
    }
  },
  'draft4/type': {
    'multiple types can be specified in an array': {
      'an integer is valid': true
    }
  },
  'draft7/type': {
    'multiple types can be specified in an array': {
      'an integer is valid': true
    },
    'not multiple types': {
      mismatch: true
    }
  },
  'draft2019-09/type': {
    'multiple types can be specified in an array': {
      'an integer is valid': true
    }
  },
  'draft2020-12/type': {
    'multiple types can be specified in an array': {
      'an integer is valid': true
    }
  },
  'draft4/not': {
    'not multiple types': {
      mismatch: true
    }
  },
  'draft7/not': {
    'not multiple types': {
      mismatch: true
    }
  },
  'draft2019-09/not': {
    'not multiple types': {
      mismatch: true
    }
  },
  'draft2020-12/not': {
    'not multiple types': {
      mismatch: true
    }
  },
  'draft2019-09/optional/format/date': {
    'validation of date strings': {
      'a invalid date string with 32 days in January': true,
      'a invalid date string with 29 days in February (normal)': true,
      'a invalid date string with 30 days in February (leap)': true,
      'a invalid date string with 32 days in March': true,
      'a invalid date string with 31 days in April': true,
      'a invalid date string with 32 days in May': true,
      'a invalid date string with 31 days in June': true,
      'a invalid date string with 32 days in July': true,
      'a invalid date string with 32 days in August': true,
      'a invalid date string with 31 days in September': true,
      'a invalid date string with 32 days in October': true,
      'a invalid date string with 31 days in November': true,
      'a invalid date string with 32 days in December': true,
      'a invalid date string with invalid month': true,
      'invalid month': true,
      'invalid month-day combination': true,
      '2021 is not a leap year': true
    }
  },
  'draft2019-09/optional/format/idn-email': {
    'validation of an internationalized e-mail addresses': {
      'an invalid idn e-mail address': true,
      'an invalid e-mail address': true
    }
  },
  'draft2019-09/optional/format/idn-hostname': {
    'validation of internationalized host names': {
      'illegal first char U+302E Hangul single dot tone mark': true,
      'contains illegal char U+302E Hangul single dot tone mark': true,
      'a host name with a component too long': true,
      'invalid label, correct Punycode': true,
      'invalid Punycode': true,
      'U-label contains "--" in the 3rd and 4th position': true,
      'U-label starts with a dash': true,
      'U-label ends with a dash': true,
      'U-label starts and ends with a dash': true,
      'Begins with a Spacing Combining Mark': true,
      'Begins with a Nonspacing Mark': true,
      'Begins with an Enclosing Mark': true,
      'Exceptions that are DISALLOWED, right-to-left chars': true,
      'Exceptions that are DISALLOWED, left-to-right chars': true,
      "MIDDLE DOT with no preceding 'l'": true,
      'MIDDLE DOT with nothing preceding': true,
      "MIDDLE DOT with no following 'l'": true,
      'MIDDLE DOT with nothing following': true,
      'Greek KERAIA not followed by Greek': true,
      'Greek KERAIA not followed by anything': true,
      'Hebrew GERESH not preceded by Hebrew': true,
      'Hebrew GERESH not preceded by anything': true,
      'Hebrew GERSHAYIM not preceded by Hebrew': true,
      'Hebrew GERSHAYIM not preceded by anything': true,
      'KATAKANA MIDDLE DOT with no Hiragana, Katakana, or Han': true,
      'KATAKANA MIDDLE DOT with no other characters': true,
      'Arabic-Indic digits mixed with Extended Arabic-Indic digits': true,
      'ZERO WIDTH JOINER not preceded by Virama': true,
      'ZERO WIDTH JOINER not preceded by anything': true
    }
  },
  'draft2019-09/optional/format/ipv4': {
    'validation of IP addresses': {
      'leading zeroes should be rejected, as they are treated as octals': true
    }
  },
  'draft2019-09/optional/format/iri-reference': {
    'validation of IRI References': {
      'an invalid IRI Reference': true,
      'an invalid IRI fragment': true
    }
  },
  'draft2019-09/optional/format/iri': {
    'validation of IRIs': {
      'an invalid IRI based on IPv6': true,
      'an invalid relative IRI Reference': true,
      'an invalid IRI': true,
      'an invalid IRI though valid IRI reference': true
    }
  },
  'draft2019-09/optional/format/time': {
    'validation of time strings': {
      'valid leap second, positive time-offset': true,
      'valid leap second, large positive time-offset': true,
      'invalid leap second, positive time-offset (wrong hour)': true,
      'invalid leap second, positive time-offset (wrong minute)': true,
      'valid leap second, negative time-offset': true,
      'valid leap second, large negative time-offset': true,
      'invalid leap second, negative time-offset (wrong hour)': true,
      'invalid leap second, negative time-offset (wrong minute)': true,
      'an invalid time string with invalid hour': true,
      'an invalid time string with invalid time numoffset hour': true,
      'an invalid time string with invalid time numoffset minute': true
    }
  },
  'draft2019-09/optional/non-bmp-regex': {
    'Proper UTF-16 surrogate pair handling: pattern': {
      'matches empty': true,
      'matches two': true
    },
    'Proper UTF-16 surrogate pair handling: patternProperties': {
      "doesn't match two": true
    }
  },
  'draft2019-09/optional/unicode': {
    'unicode semantics should be used for all pattern matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    },
    'unicode digits are more than 0 through 9': {
      'non-ascii digits (BENGALI DIGIT FOUR, BENGALI DIGIT TWO)': true
    },
    'unicode semantics should be used for all patternProperties matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    }
  },
  'draft2020-12/defs': {
    'validate definition against metaschema': {
      'invalid definition schema': true
    }
  },
  'draft2020-12/dynamicRef': {
    'A $dynamicRef to a $dynamicAnchor in the same schema resource should behave like a normal $ref to an $anchor':
      {
        'An array containing non-strings is invalid': true
      },
    'A $dynamicRef to an $anchor in the same schema resource should behave like a normal $ref to an $anchor':
      {
        'An array containing non-strings is invalid': true
      },
    'A $ref to a $dynamicAnchor in the same schema resource should behave like a normal $ref to an $anchor':
      {
        'An array of strings is valid': true,
        'An array containing non-strings is invalid': true
      },
    'A $dynamicRef should resolve to the first $dynamicAnchor still in scope that is encountered when the schema is evaluated':
      {
        'An array containing non-strings is invalid': true
      },
    "A $dynamicRef with intermediate scopes that don't include a matching $dynamicAnchor should not affect dynamic scope resolution":
      {
        'An array containing non-strings is invalid': true
      },
    'A $dynamicRef that initially resolves to a schema with a matching $dynamicAnchor should resolve to the first $dynamicAnchor in the dynamic scope':
      {
        'The recursive part is not valid against the root': true
      },
    'multiple dynamic paths to the $dynamicRef keyword': {
      'recurse to integerNode - floats are not allowed': true
    },
    'after leaving a dynamic scope, it should not be used by a $dynamicRef': {
      'string matches /$defs/thingy, but the $dynamicRef does not stop here': true,
      'first_scope is not in dynamic scope for the $dynamicRef': true
    }
  },
  'draft2020-12/format': {
    'email format': {
      'invalid email string is only an annotation by default': true
    },
    'regex format': {
      'invalid regex string is only an annotation by default': true
    },
    'ipv4 format': {
      'invalid ipv4 string is only an annotation by default': true
    },
    'ipv6 format': {
      'invalid ipv6 string is only an annotation by default': true
    },
    'hostname format': {
      'invalid hostname string is only an annotation by default': true
    },
    'date format': {
      'invalid date string is only an annotation by default': true
    },
    'date-time format': {
      'invalid date-time string is only an annotation by default': true
    },
    'time format': {
      'invalid time string is only an annotation by default': true
    },
    'json-pointer format': {
      'invalid json-pointer string is only an annotation by default': true
    },
    'relative-json-pointer format': {
      'invalid relative-json-pointer string is only an annotation by default': true
    },
    'uri format': {
      'invalid uri string is only an annotation by default': true
    },
    'uri-reference format': {
      'invalid uri-reference string is only an annotation by default': true
    },
    'uri-template format': {
      'invalid uri-template string is only an annotation by default': true
    },
    'uuid format': {
      'invalid uuid string is only an annotation by default': true
    },
    'duration format': {
      'invalid duration string is only an annotation by default': true
    }
  },
  'draft2020-12/id': {
    'Invalid use of fragments in location-independent $id': {
      'Identifier name': true,
      'Identifier name and no ref': true,
      'Identifier path': true,
      'Identifier name with absolute URI': true,
      'Identifier path with absolute URI': true,
      'Identifier name with base URI change in subschema': true,
      'Identifier path with base URI change in subschema': true
    }
  },
  'draft2020-12/optional/format/date': {
    'validation of date strings': {
      'a invalid date string with 32 days in January': true,
      'a invalid date string with 29 days in February (normal)': true,
      'a invalid date string with 30 days in February (leap)': true,
      'a invalid date string with 32 days in March': true,
      'a invalid date string with 31 days in April': true,
      'a invalid date string with 32 days in May': true,
      'a invalid date string with 31 days in June': true,
      'a invalid date string with 32 days in July': true,
      'a invalid date string with 32 days in August': true,
      'a invalid date string with 31 days in September': true,
      'a invalid date string with 32 days in October': true,
      'a invalid date string with 31 days in November': true,
      'a invalid date string with 32 days in December': true,
      'a invalid date string with invalid month': true,
      'invalid month': true,
      'invalid month-day combination': true,
      '2021 is not a leap year': true
    }
  },
  'draft2020-12/optional/format/idn-email': {
    'validation of an internationalized e-mail addresses': {
      'an invalid idn e-mail address': true,
      'an invalid e-mail address': true
    }
  },
  'draft2020-12/optional/format/idn-hostname': {
    'validation of internationalized host names': {
      'illegal first char U+302E Hangul single dot tone mark': true,
      'contains illegal char U+302E Hangul single dot tone mark': true,
      'a host name with a component too long': true,
      'invalid label, correct Punycode': true,
      'invalid Punycode': true,
      'U-label contains "--" in the 3rd and 4th position': true,
      'U-label starts with a dash': true,
      'U-label ends with a dash': true,
      'U-label starts and ends with a dash': true,
      'Begins with a Spacing Combining Mark': true,
      'Begins with a Nonspacing Mark': true,
      'Begins with an Enclosing Mark': true,
      'Exceptions that are DISALLOWED, right-to-left chars': true,
      'Exceptions that are DISALLOWED, left-to-right chars': true,
      "MIDDLE DOT with no preceding 'l'": true,
      'MIDDLE DOT with nothing preceding': true,
      "MIDDLE DOT with no following 'l'": true,
      'MIDDLE DOT with nothing following': true,
      'Greek KERAIA not followed by Greek': true,
      'Greek KERAIA not followed by anything': true,
      'Hebrew GERESH not preceded by Hebrew': true,
      'Hebrew GERESH not preceded by anything': true,
      'Hebrew GERSHAYIM not preceded by Hebrew': true,
      'Hebrew GERSHAYIM not preceded by anything': true,
      'KATAKANA MIDDLE DOT with no Hiragana, Katakana, or Han': true,
      'KATAKANA MIDDLE DOT with no other characters': true,
      'Arabic-Indic digits mixed with Extended Arabic-Indic digits': true,
      'ZERO WIDTH JOINER not preceded by Virama': true,
      'ZERO WIDTH JOINER not preceded by anything': true
    }
  },
  'draft2020-12/optional/format/ipv4': {
    'validation of IP addresses': {
      'leading zeroes should be rejected, as they are treated as octals': true
    }
  },
  'draft2020-12/optional/format/iri-reference': {
    'validation of IRI References': {
      'an invalid IRI Reference': true,
      'an invalid IRI fragment': true
    }
  },
  'draft2020-12/optional/format/iri': {
    'validation of IRIs': {
      'an invalid IRI based on IPv6': true,
      'an invalid relative IRI Reference': true,
      'an invalid IRI': true,
      'an invalid IRI though valid IRI reference': true
    }
  },
  'draft2020-12/optional/format/time': {
    'validation of time strings': {
      'valid leap second, positive time-offset': true,
      'valid leap second, large positive time-offset': true,
      'invalid leap second, positive time-offset (wrong hour)': true,
      'invalid leap second, positive time-offset (wrong minute)': true,
      'valid leap second, negative time-offset': true,
      'valid leap second, large negative time-offset': true,
      'invalid leap second, negative time-offset (wrong hour)': true,
      'invalid leap second, negative time-offset (wrong minute)': true,
      'an invalid time string with invalid hour': true,
      'an invalid time string with invalid time numoffset hour': true,
      'an invalid time string with invalid time numoffset minute': true
    }
  },
  'draft2020-12/optional/non-bmp-regex': {
    'Proper UTF-16 surrogate pair handling: pattern': {
      'matches empty': true,
      'matches two': true
    },
    'Proper UTF-16 surrogate pair handling: patternProperties': {
      "doesn't match two": true
    }
  },
  'draft2020-12/optional/unicode': {
    'unicode semantics should be used for all pattern matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    },
    'unicode digits are more than 0 through 9': {
      'non-ascii digits (BENGALI DIGIT FOUR, BENGALI DIGIT TWO)': true
    },
    'unicode semantics should be used for all patternProperties matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    }
  },
  'draft2020-12/ref': {
    'relative pointer ref to array': {
      'mismatch array': true
    }
  },
  'draft4/optional/format/ipv4': {
    'validation of IP addresses': {
      'leading zeroes should be rejected, as they are treated as octals': true
    }
  },
  'draft4/optional/non-bmp-regex': {
    'Proper UTF-16 surrogate pair handling: pattern': {
      'matches empty': true,
      'matches two': true
    },
    'Proper UTF-16 surrogate pair handling: patternProperties': {
      "doesn't match two": true
    }
  },
  'draft4/optional/unicode': {
    'unicode semantics should be used for all pattern matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    },
    'unicode digits are more than 0 through 9': {
      'non-ascii digits (BENGALI DIGIT FOUR, BENGALI DIGIT TWO)': true
    },
    'unicode semantics should be used for all patternProperties matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    }
  },
  'draft4/optional/zeroTerminatedFloats': {
    'some languages do not distinguish between different types of numeric value':
      {
        'a float is not an integer even without fractional part': true
      }
  },
  'draft7/optional/content': {
    'validation of string-encoded content based on media type': {
      'an invalid JSON document': true
    },
    'validation of binary string-encoding': {
      'an invalid base64 string (% is not a valid character)': true
    },
    'validation of binary-encoded media type documents': {
      'a validly-encoded invalid JSON document': true,
      'an invalid base64 string that is valid JSON': true
    }
  },
  'draft7/optional/format/date': {
    'validation of date strings': {
      'a invalid date string with 32 days in January': true,
      'a invalid date string with 29 days in February (normal)': true,
      'a invalid date string with 30 days in February (leap)': true,
      'a invalid date string with 32 days in March': true,
      'a invalid date string with 31 days in April': true,
      'a invalid date string with 32 days in May': true,
      'a invalid date string with 31 days in June': true,
      'a invalid date string with 32 days in July': true,
      'a invalid date string with 32 days in August': true,
      'a invalid date string with 31 days in September': true,
      'a invalid date string with 32 days in October': true,
      'a invalid date string with 31 days in November': true,
      'a invalid date string with 32 days in December': true,
      'a invalid date string with invalid month': true,
      'invalid month': true,
      'invalid month-day combination': true,
      '2021 is not a leap year': true
    }
  },
  'draft7/optional/format/idn-email': {
    'validation of an internationalized e-mail addresses': {
      'an invalid idn e-mail address': true,
      'an invalid e-mail address': true
    }
  },
  'draft7/optional/format/idn-hostname': {
    'validation of internationalized host names': {
      'illegal first char U+302E Hangul single dot tone mark': true,
      'contains illegal char U+302E Hangul single dot tone mark': true,
      'a host name with a component too long': true,
      'invalid label, correct Punycode': true,
      'invalid Punycode': true,
      'U-label contains "--" in the 3rd and 4th position': true,
      'U-label starts with a dash': true,
      'U-label ends with a dash': true,
      'U-label starts and ends with a dash': true,
      'Begins with a Spacing Combining Mark': true,
      'Begins with a Nonspacing Mark': true,
      'Begins with an Enclosing Mark': true,
      'Exceptions that are DISALLOWED, right-to-left chars': true,
      'Exceptions that are DISALLOWED, left-to-right chars': true,
      "MIDDLE DOT with no preceding 'l'": true,
      'MIDDLE DOT with nothing preceding': true,
      "MIDDLE DOT with no following 'l'": true,
      'MIDDLE DOT with nothing following': true,
      'Greek KERAIA not followed by Greek': true,
      'Greek KERAIA not followed by anything': true,
      'Hebrew GERESH not preceded by Hebrew': true,
      'Hebrew GERESH not preceded by anything': true,
      'Hebrew GERSHAYIM not preceded by Hebrew': true,
      'Hebrew GERSHAYIM not preceded by anything': true,
      'KATAKANA MIDDLE DOT with no Hiragana, Katakana, or Han': true,
      'KATAKANA MIDDLE DOT with no other characters': true,
      'Arabic-Indic digits mixed with Extended Arabic-Indic digits': true,
      'ZERO WIDTH JOINER not preceded by Virama': true,
      'ZERO WIDTH JOINER not preceded by anything': true
    }
  },
  'draft7/optional/format/ipv4': {
    'validation of IP addresses': {
      'leading zeroes should be rejected, as they are treated as octals': true
    }
  },
  'draft7/optional/format/iri-reference': {
    'validation of IRI References': {
      'an invalid IRI Reference': true,
      'an invalid IRI fragment': true
    }
  },
  'draft7/optional/format/iri': {
    'validation of IRIs': {
      'an invalid IRI based on IPv6': true,
      'an invalid relative IRI Reference': true,
      'an invalid IRI': true,
      'an invalid IRI though valid IRI reference': true
    }
  },
  'draft7/optional/format/time': {
    'validation of time strings': {
      'valid leap second, positive time-offset': true,
      'valid leap second, large positive time-offset': true,
      'invalid leap second, positive time-offset (wrong hour)': true,
      'invalid leap second, positive time-offset (wrong minute)': true,
      'valid leap second, negative time-offset': true,
      'valid leap second, large negative time-offset': true,
      'invalid leap second, negative time-offset (wrong hour)': true,
      'invalid leap second, negative time-offset (wrong minute)': true,
      'an invalid time string with invalid hour': true,
      'an invalid time string with invalid time numoffset hour': true,
      'an invalid time string with invalid time numoffset minute': true
    }
  },
  'draft7/optional/non-bmp-regex': {
    'Proper UTF-16 surrogate pair handling: pattern': {
      'matches empty': true,
      'matches two': true
    },
    'Proper UTF-16 surrogate pair handling: patternProperties': {
      "doesn't match two": true
    }
  },
  'draft7/optional/unicode': {
    'unicode semantics should be used for all pattern matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    },
    'unicode digits are more than 0 through 9': {
      'non-ascii digits (BENGALI DIGIT FOUR, BENGALI DIGIT TWO)': true
    },
    'unicode semantics should be used for all patternProperties matching': {
      'literal unicode character in json string': true,
      'unicode character in hex format in string': true
    }
  }
}


================================================
FILE: packages/json-schema/test/validator.spec.ts
================================================
import { describe, expect, it } from 'vitest'

import { Validator } from '../src/validator'

describe('Validator', () => {
  it('validates', () => {
    const validator = new Validator({ schema: { type: 'number' } })

    expect(validator.validate(7).valid).to.equal(true)
    expect(validator.validate('hello world').valid).to.equal(false)
  })

  it('adds schema', () => {
    const validator = new Validator({
      schema: {
        $id: 'https://foo.bar/baz',
        $ref: '/beep'
      }
    })

    validator.addSchema({ $id: 'https://foo.bar/beep', type: 'boolean' })

    expect(validator.validate(true).valid).to.equal(true)
    expect(validator.validate('hello world').valid).to.equal(false)
  })

  it('adds schema with specified id', () => {
    const validator = new Validator({
      schema: {
        $id: 'https://foo.bar/baz',
        $ref: '/beep'
      }
    })

    validator.addSchema({ type: 'boolean' }, 'https://foo.bar/beep')

    expect(validator.validate(true).valid).to.equal(true)
    expect(validator.validate('hello world').valid).to.equal(false)
  })

  it('validate all array entries with nested errors', () => {
    const validator = new Validator({
      schema: {
        type: 'array',
        items: {
          name: { type: 'string' },
          email: { type: 'string' },
          required: ['name', 'email']
        }
      },
      draft: '2019-09',
      shortCircuit: false
    })

    const res = validator.validate([
      {
        name: 'hello'
        //missing email
      },
      {
        //missing name
        email: 'a@b.c'
      }
    ])
    expect(res.valid).to.equal(false)
    expect(res.errors.length).to.equal(4)
  })

  it('validate all object properties with nested errors', () => {
    const validator = new Validator({
      schema: {
        type: 'object',
        properties: {
          name: { type: 'string' },
          email: { type: 'string' },
          number: { type: 'number' },
          required: ['name', 'email', 'number']
        }
      },
      draft: '2019-09',
      shortCircuit: false
    })

    const res = validator.validate({
      name: 'hello',
      email: 5, //invalid type
      number: 'Hello' //invalid type
    })
    expect(res.valid).to.equal(false)
    expect(res.errors.length).to.equal(4)
  })
})


================================================
FILE: packages/json-schema/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "test", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/openapi-utils/fixtures/basic.json
================================================
{
  "openapi": "3.0.2",
  "info": {
    "title": "OpenAPI Basic Test Fixture",
    "version": "0.1.0"
  },
  "paths": {
    "/": {
      "get": {
        "summary": "Echo",
        "operationId": "echo",
        "parameters": [
          {
            "required": false,
            "schema": {
              "title": "name",
              "type": "string"
            },
            "name": "name",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://test-openapi-basic.now.sh"
    }
  ]
}


================================================
FILE: packages/openapi-utils/fixtures/firecrawl.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "title": "Firecrawl API",
    "version": "1.0.0",
    "description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
    "contact": {
      "name": "Firecrawl Support",
      "url": "https://firecrawl.dev/support",
      "email": "support@firecrawl.dev"
    }
  },
  "servers": [
    {
      "url": "https://api.firecrawl.dev/v0"
    }
  ],
  "paths": {
    "/scrape": {
      "post": {
        "summary": "Scrape a single URL",
        "operationId": "scrape",
        "tags": ["Scraping"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URL to scrape"
                  },
                  "formats": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "markdown",
                        "html",
                        "rawHtml",
                        "links",
                        "screenshot",
                        "screenshot@fullPage"
                      ]
                    },
                    "description": "Specific formats to return.\n\n - markdown: The page in Markdown format.\n - html: The page's HTML, trimmed to include only meaningful content.\n - rawHtml: The page's original HTML.\n - links: The links on the page.\n - screenshot: A screenshot of the top of the page.\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
                    "default": ["markdown"]
                  },
                  "headers": {
                    "type": "object",
                    "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
                  },
                  "includeTags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
                  },
                  "excludeTags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
                  },
                  "onlyMainContent": {
                    "type": "boolean",
                    "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                    "default": true
                  },
                  "timeout": {
                    "type": "integer",
                    "description": "Timeout in milliseconds for the request",
                    "default": 30000
                  },
                  "waitFor": {
                    "type": "integer",
                    "description": "Wait x amount of milliseconds for the page to load to fetch content",
                    "default": 0
                  }
                },
                "required": ["url"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScrapeResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl": {
      "post": {
        "summary": "Crawl multiple URLs based on options",
        "operationId": "crawlUrls",
        "tags": ["Crawling"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "The base URL to start crawling from"
                  },
                  "crawlerOptions": {
                    "type": "object",
                    "properties": {
                      "includes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "URL patterns to include"
                      },
                      "excludes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "URL patterns to exclude"
                      },
                      "generateImgAltText": {
                        "type": "boolean",
                        "description": "Generate alt text for images using LLMs (must have a paid plan)",
                        "default": false
                      },
                      "returnOnlyUrls": {
                        "type": "boolean",
                        "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                        "default": false
                      },
                      "maxDepth": {
                        "type": "integer",
                        "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern."
                      },
                      "mode": {
                        "type": "string",
                        "enum": ["default", "fast"],
                        "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                        "default": "default"
                      },
                      "ignoreSitemap": {
                        "type": "boolean",
                        "description": "Ignore the website sitemap when crawling",
                        "default": false
                      },
                      "limit": {
                        "type": "integer",
                        "description": "Maximum number of pages to crawl",
                        "default": 10000
                      },
                      "allowBackwardCrawling": {
                        "type": "boolean",
                        "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                        "default": false
                      },
                      "allowExternalContentLinks": {
                        "type": "boolean",
                        "description": "Allows the crawler to follow links to external websites.",
                        "default": false
                      }
                    }
                  },
                  "pageOptions": {
                    "type": "object",
                    "properties": {
                      "headers": {
                        "type": "object",
                        "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
                      },
                      "includeHtml": {
                        "type": "boolean",
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "default": false
                      },
                      "includeRawHtml": {
                        "type": "boolean",
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "default": false
                      },
                      "onlyIncludeTags": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
                      },
                      "onlyMainContent": {
                        "type": "boolean",
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "default": false
                      },
                      "removeTags": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
                      },
                      "replaceAllPathsWithAbsolutePaths": {
                        "type": "boolean",
                        "description": "Replace all relative paths with absolute paths for images and links",
                        "default": false
                      },
                      "screenshot": {
                        "type": "boolean",
                        "description": "Include a screenshot of the top of the page that you are scraping.",
                        "default": false
                      },
                      "fullPageScreenshot": {
                        "type": "boolean",
                        "description": "Include a full page screenshot of the page that you are scraping.",
                        "default": false
                      },
                      "waitFor": {
                        "type": "integer",
                        "description": "Wait x amount of milliseconds for the page to load to fetch content",
                        "default": 0
                      }
                    }
                  }
                },
                "required": ["url"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrawlResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/search": {
      "post": {
        "summary": "Search for a keyword in Google, returns top page results with markdown content for each page",
        "operationId": "searchGoogle",
        "tags": ["Search"],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string",
                    "format": "uri",
                    "description": "The query to search for"
                  },
                  "pageOptions": {
                    "type": "object",
                    "properties": {
                      "onlyMainContent": {
                        "type": "boolean",
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "default": false
                      },
                      "fetchPageContent": {
                        "type": "boolean",
                        "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                        "default": true
                      },
                      "includeHtml": {
                        "type": "boolean",
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "default": false
                      },
                      "includeRawHtml": {
                        "type": "boolean",
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "default": false
                      }
                    }
                  },
                  "searchOptions": {
                    "type": "object",
                    "properties": {
                      "limit": {
                        "type": "integer",
                        "description": "Maximum number of results. Max is 20 during beta."
                      }
                    }
                  }
                },
                "required": ["query"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl/status/{jobId}": {
      "get": {
        "tags": ["Crawl"],
        "summary": "Get the status of a crawl job",
        "operationId": "getCrawlStatus",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "description": "ID of the crawl job",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Status of the job (completed, active, failed, paused)"
                    },
                    "current": {
                      "type": "integer",
                      "description": "Current page number"
                    },
                    "total": {
                      "type": "integer",
                      "description": "Total number of pages"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                      },
                      "description": "Data returned from the job (null when it is in progress)"
                    },
                    "partial_data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj"
                      },
                      "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in `data`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array."
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/crawl/cancel/{jobId}": {
      "delete": {
        "tags": ["Crawl"],
        "summary": "Cancel a crawl job",
        "operationId": "cancelCrawlJob",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "jobId",
            "in": "path",
            "description": "ID of the crawl job",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Returns cancelled."
                    }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment required",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Payment required to access this resource."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request rate limit exceeded. Please wait and try again later."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred on the server."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "ScrapeResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "warning": {
            "type": "string",
            "nullable": true,
            "description": "Warning message to let you know of any issues."
          },
          "data": {
            "type": "object",
            "properties": {
              "markdown": {
                "type": "string",
                "nullable": true,
                "description": "Markdown content of the page if the `markdown` format was specified (default)"
              },
              "html": {
                "type": "string",
                "nullable": true,
                "description": "HTML version of the content on page if the `html` format was specified"
              },
              "rawHtml": {
                "type": "string",
                "nullable": true,
                "description": "Raw HTML content of the page if the `rawHtml` format was specified"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "uri"
                },
                "nullable": true,
                "description": "Links on the page if the `links` format was specified"
              },
              "screenshot": {
                "type": "string",
                "nullable": true,
                "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
              },
              "metadata": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceURL": {
                    "type": "string",
                    "format": "uri"
                  },
                  "<any other metadata> ": {
                    "type": "string"
                  },
                  "statusCode": {
                    "type": "integer",
                    "description": "The status code of the page"
                  },
                  "error": {
                    "type": "string",
                    "nullable": true,
                    "description": "The error message of the page"
                  }
                }
              }
            }
          }
        }
      },
      "CrawlStatusResponseObj": {
        "type": "object",
        "properties": {
          "markdown": {
            "type": "string",
            "nullable": true,
            "description": "Markdown content of the page if the `markdown` format was specified (default)"
          },
          "html": {
            "type": "string",
            "nullable": true,
            "description": "HTML version of the content on page if the `html` format was specified"
          },
          "rawHtml": {
            "type": "string",
            "nullable": true,
            "description": "Raw HTML content of the page if the `rawHtml` format was specified"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "nullable": true,
            "description": "Links on the page if the `links` format was specified"
          },
          "screenshot": {
            "type": "string",
            "nullable": true,
            "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
          },
          "metadata": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "language": {
                "type": "string",
                "nullable": true
              },
              "sourceURL": {
                "type": "string",
                "format": "uri"
              },
              "<any other metadata> ": {
                "type": "string"
              },
              "statusCode": {
                "type": "integer",
                "description": "The status code of the page"
              },
              "error": {
                "type": "string",
                "nullable": true,
                "description": "The error message of the page"
              }
            }
          }
        }
      },
      "SearchResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "markdown": {
                "type": "string",
                "nullable": true,
                "description": "Markdown content of the page if the `markdown` format was specified (default)"
              },
              "html": {
                "type": "string",
                "nullable": true,
                "description": "HTML version of the content on page if the `html` format was specified"
              },
              "rawHtml": {
                "type": "string",
                "nullable": true,
                "description": "Raw HTML content of the page if the `rawHtml` format was specified"
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "uri"
                },
                "nullable": true,
                "description": "Links on the page if the `links` format was specified"
              },
              "screenshot": {
                "type": "string",
                "nullable": true,
                "description": "URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified"
              },
              "metadata": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceURL": {
                    "type": "string",
                    "format": "uri"
                  },
                  "<any other metadata> ": {
                    "type": "string"
                  },
                  "statusCode": {
                    "type": "integer",
                    "description": "The status code of the page"
                  },
                  "error": {
                    "type": "string",
                    "nullable": true,
                    "description": "The error message of the page"
                  }
                }
              }
            }
          }
        }
      },
      "CrawlResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}


================================================
FILE: packages/openapi-utils/fixtures/mixed.json
================================================
{
  "openapi": "3.0.2",
  "info": {
    "title": "OpenAPI Mixed Test Fixture",
    "version": "0.1.0"
  },
  "paths": {
    "/echo/{id}": {
      "parameters": [
        {
          "required": true,
          "schema": {
            "title": "id",
            "type": "string"
          },
          "name": "id",
          "in": "path"
        }
      ],
      "get": {
        "summary": "Echo",
        "operationId": "echo",
        "parameters": [
          {
            "required": false,
            "schema": {
              "title": "x-custom-header",
              "type": "string"
            },
            "name": "x-custom-header",
            "in": "header"
          },
          {
            "required": false,
            "schema": {
              "title": "name",
              "type": "string"
            },
            "name": "name",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://test-openapi-basic.now.sh"
    }
  ]
}


================================================
FILE: packages/openapi-utils/fixtures/notion.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "title": "Notion API",
    "version": "1.0.0",
    "description": "API specification for Notion"
  },
  "servers": [{ "url": "https://api.notion.so" }],
  "security": [{ "oauth2": [] }],

  "paths": {
    "/users/me": {
      "get": {
        "summary": "Get current user",
        "operationId": "getSelf",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse"
                }
              }
            }
          }
        }
      }
    },
    "/users/{user_id}": {
      "get": {
        "summary": "Get user",
        "operationId": "getUser",
        "parameters": [
          {
            "name": "user_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse"
                }
              }
            }
          }
        }
      }
    },
    "/users": {
      "get": {
        "summary": "List users",
        "operationId": "listUsers",
        "parameters": [
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListUsersResponse"
                }
              }
            }
          }
        }
      }
    },
    "/pages": {
      "post": {
        "summary": "Create page",
        "operationId": "createPage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePageParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/pages/{page_id}": {
      "get": {
        "summary": "Get page",
        "operationId": "getPage",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter_properties",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update page",
        "operationId": "updatePage",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePageParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/pages/{page_id}/properties/{property_id}": {
      "get": {
        "summary": "Get page property",
        "operationId": "getPageProperty",
        "parameters": [
          {
            "name": "page_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "property_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PropertyItemObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PropertyItemListResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/blocks/{block_id}": {
      "get": {
        "summary": "Get block",
        "operationId": "getBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update block",
        "operationId": "updateBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlockParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete block",
        "operationId": "deleteBlock",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/blocks/{block_id}/children": {
      "get": {
        "summary": "List block children",
        "operationId": "listBlockChildren",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBlockChildrenResponse"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Append block children",
        "operationId": "appendBlockChildren",
        "parameters": [
          {
            "name": "block_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppendBlockChildrenParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppendBlockChildrenResponse"
                }
              }
            }
          }
        }
      }
    },
    "/databases/{database_id}": {
      "get": {
        "summary": "Get database",
        "operationId": "getDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update database",
        "operationId": "updateDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/databases/{database_id}/query": {
      "post": {
        "summary": "Query database",
        "operationId": "queryDatabase",
        "parameters": [
          {
            "name": "database_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filter_properties",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QueryDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryDatabaseResponse"
                }
              }
            }
          }
        }
      }
    },
    "/databases": {
      "get": {
        "summary": "List databases",
        "operationId": "listDatabases",
        "parameters": [
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListDatabasesResponse"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create database",
        "operationId": "createDatabase",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDatabaseParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/search": {
      "post": {
        "summary": "Search",
        "operationId": "search",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          }
        }
      }
    },
    "/comments": {
      "post": {
        "summary": "Create comment",
        "operationId": "createComment",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCommentParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CommentObjectResponse"
                    },
                    {
                      "$ref": "#/components/schemas/PartialCommentObjectResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "get": {
        "summary": "List comments",
        "operationId": "listComments",
        "parameters": [
          {
            "name": "block_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListCommentsResponse"
                }
              }
            }
          }
        }
      }
    },
    "/oauth/token": {
      "post": {
        "summary": "OAuth token",
        "operationId": "oauthToken",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OauthTokenParameters"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OauthTokenResponse"
                }
              }
            }
          }
        }
      }
    }
  },

  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "scopes": {},
            "authorizationUrl": "https://api.notion.com/v1/oauth/authorize",
            "tokenUrl": "https://api.notion.com/v1/oauth/token"
          }
        }
      }
    },
    "schemas": {
      "UserObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["user"]
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["person", "bot"]
          },
          "name": {
            "type": "string"
          },
          "avatar_url": {
            "type": "string"
          }
        },
        "required": ["object", "id", "type", "name", "avatar_url"]
      },
      "ListUsersResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["results", "next_cursor", "has_more"]
      },
      "CreatePageParameters": {
        "type": "object",
        "properties": {
          "parent": {
            "type": "object",
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database_id"]
                  },
                  "database_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "database_id"]
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["title"]
                },
                {
                  "type": "object",
                  "properties": {
                    "rich_text": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["rich_text"]
                },
                {
                  "type": "object",
                  "properties": {
                    "number": {
                      "type": ["number", "null"]
                    }
                  },
                  "required": ["number"]
                },
                {
                  "type": "object",
                  "properties": {
                    "select": {
                      "type": ["object", "null"],
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": ["name"]
                    }
                  },
                  "required": ["select"]
                }
              ]
            }
          }
        },
        "required": ["parent", "properties"]
      },
      "PageObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["page"]
          },
          "id": {
            "type": "string"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "created_time",
          "last_edited_time",
          "archived",
          "url"
        ]
      },
      "PartialPageObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["page"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "UpdatePageParameters": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "additionalProperties": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["title"]
                },
                {
                  "type": "object",
                  "properties": {
                    "rich_text": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  },
                  "required": ["rich_text"]
                },
                {
                  "type": "object",
                  "properties": {
                    "number": {
                      "type": ["number", "null"]
                    }
                  },
                  "required": ["number"]
                },
                {
                  "type": "object",
                  "properties": {
                    "select": {
                      "type": ["object", "null"],
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": ["name"]
                    }
                  },
                  "required": ["select"]
                }
              ]
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "PropertyItemObjectResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["type", "id"]
      },
      "PropertyItemListResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyItemObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["results", "next_cursor", "has_more"]
      },
      "PartialBlockObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["block"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "BlockObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["block"]
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          },
          "has_children": {
            "type": "boolean"
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "id",
          "type",
          "created_time",
          "last_edited_time",
          "has_children",
          "archived"
        ]
      },
      "UpdateBlockParameters": {
        "type": "object",
        "properties": {
          "paragraph": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_1": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_2": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "heading_3": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "bulleted_list_item": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "numbered_list_item": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "quote": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "to_do": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "checked": {
                "type": "boolean"
              },
              "color": {
                "type": "string"
              }
            }
          },
          "toggle": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "color": {
                "type": "string"
              }
            }
          },
          "code": {
            "type": "object",
            "properties": {
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              },
              "language": {
                "type": "string"
              }
            }
          },
          "embed": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              }
            }
          },
          "image": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "video": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "file": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "pdf": {
            "type": "object",
            "properties": {
              "external": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "bookmark": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              }
            }
          },
          "equation": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            }
          },
          "divider": {
            "type": "object"
          },
          "table_of_contents": {
            "type": "object",
            "properties": {
              "color": {
                "type": "string"
              }
            }
          },
          "breadcrumb": {
            "type": "object"
          },
          "column_list": {
            "type": "object"
          },
          "column": {
            "type": "object"
          },
          "link_to_page": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": ["page_id", "database_id"]
              },
              "page_id": {
                "type": "string"
              },
              "database_id": {
                "type": "string"
              }
            }
          },
          "table_row": {
            "type": "object",
            "properties": {
              "cells": {
                "type": "array",
                "items": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RichTextItemRequest"
                  }
                }
              }
            }
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "ListBlockChildrenResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "AppendBlockChildrenParameters": {
        "type": "object",
        "properties": {
          "children": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BlockObjectRequest"
            }
          }
        },
        "required": ["children"]
      },
      "AppendBlockChildrenResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "PartialDatabaseObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["database"]
          },
          "id": {
            "type": "string"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse"
            }
          }
        },
        "required": ["object", "id", "properties"]
      },
      "DatabaseObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["database"]
          },
          "id": {
            "type": "string"
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  },
                  "emoji": {
                    "type": "string"
                  }
                },
                "required": ["type", "emoji"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "created_time": {
            "type": "string"
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "last_edited_time": {
            "type": "string"
          },
          "last_edited_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "is_inline": {
            "type": "boolean"
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse"
            }
          },
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["workspace"]
                  },
                  "workspace": {
                    "type": "boolean",
                    "enum": [true]
                  }
                },
                "required": ["type", "workspace"]
              }
            ]
          },
          "url": {
            "type": "string"
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "object",
          "id",
          "created_time",
          "created_by",
          "last_edited_time",
          "last_edited_by",
          "title",
          "description",
          "is_inline",
          "properties",
          "parent",
          "url",
          "archived"
        ]
      },
      "UpdateDatabaseParameters": {
        "type": "object",
        "properties": {
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "emoji": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  }
                },
                "required": ["emoji", "type"]
              },
              {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  }
                },
                "required": ["external", "type"]
              },
              {
                "type": "null"
              }
            ]
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  }
                },
                "required": ["external", "type"]
              },
              {
                "type": "null"
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertyUpdateSchema"
            }
          },
          "is_inline": {
            "type": "boolean"
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "QueryDatabaseParameters": {
        "type": "object",
        "properties": {
          "sorts": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "property": {
                      "type": "string"
                    },
                    "direction": {
                      "type": "string",
                      "enum": ["ascending", "descending"]
                    }
                  },
                  "required": ["property", "direction"]
                },
                {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "enum": ["created_time", "last_edited_time"]
                    },
                    "direction": {
                      "type": "string",
                      "enum": ["ascending", "descending"]
                    }
                  },
                  "required": ["timestamp", "direction"]
                }
              ]
            }
          },
          "filter": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PropertyFilter"
              },
              {
                "$ref": "#/components/schemas/CompoundFilter"
              }
            ]
          },
          "start_cursor": {
            "type": "string"
          },
          "page_size": {
            "type": "integer"
          },
          "archived": {
            "type": "boolean"
          }
        }
      },
      "QueryDatabaseResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "ListDatabasesResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "CreateDatabaseParameters": {
        "type": "object",
        "properties": {
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database_id"]
                  },
                  "database_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "database_id"]
              }
            ]
          },
          "properties": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertySchema"
            }
          },
          "icon": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["emoji"]
                  },
                  "emoji": {
                    "type": "string"
                  }
                },
                "required": ["type", "emoji"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "cover": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["external"]
                  },
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "external"]
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "description": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest"
            }
          },
          "is_inline": {
            "type": "boolean"
          }
        },
        "required": ["parent", "properties", "title"]
      },
      "SearchParameters": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string"
          },
          "sort": {
            "type": "object",
            "properties": {
              "direction": {
                "type": "string",
                "enum": ["ascending", "descending"]
              },
              "timestamp": {
                "type": "string",
                "enum": ["last_edited_time"]
              }
            },
            "required": ["direction", "timestamp"]
          },
          "filter": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "enum": ["page", "database"]
              },
              "property": {
                "type": "string",
                "enum": ["object"]
              }
            },
            "required": ["value", "property"]
          },
          "start_cursor": {
            "type": "string"
          },
          "page_size": {
            "type": "integer"
          }
        }
      },
      "SearchResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse"
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse"
                }
              ]
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "CreateCommentParameters": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "parent": {
                "type": "object",
                "properties": {
                  "page_id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  }
                },
                "required": ["page_id"]
              },
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              }
            },
            "required": ["parent", "rich_text"]
          },
          {
            "type": "object",
            "properties": {
              "discussion_id": {
                "type": "string"
              },
              "rich_text": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest"
                }
              }
            },
            "required": ["discussion_id", "rich_text"]
          }
        ]
      },
      "CommentObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["comment"]
          },
          "id": {
            "type": "string"
          },
          "parent": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page_id"]
                  },
                  "page_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "page_id"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["block_id"]
                  },
                  "block_id": {
                    "type": "string"
                  }
                },
                "required": ["type", "block_id"]
              }
            ]
          },
          "discussion_id": {
            "type": "string"
          },
          "rich_text": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse"
            }
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse"
          },
          "created_time": {
            "type": "string"
          },
          "last_edited_time": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "parent",
          "discussion_id",
          "rich_text",
          "created_by",
          "created_time",
          "last_edited_time"
        ]
      },
      "PartialCommentObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["comment"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "ListCommentsResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["list"]
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CommentObjectResponse"
            }
          },
          "next_cursor": {
            "type": ["string", "null"]
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "required": ["object", "results", "next_cursor", "has_more"]
      },
      "OauthTokenParameters": {
        "type": "object",
        "properties": {
          "grant_type": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "redirect_uri": {
            "type": "string"
          },
          "external_account": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": ["key", "name"]
          }
        },
        "required": ["grant_type", "code"]
      },
      "OauthTokenResponse": {
        "type": "object",
        "properties": {
          "access_token": {
            "type": "string"
          },
          "token_type": {
            "type": "string",
            "enum": ["bearer"]
          },
          "bot_id": {
            "type": "string"
          },
          "workspace_name": {
            "type": ["string", "null"]
          },
          "workspace_icon": {
            "type": ["string", "null"]
          },
          "workspace_id": {
            "type": "string"
          },
          "owner": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["user"]
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/UserObjectResponse"
                      },
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse"
                      }
                    ]
                  }
                },
                "required": ["type", "user"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["workspace"]
                  },
                  "workspace": {
                    "type": "boolean",
                    "enum": [true]
                  }
                },
                "required": ["type", "workspace"]
              }
            ]
          },
          "duplicated_template_id": {
            "type": ["string", "null"]
          }
        },
        "required": [
          "access_token",
          "token_type",
          "bot_id",
          "workspace_name",
          "workspace_icon",
          "workspace_id",
          "owner",
          "duplicated_template_id"
        ]
      },
      "RichTextItemRequest": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "text": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "string"
                  },
                  "link": {
                    "type": ["object", "null"],
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["content"]
              },
              "type": {
                "type": "string",
                "enum": ["text"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["text"]
          },
          {
            "type": "object",
            "properties": {
              "mention": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "user": {
                        "oneOf": [
                          {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string"
                              }
                            },
                            "required": ["id"]
                          },
                          {
                            "$ref": "#/components/schemas/UserObjectResponse"
                          }
                        ]
                      }
                    },
                    "required": ["user"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "page": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          }
                        },
                        "required": ["id"]
                      }
                    },
                    "required": ["page"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "database": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          }
                        },
                        "required": ["id"]
                      }
                    },
                    "required": ["database"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "date": {
                        "$ref": "#/components/schemas/DateRequest"
                      }
                    },
                    "required": ["date"]
                  }
                ]
              },
              "type": {
                "type": "string",
                "enum": ["mention"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["mention"]
          },
          {
            "type": "object",
            "properties": {
              "equation": {
                "type": "object",
                "properties": {
                  "expression": {
                    "type": "string"
                  }
                },
                "required": ["expression"]
              },
              "type": {
                "type": "string",
                "enum": ["equation"]
              },
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest"
              }
            },
            "required": ["equation"]
          }
        ]
      },
      "RichTextItemResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextRichTextItemResponse"
          },
          {
            "$ref": "#/components/schemas/MentionRichTextItemResponse"
          },
          {
            "$ref": "#/components/schemas/EquationRichTextItemResponse"
          }
        ]
      },
      "AnnotationRequest": {
        "type": "object",
        "properties": {
          "bold": {
            "type": "boolean"
          },
          "italic": {
            "type": "boolean"
          },
          "strikethrough": {
            "type": "boolean"
          },
          "underline": {
            "type": "boolean"
          },
          "code": {
            "type": "boolean"
          },
          "color": {
            "type": "string",
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background"
            ]
          }
        }
      },
      "DateRequest": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string"
          },
          "end": {
            "type": ["string", "null"]
          },
          "time_zone": {
            "type": ["string", "null"]
          }
        },
        "required": ["start"]
      },
      "TextRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["text"]
          },
          "text": {
            "type": "object",
            "properties": {
              "content": {
                "type": "string"
              },
              "link": {
                "type": ["object", "null"],
                "properties": {
                  "url": {
                    "type": "string"
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["content", "link"]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "text", "annotations", "plain_text", "href"]
      },
      "MentionRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["mention"]
          },
          "mention": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["user"]
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse"
                      },
                      {
                        "$ref": "#/components/schemas/UserObjectResponse"
                      }
                    ]
                  }
                },
                "required": ["type", "user"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["date"]
                  },
                  "date": {
                    "$ref": "#/components/schemas/DateResponse"
                  }
                },
                "required": ["type", "date"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["link_preview"]
                  },
                  "link_preview": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  }
                },
                "required": ["type", "link_preview"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["page"]
                  },
                  "page": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": ["id"]
                  }
                },
                "required": ["type", "page"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["database"]
                  },
                  "database": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      }
                    },
                    "required": ["id"]
                  }
                },
                "required": ["type", "database"]
              }
            ]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "mention", "annotations", "plain_text", "href"]
      },
      "EquationRichTextItemResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["equation"]
          },
          "equation": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            },
            "required": ["expression"]
          },
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse"
          },
          "plain_text": {
            "type": "string"
          },
          "href": {
            "type": ["string", "null"]
          }
        },
        "required": ["type", "equation", "annotations", "plain_text", "href"]
      },
      "AnnotationResponse": {
        "type": "object",
        "properties": {
          "bold": {
            "type": "boolean"
          },
          "italic": {
            "type": "boolean"
          },
          "strikethrough": {
            "type": "boolean"
          },
          "underline": {
            "type": "boolean"
          },
          "code": {
            "type": "boolean"
          },
          "color": {
            "type": "string",
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background"
            ]
          }
        },
        "required": [
          "bold",
          "italic",
          "strikethrough",
          "underline",
          "code",
          "color"
        ]
      },
      "DateResponse": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string"
          },
          "end": {
            "type": ["string", "null"]
          },
          "time_zone": {
            "type": ["string", "null"]
          }
        },
        "required": ["start", "end", "time_zone"]
      },
      "PartialUserObjectResponse": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "enum": ["user"]
          },
          "id": {
            "type": "string"
          }
        },
        "required": ["object", "id"]
      },
      "DatabasePropertyConfigResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TitlePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RichTextPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/NumberPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/SelectPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/MultiSelectPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/DatePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/PeoplePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/FilePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CheckboxPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/URLPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/EmailPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/PhoneNumberPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/FormulaPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RelationPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/RollupPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CreatedTimePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/CreatedByPropertyResponse"
          },
          {
            "$ref": "#/components/schemas/LastEditedTimePropertyResponse"
          },
          {
            "$ref": "#/components/schemas/LastEditedByPropertyResponse"
          }
        ]
      },
      "TitlePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["title"]
          },
          "title": {
            "type": "object"
          }
        },
        "required": ["id", "type", "title"]
      },
      "RichTextPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["rich_text"]
          },
          "rich_text": {
            "type": "object"
          }
        },
        "required": ["id", "type", "rich_text"]
      },
      "NumberPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["number"]
          },
          "number": {
            "type": "object",
            "properties": {
              "format": {
                "type": "string"
              }
            },
            "required": ["format"]
          }
        },
        "required": ["id", "type", "number"]
      },
      "SelectPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["select"]
          },
          "select": {
            "type": "object",
            "properties": {
              "options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SelectOption"
                }
              }
            },
            "required": ["options"]
          }
        },
        "required": ["id", "type", "select"]
      },
      "MultiSelectPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["multi_select"]
          },
          "multi_select": {
            "type": "object",
            "properties": {
              "options": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SelectOption"
                }
              }
            },
            "required": ["options"]
          }
        },
        "required": ["id", "type", "multi_select"]
      },
      "DatePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["date"]
          },
          "date": {
            "type": "object"
          }
        },
        "required": ["id", "type", "date"]
      },
      "PeoplePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["people"]
          },
          "people": {
            "type": "object"
          }
        },
        "required": ["id", "type", "people"]
      },
      "FilePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["files"]
          },
          "files": {
            "type": "object"
          }
        },
        "required": ["id", "type", "files"]
      },
      "CheckboxPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["checkbox"]
          },
          "checkbox": {
            "type": "object"
          }
        },
        "required": ["id", "type", "checkbox"]
      },
      "URLPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["url"]
          },
          "url": {
            "type": "object"
          }
        },
        "required": ["id", "type", "url"]
      },
      "EmailPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["email"]
          },
          "email": {
            "type": "object"
          }
        },
        "required": ["id", "type", "email"]
      },
      "PhoneNumberPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["phone_number"]
          },
          "phone_number": {
            "type": "object"
          }
        },
        "required": ["id", "type", "phone_number"]
      },
      "FormulaPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["formula"]
          },
          "formula": {
            "type": "object",
            "properties": {
              "expression": {
                "type": "string"
              }
            },
            "required": ["expression"]
          }
        },
        "required": ["id", "type", "formula"]
      },
      "RelationPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["relation"]
          },
          "relation": {
            "type": "object",
            "properties": {
              "database_id": {
                "type": "string"
              },
              "synced_property_name": {
                "type": "string"
              },
              "synced_property_id": {
                "type": "string"
              }
            },
            "required": [
              "database_id",
              "synced_property_name",
              "synced_property_id"
            ]
          }
        },
        "required": ["id", "type", "relation"]
      },
      "RollupPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["rollup"]
          },
          "rollup": {
            "type": "object",
            "properties": {
              "relation_property_name": {
                "type": "string"
              },
              "relation_property_id": {
                "type": "string"
              },
              "rollup_property_name": {
                "type": "string"
              },
              "rollup_property_id": {
                "type": "string"
              },
              "function": {
                "type": "string"
              }
            },
            "required": [
              "relation_property_name",
              "relation_property_id",
              "rollup_property_name",

              "rollup_property_id",
              "function"
            ]
          }
        },
        "required": ["id", "type", "rollup"]
      },
      "CreatedTimePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["created_time"]
          },
          "created_time": {
            "type": "object"
          }
        },
        "required": ["id", "type", "created_time"]
      },
      "CreatedByPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["created_by"]
          },
          "created_by": {
            "type": "object"
          }
        },
        "required": ["id", "type", "created_by"]
      },
      "LastEditedTimePropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["last_edited_time"]
          },
          "last_edited_time": {
            "type": "object"
          }
        },
        "required": ["id", "type", "last_edited_time"]
      },
      "LastEditedByPropertyResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": ["last_edited_by"]
          },
          "last_edited_by": {
            "type": "object"
          }
        },
        "required": ["id", "type", "last_edited_by"]
      },
      "SelectOption": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "color": {
            "type": "string"
          }
        },
        "required": ["id", "name", "color"]
      },
      "PropertyUpdateSchema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        }
      },
      "PropertySchema": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "name": {
            "type": ["string", "null"]
          }
        },
        "required": ["type"]
      },
      "PropertyFilter": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "title": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "title"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "rich_text": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "rich_text"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "number": {
                "$ref": "#/components/schemas/NumberPropertyFilter"
              }
            },
            "required": ["property", "number"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "checkbox": {
                "$ref": "#/components/schemas/CheckboxPropertyFilter"
              }
            },
            "required": ["property", "checkbox"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "select": {
                "$ref": "#/components/schemas/SelectPropertyFilter"
              }
            },
            "required": ["property", "select"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "multi_select": {
                "$ref": "#/components/schemas/MultiSelectPropertyFilter"
              }
            },
            "required": ["property", "multi_select"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "date": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "date"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "people": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "people"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "files": {
                "$ref": "#/components/schemas/FilesPropertyFilter"
              }
            },
            "required": ["property", "files"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "url": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "url"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "email": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "email"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "phone_number": {
                "$ref": "#/components/schemas/TextPropertyFilter"
              }
            },
            "required": ["property", "phone_number"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "relation": {
                "$ref": "#/components/schemas/RelationPropertyFilter"
              }
            },
            "required": ["property", "relation"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "created_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "created_by"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "created_time"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "last_edited_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter"
              }
            },
            "required": ["property", "last_edited_by"]
          },
          {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["property", "last_edited_time"]
          },
          {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "string",
                "enum": ["created_time", "last_edited_time"]
              },
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["timestamp", "created_time"]
          },
          {
            "type": "object",
            "properties": {
              "timestamp": {
                "type": "string",
                "enum": ["created_time", "last_edited_time"]
              },
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter"
              }
            },
            "required": ["timestamp", "last_edited_time"]
          }
        ]
      },
      "TextPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "does_not_equal": {
            "type": "string"
          },
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "starts_with": {
            "type": "string"
          },
          "ends_with": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "NumberPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "number"
          },
          "does_not_equal": {
            "type": "number"
          },
          "greater_than": {
            "type": "number"
          },
          "less_than": {
            "type": "number"
          },
          "greater_than_or_equal_to": {
            "type": "number"
          },
          "less_than_or_equal_to": {
            "type": "number"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "CheckboxPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "boolean"
          },
          "does_not_equal": {
            "type": "boolean"
          }
        }
      },
      "SelectPropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "does_not_equal": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "MultiSelectPropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "DatePropertyFilter": {
        "type": "object",
        "properties": {
          "equals": {
            "type": "string"
          },
          "before": {
            "type": "string"
          },
          "after": {
            "type": "string"
          },
          "on_or_before": {
            "type": "string"
          },
          "on_or_after": {
            "type": "string"
          },
          "past_week": {},
          "past_month": {},
          "past_year": {},
          "next_week": {},
          "next_month": {},
          "next_year": {},
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "PeoplePropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "FilesPropertyFilter": {
        "type": "object",
        "properties": {
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "RelationPropertyFilter": {
        "type": "object",
        "properties": {
          "contains": {
            "type": "string"
          },
          "does_not_contain": {
            "type": "string"
          },
          "is_empty": {
            "type": "boolean"
          },
          "is_not_empty": {
            "type": "boolean"
          }
        }
      },
      "CompoundFilter": {
        "type": "object",
        "properties": {
          "and": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyFilter"
            }
          },
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PropertyFilter"
            }
          }
        }
      },
      "BlockObjectRequest": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["paragraph"]
              },
              "paragraph": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "paragraph"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_1"]
              },
              "heading_1": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_1"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_2"]
              },
              "heading_2": {
                "type": "object",

                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_2"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["heading_3"]
              },
              "heading_3": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "heading_3"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["bulleted_list_item"]
              },
              "bulleted_list_item": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "bulleted_list_item"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["numbered_list_item"]
              },
              "numbered_list_item": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "numbered_list_item"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["to_do"]
              },
              "to_do": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "checked": {
                    "type": "boolean"
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text", "checked"]
              }
            },
            "required": ["object", "type", "to_do"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["toggle"]
              },
              "toggle": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "color": {
                    "type": "string"
                  }
                },
                "required": ["rich_text"]
              }
            },
            "required": ["object", "type", "toggle"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["code"]
              },
              "code": {
                "type": "object",
                "properties": {
                  "rich_text": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  },
                  "language": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["rich_text", "language"]
              }
            },
            "required": ["object", "type", "code"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["child_page"]
              },
              "child_page": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  }
                },
                "required": ["title"]
              }
            },
            "required": ["object", "type", "child_page"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["child_database"]
              },
              "child_database": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  }
                },
                "required": ["title"]
              }
            },
            "required": ["object", "type", "child_database"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["embed"]
              },
              "embed": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["object", "type", "embed"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["image"]
              },
              "image": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "image"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["video"]
              },
              "video": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "video"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["file"]
              },
              "file": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "file"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["pdf"]
              },
              "pdf": {
                "type": "object",
                "properties": {
                  "external": {
                    "type": "object",
                    "properties": {
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": ["url"]
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["external"]
              }
            },
            "required": ["object", "type", "pdf"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["bookmark"]
              },
              "bookmark": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "caption": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest"
                    }
                  }
                },
                "required": ["url"]
              }
            },
            "required": ["object", "type", "bookmark"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["equation"]
              },
              "equation": {
                "type": "object",
                "properties": {
                  "expression": {
                    "type": "string"
                  }
                },
                "required": ["expression"]
              }
            },
            "required": ["object", "type", "equation"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["divider"]
              },
              "divider": {
                "type": "object"
              }
            },
            "required": ["object", "type", "divider"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table_of_contents"]
              },
              "table_of_contents": {
                "type": "object",
                "properties": {
                  "color": {
                    "type": "string"
                  }
                }
              }
            },
            "required": ["object", "type", "table_of_contents"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["column_list"]
              },
              "column_list": {
                "type": "object"
              }
            },
            "required": ["object", "type", "column_list"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["column"]
              },
              "column": {
                "type": "object"
              }
            },
            "required": ["object", "type", "column"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["link_to_page"]
              },
              "link_to_page": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": ["page_id"]
                      },
                      "page_id": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "page_id"]
                  },
                  {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": ["database_id"]
                      },
                      "database_id": {
                        "type": "string"
                      }
                    },
                    "required": ["type", "database_id"]
                  }
                ]
              }
            },
            "required": ["object", "type", "link_to_page"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table"]
              },
              "table": {
                "type": "object",
                "properties": {
                  "table_width": {
                    "type": "integer"
                  },
                  "has_column_header": {
                    "type": "boolean"
                  },
                  "has_row_header": {
                    "type": "boolean"
                  },
                  "children": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest"
                    }
                  }
                },
                "required": ["table_width", "children"]
              }
            },
            "required": ["object", "type", "table"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["table_row"]
              },
              "table_row": {
                "type": "object",
                "properties": {
                  "cells": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest"
                      }
                    }
                  }
                },
                "required": ["cells"]
              }
            },
            "required": ["object", "type", "table_row"]
          },
          {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "enum": ["block"]
              },
              "type": {
                "type": "string",
                "enum": ["synced_block"]
              },
              "synced_block": {
                "type": "object",
                "properties": {
                  "synced_from": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": ["block_id"]
                          },
                          "block_id": {
                            "type": "string"
                          }
                        },
                        "required": ["type", "block_id"]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "children": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest"
                    }
                  }
                }
              }
            },
            "required": ["object", "type", "synced_block"]
          }
        ]
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/fixtures/open-meteo.yaml
================================================
openapi: 3.0.0
info:
  title: Open-Meteo APIs
  description: 'Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.'
  version: '1.0'
  contact:
    name: Open-Meteo
    url: https://open-meteo.com
    email: info@open-meteo.com
  license:
    name: Attribution 4.0 International (CC BY 4.0)
    url: https://creativecommons.org/licenses/by/4.0/
  termsOfService: https://open-meteo.com/en/features#terms
paths:
  /v1/forecast:
    servers:
      - url: https://api.open-meteo.com
    get:
      tags:
        - Weather Forecast APIs
      summary: 7 day weather forecast for coordinates
      description: 7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.
      parameters:
        - name: hourly
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - temperature_2m
                - relative_humidity_2m
                - dew_point_2m
                - apparent_temperature
                - pressure_msl
                - cloud_cover
                - cloud_cover_low
                - cloud_cover_mid
                - cloud_cover_high
                - wind_speed_10m
                - wind_speed_80m
                - wind_speed_120m
                - wind_speed_180m
                - wind_direction_10m
                - wind_direction_80m
                - wind_direction_120m
                - wind_direction_180m
                - wind_gusts_10m
                - shortwave_radiation
                - direct_radiation
                - direct_normal_irradiance
                - diffuse_radiation
                - vapour_pressure_deficit
                - evapotranspiration
                - precipitation
                - weather_code
                - snow_height
                - freezing_level_height
                - soil_temperature_0cm
                - soil_temperature_6cm
                - soil_temperature_18cm
                - soil_temperature_54cm
                - soil_moisture_0_1cm
                - soil_moisture_1_3cm
                - soil_moisture_3_9cm
                - soil_moisture_9_27cm
                - soil_moisture_27_81cm
        - name: daily
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - temperature_2m_max
                - temperature_2m_min
                - apparent_temperature_max
                - apparent_temperature_min
                - precipitation_sum
                - precipitation_hours
                - weather_code
                - sunrise
                - sunset
                - wind_speed_10m_max
                - wind_gusts_10m_max
                - wind_direction_10m_dominant
                - shortwave_radiation_sum
                - uv_index_max
                - uv_index_clear_sky_max
                - et0_fao_evapotranspiration
        - name: latitude
          in: query
          required: true
          description: 'WGS84 coordinate'
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          required: true
          description: 'WGS84 coordinate'
          schema:
            type: number
            format: double
        - name: current_weather
          in: query
          schema:
            type: boolean
        - name: temperature_unit
          in: query
          schema:
            type: string
            default: celsius
            enum:
              - celsius
              - fahrenheit
        - name: wind_speed_unit
          in: query
          schema:
            type: string
            default: kmh
            enum:
              - kmh
              - ms
              - mph
              - kn
        - name: timeformat
          in: query
          description: If format `unixtime` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply `utc_offset_seconds` again to get the correct date.
          schema:
            type: string
            default: iso8601
            enum:
              - iso8601
              - unixtime
        - name: timezone
          in: query
          description: If `timezone` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.
          schema:
            type: string
        - name: past_days
          in: query
          description: If `past_days` is set, yesterdays or the day before yesterdays data are also returned.
          schema:
            type: integer
            enum:
              - 1
              - 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  latitude:
                    type: number
                    example: 52.52
                    description: WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.
                  longitude:
                    type: number
                    example: 13.419.52
                    description: WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.
                  elevation:
                    type: number
                    example: 44.812
                    description: The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.
                  generationtime_ms:
                    type: number
                    example: 2.2119
                    description: Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.
                  utc_offset_seconds:
                    type: integer
                    example: 3600
                    description: Applied timezone offset from the &timezone= parameter.
                  hourly:
                    $ref: '#/components/schemas/HourlyResponse'
                  hourly_units:
                    type: object
                    additionalProperties:
                      type: string
                    description: For each selected weather variable, the unit will be listed here.
                  daily:
                    $ref: '#/components/schemas/DailyResponse'
                  daily_units:
                    type: object
                    additionalProperties:
                      type: string
                    description: For each selected daily weather variable, the unit will be listed here.
                  current_weather:
                    $ref: '#/components/schemas/CurrentWeather'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    description: Always set true for errors
                  reason:
                    type: string
                    description: Description of the error
                    example: 'Latitude must be in range of -90 to 90°. Given: 300'
components:
  schemas:
    HourlyResponse:
      type: object
      description: For each selected weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.
      required:
        - time
      properties:
        time:
          type: array
          items:
            type: string
        temperature_2m:
          type: array
          items:
            type: number
        relative_humidity_2m:
          type: array
          items:
            type: number
        dew_point_2m:
          type: array
          items:
            type: number
        apparent_temperature:
          type: array
          items:
            type: number
        pressure_msl:
          type: array
          items:
            type: number
        cloud_cover:
          type: array
          items:
            type: number
        cloud_cover_low:
          type: array
          items:
            type: number
        cloud_cover_mid:
          type: array
          items:
            type: number
        cloud_cover_high:
          type: array
          items:
            type: number
        wind_speed_10m:
          type: array
          items:
            type: number
        wind_speed_80m:
          type: array
          items:
            type: number
        wind_speed_120m:
          type: array
          items:
            type: number
        wind_speed_180m:
          type: array
          items:
            type: number
        wind_direction_10m:
          type: array
          items:
            type: number
        wind_direction_80m:
          type: array
          items:
            type: number
        wind_direction_120m:
          type: array
          items:
            type: number
        wind_direction_180m:
          type: array
          items:
            type: number
        wind_gusts_10m:
          type: array
          items:
            type: number
        shortwave_radiation:
          type: array
          items:
            type: number
        direct_radiation:
          type: array
          items:
            type: number
        direct_normal_irradiance:
          type: array
          items:
            type: number
        diffuse_radiation:
          type: array
          items:
            type: number
        vapour_pressure_deficit:
          type: array
          items:
            type: number
        evapotranspiration:
          type: array
          items:
            type: number
        precipitation:
          type: array
          items:
            type: number
        weather_code:
          type: array
          items:
            type: number
        snow_height:
          type: array
          items:
            type: number
        freezing_level_height:
          type: array
          items:
            type: number
        soil_temperature_0cm:
          type: array
          items:
            type: number
        soil_temperature_6cm:
          type: array
          items:
            type: number
        soil_temperature_18cm:
          type: array
          items:
            type: number
        soil_temperature_54cm:
          type: array
          items:
            type: number
        soil_moisture_0_1cm:
          type: array
          items:
            type: number
        soil_moisture_1_3cm:
          type: array
          items:
            type: number
        soil_moisture_3_9cm:
          type: array
          items:
            type: number
        soil_moisture_9_27cm:
          type: array
          items:
            type: number
        soil_moisture_27_81cm:
          type: array
          items:
            type: number
    DailyResponse:
      type: object
      description: For each selected daily weather variable, data will be returned as a floating point array. Additionally a `time` array will be returned with ISO8601 timestamps.
      properties:
        time:
          type: array
          items:
            type: string
        temperature_2m_max:
          type: array
          items:
            type: number
        temperature_2m_min:
          type: array
          items:
            type: number
        apparent_temperature_max:
          type: array
          items:
            type: number
        apparent_temperature_min:
          type: array
          items:
            type: number
        precipitation_sum:
          type: array
          items:
            type: number
        precipitation_hours:
          type: array
          items:
            type: number
        weather_code:
          type: array
          items:
            type: number
        sunrise:
          type: array
          items:
            type: number
        sunset:
          type: array
          items:
            type: number
        wind_speed_10m_max:
          type: array
          items:
            type: number
        wind_gusts_10m_max:
          type: array
          items:
            type: number
        wind_direction_10m_dominant:
          type: array
          items:
            type: number
        shortwave_radiation_sum:
          type: array
          items:
            type: number
        uv_index_max:
          type: array
          items:
            type: number
        uv_index_clear_sky_max:
          type: array
          items:
            type: number
        et0_fao_evapotranspiration:
          type: array
          items:
            type: number
      required:
        - time
    CurrentWeather:
      type: object
      description: 'Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code'
      properties:
        time:
          type: string
        temperature:
          type: number
        wind_speed:
          type: number
        wind_direction:
          type: number
        weather_code:
          type: integer
      required:
        - time
        - temperature
        - wind_speed
        - wind_direction
        - weather_code


================================================
FILE: packages/openapi-utils/fixtures/pet-store.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger Petstore",
    "license": {
      "name": "MIT"
    }
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1"
    }
  ],
  "paths": {
    "/pets": {
      "get": {
        "summary": "List all pets",
        "operationId": "listPets",
        "tags": ["pets"],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "How many items to return at one time (max 100)",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A paged array of pets",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pets"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a pet",
        "operationId": "createPets",
        "tags": ["pets"],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Pet"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Null response"
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/pets/{petId}": {
      "get": {
        "summary": "Info for a specific pet",
        "operationId": "showPetById",
        "tags": ["pets"],
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "required": true,
            "description": "The id of the pet to retrieve",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Expected response to a valid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Pet": {
        "type": "object",
        "required": ["id", "name"],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        }
      },
      "Pets": {
        "type": "array",
        "maxItems": 100,
        "items": {
          "$ref": "#/components/schemas/Pet"
        }
      },
      "Error": {
        "type": "object",
        "required": ["code", "message"],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/fixtures/petstore-expanded.json
================================================
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger Petstore",
    "description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "name": "Swagger API Team",
      "email": "apiteam@swagger.io",
      "url": "http://swagger.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/api"
    }
  ],
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
        "operationId": "findPets",
        "parameters": [
          {
            "name": "tags",
            "in": "query",
            "description": "tags to filter by",
            "required": false,
            "style": "form",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "maximum number of results to return",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed",
        "operationId": "addPet",
        "requestBody": {
          "description": "Pet to add to the store",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPet"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/pets/{id}": {
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
        "operationId": "find pet by id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of pet to fetch",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "pet response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "delete": {
        "description": "deletes a single pet based on the ID supplied",
        "operationId": "deletePet",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of pet to delete",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "pet deleted"
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Pet": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewPet"
          },
          {
            "type": "object",
            "required": ["id"],
            "properties": {
              "id": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ]
      },
      "NewPet": {
        "type": "object",
        "required": ["name"],
        "properties": {
          "name": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": ["code", "message"],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/fixtures/readme.json
================================================
{
  "openapi": "3.0.2",
  "info": {
    "description": "Create beautiful product and API documentation with our developer friendly platform.",
    "version": "4.355.0",
    "title": "ReadMe API 🦉",
    "contact": {
      "name": "API Support",
      "url": "https://docs.readme.com/main/docs/need-more-support",
      "email": "support@readme.io"
    }
  },
  "servers": [
    {
      "url": "https://dash.readme.com/api/v1"
    }
  ],
  "tags": [
    {
      "name": "API Registry"
    },
    {
      "name": "API Specification"
    },
    {
      "name": "Apply to ReadMe"
    },
    {
      "name": "Categories"
    },
    {
      "name": "Changelog"
    },
    {
      "name": "Custom Pages"
    },
    {
      "name": "Docs"
    },
    {
      "name": "Errors"
    },
    {
      "name": "Projects"
    },
    {
      "name": "Version"
    }
  ],
  "paths": {
    "/api-registry/{uuid}": {
      "get": {
        "operationId": "getAPIRegistry",
        "summary": "Retrieve an entry from the API Registry",
        "description": "Get an API definition file that's been uploaded to ReadMe.",
        "tags": ["API Registry"],
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "An API Registry UUID. This can be found by navigating to your API Reference page and viewing code snippets for Node with the `api` library.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved API registry entry.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/error_REGISTRY_NOTFOUND"
          }
        }
      }
    },
    "/api-specification": {
      "get": {
        "operationId": "getAPISpecification",
        "summary": "Get metadata",
        "description": "Get API specification metadata.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved API specification metadata.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_EMPTY"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "uploadAPISpecification",
        "summary": "Upload specification",
        "description": "Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/main/docs/rdme.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "spec": {
                    "description": "OpenAPI/Swagger file. We accept JSON or YAML.",
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The API specification was successfully uploaded."
          },
          "400": {
            "description": "There was a validation error during upload.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "408": {
            "$ref": "#/components/responses/error_SPEC_TIMEOUT"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/api-specification/{id}": {
      "put": {
        "operationId": "updateAPISpecification",
        "summary": "Update specification",
        "description": "Update an API specification in ReadMe.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "spec": {
                    "description": "OpenAPI/Swagger file. We accept JSON or YAML.",
                    "type": "string",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The API specification was updated."
          },
          "400": {
            "description": "There was a validation error during upload.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_ID_DUPLICATE"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_ID_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
                    },
                    {
                      "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "description": "There is no API specification with that ID."
          },
          "408": {
            "$ref": "#/components/responses/error_SPEC_TIMEOUT"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteAPISpecification",
        "summary": "Delete specification",
        "description": "Delete an API specification in ReadMe.",
        "tags": ["API Specification"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "The API specification was deleted."
          },
          "400": {
            "$ref": "#/components/responses/error_SPEC_ID_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_SPEC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/apply": {
      "get": {
        "operationId": "getOpenRoles",
        "summary": "Get open roles",
        "description": "Returns all the roles we're hiring for at ReadMe!",
        "tags": ["Apply to ReadMe"],
        "responses": {
          "200": {
            "description": "All the roles that we're hiring for.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/jobOpening"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "applyToReadMe",
        "summary": "Submit your application!",
        "description": "This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI!",
        "tags": ["Apply to ReadMe"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/apply"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "You did it!"
          }
        }
      }
    },
    "/categories": {
      "get": {
        "operationId": "getCategories",
        "summary": "Get all categories",
        "description": "Returns all the categories for a specified version.",
        "tags": ["Categories"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of categories.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createCategory",
        "summary": "Create category",
        "description": "Create a new category inside of this project.",
        "tags": ["Categories"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/category"
                  },
                  {
                    "required": ["title"]
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The category has successfully been created."
          },
          "400": {
            "$ref": "#/components/responses/error_CATEGORY_INVALID"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/categories/{slug}": {
      "get": {
        "operationId": "getCategory",
        "summary": "Get category",
        "description": "Returns the category with this slug.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The category exists and has been returned."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateCategory",
        "summary": "Update category",
        "description": "Change the properties of a category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/category"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The category was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_CATEGORY_INVALID"
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteCategory",
        "summary": "Delete category",
        "description": "Delete the category with this slug.\n>⚠️Heads Up!\n> This will also delete all of the docs within this category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "204": {
            "description": "The category was deleted."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/categories/{slug}/docs": {
      "get": {
        "operationId": "getCategoryDocs",
        "summary": "Get docs for category",
        "description": "Returns the docs and children docs within this category.",
        "tags": ["Categories"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".",
            "example": "getting-started",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The category exists and all of the docs have been returned."
          },
          "404": {
            "$ref": "#/components/responses/error_CATEGORY_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/changelogs": {
      "get": {
        "operationId": "getChangelogs",
        "summary": "Get changelogs",
        "description": "Returns a list of changelogs.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of changelogs.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createChangelog",
        "summary": "Create changelog",
        "description": "Create a new changelog entry.",
        "tags": ["Changelog"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/changelog"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The changelog was successfully created."
          },
          "400": {
            "description": "There was a validation error during creation."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/changelogs/{slug}": {
      "get": {
        "operationId": "getChangelog",
        "summary": "Get changelog",
        "description": "Returns the changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Update\", enter the slug \"owlet-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The changelog exists and has been returned."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateChangelog",
        "summary": "Update changelog",
        "description": "Update a changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/changelog"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The changelog was successfully updated."
          },
          "400": {
            "description": "There was a validation error during update."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteChangelog",
        "summary": "Delete changelog",
        "description": "Delete the changelog with this slug.",
        "tags": ["Changelog"],
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The changelog was successfully updated."
          },
          "404": {
            "description": "There is no changelog with that slug."
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/custompages": {
      "get": {
        "operationId": "getCustomPages",
        "summary": "Get custom pages",
        "description": "Returns a list of custom pages.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of custom pages.",
            "headers": {
              "Link": {
                "$ref": "#/components/headers/link"
              },
              "x-total-count": {
                "$ref": "#/components/headers/x-total-count"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createCustomPage",
        "summary": "Create custom page",
        "description": "Create a new custom page inside of this project.",
        "tags": ["Custom Pages"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customPage"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The custom page was successfully created."
          },
          "400": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/custompages/{slug}": {
      "get": {
        "operationId": "getCustomPage",
        "summary": "Get custom page",
        "description": "Returns the custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "responses": {
          "200": {
            "description": "The custom page exists and has been returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateCustomPage",
        "summary": "Update custom page",
        "description": "Update a custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/customPage"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The custom page was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteCustomPage",
        "summary": "Delete custom page",
        "description": "Delete the custom page with this slug.",
        "tags": ["Custom Pages"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          }
        ],
        "responses": {
          "204": {
            "description": "The custom page was successfully updated."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_CUSTOMPAGE_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/{slug}": {
      "get": {
        "operationId": "getDoc",
        "summary": "Get doc",
        "description": "Returns the doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The doc exists and has been returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateDoc",
        "summary": "Update doc",
        "description": "Update a doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/docSchemaPut"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The doc was successfully updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_DOC_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteDoc",
        "summary": "Delete doc",
        "description": "Delete the doc with this slug.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "204": {
            "description": "The doc was successfully updated."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/{slug}/production": {
      "get": {
        "operationId": "getProductionDoc",
        "summary": "Get production doc",
        "description": "This is intended for use by enterprise users with staging enabled. This endpoint will return the live version of your document, whereas the standard endpoint will always return staging.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/slug"
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The doc exists and has been returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_DOC_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs": {
      "post": {
        "operationId": "createDoc",
        "summary": "Create doc",
        "description": "Create a new doc inside of this project.",
        "tags": ["Docs"],
        "parameters": [
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/docSchemaPost"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The doc was successfully created.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/docSchemaResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/error_DOC_INVALID"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/docs/search": {
      "post": {
        "operationId": "searchDocs",
        "summary": "Search docs",
        "description": "Returns all docs that match the search.",
        "tags": ["Docs"],
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "description": "Search string to look for.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/x-readme-version"
          }
        ],
        "responses": {
          "200": {
            "description": "The search was successful and results were returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/": {
      "get": {
        "operationId": "getProject",
        "summary": "Get metadata about the current project",
        "description": "Returns project data for the API key.",
        "tags": ["Projects"],
        "responses": {
          "200": {
            "description": "Project data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/condensedProjectData"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/schema": {
      "get": {
        "operationId": "getAPISchema",
        "summary": "Get our OpenAPI Definition",
        "description": "Returns a copy of our OpenAPI Definition.",
        "tags": ["API Specification"],
        "responses": {
          "200": {
            "description": "OpenAPI Definition data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/version": {
      "get": {
        "operationId": "getVersions",
        "summary": "Get versions",
        "description": "Retrieve a list of versions associated with a project API key.",
        "tags": ["Version"],
        "responses": {
          "200": {
            "description": "A list of versions."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "post": {
        "operationId": "createVersion",
        "summary": "Create version",
        "description": "Create a new version.",
        "tags": ["Version"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/version"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The version was successfully created."
          },
          "400": {
            "description": "There was a validation error during creation.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/error_VERSION_EMPTY"
                    },
                    {
                      "$ref": "#/components/schemas/error_VERSION_DUPLICATE"
                    },
                    {
                      "$ref": "#/components/schemas/error_VERSION_FORK_EMPTY"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_FORK_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    },
    "/version/{versionId}": {
      "get": {
        "operationId": "getVersion",
        "summary": "Get version",
        "description": "Returns the version with this version ID.",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The version exists and has been returned."
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "put": {
        "operationId": "updateVersion",
        "summary": "Update version",
        "description": "Update an existing version.",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/version"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The version was successfully updated."
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_CANT_DEMOTE_STABLE"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      },
      "delete": {
        "operationId": "deleteVersion",
        "summary": "Delete version",
        "description": "Delete a version",
        "tags": ["Version"],
        "parameters": [
          {
            "$ref": "#/components/parameters/versionId"
          }
        ],
        "responses": {
          "200": {
            "description": "The version was successfully deleted."
          },
          "400": {
            "$ref": "#/components/responses/error_VERSION_CANT_REMOVE_STABLE"
          },
          "401": {
            "$ref": "#/components/responses/authUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/authForbidden"
          },
          "404": {
            "$ref": "#/components/responses/error_VERSION_NOTFOUND"
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "headers": {
      "link": {
        "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.",
        "schema": {
          "type": "string"
        }
      },
      "x-total-count": {
        "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.",
        "schema": {
          "type": "string"
        }
      }
    },
    "parameters": {
      "slug": {
        "name": "slug",
        "in": "path",
        "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "description": "Used to specify further pages (starts at 1).",
        "schema": {
          "type": "integer",
          "default": 1,
          "minimum": 1
        }
      },
      "perPage": {
        "name": "perPage",
        "in": "query",
        "description": "Number of items to include in pagination (up to 100, defaults to 10).",
        "schema": {
          "type": "integer",
          "default": 10,
          "minimum": 1,
          "maximum": 100
        }
      },
      "x-readme-version": {
        "in": "header",
        "name": "x-readme-version",
        "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.",
        "example": "v3.0",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "versionId": {
        "name": "versionId",
        "in": "path",
        "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).",
        "example": "v1.0.0",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "authForbidden": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/error_APIKEY_MISMATCH"
                }
              ]
            }
          }
        }
      },
      "authUnauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/error_APIKEY_EMPTY"
                },
                {
                  "$ref": "#/components/schemas/error_APIKEY_NOTFOUND"
                }
              ]
            }
          }
        }
      },
      "error_APIKEY_EMPTY": {
        "description": "An API key was not supplied.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_EMPTY"
            }
          }
        }
      },
      "error_APIKEY_MISMATCH": {
        "description": "The API key doesn't match the project.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_MISMATCH"
            }
          }
        }
      },
      "error_APIKEY_NOTFOUND": {
        "description": "The API key couldn't be located.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APIKEY_NOTFOUND"
            }
          }
        }
      },
      "error_APPLY_INVALID_EMAIL": {
        "description": "You need to provide a valid email.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_EMAIL"
            }
          }
        }
      },
      "error_APPLY_INVALID_JOB": {
        "description": "You need to provide a job.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_JOB"
            }
          }
        }
      },
      "error_APPLY_INVALID_NAME": {
        "description": "You need to provide a name.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_APPLY_INVALID_NAME"
            }
          }
        }
      },
      "error_CATEGORY_INVALID": {
        "description": "The category couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CATEGORY_INVALID"
            }
          }
        }
      },
      "error_CATEGORY_NOTFOUND": {
        "description": "The category couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CATEGORY_NOTFOUND"
            }
          }
        }
      },
      "error_CHANGELOG_INVALID": {
        "description": "The changelog couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CHANGELOG_INVALID"
            }
          }
        }
      },
      "error_CHANGELOG_NOTFOUND": {
        "description": "The changelog couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CHANGELOG_NOTFOUND"
            }
          }
        }
      },
      "error_CUSTOMPAGE_INVALID": {
        "description": "The page couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CUSTOMPAGE_INVALID"
            }
          }
        }
      },
      "error_CUSTOMPAGE_NOTFOUND": {
        "description": "The custom page couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_CUSTOMPAGE_NOTFOUND"
            }
          }
        }
      },
      "error_DOC_INVALID": {
        "description": "The doc couldn't be saved.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_DOC_INVALID"
            }
          }
        }
      },
      "error_DOC_NOTFOUND": {
        "description": "The doc couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_DOC_NOTFOUND"
            }
          }
        }
      },
      "error_ENDPOINT_NOTFOUND": {
        "description": "The endpoint doesn't exist.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_ENDPOINT_NOTFOUND"
            }
          }
        }
      },
      "error_INTERNAL_ERROR": {
        "description": "An unknown error has occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_INTERNAL_ERROR"
            }
          }
        }
      },
      "error_PROJECT_NEEDSSTAGING": {
        "description": "The project does not have staging enabled.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_PROJECT_NEEDSSTAGING"
            }
          }
        }
      },
      "error_PROJECT_NOTFOUND": {
        "description": "The project couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_PROJECT_NOTFOUND"
            }
          }
        }
      },
      "error_RATE_LIMITED": {
        "description": "The request has been rate limited.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_RATE_LIMITED"
            }
          }
        }
      },
      "error_REGISTRY_INVALID": {
        "description": "The registry entry couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_REGISTRY_INVALID"
            }
          }
        }
      },
      "error_REGISTRY_NOTFOUND": {
        "description": "The registry entry couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_REGISTRY_NOTFOUND"
            }
          }
        }
      },
      "error_SPEC_FILE_EMPTY": {
        "description": "A spec file wasn't included.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_FILE_EMPTY"
            }
          }
        }
      },
      "error_SPEC_ID_DUPLICATE": {
        "description": "The spec ID already tied to another version.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_ID_DUPLICATE"
            }
          }
        }
      },
      "error_SPEC_ID_INVALID": {
        "description": "The spec ID isn't valid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_ID_INVALID"
            }
          }
        }
      },
      "error_SPEC_INVALID": {
        "description": "The uploaded spec isn't valid JSON or YAML.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_INVALID"
            }
          }
        }
      },
      "error_SPEC_INVALID_SCHEMA": {
        "description": "The uploaded spec has OpenAPI validation errors.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_INVALID_SCHEMA"
            }
          }
        }
      },
      "error_SPEC_NOTFOUND": {
        "description": "The spec couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_NOTFOUND"
            }
          }
        }
      },
      "error_SPEC_TIMEOUT": {
        "description": "The spec upload timed out.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_TIMEOUT"
            }
          }
        }
      },
      "error_SPEC_VERSION_NOTFOUND": {
        "description": "The spec version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_SPEC_VERSION_NOTFOUND"
            }
          }
        }
      },
      "error_UNEXPECTED_ERROR": {
        "description": "An unknown error has occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_UNEXPECTED_ERROR"
            }
          }
        }
      },
      "error_VERSION_CANT_DEMOTE_STABLE": {
        "description": "A stable version can't be demoted.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_CANT_DEMOTE_STABLE"
            }
          }
        }
      },
      "error_VERSION_CANT_REMOVE_STABLE": {
        "description": "A stable version can't be removed.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_CANT_REMOVE_STABLE"
            }
          }
        }
      },
      "error_VERSION_DUPLICATE": {
        "description": "The version already exists.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_DUPLICATE"
            }
          }
        }
      },
      "error_VERSION_EMPTY": {
        "description": "No version was supplied.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_EMPTY"
            }
          }
        }
      },
      "error_VERSION_FORK_EMPTY": {
        "description": "New versions need to be forked from an existing version.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_FORK_EMPTY"
            }
          }
        }
      },
      "error_VERSION_FORK_NOTFOUND": {
        "description": "The version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_FORK_NOTFOUND"
            }
          }
        }
      },
      "error_VERSION_INVALID": {
        "description": "The version is invalid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_INVALID"
            }
          }
        }
      },
      "error_VERSION_NOTFOUND": {
        "description": "The version couldn't be found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/error_VERSION_NOTFOUND"
            }
          }
        }
      }
    },
    "schemas": {
      "baseError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "An error code unique to the error received."
          },
          "message": {
            "type": "string",
            "description": "The reason why the error occured."
          },
          "suggestion": {
            "type": "string",
            "description": "A helpful suggestion for how to alleviate the error."
          },
          "docs": {
            "type": "string",
            "format": "url",
            "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.",
            "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"
          },
          "help": {
            "type": "string",
            "description": "Information on where you can receive additional assistance from our wonderful support team.",
            "example": "If you need help, email support@readme.io"
          },
          "poem": {
            "type": "array",
            "description": "A short poem we wrote you about your error.",
            "items": {
              "type": "string"
            },
            "example": [
              "If you're seeing this error,",
              "Things didn't quite go the way we hoped.",
              "When we tried to process your request,",
              "Maybe trying again it'll work—who knows!"
            ]
          }
        }
      },
      "apply": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Your full name",
            "default": "Your Name"
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "A valid email we can reach you at.",
            "default": "you@example.com"
          },
          "job": {
            "type": "string",
            "description": "The job you're looking to apply for (https://readme.com/careers).",
            "enum": [
              "Front End Engineer",
              "Full Stack Engineer",
              "Head of Product",
              "Head of Solutions Engineering",
              "Product Designer"
            ],
            "default": "Front End Engineer"
          },
          "pronouns": {
            "type": "string",
            "description": "Learn more at https://lgbtlifecenter.org/pronouns/"
          },
          "linkedin": {
            "type": "string",
            "format": "url",
            "description": "What have you been up to the past few years?"
          },
          "github": {
            "type": "string",
            "description": "Or Bitbucket, Gitlab or anywhere else your code is hosted!",
            "format": "url"
          },
          "coverLetter": {
            "type": "string",
            "format": "blob",
            "description": "What should we know about you?"
          },
          "dontReallyApply": {
            "type": "boolean",
            "description": "Want to play with the API but not actually apply? Set this to true.",
            "default": false
          }
        },
        "required": ["name", "email", "job"]
      },
      "category": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "A short title for the category. This is what will show in the sidebar."
          },
          "type": {
            "type": "string",
            "enum": ["reference", "guide"],
            "default": "guide",
            "description": "A category can be part of your reference or guide documentation, which is determined by this field."
          }
        }
      },
      "changelog": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the changelog."
          },
          "type": {
            "type": "string",
            "default": "",
            "enum": ["", "added", "fixed", "improved", "deprecated", "removed"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the changelog."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the changelog.",
            "default": true
          }
        },
        "required": ["title", "body"]
      },
      "condensedProjectData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "subdomain": {
            "type": "string"
          },
          "jwtSecret": {
            "type": "string"
          },
          "baseUrl": {
            "type": "string",
            "format": "url",
            "description": "The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`."
          },
          "plan": {
            "type": "string"
          }
        }
      },
      "customPage": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the custom page."
          },
          "body": {
            "type": "string",
            "description": "Body formatted in Markdown (displayed by default)."
          },
          "html": {
            "type": "string",
            "description": "Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)."
          },
          "htmlmode": {
            "type": "boolean",
            "description": "**true** if `html` should be displayed, **false** if `body` should be displayed.",
            "default": false
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the custom page.",
            "default": true
          }
        },
        "required": ["title"]
      },
      "docSchemaPost": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          },
          "categorySlug": {
            "type": "string",
            "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."
          },
          "parentDocSlug": {
            "type": "string",
            "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."
          }
        },
        "oneOf": [
          {
            "required": ["title", "category"],
            "title": "`category` Parameter"
          },
          {
            "required": ["title", "categorySlug"],
            "title": "`categorySlug` Parameter"
          }
        ],
        "additionalProperties": true
      },
      "docSchemaPut": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          },
          "categorySlug": {
            "type": "string",
            "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."
          },
          "parentDocSlug": {
            "type": "string",
            "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."
          }
        },
        "additionalProperties": true
      },
      "docSchemaResponse": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the page."
          },
          "type": {
            "type": "string",
            "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).",
            "enum": ["basic", "error", "link"]
          },
          "body": {
            "type": "string",
            "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."
          },
          "category": {
            "type": "string",
            "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."
          },
          "hidden": {
            "type": "boolean",
            "description": "Visibility of the page."
          },
          "order": {
            "type": "integer",
            "description": "The position of the page in your project sidebar.",
            "example": 999
          },
          "parentDoc": {
            "type": "string",
            "description": "The parent doc's ID, if the page is a subpage."
          },
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "The error code for docs with the \"error\" type."
              }
            }
          }
        },
        "additionalProperties": true
      },
      "version": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "description": "Semantic Version"
          },
          "codename": {
            "type": "string",
            "description": "Dubbed name of version."
          },
          "from": {
            "type": "string",
            "description": "Semantic Version to use as the base fork."
          },
          "is_stable": {
            "type": "boolean",
            "description": "Should this be the **main** version?"
          },
          "is_beta": {
            "type": "boolean",
            "default": true
          },
          "is_hidden": {
            "type": "boolean",
            "description": "Should this be publically accessible?"
          },
          "is_deprecated": {
            "type": "boolean",
            "description": "Should this be deprecated? Only allowed in PUT operations."
          }
        },
        "required": ["version", "from"]
      },
      "jobOpening": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "description": "A slugified version of the job opening title.",
            "example": "api-engineer"
          },
          "title": {
            "type": "string",
            "description": "The job opening position.",
            "example": "API Engineer"
          },
          "description": {
            "type": "string",
            "description": "The description for this open position. This content is formatted as HTML."
          },
          "pullquote": {
            "type": "string",
            "description": "A short pullquote for the open position.",
            "example": "Deeply knowledgeable of the web, HTTP, and the API space."
          },
          "location": {
            "type": "string",
            "description": "Where this position is located at.",
            "example": "Remote"
          },
          "department": {
            "type": "string",
            "description": "The internal organization you'll be working in.",
            "example": "Engineering"
          },
          "url": {
            "type": "string",
            "format": "url",
            "description": "The place where you can apply for the position!"
          }
        }
      },
      "error_APIKEY_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_EMPTY"
              }
            }
          }
        ]
      },
      "error_APIKEY_MISMATCH": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_MISMATCH"
              }
            }
          }
        ]
      },
      "error_APIKEY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APIKEY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_EMAIL": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_EMAIL"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_JOB": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_JOB"
              }
            }
          }
        ]
      },
      "error_APPLY_INVALID_NAME": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "APPLY_INVALID_NAME"
              }
            }
          }
        ]
      },
      "error_CATEGORY_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CATEGORY_INVALID"
              }
            }
          }
        ]
      },
      "error_CATEGORY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CATEGORY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_CHANGELOG_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CHANGELOG_INVALID"
              }
            }
          }
        ]
      },
      "error_CHANGELOG_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CHANGELOG_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_CUSTOMPAGE_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CUSTOMPAGE_INVALID"
              }
            }
          }
        ]
      },
      "error_CUSTOMPAGE_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "CUSTOMPAGE_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_DOC_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "DOC_INVALID"
              }
            }
          }
        ]
      },
      "error_DOC_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "DOC_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_ENDPOINT_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "ENDPOINT_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_INTERNAL_ERROR": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "INTERNAL_ERROR"
              }
            }
          }
        ]
      },
      "error_PROJECT_NEEDSSTAGING": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "PROJECT_NEEDSSTAGING"
              }
            }
          }
        ]
      },
      "error_PROJECT_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "PROJECT_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_RATE_LIMITED": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "RATE_LIMITED"
              }
            }
          }
        ]
      },
      "error_REGISTRY_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "REGISTRY_INVALID"
              }
            }
          }
        ]
      },
      "error_REGISTRY_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "REGISTRY_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_SPEC_FILE_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_FILE_EMPTY"
              }
            }
          }
        ]
      },
      "error_SPEC_ID_DUPLICATE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_ID_DUPLICATE"
              }
            }
          }
        ]
      },
      "error_SPEC_ID_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_ID_INVALID"
              }
            }
          }
        ]
      },
      "error_SPEC_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_INVALID"
              }
            }
          }
        ]
      },
      "error_SPEC_INVALID_SCHEMA": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_INVALID_SCHEMA"
              }
            }
          }
        ]
      },
      "error_SPEC_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_SPEC_TIMEOUT": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_TIMEOUT"
              }
            }
          }
        ]
      },
      "error_SPEC_VERSION_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "SPEC_VERSION_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_UNEXPECTED_ERROR": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "UNEXPECTED_ERROR"
              }
            }
          }
        ]
      },
      "error_VERSION_CANT_DEMOTE_STABLE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_CANT_DEMOTE_STABLE"
              }
            }
          }
        ]
      },
      "error_VERSION_CANT_REMOVE_STABLE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_CANT_REMOVE_STABLE"
              }
            }
          }
        ]
      },
      "error_VERSION_DUPLICATE": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_DUPLICATE"
              }
            }
          }
        ]
      },
      "error_VERSION_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_EMPTY"
              }
            }
          }
        ]
      },
      "error_VERSION_FORK_EMPTY": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_FORK_EMPTY"
              }
            }
          }
        ]
      },
      "error_VERSION_FORK_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_FORK_NOTFOUND"
              }
            }
          }
        ]
      },
      "error_VERSION_INVALID": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_INVALID"
              }
            }
          }
        ]
      },
      "error_VERSION_NOTFOUND": {
        "allOf": [
          {
            "$ref": "#/components/schemas/baseError"
          },
          {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "default": "VERSION_NOTFOUND"
              }
            }
          }
        ]
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/fixtures/security.json
================================================
{
  "openapi": "3.0.3",
  "info": {
    "version": "1.0.0",
    "title": "Support for different security types",
    "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject"
  },
  "servers": [
    {
      "url": "https://httpbin.org"
    }
  ],
  "tags": [
    {
      "name": "API Key"
    },
    {
      "name": "HTTP"
    },
    {
      "name": "OAuth 2"
    },
    {
      "name": "OpenID Connect"
    },
    {
      "name": "Other"
    }
  ],
  "paths": {
    "/anything/apiKey": {
      "get": {
        "summary": "Query parameter",
        "description": "`apiKey` auth will be supplied within an `apiKey` query parameter.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_query": []
          }
        ]
      },
      "post": {
        "summary": "Cookie",
        "description": "`apiKey` auth will be supplied within an `api_key` cookie.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_cookie": []
          }
        ]
      },
      "put": {
        "summary": "Header",
        "description": "`apiKey` auth will be supplied within an `X-API-KEY` header.",
        "tags": ["API Key"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_header": []
          }
        ]
      }
    },
    "/anything/basic": {
      "post": {
        "summary": "Basic",
        "description": "Authentication credentials will be supplied within a `Basic` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "basic": []
          }
        ]
      }
    },
    "/anything/bearer": {
      "post": {
        "summary": "Bearer",
        "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      },
      "put": {
        "summary": "Bearer (`jwt` format)",
        "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header, but its data should be controlled as a JWT.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample\n\n> ℹ️\n> We currently do not support any special handling for this so they're handled as a standard `Bearer` authentication token.",
        "tags": ["HTTP"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "bearer_jwt": []
          }
        ]
      }
    },
    "/anything/oauth2": {
      "post": {
        "summary": "General support (all flow types)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2": ["write:things"]
          }
        ]
      },
      "get": {
        "summary": "General support (authorizationCode flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_authorizationCode": ["write:things"]
          }
        ]
      },
      "put": {
        "summary": "General support (clientCredentials flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_clientCredentials": ["write:things"]
          }
        ]
      },
      "patch": {
        "summary": "General support (implicit flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_implicit": ["write:things"]
          }
        ]
      },
      "delete": {
        "summary": "General support (password flow type)",
        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "tags": ["OAuth 2"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "oauth2_password": ["write:things"]
          }
        ]
      }
    },
    "/anything/openIdConnect": {
      "post": {
        "summary": "General support",
        "description": "🚧 This is not supported.",
        "tags": ["OpenID Connect"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "openIdConnect": []
          }
        ]
      }
    },
    "/anything/no-auth": {
      "post": {
        "summary": "No auth requirements",
        "description": "This operation does not have any authentication requirements.",
        "tags": ["Other"],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/anything/optional-auth": {
      "get": {
        "summary": "Optional auth",
        "description": "The `apiKey` query parameter auth on this operation is optional.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
        "tags": ["Other"],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "apiKey_query": []
          },
          {}
        ]
      }
    },
    "/status/401": {
      "post": {
        "summary": "Forced invalid authentication",
        "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
        "tags": ["Other"],
        "responses": {
          "401": {
            "description": "Unauthorized"
          }
        },
        "security": [
          {
            "apiKey_header": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey_cookie": {
        "type": "apiKey",
        "in": "cookie",
        "name": "api_key",
        "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "apiKey_header": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "apiKey_query": {
        "type": "apiKey",
        "in": "query",
        "name": "apiKey",
        "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
      },
      "basic": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic auth that takes a base64'd combination of `user:password`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
      },
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "description": "A bearer token that will be supplied within an `Authentication` header as `bearer <token>`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
      },
      "bearer_jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "A bearer token that will be supplied within an `Authentication` header as `bearer <token>`. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample"
      },
      "oauth2": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "clientCredentials": {
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "implicit": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account"
            }
          },
          "password": {
            "tokenUrl": "http://example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_authorizationCode": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `authorizationCode` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_clientCredentials": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `clientCredentials` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_implicit": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `implicit` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "implicit": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "oauth2_password": {
        "type": "oauth2",
        "description": "An OAuth 2 security flow that only supports the `password` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "password": {
            "tokenUrl": "http://alt.example.com/oauth/token",
            "scopes": {
              "write:things": "Add things to your account"
            }
          }
        }
      },
      "openIdConnect": {
        "type": "openIdConnect",
        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
        "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23"
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/fixtures/tic-tac-toe.json
================================================
{
  "openapi": "3.1.0",
  "info": {
    "title": "Tic Tac Toe",
    "description": "This API allows writing down marks on a Tic Tac Toe board\nand requesting the state of the board or of individual squares.\n",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "Gameplay"
    }
  ],
  "paths": {
    "/board": {
      "get": {
        "summary": "Get the whole board",
        "description": "Retrieves the current state of the board and the winner.",
        "tags": ["Gameplay"],
        "operationId": "get-board",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status"
                }
              }
            }
          }
        },
        "security": [
          {
            "defaultApiKey": []
          },
          {
            "app2AppOauth": ["board:read"]
          }
        ]
      }
    },
    "/board/{row}/{column}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/rowParam"
        },
        {
          "$ref": "#/components/parameters/columnParam"
        }
      ],
      "get": {
        "summary": "Get a single board square",
        "description": "Retrieves the requested square.",
        "tags": ["Gameplay"],
        "operationId": "get-square",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mark"
                }
              }
            }
          },
          "400": {
            "description": "The provided parameters are incorrect",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/errorMessage"
                },
                "example": "Illegal coordinates"
              }
            }
          }
        },
        "security": [
          {
            "bearerHttpAuthentication": []
          },
          {
            "user2AppOauth": ["board:read"]
          }
        ]
      },
      "put": {
        "summary": "Set a single board square",
        "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
        "tags": ["Gameplay"],
        "operationId": "put-square",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/mark"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status"
                }
              }
            }
          },
          "400": {
            "description": "The provided parameters are incorrect",
            "content": {
              "text/html": {
                "schema": {
                  "$ref": "#/components/schemas/errorMessage"
                },
                "examples": {
                  "illegalCoordinates": {
                    "value": "Illegal coordinates."
                  },
                  "notEmpty": {
                    "value": "Square is not empty."
                  },
                  "invalidMark": {
                    "value": "Invalid Mark (X or O)."
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerHttpAuthentication": []
          },
          {
            "user2AppOauth": ["board:write"]
          }
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "rowParam": {
        "description": "Board row (vertical coordinate)",
        "name": "row",
        "in": "path",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate"
        }
      },
      "columnParam": {
        "description": "Board column (horizontal coordinate)",
        "name": "column",
        "in": "path",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate"
        }
      }
    },
    "schemas": {
      "errorMessage": {
        "type": "string",
        "maxLength": 256,
        "description": "A text message describing an error"
      },
      "coordinate": {
        "type": "integer",
        "minimum": 1,
        "maximum": 3,
        "example": 1
      },
      "mark": {
        "type": "string",
        "enum": [".", "X", "O"],
        "description": "Possible values for a board square. `.` means empty square.",
        "example": "."
      },
      "board": {
        "type": "array",
        "maxItems": 3,
        "minItems": 3,
        "items": {
          "type": "array",
          "maxItems": 3,
          "minItems": 3,
          "items": {
            "$ref": "#/components/schemas/mark"
          }
        }
      },
      "winner": {
        "type": "string",
        "enum": [".", "X", "O"],
        "description": "Winner of the game. `.` means nobody has won yet.",
        "example": "."
      },
      "status": {
        "type": "object",
        "properties": {
          "winner": {
            "$ref": "#/components/schemas/winner"
          },
          "board": {
            "$ref": "#/components/schemas/board"
          }
        }
      }
    },
    "securitySchemes": {
      "defaultApiKey": {
        "description": "API key provided in console",
        "type": "apiKey",
        "name": "api-key",
        "in": "header"
      },
      "basicHttpAuthentication": {
        "description": "Basic HTTP Authentication",
        "type": "http",
        "scheme": "Basic"
      },
      "bearerHttpAuthentication": {
        "description": "Bearer token using a JWT",
        "type": "http",
        "scheme": "Bearer",
        "bearerFormat": "JWT"
      },
      "app2AppOauth": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
            "scopes": {
              "board:read": "Read the board"
            }
          }
        }
      },
      "user2AppOauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://learn.openapis.org/oauth/2.0/auth",
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
            "scopes": {
              "board:read": "Read the board",
              "board:write": "Write to the board"
            }
          }
        }
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/package.json
================================================
{
  "name": "@agentic/platform-openapi-utils",
  "version": "8.4.4",
  "description": "OpenAPI utilities used by the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/openapi-utils"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@apideck/better-ajv-errors": "catalog:",
    "@redocly/openapi-core": "catalog:",
    "ajv": "catalog:",
    "ajv-formats": "catalog:",
    "camelcase": "catalog:",
    "decamelize": "catalog:",
    "fast-uri": "catalog:",
    "plur": "catalog:"
  },
  "devDependencies": {
    "@hono/node-server": "catalog:",
    "hono": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/openapi-utils/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-openapi-utils"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-openapi-utils.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-openapi-utils <!-- omit from toc -->

> OpenAPI utilities used by the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this package directly. See [@agentic/cli](https://github.com/transitive-bullshit/agentic/tree/main/packages/cli), [@agentic/platform](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform), and [@agentic/platform-tool-client](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform-tool-client) for more public-facing packages.

## Install

```bash
npm i @agentic/platform-openapi-utils
```

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/openapi-utils/src/__snapshots__/get-tools-from-openapi-spec.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`getToolsFromOpenAPISpec > basic.json 1`] = `
{
  "toolToOperationMap": {
    "echo": {
      "method": "get",
      "operationId": "echo",
      "parameterSources": {
        "name": "query",
      },
      "path": "/",
      "tags": undefined,
    },
  },
  "tools": [
    {
      "description": "Echo",
      "inputSchema": {
        "properties": {
          "name": {
            "title": "name",
            "type": "string",
          },
        },
        "required": [],
        "type": "object",
      },
      "name": "echo",
      "outputSchema": undefined,
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > firecrawl.json 1`] = `
{
  "toolToOperationMap": {
    "cancel_crawl_job": {
      "method": "delete",
      "operationId": "cancelCrawlJob",
      "parameterSources": {
        "jobId": "path",
      },
      "path": "/crawl/cancel/{jobId}",
      "tags": [
        "Crawl",
      ],
    },
    "crawl_urls": {
      "method": "post",
      "operationId": "crawlUrls",
      "parameterSources": {
        "crawlerOptions": "body",
        "pageOptions": "body",
        "url": "body",
      },
      "path": "/crawl",
      "tags": [
        "Crawling",
      ],
    },
    "get_crawl_status": {
      "method": "get",
      "operationId": "getCrawlStatus",
      "parameterSources": {
        "jobId": "path",
      },
      "path": "/crawl/status/{jobId}",
      "tags": [
        "Crawl",
      ],
    },
    "scrape": {
      "method": "post",
      "operationId": "scrape",
      "parameterSources": {
        "excludeTags": "body",
        "formats": "body",
        "headers": "body",
        "includeTags": "body",
        "onlyMainContent": "body",
        "timeout": "body",
        "url": "body",
        "waitFor": "body",
      },
      "path": "/scrape",
      "tags": [
        "Scraping",
      ],
    },
    "search_google": {
      "method": "post",
      "operationId": "searchGoogle",
      "parameterSources": {
        "pageOptions": "body",
        "query": "body",
        "searchOptions": "body",
      },
      "path": "/search",
      "tags": [
        "Search",
      ],
    },
  },
  "tools": [
    {
      "description": "Scrape a single URL",
      "inputSchema": {
        "properties": {
          "excludeTags": {
            "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "formats": {
            "default": [
              "markdown",
            ],
            "description": "Specific formats to return.

 - markdown: The page in Markdown format.
 - html: The page's HTML, trimmed to include only meaningful content.
 - rawHtml: The page's original HTML.
 - links: The links on the page.
 - screenshot: A screenshot of the top of the page.
 - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
            "items": {
              "enum": [
                "markdown",
                "html",
                "rawHtml",
                "links",
                "screenshot",
                "screenshot@fullPage",
              ],
              "type": "string",
            },
            "type": "array",
          },
          "headers": {
            "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
            "type": "object",
          },
          "includeTags": {
            "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "onlyMainContent": {
            "default": true,
            "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
            "type": "boolean",
          },
          "timeout": {
            "default": 30000,
            "description": "Timeout in milliseconds for the request",
            "type": "integer",
          },
          "url": {
            "description": "The URL to scrape",
            "format": "uri",
            "type": "string",
          },
          "waitFor": {
            "default": 0,
            "description": "Wait x amount of milliseconds for the page to load to fetch content",
            "type": "integer",
          },
        },
        "required": [
          "url",
        ],
        "type": "object",
      },
      "name": "scrape",
      "outputSchema": {
        "properties": {
          "data": {
            "properties": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "object",
          },
          "success": {
            "type": "boolean",
          },
          "warning": {
            "description": "Warning message to let you know of any issues.",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
    },
    {
      "description": "Crawl multiple URLs based on options",
      "inputSchema": {
        "properties": {
          "crawlerOptions": {
            "properties": {
              "allowBackwardCrawling": {
                "default": false,
                "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                "type": "boolean",
              },
              "allowExternalContentLinks": {
                "default": false,
                "description": "Allows the crawler to follow links to external websites.",
                "type": "boolean",
              },
              "excludes": {
                "description": "URL patterns to exclude",
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "generateImgAltText": {
                "default": false,
                "description": "Generate alt text for images using LLMs (must have a paid plan)",
                "type": "boolean",
              },
              "ignoreSitemap": {
                "default": false,
                "description": "Ignore the website sitemap when crawling",
                "type": "boolean",
              },
              "includes": {
                "description": "URL patterns to include",
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "limit": {
                "default": 10000,
                "description": "Maximum number of pages to crawl",
                "type": "integer",
              },
              "maxDepth": {
                "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.",
                "type": "integer",
              },
              "mode": {
                "default": "default",
                "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                "enum": [
                  "default",
                  "fast",
                ],
                "type": "string",
              },
              "returnOnlyUrls": {
                "default": false,
                "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                "type": "boolean",
              },
            },
            "type": "object",
          },
          "pageOptions": {
            "properties": {
              "fullPageScreenshot": {
                "default": false,
                "description": "Include a full page screenshot of the page that you are scraping.",
                "type": "boolean",
              },
              "headers": {
                "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                "type": "object",
              },
              "includeHtml": {
                "default": false,
                "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                "type": "boolean",
              },
              "includeRawHtml": {
                "default": false,
                "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                "type": "boolean",
              },
              "onlyIncludeTags": {
                "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "onlyMainContent": {
                "default": false,
                "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                "type": "boolean",
              },
              "removeTags": {
                "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "replaceAllPathsWithAbsolutePaths": {
                "default": false,
                "description": "Replace all relative paths with absolute paths for images and links",
                "type": "boolean",
              },
              "screenshot": {
                "default": false,
                "description": "Include a screenshot of the top of the page that you are scraping.",
                "type": "boolean",
              },
              "waitFor": {
                "default": 0,
                "description": "Wait x amount of milliseconds for the page to load to fetch content",
                "type": "integer",
              },
            },
            "type": "object",
          },
          "url": {
            "description": "The base URL to start crawling from",
            "format": "uri",
            "type": "string",
          },
        },
        "required": [
          "url",
        ],
        "type": "object",
      },
      "name": "crawl_urls",
      "outputSchema": {
        "properties": {
          "id": {
            "type": "string",
          },
          "success": {
            "type": "boolean",
          },
          "url": {
            "format": "uri",
            "type": "string",
          },
        },
        "type": "object",
      },
    },
    {
      "description": "Search for a keyword in Google, returns top page results with markdown content for each page",
      "inputSchema": {
        "properties": {
          "pageOptions": {
            "properties": {
              "fetchPageContent": {
                "default": true,
                "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                "type": "boolean",
              },
              "includeHtml": {
                "default": false,
                "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                "type": "boolean",
              },
              "includeRawHtml": {
                "default": false,
                "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                "type": "boolean",
              },
              "onlyMainContent": {
                "default": false,
                "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                "type": "boolean",
              },
            },
            "type": "object",
          },
          "query": {
            "description": "The query to search for",
            "format": "uri",
            "type": "string",
          },
          "searchOptions": {
            "properties": {
              "limit": {
                "description": "Maximum number of results. Max is 20 during beta.",
                "type": "integer",
              },
            },
            "type": "object",
          },
        },
        "required": [
          "query",
        ],
        "type": "object",
      },
      "name": "search_google",
      "outputSchema": {
        "properties": {
          "data": {
            "items": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "array",
          },
          "success": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
    },
    {
      "description": "Get the status of a crawl job",
      "inputSchema": {
        "properties": {
          "jobId": {
            "description": "ID of the crawl job",
            "type": "string",
          },
        },
        "required": [
          "jobId",
        ],
        "type": "object",
      },
      "name": "get_crawl_status",
      "outputSchema": {
        "properties": {
          "current": {
            "description": "Current page number",
            "type": "integer",
          },
          "data": {
            "description": "Data returned from the job (null when it is in progress)",
            "items": {
              "properties": {
                "html": {
                  "description": "HTML version of the content on page if the \`html\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
                "links": {
                  "description": "Links on the page if the \`links\` format was specified",
                  "items": {
                    "format": "uri",
                    "type": "string",
                  },
                  "nullable": true,
                  "type": "array",
                },
                "markdown": {
                  "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                  "nullable": true,
                  "type": "string",
                },
                "metadata": {
                  "properties": {
                    "<any other metadata> ": {
                      "type": "string",
                    },
                    "description": {
                      "type": "string",
                    },
                    "error": {
                      "description": "The error message of the page",
                      "nullable": true,
                      "type": "string",
                    },
                    "language": {
                      "nullable": true,
                      "type": "string",
                    },
                    "sourceURL": {
                      "format": "uri",
                      "type": "string",
                    },
                    "statusCode": {
                      "description": "The status code of the page",
                      "type": "integer",
                    },
                    "title": {
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
                "rawHtml": {
                  "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
                "screenshot": {
                  "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
              },
              "type": "object",
            },
            "type": "array",
          },
          "partial_data": {
            "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.",
            "items": {
              "properties": {
                "html": {
                  "description": "HTML version of the content on page if the \`html\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
                "links": {
                  "description": "Links on the page if the \`links\` format was specified",
                  "items": {
                    "format": "uri",
                    "type": "string",
                  },
                  "nullable": true,
                  "type": "array",
                },
                "markdown": {
                  "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                  "nullable": true,
                  "type": "string",
                },
                "metadata": {
                  "properties": {
                    "<any other metadata> ": {
                      "type": "string",
                    },
                    "description": {
                      "type": "string",
                    },
                    "error": {
                      "description": "The error message of the page",
                      "nullable": true,
                      "type": "string",
                    },
                    "language": {
                      "nullable": true,
                      "type": "string",
                    },
                    "sourceURL": {
                      "format": "uri",
                      "type": "string",
                    },
                    "statusCode": {
                      "description": "The status code of the page",
                      "type": "integer",
                    },
                    "title": {
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
                "rawHtml": {
                  "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
                "screenshot": {
                  "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                  "nullable": true,
                  "type": "string",
                },
              },
              "type": "object",
            },
            "type": "array",
          },
          "status": {
            "description": "Status of the job (completed, active, failed, paused)",
            "type": "string",
          },
          "total": {
            "description": "Total number of pages",
            "type": "integer",
          },
        },
        "type": "object",
      },
    },
    {
      "description": "Cancel a crawl job",
      "inputSchema": {
        "properties": {
          "jobId": {
            "description": "ID of the crawl job",
            "type": "string",
          },
        },
        "required": [
          "jobId",
        ],
        "type": "object",
      },
      "name": "cancel_crawl_job",
      "outputSchema": {
        "properties": {
          "status": {
            "description": "Returns cancelled.",
            "type": "string",
          },
        },
        "type": "object",
      },
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > mixed.json 1`] = `
{
  "toolToOperationMap": {
    "echo": {
      "method": "get",
      "operationId": "echo",
      "parameterSources": {
        "id": "path",
        "name": "query",
        "x-custom-header": "header",
      },
      "path": "/echo/{id}",
      "tags": undefined,
    },
  },
  "tools": [
    {
      "description": "Echo",
      "inputSchema": {
        "properties": {
          "id": {
            "title": "id",
            "type": "string",
          },
          "name": {
            "title": "name",
            "type": "string",
          },
          "x-custom-header": {
            "title": "x-custom-header",
            "type": "string",
          },
        },
        "required": [
          "id",
        ],
        "type": "object",
      },
      "name": "echo",
      "outputSchema": undefined,
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > open-meteo.yaml 1`] = `
{
  "toolToOperationMap": {
    "get_v1_forecast": {
      "method": "get",
      "operationId": "get_v1_forecast",
      "parameterSources": {
        "current_weather": "query",
        "daily": "query",
        "hourly": "query",
        "latitude": "query",
        "longitude": "query",
        "past_days": "query",
        "temperature_unit": "query",
        "timeformat": "query",
        "timezone": "query",
        "wind_speed_unit": "query",
      },
      "path": "/v1/forecast",
      "tags": [
        "Weather Forecast APIs",
      ],
    },
  },
  "tools": [
    {
      "description": "7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.",
      "inputSchema": {
        "properties": {
          "current_weather": {
            "type": "boolean",
          },
          "daily": {
            "items": {
              "enum": [
                "temperature_2m_max",
                "temperature_2m_min",
                "apparent_temperature_max",
                "apparent_temperature_min",
                "precipitation_sum",
                "precipitation_hours",
                "weather_code",
                "sunrise",
                "sunset",
                "wind_speed_10m_max",
                "wind_gusts_10m_max",
                "wind_direction_10m_dominant",
                "shortwave_radiation_sum",
                "uv_index_max",
                "uv_index_clear_sky_max",
                "et0_fao_evapotranspiration",
              ],
              "type": "string",
            },
            "type": "array",
          },
          "hourly": {
            "items": {
              "enum": [
                "temperature_2m",
                "relative_humidity_2m",
                "dew_point_2m",
                "apparent_temperature",
                "pressure_msl",
                "cloud_cover",
                "cloud_cover_low",
                "cloud_cover_mid",
                "cloud_cover_high",
                "wind_speed_10m",
                "wind_speed_80m",
                "wind_speed_120m",
                "wind_speed_180m",
                "wind_direction_10m",
                "wind_direction_80m",
                "wind_direction_120m",
                "wind_direction_180m",
                "wind_gusts_10m",
                "shortwave_radiation",
                "direct_radiation",
                "direct_normal_irradiance",
                "diffuse_radiation",
                "vapour_pressure_deficit",
                "evapotranspiration",
                "precipitation",
                "weather_code",
                "snow_height",
                "freezing_level_height",
                "soil_temperature_0cm",
                "soil_temperature_6cm",
                "soil_temperature_18cm",
                "soil_temperature_54cm",
                "soil_moisture_0_1cm",
                "soil_moisture_1_3cm",
                "soil_moisture_3_9cm",
                "soil_moisture_9_27cm",
                "soil_moisture_27_81cm",
              ],
              "type": "string",
            },
            "type": "array",
          },
          "latitude": {
            "description": "WGS84 coordinate",
            "format": "double",
            "type": "number",
          },
          "longitude": {
            "description": "WGS84 coordinate",
            "format": "double",
            "type": "number",
          },
          "past_days": {
            "description": "If \`past_days\` is set, yesterdays or the day before yesterdays data are also returned.",
            "enum": [
              1,
              2,
            ],
            "type": "integer",
          },
          "temperature_unit": {
            "default": "celsius",
            "enum": [
              "celsius",
              "fahrenheit",
            ],
            "type": "string",
          },
          "timeformat": {
            "default": "iso8601",
            "description": "If format \`unixtime\` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply \`utc_offset_seconds\` again to get the correct date.",
            "enum": [
              "iso8601",
              "unixtime",
            ],
            "type": "string",
          },
          "timezone": {
            "description": "If \`timezone\` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.",
            "type": "string",
          },
          "wind_speed_unit": {
            "default": "kmh",
            "enum": [
              "kmh",
              "ms",
              "mph",
              "kn",
            ],
            "type": "string",
          },
        },
        "required": [
          "latitude",
          "longitude",
        ],
        "type": "object",
      },
      "name": "get_v1_forecast",
      "outputSchema": {
        "properties": {
          "current_weather": {
            "description": "Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code",
            "properties": {
              "temperature": {
                "type": "number",
              },
              "time": {
                "type": "string",
              },
              "weather_code": {
                "type": "integer",
              },
              "wind_direction": {
                "type": "number",
              },
              "wind_speed": {
                "type": "number",
              },
            },
            "required": [
              "time",
              "temperature",
              "wind_speed",
              "wind_direction",
              "weather_code",
            ],
            "type": "object",
          },
          "daily": {
            "description": "For each selected daily weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
            "properties": {
              "apparent_temperature_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "apparent_temperature_min": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "et0_fao_evapotranspiration": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "precipitation_hours": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "precipitation_sum": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "shortwave_radiation_sum": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "sunrise": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "sunset": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "temperature_2m_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "temperature_2m_min": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "time": {
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "uv_index_clear_sky_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "uv_index_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "weather_code": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_direction_10m_dominant": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_gusts_10m_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_speed_10m_max": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
            },
            "required": [
              "time",
            ],
            "type": "object",
          },
          "daily_units": {
            "additionalProperties": {
              "type": "string",
            },
            "description": "For each selected daily weather variable, the unit will be listed here.",
            "type": "object",
          },
          "elevation": {
            "description": "The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.",
            "example": 44.812,
            "type": "number",
          },
          "generationtime_ms": {
            "description": "Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.",
            "example": 2.2119,
            "type": "number",
          },
          "hourly": {
            "description": "For each selected weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
            "properties": {
              "apparent_temperature": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "cloud_cover": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "cloud_cover_high": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "cloud_cover_low": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "cloud_cover_mid": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "dew_point_2m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "diffuse_radiation": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "direct_normal_irradiance": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "direct_radiation": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "evapotranspiration": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "freezing_level_height": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "precipitation": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "pressure_msl": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "relative_humidity_2m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "shortwave_radiation": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "snow_height": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_moisture_0_1cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_moisture_1_3cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_moisture_27_81cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_moisture_3_9cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_moisture_9_27cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_temperature_0cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_temperature_18cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_temperature_54cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "soil_temperature_6cm": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "temperature_2m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "time": {
                "items": {
                  "type": "string",
                },
                "type": "array",
              },
              "vapour_pressure_deficit": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "weather_code": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_direction_10m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_direction_120m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_direction_180m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_direction_80m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_gusts_10m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_speed_10m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_speed_120m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_speed_180m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
              "wind_speed_80m": {
                "items": {
                  "type": "number",
                },
                "type": "array",
              },
            },
            "required": [
              "time",
            ],
            "type": "object",
          },
          "hourly_units": {
            "additionalProperties": {
              "type": "string",
            },
            "description": "For each selected weather variable, the unit will be listed here.",
            "type": "object",
          },
          "latitude": {
            "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
            "example": 52.52,
            "type": "number",
          },
          "longitude": {
            "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
            "example": "13.419.52",
            "type": "number",
          },
          "utc_offset_seconds": {
            "description": "Applied timezone offset from the &timezone= parameter.",
            "example": 3600,
            "type": "integer",
          },
        },
        "type": "object",
      },
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > pet-store.json 1`] = `
{
  "toolToOperationMap": {
    "create_pets": {
      "method": "post",
      "operationId": "createPets",
      "parameterSources": {
        "id": "body",
        "name": "body",
        "tag": "body",
      },
      "path": "/pets",
      "tags": [
        "pets",
      ],
    },
    "list_pets": {
      "method": "get",
      "operationId": "listPets",
      "parameterSources": {
        "limit": "query",
      },
      "path": "/pets",
      "tags": [
        "pets",
      ],
    },
    "show_pet_by_id": {
      "method": "get",
      "operationId": "showPetById",
      "parameterSources": {
        "petId": "path",
      },
      "path": "/pets/{petId}",
      "tags": [
        "pets",
      ],
    },
  },
  "tools": [
    {
      "description": "List all pets",
      "inputSchema": {
        "properties": {
          "limit": {
            "description": "How many items to return at one time (max 100)",
            "format": "int32",
            "maximum": 100,
            "type": "integer",
          },
        },
        "required": [],
        "type": "object",
      },
      "name": "list_pets",
      "outputSchema": undefined,
    },
    {
      "description": "Create a pet",
      "inputSchema": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer",
          },
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
        ],
        "type": "object",
      },
      "name": "create_pets",
      "outputSchema": undefined,
    },
    {
      "description": "Info for a specific pet",
      "inputSchema": {
        "properties": {
          "petId": {
            "description": "The id of the pet to retrieve",
            "type": "string",
          },
        },
        "required": [
          "petId",
        ],
        "type": "object",
      },
      "name": "show_pet_by_id",
      "outputSchema": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer",
          },
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
        ],
        "type": "object",
      },
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > petstore-expanded.json 1`] = `
{
  "toolToOperationMap": {
    "add_pet": {
      "method": "post",
      "operationId": "addPet",
      "parameterSources": {
        "name": "body",
        "tag": "body",
      },
      "path": "/pets",
      "tags": undefined,
    },
    "delete_pet": {
      "method": "delete",
      "operationId": "deletePet",
      "parameterSources": {
        "id": "path",
      },
      "path": "/pets/{id}",
      "tags": undefined,
    },
    "find_pet_by_id": {
      "method": "get",
      "operationId": "find pet by id",
      "parameterSources": {
        "id": "path",
      },
      "path": "/pets/{id}",
      "tags": undefined,
    },
    "find_pets": {
      "method": "get",
      "operationId": "findPets",
      "parameterSources": {
        "limit": "query",
        "tags": "query",
      },
      "path": "/pets",
      "tags": undefined,
    },
  },
  "tools": [
    {
      "description": "Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
      "inputSchema": {
        "properties": {
          "limit": {
            "description": "maximum number of results to return",
            "format": "int32",
            "type": "integer",
          },
          "tags": {
            "description": "tags to filter by",
            "items": {
              "type": "string",
            },
            "type": "array",
          },
        },
        "required": [],
        "type": "object",
      },
      "name": "find_pets",
      "outputSchema": undefined,
    },
    {
      "description": "Creates a new pet in the store. Duplicates are allowed",
      "inputSchema": {
        "properties": {
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "name",
        ],
        "type": "object",
      },
      "name": "add_pet",
      "outputSchema": undefined,
    },
    {
      "description": "Returns a user based on a single ID, if the user does not have access to the pet",
      "inputSchema": {
        "properties": {
          "id": {
            "description": "ID of pet to fetch",
            "format": "int64",
            "type": "integer",
          },
        },
        "required": [
          "id",
        ],
        "type": "object",
      },
      "name": "find_pet_by_id",
      "outputSchema": undefined,
    },
    {
      "description": "deletes a single pet based on the ID supplied",
      "inputSchema": {
        "properties": {
          "id": {
            "description": "ID of pet to delete",
            "format": "int64",
            "type": "integer",
          },
        },
        "required": [
          "id",
        ],
        "type": "object",
      },
      "name": "delete_pet",
      "outputSchema": undefined,
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > remote spec https://agentic-platform-fixtures-everything.onrender.com/docs 1`] = `
{
  "toolToOperationMap": {
    "custom_cache_control_tool": {
      "method": "post",
      "operationId": "customCacheControlTool",
      "parameterSources": {},
      "path": "/custom-cache-control-tool",
      "tags": undefined,
    },
    "custom_rate_limit_approximate_tool": {
      "method": "post",
      "operationId": "customRateLimitApproximateTool",
      "parameterSources": {},
      "path": "/custom-rate-limit-approximate-tool",
      "tags": undefined,
    },
    "custom_rate_limit_tool": {
      "method": "post",
      "operationId": "customRateLimitTool",
      "parameterSources": {},
      "path": "/custom-rate-limit-tool",
      "tags": undefined,
    },
    "disabled_for_free_plan_tool": {
      "method": "get",
      "operationId": "disabledForFreePlanTool",
      "parameterSources": {},
      "path": "/disabled-for-free-plan-tool",
      "tags": undefined,
    },
    "disabled_rate_limit_tool": {
      "method": "post",
      "operationId": "disabledRateLimitTool",
      "parameterSources": {},
      "path": "/disabled-rate-limit-tool",
      "tags": undefined,
    },
    "disabled_tool": {
      "method": "get",
      "operationId": "disabledTool",
      "parameterSources": {},
      "path": "/disabled-tool",
      "tags": undefined,
    },
    "echo": {
      "method": "post",
      "operationId": "echo",
      "parameterSources": {},
      "path": "/echo",
      "tags": undefined,
    },
    "echo_headers": {
      "method": "get",
      "operationId": "echoHeaders",
      "parameterSources": {},
      "path": "/echo-headers",
      "tags": undefined,
    },
    "get_user": {
      "method": "get",
      "operationId": "getUser",
      "parameterSources": {
        "userId": "path",
      },
      "path": "/users/{userId}",
      "tags": [
        "users",
      ],
    },
    "health_check": {
      "method": "get",
      "operationId": "healthCheck",
      "parameterSources": {},
      "path": "/health",
      "tags": undefined,
    },
    "no_cache_cache_control_tool": {
      "method": "post",
      "operationId": "noCacheCacheControlTool",
      "parameterSources": {},
      "path": "/no-cache-cache-control-tool",
      "tags": undefined,
    },
    "no_store_cache_control_tool": {
      "method": "post",
      "operationId": "noStoreCacheControlTool",
      "parameterSources": {},
      "path": "/no-store-cache-control-tool",
      "tags": undefined,
    },
    "pure": {
      "method": "post",
      "operationId": "pure",
      "parameterSources": {},
      "path": "/pure",
      "tags": undefined,
    },
    "strict_additional_properties": {
      "method": "post",
      "operationId": "strictAdditionalProperties",
      "parameterSources": {
        "foo": "body",
      },
      "path": "/strict-additional-properties",
      "tags": undefined,
    },
    "unpure_marked_pure": {
      "method": "post",
      "operationId": "unpure_marked_pure",
      "parameterSources": {},
      "path": "/unpure-marked-pure",
      "tags": undefined,
    },
  },
  "tools": [
    {
      "description": "Check if the server is healthy",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "health_check",
      "outputSchema": {
        "properties": {
          "status": {
            "type": "string",
          },
        },
        "required": [
          "status",
        ],
        "type": "object",
      },
    },
    {
      "description": "Gets a user",
      "inputSchema": {
        "properties": {
          "userId": {
            "description": "User ID",
            "type": "string",
          },
        },
        "required": [
          "userId",
        ],
        "type": "object",
      },
      "name": "get_user",
      "outputSchema": {
        "properties": {
          "email": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
          "email",
        ],
        "type": "object",
      },
    },
    {
      "description": "Disabled tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "disabled_tool",
      "outputSchema": {
        "properties": {
          "status": {
            "type": "string",
          },
        },
        "required": [
          "status",
        ],
        "type": "object",
      },
    },
    {
      "description": "Disabled for free plan tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "disabled_for_free_plan_tool",
      "outputSchema": {
        "properties": {
          "status": {
            "type": "string",
          },
        },
        "required": [
          "status",
        ],
        "type": "object",
      },
    },
    {
      "description": "Echoes the request body",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "echo",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Echoes the request headers",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "echo_headers",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Pure tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "pure",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Unpure tool marked pure",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "unpure_marked_pure",
      "outputSchema": {
        "properties": {
          "now": {
            "type": "number",
          },
        },
        "required": [
          "now",
        ],
        "type": "object",
      },
    },
    {
      "description": "Custom cache control tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "custom_cache_control_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Custom rate limit tool (approximate mode)",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "custom_rate_limit_approximate_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "No store cache control tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "no_store_cache_control_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "No cache cache control tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "no_cache_cache_control_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Custom rate limit tool (strict mode)",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "custom_rate_limit_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Disabled rate limit tool",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "disabled_rate_limit_tool",
      "outputSchema": {
        "properties": {},
        "type": "object",
      },
    },
    {
      "description": "Echoes the request body only allowing a single "foo" field.",
      "inputSchema": {
        "properties": {
          "foo": {
            "type": "string",
          },
        },
        "required": [
          "foo",
        ],
        "type": "object",
      },
      "name": "strict_additional_properties",
      "outputSchema": {
        "properties": {
          "foo": {
            "type": "string",
          },
        },
        "required": [
          "foo",
        ],
        "type": "object",
      },
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > security.json 1`] = `
{
  "toolToOperationMap": {
    "delete_anything_oauth2": {
      "method": "delete",
      "operationId": "delete_anything_oauth2",
      "parameterSources": {},
      "path": "/anything/oauth2",
      "tags": [
        "OAuth 2",
      ],
    },
    "get_anything_api_key": {
      "method": "get",
      "operationId": "get_anything_apiKey",
      "parameterSources": {},
      "path": "/anything/apiKey",
      "tags": [
        "API Key",
      ],
    },
    "get_anything_oauth2": {
      "method": "get",
      "operationId": "get_anything_oauth2",
      "parameterSources": {},
      "path": "/anything/oauth2",
      "tags": [
        "OAuth 2",
      ],
    },
    "get_anything_optional_auth": {
      "method": "get",
      "operationId": "get_anything_optional_auth",
      "parameterSources": {},
      "path": "/anything/optional-auth",
      "tags": [
        "Other",
      ],
    },
    "patch_anything_oauth2": {
      "method": "patch",
      "operationId": "patch_anything_oauth2",
      "parameterSources": {},
      "path": "/anything/oauth2",
      "tags": [
        "OAuth 2",
      ],
    },
    "post_anything_api_key": {
      "method": "post",
      "operationId": "post_anything_apiKey",
      "parameterSources": {},
      "path": "/anything/apiKey",
      "tags": [
        "API Key",
      ],
    },
    "post_anything_basic": {
      "method": "post",
      "operationId": "post_anything_basic",
      "parameterSources": {},
      "path": "/anything/basic",
      "tags": [
        "HTTP",
      ],
    },
    "post_anything_bearer": {
      "method": "post",
      "operationId": "post_anything_bearer",
      "parameterSources": {},
      "path": "/anything/bearer",
      "tags": [
        "HTTP",
      ],
    },
    "post_anything_no_auth": {
      "method": "post",
      "operationId": "post_anything_no_auth",
      "parameterSources": {},
      "path": "/anything/no-auth",
      "tags": [
        "Other",
      ],
    },
    "post_anything_oauth2": {
      "method": "post",
      "operationId": "post_anything_oauth2",
      "parameterSources": {},
      "path": "/anything/oauth2",
      "tags": [
        "OAuth 2",
      ],
    },
    "post_anything_open_id_connect": {
      "method": "post",
      "operationId": "post_anything_openIdConnect",
      "parameterSources": {},
      "path": "/anything/openIdConnect",
      "tags": [
        "OpenID Connect",
      ],
    },
    "post_status401": {
      "method": "post",
      "operationId": "post_status_401",
      "parameterSources": {},
      "path": "/status/401",
      "tags": [
        "Other",
      ],
    },
    "put_anything_api_key": {
      "method": "put",
      "operationId": "put_anything_apiKey",
      "parameterSources": {},
      "path": "/anything/apiKey",
      "tags": [
        "API Key",
      ],
    },
    "put_anything_bearer": {
      "method": "put",
      "operationId": "put_anything_bearer",
      "parameterSources": {},
      "path": "/anything/bearer",
      "tags": [
        "HTTP",
      ],
    },
    "put_anything_oauth2": {
      "method": "put",
      "operationId": "put_anything_oauth2",
      "parameterSources": {},
      "path": "/anything/oauth2",
      "tags": [
        "OAuth 2",
      ],
    },
  },
  "tools": [
    {
      "description": "\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "get_anything_api_key",
      "outputSchema": undefined,
    },
    {
      "description": "\`apiKey\` auth will be supplied within an \`api_key\` cookie.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_api_key",
      "outputSchema": undefined,
    },
    {
      "description": "\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "put_anything_api_key",
      "outputSchema": undefined,
    },
    {
      "description": "Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_basic",
      "outputSchema": undefined,
    },
    {
      "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_bearer",
      "outputSchema": undefined,
    },
    {
      "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "put_anything_bearer",
      "outputSchema": undefined,
    },
    {
      "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "get_anything_oauth2",
      "outputSchema": undefined,
    },
    {
      "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_oauth2",
      "outputSchema": undefined,
    },
    {
      "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "put_anything_oauth2",
      "outputSchema": undefined,
    },
    {
      "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "delete_anything_oauth2",
      "outputSchema": undefined,
    },
    {
      "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "patch_anything_oauth2",
      "outputSchema": undefined,
    },
    {
      "description": "🚧 This is not supported.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_open_id_connect",
      "outputSchema": undefined,
    },
    {
      "description": "This operation does not have any authentication requirements.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_anything_no_auth",
      "outputSchema": undefined,
    },
    {
      "description": "The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "get_anything_optional_auth",
      "outputSchema": undefined,
    },
    {
      "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "post_status401",
      "outputSchema": undefined,
    },
  ],
}
`;

exports[`getToolsFromOpenAPISpec > tic-tac-toe.json 1`] = `
{
  "toolToOperationMap": {
    "get_board": {
      "method": "get",
      "operationId": "get-board",
      "parameterSources": {},
      "path": "/board",
      "tags": [
        "Gameplay",
      ],
    },
    "get_square": {
      "method": "get",
      "operationId": "get-square",
      "parameterSources": {
        "column": "path",
        "row": "path",
      },
      "path": "/board/{row}/{column}",
      "tags": [
        "Gameplay",
      ],
    },
    "put_square": {
      "method": "put",
      "operationId": "put-square",
      "parameterSources": {
        "column": "path",
        "row": "path",
      },
      "path": "/board/{row}/{column}",
      "tags": [
        "Gameplay",
      ],
    },
  },
  "tools": [
    {
      "description": "Retrieves the current state of the board and the winner.",
      "inputSchema": {
        "properties": {},
        "required": [],
        "type": "object",
      },
      "name": "get_board",
      "outputSchema": {
        "properties": {
          "board": {
            "items": {
              "items": {
                "description": "Possible values for a board square. \`.\` means empty square.",
                "enum": [
                  ".",
                  "X",
                  "O",
                ],
                "example": ".",
                "type": "string",
              },
              "maxItems": 3,
              "minItems": 3,
              "type": "array",
            },
            "maxItems": 3,
            "minItems": 3,
            "type": "array",
          },
          "winner": {
            "description": "Winner of the game. \`.\` means nobody has won yet.",
            "enum": [
              ".",
              "X",
              "O",
            ],
            "example": ".",
            "type": "string",
          },
        },
        "type": "object",
      },
    },
    {
      "description": "Retrieves the requested square.",
      "inputSchema": {
        "properties": {
          "column": {
            "description": "Board column (horizontal coordinate)",
            "example": 1,
            "maximum": 3,
            "minimum": 1,
            "type": "integer",
          },
          "row": {
            "description": "Board row (vertical coordinate)",
            "example": 1,
            "maximum": 3,
            "minimum": 1,
            "type": "integer",
          },
        },
        "required": [
          "row",
          "column",
        ],
        "type": "object",
      },
      "name": "get_square",
      "outputSchema": undefined,
    },
    {
      "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
      "inputSchema": {
        "properties": {
          "column": {
            "description": "Board column (horizontal coordinate)",
            "example": 1,
            "maximum": 3,
            "minimum": 1,
            "type": "integer",
          },
          "row": {
            "description": "Board row (vertical coordinate)",
            "example": 1,
            "maximum": 3,
            "minimum": 1,
            "type": "integer",
          },
        },
        "required": [
          "row",
          "column",
        ],
        "type": "object",
      },
      "name": "put_square",
      "outputSchema": {
        "properties": {
          "board": {
            "items": {
              "items": {
                "description": "Possible values for a board square. \`.\` means empty square.",
                "enum": [
                  ".",
                  "X",
                  "O",
                ],
                "example": ".",
                "type": "string",
              },
              "maxItems": 3,
              "minItems": 3,
              "type": "array",
            },
            "maxItems": 3,
            "minItems": 3,
            "type": "array",
          },
          "winner": {
            "description": "Winner of the game. \`.\` means nobody has won yet.",
            "enum": [
              ".",
              "X",
              "O",
            ],
            "example": ".",
            "type": "string",
          },
        },
        "type": "object",
      },
    },
  ],
}
`;


================================================
FILE: packages/openapi-utils/src/__snapshots__/validate-openapi-spec.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`validateOpenAPISpec > basic.json (file url) 1`] = `
{
  "info": {
    "title": "OpenAPI Basic Test Fixture",
    "version": "0.1.0",
  },
  "openapi": "3.0.2",
  "paths": {
    "/": {
      "get": {
        "operationId": "echo",
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "required": false,
            "schema": {
              "title": "name",
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
              },
            },
            "description": "Success",
          },
        },
        "summary": "Echo",
      },
    },
  },
  "servers": [
    {
      "url": "https://test-openapi-basic.now.sh",
    },
  ],
}
`;

exports[`validateOpenAPISpec > basic.json (http url) 1`] = `
{
  "info": {
    "title": "OpenAPI Basic Test Fixture",
    "version": "0.1.0",
  },
  "openapi": "3.0.2",
  "paths": {
    "/": {
      "get": {
        "operationId": "echo",
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "required": false,
            "schema": {
              "title": "name",
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
              },
            },
            "description": "Success",
          },
        },
        "summary": "Echo",
      },
    },
  },
  "servers": [
    {
      "url": "https://test-openapi-basic.now.sh",
    },
  ],
}
`;

exports[`validateOpenAPISpec > basic.json (string) 1`] = `
{
  "info": {
    "title": "OpenAPI Basic Test Fixture",
    "version": "0.1.0",
  },
  "openapi": "3.0.2",
  "paths": {
    "/": {
      "get": {
        "operationId": "echo",
        "parameters": [
          {
            "in": "query",
            "name": "name",
            "required": false,
            "schema": {
              "title": "name",
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {},
              },
            },
            "description": "Success",
          },
        },
        "summary": "Echo",
      },
    },
  },
  "servers": [
    {
      "url": "https://test-openapi-basic.now.sh",
    },
  ],
}
`;

exports[`validateOpenAPISpec > firecrawl.json (file url) 1`] = `
{
  "components": {
    "schemas": {
      "CrawlResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "success": {
            "type": "boolean",
          },
          "url": {
            "format": "uri",
            "type": "string",
          },
        },
        "type": "object",
      },
      "CrawlStatusResponseObj": {
        "properties": {
          "html": {
            "description": "HTML version of the content on page if the \`html\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "links": {
            "description": "Links on the page if the \`links\` format was specified",
            "items": {
              "format": "uri",
              "type": "string",
            },
            "nullable": true,
            "type": "array",
          },
          "markdown": {
            "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
            "nullable": true,
            "type": "string",
          },
          "metadata": {
            "properties": {
              "<any other metadata> ": {
                "type": "string",
              },
              "description": {
                "type": "string",
              },
              "error": {
                "description": "The error message of the page",
                "nullable": true,
                "type": "string",
              },
              "language": {
                "nullable": true,
                "type": "string",
              },
              "sourceURL": {
                "format": "uri",
                "type": "string",
              },
              "statusCode": {
                "description": "The status code of the page",
                "type": "integer",
              },
              "title": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "rawHtml": {
            "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "screenshot": {
            "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "ScrapeResponse": {
        "properties": {
          "data": {
            "properties": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "object",
          },
          "success": {
            "type": "boolean",
          },
          "warning": {
            "description": "Warning message to let you know of any issues.",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "data": {
            "items": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "array",
          },
          "success": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http",
      },
    },
  },
  "info": {
    "contact": {
      "email": "support@firecrawl.dev",
      "name": "Firecrawl Support",
      "url": "https://firecrawl.dev/support",
    },
    "description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
    "title": "Firecrawl API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/crawl": {
      "post": {
        "operationId": "crawlUrls",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "crawlerOptions": {
                    "properties": {
                      "allowBackwardCrawling": {
                        "default": false,
                        "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                        "type": "boolean",
                      },
                      "allowExternalContentLinks": {
                        "default": false,
                        "description": "Allows the crawler to follow links to external websites.",
                        "type": "boolean",
                      },
                      "excludes": {
                        "description": "URL patterns to exclude",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "generateImgAltText": {
                        "default": false,
                        "description": "Generate alt text for images using LLMs (must have a paid plan)",
                        "type": "boolean",
                      },
                      "ignoreSitemap": {
                        "default": false,
                        "description": "Ignore the website sitemap when crawling",
                        "type": "boolean",
                      },
                      "includes": {
                        "description": "URL patterns to include",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "limit": {
                        "default": 10000,
                        "description": "Maximum number of pages to crawl",
                        "type": "integer",
                      },
                      "maxDepth": {
                        "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.",
                        "type": "integer",
                      },
                      "mode": {
                        "default": "default",
                        "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                        "enum": [
                          "default",
                          "fast",
                        ],
                        "type": "string",
                      },
                      "returnOnlyUrls": {
                        "default": false,
                        "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "pageOptions": {
                    "properties": {
                      "fullPageScreenshot": {
                        "default": false,
                        "description": "Include a full page screenshot of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "headers": {
                        "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                        "type": "object",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyIncludeTags": {
                        "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                      "removeTags": {
                        "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "replaceAllPathsWithAbsolutePaths": {
                        "default": false,
                        "description": "Replace all relative paths with absolute paths for images and links",
                        "type": "boolean",
                      },
                      "screenshot": {
                        "default": false,
                        "description": "Include a screenshot of the top of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "waitFor": {
                        "default": 0,
                        "description": "Wait x amount of milliseconds for the page to load to fetch content",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                  "url": {
                    "description": "The base URL to start crawling from",
                    "format": "uri",
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrawlResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Crawl multiple URLs based on options",
        "tags": [
          "Crawling",
        ],
      },
    },
    "/crawl/cancel/{jobId}": {
      "delete": {
        "operationId": "cancelCrawlJob",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "description": "Returns cancelled.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Cancel a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/crawl/status/{jobId}": {
      "get": {
        "operationId": "getCrawlStatus",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current": {
                      "description": "Current page number",
                      "type": "integer",
                    },
                    "data": {
                      "description": "Data returned from the job (null when it is in progress)",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "partial_data": {
                      "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "status": {
                      "description": "Status of the job (completed, active, failed, paused)",
                      "type": "string",
                    },
                    "total": {
                      "description": "Total number of pages",
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Get the status of a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/scrape": {
      "post": {
        "operationId": "scrape",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "excludeTags": {
                    "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "formats": {
                    "default": [
                      "markdown",
                    ],
                    "description": "Specific formats to return.

 - markdown: The page in Markdown format.
 - html: The page's HTML, trimmed to include only meaningful content.
 - rawHtml: The page's original HTML.
 - links: The links on the page.
 - screenshot: A screenshot of the top of the page.
 - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
                    "items": {
                      "enum": [
                        "markdown",
                        "html",
                        "rawHtml",
                        "links",
                        "screenshot",
                        "screenshot@fullPage",
                      ],
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "headers": {
                    "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                    "type": "object",
                  },
                  "includeTags": {
                    "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "onlyMainContent": {
                    "default": true,
                    "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                    "type": "boolean",
                  },
                  "timeout": {
                    "default": 30000,
                    "description": "Timeout in milliseconds for the request",
                    "type": "integer",
                  },
                  "url": {
                    "description": "The URL to scrape",
                    "format": "uri",
                    "type": "string",
                  },
                  "waitFor": {
                    "default": 0,
                    "description": "Wait x amount of milliseconds for the page to load to fetch content",
                    "type": "integer",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScrapeResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Scrape a single URL",
        "tags": [
          "Scraping",
        ],
      },
    },
    "/search": {
      "post": {
        "operationId": "searchGoogle",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "pageOptions": {
                    "properties": {
                      "fetchPageContent": {
                        "default": true,
                        "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                        "type": "boolean",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "query": {
                    "description": "The query to search for",
                    "format": "uri",
                    "type": "string",
                  },
                  "searchOptions": {
                    "properties": {
                      "limit": {
                        "description": "Maximum number of results. Max is 20 during beta.",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                },
                "required": [
                  "query",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Search for a keyword in Google, returns top page results with markdown content for each page",
        "tags": [
          "Search",
        ],
      },
    },
  },
  "security": [
    {
      "bearerAuth": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.firecrawl.dev/v0",
    },
  ],
}
`;

exports[`validateOpenAPISpec > firecrawl.json (http url) 1`] = `
{
  "components": {
    "schemas": {
      "CrawlResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "success": {
            "type": "boolean",
          },
          "url": {
            "format": "uri",
            "type": "string",
          },
        },
        "type": "object",
      },
      "CrawlStatusResponseObj": {
        "properties": {
          "html": {
            "description": "HTML version of the content on page if the \`html\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "links": {
            "description": "Links on the page if the \`links\` format was specified",
            "items": {
              "format": "uri",
              "type": "string",
            },
            "nullable": true,
            "type": "array",
          },
          "markdown": {
            "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
            "nullable": true,
            "type": "string",
          },
          "metadata": {
            "properties": {
              "<any other metadata> ": {
                "type": "string",
              },
              "description": {
                "type": "string",
              },
              "error": {
                "description": "The error message of the page",
                "nullable": true,
                "type": "string",
              },
              "language": {
                "nullable": true,
                "type": "string",
              },
              "sourceURL": {
                "format": "uri",
                "type": "string",
              },
              "statusCode": {
                "description": "The status code of the page",
                "type": "integer",
              },
              "title": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "rawHtml": {
            "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "screenshot": {
            "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "ScrapeResponse": {
        "properties": {
          "data": {
            "properties": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "object",
          },
          "success": {
            "type": "boolean",
          },
          "warning": {
            "description": "Warning message to let you know of any issues.",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "data": {
            "items": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "array",
          },
          "success": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http",
      },
    },
  },
  "info": {
    "contact": {
      "email": "support@firecrawl.dev",
      "name": "Firecrawl Support",
      "url": "https://firecrawl.dev/support",
    },
    "description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
    "title": "Firecrawl API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/crawl": {
      "post": {
        "operationId": "crawlUrls",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "crawlerOptions": {
                    "properties": {
                      "allowBackwardCrawling": {
                        "default": false,
                        "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                        "type": "boolean",
                      },
                      "allowExternalContentLinks": {
                        "default": false,
                        "description": "Allows the crawler to follow links to external websites.",
                        "type": "boolean",
                      },
                      "excludes": {
                        "description": "URL patterns to exclude",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "generateImgAltText": {
                        "default": false,
                        "description": "Generate alt text for images using LLMs (must have a paid plan)",
                        "type": "boolean",
                      },
                      "ignoreSitemap": {
                        "default": false,
                        "description": "Ignore the website sitemap when crawling",
                        "type": "boolean",
                      },
                      "includes": {
                        "description": "URL patterns to include",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "limit": {
                        "default": 10000,
                        "description": "Maximum number of pages to crawl",
                        "type": "integer",
                      },
                      "maxDepth": {
                        "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.",
                        "type": "integer",
                      },
                      "mode": {
                        "default": "default",
                        "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                        "enum": [
                          "default",
                          "fast",
                        ],
                        "type": "string",
                      },
                      "returnOnlyUrls": {
                        "default": false,
                        "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "pageOptions": {
                    "properties": {
                      "fullPageScreenshot": {
                        "default": false,
                        "description": "Include a full page screenshot of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "headers": {
                        "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                        "type": "object",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyIncludeTags": {
                        "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                      "removeTags": {
                        "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "replaceAllPathsWithAbsolutePaths": {
                        "default": false,
                        "description": "Replace all relative paths with absolute paths for images and links",
                        "type": "boolean",
                      },
                      "screenshot": {
                        "default": false,
                        "description": "Include a screenshot of the top of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "waitFor": {
                        "default": 0,
                        "description": "Wait x amount of milliseconds for the page to load to fetch content",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                  "url": {
                    "description": "The base URL to start crawling from",
                    "format": "uri",
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrawlResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Crawl multiple URLs based on options",
        "tags": [
          "Crawling",
        ],
      },
    },
    "/crawl/cancel/{jobId}": {
      "delete": {
        "operationId": "cancelCrawlJob",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "description": "Returns cancelled.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Cancel a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/crawl/status/{jobId}": {
      "get": {
        "operationId": "getCrawlStatus",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current": {
                      "description": "Current page number",
                      "type": "integer",
                    },
                    "data": {
                      "description": "Data returned from the job (null when it is in progress)",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "partial_data": {
                      "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "status": {
                      "description": "Status of the job (completed, active, failed, paused)",
                      "type": "string",
                    },
                    "total": {
                      "description": "Total number of pages",
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Get the status of a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/scrape": {
      "post": {
        "operationId": "scrape",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "excludeTags": {
                    "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "formats": {
                    "default": [
                      "markdown",
                    ],
                    "description": "Specific formats to return.

 - markdown: The page in Markdown format.
 - html: The page's HTML, trimmed to include only meaningful content.
 - rawHtml: The page's original HTML.
 - links: The links on the page.
 - screenshot: A screenshot of the top of the page.
 - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
                    "items": {
                      "enum": [
                        "markdown",
                        "html",
                        "rawHtml",
                        "links",
                        "screenshot",
                        "screenshot@fullPage",
                      ],
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "headers": {
                    "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                    "type": "object",
                  },
                  "includeTags": {
                    "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "onlyMainContent": {
                    "default": true,
                    "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                    "type": "boolean",
                  },
                  "timeout": {
                    "default": 30000,
                    "description": "Timeout in milliseconds for the request",
                    "type": "integer",
                  },
                  "url": {
                    "description": "The URL to scrape",
                    "format": "uri",
                    "type": "string",
                  },
                  "waitFor": {
                    "default": 0,
                    "description": "Wait x amount of milliseconds for the page to load to fetch content",
                    "type": "integer",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScrapeResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Scrape a single URL",
        "tags": [
          "Scraping",
        ],
      },
    },
    "/search": {
      "post": {
        "operationId": "searchGoogle",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "pageOptions": {
                    "properties": {
                      "fetchPageContent": {
                        "default": true,
                        "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                        "type": "boolean",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "query": {
                    "description": "The query to search for",
                    "format": "uri",
                    "type": "string",
                  },
                  "searchOptions": {
                    "properties": {
                      "limit": {
                        "description": "Maximum number of results. Max is 20 during beta.",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                },
                "required": [
                  "query",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Search for a keyword in Google, returns top page results with markdown content for each page",
        "tags": [
          "Search",
        ],
      },
    },
  },
  "security": [
    {
      "bearerAuth": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.firecrawl.dev/v0",
    },
  ],
}
`;

exports[`validateOpenAPISpec > firecrawl.json (string) 1`] = `
{
  "components": {
    "schemas": {
      "CrawlResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "success": {
            "type": "boolean",
          },
          "url": {
            "format": "uri",
            "type": "string",
          },
        },
        "type": "object",
      },
      "CrawlStatusResponseObj": {
        "properties": {
          "html": {
            "description": "HTML version of the content on page if the \`html\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "links": {
            "description": "Links on the page if the \`links\` format was specified",
            "items": {
              "format": "uri",
              "type": "string",
            },
            "nullable": true,
            "type": "array",
          },
          "markdown": {
            "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
            "nullable": true,
            "type": "string",
          },
          "metadata": {
            "properties": {
              "<any other metadata> ": {
                "type": "string",
              },
              "description": {
                "type": "string",
              },
              "error": {
                "description": "The error message of the page",
                "nullable": true,
                "type": "string",
              },
              "language": {
                "nullable": true,
                "type": "string",
              },
              "sourceURL": {
                "format": "uri",
                "type": "string",
              },
              "statusCode": {
                "description": "The status code of the page",
                "type": "integer",
              },
              "title": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "rawHtml": {
            "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
            "nullable": true,
            "type": "string",
          },
          "screenshot": {
            "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "ScrapeResponse": {
        "properties": {
          "data": {
            "properties": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "object",
          },
          "success": {
            "type": "boolean",
          },
          "warning": {
            "description": "Warning message to let you know of any issues.",
            "nullable": true,
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "data": {
            "items": {
              "html": {
                "description": "HTML version of the content on page if the \`html\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "links": {
                "description": "Links on the page if the \`links\` format was specified",
                "items": {
                  "format": "uri",
                  "type": "string",
                },
                "nullable": true,
                "type": "array",
              },
              "markdown": {
                "description": "Markdown content of the page if the \`markdown\` format was specified (default)",
                "nullable": true,
                "type": "string",
              },
              "metadata": {
                "properties": {
                  "<any other metadata> ": {
                    "type": "string",
                  },
                  "description": {
                    "type": "string",
                  },
                  "error": {
                    "description": "The error message of the page",
                    "nullable": true,
                    "type": "string",
                  },
                  "language": {
                    "nullable": true,
                    "type": "string",
                  },
                  "sourceURL": {
                    "format": "uri",
                    "type": "string",
                  },
                  "statusCode": {
                    "description": "The status code of the page",
                    "type": "integer",
                  },
                  "title": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "rawHtml": {
                "description": "Raw HTML content of the page if the \`rawHtml\` format was specified",
                "nullable": true,
                "type": "string",
              },
              "screenshot": {
                "description": "URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified",
                "nullable": true,
                "type": "string",
              },
            },
            "type": "array",
          },
          "success": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http",
      },
    },
  },
  "info": {
    "contact": {
      "email": "support@firecrawl.dev",
      "name": "Firecrawl Support",
      "url": "https://firecrawl.dev/support",
    },
    "description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
    "title": "Firecrawl API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/crawl": {
      "post": {
        "operationId": "crawlUrls",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "crawlerOptions": {
                    "properties": {
                      "allowBackwardCrawling": {
                        "default": false,
                        "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
                        "type": "boolean",
                      },
                      "allowExternalContentLinks": {
                        "default": false,
                        "description": "Allows the crawler to follow links to external websites.",
                        "type": "boolean",
                      },
                      "excludes": {
                        "description": "URL patterns to exclude",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "generateImgAltText": {
                        "default": false,
                        "description": "Generate alt text for images using LLMs (must have a paid plan)",
                        "type": "boolean",
                      },
                      "ignoreSitemap": {
                        "default": false,
                        "description": "Ignore the website sitemap when crawling",
                        "type": "boolean",
                      },
                      "includes": {
                        "description": "URL patterns to include",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "limit": {
                        "default": 10000,
                        "description": "Maximum number of pages to crawl",
                        "type": "integer",
                      },
                      "maxDepth": {
                        "description": "Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.",
                        "type": "integer",
                      },
                      "mode": {
                        "default": "default",
                        "description": "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.",
                        "enum": [
                          "default",
                          "fast",
                        ],
                        "type": "string",
                      },
                      "returnOnlyUrls": {
                        "default": false,
                        "description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "pageOptions": {
                    "properties": {
                      "fullPageScreenshot": {
                        "default": false,
                        "description": "Include a full page screenshot of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "headers": {
                        "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                        "type": "object",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyIncludeTags": {
                        "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                      "removeTags": {
                        "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                        "items": {
                          "type": "string",
                        },
                        "type": "array",
                      },
                      "replaceAllPathsWithAbsolutePaths": {
                        "default": false,
                        "description": "Replace all relative paths with absolute paths for images and links",
                        "type": "boolean",
                      },
                      "screenshot": {
                        "default": false,
                        "description": "Include a screenshot of the top of the page that you are scraping.",
                        "type": "boolean",
                      },
                      "waitFor": {
                        "default": 0,
                        "description": "Wait x amount of milliseconds for the page to load to fetch content",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                  "url": {
                    "description": "The base URL to start crawling from",
                    "format": "uri",
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CrawlResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Crawl multiple URLs based on options",
        "tags": [
          "Crawling",
        ],
      },
    },
    "/crawl/cancel/{jobId}": {
      "delete": {
        "operationId": "cancelCrawlJob",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "description": "Returns cancelled.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Cancel a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/crawl/status/{jobId}": {
      "get": {
        "operationId": "getCrawlStatus",
        "parameters": [
          {
            "description": "ID of the crawl job",
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current": {
                      "description": "Current page number",
                      "type": "integer",
                    },
                    "data": {
                      "description": "Data returned from the job (null when it is in progress)",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "partial_data": {
                      "description": "Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.",
                      "items": {
                        "$ref": "#/components/schemas/CrawlStatusResponseObj",
                      },
                      "type": "array",
                    },
                    "status": {
                      "description": "Status of the job (completed, active, failed, paused)",
                      "type": "string",
                    },
                    "total": {
                      "description": "Total number of pages",
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Get the status of a crawl job",
        "tags": [
          "Crawl",
        ],
      },
    },
    "/scrape": {
      "post": {
        "operationId": "scrape",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "excludeTags": {
                    "description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "formats": {
                    "default": [
                      "markdown",
                    ],
                    "description": "Specific formats to return.

 - markdown: The page in Markdown format.
 - html: The page's HTML, trimmed to include only meaningful content.
 - rawHtml: The page's original HTML.
 - links: The links on the page.
 - screenshot: A screenshot of the top of the page.
 - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)",
                    "items": {
                      "enum": [
                        "markdown",
                        "html",
                        "rawHtml",
                        "links",
                        "screenshot",
                        "screenshot@fullPage",
                      ],
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "headers": {
                    "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc.",
                    "type": "object",
                  },
                  "includeTags": {
                    "description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'",
                    "items": {
                      "type": "string",
                    },
                    "type": "array",
                  },
                  "onlyMainContent": {
                    "default": true,
                    "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                    "type": "boolean",
                  },
                  "timeout": {
                    "default": 30000,
                    "description": "Timeout in milliseconds for the request",
                    "type": "integer",
                  },
                  "url": {
                    "description": "The URL to scrape",
                    "format": "uri",
                    "type": "string",
                  },
                  "waitFor": {
                    "default": 0,
                    "description": "Wait x amount of milliseconds for the page to load to fetch content",
                    "type": "integer",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScrapeResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Scrape a single URL",
        "tags": [
          "Scraping",
        ],
      },
    },
    "/search": {
      "post": {
        "operationId": "searchGoogle",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "pageOptions": {
                    "properties": {
                      "fetchPageContent": {
                        "default": true,
                        "description": "Fetch the content of each page. If false, defaults to a basic fast serp API.",
                        "type": "boolean",
                      },
                      "includeHtml": {
                        "default": false,
                        "description": "Include the HTML version of the content on page. Will output a html key in the response.",
                        "type": "boolean",
                      },
                      "includeRawHtml": {
                        "default": false,
                        "description": "Include the raw HTML content of the page. Will output a rawHtml key in the response.",
                        "type": "boolean",
                      },
                      "onlyMainContent": {
                        "default": false,
                        "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
                        "type": "boolean",
                      },
                    },
                    "type": "object",
                  },
                  "query": {
                    "description": "The query to search for",
                    "format": "uri",
                    "type": "string",
                  },
                  "searchOptions": {
                    "properties": {
                      "limit": {
                        "description": "Maximum number of results. Max is 20 during beta.",
                        "type": "integer",
                      },
                    },
                    "type": "object",
                  },
                },
                "required": [
                  "query",
                ],
                "type": "object",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Payment required to access this resource.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Payment required",
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "Request rate limit exceeded. Please wait and try again later.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Too many requests",
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "example": "An unexpected error occurred on the server.",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Server error",
          },
        },
        "security": [
          {
            "bearerAuth": [],
          },
        ],
        "summary": "Search for a keyword in Google, returns top page results with markdown content for each page",
        "tags": [
          "Search",
        ],
      },
    },
  },
  "security": [
    {
      "bearerAuth": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.firecrawl.dev/v0",
    },
  ],
}
`;

exports[`validateOpenAPISpec > notion.json (file url) 1`] = `
{
  "components": {
    "schemas": {
      "AnnotationRequest": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "AnnotationResponse": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "required": [
          "bold",
          "italic",
          "strikethrough",
          "underline",
          "code",
          "color",
        ],
        "type": "object",
      },
      "AppendBlockChildrenParameters": {
        "properties": {
          "children": {
            "items": {
              "$ref": "#/components/schemas/BlockObjectRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "children",
        ],
        "type": "object",
      },
      "AppendBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "BlockObjectRequest": {
        "oneOf": [
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "paragraph": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "paragraph",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "paragraph",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_1": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_1",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_1",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_2": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_2",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_2",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_3": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_3",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_3",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bulleted_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bulleted_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bulleted_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "numbered_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "numbered_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "numbered_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "to_do": {
                "properties": {
                  "checked": {
                    "type": "boolean",
                  },
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "checked",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "to_do",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "to_do",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "toggle": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "toggle",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "toggle",
            ],
            "type": "object",
          },
          {
            "properties": {
              "code": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "language": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "language",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "code",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "code",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_page": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_database": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_database",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_database",
            ],
            "type": "object",
          },
          {
            "properties": {
              "embed": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "embed",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "embed",
            ],
            "type": "object",
          },
          {
            "properties": {
              "image": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "image",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "image",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "video",
                ],
                "type": "string",
              },
              "video": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
            },
            "required": [
              "object",
              "type",
              "video",
            ],
            "type": "object",
          },
          {
            "properties": {
              "file": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "file",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "file",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "pdf": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "pdf",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "pdf",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bookmark": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bookmark",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bookmark",
            ],
            "type": "object",
          },
          {
            "properties": {
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "equation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "divider": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "divider",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "divider",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_of_contents": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_of_contents",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_of_contents",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column_list": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column_list",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column_list",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column",
            ],
            "type": "object",
          },
          {
            "properties": {
              "link_to_page": {
                "oneOf": [
                  {
                    "properties": {
                      "page_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "page_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "page_id",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "database_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "database_id",
                    ],
                    "type": "object",
                  },
                ],
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "link_to_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "link_to_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "has_column_header": {
                    "type": "boolean",
                  },
                  "has_row_header": {
                    "type": "boolean",
                  },
                  "table_width": {
                    "type": "integer",
                  },
                },
                "required": [
                  "table_width",
                  "children",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_row": {
                "properties": {
                  "cells": {
                    "items": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "cells",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_row",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_row",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "synced_block": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "synced_from": {
                    "oneOf": [
                      {
                        "properties": {
                          "block_id": {
                            "type": "string",
                          },
                          "type": {
                            "enum": [
                              "block_id",
                            ],
                            "type": "string",
                          },
                        },
                        "required": [
                          "type",
                          "block_id",
                        ],
                        "type": "object",
                      },
                      {
                        "type": "null",
                      },
                    ],
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "synced_block",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "synced_block",
            ],
            "type": "object",
          },
        ],
      },
      "BlockObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "has_children": {
            "type": "boolean",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "created_time",
          "last_edited_time",
          "has_children",
          "archived",
        ],
        "type": "object",
      },
      "CheckboxPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "boolean",
          },
          "equals": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "CheckboxPropertyResponse": {
        "properties": {
          "checkbox": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "checkbox",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "checkbox",
        ],
        "type": "object",
      },
      "CommentObjectResponse": {
        "properties": {
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "discussion_id": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "block_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "block_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "block_id",
                ],
                "type": "object",
              },
            ],
          },
          "rich_text": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "id",
          "parent",
          "discussion_id",
          "rich_text",
          "created_by",
          "created_time",
          "last_edited_time",
        ],
        "type": "object",
      },
      "CompoundFilter": {
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "CreateCommentParameters": {
        "oneOf": [
          {
            "properties": {
              "parent": {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "page_id",
                ],
                "type": "object",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "parent",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "discussion_id": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "discussion_id",
              "rich_text",
            ],
            "type": "object",
          },
        ],
      },
      "CreateDatabaseParameters": {
        "properties": {
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertySchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "parent",
          "properties",
          "title",
        ],
        "type": "object",
      },
      "CreatePageParameters": {
        "properties": {
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
            "type": "object",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "required": [
          "parent",
          "properties",
        ],
        "type": "object",
      },
      "CreatedByPropertyResponse": {
        "properties": {
          "created_by": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_by",
        ],
        "type": "object",
      },
      "CreatedTimePropertyResponse": {
        "properties": {
          "created_time": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_time",
        ],
        "type": "object",
      },
      "DatabaseObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "id": {
            "type": "string",
          },
          "is_inline": {
            "type": "boolean",
          },
          "last_edited_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "created_by",
          "last_edited_time",
          "last_edited_by",
          "title",
          "description",
          "is_inline",
          "properties",
          "parent",
          "url",
          "archived",
        ],
        "type": "object",
      },
      "DatabasePropertyConfigResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TitlePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RichTextPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/NumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/SelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/MultiSelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/DatePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PeoplePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FilePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CheckboxPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/URLPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/EmailPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PhoneNumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FormulaPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RelationPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RollupPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedByPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedByPropertyResponse",
          },
        ],
      },
      "DatePropertyFilter": {
        "properties": {
          "after": {
            "type": "string",
          },
          "before": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "next_month": {},
          "next_week": {},
          "next_year": {},
          "on_or_after": {
            "type": "string",
          },
          "on_or_before": {
            "type": "string",
          },
          "past_month": {},
          "past_week": {},
          "past_year": {},
        },
        "type": "object",
      },
      "DatePropertyResponse": {
        "properties": {
          "date": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "date",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "date",
        ],
        "type": "object",
      },
      "DateRequest": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
        ],
        "type": "object",
      },
      "DateResponse": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
          "end",
          "time_zone",
        ],
        "type": "object",
      },
      "EmailPropertyResponse": {
        "properties": {
          "email": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "email",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "email",
        ],
        "type": "object",
      },
      "EquationRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "equation",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "equation",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "FilePropertyResponse": {
        "properties": {
          "files": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "files",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "files",
        ],
        "type": "object",
      },
      "FilesPropertyFilter": {
        "properties": {
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "FormulaPropertyResponse": {
        "properties": {
          "formula": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "formula",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "formula",
        ],
        "type": "object",
      },
      "LastEditedByPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_by": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_by",
        ],
        "type": "object",
      },
      "LastEditedTimePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_time",
        ],
        "type": "object",
      },
      "ListBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListCommentsResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/CommentObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListDatabasesResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListUsersResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/UserObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "MentionRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "mention": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "date": {
                    "$ref": "#/components/schemas/DateResponse",
                  },
                  "type": {
                    "enum": [
                      "date",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "date",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "link_preview": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "link_preview",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "link_preview",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "page": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "page",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "database",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database",
                ],
                "type": "object",
              },
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "mention",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "mention",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "MultiSelectPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "MultiSelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "multi_select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "multi_select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "multi_select",
        ],
        "type": "object",
      },
      "NumberPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "number",
          },
          "equals": {
            "type": "number",
          },
          "greater_than": {
            "type": "number",
          },
          "greater_than_or_equal_to": {
            "type": "number",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "less_than": {
            "type": "number",
          },
          "less_than_or_equal_to": {
            "type": "number",
          },
        },
        "type": "object",
      },
      "NumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "number": {
            "properties": {
              "format": {
                "type": "string",
              },
            },
            "required": [
              "format",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "number",
        ],
        "type": "object",
      },
      "OauthTokenParameters": {
        "properties": {
          "code": {
            "type": "string",
          },
          "external_account": {
            "properties": {
              "key": {
                "type": "string",
              },
              "name": {
                "type": "string",
              },
            },
            "required": [
              "key",
              "name",
            ],
            "type": "object",
          },
          "grant_type": {
            "type": "string",
          },
          "redirect_uri": {
            "type": "string",
          },
        },
        "required": [
          "grant_type",
          "code",
        ],
        "type": "object",
      },
      "OauthTokenResponse": {
        "properties": {
          "access_token": {
            "type": "string",
          },
          "bot_id": {
            "type": "string",
          },
          "duplicated_template_id": {
            "type": [
              "string",
              "null",
            ],
          },
          "owner": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "token_type": {
            "enum": [
              "bearer",
            ],
            "type": "string",
          },
          "workspace_icon": {
            "type": [
              "string",
              "null",
            ],
          },
          "workspace_id": {
            "type": "string",
          },
          "workspace_name": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "access_token",
          "token_type",
          "bot_id",
          "workspace_name",
          "workspace_icon",
          "workspace_id",
          "owner",
          "duplicated_template_id",
        ],
        "type": "object",
      },
      "PageObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "last_edited_time",
          "archived",
          "url",
        ],
        "type": "object",
      },
      "PartialBlockObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialCommentObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialDatabaseObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
        },
        "required": [
          "object",
          "id",
          "properties",
        ],
        "type": "object",
      },
      "PartialPageObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialUserObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PeoplePropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "PeoplePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "people": {
            "type": "object",
          },
          "type": {
            "enum": [
              "people",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "people",
        ],
        "type": "object",
      },
      "PhoneNumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "phone_number": {
            "type": "object",
          },
          "type": {
            "enum": [
              "phone_number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "phone_number",
        ],
        "type": "object",
      },
      "PropertyFilter": {
        "oneOf": [
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "title": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "title",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "rich_text": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "number": {
                "$ref": "#/components/schemas/NumberPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "checkbox": {
                "$ref": "#/components/schemas/CheckboxPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "checkbox",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "select": {
                "$ref": "#/components/schemas/SelectPropertyFilter",
              },
            },
            "required": [
              "property",
              "select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "multi_select": {
                "$ref": "#/components/schemas/MultiSelectPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "multi_select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "date": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "date",
            ],
            "type": "object",
          },
          {
            "properties": {
              "people": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "people",
            ],
            "type": "object",
          },
          {
            "properties": {
              "files": {
                "$ref": "#/components/schemas/FilesPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "files",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "url": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "url",
            ],
            "type": "object",
          },
          {
            "properties": {
              "email": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "email",
            ],
            "type": "object",
          },
          {
            "properties": {
              "phone_number": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "phone_number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "relation": {
                "$ref": "#/components/schemas/RelationPropertyFilter",
              },
            },
            "required": [
              "property",
              "relation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "last_edited_time",
            ],
            "type": "object",
          },
        ],
      },
      "PropertyItemListResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/PropertyItemObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "PropertyItemObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
          "id",
        ],
        "type": "object",
      },
      "PropertySchema": {
        "properties": {
          "name": {
            "type": [
              "string",
              "null",
            ],
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
        ],
        "type": "object",
      },
      "PropertyUpdateSchema": {
        "properties": {
          "name": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "filter": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PropertyFilter",
              },
              {
                "$ref": "#/components/schemas/CompoundFilter",
              },
            ],
          },
          "page_size": {
            "type": "integer",
          },
          "sorts": {
            "items": {
              "oneOf": [
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "property": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "property",
                    "direction",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "timestamp": {
                      "enum": [
                        "created_time",
                        "last_edited_time",
                      ],
                      "type": "string",
                    },
                  },
                  "required": [
                    "timestamp",
                    "direction",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "array",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "RelationPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "RelationPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "relation": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "synced_property_id": {
                "type": "string",
              },
              "synced_property_name": {
                "type": "string",
              },
            },
            "required": [
              "database_id",
              "synced_property_name",
              "synced_property_id",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "relation",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "relation",
        ],
        "type": "object",
      },
      "RichTextItemRequest": {
        "oneOf": [
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "text": {
                "properties": {
                  "content": {
                    "type": "string",
                  },
                  "link": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": [
                      "object",
                      "null",
                    ],
                  },
                },
                "required": [
                  "content",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "text",
                ],
                "type": "string",
              },
            },
            "required": [
              "text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "mention": {
                "oneOf": [
                  {
                    "properties": {
                      "user": {
                        "oneOf": [
                          {
                            "properties": {
                              "id": {
                                "type": "string",
                              },
                            },
                            "required": [
                              "id",
                            ],
                            "type": "object",
                          },
                          {
                            "$ref": "#/components/schemas/UserObjectResponse",
                          },
                        ],
                      },
                    },
                    "required": [
                      "user",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "page": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "page",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "database",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "date": {
                        "$ref": "#/components/schemas/DateRequest",
                      },
                    },
                    "required": [
                      "date",
                    ],
                    "type": "object",
                  },
                ],
              },
              "type": {
                "enum": [
                  "mention",
                ],
                "type": "string",
              },
            },
            "required": [
              "mention",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "equation",
            ],
            "type": "object",
          },
        ],
      },
      "RichTextItemResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/MentionRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/EquationRichTextItemResponse",
          },
        ],
      },
      "RichTextPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rich_text": {
            "type": "object",
          },
          "type": {
            "enum": [
              "rich_text",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rich_text",
        ],
        "type": "object",
      },
      "RollupPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rollup": {
            "properties": {
              "function": {
                "type": "string",
              },
              "relation_property_id": {
                "type": "string",
              },
              "relation_property_name": {
                "type": "string",
              },
              "rollup_property_id": {
                "type": "string",
              },
              "rollup_property_name": {
                "type": "string",
              },
            },
            "required": [
              "relation_property_name",
              "relation_property_id",
              "rollup_property_name",
              "rollup_property_id",
              "function",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "rollup",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rollup",
        ],
        "type": "object",
      },
      "SearchParameters": {
        "properties": {
          "filter": {
            "properties": {
              "property": {
                "enum": [
                  "object",
                ],
                "type": "string",
              },
              "value": {
                "enum": [
                  "page",
                  "database",
                ],
                "type": "string",
              },
            },
            "required": [
              "value",
              "property",
            ],
            "type": "object",
          },
          "page_size": {
            "type": "integer",
          },
          "query": {
            "type": "string",
          },
          "sort": {
            "properties": {
              "direction": {
                "enum": [
                  "ascending",
                  "descending",
                ],
                "type": "string",
              },
              "timestamp": {
                "enum": [
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "direction",
              "timestamp",
            ],
            "type": "object",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "SelectOption": {
        "properties": {
          "color": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
          "color",
        ],
        "type": "object",
      },
      "SelectPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "SelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "select",
        ],
        "type": "object",
      },
      "TextPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "does_not_equal": {
            "type": "string",
          },
          "ends_with": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "starts_with": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "TextRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "text": {
            "properties": {
              "content": {
                "type": "string",
              },
              "link": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": [
                  "object",
                  "null",
                ],
              },
            },
            "required": [
              "content",
              "link",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "text",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "text",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "TitlePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "title": {
            "type": "object",
          },
          "type": {
            "enum": [
              "title",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "title",
        ],
        "type": "object",
      },
      "URLPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "url",
            ],
            "type": "string",
          },
          "url": {
            "type": "object",
          },
        },
        "required": [
          "id",
          "type",
          "url",
        ],
        "type": "object",
      },
      "UpdateBlockParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "bookmark": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "breadcrumb": {
            "type": "object",
          },
          "bulleted_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "code": {
            "properties": {
              "language": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "column": {
            "type": "object",
          },
          "column_list": {
            "type": "object",
          },
          "divider": {
            "type": "object",
          },
          "embed": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "file": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "heading_1": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_2": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_3": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "image": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "link_to_page": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "page_id": {
                "type": "string",
              },
              "type": {
                "enum": [
                  "page_id",
                  "database_id",
                ],
                "type": "string",
              },
            },
            "type": "object",
          },
          "numbered_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "paragraph": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "pdf": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "quote": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "table_of_contents": {
            "properties": {
              "color": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "table_row": {
            "properties": {
              "cells": {
                "items": {
                  "items": {
                    "$ref": "#/components/schemas/RichTextItemRequest",
                  },
                  "type": "array",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "to_do": {
            "properties": {
              "checked": {
                "type": "boolean",
              },
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "toggle": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "video": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UpdateDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "emoji",
                  "type",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertyUpdateSchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "UpdatePageParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UserObjectResponse": {
        "properties": {
          "avatar_url": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
          "type": {
            "enum": [
              "person",
              "bot",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "name",
          "avatar_url",
        ],
        "type": "object",
      },
    },
    "securitySchemes": {
      "oauth2": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.notion.com/v1/oauth/authorize",
            "scopes": {},
            "tokenUrl": "https://api.notion.com/v1/oauth/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "API specification for Notion",
    "title": "Notion API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/blocks/{block_id}": {
      "delete": {
        "operationId": "deleteBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Delete block",
      },
      "get": {
        "operationId": "getBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get block",
      },
      "patch": {
        "operationId": "updateBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlockParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update block",
      },
    },
    "/blocks/{block_id}/children": {
      "get": {
        "operationId": "listBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List block children",
      },
      "patch": {
        "operationId": "appendBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppendBlockChildrenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppendBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Append block children",
      },
    },
    "/comments": {
      "get": {
        "operationId": "listComments",
        "parameters": [
          {
            "in": "query",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListCommentsResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List comments",
      },
      "post": {
        "operationId": "createComment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCommentParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CommentObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialCommentObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create comment",
      },
    },
    "/databases": {
      "get": {
        "operationId": "listDatabases",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListDatabasesResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List databases",
      },
      "post": {
        "operationId": "createDatabase",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create database",
      },
    },
    "/databases/{database_id}": {
      "get": {
        "operationId": "getDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get database",
      },
      "patch": {
        "operationId": "updateDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update database",
      },
    },
    "/databases/{database_id}/query": {
      "post": {
        "operationId": "queryDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QueryDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryDatabaseResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Query database",
      },
    },
    "/oauth/token": {
      "post": {
        "operationId": "oauthToken",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OauthTokenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OauthTokenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "OAuth token",
      },
    },
    "/pages": {
      "post": {
        "operationId": "createPage",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create page",
      },
    },
    "/pages/{page_id}": {
      "get": {
        "operationId": "getPage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page",
      },
      "patch": {
        "operationId": "updatePage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update page",
      },
    },
    "/pages/{page_id}/properties/{property_id}": {
      "get": {
        "operationId": "getPageProperty",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "path",
            "name": "property_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PropertyItemObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PropertyItemListResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page property",
      },
    },
    "/search": {
      "post": {
        "operationId": "search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Search",
      },
    },
    "/users": {
      "get": {
        "operationId": "listUsers",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListUsersResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List users",
      },
    },
    "/users/me": {
      "get": {
        "operationId": "getSelf",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get current user",
      },
    },
    "/users/{user_id}": {
      "get": {
        "operationId": "getUser",
        "parameters": [
          {
            "in": "path",
            "name": "user_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get user",
      },
    },
  },
  "security": [
    {
      "oauth2": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.notion.so",
    },
  ],
}
`;

exports[`validateOpenAPISpec > notion.json (http url) 1`] = `
{
  "components": {
    "schemas": {
      "AnnotationRequest": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "AnnotationResponse": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "required": [
          "bold",
          "italic",
          "strikethrough",
          "underline",
          "code",
          "color",
        ],
        "type": "object",
      },
      "AppendBlockChildrenParameters": {
        "properties": {
          "children": {
            "items": {
              "$ref": "#/components/schemas/BlockObjectRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "children",
        ],
        "type": "object",
      },
      "AppendBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "BlockObjectRequest": {
        "oneOf": [
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "paragraph": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "paragraph",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "paragraph",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_1": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_1",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_1",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_2": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_2",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_2",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_3": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_3",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_3",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bulleted_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bulleted_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bulleted_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "numbered_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "numbered_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "numbered_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "to_do": {
                "properties": {
                  "checked": {
                    "type": "boolean",
                  },
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "checked",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "to_do",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "to_do",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "toggle": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "toggle",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "toggle",
            ],
            "type": "object",
          },
          {
            "properties": {
              "code": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "language": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "language",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "code",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "code",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_page": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_database": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_database",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_database",
            ],
            "type": "object",
          },
          {
            "properties": {
              "embed": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "embed",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "embed",
            ],
            "type": "object",
          },
          {
            "properties": {
              "image": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "image",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "image",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "video",
                ],
                "type": "string",
              },
              "video": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
            },
            "required": [
              "object",
              "type",
              "video",
            ],
            "type": "object",
          },
          {
            "properties": {
              "file": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "file",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "file",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "pdf": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "pdf",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "pdf",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bookmark": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bookmark",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bookmark",
            ],
            "type": "object",
          },
          {
            "properties": {
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "equation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "divider": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "divider",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "divider",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_of_contents": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_of_contents",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_of_contents",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column_list": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column_list",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column_list",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column",
            ],
            "type": "object",
          },
          {
            "properties": {
              "link_to_page": {
                "oneOf": [
                  {
                    "properties": {
                      "page_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "page_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "page_id",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "database_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "database_id",
                    ],
                    "type": "object",
                  },
                ],
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "link_to_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "link_to_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "has_column_header": {
                    "type": "boolean",
                  },
                  "has_row_header": {
                    "type": "boolean",
                  },
                  "table_width": {
                    "type": "integer",
                  },
                },
                "required": [
                  "table_width",
                  "children",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_row": {
                "properties": {
                  "cells": {
                    "items": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "cells",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_row",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_row",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "synced_block": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "synced_from": {
                    "oneOf": [
                      {
                        "properties": {
                          "block_id": {
                            "type": "string",
                          },
                          "type": {
                            "enum": [
                              "block_id",
                            ],
                            "type": "string",
                          },
                        },
                        "required": [
                          "type",
                          "block_id",
                        ],
                        "type": "object",
                      },
                      {
                        "type": "null",
                      },
                    ],
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "synced_block",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "synced_block",
            ],
            "type": "object",
          },
        ],
      },
      "BlockObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "has_children": {
            "type": "boolean",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "created_time",
          "last_edited_time",
          "has_children",
          "archived",
        ],
        "type": "object",
      },
      "CheckboxPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "boolean",
          },
          "equals": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "CheckboxPropertyResponse": {
        "properties": {
          "checkbox": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "checkbox",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "checkbox",
        ],
        "type": "object",
      },
      "CommentObjectResponse": {
        "properties": {
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "discussion_id": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "block_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "block_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "block_id",
                ],
                "type": "object",
              },
            ],
          },
          "rich_text": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "id",
          "parent",
          "discussion_id",
          "rich_text",
          "created_by",
          "created_time",
          "last_edited_time",
        ],
        "type": "object",
      },
      "CompoundFilter": {
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "CreateCommentParameters": {
        "oneOf": [
          {
            "properties": {
              "parent": {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "page_id",
                ],
                "type": "object",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "parent",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "discussion_id": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "discussion_id",
              "rich_text",
            ],
            "type": "object",
          },
        ],
      },
      "CreateDatabaseParameters": {
        "properties": {
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertySchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "parent",
          "properties",
          "title",
        ],
        "type": "object",
      },
      "CreatePageParameters": {
        "properties": {
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
            "type": "object",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "required": [
          "parent",
          "properties",
        ],
        "type": "object",
      },
      "CreatedByPropertyResponse": {
        "properties": {
          "created_by": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_by",
        ],
        "type": "object",
      },
      "CreatedTimePropertyResponse": {
        "properties": {
          "created_time": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_time",
        ],
        "type": "object",
      },
      "DatabaseObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "id": {
            "type": "string",
          },
          "is_inline": {
            "type": "boolean",
          },
          "last_edited_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "created_by",
          "last_edited_time",
          "last_edited_by",
          "title",
          "description",
          "is_inline",
          "properties",
          "parent",
          "url",
          "archived",
        ],
        "type": "object",
      },
      "DatabasePropertyConfigResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TitlePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RichTextPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/NumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/SelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/MultiSelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/DatePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PeoplePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FilePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CheckboxPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/URLPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/EmailPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PhoneNumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FormulaPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RelationPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RollupPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedByPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedByPropertyResponse",
          },
        ],
      },
      "DatePropertyFilter": {
        "properties": {
          "after": {
            "type": "string",
          },
          "before": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "next_month": {},
          "next_week": {},
          "next_year": {},
          "on_or_after": {
            "type": "string",
          },
          "on_or_before": {
            "type": "string",
          },
          "past_month": {},
          "past_week": {},
          "past_year": {},
        },
        "type": "object",
      },
      "DatePropertyResponse": {
        "properties": {
          "date": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "date",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "date",
        ],
        "type": "object",
      },
      "DateRequest": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
        ],
        "type": "object",
      },
      "DateResponse": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
          "end",
          "time_zone",
        ],
        "type": "object",
      },
      "EmailPropertyResponse": {
        "properties": {
          "email": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "email",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "email",
        ],
        "type": "object",
      },
      "EquationRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "equation",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "equation",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "FilePropertyResponse": {
        "properties": {
          "files": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "files",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "files",
        ],
        "type": "object",
      },
      "FilesPropertyFilter": {
        "properties": {
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "FormulaPropertyResponse": {
        "properties": {
          "formula": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "formula",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "formula",
        ],
        "type": "object",
      },
      "LastEditedByPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_by": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_by",
        ],
        "type": "object",
      },
      "LastEditedTimePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_time",
        ],
        "type": "object",
      },
      "ListBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListCommentsResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/CommentObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListDatabasesResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListUsersResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/UserObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "MentionRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "mention": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "date": {
                    "$ref": "#/components/schemas/DateResponse",
                  },
                  "type": {
                    "enum": [
                      "date",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "date",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "link_preview": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "link_preview",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "link_preview",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "page": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "page",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "database",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database",
                ],
                "type": "object",
              },
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "mention",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "mention",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "MultiSelectPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "MultiSelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "multi_select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "multi_select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "multi_select",
        ],
        "type": "object",
      },
      "NumberPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "number",
          },
          "equals": {
            "type": "number",
          },
          "greater_than": {
            "type": "number",
          },
          "greater_than_or_equal_to": {
            "type": "number",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "less_than": {
            "type": "number",
          },
          "less_than_or_equal_to": {
            "type": "number",
          },
        },
        "type": "object",
      },
      "NumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "number": {
            "properties": {
              "format": {
                "type": "string",
              },
            },
            "required": [
              "format",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "number",
        ],
        "type": "object",
      },
      "OauthTokenParameters": {
        "properties": {
          "code": {
            "type": "string",
          },
          "external_account": {
            "properties": {
              "key": {
                "type": "string",
              },
              "name": {
                "type": "string",
              },
            },
            "required": [
              "key",
              "name",
            ],
            "type": "object",
          },
          "grant_type": {
            "type": "string",
          },
          "redirect_uri": {
            "type": "string",
          },
        },
        "required": [
          "grant_type",
          "code",
        ],
        "type": "object",
      },
      "OauthTokenResponse": {
        "properties": {
          "access_token": {
            "type": "string",
          },
          "bot_id": {
            "type": "string",
          },
          "duplicated_template_id": {
            "type": [
              "string",
              "null",
            ],
          },
          "owner": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "token_type": {
            "enum": [
              "bearer",
            ],
            "type": "string",
          },
          "workspace_icon": {
            "type": [
              "string",
              "null",
            ],
          },
          "workspace_id": {
            "type": "string",
          },
          "workspace_name": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "access_token",
          "token_type",
          "bot_id",
          "workspace_name",
          "workspace_icon",
          "workspace_id",
          "owner",
          "duplicated_template_id",
        ],
        "type": "object",
      },
      "PageObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "last_edited_time",
          "archived",
          "url",
        ],
        "type": "object",
      },
      "PartialBlockObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialCommentObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialDatabaseObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
        },
        "required": [
          "object",
          "id",
          "properties",
        ],
        "type": "object",
      },
      "PartialPageObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialUserObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PeoplePropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "PeoplePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "people": {
            "type": "object",
          },
          "type": {
            "enum": [
              "people",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "people",
        ],
        "type": "object",
      },
      "PhoneNumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "phone_number": {
            "type": "object",
          },
          "type": {
            "enum": [
              "phone_number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "phone_number",
        ],
        "type": "object",
      },
      "PropertyFilter": {
        "oneOf": [
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "title": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "title",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "rich_text": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "number": {
                "$ref": "#/components/schemas/NumberPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "checkbox": {
                "$ref": "#/components/schemas/CheckboxPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "checkbox",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "select": {
                "$ref": "#/components/schemas/SelectPropertyFilter",
              },
            },
            "required": [
              "property",
              "select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "multi_select": {
                "$ref": "#/components/schemas/MultiSelectPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "multi_select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "date": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "date",
            ],
            "type": "object",
          },
          {
            "properties": {
              "people": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "people",
            ],
            "type": "object",
          },
          {
            "properties": {
              "files": {
                "$ref": "#/components/schemas/FilesPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "files",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "url": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "url",
            ],
            "type": "object",
          },
          {
            "properties": {
              "email": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "email",
            ],
            "type": "object",
          },
          {
            "properties": {
              "phone_number": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "phone_number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "relation": {
                "$ref": "#/components/schemas/RelationPropertyFilter",
              },
            },
            "required": [
              "property",
              "relation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "last_edited_time",
            ],
            "type": "object",
          },
        ],
      },
      "PropertyItemListResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/PropertyItemObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "PropertyItemObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
          "id",
        ],
        "type": "object",
      },
      "PropertySchema": {
        "properties": {
          "name": {
            "type": [
              "string",
              "null",
            ],
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
        ],
        "type": "object",
      },
      "PropertyUpdateSchema": {
        "properties": {
          "name": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "filter": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PropertyFilter",
              },
              {
                "$ref": "#/components/schemas/CompoundFilter",
              },
            ],
          },
          "page_size": {
            "type": "integer",
          },
          "sorts": {
            "items": {
              "oneOf": [
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "property": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "property",
                    "direction",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "timestamp": {
                      "enum": [
                        "created_time",
                        "last_edited_time",
                      ],
                      "type": "string",
                    },
                  },
                  "required": [
                    "timestamp",
                    "direction",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "array",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "RelationPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "RelationPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "relation": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "synced_property_id": {
                "type": "string",
              },
              "synced_property_name": {
                "type": "string",
              },
            },
            "required": [
              "database_id",
              "synced_property_name",
              "synced_property_id",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "relation",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "relation",
        ],
        "type": "object",
      },
      "RichTextItemRequest": {
        "oneOf": [
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "text": {
                "properties": {
                  "content": {
                    "type": "string",
                  },
                  "link": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": [
                      "object",
                      "null",
                    ],
                  },
                },
                "required": [
                  "content",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "text",
                ],
                "type": "string",
              },
            },
            "required": [
              "text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "mention": {
                "oneOf": [
                  {
                    "properties": {
                      "user": {
                        "oneOf": [
                          {
                            "properties": {
                              "id": {
                                "type": "string",
                              },
                            },
                            "required": [
                              "id",
                            ],
                            "type": "object",
                          },
                          {
                            "$ref": "#/components/schemas/UserObjectResponse",
                          },
                        ],
                      },
                    },
                    "required": [
                      "user",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "page": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "page",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "database",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "date": {
                        "$ref": "#/components/schemas/DateRequest",
                      },
                    },
                    "required": [
                      "date",
                    ],
                    "type": "object",
                  },
                ],
              },
              "type": {
                "enum": [
                  "mention",
                ],
                "type": "string",
              },
            },
            "required": [
              "mention",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "equation",
            ],
            "type": "object",
          },
        ],
      },
      "RichTextItemResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/MentionRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/EquationRichTextItemResponse",
          },
        ],
      },
      "RichTextPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rich_text": {
            "type": "object",
          },
          "type": {
            "enum": [
              "rich_text",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rich_text",
        ],
        "type": "object",
      },
      "RollupPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rollup": {
            "properties": {
              "function": {
                "type": "string",
              },
              "relation_property_id": {
                "type": "string",
              },
              "relation_property_name": {
                "type": "string",
              },
              "rollup_property_id": {
                "type": "string",
              },
              "rollup_property_name": {
                "type": "string",
              },
            },
            "required": [
              "relation_property_name",
              "relation_property_id",
              "rollup_property_name",
              "rollup_property_id",
              "function",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "rollup",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rollup",
        ],
        "type": "object",
      },
      "SearchParameters": {
        "properties": {
          "filter": {
            "properties": {
              "property": {
                "enum": [
                  "object",
                ],
                "type": "string",
              },
              "value": {
                "enum": [
                  "page",
                  "database",
                ],
                "type": "string",
              },
            },
            "required": [
              "value",
              "property",
            ],
            "type": "object",
          },
          "page_size": {
            "type": "integer",
          },
          "query": {
            "type": "string",
          },
          "sort": {
            "properties": {
              "direction": {
                "enum": [
                  "ascending",
                  "descending",
                ],
                "type": "string",
              },
              "timestamp": {
                "enum": [
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "direction",
              "timestamp",
            ],
            "type": "object",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "SelectOption": {
        "properties": {
          "color": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
          "color",
        ],
        "type": "object",
      },
      "SelectPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "SelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "select",
        ],
        "type": "object",
      },
      "TextPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "does_not_equal": {
            "type": "string",
          },
          "ends_with": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "starts_with": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "TextRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "text": {
            "properties": {
              "content": {
                "type": "string",
              },
              "link": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": [
                  "object",
                  "null",
                ],
              },
            },
            "required": [
              "content",
              "link",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "text",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "text",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "TitlePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "title": {
            "type": "object",
          },
          "type": {
            "enum": [
              "title",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "title",
        ],
        "type": "object",
      },
      "URLPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "url",
            ],
            "type": "string",
          },
          "url": {
            "type": "object",
          },
        },
        "required": [
          "id",
          "type",
          "url",
        ],
        "type": "object",
      },
      "UpdateBlockParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "bookmark": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "breadcrumb": {
            "type": "object",
          },
          "bulleted_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "code": {
            "properties": {
              "language": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "column": {
            "type": "object",
          },
          "column_list": {
            "type": "object",
          },
          "divider": {
            "type": "object",
          },
          "embed": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "file": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "heading_1": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_2": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_3": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "image": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "link_to_page": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "page_id": {
                "type": "string",
              },
              "type": {
                "enum": [
                  "page_id",
                  "database_id",
                ],
                "type": "string",
              },
            },
            "type": "object",
          },
          "numbered_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "paragraph": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "pdf": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "quote": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "table_of_contents": {
            "properties": {
              "color": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "table_row": {
            "properties": {
              "cells": {
                "items": {
                  "items": {
                    "$ref": "#/components/schemas/RichTextItemRequest",
                  },
                  "type": "array",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "to_do": {
            "properties": {
              "checked": {
                "type": "boolean",
              },
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "toggle": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "video": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UpdateDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "emoji",
                  "type",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertyUpdateSchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "UpdatePageParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UserObjectResponse": {
        "properties": {
          "avatar_url": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
          "type": {
            "enum": [
              "person",
              "bot",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "name",
          "avatar_url",
        ],
        "type": "object",
      },
    },
    "securitySchemes": {
      "oauth2": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.notion.com/v1/oauth/authorize",
            "scopes": {},
            "tokenUrl": "https://api.notion.com/v1/oauth/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "API specification for Notion",
    "title": "Notion API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/blocks/{block_id}": {
      "delete": {
        "operationId": "deleteBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Delete block",
      },
      "get": {
        "operationId": "getBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get block",
      },
      "patch": {
        "operationId": "updateBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlockParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update block",
      },
    },
    "/blocks/{block_id}/children": {
      "get": {
        "operationId": "listBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List block children",
      },
      "patch": {
        "operationId": "appendBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppendBlockChildrenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppendBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Append block children",
      },
    },
    "/comments": {
      "get": {
        "operationId": "listComments",
        "parameters": [
          {
            "in": "query",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListCommentsResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List comments",
      },
      "post": {
        "operationId": "createComment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCommentParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CommentObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialCommentObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create comment",
      },
    },
    "/databases": {
      "get": {
        "operationId": "listDatabases",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListDatabasesResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List databases",
      },
      "post": {
        "operationId": "createDatabase",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create database",
      },
    },
    "/databases/{database_id}": {
      "get": {
        "operationId": "getDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get database",
      },
      "patch": {
        "operationId": "updateDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update database",
      },
    },
    "/databases/{database_id}/query": {
      "post": {
        "operationId": "queryDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QueryDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryDatabaseResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Query database",
      },
    },
    "/oauth/token": {
      "post": {
        "operationId": "oauthToken",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OauthTokenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OauthTokenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "OAuth token",
      },
    },
    "/pages": {
      "post": {
        "operationId": "createPage",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create page",
      },
    },
    "/pages/{page_id}": {
      "get": {
        "operationId": "getPage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page",
      },
      "patch": {
        "operationId": "updatePage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update page",
      },
    },
    "/pages/{page_id}/properties/{property_id}": {
      "get": {
        "operationId": "getPageProperty",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "path",
            "name": "property_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PropertyItemObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PropertyItemListResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page property",
      },
    },
    "/search": {
      "post": {
        "operationId": "search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Search",
      },
    },
    "/users": {
      "get": {
        "operationId": "listUsers",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListUsersResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List users",
      },
    },
    "/users/me": {
      "get": {
        "operationId": "getSelf",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get current user",
      },
    },
    "/users/{user_id}": {
      "get": {
        "operationId": "getUser",
        "parameters": [
          {
            "in": "path",
            "name": "user_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get user",
      },
    },
  },
  "security": [
    {
      "oauth2": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.notion.so",
    },
  ],
}
`;

exports[`validateOpenAPISpec > notion.json (string) 1`] = `
{
  "components": {
    "schemas": {
      "AnnotationRequest": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "AnnotationResponse": {
        "properties": {
          "bold": {
            "type": "boolean",
          },
          "code": {
            "type": "boolean",
          },
          "color": {
            "enum": [
              "default",
              "gray",
              "brown",
              "orange",
              "yellow",
              "green",
              "blue",
              "purple",
              "pink",
              "red",
              "gray_background",
              "brown_background",
              "orange_background",
              "yellow_background",
              "green_background",
              "blue_background",
              "purple_background",
              "pink_background",
              "red_background",
            ],
            "type": "string",
          },
          "italic": {
            "type": "boolean",
          },
          "strikethrough": {
            "type": "boolean",
          },
          "underline": {
            "type": "boolean",
          },
        },
        "required": [
          "bold",
          "italic",
          "strikethrough",
          "underline",
          "code",
          "color",
        ],
        "type": "object",
      },
      "AppendBlockChildrenParameters": {
        "properties": {
          "children": {
            "items": {
              "$ref": "#/components/schemas/BlockObjectRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "children",
        ],
        "type": "object",
      },
      "AppendBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "BlockObjectRequest": {
        "oneOf": [
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "paragraph": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "paragraph",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "paragraph",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_1": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_1",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_1",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_2": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_2",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_2",
            ],
            "type": "object",
          },
          {
            "properties": {
              "heading_3": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "heading_3",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "heading_3",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bulleted_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bulleted_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bulleted_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "numbered_list_item": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "numbered_list_item",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "numbered_list_item",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "to_do": {
                "properties": {
                  "checked": {
                    "type": "boolean",
                  },
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "checked",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "to_do",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "to_do",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "toggle": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "toggle",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "toggle",
            ],
            "type": "object",
          },
          {
            "properties": {
              "code": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "language": {
                    "type": "string",
                  },
                  "rich_text": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "rich_text",
                  "language",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "code",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "code",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_page": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "child_database": {
                "properties": {
                  "title": {
                    "type": "string",
                  },
                },
                "required": [
                  "title",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "child_database",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "child_database",
            ],
            "type": "object",
          },
          {
            "properties": {
              "embed": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "embed",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "embed",
            ],
            "type": "object",
          },
          {
            "properties": {
              "image": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "image",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "image",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "video",
                ],
                "type": "string",
              },
              "video": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
            },
            "required": [
              "object",
              "type",
              "video",
            ],
            "type": "object",
          },
          {
            "properties": {
              "file": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "file",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "file",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "pdf": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                },
                "required": [
                  "external",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "pdf",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "pdf",
            ],
            "type": "object",
          },
          {
            "properties": {
              "bookmark": {
                "properties": {
                  "caption": {
                    "items": {
                      "$ref": "#/components/schemas/RichTextItemRequest",
                    },
                    "type": "array",
                  },
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "bookmark",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "bookmark",
            ],
            "type": "object",
          },
          {
            "properties": {
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "equation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "divider": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "divider",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "divider",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_of_contents": {
                "properties": {
                  "color": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_of_contents",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_of_contents",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column_list": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column_list",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column_list",
            ],
            "type": "object",
          },
          {
            "properties": {
              "column": {
                "type": "object",
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "column",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "column",
            ],
            "type": "object",
          },
          {
            "properties": {
              "link_to_page": {
                "oneOf": [
                  {
                    "properties": {
                      "page_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "page_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "page_id",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database_id": {
                        "type": "string",
                      },
                      "type": {
                        "enum": [
                          "database_id",
                        ],
                        "type": "string",
                      },
                    },
                    "required": [
                      "type",
                      "database_id",
                    ],
                    "type": "object",
                  },
                ],
              },
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "type": {
                "enum": [
                  "link_to_page",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "link_to_page",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "has_column_header": {
                    "type": "boolean",
                  },
                  "has_row_header": {
                    "type": "boolean",
                  },
                  "table_width": {
                    "type": "integer",
                  },
                },
                "required": [
                  "table_width",
                  "children",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "table_row": {
                "properties": {
                  "cells": {
                    "items": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                    "type": "array",
                  },
                },
                "required": [
                  "cells",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "table_row",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "table_row",
            ],
            "type": "object",
          },
          {
            "properties": {
              "object": {
                "enum": [
                  "block",
                ],
                "type": "string",
              },
              "synced_block": {
                "properties": {
                  "children": {
                    "items": {
                      "$ref": "#/components/schemas/BlockObjectRequest",
                    },
                    "type": "array",
                  },
                  "synced_from": {
                    "oneOf": [
                      {
                        "properties": {
                          "block_id": {
                            "type": "string",
                          },
                          "type": {
                            "enum": [
                              "block_id",
                            ],
                            "type": "string",
                          },
                        },
                        "required": [
                          "type",
                          "block_id",
                        ],
                        "type": "object",
                      },
                      {
                        "type": "null",
                      },
                    ],
                  },
                },
                "type": "object",
              },
              "type": {
                "enum": [
                  "synced_block",
                ],
                "type": "string",
              },
            },
            "required": [
              "object",
              "type",
              "synced_block",
            ],
            "type": "object",
          },
        ],
      },
      "BlockObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "has_children": {
            "type": "boolean",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "created_time",
          "last_edited_time",
          "has_children",
          "archived",
        ],
        "type": "object",
      },
      "CheckboxPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "boolean",
          },
          "equals": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "CheckboxPropertyResponse": {
        "properties": {
          "checkbox": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "checkbox",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "checkbox",
        ],
        "type": "object",
      },
      "CommentObjectResponse": {
        "properties": {
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "discussion_id": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "block_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "block_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "block_id",
                ],
                "type": "object",
              },
            ],
          },
          "rich_text": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "id",
          "parent",
          "discussion_id",
          "rich_text",
          "created_by",
          "created_time",
          "last_edited_time",
        ],
        "type": "object",
      },
      "CompoundFilter": {
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/PropertyFilter",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "CreateCommentParameters": {
        "oneOf": [
          {
            "properties": {
              "parent": {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "page_id",
                ],
                "type": "object",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "parent",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "discussion_id": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "required": [
              "discussion_id",
              "rich_text",
            ],
            "type": "object",
          },
        ],
      },
      "CreateDatabaseParameters": {
        "properties": {
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertySchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "required": [
          "parent",
          "properties",
          "title",
        ],
        "type": "object",
      },
      "CreatePageParameters": {
        "properties": {
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "database_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database_id",
                ],
                "type": "object",
              },
            ],
            "type": "object",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "required": [
          "parent",
          "properties",
        ],
        "type": "object",
      },
      "CreatedByPropertyResponse": {
        "properties": {
          "created_by": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_by",
        ],
        "type": "object",
      },
      "CreatedTimePropertyResponse": {
        "properties": {
          "created_time": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "created_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "created_time",
        ],
        "type": "object",
      },
      "DatabaseObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "created_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "created_time": {
            "type": "string",
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "emoji",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "external",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "id": {
            "type": "string",
          },
          "is_inline": {
            "type": "boolean",
          },
          "last_edited_by": {
            "$ref": "#/components/schemas/PartialUserObjectResponse",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "parent": {
            "oneOf": [
              {
                "properties": {
                  "page_id": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "page_id",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page_id",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemResponse",
            },
            "type": "array",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "created_by",
          "last_edited_time",
          "last_edited_by",
          "title",
          "description",
          "is_inline",
          "properties",
          "parent",
          "url",
          "archived",
        ],
        "type": "object",
      },
      "DatabasePropertyConfigResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TitlePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RichTextPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/NumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/SelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/MultiSelectPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/DatePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PeoplePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FilePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CheckboxPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/URLPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/EmailPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/PhoneNumberPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/FormulaPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RelationPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/RollupPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/CreatedByPropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedTimePropertyResponse",
          },
          {
            "$ref": "#/components/schemas/LastEditedByPropertyResponse",
          },
        ],
      },
      "DatePropertyFilter": {
        "properties": {
          "after": {
            "type": "string",
          },
          "before": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "next_month": {},
          "next_week": {},
          "next_year": {},
          "on_or_after": {
            "type": "string",
          },
          "on_or_before": {
            "type": "string",
          },
          "past_month": {},
          "past_week": {},
          "past_year": {},
        },
        "type": "object",
      },
      "DatePropertyResponse": {
        "properties": {
          "date": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "date",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "date",
        ],
        "type": "object",
      },
      "DateRequest": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
        ],
        "type": "object",
      },
      "DateResponse": {
        "properties": {
          "end": {
            "type": [
              "string",
              "null",
            ],
          },
          "start": {
            "type": "string",
          },
          "time_zone": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "start",
          "end",
          "time_zone",
        ],
        "type": "object",
      },
      "EmailPropertyResponse": {
        "properties": {
          "email": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "email",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "email",
        ],
        "type": "object",
      },
      "EquationRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "equation",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "equation",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "FilePropertyResponse": {
        "properties": {
          "files": {
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "files",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "files",
        ],
        "type": "object",
      },
      "FilesPropertyFilter": {
        "properties": {
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "FormulaPropertyResponse": {
        "properties": {
          "formula": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "required": [
              "expression",
            ],
            "type": "object",
          },
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "formula",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "formula",
        ],
        "type": "object",
      },
      "LastEditedByPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_by": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_by",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_by",
        ],
        "type": "object",
      },
      "LastEditedTimePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "object",
          },
          "type": {
            "enum": [
              "last_edited_time",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "last_edited_time",
        ],
        "type": "object",
      },
      "ListBlockChildrenResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialBlockObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/BlockObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListCommentsResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/CommentObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListDatabasesResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "ListUsersResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/UserObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "MentionRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "mention": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "date": {
                    "$ref": "#/components/schemas/DateResponse",
                  },
                  "type": {
                    "enum": [
                      "date",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "date",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "link_preview": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "link_preview",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "link_preview",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "page": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "page",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "page",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "database": {
                    "properties": {
                      "id": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "id",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "database",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "type",
                  "database",
                ],
                "type": "object",
              },
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "type": {
            "enum": [
              "mention",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "mention",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "MultiSelectPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "MultiSelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "multi_select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "multi_select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "multi_select",
        ],
        "type": "object",
      },
      "NumberPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "number",
          },
          "equals": {
            "type": "number",
          },
          "greater_than": {
            "type": "number",
          },
          "greater_than_or_equal_to": {
            "type": "number",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "less_than": {
            "type": "number",
          },
          "less_than_or_equal_to": {
            "type": "number",
          },
        },
        "type": "object",
      },
      "NumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "number": {
            "properties": {
              "format": {
                "type": "string",
              },
            },
            "required": [
              "format",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "number",
        ],
        "type": "object",
      },
      "OauthTokenParameters": {
        "properties": {
          "code": {
            "type": "string",
          },
          "external_account": {
            "properties": {
              "key": {
                "type": "string",
              },
              "name": {
                "type": "string",
              },
            },
            "required": [
              "key",
              "name",
            ],
            "type": "object",
          },
          "grant_type": {
            "type": "string",
          },
          "redirect_uri": {
            "type": "string",
          },
        },
        "required": [
          "grant_type",
          "code",
        ],
        "type": "object",
      },
      "OauthTokenResponse": {
        "properties": {
          "access_token": {
            "type": "string",
          },
          "bot_id": {
            "type": "string",
          },
          "duplicated_template_id": {
            "type": [
              "string",
              "null",
            ],
          },
          "owner": {
            "oneOf": [
              {
                "properties": {
                  "type": {
                    "enum": [
                      "user",
                    ],
                    "type": "string",
                  },
                  "user": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/UserObjectResponse",
                      },
                      {
                        "$ref": "#/components/schemas/PartialUserObjectResponse",
                      },
                    ],
                  },
                },
                "required": [
                  "type",
                  "user",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "type": {
                    "enum": [
                      "workspace",
                    ],
                    "type": "string",
                  },
                  "workspace": {
                    "enum": [
                      true,
                    ],
                    "type": "boolean",
                  },
                },
                "required": [
                  "type",
                  "workspace",
                ],
                "type": "object",
              },
            ],
          },
          "token_type": {
            "enum": [
              "bearer",
            ],
            "type": "string",
          },
          "workspace_icon": {
            "type": [
              "string",
              "null",
            ],
          },
          "workspace_id": {
            "type": "string",
          },
          "workspace_name": {
            "type": [
              "string",
              "null",
            ],
          },
        },
        "required": [
          "access_token",
          "token_type",
          "bot_id",
          "workspace_name",
          "workspace_icon",
          "workspace_id",
          "owner",
          "duplicated_template_id",
        ],
        "type": "object",
      },
      "PageObjectResponse": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "created_time": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "last_edited_time": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
          "url": {
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "created_time",
          "last_edited_time",
          "archived",
          "url",
        ],
        "type": "object",
      },
      "PartialBlockObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "block",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialCommentObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "comment",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialDatabaseObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "database",
            ],
            "type": "string",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/DatabasePropertyConfigResponse",
            },
            "type": "object",
          },
        },
        "required": [
          "object",
          "id",
          "properties",
        ],
        "type": "object",
      },
      "PartialPageObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "page",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PartialUserObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
        ],
        "type": "object",
      },
      "PeoplePropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "PeoplePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "people": {
            "type": "object",
          },
          "type": {
            "enum": [
              "people",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "people",
        ],
        "type": "object",
      },
      "PhoneNumberPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "phone_number": {
            "type": "object",
          },
          "type": {
            "enum": [
              "phone_number",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "phone_number",
        ],
        "type": "object",
      },
      "PropertyFilter": {
        "oneOf": [
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "title": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "title",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "rich_text": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "rich_text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "number": {
                "$ref": "#/components/schemas/NumberPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "checkbox": {
                "$ref": "#/components/schemas/CheckboxPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "checkbox",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "select": {
                "$ref": "#/components/schemas/SelectPropertyFilter",
              },
            },
            "required": [
              "property",
              "select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "multi_select": {
                "$ref": "#/components/schemas/MultiSelectPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "multi_select",
            ],
            "type": "object",
          },
          {
            "properties": {
              "date": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "date",
            ],
            "type": "object",
          },
          {
            "properties": {
              "people": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "people",
            ],
            "type": "object",
          },
          {
            "properties": {
              "files": {
                "$ref": "#/components/schemas/FilesPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "files",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "url": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
            },
            "required": [
              "property",
              "url",
            ],
            "type": "object",
          },
          {
            "properties": {
              "email": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "email",
            ],
            "type": "object",
          },
          {
            "properties": {
              "phone_number": {
                "$ref": "#/components/schemas/TextPropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "phone_number",
            ],
            "type": "object",
          },
          {
            "properties": {
              "property": {
                "type": "string",
              },
              "relation": {
                "$ref": "#/components/schemas/RelationPropertyFilter",
              },
            },
            "required": [
              "property",
              "relation",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_by": {
                "$ref": "#/components/schemas/PeoplePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_by",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "property": {
                "type": "string",
              },
            },
            "required": [
              "property",
              "last_edited_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "created_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "created_time",
            ],
            "type": "object",
          },
          {
            "properties": {
              "last_edited_time": {
                "$ref": "#/components/schemas/DatePropertyFilter",
              },
              "timestamp": {
                "enum": [
                  "created_time",
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "timestamp",
              "last_edited_time",
            ],
            "type": "object",
          },
        ],
      },
      "PropertyItemListResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/PropertyItemObjectResponse",
            },
            "type": "array",
          },
        },
        "required": [
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "PropertyItemObjectResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
          "id",
        ],
        "type": "object",
      },
      "PropertySchema": {
        "properties": {
          "name": {
            "type": [
              "string",
              "null",
            ],
          },
          "type": {
            "type": "string",
          },
        },
        "required": [
          "type",
        ],
        "type": "object",
      },
      "PropertyUpdateSchema": {
        "properties": {
          "name": {
            "type": "string",
          },
          "type": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "filter": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/PropertyFilter",
              },
              {
                "$ref": "#/components/schemas/CompoundFilter",
              },
            ],
          },
          "page_size": {
            "type": "integer",
          },
          "sorts": {
            "items": {
              "oneOf": [
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "property": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "property",
                    "direction",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "direction": {
                      "enum": [
                        "ascending",
                        "descending",
                      ],
                      "type": "string",
                    },
                    "timestamp": {
                      "enum": [
                        "created_time",
                        "last_edited_time",
                      ],
                      "type": "string",
                    },
                  },
                  "required": [
                    "timestamp",
                    "direction",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "array",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "QueryDatabaseResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "RelationPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "RelationPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "relation": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "synced_property_id": {
                "type": "string",
              },
              "synced_property_name": {
                "type": "string",
              },
            },
            "required": [
              "database_id",
              "synced_property_name",
              "synced_property_id",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "relation",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "relation",
        ],
        "type": "object",
      },
      "RichTextItemRequest": {
        "oneOf": [
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "text": {
                "properties": {
                  "content": {
                    "type": "string",
                  },
                  "link": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": [
                      "object",
                      "null",
                    ],
                  },
                },
                "required": [
                  "content",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "text",
                ],
                "type": "string",
              },
            },
            "required": [
              "text",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "mention": {
                "oneOf": [
                  {
                    "properties": {
                      "user": {
                        "oneOf": [
                          {
                            "properties": {
                              "id": {
                                "type": "string",
                              },
                            },
                            "required": [
                              "id",
                            ],
                            "type": "object",
                          },
                          {
                            "$ref": "#/components/schemas/UserObjectResponse",
                          },
                        ],
                      },
                    },
                    "required": [
                      "user",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "page": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "page",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "database": {
                        "properties": {
                          "id": {
                            "type": "string",
                          },
                        },
                        "required": [
                          "id",
                        ],
                        "type": "object",
                      },
                    },
                    "required": [
                      "database",
                    ],
                    "type": "object",
                  },
                  {
                    "properties": {
                      "date": {
                        "$ref": "#/components/schemas/DateRequest",
                      },
                    },
                    "required": [
                      "date",
                    ],
                    "type": "object",
                  },
                ],
              },
              "type": {
                "enum": [
                  "mention",
                ],
                "type": "string",
              },
            },
            "required": [
              "mention",
            ],
            "type": "object",
          },
          {
            "properties": {
              "annotations": {
                "$ref": "#/components/schemas/AnnotationRequest",
              },
              "equation": {
                "properties": {
                  "expression": {
                    "type": "string",
                  },
                },
                "required": [
                  "expression",
                ],
                "type": "object",
              },
              "type": {
                "enum": [
                  "equation",
                ],
                "type": "string",
              },
            },
            "required": [
              "equation",
            ],
            "type": "object",
          },
        ],
      },
      "RichTextItemResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TextRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/MentionRichTextItemResponse",
          },
          {
            "$ref": "#/components/schemas/EquationRichTextItemResponse",
          },
        ],
      },
      "RichTextPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rich_text": {
            "type": "object",
          },
          "type": {
            "enum": [
              "rich_text",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rich_text",
        ],
        "type": "object",
      },
      "RollupPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "rollup": {
            "properties": {
              "function": {
                "type": "string",
              },
              "relation_property_id": {
                "type": "string",
              },
              "relation_property_name": {
                "type": "string",
              },
              "rollup_property_id": {
                "type": "string",
              },
              "rollup_property_name": {
                "type": "string",
              },
            },
            "required": [
              "relation_property_name",
              "relation_property_id",
              "rollup_property_name",
              "rollup_property_id",
              "function",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "rollup",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "rollup",
        ],
        "type": "object",
      },
      "SearchParameters": {
        "properties": {
          "filter": {
            "properties": {
              "property": {
                "enum": [
                  "object",
                ],
                "type": "string",
              },
              "value": {
                "enum": [
                  "page",
                  "database",
                ],
                "type": "string",
              },
            },
            "required": [
              "value",
              "property",
            ],
            "type": "object",
          },
          "page_size": {
            "type": "integer",
          },
          "query": {
            "type": "string",
          },
          "sort": {
            "properties": {
              "direction": {
                "enum": [
                  "ascending",
                  "descending",
                ],
                "type": "string",
              },
              "timestamp": {
                "enum": [
                  "last_edited_time",
                ],
                "type": "string",
              },
            },
            "required": [
              "direction",
              "timestamp",
            ],
            "type": "object",
          },
          "start_cursor": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "SearchResponse": {
        "properties": {
          "has_more": {
            "type": "boolean",
          },
          "next_cursor": {
            "type": [
              "string",
              "null",
            ],
          },
          "object": {
            "enum": [
              "list",
            ],
            "type": "string",
          },
          "results": {
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialPageObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                },
                {
                  "$ref": "#/components/schemas/DatabaseObjectResponse",
                },
              ],
            },
            "type": "array",
          },
        },
        "required": [
          "object",
          "results",
          "next_cursor",
          "has_more",
        ],
        "type": "object",
      },
      "SelectOption": {
        "properties": {
          "color": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
          "color",
        ],
        "type": "object",
      },
      "SelectPropertyFilter": {
        "properties": {
          "does_not_equal": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
        },
        "type": "object",
      },
      "SelectPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "select": {
            "properties": {
              "options": {
                "items": {
                  "$ref": "#/components/schemas/SelectOption",
                },
                "type": "array",
              },
            },
            "required": [
              "options",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "select",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "select",
        ],
        "type": "object",
      },
      "TextPropertyFilter": {
        "properties": {
          "contains": {
            "type": "string",
          },
          "does_not_contain": {
            "type": "string",
          },
          "does_not_equal": {
            "type": "string",
          },
          "ends_with": {
            "type": "string",
          },
          "equals": {
            "type": "string",
          },
          "is_empty": {
            "type": "boolean",
          },
          "is_not_empty": {
            "type": "boolean",
          },
          "starts_with": {
            "type": "string",
          },
        },
        "type": "object",
      },
      "TextRichTextItemResponse": {
        "properties": {
          "annotations": {
            "$ref": "#/components/schemas/AnnotationResponse",
          },
          "href": {
            "type": [
              "string",
              "null",
            ],
          },
          "plain_text": {
            "type": "string",
          },
          "text": {
            "properties": {
              "content": {
                "type": "string",
              },
              "link": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "required": [
                  "url",
                ],
                "type": [
                  "object",
                  "null",
                ],
              },
            },
            "required": [
              "content",
              "link",
            ],
            "type": "object",
          },
          "type": {
            "enum": [
              "text",
            ],
            "type": "string",
          },
        },
        "required": [
          "type",
          "text",
          "annotations",
          "plain_text",
          "href",
        ],
        "type": "object",
      },
      "TitlePropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "title": {
            "type": "object",
          },
          "type": {
            "enum": [
              "title",
            ],
            "type": "string",
          },
        },
        "required": [
          "id",
          "type",
          "title",
        ],
        "type": "object",
      },
      "URLPropertyResponse": {
        "properties": {
          "id": {
            "type": "string",
          },
          "type": {
            "enum": [
              "url",
            ],
            "type": "string",
          },
          "url": {
            "type": "object",
          },
        },
        "required": [
          "id",
          "type",
          "url",
        ],
        "type": "object",
      },
      "UpdateBlockParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "bookmark": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "breadcrumb": {
            "type": "object",
          },
          "bulleted_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "code": {
            "properties": {
              "language": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "column": {
            "type": "object",
          },
          "column_list": {
            "type": "object",
          },
          "divider": {
            "type": "object",
          },
          "embed": {
            "properties": {
              "url": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "equation": {
            "properties": {
              "expression": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "file": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "heading_1": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_2": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "heading_3": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "image": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "link_to_page": {
            "properties": {
              "database_id": {
                "type": "string",
              },
              "page_id": {
                "type": "string",
              },
              "type": {
                "enum": [
                  "page_id",
                  "database_id",
                ],
                "type": "string",
              },
            },
            "type": "object",
          },
          "numbered_list_item": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "paragraph": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "pdf": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
          "quote": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "table_of_contents": {
            "properties": {
              "color": {
                "type": "string",
              },
            },
            "type": "object",
          },
          "table_row": {
            "properties": {
              "cells": {
                "items": {
                  "items": {
                    "$ref": "#/components/schemas/RichTextItemRequest",
                  },
                  "type": "array",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "to_do": {
            "properties": {
              "checked": {
                "type": "boolean",
              },
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "toggle": {
            "properties": {
              "color": {
                "type": "string",
              },
              "rich_text": {
                "items": {
                  "$ref": "#/components/schemas/RichTextItemRequest",
                },
                "type": "array",
              },
            },
            "type": "object",
          },
          "video": {
            "properties": {
              "external": {
                "properties": {
                  "url": {
                    "type": "string",
                  },
                },
                "type": "object",
              },
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UpdateDatabaseParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "cover": {
            "oneOf": [
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "description": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
          "icon": {
            "oneOf": [
              {
                "properties": {
                  "emoji": {
                    "type": "string",
                  },
                  "type": {
                    "enum": [
                      "emoji",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "emoji",
                  "type",
                ],
                "type": "object",
              },
              {
                "properties": {
                  "external": {
                    "properties": {
                      "url": {
                        "type": "string",
                      },
                    },
                    "required": [
                      "url",
                    ],
                    "type": "object",
                  },
                  "type": {
                    "enum": [
                      "external",
                    ],
                    "type": "string",
                  },
                },
                "required": [
                  "external",
                  "type",
                ],
                "type": "object",
              },
              {
                "type": "null",
              },
            ],
          },
          "is_inline": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "$ref": "#/components/schemas/PropertyUpdateSchema",
            },
            "type": "object",
          },
          "title": {
            "items": {
              "$ref": "#/components/schemas/RichTextItemRequest",
            },
            "type": "array",
          },
        },
        "type": "object",
      },
      "UpdatePageParameters": {
        "properties": {
          "archived": {
            "type": "boolean",
          },
          "properties": {
            "additionalProperties": {
              "oneOf": [
                {
                  "properties": {
                    "title": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "title",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "rich_text": {
                      "items": {
                        "$ref": "#/components/schemas/RichTextItemRequest",
                      },
                      "type": "array",
                    },
                  },
                  "required": [
                    "rich_text",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "number": {
                      "type": [
                        "number",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "number",
                  ],
                  "type": "object",
                },
                {
                  "properties": {
                    "select": {
                      "properties": {
                        "name": {
                          "type": "string",
                        },
                      },
                      "required": [
                        "name",
                      ],
                      "type": [
                        "object",
                        "null",
                      ],
                    },
                  },
                  "required": [
                    "select",
                  ],
                  "type": "object",
                },
              ],
            },
            "type": "object",
          },
        },
        "type": "object",
      },
      "UserObjectResponse": {
        "properties": {
          "avatar_url": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
          "object": {
            "enum": [
              "user",
            ],
            "type": "string",
          },
          "type": {
            "enum": [
              "person",
              "bot",
            ],
            "type": "string",
          },
        },
        "required": [
          "object",
          "id",
          "type",
          "name",
          "avatar_url",
        ],
        "type": "object",
      },
    },
    "securitySchemes": {
      "oauth2": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://api.notion.com/v1/oauth/authorize",
            "scopes": {},
            "tokenUrl": "https://api.notion.com/v1/oauth/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "API specification for Notion",
    "title": "Notion API",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/blocks/{block_id}": {
      "delete": {
        "operationId": "deleteBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Delete block",
      },
      "get": {
        "operationId": "getBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get block",
      },
      "patch": {
        "operationId": "updateBlock",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBlockParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialBlockObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/BlockObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update block",
      },
    },
    "/blocks/{block_id}/children": {
      "get": {
        "operationId": "listBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List block children",
      },
      "patch": {
        "operationId": "appendBlockChildren",
        "parameters": [
          {
            "in": "path",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppendBlockChildrenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppendBlockChildrenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Append block children",
      },
    },
    "/comments": {
      "get": {
        "operationId": "listComments",
        "parameters": [
          {
            "in": "query",
            "name": "block_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListCommentsResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List comments",
      },
      "post": {
        "operationId": "createComment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCommentParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/CommentObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialCommentObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create comment",
      },
    },
    "/databases": {
      "get": {
        "operationId": "listDatabases",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListDatabasesResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List databases",
      },
      "post": {
        "operationId": "createDatabase",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create database",
      },
    },
    "/databases/{database_id}": {
      "get": {
        "operationId": "getDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get database",
      },
      "patch": {
        "operationId": "updateDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PartialDatabaseObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/DatabaseObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update database",
      },
    },
    "/databases/{database_id}/query": {
      "post": {
        "operationId": "queryDatabase",
        "parameters": [
          {
            "in": "path",
            "name": "database_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QueryDatabaseParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryDatabaseResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Query database",
      },
    },
    "/oauth/token": {
      "post": {
        "operationId": "oauthToken",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OauthTokenParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OauthTokenResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "OAuth token",
      },
    },
    "/pages": {
      "post": {
        "operationId": "createPage",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Create page",
      },
    },
    "/pages/{page_id}": {
      "get": {
        "operationId": "getPage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "filter_properties",
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page",
      },
      "patch": {
        "operationId": "updatePage",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePageParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PageObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PartialPageObjectResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Update page",
      },
    },
    "/pages/{page_id}/properties/{property_id}": {
      "get": {
        "operationId": "getPageProperty",
        "parameters": [
          {
            "in": "path",
            "name": "page_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "path",
            "name": "property_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/PropertyItemObjectResponse",
                    },
                    {
                      "$ref": "#/components/schemas/PropertyItemListResponse",
                    },
                  ],
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get page property",
      },
    },
    "/search": {
      "post": {
        "operationId": "search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SearchParameters",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Search",
      },
    },
    "/users": {
      "get": {
        "operationId": "listUsers",
        "parameters": [
          {
            "in": "query",
            "name": "start_cursor",
            "schema": {
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListUsersResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "List users",
      },
    },
    "/users/me": {
      "get": {
        "operationId": "getSelf",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get current user",
      },
    },
    "/users/{user_id}": {
      "get": {
        "operationId": "getUser",
        "parameters": [
          {
            "in": "path",
            "name": "user_id",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObjectResponse",
                },
              },
            },
            "description": "Successful response",
          },
        },
        "summary": "Get user",
      },
    },
  },
  "security": [
    {
      "oauth2": [],
    },
  ],
  "servers": [
    {
      "url": "https://api.notion.so",
    },
  ],
}
`;

exports[`validateOpenAPISpec > open-meteo.yaml (file url) 1`] = `
{
  "components": {
    "schemas": {
      "CurrentWeather": {
        "description": "Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code",
        "properties": {
          "temperature": {
            "type": "number",
          },
          "time": {
            "type": "string",
          },
          "weather_code": {
            "type": "integer",
          },
          "wind_direction": {
            "type": "number",
          },
          "wind_speed": {
            "type": "number",
          },
        },
        "required": [
          "time",
          "temperature",
          "wind_speed",
          "wind_direction",
          "weather_code",
        ],
        "type": "object",
      },
      "DailyResponse": {
        "description": "For each selected daily weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "apparent_temperature_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "et0_fao_evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_hours": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunrise": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunset": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "uv_index_clear_sky_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "uv_index_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m_dominant": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
      "HourlyResponse": {
        "description": "For each selected weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_high": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_low": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_mid": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "dew_point_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "diffuse_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_normal_irradiance": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "freezing_level_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "pressure_msl": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "relative_humidity_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "snow_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_0_1cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_1_3cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_27_81cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_3_9cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_9_27cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_0cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_18cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_54cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_6cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "vapour_pressure_deficit": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
    },
  },
  "info": {
    "contact": {
      "email": "info@open-meteo.com",
      "name": "Open-Meteo",
      "url": "https://open-meteo.com",
    },
    "description": "Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.",
    "license": {
      "name": "Attribution 4.0 International (CC BY 4.0)",
      "url": "https://creativecommons.org/licenses/by/4.0/",
    },
    "termsOfService": "https://open-meteo.com/en/features#terms",
    "title": "Open-Meteo APIs",
    "version": "1.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/forecast": {
      "get": {
        "description": "7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.",
        "parameters": [
          {
            "explode": false,
            "in": "query",
            "name": "hourly",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m",
                  "relative_humidity_2m",
                  "dew_point_2m",
                  "apparent_temperature",
                  "pressure_msl",
                  "cloud_cover",
                  "cloud_cover_low",
                  "cloud_cover_mid",
                  "cloud_cover_high",
                  "wind_speed_10m",
                  "wind_speed_80m",
                  "wind_speed_120m",
                  "wind_speed_180m",
                  "wind_direction_10m",
                  "wind_direction_80m",
                  "wind_direction_120m",
                  "wind_direction_180m",
                  "wind_gusts_10m",
                  "shortwave_radiation",
                  "direct_radiation",
                  "direct_normal_irradiance",
                  "diffuse_radiation",
                  "vapour_pressure_deficit",
                  "evapotranspiration",
                  "precipitation",
                  "weather_code",
                  "snow_height",
                  "freezing_level_height",
                  "soil_temperature_0cm",
                  "soil_temperature_6cm",
                  "soil_temperature_18cm",
                  "soil_temperature_54cm",
                  "soil_moisture_0_1cm",
                  "soil_moisture_1_3cm",
                  "soil_moisture_3_9cm",
                  "soil_moisture_9_27cm",
                  "soil_moisture_27_81cm",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "in": "query",
            "name": "daily",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m_max",
                  "temperature_2m_min",
                  "apparent_temperature_max",
                  "apparent_temperature_min",
                  "precipitation_sum",
                  "precipitation_hours",
                  "weather_code",
                  "sunrise",
                  "sunset",
                  "wind_speed_10m_max",
                  "wind_gusts_10m_max",
                  "wind_direction_10m_dominant",
                  "shortwave_radiation_sum",
                  "uv_index_max",
                  "uv_index_clear_sky_max",
                  "et0_fao_evapotranspiration",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "latitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "longitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "in": "query",
            "name": "current_weather",
            "schema": {
              "type": "boolean",
            },
          },
          {
            "in": "query",
            "name": "temperature_unit",
            "schema": {
              "default": "celsius",
              "enum": [
                "celsius",
                "fahrenheit",
              ],
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "wind_speed_unit",
            "schema": {
              "default": "kmh",
              "enum": [
                "kmh",
                "ms",
                "mph",
                "kn",
              ],
              "type": "string",
            },
          },
          {
            "description": "If format \`unixtime\` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply \`utc_offset_seconds\` again to get the correct date.",
            "in": "query",
            "name": "timeformat",
            "schema": {
              "default": "iso8601",
              "enum": [
                "iso8601",
                "unixtime",
              ],
              "type": "string",
            },
          },
          {
            "description": "If \`timezone\` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.",
            "in": "query",
            "name": "timezone",
            "schema": {
              "type": "string",
            },
          },
          {
            "description": "If \`past_days\` is set, yesterdays or the day before yesterdays data are also returned.",
            "in": "query",
            "name": "past_days",
            "schema": {
              "enum": [
                1,
                2,
              ],
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current_weather": {
                      "$ref": "#/components/schemas/CurrentWeather",
                    },
                    "daily": {
                      "$ref": "#/components/schemas/DailyResponse",
                    },
                    "daily_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected daily weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "elevation": {
                      "description": "The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.",
                      "example": 44.812,
                      "type": "number",
                    },
                    "generationtime_ms": {
                      "description": "Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.",
                      "example": 2.2119,
                      "type": "number",
                    },
                    "hourly": {
                      "$ref": "#/components/schemas/HourlyResponse",
                    },
                    "hourly_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "latitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": 52.52,
                      "type": "number",
                    },
                    "longitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": "13.419.52",
                      "type": "number",
                    },
                    "utc_offset_seconds": {
                      "description": "Applied timezone offset from the &timezone= parameter.",
                      "example": 3600,
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "description": "Always set true for errors",
                      "type": "boolean",
                    },
                    "reason": {
                      "description": "Description of the error",
                      "example": "Latitude must be in range of -90 to 90°. Given: 300",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Bad Request",
          },
        },
        "summary": "7 day weather forecast for coordinates",
        "tags": [
          "Weather Forecast APIs",
        ],
      },
      "servers": [
        {
          "url": "https://api.open-meteo.com",
        },
      ],
    },
  },
}
`;

exports[`validateOpenAPISpec > open-meteo.yaml (http url) 1`] = `
{
  "components": {
    "schemas": {
      "CurrentWeather": {
        "description": "Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code",
        "properties": {
          "temperature": {
            "type": "number",
          },
          "time": {
            "type": "string",
          },
          "weather_code": {
            "type": "integer",
          },
          "wind_direction": {
            "type": "number",
          },
          "wind_speed": {
            "type": "number",
          },
        },
        "required": [
          "time",
          "temperature",
          "wind_speed",
          "wind_direction",
          "weather_code",
        ],
        "type": "object",
      },
      "DailyResponse": {
        "description": "For each selected daily weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "apparent_temperature_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "et0_fao_evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_hours": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunrise": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunset": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "uv_index_clear_sky_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "uv_index_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m_dominant": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
      "HourlyResponse": {
        "description": "For each selected weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_high": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_low": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_mid": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "dew_point_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "diffuse_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_normal_irradiance": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "freezing_level_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "pressure_msl": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "relative_humidity_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "snow_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_0_1cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_1_3cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_27_81cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_3_9cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_9_27cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_0cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_18cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_54cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_6cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "vapour_pressure_deficit": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
    },
  },
  "info": {
    "contact": {
      "email": "info@open-meteo.com",
      "name": "Open-Meteo",
      "url": "https://open-meteo.com",
    },
    "description": "Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.",
    "license": {
      "name": "Attribution 4.0 International (CC BY 4.0)",
      "url": "https://creativecommons.org/licenses/by/4.0/",
    },
    "termsOfService": "https://open-meteo.com/en/features#terms",
    "title": "Open-Meteo APIs",
    "version": "1.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/forecast": {
      "get": {
        "description": "7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.",
        "parameters": [
          {
            "explode": false,
            "in": "query",
            "name": "hourly",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m",
                  "relative_humidity_2m",
                  "dew_point_2m",
                  "apparent_temperature",
                  "pressure_msl",
                  "cloud_cover",
                  "cloud_cover_low",
                  "cloud_cover_mid",
                  "cloud_cover_high",
                  "wind_speed_10m",
                  "wind_speed_80m",
                  "wind_speed_120m",
                  "wind_speed_180m",
                  "wind_direction_10m",
                  "wind_direction_80m",
                  "wind_direction_120m",
                  "wind_direction_180m",
                  "wind_gusts_10m",
                  "shortwave_radiation",
                  "direct_radiation",
                  "direct_normal_irradiance",
                  "diffuse_radiation",
                  "vapour_pressure_deficit",
                  "evapotranspiration",
                  "precipitation",
                  "weather_code",
                  "snow_height",
                  "freezing_level_height",
                  "soil_temperature_0cm",
                  "soil_temperature_6cm",
                  "soil_temperature_18cm",
                  "soil_temperature_54cm",
                  "soil_moisture_0_1cm",
                  "soil_moisture_1_3cm",
                  "soil_moisture_3_9cm",
                  "soil_moisture_9_27cm",
                  "soil_moisture_27_81cm",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "in": "query",
            "name": "daily",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m_max",
                  "temperature_2m_min",
                  "apparent_temperature_max",
                  "apparent_temperature_min",
                  "precipitation_sum",
                  "precipitation_hours",
                  "weather_code",
                  "sunrise",
                  "sunset",
                  "wind_speed_10m_max",
                  "wind_gusts_10m_max",
                  "wind_direction_10m_dominant",
                  "shortwave_radiation_sum",
                  "uv_index_max",
                  "uv_index_clear_sky_max",
                  "et0_fao_evapotranspiration",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "latitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "longitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "in": "query",
            "name": "current_weather",
            "schema": {
              "type": "boolean",
            },
          },
          {
            "in": "query",
            "name": "temperature_unit",
            "schema": {
              "default": "celsius",
              "enum": [
                "celsius",
                "fahrenheit",
              ],
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "wind_speed_unit",
            "schema": {
              "default": "kmh",
              "enum": [
                "kmh",
                "ms",
                "mph",
                "kn",
              ],
              "type": "string",
            },
          },
          {
            "description": "If format \`unixtime\` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply \`utc_offset_seconds\` again to get the correct date.",
            "in": "query",
            "name": "timeformat",
            "schema": {
              "default": "iso8601",
              "enum": [
                "iso8601",
                "unixtime",
              ],
              "type": "string",
            },
          },
          {
            "description": "If \`timezone\` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.",
            "in": "query",
            "name": "timezone",
            "schema": {
              "type": "string",
            },
          },
          {
            "description": "If \`past_days\` is set, yesterdays or the day before yesterdays data are also returned.",
            "in": "query",
            "name": "past_days",
            "schema": {
              "enum": [
                1,
                2,
              ],
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current_weather": {
                      "$ref": "#/components/schemas/CurrentWeather",
                    },
                    "daily": {
                      "$ref": "#/components/schemas/DailyResponse",
                    },
                    "daily_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected daily weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "elevation": {
                      "description": "The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.",
                      "example": 44.812,
                      "type": "number",
                    },
                    "generationtime_ms": {
                      "description": "Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.",
                      "example": 2.2119,
                      "type": "number",
                    },
                    "hourly": {
                      "$ref": "#/components/schemas/HourlyResponse",
                    },
                    "hourly_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "latitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": 52.52,
                      "type": "number",
                    },
                    "longitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": "13.419.52",
                      "type": "number",
                    },
                    "utc_offset_seconds": {
                      "description": "Applied timezone offset from the &timezone= parameter.",
                      "example": 3600,
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "description": "Always set true for errors",
                      "type": "boolean",
                    },
                    "reason": {
                      "description": "Description of the error",
                      "example": "Latitude must be in range of -90 to 90°. Given: 300",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Bad Request",
          },
        },
        "summary": "7 day weather forecast for coordinates",
        "tags": [
          "Weather Forecast APIs",
        ],
      },
      "servers": [
        {
          "url": "https://api.open-meteo.com",
        },
      ],
    },
  },
}
`;

exports[`validateOpenAPISpec > open-meteo.yaml (string) 1`] = `
{
  "components": {
    "schemas": {
      "CurrentWeather": {
        "description": "Current weather conditions with the attributes: time, temperature, wind_speed, wind_direction and weather_code",
        "properties": {
          "temperature": {
            "type": "number",
          },
          "time": {
            "type": "string",
          },
          "weather_code": {
            "type": "integer",
          },
          "wind_direction": {
            "type": "number",
          },
          "wind_speed": {
            "type": "number",
          },
        },
        "required": [
          "time",
          "temperature",
          "wind_speed",
          "wind_direction",
          "weather_code",
        ],
        "type": "object",
      },
      "DailyResponse": {
        "description": "For each selected daily weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "apparent_temperature_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "et0_fao_evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_hours": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation_sum": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunrise": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "sunset": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m_min": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "uv_index_clear_sky_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "uv_index_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m_dominant": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m_max": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
      "HourlyResponse": {
        "description": "For each selected weather variable, data will be returned as a floating point array. Additionally a \`time\` array will be returned with ISO8601 timestamps.",
        "properties": {
          "apparent_temperature": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_high": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_low": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "cloud_cover_mid": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "dew_point_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "diffuse_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_normal_irradiance": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "direct_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "evapotranspiration": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "freezing_level_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "precipitation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "pressure_msl": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "relative_humidity_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "shortwave_radiation": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "snow_height": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_0_1cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_1_3cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_27_81cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_3_9cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_moisture_9_27cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_0cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_18cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_54cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "soil_temperature_6cm": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "temperature_2m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "time": {
            "items": {
              "type": "string",
            },
            "type": "array",
          },
          "vapour_pressure_deficit": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "weather_code": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_direction_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_gusts_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_10m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_120m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_180m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
          "wind_speed_80m": {
            "items": {
              "type": "number",
            },
            "type": "array",
          },
        },
        "required": [
          "time",
        ],
        "type": "object",
      },
    },
  },
  "info": {
    "contact": {
      "email": "info@open-meteo.com",
      "name": "Open-Meteo",
      "url": "https://open-meteo.com",
    },
    "description": "Open-Meteo offers free weather forecast APIs for open-source developers and non-commercial use. No API key is required.",
    "license": {
      "name": "Attribution 4.0 International (CC BY 4.0)",
      "url": "https://creativecommons.org/licenses/by/4.0/",
    },
    "termsOfService": "https://open-meteo.com/en/features#terms",
    "title": "Open-Meteo APIs",
    "version": "1.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/forecast": {
      "get": {
        "description": "7 day weather variables in hourly and daily resolution for given WGS84 latitude and longitude coordinates. Available worldwide.",
        "parameters": [
          {
            "explode": false,
            "in": "query",
            "name": "hourly",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m",
                  "relative_humidity_2m",
                  "dew_point_2m",
                  "apparent_temperature",
                  "pressure_msl",
                  "cloud_cover",
                  "cloud_cover_low",
                  "cloud_cover_mid",
                  "cloud_cover_high",
                  "wind_speed_10m",
                  "wind_speed_80m",
                  "wind_speed_120m",
                  "wind_speed_180m",
                  "wind_direction_10m",
                  "wind_direction_80m",
                  "wind_direction_120m",
                  "wind_direction_180m",
                  "wind_gusts_10m",
                  "shortwave_radiation",
                  "direct_radiation",
                  "direct_normal_irradiance",
                  "diffuse_radiation",
                  "vapour_pressure_deficit",
                  "evapotranspiration",
                  "precipitation",
                  "weather_code",
                  "snow_height",
                  "freezing_level_height",
                  "soil_temperature_0cm",
                  "soil_temperature_6cm",
                  "soil_temperature_18cm",
                  "soil_temperature_54cm",
                  "soil_moisture_0_1cm",
                  "soil_moisture_1_3cm",
                  "soil_moisture_3_9cm",
                  "soil_moisture_9_27cm",
                  "soil_moisture_27_81cm",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "in": "query",
            "name": "daily",
            "schema": {
              "items": {
                "enum": [
                  "temperature_2m_max",
                  "temperature_2m_min",
                  "apparent_temperature_max",
                  "apparent_temperature_min",
                  "precipitation_sum",
                  "precipitation_hours",
                  "weather_code",
                  "sunrise",
                  "sunset",
                  "wind_speed_10m_max",
                  "wind_gusts_10m_max",
                  "wind_direction_10m_dominant",
                  "shortwave_radiation_sum",
                  "uv_index_max",
                  "uv_index_clear_sky_max",
                  "et0_fao_evapotranspiration",
                ],
                "type": "string",
              },
              "type": "array",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "latitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "description": "WGS84 coordinate",
            "in": "query",
            "name": "longitude",
            "required": true,
            "schema": {
              "format": "double",
              "type": "number",
            },
          },
          {
            "in": "query",
            "name": "current_weather",
            "schema": {
              "type": "boolean",
            },
          },
          {
            "in": "query",
            "name": "temperature_unit",
            "schema": {
              "default": "celsius",
              "enum": [
                "celsius",
                "fahrenheit",
              ],
              "type": "string",
            },
          },
          {
            "in": "query",
            "name": "wind_speed_unit",
            "schema": {
              "default": "kmh",
              "enum": [
                "kmh",
                "ms",
                "mph",
                "kn",
              ],
              "type": "string",
            },
          },
          {
            "description": "If format \`unixtime\` is selected, all time values are returned in UNIX epoch time in seconds. Please not that all time is then in GMT+0! For daily values with unix timestamp, please apply \`utc_offset_seconds\` again to get the correct date.",
            "in": "query",
            "name": "timeformat",
            "schema": {
              "default": "iso8601",
              "enum": [
                "iso8601",
                "unixtime",
              ],
              "type": "string",
            },
          },
          {
            "description": "If \`timezone\` is set, all timestamps are returned as local-time and data is returned starting at 0:00 local-time. Any time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is supported.",
            "in": "query",
            "name": "timezone",
            "schema": {
              "type": "string",
            },
          },
          {
            "description": "If \`past_days\` is set, yesterdays or the day before yesterdays data are also returned.",
            "in": "query",
            "name": "past_days",
            "schema": {
              "enum": [
                1,
                2,
              ],
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "current_weather": {
                      "$ref": "#/components/schemas/CurrentWeather",
                    },
                    "daily": {
                      "$ref": "#/components/schemas/DailyResponse",
                    },
                    "daily_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected daily weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "elevation": {
                      "description": "The elevation in meters of the selected weather grid-cell. In mountain terrain it might differ from the location you would expect.",
                      "example": 44.812,
                      "type": "number",
                    },
                    "generationtime_ms": {
                      "description": "Generation time of the weather forecast in milli seconds. This is mainly used for performance monitoring and improvements.",
                      "example": 2.2119,
                      "type": "number",
                    },
                    "hourly": {
                      "$ref": "#/components/schemas/HourlyResponse",
                    },
                    "hourly_units": {
                      "additionalProperties": {
                        "type": "string",
                      },
                      "description": "For each selected weather variable, the unit will be listed here.",
                      "type": "object",
                    },
                    "latitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": 52.52,
                      "type": "number",
                    },
                    "longitude": {
                      "description": "WGS84 of the center of the weather grid-cell which was used to generate this forecast. This coordinate might be up to 5 km away.",
                      "example": "13.419.52",
                      "type": "number",
                    },
                    "utc_offset_seconds": {
                      "description": "Applied timezone offset from the &timezone= parameter.",
                      "example": 3600,
                      "type": "integer",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "error": {
                      "description": "Always set true for errors",
                      "type": "boolean",
                    },
                    "reason": {
                      "description": "Description of the error",
                      "example": "Latitude must be in range of -90 to 90°. Given: 300",
                      "type": "string",
                    },
                  },
                  "type": "object",
                },
              },
            },
            "description": "Bad Request",
          },
        },
        "summary": "7 day weather forecast for coordinates",
        "tags": [
          "Weather Forecast APIs",
        ],
      },
      "servers": [
        {
          "url": "https://api.open-meteo.com",
        },
      ],
    },
  },
}
`;

exports[`validateOpenAPISpec > pet-store.json (file url) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "Pet": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer",
          },
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
        ],
        "type": "object",
      },
      "Pets": {
        "items": {
          "$ref": "#/components/schemas/Pet",
        },
        "maxItems": 100,
        "type": "array",
      },
    },
  },
  "info": {
    "license": {
      "name": "MIT",
    },
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "operationId": "listPets",
        "parameters": [
          {
            "description": "How many items to return at one time (max 100)",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "maximum": 100,
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pets",
                },
              },
            },
            "description": "A paged array of pets",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string",
                },
              },
            },
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "List all pets",
        "tags": [
          "pets",
        ],
      },
      "post": {
        "operationId": "createPets",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Pet",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "201": {
            "description": "Null response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Create a pet",
        "tags": [
          "pets",
        ],
      },
    },
    "/pets/{petId}": {
      "get": {
        "operationId": "showPetById",
        "parameters": [
          {
            "description": "The id of the pet to retrieve",
            "in": "path",
            "name": "petId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "Expected response to a valid request",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Info for a specific pet",
        "tags": [
          "pets",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1",
    },
  ],
}
`;

exports[`validateOpenAPISpec > pet-store.json (http url) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "Pet": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer",
          },
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
        ],
        "type": "object",
      },
      "Pets": {
        "items": {
          "$ref": "#/components/schemas/Pet",
        },
        "maxItems": 100,
        "type": "array",
      },
    },
  },
  "info": {
    "license": {
      "name": "MIT",
    },
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "operationId": "listPets",
        "parameters": [
          {
            "description": "How many items to return at one time (max 100)",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "maximum": 100,
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pets",
                },
              },
            },
            "description": "A paged array of pets",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string",
                },
              },
            },
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "List all pets",
        "tags": [
          "pets",
        ],
      },
      "post": {
        "operationId": "createPets",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Pet",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "201": {
            "description": "Null response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Create a pet",
        "tags": [
          "pets",
        ],
      },
    },
    "/pets/{petId}": {
      "get": {
        "operationId": "showPetById",
        "parameters": [
          {
            "description": "The id of the pet to retrieve",
            "in": "path",
            "name": "petId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "Expected response to a valid request",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Info for a specific pet",
        "tags": [
          "pets",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1",
    },
  ],
}
`;

exports[`validateOpenAPISpec > pet-store.json (string) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "Pet": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer",
          },
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
        ],
        "type": "object",
      },
      "Pets": {
        "items": {
          "$ref": "#/components/schemas/Pet",
        },
        "maxItems": 100,
        "type": "array",
      },
    },
  },
  "info": {
    "license": {
      "name": "MIT",
    },
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "operationId": "listPets",
        "parameters": [
          {
            "description": "How many items to return at one time (max 100)",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "maximum": 100,
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pets",
                },
              },
            },
            "description": "A paged array of pets",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string",
                },
              },
            },
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "List all pets",
        "tags": [
          "pets",
        ],
      },
      "post": {
        "operationId": "createPets",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Pet",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "201": {
            "description": "Null response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Create a pet",
        "tags": [
          "pets",
        ],
      },
    },
    "/pets/{petId}": {
      "get": {
        "operationId": "showPetById",
        "parameters": [
          {
            "description": "The id of the pet to retrieve",
            "in": "path",
            "name": "petId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "Expected response to a valid request",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
        "summary": "Info for a specific pet",
        "tags": [
          "pets",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1",
    },
  ],
}
`;

exports[`validateOpenAPISpec > petstore-expanded.json (file url) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "NewPet": {
        "properties": {
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "name",
        ],
        "type": "object",
      },
      "Pet": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewPet",
          },
          {
            "properties": {
              "id": {
                "format": "int64",
                "type": "integer",
              },
            },
            "required": [
              "id",
            ],
            "type": "object",
          },
        ],
      },
    },
  },
  "info": {
    "contact": {
      "email": "apiteam@swagger.io",
      "name": "Swagger API Team",
      "url": "http://swagger.io",
    },
    "description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    },
    "termsOfService": "http://swagger.io/terms/",
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
        "operationId": "findPets",
        "parameters": [
          {
            "description": "tags to filter by",
            "in": "query",
            "name": "tags",
            "required": false,
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
            "style": "form",
          },
          {
            "description": "maximum number of results to return",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Pet",
                  },
                  "type": "array",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed",
        "operationId": "addPet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPet",
              },
            },
          },
          "description": "Pet to add to the store",
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
    "/pets/{id}": {
      "delete": {
        "description": "deletes a single pet based on the ID supplied",
        "operationId": "deletePet",
        "parameters": [
          {
            "description": "ID of pet to delete",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "204": {
            "description": "pet deleted",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
        "operationId": "find pet by id",
        "parameters": [
          {
            "description": "ID of pet to fetch",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/api",
    },
  ],
}
`;

exports[`validateOpenAPISpec > petstore-expanded.json (http url) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "NewPet": {
        "properties": {
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "name",
        ],
        "type": "object",
      },
      "Pet": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewPet",
          },
          {
            "properties": {
              "id": {
                "format": "int64",
                "type": "integer",
              },
            },
            "required": [
              "id",
            ],
            "type": "object",
          },
        ],
      },
    },
  },
  "info": {
    "contact": {
      "email": "apiteam@swagger.io",
      "name": "Swagger API Team",
      "url": "http://swagger.io",
    },
    "description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    },
    "termsOfService": "http://swagger.io/terms/",
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
        "operationId": "findPets",
        "parameters": [
          {
            "description": "tags to filter by",
            "in": "query",
            "name": "tags",
            "required": false,
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
            "style": "form",
          },
          {
            "description": "maximum number of results to return",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Pet",
                  },
                  "type": "array",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed",
        "operationId": "addPet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPet",
              },
            },
          },
          "description": "Pet to add to the store",
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
    "/pets/{id}": {
      "delete": {
        "description": "deletes a single pet based on the ID supplied",
        "operationId": "deletePet",
        "parameters": [
          {
            "description": "ID of pet to delete",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "204": {
            "description": "pet deleted",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
        "operationId": "find pet by id",
        "parameters": [
          {
            "description": "ID of pet to fetch",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/api",
    },
  ],
}
`;

exports[`validateOpenAPISpec > petstore-expanded.json (string) 1`] = `
{
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer",
          },
          "message": {
            "type": "string",
          },
        },
        "required": [
          "code",
          "message",
        ],
        "type": "object",
      },
      "NewPet": {
        "properties": {
          "name": {
            "type": "string",
          },
          "tag": {
            "type": "string",
          },
        },
        "required": [
          "name",
        ],
        "type": "object",
      },
      "Pet": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NewPet",
          },
          {
            "properties": {
              "id": {
                "format": "int64",
                "type": "integer",
              },
            },
            "required": [
              "id",
            ],
            "type": "object",
          },
        ],
      },
    },
  },
  "info": {
    "contact": {
      "email": "apiteam@swagger.io",
      "name": "Swagger API Team",
      "url": "http://swagger.io",
    },
    "description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    },
    "termsOfService": "http://swagger.io/terms/",
    "title": "Swagger Petstore",
    "version": "1.0.0",
  },
  "openapi": "3.0.0",
  "paths": {
    "/pets": {
      "get": {
        "description": "Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.",
        "operationId": "findPets",
        "parameters": [
          {
            "description": "tags to filter by",
            "in": "query",
            "name": "tags",
            "required": false,
            "schema": {
              "items": {
                "type": "string",
              },
              "type": "array",
            },
            "style": "form",
          },
          {
            "description": "maximum number of results to return",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "format": "int32",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Pet",
                  },
                  "type": "array",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "post": {
        "description": "Creates a new pet in the store. Duplicates are allowed",
        "operationId": "addPet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewPet",
              },
            },
          },
          "description": "Pet to add to the store",
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
    "/pets/{id}": {
      "delete": {
        "description": "deletes a single pet based on the ID supplied",
        "operationId": "deletePet",
        "parameters": [
          {
            "description": "ID of pet to delete",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "204": {
            "description": "pet deleted",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
      "get": {
        "description": "Returns a user based on a single ID, if the user does not have access to the pet",
        "operationId": "find pet by id",
        "parameters": [
          {
            "description": "ID of pet to fetch",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet",
                },
              },
            },
            "description": "pet response",
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error",
                },
              },
            },
            "description": "unexpected error",
          },
        },
      },
    },
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/api",
    },
  ],
}
`;

exports[`validateOpenAPISpec > remote spec https://agentic-platform-fixtures-everything.onrender.com/docs 1`] = `
{
  "components": {
    "parameters": {},
    "schemas": {
      "User": {
        "properties": {
          "email": {
            "type": "string",
          },
          "id": {
            "type": "string",
          },
          "name": {
            "type": "string",
          },
        },
        "required": [
          "id",
          "name",
          "email",
        ],
        "type": "object",
      },
    },
  },
  "info": {
    "description": "OpenAPI kitchen sink server meant for testing Agentic's origin OpenAPI adapter and ToolConfig features.",
    "title": "OpenAPI server everything",
    "version": "0.1.0",
  },
  "openapi": "3.1.0",
  "paths": {
    "/custom-cache-control-tool": {
      "post": {
        "description": "Custom cache control tool",
        "operationId": "customCacheControlTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/custom-rate-limit-approximate-tool": {
      "post": {
        "description": "Custom rate limit tool (approximate mode)",
        "operationId": "customRateLimitApproximateTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/custom-rate-limit-tool": {
      "post": {
        "description": "Custom rate limit tool (strict mode)",
        "operationId": "customRateLimitTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/disabled-for-free-plan-tool": {
      "get": {
        "description": "Disabled for free plan tool",
        "operationId": "disabledForFreePlanTool",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "status",
                  ],
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
        },
      },
    },
    "/disabled-rate-limit-tool": {
      "post": {
        "description": "Disabled rate limit tool",
        "operationId": "disabledRateLimitTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/disabled-tool": {
      "get": {
        "description": "Disabled tool",
        "operationId": "disabledTool",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "status",
                  ],
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
        },
      },
    },
    "/echo": {
      "post": {
        "description": "Echoes the request body",
        "operationId": "echo",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/echo-headers": {
      "get": {
        "description": "Echoes the request headers",
        "operationId": "echoHeaders",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request headers",
          },
        },
      },
    },
    "/health": {
      "get": {
        "description": "Check if the server is healthy",
        "operationId": "healthCheck",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "status",
                  ],
                  "type": "object",
                },
              },
            },
            "description": "OK",
          },
        },
      },
    },
    "/no-cache-cache-control-tool": {
      "post": {
        "description": "No cache cache control tool",
        "operationId": "noCacheCacheControlTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/no-store-cache-control-tool": {
      "post": {
        "description": "No store cache control tool",
        "operationId": "noStoreCacheControlTool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/pure": {
      "post": {
        "description": "Pure tool",
        "operationId": "pure",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {},
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/strict-additional-properties": {
      "post": {
        "description": "Echoes the request body only allowing a single "foo" field.",
        "operationId": "strictAdditionalProperties",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "foo": {
                    "type": "string",
                  },
                },
                "required": [
                  "foo",
                ],
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "foo": {
                      "type": "string",
                    },
                  },
                  "required": [
                    "foo",
                  ],
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body",
          },
        },
      },
    },
    "/unpure-marked-pure": {
      "post": {
        "description": "Unpure tool marked pure",
        "operationId": "unpure_marked_pure",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {},
                "type": "object",
              },
            },
          },
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "now": {
                      "type": "number",
                    },
                  },
                  "required": [
                    "now",
                  ],
                  "type": "object",
                },
              },
            },
            "description": "Echoed request body with current timestamp to not be pure",
          },
        },
      },
    },
    "/users/{userId}": {
      "get": {
        "description": "Gets a user",
        "operationId": "getUser",
        "parameters": [
          {
            "description": "User ID",
            "in": "path",
            "name": "userId",
            "required": true,
            "schema": {
              "type": "string",
            },
          },
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User",
                },
              },
            },
            "description": "A user object",
          },
        },
        "tags": [
          "users",
        ],
      },
    },
  },
  "webhooks": {},
}
`;

exports[`validateOpenAPISpec > security.json (file url) 1`] = `
{
  "components": {
    "securitySchemes": {
      "apiKey_cookie": {
        "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "cookie",
        "name": "api_key",
        "type": "apiKey",
      },
      "apiKey_header": {
        "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey",
      },
      "apiKey_query": {
        "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "query",
        "name": "apiKey",
        "type": "apiKey",
      },
      "basic": {
        "description": "Basic auth that takes a base64'd combination of \`user:password\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "basic",
        "type": "http",
      },
      "bearer": {
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "bearer_jwt": {
        "bearerFormat": "JWT",
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "oauth2": {
        "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "implicit": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_authorizationCode": {
        "description": "An OAuth 2 security flow that only supports the \`authorizationCode\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_clientCredentials": {
        "description": "An OAuth 2 security flow that only supports the \`clientCredentials\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_implicit": {
        "description": "An OAuth 2 security flow that only supports the \`implicit\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "implicit": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
        },
        "type": "oauth2",
      },
      "oauth2_password": {
        "description": "An OAuth 2 security flow that only supports the \`password\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "openIdConnect": {
        "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
        "type": "openIdConnect",
      },
    },
  },
  "info": {
    "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject",
    "title": "Support for different security types",
    "version": "1.0.0",
  },
  "openapi": "3.0.3",
  "paths": {
    "/anything/apiKey": {
      "get": {
        "description": "\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
        ],
        "summary": "Query parameter",
        "tags": [
          "API Key",
        ],
      },
      "post": {
        "description": "\`apiKey\` auth will be supplied within an \`api_key\` cookie.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_cookie": [],
          },
        ],
        "summary": "Cookie",
        "tags": [
          "API Key",
        ],
      },
      "put": {
        "description": "\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Header",
        "tags": [
          "API Key",
        ],
      },
    },
    "/anything/basic": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "basic": [],
          },
        ],
        "summary": "Basic",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/bearer": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer": [],
          },
        ],
        "summary": "Bearer",
        "tags": [
          "HTTP",
        ],
      },
      "put": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer_jwt": [],
          },
        ],
        "summary": "Bearer (\`jwt\` format)",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/no-auth": {
      "post": {
        "description": "This operation does not have any authentication requirements.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "summary": "No auth requirements",
        "tags": [
          "Other",
        ],
      },
    },
    "/anything/oauth2": {
      "delete": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_password": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (password flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "get": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_authorizationCode": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (authorizationCode flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "patch": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_implicit": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (implicit flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "post": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (all flow types)",
        "tags": [
          "OAuth 2",
        ],
      },
      "put": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_clientCredentials": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (clientCredentials flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
    },
    "/anything/openIdConnect": {
      "post": {
        "description": "🚧 This is not supported.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "openIdConnect": [],
          },
        ],
        "summary": "General support",
        "tags": [
          "OpenID Connect",
        ],
      },
    },
    "/anything/optional-auth": {
      "get": {
        "description": "The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
          {},
        ],
        "summary": "Optional auth",
        "tags": [
          "Other",
        ],
      },
    },
    "/status/401": {
      "post": {
        "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
        "responses": {
          "401": {
            "description": "Unauthorized",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Forced invalid authentication",
        "tags": [
          "Other",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "https://httpbin.org",
    },
  ],
  "tags": [
    {
      "name": "API Key",
    },
    {
      "name": "HTTP",
    },
    {
      "name": "OAuth 2",
    },
    {
      "name": "OpenID Connect",
    },
    {
      "name": "Other",
    },
  ],
}
`;

exports[`validateOpenAPISpec > security.json (http url) 1`] = `
{
  "components": {
    "securitySchemes": {
      "apiKey_cookie": {
        "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "cookie",
        "name": "api_key",
        "type": "apiKey",
      },
      "apiKey_header": {
        "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey",
      },
      "apiKey_query": {
        "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "query",
        "name": "apiKey",
        "type": "apiKey",
      },
      "basic": {
        "description": "Basic auth that takes a base64'd combination of \`user:password\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "basic",
        "type": "http",
      },
      "bearer": {
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "bearer_jwt": {
        "bearerFormat": "JWT",
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "oauth2": {
        "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "implicit": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_authorizationCode": {
        "description": "An OAuth 2 security flow that only supports the \`authorizationCode\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_clientCredentials": {
        "description": "An OAuth 2 security flow that only supports the \`clientCredentials\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_implicit": {
        "description": "An OAuth 2 security flow that only supports the \`implicit\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "implicit": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
        },
        "type": "oauth2",
      },
      "oauth2_password": {
        "description": "An OAuth 2 security flow that only supports the \`password\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "openIdConnect": {
        "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
        "type": "openIdConnect",
      },
    },
  },
  "info": {
    "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject",
    "title": "Support for different security types",
    "version": "1.0.0",
  },
  "openapi": "3.0.3",
  "paths": {
    "/anything/apiKey": {
      "get": {
        "description": "\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
        ],
        "summary": "Query parameter",
        "tags": [
          "API Key",
        ],
      },
      "post": {
        "description": "\`apiKey\` auth will be supplied within an \`api_key\` cookie.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_cookie": [],
          },
        ],
        "summary": "Cookie",
        "tags": [
          "API Key",
        ],
      },
      "put": {
        "description": "\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Header",
        "tags": [
          "API Key",
        ],
      },
    },
    "/anything/basic": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "basic": [],
          },
        ],
        "summary": "Basic",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/bearer": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer": [],
          },
        ],
        "summary": "Bearer",
        "tags": [
          "HTTP",
        ],
      },
      "put": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer_jwt": [],
          },
        ],
        "summary": "Bearer (\`jwt\` format)",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/no-auth": {
      "post": {
        "description": "This operation does not have any authentication requirements.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "summary": "No auth requirements",
        "tags": [
          "Other",
        ],
      },
    },
    "/anything/oauth2": {
      "delete": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_password": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (password flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "get": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_authorizationCode": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (authorizationCode flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "patch": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_implicit": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (implicit flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "post": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (all flow types)",
        "tags": [
          "OAuth 2",
        ],
      },
      "put": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_clientCredentials": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (clientCredentials flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
    },
    "/anything/openIdConnect": {
      "post": {
        "description": "🚧 This is not supported.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "openIdConnect": [],
          },
        ],
        "summary": "General support",
        "tags": [
          "OpenID Connect",
        ],
      },
    },
    "/anything/optional-auth": {
      "get": {
        "description": "The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
          {},
        ],
        "summary": "Optional auth",
        "tags": [
          "Other",
        ],
      },
    },
    "/status/401": {
      "post": {
        "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
        "responses": {
          "401": {
            "description": "Unauthorized",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Forced invalid authentication",
        "tags": [
          "Other",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "https://httpbin.org",
    },
  ],
  "tags": [
    {
      "name": "API Key",
    },
    {
      "name": "HTTP",
    },
    {
      "name": "OAuth 2",
    },
    {
      "name": "OpenID Connect",
    },
    {
      "name": "Other",
    },
  ],
}
`;

exports[`validateOpenAPISpec > security.json (string) 1`] = `
{
  "components": {
    "securitySchemes": {
      "apiKey_cookie": {
        "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "cookie",
        "name": "api_key",
        "type": "apiKey",
      },
      "apiKey_header": {
        "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey",
      },
      "apiKey_query": {
        "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object",
        "in": "query",
        "name": "apiKey",
        "type": "apiKey",
      },
      "basic": {
        "description": "Basic auth that takes a base64'd combination of \`user:password\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "basic",
        "type": "http",
      },
      "bearer": {
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "bearer_jwt": {
        "bearerFormat": "JWT",
        "description": "A bearer token that will be supplied within an \`Authentication\` header as \`bearer <token>\`. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#jwt-bearer-sample",
        "scheme": "bearer",
        "type": "http",
      },
      "oauth2": {
        "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
          "implicit": {
            "authorizationUrl": "http://example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_authorizationCode": {
        "description": "An OAuth 2 security flow that only supports the \`authorizationCode\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_clientCredentials": {
        "description": "An OAuth 2 security flow that only supports the \`clientCredentials\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "clientCredentials": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "oauth2_implicit": {
        "description": "An OAuth 2 security flow that only supports the \`implicit\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "implicit": {
            "authorizationUrl": "http://alt.example.com/oauth/dialog",
            "scopes": {
              "write:things": "Add things to your account",
            },
          },
        },
        "type": "oauth2",
      },
      "oauth2_password": {
        "description": "An OAuth 2 security flow that only supports the \`password\` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
        "flows": {
          "password": {
            "scopes": {
              "write:things": "Add things to your account",
            },
            "tokenUrl": "http://alt.example.com/oauth/token",
          },
        },
        "type": "oauth2",
      },
      "openIdConnect": {
        "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
        "type": "openIdConnect",
      },
    },
  },
  "info": {
    "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject",
    "title": "Support for different security types",
    "version": "1.0.0",
  },
  "openapi": "3.0.3",
  "paths": {
    "/anything/apiKey": {
      "get": {
        "description": "\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
        ],
        "summary": "Query parameter",
        "tags": [
          "API Key",
        ],
      },
      "post": {
        "description": "\`apiKey\` auth will be supplied within an \`api_key\` cookie.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_cookie": [],
          },
        ],
        "summary": "Cookie",
        "tags": [
          "API Key",
        ],
      },
      "put": {
        "description": "\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Header",
        "tags": [
          "API Key",
        ],
      },
    },
    "/anything/basic": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "basic": [],
          },
        ],
        "summary": "Basic",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/bearer": {
      "post": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer": [],
          },
        ],
        "summary": "Bearer",
        "tags": [
          "HTTP",
        ],
      },
      "put": {
        "description": "Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample

> ℹ️
> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "bearer_jwt": [],
          },
        ],
        "summary": "Bearer (\`jwt\` format)",
        "tags": [
          "HTTP",
        ],
      },
    },
    "/anything/no-auth": {
      "post": {
        "description": "This operation does not have any authentication requirements.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "summary": "No auth requirements",
        "tags": [
          "Other",
        ],
      },
    },
    "/anything/oauth2": {
      "delete": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_password": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (password flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "get": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_authorizationCode": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (authorizationCode flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "patch": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_implicit": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (implicit flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
      "post": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (all flow types)",
        "tags": [
          "OAuth 2",
        ],
      },
      "put": {
        "description": "> ℹ️
> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "oauth2_clientCredentials": [
              "write:things",
            ],
          },
        ],
        "summary": "General support (clientCredentials flow type)",
        "tags": [
          "OAuth 2",
        ],
      },
    },
    "/anything/openIdConnect": {
      "post": {
        "description": "🚧 This is not supported.",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "openIdConnect": [],
          },
        ],
        "summary": "General support",
        "tags": [
          "OpenID Connect",
        ],
      },
    },
    "/anything/optional-auth": {
      "get": {
        "description": "The \`apiKey\` query parameter auth on this operation is optional.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object",
        "responses": {
          "200": {
            "description": "OK",
          },
        },
        "security": [
          {
            "apiKey_query": [],
          },
          {},
        ],
        "summary": "Optional auth",
        "tags": [
          "Other",
        ],
      },
    },
    "/status/401": {
      "post": {
        "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.",
        "responses": {
          "401": {
            "description": "Unauthorized",
          },
        },
        "security": [
          {
            "apiKey_header": [],
          },
        ],
        "summary": "Forced invalid authentication",
        "tags": [
          "Other",
        ],
      },
    },
  },
  "servers": [
    {
      "url": "https://httpbin.org",
    },
  ],
  "tags": [
    {
      "name": "API Key",
    },
    {
      "name": "HTTP",
    },
    {
      "name": "OAuth 2",
    },
    {
      "name": "OpenID Connect",
    },
    {
      "name": "Other",
    },
  ],
}
`;

exports[`validateOpenAPISpec > tic-tac-toe.json (file url) 1`] = `
{
  "components": {
    "parameters": {
      "columnParam": {
        "description": "Board column (horizontal coordinate)",
        "in": "path",
        "name": "column",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
      "rowParam": {
        "description": "Board row (vertical coordinate)",
        "in": "path",
        "name": "row",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
    },
    "schemas": {
      "board": {
        "items": {
          "items": {
            "$ref": "#/components/schemas/mark",
          },
          "maxItems": 3,
          "minItems": 3,
          "type": "array",
        },
        "maxItems": 3,
        "minItems": 3,
        "type": "array",
      },
      "coordinate": {
        "example": 1,
        "maximum": 3,
        "minimum": 1,
        "type": "integer",
      },
      "errorMessage": {
        "description": "A text message describing an error",
        "maxLength": 256,
        "type": "string",
      },
      "mark": {
        "description": "Possible values for a board square. \`.\` means empty square.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
      "status": {
        "properties": {
          "board": {
            "$ref": "#/components/schemas/board",
          },
          "winner": {
            "$ref": "#/components/schemas/winner",
          },
        },
        "type": "object",
      },
      "winner": {
        "description": "Winner of the game. \`.\` means nobody has won yet.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
    },
    "securitySchemes": {
      "app2AppOauth": {
        "flows": {
          "clientCredentials": {
            "scopes": {
              "board:read": "Read the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
      "basicHttpAuthentication": {
        "description": "Basic HTTP Authentication",
        "scheme": "Basic",
        "type": "http",
      },
      "bearerHttpAuthentication": {
        "bearerFormat": "JWT",
        "description": "Bearer token using a JWT",
        "scheme": "Bearer",
        "type": "http",
      },
      "defaultApiKey": {
        "description": "API key provided in console",
        "in": "header",
        "name": "api-key",
        "type": "apiKey",
      },
      "user2AppOauth": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://learn.openapis.org/oauth/2.0/auth",
            "scopes": {
              "board:read": "Read the board",
              "board:write": "Write to the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "This API allows writing down marks on a Tic Tac Toe board
and requesting the state of the board or of individual squares.
",
    "title": "Tic Tac Toe",
    "version": "1.0.0",
  },
  "openapi": "3.1.0",
  "paths": {
    "/board": {
      "get": {
        "description": "Retrieves the current state of the board and the winner.",
        "operationId": "get-board",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
        },
        "security": [
          {
            "defaultApiKey": [],
          },
          {
            "app2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get the whole board",
        "tags": [
          "Gameplay",
        ],
      },
    },
    "/board/{row}/{column}": {
      "get": {
        "description": "Retrieves the requested square.",
        "operationId": "get-square",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mark",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "example": "Illegal coordinates",
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get a single board square",
        "tags": [
          "Gameplay",
        ],
      },
      "parameters": [
        {
          "$ref": "#/components/parameters/rowParam",
        },
        {
          "$ref": "#/components/parameters/columnParam",
        },
      ],
      "put": {
        "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
        "operationId": "put-square",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/mark",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "examples": {
                  "illegalCoordinates": {
                    "value": "Illegal coordinates.",
                  },
                  "invalidMark": {
                    "value": "Invalid Mark (X or O).",
                  },
                  "notEmpty": {
                    "value": "Square is not empty.",
                  },
                },
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:write",
            ],
          },
        ],
        "summary": "Set a single board square",
        "tags": [
          "Gameplay",
        ],
      },
    },
  },
  "tags": [
    {
      "name": "Gameplay",
    },
  ],
}
`;

exports[`validateOpenAPISpec > tic-tac-toe.json (http url) 1`] = `
{
  "components": {
    "parameters": {
      "columnParam": {
        "description": "Board column (horizontal coordinate)",
        "in": "path",
        "name": "column",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
      "rowParam": {
        "description": "Board row (vertical coordinate)",
        "in": "path",
        "name": "row",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
    },
    "schemas": {
      "board": {
        "items": {
          "items": {
            "$ref": "#/components/schemas/mark",
          },
          "maxItems": 3,
          "minItems": 3,
          "type": "array",
        },
        "maxItems": 3,
        "minItems": 3,
        "type": "array",
      },
      "coordinate": {
        "example": 1,
        "maximum": 3,
        "minimum": 1,
        "type": "integer",
      },
      "errorMessage": {
        "description": "A text message describing an error",
        "maxLength": 256,
        "type": "string",
      },
      "mark": {
        "description": "Possible values for a board square. \`.\` means empty square.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
      "status": {
        "properties": {
          "board": {
            "$ref": "#/components/schemas/board",
          },
          "winner": {
            "$ref": "#/components/schemas/winner",
          },
        },
        "type": "object",
      },
      "winner": {
        "description": "Winner of the game. \`.\` means nobody has won yet.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
    },
    "securitySchemes": {
      "app2AppOauth": {
        "flows": {
          "clientCredentials": {
            "scopes": {
              "board:read": "Read the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
      "basicHttpAuthentication": {
        "description": "Basic HTTP Authentication",
        "scheme": "Basic",
        "type": "http",
      },
      "bearerHttpAuthentication": {
        "bearerFormat": "JWT",
        "description": "Bearer token using a JWT",
        "scheme": "Bearer",
        "type": "http",
      },
      "defaultApiKey": {
        "description": "API key provided in console",
        "in": "header",
        "name": "api-key",
        "type": "apiKey",
      },
      "user2AppOauth": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://learn.openapis.org/oauth/2.0/auth",
            "scopes": {
              "board:read": "Read the board",
              "board:write": "Write to the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "This API allows writing down marks on a Tic Tac Toe board
and requesting the state of the board or of individual squares.
",
    "title": "Tic Tac Toe",
    "version": "1.0.0",
  },
  "openapi": "3.1.0",
  "paths": {
    "/board": {
      "get": {
        "description": "Retrieves the current state of the board and the winner.",
        "operationId": "get-board",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
        },
        "security": [
          {
            "defaultApiKey": [],
          },
          {
            "app2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get the whole board",
        "tags": [
          "Gameplay",
        ],
      },
    },
    "/board/{row}/{column}": {
      "get": {
        "description": "Retrieves the requested square.",
        "operationId": "get-square",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mark",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "example": "Illegal coordinates",
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get a single board square",
        "tags": [
          "Gameplay",
        ],
      },
      "parameters": [
        {
          "$ref": "#/components/parameters/rowParam",
        },
        {
          "$ref": "#/components/parameters/columnParam",
        },
      ],
      "put": {
        "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
        "operationId": "put-square",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/mark",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "examples": {
                  "illegalCoordinates": {
                    "value": "Illegal coordinates.",
                  },
                  "invalidMark": {
                    "value": "Invalid Mark (X or O).",
                  },
                  "notEmpty": {
                    "value": "Square is not empty.",
                  },
                },
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:write",
            ],
          },
        ],
        "summary": "Set a single board square",
        "tags": [
          "Gameplay",
        ],
      },
    },
  },
  "tags": [
    {
      "name": "Gameplay",
    },
  ],
}
`;

exports[`validateOpenAPISpec > tic-tac-toe.json (string) 1`] = `
{
  "components": {
    "parameters": {
      "columnParam": {
        "description": "Board column (horizontal coordinate)",
        "in": "path",
        "name": "column",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
      "rowParam": {
        "description": "Board row (vertical coordinate)",
        "in": "path",
        "name": "row",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/coordinate",
        },
      },
    },
    "schemas": {
      "board": {
        "items": {
          "items": {
            "$ref": "#/components/schemas/mark",
          },
          "maxItems": 3,
          "minItems": 3,
          "type": "array",
        },
        "maxItems": 3,
        "minItems": 3,
        "type": "array",
      },
      "coordinate": {
        "example": 1,
        "maximum": 3,
        "minimum": 1,
        "type": "integer",
      },
      "errorMessage": {
        "description": "A text message describing an error",
        "maxLength": 256,
        "type": "string",
      },
      "mark": {
        "description": "Possible values for a board square. \`.\` means empty square.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
      "status": {
        "properties": {
          "board": {
            "$ref": "#/components/schemas/board",
          },
          "winner": {
            "$ref": "#/components/schemas/winner",
          },
        },
        "type": "object",
      },
      "winner": {
        "description": "Winner of the game. \`.\` means nobody has won yet.",
        "enum": [
          ".",
          "X",
          "O",
        ],
        "example": ".",
        "type": "string",
      },
    },
    "securitySchemes": {
      "app2AppOauth": {
        "flows": {
          "clientCredentials": {
            "scopes": {
              "board:read": "Read the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
      "basicHttpAuthentication": {
        "description": "Basic HTTP Authentication",
        "scheme": "Basic",
        "type": "http",
      },
      "bearerHttpAuthentication": {
        "bearerFormat": "JWT",
        "description": "Bearer token using a JWT",
        "scheme": "Bearer",
        "type": "http",
      },
      "defaultApiKey": {
        "description": "API key provided in console",
        "in": "header",
        "name": "api-key",
        "type": "apiKey",
      },
      "user2AppOauth": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://learn.openapis.org/oauth/2.0/auth",
            "scopes": {
              "board:read": "Read the board",
              "board:write": "Write to the board",
            },
            "tokenUrl": "https://learn.openapis.org/oauth/2.0/token",
          },
        },
        "type": "oauth2",
      },
    },
  },
  "info": {
    "description": "This API allows writing down marks on a Tic Tac Toe board
and requesting the state of the board or of individual squares.
",
    "title": "Tic Tac Toe",
    "version": "1.0.0",
  },
  "openapi": "3.1.0",
  "paths": {
    "/board": {
      "get": {
        "description": "Retrieves the current state of the board and the winner.",
        "operationId": "get-board",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
        },
        "security": [
          {
            "defaultApiKey": [],
          },
          {
            "app2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get the whole board",
        "tags": [
          "Gameplay",
        ],
      },
    },
    "/board/{row}/{column}": {
      "get": {
        "description": "Retrieves the requested square.",
        "operationId": "get-square",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mark",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "example": "Illegal coordinates",
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:read",
            ],
          },
        ],
        "summary": "Get a single board square",
        "tags": [
          "Gameplay",
        ],
      },
      "parameters": [
        {
          "$ref": "#/components/parameters/rowParam",
        },
        {
          "$ref": "#/components/parameters/columnParam",
        },
      ],
      "put": {
        "description": "Places a mark on the board and retrieves the whole board and the winner (if any).",
        "operationId": "put-square",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/mark",
              },
            },
          },
          "required": true,
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/status",
                },
              },
            },
            "description": "OK",
          },
          "400": {
            "content": {
              "text/html": {
                "examples": {
                  "illegalCoordinates": {
                    "value": "Illegal coordinates.",
                  },
                  "invalidMark": {
                    "value": "Invalid Mark (X or O).",
                  },
                  "notEmpty": {
                    "value": "Square is not empty.",
                  },
                },
                "schema": {
                  "$ref": "#/components/schemas/errorMessage",
                },
              },
            },
            "description": "The provided parameters are incorrect",
          },
        },
        "security": [
          {
            "bearerHttpAuthentication": [],
          },
          {
            "user2AppOauth": [
              "board:write",
            ],
          },
        ],
        "summary": "Set a single board square",
        "tags": [
          "Gameplay",
        ],
      },
    },
  },
  "tags": [
    {
      "name": "Gameplay",
    },
  ],
}
`;


================================================
FILE: packages/openapi-utils/src/get-tools-from-openapi-spec.test.ts
================================================
import { readFile } from 'node:fs/promises'
import path from 'node:path'
import { fileURLToPath } from 'node:url'

import { describe, expect, test } from 'vitest'

import { getToolsFromOpenAPISpec } from './get-tools-from-openapi-spec'
import { validateOpenAPISpec } from './validate-openapi-spec'

const validFixtures = [
  'basic.json',
  'mixed.json',
  'firecrawl.json',
  'open-meteo.yaml',
  'pet-store.json',
  'petstore-expanded.json',
  'security.json',
  'tic-tac-toe.json'
]

const invalidFixtures = ['notion.json']

const fixturesDir = path.join(
  fileURLToPath(import.meta.url),
  '..',
  '..',
  'fixtures'
)

describe('getToolsFromOpenAPISpec', () => {
  test('remote spec https://agentic-platform-fixtures-everything.onrender.com/docs', async () => {
    const source =
      'https://agentic-platform-fixtures-everything.onrender.com/docs'
    const spec = await validateOpenAPISpec(source, {
      dereference: true
    })
    const result = await getToolsFromOpenAPISpec(spec)
    expect(result).toMatchSnapshot()
  })

  for (const fixture of validFixtures) {
    test(
      fixture,
      {
        timeout: 60_000
      },
      async () => {
        const fixturePath = path.join(fixturesDir, fixture)
        const source = await readFile(fixturePath, 'utf8')

        const spec = await validateOpenAPISpec(source, {
          dereference: true
        })
        const result = await getToolsFromOpenAPISpec(spec)

        expect(result).toMatchSnapshot()
      }
    )
  }

  for (const fixture of invalidFixtures) {
    test(
      `${fixture} (invalid)`,
      {
        timeout: 60_000
      },
      async () => {
        const fixturePath = path.join(fixturesDir, fixture)
        const source = await readFile(fixturePath, 'utf8')

        const spec = await validateOpenAPISpec(source, {
          dereference: true
        })

        await expect(async () =>
          getToolsFromOpenAPISpec(spec)
        ).rejects.toThrowError()
      }
    )
  }
})


================================================
FILE: packages/openapi-utils/src/get-tools-from-openapi-spec.ts
================================================
import { assert, parseZodSchema } from '@agentic/platform-core'
import {
  type OpenAPIOperationHttpMethod,
  type OpenAPIOperationParameterSource,
  type OpenAPIToolOperation,
  openapiToolOperationSchema,
  type Tool,
  toolSchema
} from '@agentic/platform-types'
import decamelize from 'decamelize'

import type {
  DereferencedLooseOpenAPI3Spec,
  OperationObject,
  ParameterObject,
  SchemaObject
} from './types'
import { convertParametersToJsonSchema } from './openapi-parameters-to-json-schema'
import { camelCase, mergeJsonSchemaObjects } from './utils'

const jsonContentType = 'application/json'
const multipartFormData = 'multipart/form-data'
// const applicationFormUrlEncoded = 'application/x-www-form-urlencoded'

const httpMethods = ['get', 'post', 'put', 'delete', 'patch', 'trace'] as const
const paramSources = ['body', 'formData', 'header', 'path', 'query'] as const

/**
 * Converts a fully dereferenced and validated OpenAPI spec into an array of
 * MCP-compatible tools, with a map of tool names to their corresponding OpenAPI
 * operations.
 *
 * This allows us to expose OpenAPI HTTP operations as MCP tools and convert
 * MCP tool calls to corresponding HTTP requests.
 */
export async function getToolsFromOpenAPISpec(
  spec: DereferencedLooseOpenAPI3Spec
): Promise<{
  tools: Tool[]
  toolToOperationMap: Record<string, OpenAPIToolOperation>
}> {
  const tools: Tool[] = []
  const toolToOperationMap: Record<string, OpenAPIToolOperation> = {}

  const operationResponsePaths = [
    ['responses', '200', 'content', jsonContentType, 'schema'],
    ['responses', '201', 'content', jsonContentType, 'schema']
    // ['responses', 'default', 'content', jsonContentType, 'schema']
  ]

  const operationRequestPaths = [
    ['requestBody', 'content', jsonContentType, 'schema'],
    ['requestBody', 'content', multipartFormData, 'schema']
    // TODO: Support application/x-www-form-urlencoded bodies
    // ['requestBody', 'content', applicationFormUrlEncoded, 'schema']
  ]

  const operationNames = new Set<string>()

  for (const path in spec.paths) {
    const pathItem = spec.paths[path]
    assert(pathItem)
    // console.log(JSON.stringify(pathItem, null, 2))

    const pathParamsJsonSchema = {
      type: 'object',
      properties: {} as Record<string, SchemaObject>,
      required: [] as string[]
    } satisfies SchemaObject
    const pathParamsSources: Record<string, OpenAPIOperationParameterSource> =
      {}

    if (pathItem.parameters) {
      const params = convertParametersToJsonSchema(
        pathItem.parameters as ParameterObject[]
      )

      for (const source of paramSources) {
        if (params[source]) {
          mergeJsonSchemaObjects(pathParamsJsonSchema, params[source], {
            source,
            sources: pathParamsSources,
            label: `path "${path}"`
          })
        }
      }
    }

    for (const method of httpMethods) {
      const operation = pathItem[method] as OperationObject
      if (!operation) {
        continue
      }

      const operationId =
        operation.operationId || `${method}${path.replaceAll(/\W+/g, '_')}`
      assert(
        operationId,
        `Invalid operation id "${operationId}" for OpenAPI path "${method} ${path}"`
      )

      const operationName = camelCase(operationId.replaceAll('/', '_'))
      const operationNameSnakeCase = decamelize(operationName)
      assert(
        !operationNames.has(operationName),
        `Duplicate operation name "${operationName}"`
      )
      operationNames.add(operationName)

      const operationParamsJsonSchema = structuredClone(pathParamsJsonSchema)
      const operationParamsSources: Record<
        string,
        OpenAPIOperationParameterSource
      > = structuredClone(pathParamsSources)
      const operationResponseJsonSchemas: Record<string, SchemaObject> = {}

      for (const schemaPath of operationRequestPaths) {
        let current: any = operation
        for (const key of schemaPath) {
          current = current[key]
          if (!current) break
        }

        if (current) {
          mergeJsonSchemaObjects(operationParamsJsonSchema, current, {
            source: schemaPath[2] === jsonContentType ? 'body' : 'formData',
            sources: operationParamsSources,
            label: `operation "${operationId}"`
          })
          break
        }
      }

      for (const schemaPath of operationResponsePaths) {
        let current: any = operation
        for (const key of schemaPath) {
          current = current[key]
          if (!current) break
        }

        if (current) {
          const status = schemaPath[1]!
          assert(
            status,
            `Invalid status ${status} for operation ${operationName}`
          )

          if (current.type !== 'object') {
            // console.warn(
            //   `Invalid OpenAPI response type "${current.type}" for operation "${operationName}"`
            // )
            break
          }

          operationResponseJsonSchemas[status] = current
          break
        }
      }

      if (operation.parameters) {
        const params = convertParametersToJsonSchema(
          operation.parameters as ParameterObject[]
        )

        for (const source of paramSources) {
          if (params[source]) {
            mergeJsonSchemaObjects(operationParamsJsonSchema, params[source], {
              source,
              sources: operationParamsSources,
              label: `operation "${operationId}"`
            })
          }
        }
      }

      const operationResponseJsonSchema =
        operationResponseJsonSchemas['200'] ||
        operationResponseJsonSchemas['201']
      const description = operation.description || operation.summary
      const { tags } = operation

      tools.push(
        parseZodSchema(
          toolSchema,
          {
            name: operationNameSnakeCase,
            description,
            inputSchema: operationParamsJsonSchema,
            outputSchema: operationResponseJsonSchema
          },
          {
            statusCode: 400
          }
        )
      )

      toolToOperationMap[operationNameSnakeCase] = parseZodSchema(
        openapiToolOperationSchema,
        {
          operationId,
          method: method.toLowerCase() as OpenAPIOperationHttpMethod,
          path,
          parameterSources: operationParamsSources,
          tags
        },
        {
          statusCode: 400
        }
      )
    }
  }

  return {
    tools,
    toolToOperationMap
  }
}


================================================
FILE: packages/openapi-utils/src/index.ts
================================================
export * from './get-tools-from-openapi-spec'
export * from './redocly-config'
export type * from './types'
export * from './validate-json-schema-object'
export * from './validate-openapi-spec'


================================================
FILE: packages/openapi-utils/src/openapi-parameters-to-json-schema.ts
================================================
/**
 * This file is forked from: https://github.com/kogosoftwarellc/open-api/tree/main/packages/openapi-jsonschema-parameters
 *
 * Several fixes have been applied.
 *
 * The original code is licensed under the MIT license.
 */

import type { ParameterObject, SchemaObject } from './types'

export interface OpenAPIParametersAsJsonSchema {
  body?: SchemaObject
  formData?: SchemaObject
  header?: SchemaObject
  path?: SchemaObject
  query?: SchemaObject
  cookie?: SchemaObject
}

const VALIDATION_KEYWORDS = new Set([
  'additionalItems',
  'default',
  'example',
  'description',
  'enum',
  'examples',
  'exclusiveMaximum',
  'exclusiveMinimum',
  'format',
  'items',
  'maxItems',
  'maxLength',
  'maximum',
  'minItems',
  'minLength',
  'minimum',
  'multipleOf',
  'pattern',
  'title',
  'type',
  'uniqueItems'
])

const SUBSCHEMA_KEYWORDS = [
  'additionalItems',
  'items',
  'contains',
  'additionalProperties',
  'propertyNames',
  'not'
]

const SUBSCHEMA_ARRAY_KEYWORDS = ['items', 'allOf', 'anyOf', 'oneOf']

const SUBSCHEMA_OBJECT_KEYWORDS = [
  'definitions',
  'properties',
  'patternProperties',
  'dependencies'
]

export function convertParametersToJsonSchema(
  parameters: ParameterObject[]
): OpenAPIParametersAsJsonSchema {
  const parametersSchema: OpenAPIParametersAsJsonSchema = {}
  const bodySchema = getBodySchema(parameters)
  const formDataSchema = getSchema(parameters, 'formData')
  const headerSchema = getSchema(parameters, 'header')
  const pathSchema = getSchema(parameters, 'path')
  const querySchema = getSchema(parameters, 'query')
  const cookieSchema = getSchema(parameters, 'cookie')

  if (bodySchema) {
    parametersSchema.body = bodySchema
  }

  if (formDataSchema) {
    parametersSchema.formData = formDataSchema
  }

  if (headerSchema) {
    parametersSchema.header = headerSchema
  }

  if (pathSchema) {
    parametersSchema.path = pathSchema
  }

  if (querySchema) {
    parametersSchema.query = querySchema
  }

  if (cookieSchema) {
    parametersSchema.cookie = cookieSchema
  }

  return parametersSchema
}

function copyValidationKeywords(src: any) {
  const dst: any = {}
  for (let i = 0, keys = Object.keys(src), len = keys.length; i < len; i++) {
    const keyword = keys[i]
    if (!keyword) continue

    if (VALIDATION_KEYWORDS.has(keyword) || keyword.slice(0, 2) === 'x-') {
      dst[keyword] = src[keyword]
    }
  }
  return dst
}

function handleNullable(schema: SchemaObject) {
  return { anyOf: [schema, { type: 'null' }] }
}

function handleNullableSchema(schema: any) {
  if (typeof schema !== 'object' || schema === null) {
    return schema
  }

  const newSchema = { ...schema }

  for (const keyword of SUBSCHEMA_KEYWORDS) {
    if (
      typeof schema[keyword] === 'object' &&
      schema[keyword] !== null &&
      !Array.isArray(schema[keyword])
    ) {
      newSchema[keyword] = handleNullableSchema(schema[keyword])
    }
  }

  for (const keyword of SUBSCHEMA_ARRAY_KEYWORDS) {
    if (Array.isArray(schema[keyword])) {
      newSchema[keyword] = schema[keyword].map(handleNullableSchema)
    }
  }

  for (const keyword of SUBSCHEMA_OBJECT_KEYWORDS) {
    if (typeof schema[keyword] === 'object' && schema[keyword] !== null) {
      newSchema[keyword] = { ...schema[keyword] }
      for (const prop of Object.keys(schema[keyword])) {
        newSchema[keyword][prop] = handleNullableSchema(schema[keyword][prop])
      }
    }
  }

  delete newSchema.$ref

  if (schema.nullable) {
    delete newSchema.nullable
    return handleNullable(newSchema)
  }

  return newSchema
}

function getBodySchema(parameters: any[]) {
  let bodySchema = parameters.find((param) => {
    return param.in === 'body' && param.schema
  })

  if (bodySchema) {
    bodySchema = bodySchema.schema
  }

  return bodySchema
}

function getSchema(parameters: any[], type: string) {
  const params = parameters.filter(byIn(type))
  let schema: any

  if (params.length) {
    schema = { type: 'object', properties: {} }

    for (const param of params) {
      let paramSchema = copyValidationKeywords(param)

      if ('schema' in param) {
        paramSchema = {
          ...paramSchema,
          ...handleNullableSchema(param.schema)
        }

        if ('examples' in param) {
          paramSchema.examples = getExamples(param.examples)
        }

        schema.properties[param.name] = paramSchema
      } else {
        if ('examples' in paramSchema) {
          paramSchema.examples = getExamples(paramSchema.examples)
        }

        schema.properties[param.name] = param.nullable
          ? handleNullable(paramSchema)
          : paramSchema
      }
    }

    // TODO: support openai strict mode by default (all params must be required,
    // and optional params without defaults must be nullable)

    schema.required = getRequiredParams(params)
  }

  return schema
}

function getRequiredParams(parameters: any[]) {
  return parameters.filter(byRequired).map(toName)
}

function getExamples(exampleSchema: any) {
  return Object.keys(exampleSchema).map((k) => exampleSchema[k].value)
}

function byIn(str: string) {
  return (param: any) => param.in === str && param.type !== 'file'
}

function byRequired(param: any) {
  return !!param.required
}

function toName(param: any) {
  return param.name
}


================================================
FILE: packages/openapi-utils/src/redocly-config.ts
================================================
import {
  type Config as RedoclyConfig,
  createConfig
} from '@redocly/openapi-core'

// Cache the default Redocly config to avoid re-creating it on every call
let _defaultRedoclyConfig: RedoclyConfig | undefined

export async function getDefaultRedoclyConfig(): Promise<RedoclyConfig> {
  if (!_defaultRedoclyConfig) {
    _defaultRedoclyConfig = await createConfig(
      {
        rules: {
          // throw error on duplicate operationIds
          'operation-operationId-unique': { severity: 'error' }
        }
      },
      { extends: ['minimal'] }
    )
  }

  return _defaultRedoclyConfig
}


================================================
FILE: packages/openapi-utils/src/types.ts
================================================
// These loose OpenAPI types are taken from https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/src/types.ts

// Note: these OpenAPI types are meant only for internal use, not external
// consumption. Some formatting may be better in other libraries meant for
// consumption. Some typing may be “loose” or “incorrect” in order to guarantee
// that all logical paths are handled. In other words, these are built more
// for ways schemas _can_ be written, not necessarily how they _should_ be.

export interface Extensible {
  [key: `x-${string}`]: any
}

/**
 * [4.8] Schema
 * @see https://spec.openapis.org/oas/v3.1.0#schema
 */
export interface LooseOpenAPI3Spec extends Extensible {
  /** REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API info.version string. */
  openapi: string
  /** REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */
  info: InfoObject // required
  /** The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI. */
  jsonSchemaDialect?: string
  /** An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /. */
  servers?: ServerObject[]
  /** The available paths and operations for the API. */
  paths?: PathsObject
  /** The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available. */
  webhooks?: { [id: string]: PathItemObject | ReferenceObject }
  /** An element to hold various schemas for the document. */
  components?: ComponentsObject
  /** A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array. */
  security?: SecurityRequirementObject[]
  /** A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique. */
  tags?: TagObject[]
  /** Additional external documentation. */
  externalDocs?: ExternalDocumentationObject
  $defs?: $defs
}

/**
 * [4.8.2] Info Object
 * The object provides metadata about the API.
 */
export interface InfoObject extends Extensible {
  /** REQUIRED. The title of the API. */
  title: string
  /** A short summary of the API. */
  summary?: string
  /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** A URL to the Terms of Service for the API. This MUST be in the form of a URL. */
  termsOfService?: string
  /** The contact information for the exposed API. */
  contact?: ContactObject
  /** The license information for the exposed API. */
  license?: LicenseObject
  /** REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). */
  version: string
}

/**
 * [4.8.3] Contact Object
 * Contact information for the exposed API.
 */
export interface ContactObject extends Extensible {
  /** The identifying name of the contact person/organization. */
  name?: string
  /** The URL pointing to the contact information. This MUST be in the form of a URL. */
  url?: string
  /** The email address of the contact person/organization. This MUST be in the form of an email address. */
  email?: string
}

/**
 * [4.8.4] License object
 * License information for the exposed API.
 */
export interface LicenseObject extends Extensible {
  /** REQUIRED. The license name used for the API. */
  name: string
  /** An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. */
  identifier: string
  /** A URL to the license used for the API. This MUST be in the form of a URL. The url field is mutually exclusive of the identifier field. */
  url: string
}

/**
 * [4.8.5] Server Object
 * An object representing a Server.
 */
export interface ServerObject extends Extensible {
  /** REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}. */
  url: string
  /** An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. */
  description: string
  /** A map between a variable name and its value. The value is used for substitution in the server’s URL template. */
  variables: { [name: string]: ServerVariableObject }
}

/**
 * [4.8.6] Server Variable Object
 * An object representing a Server Variable for server URL template substitution.
 */
export interface ServerVariableObject extends Extensible {
  /** An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. */
  enum?: string[]
  /** REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object’s treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value MUST exist in the enum’s values. */
  default: string
  /** An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. */
  description?: string
}

/**
 * [4.8.7] Components Object
 * Holds a set of reusable objects for different aspects of the OAS.
 */
export interface ComponentsObject extends Extensible {
  /** An object to hold reusable Schema Objects.*/
  schemas?: Record<string, SchemaObject>
  /** An object to hold reusable Response Objects. */
  responses?: Record<string, ResponseObject | ReferenceObject>
  /** An object to hold reusable Parameter Objects. */
  parameters?: Record<string, ParameterObject | ReferenceObject>
  /** An object to hold reusable Example Objects. */
  examples?: Record<string, ExampleObject | ReferenceObject>
  /** An object to hold reusable Request Body Objects. */
  requestBodies?: Record<string, RequestBodyObject | ReferenceObject>
  /** An object to hold reusable Header Objects. */
  headers?: Record<string, HeaderObject | ReferenceObject>
  /** An object to hold reusable Security Scheme Objects. */
  securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>
  /** An object to hold reusable Link Objects. */
  links?: Record<string, LinkObject | ReferenceObject>
  /** An object to hold reusable Callback Objects. */
  callbacks?: Record<string, CallbackObject | ReferenceObject>
  /** An object to hold reusable Path Item Objects. */
  pathItems?: Record<string, PathItemObject | ReferenceObject>
}

/**
 * [4.8.8] Paths Object
 * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to Access Control List (ACL) constraints.
 */
export interface PathsObject {
  [pathname: string]: PathItemObject | ReferenceObject // note: paths object does support $refs; the schema just defines it in a weird way
}

/**
 * [x.x.x] Webhooks Object
 * Holds the webhooks definitions, indexed by their names. A webhook is defined by a Path Item Object; the only difference is that the request is initiated by the API provider.
 */
export interface WebhooksObject {
  [name: string]: PathItemObject
}

/**
 * [4.8.9] Path Item Object
 * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
 */
export interface PathItemObject extends Extensible {
  /** A definition of a GET operation on this path. */
  get?: OperationObject | ReferenceObject
  /** A definition of a PUT operation on this path. */
  put?: OperationObject | ReferenceObject
  /** A definition of a POST operation on this path. */
  post?: OperationObject | ReferenceObject
  /** A definition of a DELETE operation on this path. */
  delete?: OperationObject | ReferenceObject
  /** A definition of a OPTIONS operation on this path. */
  options?: OperationObject | ReferenceObject
  /** A definition of a HEAD operation on this path. */
  head?: OperationObject | ReferenceObject
  /** A definition of a PATCH operation on this path. */
  patch?: OperationObject | ReferenceObject
  /** A definition of a TRACE operation on this path. */
  trace?: OperationObject | ReferenceObject
  /** An alternative server array to service all operations in this path. */
  servers?: ServerObject[]
  /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters. */
  parameters?: (ParameterObject | ReferenceObject)[]
}

/**
 * [4.8.10] Operation Object
 * Describes a single API operation on a path.
 */
export interface OperationObject extends Extensible {
  /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
  tags?: string[]
  /** A short summary of what the operation does. */
  summary?: string
  /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** Additional external documentation for this operation. */
  externalDocs?: ExternalDocumentationObject
  /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */
  operationId?: string
  /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters. */
  parameters?: (ParameterObject | ReferenceObject)[]
  /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
  requestBody?: RequestBodyObject | ReferenceObject
  /** The list of possible responses as they are returned from executing this operation. */
  responses?: ResponsesObject
  /** A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. */
  callbacks?: Record<string, CallbackObject | ReferenceObject>
  /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */
  deprecated?: boolean
  /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */
  security?: SecurityRequirementObject[]
  /** An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value. */
  servers?: ServerObject[]
}

/**
 * [4.8.11] External Documentation Object
 * Allows referencing an external resource for extended documentation.
 */
export interface ExternalDocumentationObject extends Extensible {
  /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** REQUIRED. The URL for the target documentation. This MUST be in the form of a URL. */
  url: string
}

/**
 * [4.8.12] Parameter Object
 * Describes a single operation parameter.
 * A unique parameter is defined by a combination of a name and location.
 */
export interface ParameterObject extends Extensible {
  /**
   * REQUIRED. The name of the parameter. Parameter names are case sensitive.
   *
   * - If `in` is `"path"`, the `name` field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
   * - If `in` is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
   * - For all other cases, the `name` corresponds to the parameter name used by the `in` property.
   */
  name: string
  /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".*/
  in: 'query' | 'header' | 'path' | 'cookie'
  /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false. */
  required?: boolean
  /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
  deprecated?: boolean
  /** Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. */
  allowEmptyValue?: boolean
  /** Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form. */
  style?: string
  /** When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When `style` is `form`, the default value is `true`. For all other styles, the default value is `false`. */
  explode?: boolean
  /** Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986] `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. */
  allowReserved?: boolean
  /** The schema defining the type used for the parameter. */
  schema?: SchemaObject
  /** Example of the parameter’s potential value. */
  example?: any
  /** Examples of the parameter’s potential value. */
  examples?: { [name: string]: ExampleObject | ReferenceObject }
  /** A map containing the representations for the parameter. */
  content?: { [contentType: string]: MediaTypeObject | ReferenceObject }
}

/**
 * [4.8.13] Request Body Object
 * Describes a single request body.
 */
export interface RequestBodyObject extends Extensible {
  /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text */
  content: { [contentType: string]: MediaTypeObject | ReferenceObject }
  /** Determines if the request body is required in the request. Defaults to false. */
  required?: boolean
}

/**
 * [4.8.14] Media Type Object
 */
export interface MediaTypeObject extends Extensible {
  /** The schema defining the content of the request, response, or parameter. */
  schema?: SchemaObject | ReferenceObject
  /** Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. */
  example?: any
  /** Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema. */
  examples?: { [name: string]: ExampleObject | ReferenceObject }
  /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded. */
  encoding?: { [propertyName: string]: EncodingObject }
}

/**
 * [4.8.15] Encoding Object
 * A single encoding definition applied to a single schema property.
 */
export interface EncodingObject extends Extensible {
  /** The Content-Type for encoding a specific property. Default value depends on the property type: for object - application/json; for array – the default is defined based on the inner type; for all other cases the default is application/octet-stream. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types. */
  contentType?: string
  /** A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart. */
  headers?: { [name: string]: HeaderObject | ReferenceObject }
  /** Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
  style?: string
  /** When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
  explode?: string
  /** Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986] :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored. */
  allowReserved?: string
}

/**
 * [4.8.16] Responses Object
 * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
 */
export type ResponsesObject = {
  [responseCode: string]: ResponseObject | ReferenceObject
} & {
  /** The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. */
  default?: ResponseObject | ReferenceObject
}

/**
 * [4.8.17] Response Object
 * Describes a single response from an API Operation, including design-time, static links to operations based on the response.
 */
export interface ResponseObject extends Extensible {
  /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
  description: string
  /** Maps a header name to its definition. [RFC7230] states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
  headers?: { [name: string]: HeaderObject | ReferenceObject }
  /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text */
  content?: { [contentType: string]: MediaTypeObject }
  /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
  links?: { [name: string]: LinkObject | ReferenceObject }
}

/**
 * [4.8.18] Callback Object
 * A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
 */
export type CallbackObject = Record<string, PathItemObject>

/**
 * [4.8.19[ Example Object
 */
export interface ExampleObject extends Extensible {
  /** Short description for the example. */
  summary?: string
  /** Long description for the example. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
  value?: any
  /** A URI that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References. */
  externalValue?: string
}

/**
 * [4.8.20] Link Object
 * The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
 */
export interface LinkObject extends Extensible {
  /** A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition. See the rules for resolving Relative References. */
  operationRef?: string
  /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */
  operationId?: string
  /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id). */
  parameters?: { [name: string]: `$${string}` }
  /** A literal value or {expression} to use as a request body when calling the target operation. */
  requestBody?: `$${string}`
  /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** A server object to be used by the target operation. */
  server?: ServerObject
}

/**
 * [4.8.21] Header Object
 * The Header Object follows the structure of the Parameter Object with the following changes:
 *
 * 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map.
 * 2. `in` MUST NOT be specified, it is implicitly in `header`.
 * 3. All traits that are affected by the location MUST be applicable to a location of `heade`r (for example, `style`).
 */
export type HeaderObject = Omit<ParameterObject, 'name' | 'in'>

/**
 * [4.8.22] Tag Object
 * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
 */
export interface TagObject extends Extensible {
  /** REQUIRED. The name of the tag. */
  name: string
  /** A description for the tag. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  /** Additional external documentation for this tag. */
  externalDocs?: ExternalDocumentationObject
}

/**
 * [4.8.23] Reference Object
 * A simple object to allow referencing other components in the OpenAPI document, internally and externally. The $ref string value contains a URI [RFC3986], which identifies the location of the value being referenced. See the rules for resolving Relative References.
 */
export interface ReferenceObject extends Extensible {
  /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
  $ref: string
  /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
  summary?: string
  /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
  description?: string
}

/**
 * [4.8.24] Schema Object
 * The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12.
 */
export type SchemaObject = {
  /** The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12. */
  discriminator?: DiscriminatorObject
  /** MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
  xml?: XMLObject
  /** Additional external documentation for this schema. */
  externalDocs?: ExternalDocumentationObject
  /** @deprecated */
  example?: any
  title?: string
  description?: string
  $comment?: string
  deprecated?: boolean
  readOnly?: boolean
  writeOnly?: boolean
  enum?: unknown[]
  /** Use of this keyword is functionally equivalent to an "enum" (Section 6.1.2) with a single value. */
  const?: unknown
  default?: unknown
  format?: string
  /** @deprecated in 3.1 (still valid for 3.0) */
  nullable?: boolean
  oneOf?: (SchemaObject | ReferenceObject)[]
  allOf?: (SchemaObject | ReferenceObject)[]
  anyOf?: (SchemaObject | ReferenceObject)[]
  required?: string[]
  [key: `x-${string}`]: any
} & (
  | StringSubtype
  | NumberSubtype
  | IntegerSubtype
  | ArraySubtype
  | BooleanSubtype
  | NullSubtype
  | ObjectSubtype
  | {
      type: (
        | 'string'
        | 'number'
        | 'integer'
        | 'array'
        | 'boolean'
        | 'null'
        | 'object'
      )[]
    }
)

export interface StringSubtype {
  type: 'string' | ['string', 'null']
  enum?: (string | ReferenceObject)[]
}

export interface NumberSubtype {
  type: 'number' | ['number', 'null']
  minimum?: number
  maximum?: number
  enum?: (number | ReferenceObject)[]
}

export interface IntegerSubtype {
  type: 'integer' | ['integer', 'null']
  minimum?: number
  maximum?: number
  enum?: (number | ReferenceObject)[]
}

export interface ArraySubtype {
  type: 'array' | ['array', 'null']
  prefixItems?: (SchemaObject | ReferenceObject)[]
  items?: SchemaObject | ReferenceObject | (SchemaObject | ReferenceObject)[]
  minItems?: number
  maxItems?: number
  enum?: (SchemaObject | ReferenceObject)[]
}

export interface BooleanSubtype {
  type: 'boolean' | ['boolean', 'null']
  enum?: (boolean | ReferenceObject)[]
}

export interface NullSubtype {
  type: 'null'
}

export interface ObjectSubtype {
  type: 'object' | ['object', 'null']
  properties?: { [name: string]: SchemaObject | ReferenceObject }
  additionalProperties?:
    | boolean
    | Record<string, never>
    | SchemaObject
    | ReferenceObject
  required?: string[]
  allOf?: (SchemaObject | ReferenceObject)[]
  anyOf?: (SchemaObject | ReferenceObject)[]
  enum?: (SchemaObject | ReferenceObject)[]
  $defs?: $defs
}

/**
 * [4.8.25] Discriminator Object
 * When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it.
 */
export interface DiscriminatorObject {
  /** REQUIRED. The name of the property in the payload that will hold the discriminator value. */
  propertyName: string
  /** An object to hold mappings between payload values and schema names or references. */
  mapping?: Record<string, string>
  /** If this exists, then a discriminator type should be added to objects matching this path */
  oneOf?: string[]
}

/**
 * [4.8.26] XML Object
 * A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior.
 */
export interface XMLObject extends Extensible {
  /** Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. */
  name?: string
  /** The URI of the namespace definition. This MUST be in the form of an absolute URI. */
  namespace?: string
  /** The prefix to be used for the name. */
  prefix?: string
  /** Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. */
  attribute?: boolean
  /** MAY be used only for an array definition. Signifies whether the array is wrapped (for example, `<books><book/><book/></books>`) or unwrapped (`<book/><book/>`). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). */
  wrapped?: boolean
}

/**
 * [4.8.27] Security Scheme Object
 * Defines a security scheme that can be used by the operations.
 */
export type SecuritySchemeObject = {
  /** A description for security scheme. CommonMark syntax MAY be used for rich text representation. */
  description?: string
  [key: `x-${string}`]: any
} & (
  | {
      /** REQUIRED. The type of the security scheme. */
      type: 'apiKey'
      /** REQUIRED. The name of the header, query or cookie parameter to be used. */
      name: string
      /** REQUIRED. The location of the API key. */
      in: 'query' | 'header' | 'cookie'
    }
  | {
      /** REQUIRED. The type of the security scheme. */
      type: 'http'
      /** REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry. */
      scheme: string
      /** A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. */
      bearer?: string
    }
  | {
      /** REQUIRED. The type of the security scheme. */
      type: 'mutualTLS'
    }
  | {
      /** REQUIRED. Tye type of the security scheme. */
      type: 'oauth2'
      /** REQUIRED. An object containing configuration information for the flow types supported. */
      flows: OAuthFlowsObject
    }
  | {
      /** REQUIRED. Tye type of the security scheme. */
      type: 'openIdConnect'
      /** REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS. */
      openIdConnectUrl: string
    }
)

/**
 * [4.8.26] OAuth Flows Object
 * Allows configuration of the supported OAuth Flows.
 */
export interface OAuthFlowsObject extends Extensible {
  /** Configuration for the OAuth Implicit flow */
  implicit?: OAuthFlowObject
  /** Configuration for the OAuth Resource Owner Password flow */
  password?: OAuthFlowObject
  /** Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. */
  clientCredentials?: OAuthFlowObject
  /** Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. */
  authorizationCode?: OAuthFlowObject
}

/**
 * [4.8.29] OAuth Flow Object
 * Configuration details for a supported OAuth Flow
 */
export interface OAuthFlowObject extends Extensible {
  /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
  authorizationUrl: string
  /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
  tokenUrl: string
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
  refreshUrl: string
  /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
  scopes: { [name: string]: string }
}

/**
 * [4.8.30] Security Requirements Object
 * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.
 */
export type SecurityRequirementObject = {
  [P in keyof ComponentsObject['securitySchemes']]?: string[]
}

export type $defs = Record<string, SchemaObject>

type Deref<T> =
  // 1. Remove any direct ReferenceObject
  T extends ReferenceObject
    ? never
    : // 2. Recurse into arrays/tuples
      T extends readonly (infer U)[]
      ? readonly Deref<U>[]
      : // 3. Recurse into object properties
        T extends object
        ? { [K in keyof T]: Deref<T[K]> }
        : // 4. Primitives, functions, etc. stay unchanged
          T

/** LooseOpenAPI3Spec with every `$ref` wiped out */
export type DereferencedLooseOpenAPI3Spec = Deref<LooseOpenAPI3Spec>


================================================
FILE: packages/openapi-utils/src/utils.ts
================================================
import type { OpenAPIOperationParameterSource } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import camelCaseImpl from 'camelcase'

import type { ObjectSubtype, SchemaObject } from './types'

export function camelCase(identifier: string): string {
  return camelCaseImpl(identifier)
}

export function mergeJsonSchemaObjects(
  schema0: SchemaObject & ObjectSubtype,
  schema1: SchemaObject,
  {
    source,
    sources,
    label
  }: {
    source: OpenAPIOperationParameterSource
    sources: Record<string, OpenAPIOperationParameterSource>
    label: string
  }
) {
  // TODO: Support cookie parameters
  assert(
    source !== 'cookie',
    'Cookie parameters for OpenAPI operations are not yet supported. If you need cookie parameter support, please contact support@agentic.so.'
  )

  if (schema1.type === 'object' && schema1.properties) {
    schema0.properties = {
      ...schema0.properties,
      ...schema1.properties
    }

    for (const key of Object.keys(schema1.properties)) {
      assert(
        !sources[key],
        `Duplicate parameter "${key}" in OpenAPI spec ${label}`
      )

      sources[key] = source
    }
  }

  if (schema1.required) {
    schema0.required = Array.from(
      new Set([...(schema0.required || []), ...schema1.required])
    )
  }

  // https://community.openai.com/t/official-documentation-for-supported-schemas-for-response-format-parameter-in-calls-to-client-beta-chats-completions-parse/932422/3
  // https://platform.openai.com/docs/guides/structured-outputs
  // https://json-schema.org/understanding-json-schema/reference/combining
  assert(
    !schema1.oneOf,
    `JSON schema "oneOf" is not supported in OpenAPI spec ${label}`
  )
  assert(
    !schema1.allOf,
    `JSON schema "oneOf" is not supported in OpenAPI spec ${label}`
  )
  // TODO: Support "anyOf" which should be supported by OpenAI function calling
  assert(
    !schema1.anyOf,
    `JSON schema "anyOf" is not supported in OpenAPI spec ${label}`
  )
}


================================================
FILE: packages/openapi-utils/src/validate-json-schema-object.ts
================================================
import { assert, hashObject, HttpError } from '@agentic/platform-core'
import { betterAjvErrors } from '@apideck/better-ajv-errors'
import Ajv, { type ValidateFunction } from 'ajv'
import addFormats from 'ajv-formats'
import fastUri from 'fast-uri'
import plur from 'plur'

const globalAjv = new Ajv({
  coerceTypes: true,
  useDefaults: true,
  removeAdditional: true,
  uriResolver: fastUri,
  // Explicitly set allErrors to `false`.
  // When set to `true`, a DoS attack is possible.
  allErrors: false
})

// https://github.com/ajv-validator/ajv-formats
addFormats(globalAjv)

/**
 * Validates `data` against the provided JSON schema.
 *
 * This method uses `ajv` and is therefore not compatible with CF workers due
 * to its use of code generation and evaluation.
 *
 * The API gateway uses `cfValidateJsonSchemaObject`, which is looser but
 * special-cased for CF workers.
 *
 * @see https://github.com/ajv-validator/ajv/issues/2318
 */
export async function validateJsonSchema<T = unknown>({
  schema,
  data,
  ajv = globalAjv,
  errorMessage
}: {
  schema: any
  data: unknown
  ajv?: Ajv
  errorMessage?: string
}): Promise<T> {
  assert(schema, 400, '`schema` is required')
  const isSchemaObject =
    typeof schema === 'object' &&
    !Array.isArray(schema) &&
    schema.type === 'object'
  const isDataObject = typeof data === 'object' && !Array.isArray(data)
  if (isSchemaObject && !isDataObject) {
    throw new HttpError({
      statusCode: 400,
      message: `${errorMessage ? errorMessage + ': ' : ''}Data must be an object according to its schema.`
    })
  }

  // Special-case check for required fields to give better error messages
  if (isSchemaObject && Array.isArray(schema.required)) {
    const missingRequiredFields: string[] = schema.required.filter(
      (field: string) => (data as Record<string, unknown>)[field] === undefined
    )

    if (missingRequiredFields.length > 0) {
      throw new HttpError({
        statusCode: 400,
        message: `${errorMessage ? errorMessage + ': ' : ''}Missing required ${plur('field', missingRequiredFields.length)}: ${missingRequiredFields.map((field) => `"${field}"`).join(', ')}`
      })
    }
  }

  const schemaHashKey = await hashObject(schema)
  let validate = ajv.getSchema(schemaHashKey) as ValidateFunction<T>
  if (!validate) {
    validate = ajv.compile<T>(schema)
    ajv.addSchema(schema, schemaHashKey)
  }

  if (ajv.validate(schema, data)) {
    return data as T
  }

  // TODO: Add better error messages
  const errors = betterAjvErrors({ schema, data, errors: ajv.errors })
  const finalErrorMessage = [
    errorMessage ? `${errorMessage}: ` : undefined,
    ...errors.map((error) => JSON.stringify(error, null, 2))
  ]
    .filter(Boolean)
    .join('\n')

  throw new HttpError({
    statusCode: 400,
    message: finalErrorMessage
  })
}


================================================
FILE: packages/openapi-utils/src/validate-openapi-spec.test.ts
================================================
import { readFile } from 'node:fs/promises'
import path from 'node:path'
import { fileURLToPath } from 'node:url'

import { serve } from '@hono/node-server'
import { Hono } from 'hono'
import { afterAll, assert, beforeAll, describe, expect, test } from 'vitest'

import { validateOpenAPISpec } from './validate-openapi-spec'

const fixtures = [
  'basic.json',
  'firecrawl.json',
  'notion.json',
  'open-meteo.yaml',
  'pet-store.json',
  'petstore-expanded.json',
  'security.json',
  'tic-tac-toe.json'
]

const fixturesDir = path.join(
  fileURLToPath(import.meta.url),
  '..',
  '..',
  'fixtures'
)

let server: ReturnType<typeof serve> | undefined
let port: number | undefined

// Setup a simple HTTP server to test loading remote versions of the fixtures
beforeAll(async () => {
  const app = new Hono()

  app.get('/fixtures/*', async (c) => {
    const fixtureFile = c.req.path.split('/').at(-1)!
    assert(fixtureFile, `Missing fixture file: ${c.req.path}`)

    const fixturePath = path.join(fixturesDir, fixtureFile)
    const spec = await readFile(fixturePath, 'utf8')

    return c.json(spec)
  })

  await new Promise((resolve) => {
    port = 6039
    server = serve(
      {
        fetch: app.fetch,
        port
      },
      resolve
    )
  })
})

// Close the HTTP server
afterAll(async () => {
  await new Promise<void>((resolve, reject) => {
    if (server) {
      server.close((err) => (err ? reject(err) : resolve()))
    } else {
      resolve()
    }
  })
})

describe('validateOpenAPISpec', () => {
  test('remote spec https://agentic-platform-fixtures-everything.onrender.com/docs', async () => {
    const source =
      'https://agentic-platform-fixtures-everything.onrender.com/docs'
    const result = await validateOpenAPISpec(source)
    expect(result).toMatchSnapshot()
  })

  for (const fixture of fixtures) {
    test(
      `${fixture} (string)`,
      {
        timeout: 60_000
      },
      async () => {
        const fixturePath = path.join(fixturesDir, fixture)
        const source = await readFile(fixturePath, 'utf8')

        const result = await validateOpenAPISpec(source)
        expect(result).toMatchSnapshot()
      }
    )

    test(
      `${fixture} (file url)`,
      {
        timeout: 60_000
      },
      async () => {
        const source = new URL(`file://${path.join(fixturesDir, fixture)}`)

        const result = await validateOpenAPISpec(source)
        expect(result).toMatchSnapshot()
      }
    )

    test(
      `${fixture} (http url)`,
      {
        timeout: 60_000
      },
      // eslint-disable-next-line no-loop-func
      async () => {
        assert(server)
        assert(port)

        const source = new URL(`http://localhost:${port}/fixtures/${fixture}`)

        const result = await validateOpenAPISpec(source)
        expect(result).toMatchSnapshot()
      }
    )
  }
})


================================================
FILE: packages/openapi-utils/src/validate-openapi-spec.ts
================================================
import fs from 'node:fs/promises'
import path from 'node:path'
import { fileURLToPath } from 'node:url'

import { assert, type Logger, parseJson } from '@agentic/platform-core'
import {
  BaseResolver,
  bundle,
  type Config as RedoclyConfig,
  type Document,
  lintDocument,
  makeDocumentFromString,
  type NormalizedProblem,
  Source
} from '@redocly/openapi-core'

import type { DereferencedLooseOpenAPI3Spec, LooseOpenAPI3Spec } from './types'
import { getDefaultRedoclyConfig } from './redocly-config'

interface ParseSchemaOptions {
  absoluteRef: string
  resolver: BaseResolver
}

/**
 * Validates an OpenAPI spec and bundles it into a single, normalized schema.
 *
 * The input `source` should point to a valid OpenAPI spec (3.0 or 3.1).
 *
 * Adapted from https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/src/lib/redoc.ts
 */
export async function validateOpenAPISpec<
  TDereference extends boolean | undefined
>(
  source: string | URL | Buffer | Record<string, unknown>,
  {
    cwd,
    redoclyConfig,
    logger,
    silent = false,
    dereference = false
  }: {
    cwd?: string
    redoclyConfig?: RedoclyConfig
    logger?: Logger
    silent?: boolean
    dereference?: TDereference
  } = {}
): Promise<
  TDereference extends true ? DereferencedLooseOpenAPI3Spec : LooseOpenAPI3Spec
> {
  if (!redoclyConfig) {
    redoclyConfig = await getDefaultRedoclyConfig()
  }

  if (
    typeof source === 'string' &&
    (source.startsWith('https://') ||
      source.startsWith('http://') ||
      source.startsWith('//'))
  ) {
    try {
      source = new URL(source)
    } catch {
      // Not a URL, continue
    }
  }

  let absoluteRef: string
  if (source instanceof URL) {
    absoluteRef =
      source.protocol === 'file:' ? fileURLToPath(source) : source.href
  } else {
    absoluteRef = cwd ?? process.cwd()
  }

  const resolver = new BaseResolver(redoclyConfig.resolve)
  let document: Document

  try {
    document = await parseSchema(source, {
      absoluteRef,
      resolver
    })
  } catch (err: any) {
    throw new Error(`Invalid OpenAPI spec: ${err.message}`)
  }

  // Check for OpenAPI 3 or greater
  const openapiVersion = Number.parseFloat(document.parsed.openapi)
  if (
    document.parsed.swagger ||
    !document.parsed.openapi ||
    Number.isNaN(openapiVersion) ||
    openapiVersion < 3 ||
    openapiVersion >= 4
  ) {
    if (document.parsed.swagger) {
      throw new Error(
        'Unsupported Swagger version: 2.x. Use OpenAPI 3.x instead.'
      )
    }

    if (document.parsed.openapi || openapiVersion < 3 || openapiVersion >= 4) {
      throw new Error(`Unsupported OpenAPI version: ${document.parsed.openapi}`)
    }

    throw new Error('Unsupported schema format, expected `openapi: 3.x`')
  }

  const problems = await lintDocument({
    document,
    config: redoclyConfig.styleguide,
    externalRefResolver: resolver
  })
  _processProblems(problems, { silent, logger })

  const bundled = await bundle({
    doc: document,
    config: redoclyConfig,
    dereference,
    removeUnusedComponents: true,
    externalRefResolver: resolver
  })
  _processProblems(bundled.problems, { silent, logger })

  return bundled.bundle.parsed
}

async function parseSchema(
  schema: unknown,
  { absoluteRef, resolver }: ParseSchemaOptions
): Promise<Document> {
  if (!schema) {
    throw new Error('Invalid schema: empty')
  }

  if (schema instanceof URL) {
    const result = await resolver.resolveDocument(null, absoluteRef, true)

    if ('parsed' in result) {
      const { parsed } = result
      if (typeof parsed === 'object') {
        return result
      } else if (typeof parsed === 'string') {
        // Result is a string that we need to parse down below
        schema = parsed
      } else {
        throw new Error('Invalid OpenAPI spec: failed to parse remote schema')
      }
    } else {
      throw result.originalError
    }
  }

  if (schema instanceof Buffer) {
    return parseSchema(schema.toString('utf8'), { absoluteRef, resolver })
  }

  if (typeof schema === 'string') {
    schema = schema.trim()
    assert(typeof schema === 'string')

    // URL
    if (
      schema.startsWith('http://') ||
      schema.startsWith('https://') ||
      schema.startsWith('file://')
    ) {
      const url = new URL(schema)

      return parseSchema(url, {
        absoluteRef: url.protocol === 'file:' ? fileURLToPath(url) : url.href,
        resolver
      })
    }

    // JSON
    if (schema[0] === '{') {
      return {
        source: new Source(absoluteRef, schema, 'application/json'),
        parsed: parseJson(schema)
      }
    }

    // Path to local file
    // TODO: support raw local files (no ./ prefix)
    if (schema.startsWith('/') || schema.startsWith('.')) {
      const schemaPath = path.join(absoluteRef, schema)
      const schemaContent = await fs.readFile(schemaPath, 'utf8')

      // TODO: support local YAML files
      return {
        source: new Source(schemaPath, schemaContent, 'application/json'),
        parsed: parseJson(schemaContent)
      }
    }

    // YAML
    const result = makeDocumentFromString(schema, absoluteRef)
    if (
      typeof result !== 'object' ||
      !('parsed' in result) ||
      typeof result.parsed !== 'object'
    ) {
      throw new Error('Invalid OpenAPI spec: failed to parse schema')
    }

    return result
  }

  if (typeof schema === 'object' && !Array.isArray(schema)) {
    return {
      source: new Source(
        absoluteRef,
        JSON.stringify(schema),
        'application/json'
      ),
      parsed: schema
    }
  }

  throw new Error(
    `Error parsing OpenAPI spec: Expected string, object, or Buffer. Got ${Array.isArray(schema) ? 'Array' : typeof schema}`
  )
}

function _processProblems(
  problems: NormalizedProblem[],
  {
    logger,
    silent
  }: {
    logger?: Logger
    silent: boolean
  }
) {
  if (problems.length) {
    let errorMessage: string | undefined

    for (const problem of problems) {
      const problemLocation = problem.location?.[0]?.pointer
      const problemMessage = problemLocation
        ? `${problem.message} at ${problemLocation}`
        : problem.message

      if (problem.severity === 'error') {
        errorMessage = problemMessage
        logger?.error('openapi spec error', problemMessage)
      } else if (!silent) {
        logger?.warn('openapi spec warning', problemMessage)
      }
    }

    if (errorMessage) {
      throw new Error(errorMessage)
    }
  }
}


================================================
FILE: packages/openapi-utils/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "bin/*"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/platform/package.json
================================================
{
  "name": "@agentic/platform",
  "version": "8.4.4",
  "description": "Public SDK for developers building on top of the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/platform"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-openapi-utils": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@modelcontextprotocol/sdk": "catalog:",
    "mrmime": "^2.0.1",
    "semver": "catalog:",
    "unconfig": "catalog:"
  },
  "devDependencies": {
    "@types/semver": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/platform/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform <!-- omit from toc -->

> Public SDK for developers building on top of the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

## Install

```bash
npm i @agentic/platform
```

## Usage

The main export of `@agentic/platform` is the `defineConfig(...)` function, which enables you to configure your Agentic project with full type safety and autocomplete.

Here's an example `agentic.config.ts`:

```ts
import { defineConfig } from '@agentic/platform'

export default defineConfig({
  name: '<Your Project Name>',
  description: '<A brief description of your project>',
  origin: {
    type: 'mcp',
    url: '<Your Remote MCP Server URL>'
  }
})
```

## Docs

See the [Agentic Publishing Quick Start](https://docs.agentic.so/publishing/quickstart) for more details.

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/platform/src/__snapshots__/load-agentic-config.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`loadAgenticConfig > basic-mcp 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "Test Basic MCP",
  "origin": {
    "location": "external",
    "type": "mcp",
    "url": "https://agentic-basic-mcp-test.onrender.com/mcp",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "slug": "test-basic-mcp",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > basic-openapi 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "Test Basic OpenAPI",
  "origin": {
    "location": "external",
    "spec": "{"openapi":"3.1.0","info":{"title":"JSONPlaceholder","version":"1.0.0"},"paths":{"/posts":{"get":{"summary":"Get posts","operationId":"getPosts","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Post"}}}}}}},"post":{"summary":"Create post","operationId":"createPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","title","body"],"properties":{"userId":{"type":"integer"},"title":{"type":"string"},"body":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}}}}},"/posts/{postId}":{"get":{"summary":"Get post","operationId":"getPost","parameters":[{"required":true,"schema":{"type":"integer"},"name":"postId","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Post"}}}}}}}},"components":{"schemas":{"Post":{"type":"object","required":["id","userId","title","body"],"properties":{"id":{"type":"integer"},"userId":{"type":"integer"},"title":{"type":"string"},"body":{"type":"string"}}}}}}",
    "type": "openapi",
    "url": "https://jsonplaceholder.typicode.com",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "slug": "test-basic-openapi",
  "toolConfigs": [
    {
      "name": "get_posts",
      "pure": true,
    },
    {
      "name": "get_post",
      "pure": true,
    },
  ],
}
`;

exports[`loadAgenticConfig > basic-raw-free-json 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-basic-raw-free-json",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://jsonplaceholder.typicode.com",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "slug": "test-basic-raw-free-json",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > basic-raw-free-ts 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-basic-raw-free-ts",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://jsonplaceholder.typicode.com",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "slug": "test-basic-raw-free-ts",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > everything-openapi 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "icon": "https://storage.agentic.so/agentic-dev-icon-circle-dark.svg",
  "name": "Test Everything OpenAPI",
  "origin": {
    "location": "external",
    "spec": "{"openapi":"3.1.0","info":{"title":"OpenAPI server everything","description":"OpenAPI kitchen sink server meant for testing Agentic's origin OpenAPI adapter and ToolConfig features.","version":"0.1.0"},"components":{"schemas":{"User":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}},"required":["id","name","email"]}},"parameters":{}},"paths":{"/health":{"get":{"description":"Check if the server is healthy","operationId":"healthCheck","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]}}}}}}},"/users/{userId}":{"get":{"description":"Gets a user","tags":["users"],"operationId":"getUser","parameters":[{"schema":{"type":"string"},"required":true,"description":"User ID","name":"userId","in":"path"}],"responses":{"200":{"description":"A user object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}}}},"/disabled-tool":{"get":{"description":"Disabled tool","operationId":"disabledTool","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]}}}}}}},"/disabled-for-free-plan-tool":{"get":{"description":"Disabled for free plan tool","operationId":"disabledForFreePlanTool","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]}}}}}}},"/echo":{"post":{"description":"Echoes the request body","operationId":"echo","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/echo-headers":{"get":{"description":"Echoes the request headers","operationId":"echoHeaders","responses":{"200":{"description":"Echoed request headers","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/pure":{"post":{"description":"Pure tool","operationId":"pure","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/unpure-marked-pure":{"post":{"description":"Unpure tool marked pure","operationId":"unpure_marked_pure","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body with current timestamp to not be pure","content":{"application/json":{"schema":{"type":"object","properties":{"now":{"type":"number"}},"required":["now"]}}}}}}},"/custom-cache-control-tool":{"post":{"description":"Custom cache control tool","operationId":"customCacheControlTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/custom-rate-limit-approximate-tool":{"post":{"description":"Custom rate limit tool (approximate mode)","operationId":"customRateLimitApproximateTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/no-store-cache-control-tool":{"post":{"description":"No store cache control tool","operationId":"noStoreCacheControlTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/no-cache-cache-control-tool":{"post":{"description":"No cache cache control tool","operationId":"noCacheCacheControlTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/custom-rate-limit-tool":{"post":{"description":"Custom rate limit tool (strict mode)","operationId":"customRateLimitTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/disabled-rate-limit-tool":{"post":{"description":"Disabled rate limit tool","operationId":"disabledRateLimitTool","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}},"/strict-additional-properties":{"post":{"description":"Echoes the request body only allowing a single \\"foo\\" field.","operationId":"strictAdditionalProperties","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"foo":{"type":"string"}},"required":["foo"]}}}},"responses":{"200":{"description":"Echoed request body","content":{"application/json":{"schema":{"type":"object","properties":{"foo":{"type":"string"}},"required":["foo"]}}}}}}}},"webhooks":{}}",
    "type": "openapi",
    "url": "https://agentic-platform-fixtures-everything.onrender.com",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "per_unit",
          "slug": "requests",
          "unitAmount": 0,
          "usageType": "metered",
        },
      ],
      "name": "Free",
      "slug": "free",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "amount": 999,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "tiered",
          "slug": "requests",
          "tiers": [
            {
              "unitAmount": 0,
              "upTo": 1000,
            },
            {
              "unitAmount": 0.053,
              "upTo": "inf",
            },
          ],
          "tiersMode": "volume",
          "usageType": "metered",
        },
      ],
      "name": "Starter",
      "slug": "starter",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "amount": 2999,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "tiered",
          "slug": "requests",
          "tiers": [
            {
              "unitAmount": 0,
              "upTo": 10000,
            },
            {
              "unitAmount": 0.049,
              "upTo": "inf",
            },
          ],
          "tiersMode": "volume",
          "usageType": "metered",
        },
      ],
      "name": "Pro",
      "slug": "pro",
    },
  ],
  "readme": "data:text/markdown;base64,IyBUZXN0IEV2ZXJ5dGhpbmcgT3BlbkFQSQoKVGhpcyBpcyB0ZXN0aW5nICoqcmVhZG1lIHJlbmRlcmluZyoqLgoKIyMgTWlzYwoKLSBbIF0gSXRlbSAxCi0gWyBdIEl0ZW0gMgotIFt4XSBJdGVtIDMKCi0tLQoKLSBfaXRhbGljXwotICoqYm9sZCoqCi0gW2xpbmtdKGh0dHBzOi8vd3d3Lmdvb2dsZS5jb20pCi0gYGNvZGVgCgojIyBDb2RlCgpgYGB0cwpjb25zdCBhID0gMQoKZXhwb3J0IGZ1bmN0aW9uIGZvbygpIHsKICBjb25zb2xlLmxvZygnaGVsbG8gd29ybGQnKQp9CmBgYAoKIyMgSW1hZ2VzCgohW0ltYWdlXShodHRwczovL3BsYWNlaG9sZC5jby82MDB4NDAwKQo=",
  "slug": "test-everything-openapi",
  "toolConfigs": [
    {
      "enabled": true,
      "name": "get_user",
      "pricingPlanOverridesMap": {
        "free": {
          "enabled": true,
          "reportUsage": true,
        },
      },
      "pure": true,
      "rateLimit": {
        "enabled": false,
      },
      "reportUsage": true,
    },
    {
      "examples": [
        {
          "args": {
            "message": "Hello, world!",
          },
          "featured": true,
          "name": "Example 1",
          "prompt": "Use the echo tool to say hello.",
        },
      ],
      "name": "echo",
    },
    {
      "enabled": false,
      "name": "disabled_tool",
    },
    {
      "name": "disabled_for_free_plan_tool",
      "pricingPlanOverridesMap": {
        "free": {
          "enabled": false,
        },
      },
    },
    {
      "name": "pure",
      "pure": true,
    },
    {
      "name": "unpure_marked_pure",
      "pure": true,
    },
    {
      "cacheControl": "public, max-age=7200, s-maxage=7200, stale-while-revalidate=3600",
      "name": "custom_cache_control_tool",
    },
    {
      "cacheControl": "no-cache",
      "name": "no_cache_cache_control_tool",
    },
    {
      "cacheControl": "no-store",
      "name": "no_store_cache_control_tool",
    },
    {
      "name": "custom_rate_limit_tool",
      "rateLimit": {
        "enabled": true,
        "interval": 30,
        "limit": 2,
        "mode": "strict",
      },
    },
    {
      "name": "custom_rate_limit_approximate_tool",
      "rateLimit": {
        "enabled": true,
        "interval": 30,
        "limit": 2,
        "mode": "approximate",
      },
    },
    {
      "name": "disabled_rate_limit_tool",
      "rateLimit": {
        "enabled": false,
      },
    },
    {
      "inputSchemaAdditionalProperties": false,
      "name": "strict_additional_properties",
      "outputSchemaAdditionalProperties": false,
    },
  ],
}
`;

exports[`loadAgenticConfig > invalid: invalid-metadata-0 1`] = `[ZodValidationError: Expected string at "icon"]`;

exports[`loadAgenticConfig > invalid: invalid-metadata-1 1`] = `[Error: Invalid "readme" (must be a URL or a path to a local file): "./not-found.md"]`;

exports[`loadAgenticConfig > invalid: invalid-name-0 1`] = `[ZodValidationError: Expected string at "name"]`;

exports[`loadAgenticConfig > invalid: invalid-name-1 1`] = `[ZodValidationError: Value must be less or equal to 1,024 at "name"]`;

exports[`loadAgenticConfig > invalid: invalid-name-2 1`] = `[ZodValidationError: Value must be greater or equal to 1 at "name"]`;

exports[`loadAgenticConfig > invalid: invalid-origin-url-0 1`] = `[Error: Invalid originUrl: must be a valid https URL]`;

exports[`loadAgenticConfig > invalid: invalid-origin-url-1 1`] = `[TypeError: parseFunc is not a function]`;

exports[`loadAgenticConfig > invalid: invalid-origin-url-2 1`] = `[ZodValidationError: Expected object at "origin"]`;

exports[`loadAgenticConfig > invalid: invalid-origin-url-3 1`] = `[TypeError: parseFunc is not a function]`;

exports[`loadAgenticConfig > invalid: invalid-slug-0 1`] = `[ZodValidationError: Invalid project slug at "slug"]`;

exports[`loadAgenticConfig > invalid: invalid-slug-1 1`] = `[ZodValidationError: Invalid project slug at "slug"]`;

exports[`loadAgenticConfig > invalid: invalid-slug-2 1`] = `[ZodValidationError: Invalid project slug at "slug"]`;

exports[`loadAgenticConfig > invalid: invalid-slug-3 1`] = `[Error: Invalid project slug "" for project name " ". Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. For example: "my-project" or "linkedin-resolver-23"]`;

exports[`loadAgenticConfig > invalid: invalid-slug-4 1`] = `[ZodValidationError: Invalid project slug at "slug"]`;

exports[`loadAgenticConfig > invalid: pricing-base-inconsistent 1`] = `[ZodValidationError: Invalid PricingPlanLineItem "base": reserved "base" LineItems must have "licensed" usage type. at "pricingPlans[1].lineItems[0]"]`;

exports[`loadAgenticConfig > invalid: pricing-custom-inconsistent 1`] = `[Error: Invalid pricingPlans: all PricingPlans which contain the same LineItems (by slug "custom-test") must have the same usage type ("licensed" or "metered").]`;

exports[`loadAgenticConfig > invalid: pricing-duplicate-0 1`] = `[Error: Invalid pricingPlans: duplicate PricingPlan slugs. All PricingPlan slugs must be unique (e.g. "free", "starter-monthly", "pro-annual", etc).]`;

exports[`loadAgenticConfig > invalid: pricing-duplicate-1 1`] = `[Error: Invalid pricingPlan "basic": duplicate line-item slugs]`;

exports[`loadAgenticConfig > invalid: pricing-empty-0 1`] = `[ZodValidationError: Value must be greater or equal to 1 at "pricingIntervals"]`;

exports[`loadAgenticConfig > invalid: pricing-empty-1 1`] = `[ZodValidationError: Value must be greater or equal to 1 at "pricingPlans[0].lineItems"]`;

exports[`loadAgenticConfig > invalid: pricing-empty-2 1`] = `[ZodValidationError: Value must be greater or equal to 1 at "pricingPlans"]`;

exports[`loadAgenticConfig > metadata-0 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "icon": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iOTYiIGhlaWdodD0iOTYiIHZpZXdCb3g9IjAgMCA5NiA5NiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGNpcmNsZSBjeD0iNDgiIGN5PSI0OCIgcj0iNDgiIGZpbGw9IiM4ODg4ODgiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0yNi4yOTIyIDczLjIwNjdDMjIuNjI0OCA3My4yNTUgMTguOTgyNSA3My4yMDY1IDE1LjM2NTMgNzMuMDYxMUMyNi43NTIgNTUuMDQ4IDM4LjE0MDIgMzcuMDMwOSA0OS41Mjk5IDE5LjAwOTdDNTEuMTYzNSAxNy4zMjkzIDUyLjk4NDcgMTcuMTEwNyA1NC45OTMzIDE4LjM1NDFDNTcuNDkxIDIwLjQ1NTggNTguMjQzOCAyMy4wNTM5IDU3LjI1MTUgMjYuMTQ4NUM1NS40OTEzIDI5LjEzNTIgNTMuNjk0NSAzMi4wOTc1IDUxLjg2MDkgMzUuMDM1N0M0NC4xODc4IDQ3LjE3NjYgMzYuNTE0OSA1OS4zMTc2IDI4Ljg0MTcgNzEuNDU4NUMyOC4yODYxIDcyLjQ3NjMgMjcuNDM2MyA3My4wNTkgMjYuMjkyMiA3My4yMDY3WiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01NS40MzAyIDM3LjM2NjhDNTUuNzU2NiAzNy41MjI0IDU2LjAyMzcgMzcuNzY1MSA1Ni4yMzE1IDM4LjA5NTJDNjQuMzYwNiA0OS44NjE1IDcyLjU0MzcgNjEuNTg5NyA4MC43ODA0IDczLjI3OTZDNzcuMTg2NyA3My4zNzY4IDczLjU5MzEgNzMuMzc2OCA2OS45OTkzIDczLjI3OTZDNjguOTc5MyA3My4wNDkgNjguMTI5NSA3Mi41MzkxIDY3LjQ0OTcgNzEuNzQ5OUM2Mi4zMzc5IDY0LjI5NDMgNTcuMTkwMiA1Ni44NjQgNTIuMDA2NSA0OS40NTkxQzUxLjQ2MjcgNDguNjcxNSA1MC45NzcyIDQ3Ljg0NTkgNTAuNTQ5NiA0Ni45ODI0QzUwLjM3MDggNDUuODY2NCA1MC42MTM3IDQ0Ljg0NjYgNTEuMjc4IDQzLjkyMjlDNTIuNjk4NiA0MS43NTE5IDU0LjA4MjcgMzkuNTY2NiA1NS40MzAyIDM3LjM2NjhaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTYzLjg4MDMgNzMuMDYxQzU5LjcyODggNzMuMjA2NCA1NS41NTIzIDczLjI1NSA1MS4zNTA5IDczLjIwNjdDNTAuMjQxNyA3MS41MzgxIDQ5LjEwMDUgNjkuODg3IDQ3LjkyNzEgNjguMjUzMkM0Ni44NDUxIDY5Ljg4NCA0NS44MDA5IDcxLjUzNTEgNDQuNzk0OCA3My4yMDY3QzQwLjY5MDQgNzMuMjU1IDM2LjYxMSA3My4yMDY0IDMyLjU1NjcgNzMuMDYxQzM2LjM4NDkgNjcuMDIyMSA0MC4yNDU3IDYxLjAwMDMgNDQuMTM5MiA1NC45OTUzQzQ1LjcxNzMgNTMuMzQxOSA0Ny41ODcxIDUyLjkyOTIgNDkuNzQ4MyA1My43NTdDNTAuMzIyMyA1NC4wMzE3IDUwLjgzMjIgNTQuMzk2IDUxLjI3OCA1NC44NDk3QzU1LjUxMDkgNjAuOTAyNyA1OS43MTE3IDY2Ljk3MzIgNjMuODgwMyA3My4wNjFaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTE1LjM2NTIgNzMuMDYxMUMxOC45ODI1IDczLjIwNjUgMjIuNjI0NyA3My4yNTUgMjYuMjkyMSA3My4yMDY3QzIyLjYyNSA3My40MDA0IDE4LjkzNDIgNzMuNDAwNCAxNS4yMTk1IDczLjIwNjdDMTUuMjM3NiA3My4xMTgzIDE1LjI4NjEgNzMuMDY5OCAxNS4zNjUyIDczLjA2MTFaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTMyLjU1NjggNzMuMDYxMUMzNi42MTExIDczLjIwNjUgNDAuNjkwNCA3My4yNTUgNDQuNzk0OCA3My4yMDY3QzQwLjY5MDcgNzMuNDAwNCAzNi41NjI5IDczLjQwMDQgMzIuNDExMSA3My4yMDY3QzMyLjQyOTIgNzMuMTE4MyAzMi40Nzc3IDczLjA2OTggMzIuNTU2OCA3My4wNjExWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik02My44ODAzIDczLjA2MTFDNjMuOTU5NCA3My4wNjk4IDY0LjAwNzkgNzMuMTE4MyA2NC4wMjYgNzMuMjA2N0M1OS43NzcxIDczLjQwMDUgNTUuNTUyIDczLjQwMDUgNTEuMzUwOSA3My4yMDY3QzU1LjU1MjMgNzMuMjU1IDU5LjcyODkgNzMuMjA2NSA2My44ODAzIDczLjA2MTFaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K",
  "name": "Test Metadata 0",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "readme": "data:text/markdown;base64,IyBUZXN0IE1ldGFkYXRhCgpUaGlzIGlzIHRlc3RpbmcgKipyZWFkbWUgcmVuZGVyaW5nKiouCgojIyBNaXNjCgotIFsgXSBJdGVtIDEKLSBbIF0gSXRlbSAyCi0gW3hdIEl0ZW0gMwoKLS0tCgotIF9pdGFsaWNfCi0gKipib2xkKioKLSBbbGlua10oaHR0cHM6Ly93d3cuZ29vZ2xlLmNvbSkKLSBgY29kZWAKCiMjIENvZGUKCmBgYHRzCmNvbnN0IGEgPSAxCgpleHBvcnQgZnVuY3Rpb24gZm9vKCkgewogIGNvbnNvbGUubG9nKCdoZWxsbyB3b3JsZCcpCn0KYGBgCgojIyBJbWFnZXMKCiFbSW1hZ2VdKGh0dHBzOi8vcGxhY2Vob2xkLmNvLzYwMHg0MDApCg==",
  "slug": "test-metadata-0",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > metadata-1 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "icon": "https://agentic.so/agentic-icon-circle-light.svg",
  "name": "Test Metadata 1",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "readme": "https://raw.githubusercontent.com/transitive-bullshit/agentic/refs/heads/main/readme.md",
  "slug": "test-metadata-1",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > metadata-2 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "icon": "data:image/svg+xml;base64,<svg width="49" height="49" viewBox="0 0 49 49" fill="none" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<path d="M0.0195312 48.3594H48.0195V0.359375H0.0195312V48.3594Z" fill="url(#pattern0_2779_20)"/>
<defs>
<pattern id="pattern0_2779_20" patternContentUnits="objectBoundingBox" width="1" height="1">
<use xlink:href="#image0_2779_20" transform="scale(0.00625)"/>
</pattern>
<image id="image0_2779_20" width="160" height="160" preserveAspectRatio="none" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAACgCAYAAACLz2ctAABWPklEQVR4nO29d7wdV3X3/V17Zs45t6l32XLBxhUMBozpvRMHcAx+SSA4hBJCCgmhBBKMgfBAIEAoeSjBEAiQgCEQgk2CjQNuuOKKjW1kSba6ZElX995TZvZ6/9hl9rkSYFlH90pPsvw5vkdnZvbsmfnNb5W99trC/8oDlu3nf+HF5j/+47HmiU/6PPDz2e7P/wuS7/ro3892Hw4Z0asu/035xtd/195//8P4y3e+C7h2tvt0qEtuH/bw2e7DISPZtVc0W0B18Q+eP7lm7WnZGS86T874jX8Aytnu26Equcmy2e7DISN28fz7rYHm8qXI2p8vmvjIh/6enTtPazz1aW8H7p3t/h2Kkpt19812Hw4ZKRctWVsBtIZoPH0V5r57Gf/Sp3+n++PLHpa/451/Blwyy1085CS3Vme7D4eM5GvXbqiGWtjdk5j5K8kPV+Yu2cD4Tbee0j73bd9qPe0F75WzXvJRoDfbfT1UJJcli2e7D4eM2GNP2KQjjW618/6Gaa+ExYsxh8Gc4c3svmPNnPbXP/3Botd+dONJT30LsGa2+3soSG7WrZ/tPhwy0j39CffJ/NHddvOuBeyahGw+NBcgY8LYcZsxC9tM/ufnX6pXX3lC/o7z3gRcPNt9Ptglr1pDs92HQ0fG5mxgwdINFesXML4bdD40WjA0D0oYmb+V7MRJxtf97GHl+9/8rdaTX/JueflLPwpUs9zzg1ZyOeKw2e7DISPFxf+127bGNpZwkk5OIN0uZEOQt2BoLlholVuRVZPs3rpmrP2tv/9Qw5Qn5s9/0duBzbPd/4NRctk1Odt9OHTk2FPaevhPNilgO22y9hS0WmAKKICWQqU0dxmyBROMj1R0vvvx3+P6qx4m5/7tHwDXzfIVHHSSV/n/xgH3SVau3Ahge12ydhsKBWNACsiHYAiwhnxcGCt2M3GE0tlwzWOyv37DdxqvfNNfAF+Z3Qs4uCSXu+6c7T4cUmJXHLFFgaqyFO0ODJWQ5yACWQ6NIbCAhXxSGG3vxqywTG27bUXn/X/6xeazX/4we957zgOmZvlSDgrJ7W/+xmz34ZAS8+m/31oNZ1itoNeBsgemCSZzAFSBBg6EGDI1jEyNY+ZXTDYm8qmLPv+2huixxQtf/Kf87+gJeX7N/5ol+yJm87addngYq+PQ7kK3B7kFyYAMjIDBgVAFEAzC8NQ4Zqhk4vCKzn987kxuvvGoxrPPeB3/wxMacrnu+tnuwyEl1fEn7KSVd6ylqVUP6XWhUhCcGiZzAMyoQaiCSEZrchcm6zLxEOjcd82p9ptbv12880N/Cnx9Fi9pViWvTjxxtvtwSEk5IrulmfVkkqZai/RKqKwDnTjGQzwLZgIN/5sxiBiak7uQqs3kKuhsWb3C/uUffLH1/N8+OjvqyL/FK+7/SZLn9/2PN0P2SaoTj21LlpcqoGUFZeUAmHsWJAAu99+VCEpxvzcmdiDdKcwipb1z89DUNz7xf1pPfslK+6EPvx2YmMXLm3HJu2edOdt9OKRE7rpr0hStrgW0UuiVUFWgGrHmgGicPSgClLWKFgNiKCZ2IN0JZK7SHuox+ZN//aPGX7eOKF76228E1s3eFc6s5Nktt812Hw4pqZYtbtNotlVBrYKtwKr7mLBXynyZswcjAAMTGvJJw3B7Nya3TK5Sev/1xTPkrjsPaz3hqa8Gfjo7Vzizkuf/fels9+GQkvJVv1uSF2XEmLWgNmFA8XtKgkPvmKhA7rf7/TIVhtq7EVMxeQy0111xKhes+3p+3odeA1w6s1c385KXp5wy2304tMRWglohDCBZdSC06kGoNculKtlmNUMGW1EdE5rc0JrajVQ955zcu+4Y+zd/+bX8fR97A/DNmb/ImZPcjozMdh8OKZEdO5tU3SYNaoaz/q/65F6V+gANaldrmzAcp/i4oWDE0JoaR8ouk6ugt/bupfaPfv/8xns/PAf4wkxe40xKzs6ds92HQ0rs6NCIlJOtyIB4sCkObFamMZ3fFlQy4kZNcr8h7iOICM32LqTsMnUkdFZvnNN9659+snHe+wvgswf62mZDcjr/OyS5L5Lddfd87XVbkoMgntXC1r1MbxCpmTE4JXiQ5tSMiFPdYsTFCrsd5Chor94y3H37W/6+ee57CuBTB/wCZ1hy6XRmuw+HlrS7K3X3rmFZ4gbZkKwOPBupPd7AepA4JsEo9BRpcOAsCqJO1lGwlkZbodeDI5XOXdtb3b9+x981PvSRHv+PMWHO8PBs9+GQEtvZ/RDtdMmywIAZZMaNeBTJjhr+J9NUMQ6Q1rgfssw5MFnh/jbV2YsojfZutOqhxyid23c0edtb/q745D9MAv88Yxd8gCXXsbHZ7sOhI8MjYi76zsPLwuHOaO5SsVoGhr06BpeAb3H2IOA83gBGj0IDqKmdl4waoIW60A7QaI+jVQ+Ohe4tW0Z5059+LPvSP+0A/mNGrvkAS24XLZjtPhwykk10VvGLWx8tQ5Apbrit2YAhr4ZbAkuBcWCL+JHdoIZJbEVqtaw+gQGF3BuG2nAgtBaxFc3OBGQlehJ0b7h3oZzz6k813/D6s4ErZ+jSD5jkxTXXzHYfDhlRUzyl2njPEbIEMjXQaEKzgMINr6HAAoGVQBNYi5shnFOzI4AJoybiWLBSKAVKA5qBLRwDFi3AIlQ0ulNoXqEnQO+nq1fJ5z73ucbffeQs4JAeyso58aTZ7sMhIeWRx+TmvLf9lu10KZpgTO5mxBW5S8kPgCqBFnA0juXWUIdmYiwwxAupnRdjHDBVoTI+ubUBWkFjBKNKszeFjlr0OOjedueJ8slPfoovnn82sHE27skgJO+d9ujZ7sMhIeaS/36Ovey/nstcKARM1oRmC1q5MwiDZ2txIMyAo/18kTU4YOWhNe8mR28Zl7ol3jGxmbcLrQehBVtibEWj6qILLe1V0P2vC5/SPPfc9/KOv3oth2gqVy69/52y+uukXLJo2Hzti39S3T9R5Eshl8xNxWw1oemzoIORF25nhQPVkThsrhOfsKD9tmAM1xjHjIX3kK1x6llyN+sub4GtyNWi9NCVytQ4dD/zf189tHTpncAHZu6ODE7y7HOfme0+HPSSGfOm3n9+71m6GPIGZFnh2K+ROfsvpl1JXajNZ2GRAYfjgLcOr46T1C1DP3cJLqRTGrC5Z8EcbAOKCmxJ3quwTUu1SunshM7nPvv24h/Pvxr44YzdlAFJbh/3+Nnuw0Etxc9uemPnb/7mr8ocGvOhyASk4ZDYnJZgoOq82ip4uOpBKLACx4r3UYMvHaIL39X/u+lBWPlgd56DFpA3EVtRVB3sXMUeCd1frJ+bv/9975Ev/fOLgK0zdnMGIDkHYUr+ZDMbznrdAjhgA9U6NldaV1wp/BLbybQaKxvfuuDN7S9/5Q3d3Tsb2RGQj3jv1+QuZNKAqHr7Ml+ogQTOyzUCK60D5KZkX/VqOfbCe8a5uvZL42xMzdx5swbkFaaqyClpLLJU26D74x89ofW5z/4R8K4DdMsOiOTyuYNvZGf4+GN/L9uycSXw9gN1ju6TnvbE7CtffZ097fQLpOr+OLvx+m7v91+3KN+w4aGy+u6nyPe+c9bklVc/pE2JWQnZPDf5zZgcigYM504FY+LsNzcRyX+39I/zVuqY8DCgq3C/V8UhbctoErjGT+80NQuSeXswd6MmWUFeVmhLKJc7VVz+8z+93nz7378LHDKxNdlx082z3Yc+KcdGzdjb/+IHYivbfunLnsVeR/j3TzrPeoGMvv3tX+996hNntpfM65j5i+/JsmwiM7KU7ZuXVpu3591SqeZBtgCKuU4jttRghufA/PmwZAzmDIFpOGBoBiMGjhIXAwxg6ks2wIF0XOFOYMqPgODDL4Tk1vCpoFvC7go6Pai6UHah6kBvEjqTVJR0Kkt7NZQboPXqV38VePmg79mBklw+9tHZ7kOfmN995Un5z25/vF204FZz680jwO5BnyN76MMeYy/8zjPLBVD0djTNxh3H2S6UbWfvMwrNMchGIWtBbgy55EhjGIZGodVw7KTUqfiKU5vpkBrUdiHUQBzFBatX4+zCkJoVb4I/zuIYtQX0gm0Z2LAAU2BKS54p+RKl3AblBV8/s/GFLz0H+P6g79uBkNz8xhmz3Yc+MVde8RyzYWPTHn7YcPtFZw5xAABYfOc7Lyg3rp3LEsibMLpyITQXoJ0udDsIpUssEHGIzDKXsZIX0ChgTuGdgmD7+UyWltSp98EmBCK4FAc4BRapu7INiUc8newFp7ZbAl2BnomTmlxaV45oSVZa8hElXwzlfbsa+TcveDWHCgDtNy+Y7T5E6X7ggwvnfOrvX8roKMZWo9LIx4AtgzyHyUbn8/3vvkCbQANkBAeaJYuQoRE/LFa66Za2SnL51IVcWrjkA/FsZLwN2BAY9YizCfqEPcV6plymbhLm7oQ5NaRKUzspGTAk0ElYULxNSIahJDNCPqaUAtXFP3hu49OffTxwxSDv3YGQPHvpy2a7D1GaX/7CKxu33f4YDjsMJieHzIYNA88VM3evf5q944ZHyhxgCPIM6JSwewKk6SixKJw6VZ+VIjgnoYlPlyJJuxdn740BI9qfBxiw1JeI4Pfp4cC8XGG1etD67YJP2SLJkMGdv+NHTERcGlieIT1DppZsBMxcqO5bP8Yll7yAQwGAXHJwFHavnvDYU0c+89k3sXCxV282SeQcnOglF7+U3ZPGLnXOZIGBrAk9C50ukDmV6+dqkPn0+QZeLeMnIPkGLW77PP/XJuGXBFNRVadatgfMAebjeD4dI4YEuOJVsYHJ1BYMfw3GCqZQslHo7YDqlp8+s/znf/0gBzCUNQjJO2//y9nuA7bXXjbnla/4SNbtHs6jF8GWnWi36NkFC7uDPI/Z0T1Fr77sGbIAtAmFBUMBRRPmZI7FspCpgk+bFweskOlcUafZKw5w89UByZdl22OoLYCWsC1BoSgsVNih0MUBLUzzTGOF4PrRErdfmOTuASiVkOVCNqL0Mqhu+unJjR9e8kgO8qmdeeOHs8uAU8991vDYO8/9cOPGm5/M00+EwxR2WGxHdtHp7BrkueS73zuDTfcs0oe655pX4pyKuQUsNS7WInimSm04qR2IvlELYFhhiXc+ymS7Jmw2HZCp41IqDCnMU9ioNQuGfeN3rZk4mgCJGaDikm2GwIyA3bRtWFff/WgOdgDq6rtn7eR6yvFmzhv/4P3NCy9+OY8/FlYaxyBVhrTbO1pfOn9g9YM7bz53nl5z+QtlDmgL8knIEJjThAW5MwbV1AeI0hdkTlUu1MBaLM72K1PGIv0yjc2YBjLxLAjcj48NBiDaxAnyxzXUmQLd0LyJXrdYF6c2Q1DuAnvrLacO6v4dKMntrbfM2smba+9+V/PbF/0xpx0DR7dckR9rYLKDXXb4xuqEkwZWqCe76D+fqbdd+RhdCVJBXoFpZDC/Aa3CpUDhQxxGEoZJwKfTPguBBfSzZcp+6ThvUNmpqN9ogWFgEXCv1AkLKXWG0E4Iy0xByoCCIFacf9LyJ7r77uP4zPnzgB37d/cOnOS89Z2zcuLs0ov+uPXOd/81J6+Ck8ZcdYGuONtm507Kxz39nmz1moHlipVrNp9F2RbGBNml5CowWsBow6U7aUacRD4deOloseJU7RxgCbXq1YTx9ioyrSFq+856xlugcL/CLo/w4A0HgKtxb09LnW3apt9T9nUyTdP9s9qw/vBs544VHNQA3Llj5s+6c+szhj/4d+9mxUJ4xEKnO9p+W6+CjlIedfTAUs31yBMeo3/4qmfLCtBSySvIGgJzG84GJCSUes+yr7IB/f+ugBFcdksLFzfUsOPeTp7SZ/p7bLwGdQMHwvFku2r/vhbPgj6GmJoIQXM3gSGwu3aNNX5y1QoO4rT9PPvJVTN6wu5znrl07M//+H1mamoeTz8aGhW0xQ9JGbh/Ajs8ulOPPHJgpVvlO//xIt117zxdBYy7EJ8ZzWG05cZyCfZfOrJhnCpMwyoVDiTLcdXwy6CL2ftoRnREEkbbA4/+R8Ux4RzcDLsJ6iE5jY3X5xnCBb87iRr2ZqNkLqSptmrZn9++aH/v34GU3P789hk9YXPDvX9Q3Hz7Y3nGCS580cY9SOvV3+ZxqmUrb2K4NZi3dtERy+315/0mC0FVyHpKXuBUb9HyhSQ9AAPThUSCEDpR/4IYnNodJWG+RFLPN43lBQkhmpTdgg4NY79NnEc8kbQXY49J+5mwR32aYLAY386OCWgOzd33mzZzktOcuaW69KlPOq7xlredw5EL4YiWS0vqSm179Sxs2kHveU/9YfGtfxuIA9I99UnPlLXXnaTHAJPq2G/IwFDhJv6EygZAzOFL7SrR2nRbjHM60kB0/LsX5osxvOnbpoE3BRbAmDqaDtnVgZWjA+TZtAhthfCR3+6LpEunQpetGN23OzazkuuyFTN2suynP31xtmXjKp53vLuhwYgG9zav20ElrV3dpz39e4M4n5xwai5ve/NZNCzkgnSV3IAZLtyMNlO48dSgfqPHmjQSVON8gcXTgKLJTtNHP/ZqE6YqOd0nObHVaMOxkwTEJOrYH1vggNrWGtPBDsz8v6cmD+rFAHOmZmapLvvC5w013/GOZ5nFTVjQTDw4dT5AZeC2e+k++bnfbf7bt38yiHN2R5ecrtdd+nRZCtpRcgtZS1w6VVY49RtUbyb1yxBtOa96h4FlDsQxmyUGrKefNQHjHkhO2ycJz6SqFhdwHqX2XTU5yCZgzHGTmIInnWwKea6KHtRLYeX6K0MHgxOzefNDszvvfCRHznMPvZfc9MzA7VuobHNX+/de/X8HdU753g9eyNS2kfAwc8C0MpfRbApipaoQegmqLM7t8GwUnY7Q8i8BHvhhvL3Zh9O+TM96SX9Xdecz6u06rSvxh5cimA15YqcmzQbnWKa6B/V0zVymBjrc+kslu/g/T8hsdz7z5vfbNrmBbT24dR2dl5392ea/fPXHgzhf9/f/eJH86PvP1UVgSzBhRa2WT6nPfCYzfoEZ60ck1GeaWHGbluI805LE050+tpb8pg/ghU53CVkvJECyQNM6G69HP2P2MaF1IazAgH6fYFG48cbsoJ53mzNDixXaeUuX0ZuEoaZjFnAPuC1wzS/oHnn0tZ1XnfORQZ3PXHPtk/W+Gx8uh4Ftu9mNpiXQzB3wTEZMa4pp8ymIxDkcC+hXzX34Shls+rZk/+mgTGsGpkyY7lb4EY9xW9cgtEqdrq+1w+HHlftMxHBJc+e1OYglZ+68GTmR7Ny6TKigkdc3rsrhxnWUJt8+9VfveItZf+99AzvhVZc9Dzsl2gSZ8hlWQ8bl+mUNZ/8F8O0x8iHOE10S2GZvJ9D+r6I1SKbH/PY4LFHRe/WG1d2fkA2Zpv0rxGE5qLOyQrv+3KrAUIZs3jT+627VbEoumzfNyImynVvGpMhcBjG4Sde3bqFas0nb73v3udm6tT8c1Ln0hMcstzf+5Eky3yU1G/URlzxzgecspx75MP32WVhscDFu4D+GZBKai1+ngTB1offwhvfCctFg0/ocgd0ydQDMceGqANpwzuDAGe/2+jilBvCVwPAwOr5j4FMaBim5ju+YoVOJ0Cx8GQsDd2zH/vxe2q96+bvkzjs+PsgzVcNLH8u2O4/hcKDnAViIY18TigmFilYJsIITsgCXG9jHfNPBBnsMbaSsBHu3B0XZwwGZ7g0rdbHKQl3EILZJvxoW91GxNUHi+i5ImS1YfHAzYLZg8cycadf2iqaf3HPH/djb76XzsjPOM+2p9wz8XLfe+ER6k5m2QHc5J9sU4rwQE9gvuIlCSlyMqstuFvrn6aYSVG74RxwNm2YTBnClIIsebwK29CVI44E5zgsfT7Zp0lZg3Uz9T1oPC/dA8kabY469f19v30xKzjHHzsyZ7rxtiqwJayeofraezpm/8W7g3EGfpvfS3xvhb971GOY5kjDW2X9S+EI/4tf1NX3Gk/tT4NjPleUjboiGvd8/MRvjsZCA0u8X7baU7abtAz7c4pEaACbifm94nVr5Y20YuqNeJMcXPNIKF9ZUoA2yfMHO3umnzYyN9SAl751+2sycqLt7K+OKveVeOs9+2ntod849ICeq7Cq2/OIEhqmXaMtw4Z4s8X6jm5iw4Bxq1RttumlqNjDYNPw6keiR1kCatj0cMD3FK7UFxduC4ON8iY0oCRjDPoExRbB+6FB6kM1dsFkre1DXismlmpk4Zb5mzQS7Jug+55kfK1/wvHcdsBPdePPDmdi4mEWgHWL9RzfmmyXhF++AhDhcC1fdNKNmoxBUTiUApG9TsMWkBlxfJnMS3pGEHUP5DsX3KQmv9B2bUG0aiomndyrYikbCNRbMnLkb5dprZ2ao60FKnl87Mwt257f/PGs/73kXT7z/g+9ij6c6OMlu/MwptNsuxtz2zzUTBzzjvfAsxP6kZql5uPkd6cD+LxPFgydRx6HyaWDIlP3SLJgAYIvzdPd4/6exnZl2bN/Hgq3QUh0eg8ovHQOa5cs28qMfzsxIw4OUXH70wxk50eRrX/t9hEvzG2/YeSDPI7ffdJSOgZukow4XBmLIxZiEVfzDHlaYG4K9iRrdY8QjgDPYbtT/jqBN7L0AnD4PNjSl9bYIaN9oOiuuLyE16Utop3IqWY2gvh/ag6wC+5BjD2r7DyC3D5kZJ8Rcd8Mde/u998pXSvGf32/0HvHIHvtZZtas2zDKlk2rpAnWP0A32BFGPILqTew/A8wR520mpl78ItNAmDogSRL1HqQ+3RNWiGXYdNrvaRwwgkvqBIPoqYcDExuxEj+0qS4GKLjQUwNM3tjnwH7nGU8+zi5fsZ0BV6T4ZZJ3XvXKmTjPL5XGZZeflf3LV19v54y9H/iv/WmrOvX0Bdnk/SvIqAsaBABG54P+hz+MczwMjk1kGpDCqEQAmeBUeGC1VF0HNmPatsBwSF2CI4Ar/J4ya2r3KdT0OM3tVnXJvFWdUqIW6IAZGSXftOH+fbh9jL/nna3hj3/0k2zauQZ49b4c+2AlH/7Qh2biPHuV8unPPHv4rX/+WdatH61Oe/gN7CcAjS2W2fa2BczFB2JroqvHfcPeHmy+REfNvcnMctnLx0C9UKH24yIF3B6/J2oT/Mw7/49s2jHTwzspGFMdYXHsZwXwgegKpAsyXPTsYcv3CYCNNT9r5evuXMpnv/aM9j9++ZvMwGI4eXnqzIRh9pAjV53aes3vfiDr2tFq1RJsObXfdWDMzTcvkqo9hF/doN7gp1oG+y+ouBYwF/d800nnqUfbBz7PYGnAue8TgKvT1ozz54vhE+r5Jmm96L2h2RgP3uSNsl7XKtDDBaCDeCeEVtG1S5fs0zBc69KLrVm/ZcJa0K9/7Y+rCy64mHq62AGRvDz7rAPZ/l7FdnVk5HWvfJ/etXqVPOGJVHfcjBbFfqcN2fX3zRXRIhKYAWPSBwp9s8hGcbPL0vK409ksqMPgkYZtWcqS6oECoH5bauhROxyVB4+o66DVftUvBqjqucmV1n1OEycQt7hNN3RBIrjVguQNy+jYPnnAevkt2tu8xWZLFyE/uvTZ5l8veCnwT/vSxr5Kbv515suzNe/f8of69X99rjl8BbSa6OQ4UjT2e8zSzGmOaWcy2mKp+9A3mhESDsY8C/Xt7MERazwHu4+6bkxQxRELnqVkejtQZwdQt5P2JbQf8RpeEHV9K/3LIoZ6bTl/fA+o3KT0tB0BsJXQnoorkzwQ6T7pObm97tahkcyQoZSf+8xrzLf//Vv4wcADITm/8RsHqu29y7q1p8r/d8Yf2wqK5Suh16OqLJI39j9gunDOXLplX+W0+GRDtStwD7eFG+yPweFEfVL/E1E3GpFLHdWOAExUNdDnMQdmRPrLeQTbE3y2c99r4raHSVoq3sNNGDB48Wp87ei634GwNQOdareyXTvm7cvt653+pIV0JpfQgHzFAiYvu/SJ2YUXnsEBXJ0zlwsvPFBt7yH2SU8zzf/z3rf17rh75dCCYVg2H9263Y1hygBqsU2OD0sYC00jKNPLbBic+s3CjsGZSNRqWFAmgi4AkIT9TA206SAM4IPa4QghGJW6NnQpNZiDXRcWvlFxpUpie8YlU9jKoSyWE5Eaxn5GHNvvzy3miH25fXLdNY9gzbrlPPRwirnDcAfYf/rCK4p3nfcN4IAsLJ1nRx19INrdq8jl//3S6vtfO0saUMybB0tbsLXjMFCV5tc28Gukag0N9eV3h9haatuDSzoY1hqpVv1DT4z5MLIQyrMZ68MvgQGTdvtYkFqVBnCGmF44RZjYFMCsgdlszXxx2a5wzgT5JgepgCyml0kpiGdBWlBuh9a1P3na5Ps+9Kn+C/vlkn3gvGfJrkqypfOQYcUMQ3nFj56Sr1v7RODiB9LGvkqu69YeiHb3kPIxj19YnPvmP+m1lZaALJ8DYxmYyps7dmR/z2HGd45q8D5J/kb2Uze5p2VdcUBN2CUWxAw2F37WGU4FB5D1BZ+pATg9VghEWyBMJgrer/Ggj0WNAl378eDAotbEJIO6JLBfRy4s4WV6YFyZXqPqfKEmlMOg37/wuc0XvOhpwK+twVcedcxj7AUXvLgxD2TRGLR3kC2Ect3ulv3JVc/jQAHQzlBpjvzOu86x1156uhRQNApYNgKFIEPG3d/77lu6v+cwkzKqGWigmmBuhWTPMLzV8htiqrsmjObRF9b8CEutpipYEmCl7Cok/6AfeIFhI2Na93vmzx1GNuL4tLcdQx8lfM/9dfgywo0KqhIpe2RWyUQxDajmQXfj5pHWB97/wfI9738Z8Evr8FWHrZrPX//lu3XN+sWN0xbByDDs2oiZ495Re8VlTzPn/9N8XAG5gUrOa1476Db3EFmz/mh55x++prLueebLWjCn5W7waI40gHvvXWX+5G3DwINyRsw9m0W/8/UR9QSBrbWYA49nu1BruU8pBeeE+mEH9gvOS0w2SNRwn2qXPuyRU9ePmQrnk2S0JHPtGf+RjBg9D8wYqm5lvu6GCLH+RmaceVB427KyZFMTGKuYDOyoq/PE1Vc/ypz37gvkJS851+zYcRHT4nr2occ+ho9/7Lzehd957tAqKFatcOecmsS0gHlgb7v5xOyOnz8K+MG+PpdfJ7nc8fNBt7mHmMt+/Eq95+aHau5WOmBhw2WJqsKcJmYEdNO9D63mLFiJW8Jln0U2XV/Y7tQIiSnlCEl89osP+IYCj6EkmvpqPvUQhWO/QqYVzUq9aVIPp98GDCAewRUZmsI98li+TetUrOn9S8M5sGdxpBBIr4zrXyPYi87uMFbd6uqVQg69udARIbvyR6fkN137NT3hpOvs6adfp8uWb5Xdu4bl1luPL7/wmSeW961f2FwCw0cugjmLYGIS2i6cJQvA3jXe0quufDoHAoB61YFd9V2e8syjufQ7vxPmUucLgeGCmGs3OkS2pAFr1y3Prr/yNB4kAKujj23JD/5jYRr7DdouAkbpX0zGeECEQf7w8AupC/+knxh6oZ/50myXXNz4csv/ZiVhW6kdkXhO/+8wAhjnJ6tfqBDfX7+jEbdzJVCEFLOQ55hh8oLW1G7yskfHQHeuUjWgOz7Z5IZrHi9XX/P4cC4VMEMwchgMLR5GFq105x+/H9pt914N+0u46vKn6Je/OsqA123J7RvfOMj29jzB588/S9fc+hDN3ZK3ZlRcOdwCxz7NFvmK+ciaTdhbbnguDzLmpK96xkIztX1FsOmCOSapXZapX2AwuLh+UwwUS71IYEbCdsn36XG7FIhhJtuQB4uV/rxBTQ4IKfcxNBM67IGptp6UHmyJuOqS8SrY2xlqXLZ30YChYWRqlGJqkqI7SVl2KFuWsgA7hpsr0nOH5U2hMVaQzZsD85dAYxjGd8CObdhuF+sXZNI5UN168ynFZZc/ArjswTyfXyZ5dtnlg2yvT6pHPmaRXPLts63iFhyaB5IZpzqGLb4EAGbpAvL5m+hddsmz8rec+3Dgpn09l1537VE6vnUhY6BVHb5z47fBiTD1GC3UjonxelNwNlW0/fy+JnEEgATZtc1mcCp3iNruVHwg2UwDOrUtmMYgw2+KA1XPozOEaoIzI+oYMA+5jZmzE/MCGk1oDsNoD7od8m6bvOyC7bkbo3j05W7N4+YQtIacSTS5GybHYWIX1lYR68wDu2bLCNdf92QGDUCuv26Q7fWJlOWz+flPHmGbIENghkFy41midFZymcG8RTSObNG9df1SvfHGc4A37eu5dGz5KbLr/iG70JFH9BvwNpIYdzNDAfDpn3BQHhwMrdVf6qRMV78h3jeMq2SQ7lhpUk8G6sVntD4+tRfCX4MrQl56mxBbO0CpLZr5NkMs0yqYyrFhowGtYXdd1n+C4RmSM0JXbQWdSehOQnscep3YTVGvhgF7+21PkL/9cIHj5oFIrq8+MGlfWonJ3/0XZ2nHonPAjPlrzr19lVfuZlUKQ3MoDltOvn415fcueHX+gU9/l32IO+nhxxXy3rc9QxtugEDKcI89+EzmVFaMp0HM8wv2m8ExX5aGSgLivEzPkHEN1Wo3Lu/gN8YVM5N968bomyMSDlO/X0mdoZMMt0U1Hb1pSV6SsN3W1xcmL4V2sR6s3rOuSuh1oddxAOy0UVv1FXigAQyDveXGR+X33XsM8LMH+mx+neRy372DaqtPzNadj5ZbL39aNQTacgwoUI8qaAmt0qmZsoBFK2kdvYldt24c0w//1YeLV//JS4EH5KLbtRueW13/g+ewmHjT3KCFQOEXGwzhE+NRF1PzIT7EAj/ma+rYX3AUgiOTql7BrS0yrNNA5o+JyaYeeNNXzUynceo0cIYYYMic6Zs7PE2CPRlVv+9nBF5gSevUcGV9yYgS6ILtQrcN3S70Sqxq/+kynBpev26pXHrp6QwUgJdeOqi2+kSq8um6dcNcOwqM1Izv7KsKqh7kJTRL5+2NzKdYeQTD4z9j4vabTtEvfOIr5q0ffB3wK22EbPOW4+35f/celd05w4L2lCLz5pHxc4CzgjghCWr1asUxYwBfWIqrL9NFa+BFO87/u4EHn9QPPyHMOv0+AVhqC0bPOzlfkHQSe3Bkgn0o6b/9XxsC2Z7lFAfAsNaIWge8qsLNWirdKIrtgXSdd1L2oHS2X1wyJUSpRsCu72HX3/dY4Pxf9Uz2RXK7fnD1gILob58zlH/4r56tAE2QptMKbn5uUAOlu/hmCd3MFSpavIqh9i5seR+Tt97wqOyv3/DdxuOf8ml97FP/RSZ33EVqe8xZNMdOdJ9Xfvrv/spuufUkcxhUPY2lkzNjXAX8ouEZrR439YmCtaGYiVe/Usf+UlAEVglgAsfkw7j9Y7aL1ttDaCU4GuHffoQmOhdh5+lqPcYevaNUZ7Ymxlm6TWuggWe7YBt61lPrWM9UYLruGWjP3VZTAiWqttbWUuOZhnMk7c9uPVXO/9JcBrQGXa5vedsg2ukTueHmk1l906m2BdpI4rbBCdDKvW29HhQltDK3CF/ehKXHMNLrIPlWJu+9c9nUv/ziXeaK7/9Btvyom+Soo9fonLG22bhprt5958nVXXecRG+yMEsFW0Fu1I2eGUEKH5bI/Tq/EqZkGvqnZ/p+5R58mQdmXwaN9AMkwzFfJuxRviPOZqNmq4gf7cNR3D+ANG5Q542HMWOBOB847BOqJKi36cLvVWA8vz0ATypfo86zX7D/Kgc8TAWiKILG9pL+C27ph9V3P7Rx3fXHAgOZz5tn110/iHb6RFff+QS2b5qr83HFsqF+0AbAr8Xb7bo3sZG5tKR2Bq0RWHk8w/lqisZG2tsqevetW9Jbu+6ZXPGjWEMS4+zKbAEYlEKgyIQ8E8d8jZZbhLDhQZjl3jAMqjjYd54Bc8+GKeCgX/0GdhuWumQG4eIShyUhpdrLFT8CogkwUzbz96byv2XqEya0BmnacACfgFOzHoiSql/fjlT1R0vPiP6jlTveWL9YgEanOwxnxkrEw6A7ts7lxhsfxqAAyI03DqKdPpH1dz1OrWO/OIEn3HQzjQGlC03j9GZp3argrVFYdizF0ByKuZuodoxTTvYou97UCVo0c+Zd3hCyzI/zNfN6dfNm01dD9Y5IHo3D2skwHkxZ8lv6MQkArbhx5BhuSWkxGP7022txm//NSDIMp/1DfVGt4thqxLrFrHuhLVsDq28tOX9Pw40Wm+Q6em/XerCVHqiVZ0BbuZsqONbtUi9BEYY18fe8CXZTD7t758MHBBVyu3sgqjyKfc0bVhZvOPNR1odEIgEY0EwcuVTWAbDqQdl1G3NxwdEycwxUNGD+ChiZR7ZwJ9nuXTQnp1zIoPRvrYgDVKh6leeuBFsAXKOot0nmPOJGsP3839yr4pDrRwq8xFOONfskCSJLv6pNPVSFPTzXQJTB5gvqOr6Y1A6GURfUbvl/V/4T1HhgSmtrVrVVfWwwOivv+dqKOOG9Kv1v/vgwoT2jnuuiWkehgh3oqxnrz247vjjzrAYOrvsleX7iSfvbRp/YSy45ke33HWaHnaqMAwjqn0dQKSH+ZHL3oC3uxuXW58H5g5vDTpWOzIVOB7odF7Mqez6U4G+Y8UD0q4i7kqjJXzGOaTOT2ILBAUnswT1yrBI128K9KDFBwO8zPcwSj0sYrY7L1NtDWpao60uVAlKcndnUZCXOBHx9ej4JMkcVHQCXfKwPvwQmjR40dSJOGCmS+t0LUSX1o352w33HlMcfvxjYbw82L48/fn/b6BNz+Y9PZtf9Teazh2kUp15YC2Xp1K9kNVKNBfEMFpZPCM/fZN6eM1Dm7njrK4crPpySeVAljoYrDuMZUNwnMFxIaQrgS+cOp/M9FF+rz9TAC6CKQEwvVOttKZZDwkHqCaf7hASNMLLRwk2an/C/B6fEqFPRAVSxHc924fcquOGB+ZLfgkcOkQkVHMtn1FnbSfdDsF63bVki27YfxiAAKNu2728bUXTBknmycfUJ4N6kviwlf5NVQayPRxnPgmp8Yqb/iCVWMQ3ZJKJ+nQ7BpaLjWDLWaTE1iDIPvCzMmfCvbiFe1Qc1DHE19Ok5ftNtwSH8mhzU1JASHsnFxkTEsK9nfWOIToehznwx1Nceb6ZvfwEupet+rY8N8R1Jjqn8fQtq1apLPZtnYdLCTpuwqGfLPgfHnVRCpAKiExI3C9AC7U7NMVdesQrY7/VccnPlFfvbRhQdm7OcO+88WqfZf24jPhs93CDr1LBkjgkVDwp/IwOQjAddrAqfAC4wT/BaDcQYn+QJkPy+TakZL40BxoHjRO/E6lninJQm/ewX2VGSCw0gnMaG0/cxHqDh+MA6UC8HYTxQcoUl3v7bAfXyDJ4pDcSAM4mdOM/CMoW5CuuTY9PAdQrAaEW4F1PQukYT9a2QBtitu6lGRw/bd4TsKXk1OrilxGTlypUysXVVNIWC4Rqeh8dRNJir0gOlclF5wanhYBcG9oohDG9HBZZKgZB6rGS1bRjqQBfixmtDZkwIvcSJRqZmwQgkbxo0qGODEZgk/ZD6mMAypH+pmXxvei2nznwJBCfq+qbeDlyO81K3q5ufFvCswd7zbY5ZtwjkAs+Aoi45Nsetxu4929iJqKWTPifvdh+J4NspQbdtecivwsIDlVy3DbAI0vLFh9PetjjMn473OLK8YwO1ilj19koXMDUQwkRuyeuD+4cJ2LvtFABgahCI96jB2VNDUoPZ4B2QBJTpaQJrFriwiwmgM3U3Uhsx/ub/xuh7wugWoucq1G+j4EHo2VDVh14CYNQx8FIPpp3ApEJH3YpTTXHO25B1tW4K36fK34eG/0xY15dId7qX2+r6oP5dT9MmBeohus1b5jMAydk8OABma9YupNttkfeDLzXC1dvJYtSzXVDFCaLijQnjd/73OLSVMFV0WpVoe6VOQDj/CH6sN6hc089+adyPcA7jHm5Qj9EtNPW1hRjfdDH4YTolxm1McoxCLFAZhgBD/C1kQJdeDYdtBpijzjvu4EDa05rRwz0pqcHuf3IjK+Ef0DdOHBgilgwh3ruYH5tYENqAbPOWeXvDwL5Kng0SgLmZb3tlM0wMSuNI0dTw3+PQUgiUtrwKTNVLKMxD8IinASCqTPrZMKpF/70QV4YjD+rX+JiW9IdjYhwQ96pn4gDYp2b9RZnkvCmNqH8RQhmPPUIz1GwabVf14Z2gH8UvxRquNYzr+iYMjhELnH1srQPo9Bc0BVefoZegCf8sSPftv6S+6nCerXu7ts9jAJL3dg3OCzaj2ZhSSd8cidT+A7CKVuK9PuuCytFDxQGwCjcwveMhKGwcaKM9OB08Uqu+gPxR9QFkqdmmzwYkueFSA6OJZz+TqHnpfzjTJWXnTOuk0gjU8Gba+jpDHDBPzlFRM2/ar1AZK9X7gVWN+DCL7feoQ1gnTBeMIcOEIalvF2h/5nh6veFZTu1/NTOAXKemBtEOALbqtfa0Wp30M6C6cFY0zCt3YUMCHQOTZa1S1QMwBJNVffjFP4yY1+cBF97WAKpCYD4+DUy9xyn1py9JVWpHJsOxXxz18Bey1xAMtbqP/1Z37l66XZPEgQD88ETV9y/8Ft7iKjmvcUNpmlxnGHIL7NVnDiQACyANfYuhGOnfPYa19nJNQQyYqanmXrbss+RmgABUse7xRFXgbT5TX3PIGLIWxCgSXzsLpoIRcbZPW503HMQqaJLTh5l2s4P9Jz6g7eljLk79GknARxLO8Q/e+FhhaL7hGTJl1cBiQRWl1BGAGQBmvBrNNDEH/H7hTTTG3YjMgytNSo1Zzoa4HFcasws2Tp9H6+N/KXOFYbwytfWmgTRpN8x7ChYCSXNhdwTodgsGIDndwRVRFzFVDCNoYgfiLyxE161SpzFVyVtv3TKlcz27dcLbD1H1aqoehHoerVfHJnnIc4HFtq5ukE+z/fzYZh0D9HdXxAEwDb301RmUaQCE+GQM9YUHRyQMse2R1RzO4W9WFjRCQEEAhrh4YJ+NJzWo8PcunCMALFgvPeudleT4yHY1GPvIzuzlt74ffpUd8sAlH1RDAHljeNKKuKRbv3geJBrM+jcrjBgJSJqShKfHocyBbRv1PP4INFOr2MCCIVwRjXzcENYy/MLP3r4K7JdrbfhPDz6HuFyRbItgSxkxXPU0FRbZUN15CnV2WWzDJsclgI/emt/cZ/95CRnbcb3l0J/kHma+DxH0uFoTJdQ1aVLWqylOkxhhIMo+LRzIpYJBrUM82PWCFywZJ88qJvztC/Go8ElDUIk6dovlBG9PXGC1lTn22imw23hA2zpsEbJTInDxOXS4WNhidaGXMOQW7L/wEAOIY2GgBAghOzqdE4JQFzmfBsZU0mGuEIPrJf+OLw3EaZIpy+aQxGtqMIeXLA8vi/9fSGLYG1UJztGZ9IwXY5l706vuEzlR+7eESwohHm02B6I6c20OxJYEoHzIUVvNjUXbjDNStYEmaKNmfALzZb6mZ6XJ8KYmasEDrWFgkYFWBeMGemlyoafToMoLYEhdnGyBusBzCDgb9Wlb1IZ/X82XlAXVZdNMB2UYKUnR2xdX810LZdaCGiyqegxbvOdgvWEchtXCcYJ7ybLYmGs48+cMq1oV1C9Puvp8vC9a27wddSMgMX/QJgfYvu4Hbd9H6kGjp+ynoCPDA3Eech0ZiDcNgB5xzL0MzduFbhuhAp0AyXGJCVBnBhnihC0N1QNC8Z14F/zf3Dovdo7AlHUZaOHhGXWgaimMiltkekTrshoBgMH2CwHnYAf2JaD682UeqCkAJav3C2DsAyj9eioOI3gwNz0QUrWL70948cL1pt9jv7Tun/qXM8xhnh7ris6Y/9rB3bNQhSE8CPqZOhZdUAjVxVINrVCPUwP50MjEA4TFr5Q8H9rvsnxRzPrN62gsuFfM3csF0DZoATKnfpNCGEat+NiyoqW4obkQ3xPbH6IQcWXIhoJe8EGykLbeED/XGB/xT9RuZMHE6Zg++Sj1dEO2TBgJiUkPhrjQjYS+hfikbyPELaMr6WmjYXwqVLhREJ2poBbLROeFvsQSvsbFS0MKWbwHQnR2QpwwxBmDg7LLs2SfcxTAmNhHEXwauxGnxSionzqCgnSA5SsHsgpTzvKVg2gHALvi8HXmiIf8nLuveQwZrsPhPRlzTFjXQlGwgopgLT4XQafdlKCewsO2XpXamsFyH3KRBHghnSsNOsdaL+l3atUagBazowPwPAOaBJQS3Fup7cJIbEHNBXsDV0SoAjoJ6yDU5XdtbXOmRdPTdLDIjoEVqc8bvWCtvXWjMC4uCyYNE0UPOdiYGkk13RQy/BVnMZCuY6XAkUcMZDplzpFHDKIdAPS6KzbpEcfdLEpM5QNQXx9PRsE2QEIEyY9vKuLGh6M9RKKFPSPGGWvh4dj64Yc5EFmwo9QlbMZQi9YpT2nu397q/IW6MGHyet9YcYYLHAiRQo3xTkR4OsH+C7ZG6bY3cb+Hsdugy8LIRnjHoGbBwFqK99jVAbkkAZTUMU3V/pU+dwMT6p03D9C+lTb72Y8+LRWeES5bzqtvLSFrAUcds9el1/ZVco46ZhDt1JI1rpO589syeX+rL5mxC7qLaCLZRvIcFJfio/iwTMJ8YhM28DdTwKXb44FlcWsB++9FVgebM3+MMXXSq1APwcXzUMcKg7ORVlIQQ1zwGj8qIxkaMrq9pS74lHfSKEXpbMEWQK/2WkPcMgQBws2yvm+xPrTU9ld8McOLiAcd/WZgD9he1RnQ4aXNtb7nfsjOgpuKabU2lSrQngOc9cEJfPdl7vxJMzpnIIUlczM6ZxDtRLHHn3SjWXL0XXLXdSdL5qncP0NVkClc2a8GaBPEe3za8yommFQpEAG3eItJQGgc2EKQObKc356ZJMwCcTRBkt9iBEqpJ0ZBBF9UtYH5fJ6iyVDxLrX6RbB9H9WnxAs+0KleFahvv6nQ6blpqIE1jd+O1mGVaSQVAWqps2X6Yi/pd2AXsCOYNLh7mZo3HpQazCHfpFrQLmjHA1D6m6UHsnTlfaxYMRgAsmLFINqJYnbdv0VPOu3H5o7rTpZhYKo2eSRccM9rhC5uLV8B3aWu8HsB7kFQOwka1G1FzBUMTkYKqlhGzdZ2oCGxBekPzfTlAKoPVhtiNa04nyTMrCvQuOihy+VXaaCSO/NBS8Rn9ygVWIOoL/IXqCWEUHo9p44rf31B5wXW6wtY+79CnWoVZtGFSADUaFF1Kfxtf81KEvIJtrX7BBNSK3WFEkqc8xiIQxOsq3tm5uRTflJ98XMb9gcnQfLqi58bRDt9Yp71vIvM97/4WqOTmQ1qWN1LHq/FM6L6ifq6HXQnyBzqVKagfk1gi2CUBx0RdVDNWMZSFwTXWhXHdT+0H4ih/WBnRZWbOdCZglCRXlP1S4GS4+qONFEqxPZwCq10DJhlqDWIeBa01LadEch7fm6u+BWR/MeKX4Y1OCD+puGZPqjv8Hv0+j3L9ayz/fDXW4bgXQCeR5MCAXg9nBnkZ3Cm70wQ7Tn7T5769EsGhZVcnvr0QbUVpXzyUy8tvvnYq81NP3ycNPzFUZN/GNJ1z8NPhGkLdgIYVrIwZlxpXTAyGEpRxYKrcSLenvPqNwC0b1mtaeALjBdsS9QxX+Fnz4Xsmyyo3QKVRm3/If73FipDILmzXbOQr56hWiEYyAyqyUIygY1SW7QSV64uuKIq0BE/Zk5tYlivSvxpUH98uKEh2yauMReu3bNf6IRfn067YEtfisPW74jCHgkJAExC9pDj7tHTTv/vQWEl19NOH1RbUcz4zl088fnfMDf98HEmx71h/j4o1NF0v+KAGtwNnfImE/jJS+rSj0Jmizi1FgcpRd1vJgFmqIIUb3pFn42YGuoGomVfiJtXHKZwZkVUu0jDAy5MoROggZoWiJsArRJ0VobgxrKVAtGu2z8cZpMb4ax/B/YASpSYsh+ZH6LBls43CWaH+n/HuKb1EYaqNlGCB971f0t1SkQ1km7Ae7grqerFgnTAPPP5F/L5z/1iUFjJ5fODV8EA+vwXf5PDT359tvGWY21RgzAN8Sk+VGMgKxUmQK1gc0VwK//Em6cWtzyVu3lRrQb9HhhSbK2Oo1MSPuzJhOFTeGdCjFe9uQdeA5XCqWJ/kGL8tiGQFjGTR0vQrlfVwcbKMAgqxjGi4E5Y+esytr6GmCUufaZfHJoL2TlhxlygqaCWFXfeAqc5VN15uupGYrrWvdB40Bk/9ltpzX62bireWgGdhHzZ4t385ou/Mkic5PzmiwfZXhSFe+zjX/AV+ddb3pWN9ZtsCnHQwPpnYgWySdCuQmH8alXBXvNOSHQ2Atj8gwnZw9OzPGLMUBPHwzsnaUA3MzUAjQebFM62Ex+4lMIBT/EAaYCMuL9BpHIviXYJykzI3HE+ZhgdURNGTUKMzjs9oSpEdI6kVqUx+RRvRHunrNIatBYXnF8I3AO0g3q2NWuqxiKUajRWcOtTvWlYSEF2Q37Wi77Fl7804BrRX/7SINvrE33pb39RLv/e2WbrzceZFlTdfhCC+27x934SzBQwpljvrjgzTX24JQCIOrAsQc1mdYPhT3yVw0mSTwjeCq46V7D/TJaAr+kZMIzzheNy1Izicr1y6sZxx2JwJdAsqgbxoxsaryl5OeIQpLrj1NRgkuRG9U39TF4ewjUGw9pvOMzCZnWLXnT9i+lHS7QEbYIOKbrT4Tian76J+HwM6C7IVx22jde89lP78vwfiBzQlZIUVutvnvMP8g9/9lHTwhVq93GsoC3wMyetD57KOLBYva0uXvsEJFXJA/AHBxUVbL3AcOn0Q6B253xbwW7K8OBLRjtMjlI41StFv+0neLU7iossa72tL5DZIaphI85JwXhnVpOAu3X0Ezz+UNUh9eSnv0yqxMn94f6kKStWXWLvyTigr7YuLlg5+88OK/pQ0N1gt/uwo29y+nwlrRwpNF710s/y1a8OfF233Hz1q4Nus0+qP33L+fkl336x3PnfTzFjQjWl8fmHm2rDi1+B3QlZD1faTdV7kFojN33zQxa0JI2ZEGowCTuGITXd89Pw6jfG/tKgs2fFvnM479fPVieCLuq/MLwSSuECkqNqXUkSyUA9oDV3TNk3LyUEp30MM3gFJgGZepWbJcxuvCqOoFa3FMbJFhZZ2GRhpzqnYynoqGJv8q9I4vHGyYcBiNugeNRjf8qrzvnEfoNhL5LzqnMORLtRsh1bdtmXv+H/yPtvOS3TbUNaEOvpxFmZ/vlZA4yDTIBpKahgRRHxIIweYPB2w4Mz9W8xHSmx/2I2dbAFfRuFgVbL23wZMaYnDZQCV10zhF98WzRRhokAjIkSAYgBMS1vC/oYlOAdDouqjxWKTx03YeTf1gAKE5rigoqh+fBvv58J6juYJ1qDsrLOHlyusFBdPfKeZ7ttzuQJA4cpAKPjMQH58GjXvPUd79E1qwdfyxnIdc3qA9Fuv4wOXSRPPftTXPjJP88Wg4bRERLKx9vebbA7gAWQibpsGajn6IQM5phgGYbnEtAZ/LbwJJLQjOB+zw0MtSAPTkYDMl/QmoYHY9gWACi4wtABgOFk0+IVMU0rbLe4JYr8hRrHRGlozjXlARlGfprGz/vVesdwD0IcM3j40cb1zkZ4yWL9QHWpb4CWit0NVad+XaLBEp5LD2Q3NF/5io9y0YXf3PeH/sAkNxfNzIrp9lWv/bC57ZonyfqrT8vmC2U7UcVAcA6sBXaA9MC2nNWk+MKWYmtjPDzo4N2CB5hnBZPsk2YCK67M27Av4RtGPGLIpYnSAtNy4KOgrnZVePZrUZfVCp0PjXtbtS/O48AXzStfr0ZR0AqxlVfFhQNhUA0NX0Z3KqiL9BohxkPTYHNgwjSY4u1N62tSViWU9zsAJkf1HSKboPnU515i//wtH9jfZ/+rJLd//pYD2X4qG/QN73ibvPf13zTdDfOyhiuQOt28s8YZxzKOi/FSqwdJJy+lDyOEZKJqts6xiJ6zOlVUZNAs3ApCxdC0QHMDG0v6t9xvFD7pABfDYwgYpWa/FIABXqkqTsf8ev27+hdFK9dfMSXOCC58TKR0HnnTA7kjLo5HAsQYIba1+o3FK0P2aN0rdx8VOwH2fudghGhO3EFAt0PziKN/kb/+D/+M227ZPigA7E3y7LZbDmT7/dIwP7TPf9UH5Mvvf3+2yt++QPl4cstAus47YzF+3p56LutzB+u3PtqG1MZ6YWEsxPb8yEY+hFsxsZHYfB580uz7t+JHP8ic/UmOxpq50weTpzNgYEGowVpvV1FEa/tP1Y0j12AKSX8lZP6lMerDCL6dEMQOc2P6QBhYNLygfrasqPN4t3oPmMTuCz28H4rhxbvM337izyq4cX8f+a+TvIrxsxmSs37nw7LuF6dwzb+cnS3DZV74TRbn/Kl1b6hMgM5PrCvBDdFBoooS9gtMmNnaWC+MA1Lmi5WLzwUzDR90bnqwNb3aDUVXCtDMqUvAl9eiTmcJE5dSSV6QUMo/AlET88G9UhLAZnuoDPm4c0mdhePDA6kXH0GqiWechHGiA6aEaqmqSqWKNVCNQ7XRj0z5iE6cHjIJWdWk8aa3/jW33/btwTzwXy25uf22mThPLbff1tPX//k7szuvP7HacefDs/lC1dUIQgVHMJNQbQeZ70egAgtGQ9vURwTwGe8Zo0lQKzgCPr4WxnSlANPw6VRNz4puOXWNlX8yb4Fm3vYb8u04BnTwSxkwXgEayrul9CIkXleFUiKUrh9+3Q4JscesxE2o8XoyXobW1VAl+ZtqhT67UN1/4kY/7Aaw497UicYfaAfMdhh57hl/ww0/+dj+PeQHLnl2w35XWd13ueEnd1d/+r43mY+86eu071ugLaHyhbjDQAAW2AK6HHQOcYTNpculNzuxhaItCPW6GUI9/dKrYxNA1AATPF/n/brwS06/k1EQVa/4ZIPapa1BH1kOJPYH72xQ91khBKmdqm3gVivKwXqzoZrGsNHuq6Zd83S1b/t+V7XulwzsZtANibnjm9AumC3QPOv3Pl+e87pz9/fx7ovk5R+/eSbPl8ol5uw/Oi/7x7d9lCF1eQYA4kGWA+NgN4Ido15dVPcGvmBsh+8+JlHaGpAxqNyfZKA0cABo4lK0nfPhvF+pnQ9peuAF8AXgpfER6n4kq2YKuSt9qxZn1AbPq8RlzDgPWLVA8FnXYQJUH8OG7BavutO5vvF+OJsvANGi2Eyx41D9AmybvslhWoJsgdbzz/5m9Z6/fTMDXIr1gUheHT3gOSH7INXRx3ys2LTmBPNf//C6bJG7GQo1EyroRrCLFLtMvPp1LoGkVY/6AEmtfko/oSEMb8XsZu/54j1d6u+EALRnPyXDsV9SUkFqBkwy/cC7K7WDFGIvimB8W4GdKvw8UlR6iDqbTyVDQpp/mBsCvoxdsPWCvefbit5v3UU3iuTjqFap1jjHLpYg9I6ybIHmk553MW959x9mW7fev/9Pdd8kz7Zunelz9knvNW85t7nupw/TX1z5+HyeUPa0HhLKgA7ovWDngZ2DH59Xb7D7B23Cd1uzn1FiHepQZDJOqcxRfKYLQf0G1ev/RhvTsaL0BZelBl4fCwYCdDaE4k0A9RmkbrUenCORE4fkolMT+icxJFIzqvdsowSm82war30a+xml2gTVeh+ENnVzsh2apzz+6vx1b30NmzZsHMTz3FfJzaaBpPY/aDGwsffGD/5J40PnfKu37a7DzLBQ2cQexI2MyEawo4rJHZ+oqLOzUmOGhBHDgyl9sDEO27kHryY4I8HeC+wX6neET8iEkQRs01VwyoJeHap41sOpSxXvzNjkmMSOjHanqX+P2t15yjXIbH2evhTSKn4Uixql2q5U9zgnQ32Sjq2cwzF02LG3Zr/1mnO4d/Xq/XuKD15yc++BP/fUKSflZmIyhDv3ItW11Sve/u7GJ17/WVv1sHkdxVDvB+gGz4KHubFhVeu1nNcpaRGf1Bss/QBoqMHngeNGlzM0OhvprKWUlXLPdjXwpG+YbXooJoxFp1548gnTOFMg94HR038c/sPRle0m6teznHrGm8Z8eLuvHIdqNegujQFnW4HZCcPLj1prXnDOa9ixYYbDIP2Sy44Dz4DZ+KqXNy664Km94x/xaVm+6mr2AkQ7d+XneMmfnNb81odeE9LD8WpYcrBWMesEOwaySCO7SF9g2tKXHCDWqeDuJBTz47kUEz97B1/4nrJSEnhOy3JA4qy67J2UwUStP0+qPqeBElOP9MS4SHAuLFRtN2ykKdDS4Yswhuy2qViqrmLXqAs6Z8TZdNk4jCxZNlH+ycffZOHKfXmOB0Ly8oSHH/CT2GVH3FLcced55mv/eE73jDP+mSe+4BPAHrllE7/15g/O/cVVT7K3XnZ8u1mTmfocUdsFuRfMMOjcgOFUpYUx2+Q3tdCZgKGOry7g7Szjgabu30qI7aXgCkBMHY9+5pO0th9uGoHulfmkNsCiZ0Fsp36JAntWXvV2oZqg9nrT/BVbM20Ap7FUHaVa6wPO1EWGmIKRkRx52ZveU2y89ZsP9nkOUvJi460H/CTFxluv7/72617SWH3P1xr/+PXfLm+5/Az7uKf8mxz7qH+0yx96Ob7IWH7r1Xd1nvmaj+V3XfkPRqpYtSLGbnPQcbD3gQw7UBq0njsifj5hfOheVZYd6I1DcwnOaww980ZmElpRsmkqN4AQ+sGXghH6ST0NzUz/pFKrTIl2XVCxwZMfh7KdgE+T4yofcA/DepaqZ6nWKtVajdMrqVysr2Uhe87vfHvq9DP/bp8e4AGUvHP6mTN1ruvNy3//ZfKVL305v+6WE3XL116hqy76reKUJ1xsH/rY71SLDr8KuJmpyTvKxsIJmdw8IkMS3l8/W1Hdkq/bQdcrerSgJnl4IcwRWMlaYv2X7k6oJqGY44NfFjcgFgCVju0mf9UD+ZeBKiSHhu2Rbujff48SA6kkQeVo11VQ7obu/fTZtlrVgIv7uhXPbc+FW6q11BPLraCVknWgecSRu9rP/qOPSHvnjMb6fpXk0t45YyfrPeuZN2SVOVv//RtfyO68/tRC7BBbvvfC/NofvJDDj9oqrbHV5dat86fGt47Q8qGwYDolz1dF0S0GHVb0CEFz9cmdQkxlTwPSZFBOQGcjFIuoh1psHe6IJwl2VT18pwgSqpiGTqRfk3R/je3YuL2WBGjpRUUW9MBTC3YSepvAdvyuwcNNwi3Sc7+bCtuzVOsC82k91dXvmluQIx55Fc2RaPqUKxoi2l6QXXtTkd111zZmOAgNkGdXzUw+YJR53Mxr/+zszpc/9cXypsse1zrqCHRiiuqnty+yRhdVGS7fM4TFbA2JWL0idw9dNgg0FTncT+GcHuJI13ZDoL0JGguQoXmAYrGIzzrRaFsJGuN84hEW2NUBRukPP+/p2qdB6HS4LPxJQybWM7gr52EoHbDKTVDuSkwL/xGfqhW9ihLtVti1il2nsfhqPSCiLl2ygN66W47Irv/GC2SMbdbsPrm1Ljstv/ma0+S6zQur457yemDG7cI82zTAteIesGy5077p3LOrT3/4M5OXf/c5Q8cdRXPpI6k627DVdjLbo9sumZKyXkA52vXO03Tr0Sm6yWAbCoeBKXxcUOgHnoAL/PagfTfkC6AxhviHPi0Vwn9NB/lTFgzbw/fpqrUGWqy47NPn6wrM4WNxpBMA5tdHKXdAuZm6SF8YBUnStKjAlOikdQ7HfVBVGgsMBQCGnNVeAzr33Xlc49/e+7VsrGnzrm3m6ydhTUXvaS/5cffxz795Px/qg5K88/jnz8Z5ge5a864P/3b1mRUf2fWdz7xi6PBxho86iWzoOGCK1tRW2H03E+JrYSd4ilxnQEqLbhJsE2SFIkVIf6oSsGgdWyt3Q/sWyOdBNuJAmbBRAJ76SGE8eQSTqclNPVMK9AMP+oGW/j8gwybn7YH2HBPaKeitc38Fz3bhmJKUCXXKM996xVa2Jtzat3HGgPeTRoeGKbIFBbsyys2TdKt5HXnxsz7aPucv/gY3b27GJbcrVs3Geb3YbfquD/5+o+zdN3XhF9/anfixjB55FPn8JTCyiJZMop21TCbc4UId3g5EqLytYzZBVUC2XJHM1mQWVF4kKgPdTUj7ehiei9JCtItKeLjh6eFKrYntG9aV+CVEIbU+197YcC9M2A/OwGoeWL3V0NtAnajn2U/L2vmQCh232DVgNyvq6/rFyIwmZzCgOQz1oDmyCMt82ps2UI0sudk8++y3Ad8r/vMb+/8oH6Tks3lyL11OOvrtrcVv3Tj13c+97/477x4ZXraWobE5mOGcVtagouNqkzONbHy8zRpFesBGi80Es1yR3NZACaMKka0MdO5BiuuRxtNQbeHm8YZE1BCeSYK+vtJ6zM3WlPmmW4GJ17rHv21iw/mPVq5IU7UWunf47eKGLQI4AxNqhW63VOssul3deK9Xu264WOtqb8EMztyI5K771mJ1V4enn/OZ4oiT3w/M7jgskLNwsPUBH7Qs5GPNR3zm7vJjb/347vU/P7K9chstFfKGuGIFhGfolaOG0V9nE1bicjjtJhc/kxUgLc9eod4EvhE3tAJTt2CyJdjscaA9VDrUIx/hCZa+1ou3AUlVsCacl4IwpM9OC6306ccSp3r9vGDdDN0bwE44sGsNTrBgKigrdLNS3avobp9oaonVrfrnWBItB90FnXZOvvSk6xqPPvOdwEVsPSCzLPdZ8oOlIwCG+77bfPFr1mU/+vYn2ndf9sTdS5Ws0FhGJRCJG9wKHmlMQ8AaxVSC3aIu93QFMGTrPYMrreqTPtvQvgIZXoTKKc4eFL+AtobZcKXTYRLm50EsIEQKu2mMB4kaDSEfi1K5cEtkNRB2Ib2fOM+XvFa3qcrtWHSjs/eYsh586rW6uHJrldZZzgq2regOyIZWjDcf9YJPZCc9+cO49acOGsnN4UfNdh+my43mkR94UfMH3zivuvCTryt73cwudqSVZp+nlbawLt08eKaiYLYpVgyyDGTEurCNqmeXBITlNqR9MWZoAVaORukRWVB9rI1GBJN6FR7ZcA+ZHutTbyemoZcyqlmRNlJeBr07auaLqVd+bHfcoustuk3RsOZbyEWwOPCVEGqsaccDj1aVnfD4i+SJv/s3wBW2bzz64JDc5gdfp2T8rm1y5ivf2Fy05HJz6ZfP662/9SEsxS0+GGzyTF3RH1uDMRSaMri/ssNiKoElBhaAi7lBzO8PgOytRrILkebLwC5DpU0dSzS45NWQluOZL610T+0n9zsYKUoSh8LH8ERKTHkFdK4hluq1HnxincrdpugmxY4rWMfAtqoxqqG6aeXBuROkyjEnPO2a7MTnfkjy1r/R2z24FSkHLDL5jU/Odh9+pWhn9Jjq2u+/q3vTN8+2eTuXxWDmEIsXZIWE6RxIQ9zcohxMQ5BcMJm4Mn4LDSwWZEgwYQGazNTFzE0Jradj89/E6gj1PJEmMIQyiktMnT4lM0iAYJX8Dd5tjxBqcSsHthHpYewPkc4FUE656HqYOa6VU7Ob1QGwo2hpXRMdX9m0Y92Mwi7olKXaqUg3wyx75G1y8ks+ric+82v4VUIOZpHdN1092334tSLrt2V67x2/Uf70399S3fOjx+lID1kIZgikKXU1jYa4OUYFSC5IIS5hIQPJDcwVZLEgcwTJjctkMcbNvTUlZAXa+i2seSqqBbFhWg6AYYgmzLDD1/uL+VheTYMbYYkxxh5uvayO+4hi7FWYzheg2ga26ZMKPIXvstiNCuPeruupq2ra8XZd14HSTlh0QqFnYO4xa8wxL/yMHv2MzwOzkt38YEQmLv+P2e7DAxZtLB/jqm/9fnnj199Y7b7jaOYoZi6YIanrCDU9Cxbioi9FYEVxFflbgiwUzAKBpndlMg9C6UCxBNs8B+VE53JEEI6gzKVvXvBebcBE3eIrf1MCHYQ2YDB6K6b7KeitAR0iVkYtLexwzMeE93BLBzg66rKapyx2snLAqzJ07Oh1ZsUTv8CyU88HVh/oZzBokamLPj7bfdh32dlcVd156evLdT/8PdvesNTMB5kHNMQBMBQ4yDwLBkAWgviK8jJXkCWCDBuf7GL8cg5tKB6GbfwuVpfgVOsQTg3PAUapE1JTEAZ7cC8A1MCAgmE1WfcT0L0JbKg9Yh3DbbXoNusW9fHMF8E3ZdGJ0q06RQNdcMptLH/iVxg94iscgsALIlP/9dHZ7sODFl2z7YSqvfmP7N3//v/RWT+POcBcwbQc6IxXwTS8Ki6cXRhWSTLD3i6c49lS/JySrIu2noPNz3Sq2K0FizICzEf7WDBJxcJXP03TUKLqFYTNZN1/QLo/AjvkvFasKz602aK71BcPV79YjIWJLkyqWzSmuXjCLn78pbriOV+ToWUXAbM7o2wAIlPXzngCxMClN24fJXde+FrWXPhb2lm/gFGQUZAh45wRD0JTiKs1XjgQinGMKYsE5oknNgOmB/kQOvRKrHmMH3FpoIygLMCvhM2elc7TuF9Y3a+LYBE7QdY7H+n8G1Q+1V8tTFrYrOi4OrLsWuh00anKMaGZa3XkmJ/Z5c/5ro485N/syLLrmIW0qQMlMnHroWMD/jqRrTtP0fVXvoJ7//NMJlcfqVkXGQKGxYGx6dSwyXA1YwocCHOBxQLzwcRlWiehcTy29XtYFvkAZAvVuSiLiPOEkznCQB08jkzY86T675j2/3Up9rbh7L4pD76dFjod6FZoV1Azhg6tXKNjp1xi5z3quzp09I/4f4Dt9iYyddMFs92HgYtsWne4pXOG2Xj5mWy7+nHa29QiV2jhV1YQpMiRpvF5h44JWSow6jMBjYWsQltnYPNnu7ifNIAhrCzCBSVd7mDMGQvZK1q5crx0gRxT/ox86v3Qu8fZfWXl1ovb2IVtFqxg8/mVDh9xpx056XIdOeZiGot/DNw7W/dwpkQ6Nx7cccD9EaurmnR3nKadbS/MNl72HLP79pOYuisna/uV1qmLHmSCGclgmYGWr4olbSRfhQ6/EivLUQyumtYYymJX1AjcUB3UoRSsK7dWWrBdivankIlvuaW3gnk4OQcdn7fdth5ys5336Cu1dcRlmo9dCwxkIehDRaR9+z/Ndh9mRHrNx8433V2Pld3rn2523v6EbPdNJ9HdMteU6xCzETWTkJXIvMqNmqQrc7Wej82f6NcMaaIyjMpcrC7E2XJuCEyq0tXmK3tI1YMqJ+tejel9ArRXabZsizYOv8MWR91Ed961Nn/4DdC5E7es4P9Ikc4dB2alpINZOq3nj5ANHydTk48wU/eearpbTpTurmOkt2WJqdY1JduCNMeh6IKZgnwFWpzsV0xquEQFzVDmopUv2RYWl8GoipnCZFvJs3tM9otfCD+9TRuH/cw2Tvi56Ka1/A8G3HSRzubzZ7sPsy5T9hVNMXY53c7Rpt1ZJWKPlLK3CquLKNsLxO4eRasGRjNfJ7gUIx0yM6GmuYu82EGeb1axa5FsgzZH15Nna6XasRmYmu3rO5jl/wcfhxWz4Weq8wAAAABJRU5ErkJggg=="/>
</defs>
</svg>",
  "name": "Test Metadata 2",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
  ],
  "slug": "test-metadata-2",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > pricing-3-plans 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-pricing-3-plans",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "features": [
        "Unlimited images **with watermark**",
        "No backend generation",
        "No custom templates\`",
      ],
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "slug": "free",
    },
    {
      "features": [
        "Unlimited images **without watermark**",
        "Unlimited backend generation",
        "No custom templates",
      ],
      "interval": "month",
      "lineItems": [
        {
          "amount": 999,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Starter",
      "slug": "starter",
    },
    {
      "features": [
        "Unlimited images **without watermark**",
        "Unlimited backend generation",
        "Unlimited custom templates",
      ],
      "interval": "month",
      "lineItems": [
        {
          "amount": 2999,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Pro",
      "slug": "pro",
    },
  ],
  "slug": "test-pricing-3-plans",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > pricing-custom-0 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-pricing-custom-0",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
    "year",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "slug": "free",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "amount": 500,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "per_unit",
          "slug": "custom-test",
          "unitAmount": 100,
          "usageType": "metered",
        },
      ],
      "name": "Basic Monthly",
      "rateLimit": {
        "enabled": true,
        "interval": 2592000,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "basic-monthly",
    },
    {
      "interval": "year",
      "lineItems": [
        {
          "amount": 4800,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "per_unit",
          "slug": "custom-test",
          "unitAmount": 80,
          "usageType": "metered",
        },
      ],
      "name": "Basic Annual",
      "rateLimit": {
        "enabled": true,
        "interval": 2592000,
        "limit": 1500,
        "mode": "approximate",
      },
      "slug": "basic-annual",
    },
  ],
  "slug": "test-pricing-custom-0",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > pricing-freemium 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-pricing-freemium",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 60,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "free",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "amount": 499,
          "slug": "base",
          "usageType": "licensed",
        },
      ],
      "name": "Basic",
      "slug": "basic",
      "trialPeriodDays": 7,
    },
  ],
  "slug": "test-pricing-freemium",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > pricing-monthly-annual 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-pricing-monthly-annual",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
    "year",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "custom-base",
          "usageType": "licensed",
        },
      ],
      "name": "Free",
      "slug": "free",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "amount": 100,
          "slug": "custom-base",
          "usageType": "licensed",
        },
      ],
      "name": "Basic Monthly",
      "slug": "basic-monthly",
    },
    {
      "interval": "year",
      "lineItems": [
        {
          "amount": 70,
          "slug": "custom-base",
          "usageType": "licensed",
        },
      ],
      "name": "Basic Annual",
      "slug": "basic-annual",
    },
  ],
  "slug": "test-pricing-monthly-annual",
  "toolConfigs": [],
}
`;

exports[`loadAgenticConfig > pricing-pay-as-you-go 1`] = `
{
  "defaultRateLimit": {
    "enabled": true,
    "interval": 60,
    "limit": 1000,
    "mode": "approximate",
  },
  "name": "test-pricing-pay-as-you-go",
  "origin": {
    "location": "external",
    "type": "raw",
    "url": "https://httpbin.org",
  },
  "pricingIntervals": [
    "month",
  ],
  "pricingPlans": [
    {
      "lineItems": [
        {
          "amount": 0,
          "slug": "base",
          "usageType": "licensed",
        },
        {
          "billingScheme": "per_unit",
          "slug": "requests",
          "unitAmount": 0,
          "usageType": "metered",
        },
      ],
      "name": "Free",
      "rateLimit": {
        "enabled": true,
        "interval": 86400,
        "limit": 20,
        "mode": "approximate",
      },
      "slug": "free",
    },
    {
      "interval": "month",
      "lineItems": [
        {
          "billingScheme": "tiered",
          "slug": "requests",
          "tiers": [
            {
              "unitAmount": 0.467,
              "upTo": 999,
            },
            {
              "unitAmount": 0.053,
              "upTo": "inf",
            },
          ],
          "tiersMode": "volume",
          "usageType": "metered",
        },
      ],
      "name": "Pay-As-You-Go",
      "rateLimit": {
        "enabled": true,
        "interval": 86400,
        "limit": 1000,
        "mode": "approximate",
      },
      "slug": "pay-as-you-go",
    },
  ],
  "slug": "test-pricing-pay-as-you-go",
  "toolConfigs": [],
}
`;


================================================
FILE: packages/platform/src/define-config.ts
================================================
import type {
  AgenticProjectConfig,
  AgenticProjectConfigInput
} from '@agentic/platform-types'

import { parseAgenticProjectConfig } from './parse-agentic-project-config'

/**
 * This method allows Agentic projects to define their configs in a type-safe
 * way from `agentic.config.ts` files.
 *
 * It parses the given input config and performs basic validation.
 */
export function defineConfig(
  config: AgenticProjectConfigInput
): AgenticProjectConfig {
  return parseAgenticProjectConfig(config)
}


================================================
FILE: packages/platform/src/index.ts
================================================
export * from './define-config'
export * from './load-agentic-config'
export * from './resolve-agentic-project-config'
export type * from './types'
export * from './validate-agentic-project-config'
export { defaultFreePricingPlan } from '@agentic/platform-types'


================================================
FILE: packages/platform/src/load-agentic-config.test.ts
================================================
import path from 'node:path'
import { fileURLToPath } from 'node:url'

import { describe, expect, test } from 'vitest'

import { loadAgenticConfig } from './load-agentic-config'

const fixtures = [
  'basic-raw-free-ts',
  'basic-raw-free-json',
  'pricing-freemium',
  'pricing-pay-as-you-go',
  'pricing-3-plans',
  'pricing-monthly-annual',
  'pricing-custom-0',
  'basic-openapi',
  'basic-mcp',
  'everything-openapi',
  'metadata-0',
  'metadata-1',
  'metadata-2'
]

const invalidFixtures = [
  'pricing-base-inconsistent',
  'pricing-custom-inconsistent',
  'pricing-empty-0',
  'pricing-empty-1',
  'pricing-empty-2',
  'pricing-duplicate-0',
  'pricing-duplicate-1',
  'invalid-origin-url-0',
  'invalid-origin-url-1',
  'invalid-origin-url-2',
  'invalid-origin-url-3',
  'invalid-name-0',
  'invalid-name-1',
  'invalid-name-2',
  'invalid-slug-0',
  'invalid-slug-1',
  'invalid-slug-2',
  'invalid-slug-3',
  'invalid-slug-4',
  'invalid-metadata-0',
  'invalid-metadata-1'
]

const fixturesDir = path.join(
  fileURLToPath(import.meta.url),
  '..',
  '..',
  '..',
  '..',
  'fixtures'
)

const validFixturesDir = path.join(fixturesDir, 'valid')
const invalidFixturesDir = path.join(fixturesDir, 'invalid')

describe('loadAgenticConfig', () => {
  for (const fixture of fixtures) {
    test(
      `${fixture}`,
      {
        timeout: 60_000
      },
      async () => {
        const fixtureDir = path.join(validFixturesDir, fixture)

        const config = await loadAgenticConfig({ cwd: fixtureDir })
        expect(config).toMatchSnapshot()
      }
    )
  }

  for (const fixture of invalidFixtures) {
    test(
      `invalid: ${fixture}`,
      {
        timeout: 60_000
      },
      async () => {
        const fixtureDir = path.join(invalidFixturesDir, fixture)

        await expect(
          loadAgenticConfig({ cwd: fixtureDir })
        ).rejects.toThrowErrorMatchingSnapshot()
      }
    )
  }
})


================================================
FILE: packages/platform/src/load-agentic-config.ts
================================================
import type { AgenticProjectConfig } from '@agentic/platform-types'
import { loadConfig } from 'unconfig'

import { validateAgenticProjectConfig } from './validate-agentic-project-config'

export async function loadAgenticConfig({
  cwd
}: {
  cwd?: string
} = {}): Promise<AgenticProjectConfig> {
  const { config } = await loadConfig({
    cwd,
    sources: [
      {
        files: 'agentic.config',
        extensions: ['ts', 'mts', 'cts', 'js', 'mjs', 'cjs', 'json']
      }
    ]
  })

  return validateAgenticProjectConfig(config, { cwd })
}


================================================
FILE: packages/platform/src/origin-adapters/mcp.ts
================================================
import type {
  MCPOriginAdapter,
  MCPOriginAdapterConfig,
  Tool
} from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'
import { Client as McpClient } from '@modelcontextprotocol/sdk/client/index.js'
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js'

export async function resolveMCPOriginAdapter({
  name,
  version,
  origin,
  label
}: {
  name: string
  origin: MCPOriginAdapterConfig
  label: string
  version: string
}): Promise<{
  origin: MCPOriginAdapter
  tools?: Tool[]
}> {
  assert(
    origin.type === 'mcp',
    400,
    `Invalid origin adapter type "${origin.type}" for ${label}`
  )
  const transport = new StreamableHTTPClientTransport(new URL(origin.url), {
    requestInit: {
      headers: origin.headers
    }
  })
  const client = new McpClient({ name, version })

  try {
    await client.connect(transport)
  } catch (err: any) {
    throw new Error(
      `Failed to connect to MCP server at ${origin.url} using the Streamable HTTP transport.Make sure your MCP server is running and accessible, and that your URL is using the correct path (/, /mcp, etc): ${err.message}`,
      { cause: err }
    )
  }

  const serverInfo = {
    name,
    version,
    ...client.getServerVersion(),
    capabilities: client.getServerCapabilities(),
    instructions: client.getInstructions()
  }

  const listToolsResponse = await client.listTools()

  // TODO: Validate MCP tools
  const tools = listToolsResponse.tools

  return {
    tools,
    origin: {
      ...origin,
      serverInfo
    }
  }
}


================================================
FILE: packages/platform/src/origin-adapters/openapi.ts
================================================
import type {
  OpenAPIOriginAdapter,
  OpenAPIOriginAdapterConfig,
  Tool
} from '@agentic/platform-types'
import { assert, type Logger } from '@agentic/platform-core'
import {
  getToolsFromOpenAPISpec,
  validateOpenAPISpec
} from '@agentic/platform-openapi-utils'

export async function resolveOpenAPIOriginAdapter({
  origin,
  label,
  cwd,
  logger
}: {
  origin: OpenAPIOriginAdapterConfig
  label: string
  cwd?: string
  logger?: Logger
}): Promise<{
  origin: OpenAPIOriginAdapter
  tools?: Tool[]
}> {
  assert(
    origin.type === 'openapi',
    400,
    `Invalid origin adapter type "${origin.type}" for ${label}`
  )
  assert(
    origin.spec,
    400,
    `OpenAPI spec is required for ${label} with origin adapter type set to "openapi"`
  )

  // Validate and normalize the OpenAPI spec
  const openapiSpec = await validateOpenAPISpec(origin.spec, {
    cwd,
    logger
  })

  // Remove origin servers from the OpenAPI spec.
  // TODO: Ensure that `origin.url` matches any origin servers in the openapi spec?
  delete openapiSpec.servers

  // TODO: Additional, agentic-specific validation of the OpenAPI spec's
  // operations to ensure they are valid tools.

  // TODO: Simplify OpenAPI spec by removing any query params and headers
  // specific to the Agentic API gateway.

  // TODO: Extract tool definitions from OpenAPI operationIds

  const dereferencedOpenAPISpec = await validateOpenAPISpec(origin.spec, {
    cwd,
    dereference: true
  })

  const { tools, toolToOperationMap } = await getToolsFromOpenAPISpec(
    dereferencedOpenAPISpec
  )

  return {
    tools,
    origin: {
      ...origin,
      // Update the openapi spec with the normalized version
      spec: JSON.stringify(openapiSpec),
      toolToOperationMap
    }
  }
}


================================================
FILE: packages/platform/src/parse-agentic-project-config.ts
================================================
import { parseZodSchema, pruneUndefined } from '@agentic/platform-core'
import {
  type AgenticProjectConfig,
  agenticProjectConfigSchema,
  type ResolvedAgenticProjectConfig,
  resolvedAgenticProjectConfigSchema
} from '@agentic/platform-types'

// NOTE: The extra typing and casts here are necessary because we're overriding
// the default zod types for some fields (e.g. `pricingPlans`) in order to get
// stricter TypeScript types than what zod v3 allows (nested discrimianted
// unions). We should consider removing these once we upgrade to zod v4.

/**
 * @internal
 */
export function parseAgenticProjectConfig(
  inputConfig: unknown,
  { strip = false, strict = false }: { strip?: boolean; strict?: boolean } = {}
): AgenticProjectConfig {
  return pruneUndefined(
    parseZodSchema(
      strip
        ? agenticProjectConfigSchema.strip()
        : strict
          ? agenticProjectConfigSchema.strict()
          : agenticProjectConfigSchema,
      inputConfig,
      {
        statusCode: 400
      }
    )
  ) as AgenticProjectConfig
}

/**
 * @internal
 */
export function parseResolvedAgenticProjectConfig(
  inputConfig: unknown,
  { strip = false, strict = false }: { strip?: boolean; strict?: boolean } = {}
): ResolvedAgenticProjectConfig {
  return pruneUndefined(
    parseZodSchema(
      strip
        ? resolvedAgenticProjectConfigSchema.strip()
        : strict
          ? resolvedAgenticProjectConfigSchema.strict()
          : resolvedAgenticProjectConfigSchema,
      inputConfig,
      {
        statusCode: 400
      }
    )
  ) as ResolvedAgenticProjectConfig
}


================================================
FILE: packages/platform/src/resolve-agentic-project-config.ts
================================================
import type { Logger } from '@agentic/platform-core'
import type {
  AgenticProjectConfig,
  AgenticProjectConfigRaw,
  ResolvedAgenticProjectConfig
} from '@agentic/platform-types'

import type { UploadFileUrlToStorageFn } from './types'
import {
  parseAgenticProjectConfig,
  parseResolvedAgenticProjectConfig
} from './parse-agentic-project-config'
import { resolveMetadata } from './resolve-metadata'
import { resolveMetadataFiles } from './resolve-metadata-files'
import { resolveOriginAdapter } from './resolve-origin-adapter'
import { validatePricing } from './validate-pricing'
import { validateTools } from './validate-tools'

export async function resolveAgenticProjectConfig(
  inputConfig: AgenticProjectConfig | AgenticProjectConfigRaw,
  opts: {
    logger?: Logger
    cwd?: string
    label?: string
    uploadFileUrlToStorage: UploadFileUrlToStorageFn
  }
): Promise<ResolvedAgenticProjectConfig> {
  const config = parseAgenticProjectConfig(inputConfig)

  const { slug, version } = await resolveMetadata(config)
  validatePricing(config)

  const { readme, iconUrl } = await resolveMetadataFiles(config, opts)
  const { origin, tools } = await resolveOriginAdapter({
    slug,
    version,
    label: `project "${slug}"`,
    ...opts,
    origin: config.origin
  })

  const resolvedConfig = parseResolvedAgenticProjectConfig({
    ...config,
    slug,
    version,
    readme,
    iconUrl,
    origin,
    tools
  })

  validateTools({
    label: `project "${slug}"`,
    ...opts,
    origin: resolvedConfig.origin,
    tools: resolvedConfig.tools,
    toolConfigs: resolvedConfig.toolConfigs
  })

  return resolvedConfig
}


================================================
FILE: packages/platform/src/resolve-metadata-file.ts
================================================
import type { UploadFileUrlToStorageFn } from './types'

export async function resolveMetadataFile(
  input: string | undefined,
  {
    label,
    uploadFileUrlToStorage
  }: {
    label: string
    uploadFileUrlToStorage: UploadFileUrlToStorageFn
  }
): Promise<string | undefined> {
  if (!input) return

  try {
    const source = new URL(input)

    return uploadFileUrlToStorage(source.toString())
  } catch {
    throw new Error(`Invalid "${label}" must be a public URL: "${input}"`)
  }
}


================================================
FILE: packages/platform/src/resolve-metadata-files.ts
================================================
import type {
  AgenticProjectConfig,
  ResolvedAgenticProjectConfig
} from '@agentic/platform-types'

import type { UploadFileUrlToStorageFn } from './types'
import { resolveMetadataFile } from './resolve-metadata-file'

export async function resolveMetadataFiles(
  { readme, icon }: Pick<AgenticProjectConfig, 'readme' | 'icon'>,
  {
    uploadFileUrlToStorage
  }: {
    uploadFileUrlToStorage: UploadFileUrlToStorageFn
  }
): Promise<Pick<ResolvedAgenticProjectConfig, 'readme' | 'iconUrl'>> {
  if (readme) {
    readme = await resolveMetadataFile(readme, {
      label: 'readme',
      uploadFileUrlToStorage
    })
  }

  if (icon) {
    icon = await resolveMetadataFile(icon, {
      label: 'icon',
      uploadFileUrlToStorage
    })
  }

  return {
    readme,
    iconUrl: icon
  }
}


================================================
FILE: packages/platform/src/resolve-metadata.ts
================================================
import type {
  AgenticProjectConfig,
  ResolvedAgenticProjectConfig
} from '@agentic/platform-types'
import { assert, slugify } from '@agentic/platform-core'
import { isValidProjectSlug } from '@agentic/platform-validators'
import { clean as cleanSemver, valid as isValidSemver } from 'semver'

export async function resolveMetadata({
  name,
  slug,
  version
}: Pick<AgenticProjectConfig, 'name' | 'slug' | 'version'>): Promise<
  Pick<ResolvedAgenticProjectConfig, 'slug' | 'version'>
> {
  slug ??= slugify(name)

  assert(
    isValidProjectSlug(slug),
    `Invalid project slug "${slug}" for project name "${name}". Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. For example: "my-project" or "linkedin-resolver-23"`
  )

  if (version) {
    const normalizedVersion = cleanSemver(version)!
    assert(version, `Invalid semver version "${version}" for project "${slug}"`)

    assert(
      isValidSemver(version),
      `Invalid semver version "${version}" for project "${slug}"`
    )

    // Update the config with the normalized semver version
    version = normalizedVersion
  }

  return {
    slug,
    version
  }
}


================================================
FILE: packages/platform/src/resolve-origin-adapter.ts
================================================
import type {
  OriginAdapter,
  OriginAdapterConfig,
  Tool
} from '@agentic/platform-types'
import { assert, type Logger } from '@agentic/platform-core'

import { resolveMCPOriginAdapter } from './origin-adapters/mcp'
import { resolveOpenAPIOriginAdapter } from './origin-adapters/openapi'
import { validateOriginUrl } from './validate-origin-url'

/**
 * Validates, normalizes, and resolves the origin adapter config for a project.
 */
export async function resolveOriginAdapter({
  slug,
  version = '0.0.0',
  origin,
  label,
  cwd,
  logger
}: {
  slug: string
  origin: OriginAdapterConfig
  label: string
  version?: string
  cwd?: string
  logger?: Logger
}): Promise<{
  origin: OriginAdapter
  tools?: Tool[]
}> {
  validateOriginUrl({ originUrl: origin.url, label })

  if (origin.type === 'openapi') {
    return resolveOpenAPIOriginAdapter({
      origin,
      label,
      cwd,
      logger
    })
  } else if (origin.type === 'mcp') {
    return resolveMCPOriginAdapter({
      name: slug,
      version,
      origin,
      label
    })
  } else {
    assert(
      origin.type === 'raw',
      400,
      `Invalid origin adapter type "${origin.type}" for ${label}`
    )

    return {
      origin
    }
  }
}


================================================
FILE: packages/platform/src/types.ts
================================================
export type UploadFileUrlToStorageFn = (source: string) => Promise<string>


================================================
FILE: packages/platform/src/validate-agentic-project-config.ts
================================================
import type { AgenticProjectConfig } from '@agentic/platform-types'
import { type Logger } from '@agentic/platform-core'

import { parseAgenticProjectConfig } from './parse-agentic-project-config'
import { resolveMetadata } from './resolve-metadata'
import { validateMetadataFiles } from './validate-metadata-files'
import { validateOriginAdapter } from './validate-origin-adapter'
import { validatePricing } from './validate-pricing'

export async function validateAgenticProjectConfig(
  inputConfig: unknown,
  {
    strip = false,
    ...opts
  }: {
    logger?: Logger
    cwd?: string
    strip?: boolean
    label?: string
  } = {}
): Promise<AgenticProjectConfig> {
  const config = parseAgenticProjectConfig(inputConfig, {
    strip,
    strict: !strip
  })

  const { slug, version } = await resolveMetadata(config)
  validatePricing(config)

  const { readme, icon } = await validateMetadataFiles(config, opts)
  const origin = await validateOriginAdapter({
    slug,
    version,
    label: `project "${slug}"`,
    ...opts,
    origin: config.origin
  })

  return parseAgenticProjectConfig(
    {
      ...config,
      slug,
      version,
      readme,
      icon,
      origin
    },
    { strip, strict: !strip }
  )
}


================================================
FILE: packages/platform/src/validate-metadata-file.ts
================================================
import { readFile } from 'node:fs/promises'
import path from 'node:path'

import { lookup as lookupMimeType } from 'mrmime'

export async function validateMetadataFile(
  input: string | undefined,
  {
    label,
    cwd
  }: {
    label: string
    cwd: string
  }
): Promise<string | undefined> {
  if (!input) return

  let source: string | ArrayBuffer | URL

  try {
    // Check if it's a URL.
    source = new URL(input)

    return source.toString()
  } catch {
    try {
      // Not a URL; check if it's a local file path.
      const buffer = await readFile(path.resolve(cwd, input))

      const mime =
        lookupMimeType(path.extname(input)) ?? 'application/octet-stream'

      return `data:${mime};base64,${buffer.toString('base64')}`
    } catch {
      throw new Error(
        `Invalid "${label}" (must be a URL or a path to a local file): "${input}"`
      )
    }
  }
}


================================================
FILE: packages/platform/src/validate-metadata-files.ts
================================================
import type { AgenticProjectConfig } from '@agentic/platform-types'

import { validateMetadataFile } from './validate-metadata-file'

export async function validateMetadataFiles(
  { readme, icon }: Pick<AgenticProjectConfig, 'readme' | 'icon'>,
  {
    cwd = process.cwd()
  }: {
    cwd?: string
  }
): Promise<Pick<AgenticProjectConfig, 'readme' | 'icon'>> {
  if (readme) {
    readme = await validateMetadataFile(readme, { label: 'readme', cwd })
  }

  if (icon) {
    icon = await validateMetadataFile(icon, { label: 'icon', cwd })
  }

  return {
    readme,
    icon
  }
}


================================================
FILE: packages/platform/src/validate-origin-adapter.ts
================================================
import type { OriginAdapterConfig } from '@agentic/platform-types'
import { assert, type Logger } from '@agentic/platform-core'

import { resolveMCPOriginAdapter } from './origin-adapters/mcp'
import { resolveOpenAPIOriginAdapter } from './origin-adapters/openapi'
import { validateOriginUrl } from './validate-origin-url'

/**
 * Validates and normalizes the origin adapter for a project.
 */
export async function validateOriginAdapter({
  slug,
  version = '0.0.0',
  origin,
  label,
  cwd,
  logger
}: {
  slug: string
  origin: Readonly<OriginAdapterConfig>
  label: string
  version?: string
  cwd?: string
  logger?: Logger
}): Promise<OriginAdapterConfig> {
  validateOriginUrl({ originUrl: origin.url, label })

  if (origin.type === 'openapi') {
    // We intentionally ignore the resolved tools here because the server will
    // need to re-validate the OpenAPI spec and tools anyway. We do, however,
    // override the `spec` field with the parsed, normalized version because
    // that may have been pointing to a local file or remote URL.
    const { origin: resolvedOriginAdapter } = await resolveOpenAPIOriginAdapter(
      {
        origin,
        label,
        cwd,
        logger
      }
    )

    return {
      ...origin,
      spec: resolvedOriginAdapter.spec
    }
  } else if (origin.type === 'mcp') {
    // We intentionally ignore the resolved version and tools here because the
    // server will need to re-validate the MCP server info and tools anyway.
    await resolveMCPOriginAdapter({
      name: slug,
      version,
      origin,
      label
    })

    return origin
  } else {
    assert(
      origin.type === 'raw',
      400,
      `Invalid origin adapter type "${origin.type}" for ${label}`
    )

    return origin
  }
}


================================================
FILE: packages/platform/src/validate-origin-url.ts
================================================
import { assert } from '@agentic/platform-core'

export function validateOriginUrl({
  originUrl,
  label
}: {
  originUrl: string
  label: string
}) {
  assert(originUrl, 400, `Origin URL is required for ${label}`)

  try {
    const parsedOriginUrl = new URL(originUrl)
    assert(
      parsedOriginUrl.protocol === 'https:',
      'Invalid originUrl: must be a valid https URL'
    )

    assert(parsedOriginUrl.hostname, 'Invalid originUrl: must be a valid URL')
  } catch (err) {
    throw new Error('Invalid originUrl: must be a valid https URL', {
      cause: err
    })
  }
}


================================================
FILE: packages/platform/src/validate-pricing.ts
================================================
import { assert } from '@agentic/platform-core'
import {
  type AgenticProjectConfig,
  getPricingPlansByInterval,
  type PricingPlanLineItem
} from '@agentic/platform-types'

export function validatePricing({
  pricingIntervals,
  pricingPlans
}: Pick<AgenticProjectConfig, 'pricingIntervals' | 'pricingPlans'>) {
  assert(
    pricingPlans?.length,
    'Invalid pricingPlans: must be a non-empty array'
  )
  assert(
    pricingIntervals?.length,
    'Invalid pricingIntervals: must be a non-empty array'
  )

  {
    // Validate pricing interval
    const pricingIntervalsSet = new Set(pricingIntervals)
    assert(
      pricingIntervalsSet.size === pricingIntervals.length,
      'Invalid pricingIntervals: duplicate pricing intervals'
    )
    assert(
      pricingIntervals.length >= 1,
      'Invalid pricingIntervals: must contain at least one pricing interval'
    )

    if (pricingIntervals.length > 1) {
      for (const pricingPlan of pricingPlans) {
        if (pricingPlan.interval) {
          assert(
            pricingIntervalsSet.has(pricingPlan.interval),
            `Invalid pricingPlan "${pricingPlan.slug}": PricingPlan "${pricingPlan.slug}" has invalid interval "${pricingPlan.interval}" which is not included in the "pricingIntervals" array.`
          )
        }

        if (pricingPlan.slug === 'free') continue

        assert(
          pricingPlan.interval !== undefined,
          `Invalid pricingPlan "${pricingPlan.slug}": non-free PricingPlan "${pricingPlan.slug}" must specify an "interval" because the project supports multiple pricing intervals.`
        )
      }
    } else {
      // Only a single pricing interval is supported, so default all pricing
      // plans to use the default pricing interval.
      const defaultPricingInterval = pricingIntervals[0]!
      assert(
        defaultPricingInterval,
        'Invalid pricingIntervals: must contain at least one valid pricing interval'
      )

      for (const pricingPlan of pricingPlans) {
        if (pricingPlan.interval) {
          assert(
            pricingIntervalsSet.has(pricingPlan.interval),
            `Invalid pricingPlan "${pricingPlan.slug}": PricingPlan "${pricingPlan.slug}" has invalid interval "${pricingPlan.interval}" which is not included in the "pricingIntervals" array.`
          )
        }

        if (pricingPlan.slug === 'free') continue

        pricingPlan.interval ??= defaultPricingInterval
      }
    }
  }

  {
    // Validate pricingPlans
    const pricingPlanSlugsSet = new Set(pricingPlans.map((p) => p.slug))
    assert(
      pricingPlanSlugsSet.size === pricingPlans.length,
      'Invalid pricingPlans: duplicate PricingPlan slugs. All PricingPlan slugs must be unique (e.g. "free", "starter-monthly", "pro-annual", etc).'
    )

    const pricingPlanLineItemSlugMap: Record<string, PricingPlanLineItem[]> = {}

    for (const pricingPlan of pricingPlans) {
      const lineItemSlugsSet = new Set(
        pricingPlan.lineItems.map((lineItem) => lineItem.slug)
      )

      assert(
        lineItemSlugsSet.size === pricingPlan.lineItems.length,
        `Invalid pricingPlan "${pricingPlan.slug}": duplicate line-item slugs`
      )

      for (const lineItem of pricingPlan.lineItems) {
        if (!pricingPlanLineItemSlugMap[lineItem.slug]) {
          pricingPlanLineItemSlugMap[lineItem.slug] = []
        }

        pricingPlanLineItemSlugMap[lineItem.slug]!.push(lineItem)
      }
    }

    for (const lineItems of Object.values(pricingPlanLineItemSlugMap)) {
      if (lineItems.length <= 1) continue

      const lineItem0 = lineItems[0]!

      for (let i = 1; i < lineItems.length; ++i) {
        const lineItem = lineItems[i]!

        assert(
          lineItem.usageType === lineItem0.usageType,
          `Invalid pricingPlans: all PricingPlans which contain the same LineItems (by slug "${lineItem.slug}") must have the same usage type ("licensed" or "metered").`
        )
      }
    }
  }

  // Validate PricingPlanLineItems
  for (const pricingPlan of pricingPlans) {
    for (const lineItem of pricingPlan.lineItems) {
      if (lineItem.slug === 'base') {
        assert(
          lineItem.usageType === 'licensed',
          `Invalid PricingPlan "${pricingPlan.slug}": reserved LineItem "base" must have "licensed" usage type.`
        )
      } else if (lineItem.slug === 'requests') {
        assert(
          lineItem.usageType === 'metered',
          `Invalid PricingPlan "${pricingPlan.slug}": reserved "requests" LineItem "${lineItem.slug}" must have "metered" usage type.`
        )
      } else {
        assert(
          lineItem.slug.startsWith('custom-'),
          `Invalid PricingPlan "${pricingPlan.slug}": custom LineItem "${lineItem.slug}" must have a slug that starts with "custom-". This is required so that TypeScript can discriminate between custom and reserved line-items.`
        )
      }

      if (lineItem.usageType === 'metered') {
        switch (lineItem.billingScheme) {
          case 'per_unit':
            assert(
              (lineItem as any).unitAmount !== undefined,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must specify a non-negative "unitAmount" when using "per_unit" billing scheme.`
            )

            assert(
              (lineItem as any).tiersMode === undefined,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must not specify "tiersMode" when using "per_unit" billing scheme.`
            )

            assert(
              (lineItem as any).tiers === undefined,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must not specify "tiers" when using "per_unit" billing scheme.`
            )
            break

          case 'tiered':
            assert(
              (lineItem as any).unitAmount === undefined,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must not specify "unitAmount" when using "tiered" billing scheme.`
            )

            assert(
              (lineItem as any).tiers?.length,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must specify a non-empty "tiers" array when using "tiered" billing scheme.`
            )

            assert(
              (lineItem as any).tiersMode !== undefined,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must specify a valid "tiersMode" when using "tiered" billing scheme.`
            )

            // TODO: Not sure if this is a valid requirement or not.
            assert(
              (lineItem as any).transformQuantity === undefined,
              `Invalid pricingPlan "${pricingPlan.slug}": metered LineItem "${lineItem.slug}" must not specify "transformQuantity" when using "tiered" billing scheme.`
            )
            break

          default:
            assert(
              false,
              `Invalid PricingPlan "${pricingPlan.slug}": metered LineItem "${(lineItem as any).slug}" must specify a valid "billingScheme".`
            )
        }
      }
    }
  }

  // Validate deployment pricing plans to ensure they contain at least one valid
  // plan per pricing interval configured on the project.
  for (const pricingInterval of pricingIntervals) {
    const pricingPlansForInterval = getPricingPlansByInterval({
      pricingInterval,
      pricingPlans
    })

    assert(
      pricingPlansForInterval.length > 0,
      400,
      `Invalid pricing config: no pricing plans for pricing interval "${pricingInterval}"`
    )
  }
}


================================================
FILE: packages/platform/src/validate-tools.ts
================================================
import type { OriginAdapter, Tool, ToolConfig } from '@agentic/platform-types'
import { assert } from '@agentic/platform-core'

/**
 * Validates the origin server's tools for a project.
 */
export function validateTools({
  origin,
  tools,
  toolConfigs,
  label
}: {
  origin: OriginAdapter
  tools: Tool[]
  toolConfigs: ToolConfig[]
  label: string
}) {
  if (!tools.length) {
    assert(
      origin.type === 'raw',
      `No tools defined for ${label} with origin adapter type "${origin.type}"`
    )
  }

  const toolsMap: Record<string, Tool> = {}
  for (const tool of tools) {
    assert(
      !toolsMap[tool.name],
      400,
      `Duplicate tool name "${tool.name}" found in ${label}`
    )
    toolsMap[tool.name] = tool
  }

  for (const toolConfig of toolConfigs) {
    const tool = toolsMap[toolConfig.name]
    assert(
      tool,
      400,
      `Tool "${toolConfig.name}" from \`toolConfigs\` not found in \`tools\` for ${label}`
    )
  }
}


================================================
FILE: packages/platform/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "bin/*"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/platform-core/package.json
================================================
{
  "name": "@agentic/platform-core",
  "version": "8.4.4",
  "description": "Core utilities shared across the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/core"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@sindresorhus/slugify": "catalog:",
    "decircular": "catalog:",
    "is-obj": "catalog:",
    "ohash": "^2.0.11",
    "parse-json": "catalog:",
    "sort-keys": "catalog:",
    "type-fest": "catalog:",
    "zod": "catalog:",
    "zod-validation-error": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/platform-core/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-core"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-core.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-core <!-- omit from toc -->

> Core utilities shared across the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this package directly. See [@agentic/cli](https://github.com/transitive-bullshit/agentic/tree/main/packages/cli), [@agentic/platform](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform), and [@agentic/platform-tool-client](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform-tool-client) for more public-facing packages.

## Install

```bash
npm i @agentic/platform-core
```

## Usage

```ts
import {
  assert,
  omit,
  pick,
  parseJson,
  parseZodSchema,
  sha256,
  getEnv,
  sanitizeSearchParams,
  pruneUndefined,
  slugify
  // etc...
} from '@agentic/platform-core'
```

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/platform-core/src/__snapshots__/utils.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`sha256 1`] = `"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"`;


================================================
FILE: packages/platform-core/src/errors.ts
================================================
import { fromError } from 'zod-validation-error'

import type { RateLimitResult } from './types'
import { getRateLimitHeaders } from './rate-limit-headers'

export class BaseError extends Error {
  constructor({ message, cause }: { message: string; cause?: unknown }) {
    super(message, { cause })

    // Ensure the name of this error is the same as the class name
    this.name = this.constructor.name

    // Disabling due to https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-useless-error-capture-stack-trace.md
    // Set stack trace to caller
    // if (Error.captureStackTrace) {
    //   Error.captureStackTrace(this, this.constructor)
    // }
  }
}

export class HttpError extends BaseError {
  readonly statusCode: number
  readonly headers?: Record<string, string>

  constructor({
    message,
    statusCode = 500,
    headers,
    cause
  }: {
    message: string
    statusCode?: number
    headers?: Record<string, string>
    cause?: unknown
  }) {
    super({ message, cause })

    this.statusCode = statusCode
    this.headers = headers
  }
}

export class RateLimitError extends HttpError {
  readonly rateLimitResult: RateLimitResult

  constructor({
    rateLimitResult,
    message = 'Rate limit exceeded; please try again later.',
    headers,
    cause
  }: {
    rateLimitResult: RateLimitResult
    message?: string
    headers?: Record<string, string>
    cause?: unknown
  }) {
    super({
      message,
      cause,
      statusCode: 429,
      headers: {
        ...getRateLimitHeaders(rateLimitResult),
        ...headers
      }
    })

    this.rateLimitResult = rateLimitResult
  }
}

export class JsonRpcError extends HttpError {
  readonly jsonRpcErrorCode: number
  readonly jsonRpcId: string | number | null

  constructor({
    message,
    jsonRpcErrorCode,
    jsonRpcId = null,
    statusCode,
    cause
  }: {
    message: string
    jsonRpcErrorCode: number
    jsonRpcId?: string | number | null
    statusCode?: number
    cause?: unknown
  }) {
    super({ message, cause, statusCode })

    this.jsonRpcErrorCode = jsonRpcErrorCode
    this.jsonRpcId = jsonRpcId
  }
}

export class ZodValidationError extends HttpError {
  constructor({
    statusCode,
    prefix,
    cause
  }: {
    statusCode?: number
    prefix?: string
    cause: unknown
  }) {
    const error = fromError(cause, { prefix })
    super({ message: error.message, cause, statusCode })
  }
}


================================================
FILE: packages/platform-core/src/hash-object.test.ts
================================================
import { describe, expect, test } from 'vitest'

import { hashObject } from './hash-object'

describe('hashObject', () => {
  test('basic', async () => {
    await expect(hashObject({ unicorn: 'rainbow' })).resolves.toBe(
      '0bdeed89f3fbb21d7c4fa488992470030e98387c4ad3f4e18cebb70d7dac59dd'
    )

    await expect(hashObject({ a: 0, b: { a: 0, b: 0 } })).resolves.toBe(
      await hashObject({ b: { b: 0, a: 0 }, a: 0 })
    )

    await expect(hashObject({ a: 'b' })).resolves.not.toBe(
      await hashObject({ a: 'c' })
    )
  })

  test('handles circular references', async () => {
    const object = {
      a: {
        b: {}
      }
    }

    object.a.b = object // Create a circular reference.

    await expect(hashObject(object)).resolves.toBe(
      'fe15b32f1f303e18ac292a995c18e0560c1031d0a7a5999a1c5cacea06cead87'
    )
  })
})


================================================
FILE: packages/platform-core/src/hash-object.ts
================================================
import type { LiteralUnion } from 'type-fest'
import decircular from 'decircular'
import isObject from 'is-obj'
import sortKeys from 'sort-keys'

import { sha256 } from './utils'

export type Algorithm = LiteralUnion<
  'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512',
  string
>

export type HashObjectOptions = {
  /** @default 'SHA-256' */
  readonly algorithm?: Algorithm
}

function normalizeObject(object: any): any {
  if (typeof object === 'string') {
    return object.normalize('NFD')
  }

  if (Array.isArray(object)) {
    return object.map((element) => normalizeObject(element))
  }

  if (isObject(object)) {
    return Object.fromEntries(
      Object.entries(object).map(([key, value]) => [
        key.normalize('NFD'),
        normalizeObject(value)
      ])
    )
  }

  return object
}

/**
 * Returns a stable, deterministic hash of the given object, defaulting to
 * using `sha256` as the hashing algorithm and `hex` as the encoding.
 */
export async function hashObject(object: Record<string, any>): Promise<string> {
  if (!isObject(object)) {
    throw new TypeError('Expected an object')
  }

  const normalizedObject = normalizeObject(decircular(object))
  const input = JSON.stringify(sortKeys(normalizedObject, { deep: true }))

  return sha256(input)
}


================================================
FILE: packages/platform-core/src/index.ts
================================================
export * from './errors'
export * from './hash-object'
export * from './rate-limit-headers'
export type * from './types'
export * from './utils'


================================================
FILE: packages/platform-core/src/rate-limit-headers.ts
================================================
import type { RateLimitResult } from './types'

/**
 * @see https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers-06
 */
export function getRateLimitHeaders(
  rateLimitResult?: RateLimitResult
): Record<string, string> | undefined {
  const headers: Record<string, string> = {}
  if (!rateLimitResult) {
    return undefined
  }

  const { id, limit, remaining, resetTimeMs, intervalMs } = rateLimitResult
  const intervalSeconds = Math.ceil(intervalMs / 1000)
  const resetTimeSeconds = Math.ceil(resetTimeMs / 1000)

  const rateLimitPolicy = `${limit};w=${intervalSeconds}`
  const limitString = limit.toString()
  const remainingString = remaining.toString()
  const resetTimeString = resetTimeSeconds.toString()

  // NOTE: Cloudflare and/or origin servers may set the x- headers, which can
  // be pretty confusing since the end user gets both ratelimit headers.
  // I'm hesitant to remove any extra origin headers, since they're a nice
  // escape hatch for sending extra metadata, and the origin may in fact have
  // its own separate rate-limiting policy, which we don't necessarily want to
  // hide. So for now, we'll just set the standard rate-limit headers and make
  // sure this distinction is documented.
  headers['ratelimit-policy'] = rateLimitPolicy
  headers['ratelimit-limit'] = limitString
  headers['ratelimit-remaining'] = remainingString
  headers['ratelimit-reset'] = resetTimeString
  headers['x-ratelimit-id'] = id

  if (!rateLimitResult.passed) {
    const retryAfterSeconds = Math.max(
      0,
      Math.ceil((resetTimeMs - Date.now()) / 1000)
    )
    const retryAfterString = retryAfterSeconds.toString()

    headers['retry-after'] = retryAfterString
  }

  return headers
}


================================================
FILE: packages/platform-core/src/types.test.ts
================================================
import { expectTypeOf, test } from 'vitest'

import type { Logger } from './types'

test('Logger type is compatible with Console', () => {
  expectTypeOf<Console>().toExtend<Logger>()
})


================================================
FILE: packages/platform-core/src/types.ts
================================================
export interface Logger {
  trace(message?: any, ...detail: any[]): void
  debug(message?: any, ...detail: any[]): void
  info(message?: any, ...detail: any[]): void
  warn(message?: any, ...detail: any[]): void
  error(message?: any, ...detail: any[]): void
}

export type RateLimitResult = {
  /**
   * The identifier used to uniquely track this rate limit.
   *
   * This will typically be the customer's ID or IP address.
   */
  id: string

  /**
   * Whether or not the request passed the rate limit.
   */
  passed: boolean

  /**
   * The interval in milliseconds over which the rate limit is enforced.
   */
  intervalMs: number

  /**
   * The maximum number of requests that can be made per interval.
   */
  limit: number

  /**
   * The current number of requests that have been made against the rate limit.
   */
  current: number

  /**
   * The number of requests that can be made before the rate limit resets.
   *
   * Will be `0` if the rate limit has been exceeded.
   */
  remaining: number

  /**
   * The time in milliseconds since the Unix epoch UTC at which the rate limit
   * will reset.
   */
  resetTimeMs: number
}


================================================
FILE: packages/platform-core/src/utils.test.ts
================================================
import { expect, test } from 'vitest'

import {
  omit,
  pick,
  pruneEmpty,
  pruneEmptyDeep,
  sha256,
  slugify
} from './utils'

test('pick', () => {
  expect(pick({ a: 1, b: 2, c: 3 }, 'a', 'c')).toEqual({ a: 1, c: 3 })
  expect(
    pick({ a: { b: 'foo' }, d: -1, foo: null } as any, 'b', 'foo')
  ).toEqual({ foo: null })
})

test('omit', () => {
  expect(omit({ a: 1, b: 2, c: 3 }, 'a', 'c')).toEqual({ b: 2 })
  expect(omit({ a: { b: 'foo' }, d: -1, foo: null }, 'b', 'foo')).toEqual({
    a: { b: 'foo' },
    d: -1
  })
  expect(omit({ a: 1, b: 2, c: 3 }, 'foo', 'bar', 'c')).toEqual({ a: 1, b: 2 })
})

test('sha256', async () => {
  // Test default behavior (random UUID)
  const hash1 = await sha256()
  const hash2 = await sha256()
  expect(hash1).toHaveLength(64) // SHA-256 produces 64 character hex string
  expect(hash2).toHaveLength(64)
  expect(hash1).not.toBe(hash2) // Different UUIDs should produce different hashes

  const hash3 = await sha256('foo')
  const hash4 = await sha256('foo')
  expect(hash3).toBe(hash4) // Same input should produce the same hash

  const hash5 = await sha256('foo1')
  expect(hash1).not.toBe(hash5)
  expect(hash2).not.toBe(hash5)
  expect(hash3).not.toBe(hash5)
  expect(hash4).not.toBe(hash5)

  expect(await sha256('test')).toMatchSnapshot()
})

test('pruneEmpty', () => {
  expect(
    pruneEmpty({
      a: 1,
      b: { foo: true },
      c: [true],
      d: 'foo',
      e: null,
      f: undefined
    })
  ).toEqual({
    a: 1,
    b: { foo: true },
    c: [true],
    d: 'foo'
  })

  expect(pruneEmpty({ a: 0, b: {}, c: [], d: '' })).toEqual({
    a: 0
  })
  expect(pruneEmpty({ b: {}, c: [], d: '' })).toEqual({})

  expect(
    pruneEmpty({
      a: null,
      b: { foo: [{}], bar: [null, undefined, ''] },
      c: ['', '', ''],
      d: '',
      e: undefined,
      f: [],
      g: {}
    })
  ).toEqual({
    b: { foo: [{}], bar: [null, undefined, ''] },
    c: ['', '', '']
  })
})

test('pruneEmptyDeep', () => {
  expect(
    pruneEmptyDeep({ a: 1, b: { foo: true }, c: [true], d: 'foo' })
  ).toEqual({
    a: 1,
    b: { foo: true },
    c: [true],
    d: 'foo'
  })

  expect(pruneEmptyDeep({ a: 0, b: {}, c: [], d: '' })).toEqual({
    a: 0
  })

  expect(
    pruneEmptyDeep({
      a: null,
      b: { foo: [{}], bar: [null, undefined, ''] },
      c: ['', '', ''],
      d: '',
      e: undefined
    })
  ).toEqual(undefined)
})

test('slugify', () => {
  expect(slugify('Foo Bar')).toBe('foo-bar')
  expect(slugify('FooBar')).toBe('foo-bar')
  expect(slugify('FooBarBaz')).toBe('foo-bar-baz')
  expect(slugify('FooBarBazQux')).toBe('foo-bar-baz-qux')
  expect(slugify('FooBarBazQuxQuux')).toBe('foo-bar-baz-qux-quux')
  expect(slugify('foo-bar')).toBe('foo-bar')
  expect(slugify('--foo BAR --')).toBe('foo-bar')
  expect(slugify('я люблю единорогов')).toBe('ya-lyublyu-edinorogov')
  expect(slugify('fooBar 123 $#%')).toBe('foo-bar-123')
  expect(slugify('  Déjà Vu!  ')).toBe('deja-vu')
  expect(slugify('I ♥ Dogs')).toBe('i-love-dogs')
  expect(slugify('')).toBe('')
  expect(slugify('    ')).toBe('')
  expect(slugify('-')).toBe('')
  expect(slugify('--')).toBe('')
  expect(slugify('- -')).toBe('')
})


================================================
FILE: packages/platform-core/src/utils.ts
================================================
import type { z, ZodType } from 'zod'
import slugifyImpl from '@sindresorhus/slugify'

import { HttpError, ZodValidationError } from './errors'

export { default as parseJson } from 'parse-json'

/**
 * From `inputObj`, create a new object that does not include `keys`.
 *
 * @example
 * ```js
 * omit({ a: 1, b: 2, c: 3 }, 'a', 'c') // { b: 2 }
 * ```
 */
export const omit = <
  T extends Record<string, unknown> | object,
  K extends keyof any
>(
  inputObj: T,
  ...keys: K[]
): Omit<T, K> => {
  const keysSet = new Set(keys)
  return Object.fromEntries(
    Object.entries(inputObj).filter(([k]) => !keysSet.has(k as any))
  ) as any
}

/**
 * From `inputObj`, create a new object that only includes `keys`.
 *
 * @example
 * ```js
 * pick({ a: 1, b: 2, c: 3 }, 'a', 'c') // { a: 1, c: 3 }
 * ```
 */
export const pick = <
  T extends Record<string, unknown> | object,
  K extends keyof T
>(
  inputObj: T,
  ...keys: K[]
): Pick<T, K> => {
  const keysSet = new Set(keys)
  return Object.fromEntries(
    Object.entries(inputObj).filter(([k]) => keysSet.has(k as any))
  ) as any
}

export function assert(expr: unknown, message?: string): asserts expr
export function assert(
  expr: unknown,
  statusCode?: number,
  message?: string
): asserts expr
export function assert(
  expr: unknown,
  statusCodeOrMessage?: number | string,
  message = 'Internal assertion failed'
): asserts expr {
  if (expr) {
    return
  }

  if (typeof statusCodeOrMessage === 'number') {
    const error = new HttpError({ statusCode: statusCodeOrMessage, message })
    Error.captureStackTrace(error, assert)
    throw error
  } else {
    const error = new Error(statusCodeOrMessage ?? message)
    Error.captureStackTrace(error, assert)
    throw error
  }
}

/**
 * Parses the given input against the given Zod schema, throwing a
 * `ZodValidationError` if the input is invalid.
 */
export function parseZodSchema<TSchema extends ZodType<any, any, any>>(
  schema: TSchema,
  input: unknown,
  {
    error,
    statusCode = 500
  }: {
    error?: string
    statusCode?: number
  } = {}
): z.infer<TSchema> {
  try {
    return schema.parse(input)
  } catch (err) {
    throw new ZodValidationError({
      prefix: error,
      cause: err,
      statusCode
    })
  }
}

export async function sha256(
  input: string | ArrayBuffer | ArrayBufferView = crypto.randomUUID()
) {
  let dataBuffer: ArrayBuffer | ArrayBufferView

  if (typeof input === 'string') {
    dataBuffer = new TextEncoder().encode(input)
  } else {
    dataBuffer = input
  }

  const hashBuffer = await crypto.subtle.digest('SHA-256', dataBuffer as any)
  const hashArray = Array.from(new Uint8Array(hashBuffer))
  const hashHex = hashArray
    .map((b) => ('00' + b.toString(16)).slice(-2))
    .join('')
  return hashHex
}

export function getEnv(name: string): string | undefined {
  try {
    return typeof process !== 'undefined'
      ? // eslint-disable-next-line no-process-env
        process.env?.[name]
      : undefined
  } catch {
    return undefined
  }
}

/**
 * Creates a new `URLSearchParams` object with all values coerced to strings
 * that correctly handles arrays of values as repeated keys (or CSV) and
 * correctly removes `undefined` keys and values.
 */
export function sanitizeSearchParams(
  searchParams:
    | Record<
        string,
        string | number | boolean | string[] | number[] | boolean[] | undefined
      >
    | object = {},
  {
    csv = false
  }: {
    /**
     * Whether to use comma-separated-values for arrays or multiple entries.
     *
     * Defaults to `false` and will use multiple entries.
     */
    csv?: boolean
  } = {}
): URLSearchParams {
  const entries = Object.entries(searchParams).flatMap(([key, value]) => {
    if (key === undefined || value === undefined) {
      return []
    }

    if (Array.isArray(value)) {
      return value.map((v) => [key, String(v)])
    }

    return [[key, String(value)]]
  }) as [string, string][]

  if (!csv) {
    return new URLSearchParams(entries)
  }

  const csvEntries: Record<string, string> = {}
  for (const [key, value] of entries) {
    csvEntries[key] = csvEntries[key] ? `${csvEntries[key]},${value}` : value
  }

  return new URLSearchParams(csvEntries)
}

export function pruneUndefined<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(([, value]) => value !== undefined)
  ) as NonNullable<T>
}

export function pruneNullOrUndefined<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(
      ([, value]) => value !== undefined && value !== null
    )
  ) as NonNullable<T>
}

export function pruneNullOrUndefinedDeep<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  if (!obj || Array.isArray(obj) || typeof obj !== 'object') return obj

  return Object.fromEntries(
    Object.entries(obj)
      .filter(([, value]) => value !== undefined && value !== null)
      .map(([key, value]) =>
        Array.isArray(value)
          ? [
              key,
              value
                .filter((v) => v !== undefined && v !== null)
                .map(pruneNullOrUndefinedDeep as any)
            ]
          : typeof value === 'object'
            ? [key, pruneNullOrUndefinedDeep(value)]
            : [key, value]
      )
  ) as NonNullable<T>
}

export function pruneEmpty<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(([, value]) => {
      if (value === undefined || value === null) return false
      if (typeof value === 'string' && !value) return false
      if (Array.isArray(value) && !value.length) return false
      if (
        typeof value === 'object' &&
        !Array.isArray(value) &&
        !Object.keys(value).length
      ) {
        return false
      }

      return true
    })
  ) as NonNullable<T>
}

export function pruneEmptyDeep<T>(
  value?: T
):
  | undefined
  | (T extends Record<string, any>
      ? { [K in keyof T]: Exclude<T[K], undefined | null> }
      : T extends Array<infer U>
        ? Array<Exclude<U, undefined | null>>
        : Exclude<T, null>) {
  if (value === undefined || value === null) return undefined

  if (typeof value === 'string') {
    if (!value) return undefined

    return value as any
  }

  if (Array.isArray(value)) {
    if (!value.length) return undefined

    value = value
      .map((v) => pruneEmptyDeep(v))
      .filter((v) => v !== undefined) as any

    if (!value || !Array.isArray(value) || !value.length) return undefined
    return value as any
  }

  if (typeof value === 'object') {
    if (!Object.keys(value).length) return undefined

    value = Object.fromEntries(
      Object.entries(value)
        .map(([k, v]) => [k, pruneEmptyDeep(v)])
        .filter(([, v]) => v !== undefined)
    )

    if (!value || !Object.keys(value).length) return undefined
    return value as any
  }

  return value as any
}

/**
 * Slugifies a string.
 *
 * - converts to lowercase
 * - decamelizes (fooBar -> foo-bar)
 * - replaces non-latin characters with latin equivalents (transliteration)
 * - replaces spaces with hyphens
 * - removes trailing hyphens
 * - removes leading hyphens
 * - removes multiple consecutive hyphens
 * - removes multiple consecutive spaces
 *
 * @see https://github.com/sindresorhus/slugify
 */
export function slugify(input: string): string {
  return slugifyImpl(input)
}


================================================
FILE: packages/platform-core/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/tool-client/package.json
================================================
{
  "name": "@agentic/platform-tool-client",
  "version": "8.4.4",
  "description": "Main client for working with LLM tools hosted on the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/tool-client"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-api-client": "workspace:*",
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-types": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "ky": "catalog:",
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/tool-client/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-tool-client"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-tool-client.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-tool-client <!-- omit from toc -->

> Main client for working with LLM tools hosted on the Agentic platform.

The purpose of this package is to connect TypeScript LLM SDKs to Agentic's hosted tools via the `AgenticToolClient.fromIdentifier(...)` method.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

## Install

```bash
npm i @agentic/platform-tool-client
```

## Usage

This example uses the [Vercel AI SDK](https://ai-sdk.dev) and the [`@agentic/search`](https://agentic.so/marketplace/projects/@agentic/search) tool.

```ts
import 'dotenv/config'

import { createAISDKTools } from '@agentic/ai-sdk'
import { AgenticToolClient } from '@agentic/platform-tool-client'
import { createOpenAI } from '@ai-sdk/openai'
import { generateText } from 'ai'

async function main() {
  const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
  const openai = createOpenAI({ compatibility: 'strict' })

  const result = await generateText({
    model: openai('gpt-4o-mini'),
    tools: createAISDKTools(searchTool),
    toolChoice: 'required',
    temperature: 0,
    system: 'You are a helpful assistant. Be as concise as possible.',
    prompt: 'What is the weather in San Francisco?'
  })

  console.log(JSON.stringify(result.toolResults[0], null, 2))
}

await main()
```

If you have a subscription to the Agentic project, you can specify your API key either by using the `AGENTIC_API_KEY` environment variable, or by passing it explicitly:

```ts
const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search', {
  apiKey: process.env.AGENTIC_API_KEY
})
```

Now all tool calls will be associated with your subscription for usage-tracking and billing purposes.

## Docs

See the [Agentic Quick Start](https://docs.agentic.so/marketplace) for more details on how to use Agentic tools with other TS LLM SDKs, MCP clients, and simple HTTP usage.

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/tool-client/src/agentic-tool-client.ts
================================================
import type { Deployment, Project } from '@agentic/platform-types'
import {
  AIFunctionSet,
  AIFunctionsProvider,
  createAIFunction,
  createJsonSchema,
  getEnv
} from '@agentic/core'
import { AgenticApiClient } from '@agentic/platform-api-client'
import { assert } from '@agentic/platform-core'
import { parseDeploymentIdentifier } from '@agentic/platform-validators'
import defaultKy, { type KyInstance } from 'ky'

export type AgenticToolClientOptions = {
  /**
   * Optional API key for your subscription to the Agentic project.
   *
   * If not set, will default to the `AGENTIC_API_KEY` environment variable.
   *
   * If no `apiKey` is set, the client will make unauthenticated tool calls,
   * which may or may not be supported by the target Agentic project.
   */
  apiKey?: string

  /**
   * Optional custom Agentic API client.
   */
  agenticApiClient?: AgenticApiClient

  /**
   * Optional custom Agentic Gateway base URL.
   *
   * @default `https://gateway.agentic.so`
   */
  agenticGatewayBaseUrl?: string

  /**
   * Optional custom Ky instance.
   *
   * Useful for overriding the default headers, retry logic, etc.
   */
  ky?: KyInstance
}

/**
 * Agentic tool client which makes it easy to use an Agentic tool products with
 * all of the major TypeScript LLM SDKs, without having to go through any MCP
 * middleware.
 *
 * The resulting tool client will make simple HTTP calls to the Agentic Gateway
 * to execute tools.
 *
 * @example
 * ```ts
 * const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
 * ```
 */
export class AgenticToolClient extends AIFunctionsProvider {
  readonly apiKey: string | undefined
  readonly project: Project
  readonly deployment: Deployment
  readonly agenticGatewayBaseUrl: string
  readonly ky: KyInstance

  protected constructor({
    apiKey,
    project,
    deployment,
    deploymentIdentifier,
    agenticGatewayBaseUrl,
    ky
  }: {
    apiKey: string | undefined
    project: Project
    deployment: Deployment
    deploymentIdentifier: string
    agenticGatewayBaseUrl: string
    ky: KyInstance
  }) {
    super()

    this.apiKey = apiKey
    this.project = project
    this.deployment = deployment
    this.agenticGatewayBaseUrl = agenticGatewayBaseUrl
    this.ky = apiKey
      ? ky.extend({ headers: { Authorization: `Bearer ${apiKey}` } })
      : ky

    this._functions = new AIFunctionSet(
      deployment.tools.map((tool) => {
        return createAIFunction({
          name: tool.name,
          description: tool.description ?? '',
          inputSchema: createJsonSchema(tool.inputSchema),
          // TODO: we should make sure all agentic tools support OpenAI strict
          // mode by default.
          strict: false,
          execute: async (json) => {
            return ky
              .post(
                `${agenticGatewayBaseUrl}/${deploymentIdentifier}/${tool.name}`,
                {
                  json
                }
              )
              .json()
          }
        })
      })
    )
  }

  /**
   * Helper method to call a tool with either raw or stringified JSON arguments.
   */
  async callTool(toolName: string, args: string | Record<string, any>) {
    const tool = this.functions.get(toolName)
    assert(tool, `Tool "${toolName}" not found`)
    return tool(typeof args === 'string' ? args : JSON.stringify(args))
  }

  /**
   * Creates an Agentic tool client from a project or deployment identifier.
   *
   * You'll generally use a project identifier, which will automatically use
   * that project's `latest` deployment, but if you want to target a specific
   * version or preview deployment, you can use a fully-qualified deployment
   * identifier.
   *
   * @param projectOrDeploymentIdentifier - The project or deployment identifier to use
   * @param options.apiKey - Optional API key for authentication. If not provided,
   *   automatically derived from the `AGENTIC_API_KEY` environment variable.
   *   The key will start with `sk-...` and is found at https://agentic.so/app
   *
   * @example
   * ```ts
   * const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search')
   * ```
   *
   * @example
   * ```ts
   * // With explicit API key
   * const searchTool = await AgenticToolClient.fromIdentifier('@agentic/search', {
   *   apiKey: 'sk-...'
   * })
   * ```
   */
  static async fromIdentifier(
    projectOrDeploymentIdentifier: string,
    {
      apiKey = getEnv('AGENTIC_API_KEY'),
      agenticApiClient = new AgenticApiClient(),
      agenticGatewayBaseUrl = 'https://gateway.agentic.so',
      ky = defaultKy
    }: AgenticToolClientOptions = {}
  ): Promise<AgenticToolClient> {
    const { projectIdentifier, deploymentIdentifier, deploymentVersion } =
      parseDeploymentIdentifier(projectOrDeploymentIdentifier, {
        strict: false
      })

    const [project, rawDeployment] = await Promise.all([
      agenticApiClient.getPublicProjectByIdentifier({
        projectIdentifier,
        populate:
          deploymentVersion === 'latest' ? ['lastPublishedDeployment'] : []
      }),

      // Only make 1 API call in the 95% case where the deployment version is
      // set to the default value of `latest`.
      deploymentVersion === 'latest'
        ? Promise.resolve(undefined)
        : agenticApiClient.getPublicDeploymentByIdentifier({
            deploymentIdentifier
          })
    ])

    const deployment =
      deploymentVersion === 'latest'
        ? project?.lastPublishedDeployment
        : rawDeployment

    assert(project, `Project "${projectIdentifier}" not found`)
    assert(deployment, `Deployment "${deploymentIdentifier}" not found`)

    return new AgenticToolClient({
      apiKey,
      project,
      deployment,
      deploymentIdentifier,
      agenticGatewayBaseUrl,
      ky
    })
  }
}


================================================
FILE: packages/tool-client/src/index.ts
================================================
export * from './agentic-tool-client'


================================================
FILE: packages/tool-client/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/types/bin/generate-project-config-json-schema.ts
================================================
import restoreCursor from 'restore-cursor'
import { zodToJsonSchema } from 'zod-to-json-schema'

import { agenticProjectConfigSchema } from '../src'

async function main() {
  restoreCursor()

  const tempJsonSchema = zodToJsonSchema(agenticProjectConfigSchema)

  const publicJsonSchema = {
    ...tempJsonSchema,
    $schema: 'https://json-schema.org/draft-07/schema',
    // TODO
    // $id: 'https://agentic.so/docs/schema.json',
    title: 'Agentic Project Config Schema',
    description:
      'JSON Schema used by `agentic.config.{ts,js,json}` files to configure Agentic projects.'
  }

  // eslint-disable-next-line no-console
  console.log(JSON.stringify(publicJsonSchema, null, 2))
}

await main()


================================================
FILE: packages/types/package.json
================================================
{
  "name": "@agentic/platform-types",
  "version": "8.4.4",
  "description": "Core schemas and types shared across the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/types"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "generate": "run-s generate:*",
    "generate:openapi": "openapi-typescript http://localhost:3001/docs --output ./src/openapi.d.ts",
    "generate:json-schema": "tsx bin/generate-project-config-json-schema.ts > ../../apps/web/public/schema.json",
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@agentic/platform-validators": "workspace:*",
    "@hono/zod-openapi": "catalog:",
    "ms": "catalog:",
    "type-fest": "catalog:",
    "zod": "catalog:"
  },
  "devDependencies": {
    "@types/ms": "catalog:",
    "openapi-typescript": "catalog:",
    "restore-cursor": "catalog:",
    "zod-to-json-schema": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/types/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-types"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-types.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-types <!-- omit from toc -->

> Core schemas and types shared across the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this package directly. See [@agentic/cli](https://github.com/transitive-bullshit/agentic/tree/main/packages/cli), [@agentic/platform](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform), and [@agentic/platform-tool-client](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform-tool-client) for more public-facing packages.

## Install

```bash
npm i @agentic/platform-types
```

## Usage

```ts
import {
  agenticProjectConfigSchema,
  type AgenticProjectConfigInput,
  resolvedAgenticProjectConfigSchema,
  type ResolvedAgenticProjectConfig,
  type User,
  type Project,
  type Deployment,
  type Consumer,
  type AdminMcpRequestMetadata
  // etc...
} from '@agentic/platform-types'
```

## Notes

Some types are raw TS, some are derived from zod schemas, and most of the core database models are inferred from a generated OpenAPI spec exposed by Agentic's backend API.

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/types/src/__snapshots__/rate-limit.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`rateLimitSchema invalid 1`] = `
[ZodError: [
  {
    "code": "invalid_union",
    "unionErrors": [
      {
        "issues": [
          {
            "code": "invalid_literal",
            "expected": false,
            "path": [
              "enabled"
            ],
            "message": "Invalid literal value, expected false"
          }
        ],
        "name": "ZodError"
      },
      {
        "issues": [
          {
            "code": "invalid_union",
            "unionErrors": [
              {
                "issues": [
                  {
                    "code": "invalid_type",
                    "expected": "number",
                    "received": "string",
                    "path": [
                      "interval"
                    ],
                    "message": "Expected number, received string"
                  }
                ],
                "name": "ZodError"
              },
              {
                "issues": [
                  {
                    "code": "too_small",
                    "minimum": 1,
                    "type": "string",
                    "inclusive": true,
                    "exact": false,
                    "message": "String must contain at least 1 character(s)",
                    "path": [
                      "interval"
                    ]
                  }
                ],
                "name": "ZodError"
              }
            ],
            "path": [
              "interval"
            ],
            "message": "Invalid input"
          }
        ],
        "name": "ZodError"
      }
    ],
    "path": [],
    "message": "Invalid input"
  }
]]
`;

exports[`rateLimitSchema invalid 2`] = `
[ZodError: [
  {
    "code": "too_small",
    "minimum": 0,
    "type": "number",
    "inclusive": false,
    "exact": false,
    "message": "Number must be greater than 0",
    "path": [
      "interval"
    ]
  }
]]
`;

exports[`rateLimitSchema invalid 3`] = `
[ZodError: [
  {
    "code": "custom",
    "message": "Invalid interval \\"--\\"",
    "path": [
      "interval",
      "interval"
    ]
  }
]]
`;

exports[`rateLimitSchema invalid 4`] = `
[ZodError: [
  {
    "code": "too_small",
    "minimum": 0,
    "type": "number",
    "inclusive": true,
    "exact": false,
    "message": "Number must be greater than or equal to 0",
    "path": [
      "limit"
    ]
  }
]]
`;

exports[`rateLimitSchema valid 1`] = `
{
  "enabled": true,
  "interval": 10,
  "limit": 100,
  "mode": "approximate",
}
`;

exports[`rateLimitSchema valid 2`] = `
{
  "enabled": true,
  "interval": 10,
  "limit": 100,
  "mode": "approximate",
}
`;

exports[`rateLimitSchema valid 3`] = `
{
  "enabled": true,
  "interval": 86400,
  "limit": 1000,
  "mode": "strict",
}
`;

exports[`rateLimitSchema valid 4`] = `
{
  "enabled": false,
}
`;

exports[`rateLimitSchema valid 5`] = `
{
  "enabled": false,
}
`;


================================================
FILE: packages/types/src/agentic-project-config.test.ts
================================================
import { expectTypeOf, test } from 'vitest'

import type { AgenticProjectConfigInput } from './agentic-project-config'

test('AgenticProjectConfig input types', () => {
  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
  }>().toExtend<AgenticProjectConfigInput>()

  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
    pricingPlans: [
      {
        name: 'Free'
        slug: 'free'
        lineItems: [
          {
            slug: 'base'
            usageType: 'licensed'
            amount: 0
          }
        ]
      }
    ]
  }>().toExtend<AgenticProjectConfigInput>()

  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
    pricingPlans: [
      {
        name: 'Basic Monthly'
        slug: 'basic-monthly'
        lineItems: [
          {
            slug: 'requests'
            usageType: 'metered'
            billingScheme: 'per_unit'
            unitAmount: 50
          }
        ]
        rateLimit: {
          // Make sure `interval` can use a string as input
          interval: '30s'
          limit: 100
        }
      }
    ]
  }>().toExtend<AgenticProjectConfigInput>()

  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
    pricingPlans: [
      {
        name: 'Basic Monthly'
        slug: 'basic-monthly'
        lineItems: [
          {
            slug: 'requests'
            usageType: 'metered'
            billingScheme: 'per_unit'
            unitAmount: 50
          }
        ]
        rateLimit: {
          // Make sure `interval` can use a number as input
          interval: 300
          limit: 100
        }
      }
    ]
  }>().toExtend<AgenticProjectConfigInput>()

  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
    // Invalid because `pricingPlans` must be non-empty if defined
    pricingPlans: []
  }>().not.toExtend<AgenticProjectConfigInput>()

  expectTypeOf<{
    name: 'test'
    origin: {
      type: 'openapi'
      url: 'https://httpbin.org'
      spec: './openapi.json'
    }
    pricingPlans: [
      {
        name: 'Basic Monthly'
        slug: 'basic-monthly'
        // Invalid because `lineItems` must be non-empty
        lineItems: []
      }
    ]
  }>().not.toExtend<AgenticProjectConfigInput>()
})


================================================
FILE: packages/types/src/agentic-project-config.ts
================================================
import type { Simplify } from 'type-fest'
import { isValidProjectSlug } from '@agentic/platform-validators'
import { z } from '@hono/zod-openapi'

import {
  originAdapterConfigSchema,
  originAdapterSchema
} from './origin-adapter'
import {
  defaultFreePricingPlan,
  defaultRequestsRateLimit,
  pricingIntervalListSchema,
  type PricingPlanList,
  type PricingPlanListInput,
  pricingPlanListSchema
} from './pricing'
import {
  type RateLimit,
  type RateLimitInput,
  rateLimitSchema
} from './rate-limit'
import {
  type ToolConfig,
  type ToolConfigInput,
  toolConfigSchema,
  toolSchema
} from './tools'

// TODO:
// - optional external auth provider config (google, github, twitter, etc)
// - optional stripe webhooks
// - optional response header config (custom headers, immutability for caching, etc)
// - optional agentic version
// - optional version

export const agenticProjectConfigSchema = z
  .object({
    /**
     * Display name for the project.
     *
     * Max length 1024 characters.
     *
     * @required
     * @example "My Project"
     * @example "LinkedIn Resolver"
     */
    name: z
      .string()
      .max(1024)
      .nonempty()
      .describe('Display name for the project. Max length 1024 characters.'),

    /**
     * Slug for the project.
     *
     * Must be ascii-only, lower-case, and kebab-case with no spaces between 1
     * and 256 characters.
     *
     * The project's fully qualified identifier will be `@namespace/slug`, where
     * the `namespace` is determined by the author's `username` or team slug.
     *
     * If not provided, the project `slug` will be derived by slugifying `name`.
     *
     * @example "my-project"
     * @example "linkedin-resolver-23"
     */
    slug: z
      .string()
      .nonempty()
      .describe(
        'Unique project slug. Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. If not provided, it will be derived by slugifying `name`.'
      )
      .optional()
      .refine((slug) => (slug ? isValidProjectSlug(slug) : true), {
        message: 'Invalid project slug'
      }),

    /**
     * Optional semantic version of the project as a semver string.
     *
     * @example "1.0.0"
     */
    version: z
      .string()
      .nonempty()
      .describe(
        'Optional semantic version of the project as a semver string. Ex: 1.0.0, 0.0.1, 5.0.1, etc.'
      )
      .optional(),

    /**
     * Optional short description of the project.
     *
     * Should be no longer than a few lines.
     */
    description: z
      .string()
      .describe('A short description of the project.')
      .optional(),

    /**
     * Optional markdown readme documenting the project (supports GitHub-flavored markdown).
     *
     * A string which may be either:
     * - A URL to a remote markdown file (eg, `https://example.com/readme.md`)
     * - A local file path (eg, `./readme.md`)
     * - A data-uri string (eg, `data:text/markdown;base64,SGVsbG8gV29ybGQ=`)
     */
    readme: z
      .string()
      .describe(
        'Optional markdown readme documenting the project (supports GitHub-flavored markdown).'
      )
      .optional(),

    /**
     * Optional logo image to use for the project.
     *
     * A string which may be either:
     * - A URL to a remote image (eg, `https://example.com/logo.png`)
     * - A local file path (eg, `./logo.png`)
     * - A data-uri string (eg, `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`)
     *
     * Logos should have a square aspect ratio.
     *
     * @example "https://example.com/logo.png"
     */
    icon: z
      .string()
      .optional()
      .describe(
        'Optional logo image to use for the project. Logos should have a square aspect ratio.'
      ),

    /**
     * Optional URL to the source code of the project (eg, GitHub repo).
     *
     * @example "https://github.com/my-org/my-project"
     */
    sourceUrl: z
      .string()
      .url()
      .describe(
        'Optional URL to the source code of the project (eg, GitHub repo).'
      )
      .optional(),

    /**
     * Optional URL to the product's homepage.
     *
     * @example "https://my-product.com"
     */
    homepageUrl: z
      .string()
      .url()
      .describe("Optional URL to the product's homepage.")
      .optional(),

    /**
     * Origin API adapter used to configure the origin API server downstream
     * from Agentic's API gateway. It specifies whether the origin API server's
     * is hosted externally or deployed internally to Agentic's infrastructure.
     * If hosted externally, the origin `url` must be a valid \`https\` URL
     * pointing to the remote origin server.
     *
     * It also specifies the format for how origin tools are defined: either as
     * an OpenAPI spec or an MCP server.
     *
     * @note Currently, only external origin servers are supported. If you'd like
     * to host your API or MCP server on Agentic's infrastructure, please reach
     * out to support@agentic.so.
     *
     * @required
     */
    origin: originAdapterConfigSchema,

    /** Optional subscription pricing config for this project. */
    pricingPlans: pricingPlanListSchema
      .describe(
        'List of PricingPlans configuring which Stripe subscriptions should be available for the project. Defaults to a single free plan which is useful for developing and testing your project.'
      )
      .optional()
      .default([defaultFreePricingPlan]),

    /**
     * Optional list of billing intervals to enable in pricing plans.
     *
     * Defaults to a single monthly interval `['month']`.
     *
     * To add support for annual pricing plans, for example, you can use:
     * `['month', 'year']`.
     *
     * Note that for every pricing interval, you must define a corresponding set
     * of PricingPlans in the `pricingPlans` array. If you only have one pricing
     * interval (like the default `month` interval), `pricingPlans` don't need to
     * specify their `interval` property. Otherwise, all PricingPlans must
     * specify their `interval` property to differentiate between different
     * pricing intervals.
     */
    pricingIntervals: pricingIntervalListSchema
      .describe(
        `Optional list of billing intervals to enable in the pricingPlans.

Defaults to a single monthly interval \`['month']\`.

To add support for annual pricing plans, for example, you can use: \`['month', 'year']\`.`
      )
      .optional()
      .default(['month']),

    /**
     * Optional default rate limits to enforce across all pricing plans.
     *
     * To disable the default rate-limit, set `defaultRateLimit.enabled` to
     * `false`.
     *
     * Note that pricing-plan-specific rate-limits override this default (via
     * `pricingPlans`), and tool-specific rate-limits may override both default
     * and pricing-plan-specific rate-limits (via `toolConfigs`).
     */
    defaultRateLimit: rateLimitSchema
      .optional()
      .default(defaultRequestsRateLimit),

    /**
     * Optional list of tool configs to override the default behavior of
     * specific tools.
     *
     * Make sure the tool `name` matches the origin server's tool names, either
     * via its MCP server or OpenAPI operationIds.
     *
     * Tool names are expected to be unique and stable across deployments.
     *
     * With `toolConfigs`, tools can be disabled, set custom rate-limits,
     * customize reporting usage for metered billing, and they can also
     * override behavior for different pricing plans.
     *
     * For example, you may want to disable certain tools on a `free` pricing
     * plan or remove the rate-limit for a specific tool on a `pro` pricing
     * plan while keeping the defualt rate-limit in place for other tools.
     *
     * Note that tool-specific configs override the defaults defined in
     * pricing plans.
     *
     * If a tool is defined on the origin server but not specified in
     * `toolConfigs`, it will use the default behavior of the Agentic API
     * gateway.
     */
    toolConfigs: z.array(toolConfigSchema).optional().default([])
  })
  .strip()

export type AgenticProjectConfigInput = Simplify<
  Omit<
    z.input<typeof agenticProjectConfigSchema>,
    'pricingPlans' | 'toolConfigs'
  > & {
    pricingPlans?: PricingPlanListInput
    toolConfigs?: ToolConfigInput[]
    defaultRateLimit?: RateLimitInput
  }
>
export type AgenticProjectConfigRaw = z.output<
  typeof agenticProjectConfigSchema
>
export type AgenticProjectConfig = Simplify<
  Omit<
    AgenticProjectConfigRaw,
    'pricingPlans' | 'toolConfigs' | 'defaultRateLimit'
  > & {
    slug: string
    pricingPlans: PricingPlanList
    toolConfigs: ToolConfig[]
    defaultRateLimit: RateLimit
  }
>

export const resolvedAgenticProjectConfigSchema = agenticProjectConfigSchema
  .required({
    slug: true
  })
  .omit({
    icon: true
  })
  .extend({
    /**
     * Optional logo image URL to use for the project. Logos should have a
     * square aspect ratio.
     *
     * @example "https://example.com/logo.png"
     */
    iconUrl: z
      .string()
      .optional()
      .describe(
        'Optional logo image URL to use for the project. Logos should have a square aspect ratio.'
      ),

    origin: originAdapterSchema,
    tools: z.array(toolSchema).default([])
  })
export type ResolvedAgenticProjectConfig = Simplify<
  Omit<
    z.output<typeof resolvedAgenticProjectConfigSchema>,
    'pricingPlans' | 'toolConfigs' | 'defaultRateLimit'
  > & {
    slug: string
    pricingPlans: PricingPlanList
    toolConfigs: ToolConfig[]
    defaultRateLimit: RateLimit
  }
>


================================================
FILE: packages/types/src/auth-subjects.ts
================================================
import { z } from '@hono/zod-openapi'

export const authUserSchema = z.object({
  type: z.literal('user'),
  id: z.string(),
  username: z.string()
})
export type AuthUser = z.infer<typeof authUserSchema>


================================================
FILE: packages/types/src/index.ts
================================================
export * from './agentic-project-config'
export * from './auth-subjects'
export * from './mcp'
export type * as openapi from './openapi.d.ts'
export * from './origin-adapter'
export * from './pricing'
export * from './rate-limit'
export * from './tools'
export type * from './types'
export * from './utils'
export * from './webhook'


================================================
FILE: packages/types/src/mcp.ts
================================================
import { z } from '@hono/zod-openapi'

/**
 * Capabilities that a server may support.
 *
 * Known capabilities are defined here, in this schema, but this is not a
 * closed set: any server can define its own, additional capabilities.
 */
export const mcpServerCapabilitiesSchema = z
  .object({
    /**
     * Experimental, non-standard capabilities that the server supports.
     */
    experimental: z.optional(z.object({}).passthrough()),

    /**
     * Present if the server supports sending log messages to the client.
     */
    logging: z.optional(z.object({}).passthrough()),

    /**
     * Present if the server supports sending completions to the client.
     */
    completions: z.optional(z.object({}).passthrough()),

    /**
     * Present if the server offers any prompt templates.
     */
    prompts: z.optional(
      z
        .object({
          /**
           * Whether this server supports issuing notifications for changes to
           * the prompt list.
           */
          listChanged: z.optional(z.boolean())
        })
        .passthrough()
    ),

    /**
     * Present if the server offers any resources to read.
     */
    resources: z.optional(
      z
        .object({
          /**
           * Whether this server supports clients subscribing to resource updates.
           */
          subscribe: z.optional(z.boolean()),

          /**
           * Whether this server supports issuing notifications for changes to
           * the resource list.
           */
          listChanged: z.optional(z.boolean())
        })
        .passthrough()
    ),

    /**
     * Present if the server offers any tools to call.
     */
    tools: z.optional(
      z
        .object({
          /**
           * Whether this server supports issuing notifications for changes to
           * the tool list.
           */
          listChanged: z.optional(z.boolean())
        })
        .passthrough()
    )
  })
  .passthrough()

/**
 * After receiving an initialize request from the client, the server sends
 * this response.
 */
export const mcpServerInfoSchema = z.object({
  /**
   * The name of the MCP server.
   */
  name: z.string(),

  /**
   * The version of the MCP server.
   */
  version: z.string(),

  /**
   * The advertised capabilities of the MCP server.
   */
  capabilities: mcpServerCapabilitiesSchema.optional(),

  /**
   * Instructions describing how to use the server and its features.
   *
   * This can be used by clients to improve the LLM's understanding of
   * available tools, resources, etc. It can be thought of like a "hint" to the
   * model. For example, this information MAY be added to the system prompt.
   */
  instructions: z.string().optional()
})


================================================
FILE: packages/types/src/openapi.d.ts
================================================
/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
    "/v1/health": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Health check endpoint. */
        get: operations["healthCheck"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/auth/password/signin": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Signs in with email and password. */
        post: operations["signInWithPassword"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/auth/password/signup": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Signs up for a new account with email and password. */
        post: operations["signUpWithPassword"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/auth/github/exchange": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Exchanges a GitHub OAuth code for an Agentic auth session. */
        post: operations["exchangeOAuthCodeWithGitHub"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/auth/github/init": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Starts a GitHub OAuth flow. */
        get: operations["initGitHubOAuthFlow"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/public": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists projects that have been published publicly to the marketplace. */
        get: operations["listPublicProjects"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/public/by-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a public project by its public identifier (eg, "@username/project-slug"). */
        get: operations["getPublicProjectByIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/public/{projectId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a public project by ID. */
        get: operations["getPublicProject"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/deployments/public/by-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a public deployment by its identifier (eg, "@username/project-slug@latest"). */
        get: operations["getPublicDeploymentByIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/users/{userId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a user by ID. */
        get: operations["getUser"];
        put?: never;
        /** @description Updates a user by ID. */
        post: operations["updateUser"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/teams": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists all teams the authenticated user belongs to. */
        get: operations["listTeams"];
        put?: never;
        /** @description Creates a new team. */
        post: operations["createTeam"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/teams/{teamId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a team by ID. */
        get: operations["getTeam"];
        put?: never;
        /** @description Updates a team. */
        post: operations["updateTeam"];
        /** @description Deletes a team by ID. */
        delete: operations["deleteTeam"];
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/teams/{teamId}/members": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Creates a new team member. */
        post: operations["createTeamMember"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/teams/{teamId}/members/{userId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Updates a team member. */
        post: operations["updateTeamMember"];
        /** @description Deletes a team member. */
        delete: operations["deleteTeamMember"];
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/storage/signed-upload-url": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a signed URL for uploading a file to Agentic's blob storage. Files are namespaced to a given project and are identified by a key that should be a hash of the file's contents, with the correct file extension. */
        get: operations["getSignedStorageUploadUrl"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists projects owned by the authenticated user or team. */
        get: operations["listProjects"];
        put?: never;
        /** @description Creates a new project. */
        post: operations["createProject"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/by-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a project by its public identifier (eg, "@username/project-slug"). */
        get: operations["getProjectByIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/{projectId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a project by ID. */
        get: operations["getProject"];
        put?: never;
        /** @description Updates a project. */
        post: operations["updateProject"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/by-project-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a consumer for the authenticated user and the given project identifier. */
        get: operations["getConsumerByProjectIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/billing-portal": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Creates a Stripe billing portal session for the authenticated user. */
        post: operations["createBillingPortalSession"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/{consumerId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a consumer by ID. */
        get: operations["getConsumer"];
        put?: never;
        /** @description Updates a consumer's subscription to a different deployment or pricing plan. Set `plan` to undefined to cancel the subscription. */
        post: operations["updateConsumer"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists all of the customer subscriptions for the current user. */
        get: operations["listConsumers"];
        put?: never;
        /** @description Upserts a consumer by modifying a customer's subscription to a project. */
        post: operations["createConsumer"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/checkout": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Creates a Stripe checkout session for a consumer to modify their subscription to a project. */
        post: operations["createConsumerCheckoutSession"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/{consumerId}/billing-portal": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Creates a Stripe billing portal session for a customer. */
        post: operations["createConsumerBillingPortalSession"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/consumers/{consumerId}/refresh-api-key": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Refreshes a consumer's API key. */
        post: operations["refreshConsumerApiKey"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/projects/{projectId}/consumers": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists all of the customers for a project. */
        get: operations["listConsumersForProject"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/deployments/by-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a deployment by its identifier (eg, "@username/project-slug@latest"). */
        get: operations["getDeploymentByIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/deployments/{deploymentId}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a deployment by its ID */
        get: operations["getDeployment"];
        put?: never;
        /** @description Updates a deployment. */
        post: operations["updateDeployment"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/deployments": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Lists deployments the user or team has access to, optionally filtering by project. */
        get: operations["listDeployments"];
        put?: never;
        /** @description Creates a new deployment within a project. */
        post: operations["createDeployment"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/deployments/{deploymentId}/publish": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        put?: never;
        /** @description Publishes a deployment. */
        post: operations["publishDeployment"];
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/admin/consumers/api-keys/{apiKey}": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a consumer by API key. This route is admin-only. */
        get: operations["adminGetConsumerByApiKey"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/admin/consumers/{consumerId}/activate": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        get?: never;
        /** @description Activates a consumer signifying that at least one API call has been made using the consumer's API token. This method is idempotent and admin-only. */
        put: operations["adminActivateConsumer"];
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
    "/v1/admin/deployments/by-identifier": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** @description Gets a deployment by its public identifier. This route is admin-only. */
        get: operations["adminGetDeploymentByIdentifier"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
}
export type webhooks = Record<string, never>;
export interface components {
    schemas: {
        User: {
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            username: string;
            /** @enum {string} */
            role: "user" | "admin";
            email: string;
            isEmailVerified: boolean;
            name?: string;
            bio?: string;
            image?: string;
            stripeCustomerId?: string;
        };
        AuthSession: {
            token: string;
            user: components["schemas"]["User"];
        };
        /** @description Public project identifier (e.g. "@namespace/project-slug") */
        ProjectIdentifier: string;
        /** @description The frequency at which a subscription is billed. */
        PricingInterval: "day" | "week" | "month" | "year";
        Team: Record<string, never>;
        /** @description A Project represents a single Agentic API product. It is comprised of a series of immutable Deployments, each of which contains pricing data, origin API config, OpenAPI or MCP specs, tool definitions, and various metadata.
         *
         *     You can think of Agentic Projects as similar to Vercel projects. They both hold some common configuration and are comprised of a series of immutable Deployments.
         *
         *     Internally, Projects manage all of the Stripe billing resources across Deployments (Stripe Products, Prices, and Meters for usage-based billing). */
        Project: {
            /** @description Project id (e.g. "proj_tz4a98xxat96iws9zmbrgj3a") */
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            /** @description Display name for the project. Max length 1024 characters. */
            name: string;
            identifier: components["schemas"]["ProjectIdentifier"];
            namespace: string;
            /** @description Unique project slug. Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. If not provided, it will be derived by slugifying `name`. */
            slug?: string;
            private: boolean;
            tags?: string[];
            /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
            userId: string;
            /** @description Team id (e.g. "team_tz4a98xxat96iws9zmbrgj3a") */
            teamId?: string;
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            lastPublishedDeploymentId?: string;
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            lastDeploymentId?: string;
            lastPublishedDeploymentVersion?: string;
            defaultPricingInterval: components["schemas"]["PricingInterval"];
            /** @enum {string} */
            pricingCurrency: "usd";
            user?: components["schemas"]["User"];
            team?: components["schemas"]["Team"];
            lastPublishedDeployment?: unknown;
            lastDeployment?: unknown;
            deployment?: unknown;
        };
        /** @description Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}") */
        DeploymentIdentifier: string;
        JsonSchemaObject: {
            /** @enum {string} */
            type: "object";
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            additionalProperties?: boolean | {
                [key: string]: unknown;
            };
        };
        Tool: {
            /** @description Agentic tool name */
            name: string;
            description?: string;
            inputSchema: components["schemas"]["JsonSchemaObject"];
            outputSchema?: components["schemas"]["JsonSchemaObject"];
            annotations?: {
                title?: string;
                readOnlyHint?: boolean;
                destructiveHint?: boolean;
                idempotentHint?: boolean;
                openWorldHint?: boolean;
            };
        };
        RateLimit: {
            /** @enum {boolean} */
            enabled: false;
        } | {
            /** @description The interval at which the rate limit is applied. Either a positive integer expressed in seconds or a valid positive [ms](https://github.com/vercel/ms) string (eg, "10s", "1m", "8h", "2d", "1w", "1y", etc). */
            interval: number | string;
            /** @description Maximum number of operations per interval (unitless). */
            limit: number;
            /**
             * @description How to enforce the rate limit: "strict" (more precise but slower) or "approximate" (the default; faster and asynchronous but less precise).
             * @default approximate
             */
            mode: "strict" | "approximate";
            /** @default true */
            enabled: boolean;
        };
        PricingPlanToolOverride: {
            enabled?: boolean;
            reportUsage?: boolean;
            rateLimit?: components["schemas"]["RateLimit"];
        };
        ToolConfig: {
            /** @description Agentic tool name */
            name: string;
            enabled?: boolean;
            pure?: boolean;
            cacheControl?: string;
            reportUsage?: boolean;
            rateLimit?: components["schemas"]["RateLimit"];
            inputSchemaAdditionalProperties?: boolean;
            outputSchemaAdditionalProperties?: boolean;
            /** @description Allows you to override this tool's behavior or disable it entirely for different pricing plans. This is a map of PricingPlan slug to PricingPlanToolOverrides for that plan. */
            pricingPlanOverridesMap?: {
                [key: string]: components["schemas"]["PricingPlanToolOverride"];
            };
            /** @description Examples of how to use this tool. Used to generate example usage in the tool's docs. */
            examples?: {
                /** @description The display name of the example. If not given, defaults to `Example 1`, `Example 2`, etc. */
                name?: string;
                /** @description The input prompt for agents to use when running this example. */
                prompt: string;
                /** @description An optional system prompt for agents to use when running this example. Defaults to `You are a helpful assistant. Be as concise as possible.` */
                systemPrompt?: string;
                /** @description The arguments to pass to the tool for this example. */
                args: {
                    [key: string]: unknown;
                };
                /** @description Whether this example should be featured in the docs for the project. */
                featured?: boolean;
                /** @description A description of the example. */
                description?: string;
            }[];
        };
        /**
         * @description Display name for the pricing plan (eg, "Free", "Starter Monthly", "Pro Annual", etc)
         * @example Starter Monthly
         */
        name: string;
        /**
         * @description PricingPlan slug (eg, "free", "starter-monthly", "pro-annual", etc). Should be lower-cased and kebab-cased. Should be stable across deployments.
         * @example starter-monthly
         */
        slug: string;
        /** @example API calls */
        label: string;
        PricingPlanTier: {
            unitAmount?: number;
            flatAmount?: number;
            upTo: number | "inf";
        };
        /** @description PricingPlanLineItems represent a single line-item in a Stripe Subscription. They map to a Stripe billing `Price` and possibly a corresponding Stripe `Meter` for usage-based line-items. */
        PricingPlanLineItem: {
            slug: string;
            label?: components["schemas"]["label"];
            /** @enum {string} */
            usageType: "licensed";
            amount: number;
        } | {
            slug: string;
            label?: components["schemas"]["label"];
            /** @enum {string} */
            usageType: "metered";
            unitLabel?: string;
            billingScheme: "per_unit" | "tiered";
            unitAmount?: number;
            tiersMode?: "graduated" | "volume";
            tiers?: components["schemas"]["PricingPlanTier"][];
            defaultAggregation?: {
                /** @default sum */
                formula: "sum" | "count";
            };
            transformQuantity?: {
                divideBy: number;
                round: "down" | "up";
            };
        };
        /** @description Represents the config for a Stripe subscription with one or more PricingPlanLineItems. */
        PricingPlan: {
            name: components["schemas"]["name"];
            slug: components["schemas"]["slug"];
            interval?: components["schemas"]["PricingInterval"];
            description?: string;
            features?: string[];
            trialPeriodDays?: number;
            rateLimit?: components["schemas"]["RateLimit"];
            lineItems: components["schemas"]["PricingPlanLineItem"][];
        };
        /** @description A Deployment is a single, immutable instance of a Project. Each deployment contains pricing plans, origin server config (OpenAPI or MCP server), tool definitions, and metadata.
         *
         *     Deployments are private to a developer or team until they are published, at which point they are accessible to any customers with access to the parent Project. */
        Deployment: {
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            identifier: components["schemas"]["DeploymentIdentifier"];
            hash: string;
            /** @description Optional semantic version of the project as a semver string. Ex: 1.0.0, 0.0.1, 5.0.1, etc. */
            version?: string;
            published: boolean;
            /** @description Display name for the project. Max length 1024 characters. */
            name: string;
            /** @description A short description of the project. */
            description?: string;
            /** @description Optional markdown readme documenting the project (supports GitHub-flavored markdown). */
            readme?: string;
            /** @description Optional logo image URL to use for the project. Logos should have a square aspect ratio. */
            iconUrl?: string;
            /**
             * Format: uri
             * @description Optional URL to the source code of the project (eg, GitHub repo).
             */
            sourceUrl?: string;
            /**
             * Format: uri
             * @description Optional URL to the product's homepage.
             */
            homepageUrl?: string;
            /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
            userId: string;
            /** @description Team id (e.g. "team_tz4a98xxat96iws9zmbrgj3a") */
            teamId?: string;
            /** @description Project id (e.g. "proj_tz4a98xxat96iws9zmbrgj3a") */
            projectId: string;
            /** @default [] */
            tools: components["schemas"]["Tool"][];
            /** @default [] */
            toolConfigs: components["schemas"]["ToolConfig"][];
            /**
             * @description List of PricingPlans configuring which Stripe subscriptions should be available for the project. Defaults to a single free plan which is useful for developing and testing your project.
             * @default [
             *       {
             *         "name": "Free",
             *         "slug": "free",
             *         "lineItems": [
             *           {
             *             "slug": "base",
             *             "usageType": "licensed",
             *             "amount": 0
             *           }
             *         ],
             *         "rateLimit": {
             *           "enabled": true,
             *           "interval": 60,
             *           "limit": 1000,
             *           "mode": "approximate"
             *         }
             *       }
             *     ]
             */
            pricingPlans: components["schemas"]["PricingPlan"][];
            /**
             * @description Optional list of billing intervals to enable in the pricingPlans.
             *
             *     Defaults to a single monthly interval `['month']`.
             *
             *     To add support for annual pricing plans, for example, you can use: `['month', 'year']`.
             * @default [
             *       "month"
             *     ]
             */
            pricingIntervals: components["schemas"]["PricingInterval"][];
            defaultRateLimit?: components["schemas"]["RateLimit"] & unknown;
            project?: unknown;
        };
        TeamMember: {
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            userId: string;
            teamSlug: string;
            teamId: string;
            /** @enum {string} */
            role: "user" | "admin";
            confirmed: boolean;
            confirmedAt?: string;
        };
        /** @description A Consumer represents a user who has subscribed to a Project and is used
         *     to track usage and billing.
         *
         *     Consumers are linked to a corresponding Stripe Customer and Subscription.
         *     The Stripe customer will either be the user's default Stripe Customer if the
         *     project uses the default Agentic platform account, or a customer on the project
         *     owner's connected Stripe account if the project has Stripe Connect enabled. */
        Consumer: {
            /** @description Consumer id (e.g. "csmr_tz4a98xxat96iws9zmbrgj3a") */
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            token: string;
            plan?: string;
            activated: boolean;
            source?: string;
            /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
            userId: string;
            /** @description Project id (e.g. "proj_tz4a98xxat96iws9zmbrgj3a") */
            projectId: string;
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            deploymentId: string;
            stripeStatus: string;
            isStripeSubscriptionActive: boolean;
            user?: components["schemas"]["User"];
            project?: components["schemas"]["Project"];
            deployment?: unknown;
        };
        /** @description Origin adapter is used to configure the origin API server downstream from Agentic's API gateway. It specifies whether the origin API server denoted by `url` is hosted externally or deployed internally to Agentic's infrastructure. It also specifies the format for how origin tools are defined: either an OpenAPI spec or an MCP server.
         *
         *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so. */
        OriginAdapterConfig: {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "openapi";
            /** @description Local file path, URL, or JSON stringified OpenAPI spec describing the origin API server. */
            spec: string;
        } | {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "mcp";
            headers?: {
                [key: string]: string;
            };
        } | {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "raw";
        };
        AdminConsumer: {
            /** @description Consumer id (e.g. "csmr_tz4a98xxat96iws9zmbrgj3a") */
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            token: string;
            plan?: string;
            activated: boolean;
            source?: string;
            /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
            userId: string;
            /** @description Project id (e.g. "proj_tz4a98xxat96iws9zmbrgj3a") */
            projectId: string;
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            deploymentId: string;
            stripeStatus: string;
            isStripeSubscriptionActive: boolean;
            user?: components["schemas"]["User"];
            project?: components["schemas"]["Project"];
            deployment?: unknown;
            _stripeCustomerId: string;
        };
        /** @description Origin adapter is used to configure the origin API server downstream from Agentic's API gateway. It specifies whether the origin API server denoted by `url` is hosted externally or deployed internally to Agentic's infrastructure. It also specifies the format for how origin tools are defined: either an OpenAPI spec, an MCP server, or a raw HTTP REST API. */
        OriginAdapter: {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "openapi";
            /** @description JSON stringified OpenAPI spec describing the origin API server. */
            spec: string;
            /** @description Mapping from tool name to OpenAPI Operation info. This is used by the Agentic API gateway to route tools to the correct origin API operation, along with the HTTP method, path, params, etc. */
            toolToOperationMap: {
                [key: string]: {
                    /** @description OpenAPI operationId for the tool */
                    operationId: string;
                    /** @description HTTP method */
                    method: "get" | "put" | "post" | "delete" | "patch" | "trace";
                    /** @description HTTP path template */
                    path: string;
                    /** @description Mapping from parameter name to HTTP source (query, path, JSON body, etc). */
                    parameterSources: {
                        [key: string]: "query" | "header" | "path" | "cookie" | "body" | "formData";
                    };
                    tags?: string[];
                };
            };
        } | {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "mcp";
            headers?: {
                [key: string]: string;
            };
            serverInfo: {
                name: string;
                version: string;
                capabilities?: {
                    experimental?: Record<string, never>;
                    logging?: Record<string, never>;
                    completions?: Record<string, never>;
                    prompts?: {
                        listChanged?: boolean;
                    };
                    resources?: {
                        subscribe?: boolean;
                        listChanged?: boolean;
                    };
                    tools?: {
                        listChanged?: boolean;
                    };
                };
                instructions?: string;
            };
        } | {
            /**
             * @default external
             * @enum {string}
             */
            location: "external";
            /**
             * Format: uri
             * @description Required base URL of the externally hosted origin API server. Must be a valid `https` URL.
             *
             *     NOTE: Agentic currently only supports `external` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.
             */
            url: string;
            /** @enum {string} */
            type: "raw";
        };
        AdminDeployment: {
            /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
            id: string;
            createdAt: string;
            updatedAt: string;
            deletedAt?: string;
            identifier: components["schemas"]["DeploymentIdentifier"];
            hash: string;
            /** @description Optional semantic version of the project as a semver string. Ex: 1.0.0, 0.0.1, 5.0.1, etc. */
            version?: string;
            published: boolean;
            /** @description Display name for the project. Max length 1024 characters. */
            name: string;
            /** @description A short description of the project. */
            description?: string;
            /** @description Optional markdown readme documenting the project (supports GitHub-flavored markdown). */
            readme?: string;
            /** @description Optional logo image URL to use for the project. Logos should have a square aspect ratio. */
            iconUrl?: string;
            /**
             * Format: uri
             * @description Optional URL to the source code of the project (eg, GitHub repo).
             */
            sourceUrl?: string;
            /**
             * Format: uri
             * @description Optional URL to the product's homepage.
             */
            homepageUrl?: string;
            /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
            userId: string;
            /** @description Team id (e.g. "team_tz4a98xxat96iws9zmbrgj3a") */
            teamId?: string;
            /** @description Project id (e.g. "proj_tz4a98xxat96iws9zmbrgj3a") */
            projectId: string;
            /** @default [] */
            tools: components["schemas"]["Tool"][];
            /** @default [] */
            toolConfigs: components["schemas"]["ToolConfig"][];
            /**
             * @description List of PricingPlans configuring which Stripe subscriptions should be available for the project. Defaults to a single free plan which is useful for developing and testing your project.
             * @default [
             *       {
             *         "name": "Free",
             *         "slug": "free",
             *         "lineItems": [
             *           {
             *             "slug": "base",
             *             "usageType": "licensed",
             *             "amount": 0
             *           }
             *         ],
             *         "rateLimit": {
             *           "enabled": true,
             *           "interval": 60,
             *           "limit": 1000,
             *           "mode": "approximate"
             *         }
             *       }
             *     ]
             */
            pricingPlans: components["schemas"]["PricingPlan"][];
            /**
             * @description Optional list of billing intervals to enable in the pricingPlans.
             *
             *     Defaults to a single monthly interval `['month']`.
             *
             *     To add support for annual pricing plans, for example, you can use: `['month', 'year']`.
             * @default [
             *       "month"
             *     ]
             */
            pricingIntervals: components["schemas"]["PricingInterval"][];
            defaultRateLimit?: components["schemas"]["RateLimit"] & unknown;
            project?: unknown;
            origin: components["schemas"]["OriginAdapter"];
            _secret: string;
        };
    };
    responses: {
        /** @description Bad Request */
        400: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
        /** @description Unauthorized */
        401: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
        /** @description Forbidden */
        403: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
        /** @description Not Found */
        404: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
        /** @description Conflict */
        409: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
        /** @description Gone */
        410: {
            headers: {
                [name: string]: unknown;
            };
            content: {
                "application/json": {
                    error: string;
                    requestId: string;
                };
            };
        };
    };
    parameters: never;
    requestBodies: never;
    headers: never;
    pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
    healthCheck: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        status: string;
                    };
                };
            };
        };
    };
    signInWithPassword: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** Format: email */
                    email: string;
                    password: string;
                };
            };
        };
        responses: {
            /** @description An auth session */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AuthSession"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    signUpWithPassword: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    username: string;
                    /** Format: email */
                    email: string;
                    password: string;
                };
            };
        };
        responses: {
            /** @description An auth session */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AuthSession"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    exchangeOAuthCodeWithGitHub: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    code: string;
                };
            };
        };
        responses: {
            /** @description An auth session */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AuthSession"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    initGitHubOAuthFlow: {
        parameters: {
            query: {
                redirect_uri: string;
                client_id?: string;
                scope?: string;
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description Redirected to GitHub */
            302: {
                headers: {
                    [name: string]: unknown;
                };
                content?: never;
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    listPublicProjects: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
                tag?: string;
                notTag?: string;
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of projects */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"][];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    getPublicProjectByIdentifier: {
        parameters: {
            query: {
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
                /** @description Public project identifier (e.g. "@namespace/project-slug") */
                projectIdentifier: components["schemas"]["ProjectIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getPublicProject: {
        parameters: {
            query?: {
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
            };
            header?: never;
            path: {
                /** @description Project ID */
                projectId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getPublicDeploymentByIdentifier: {
        parameters: {
            query: {
                populate?: ("user" | "team" | "project") | ("user" | "team" | "project")[];
                /** @description Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}") */
                deploymentIdentifier: components["schemas"]["DeploymentIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getUser: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description User ID */
                userId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A user object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["User"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    updateUser: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description User ID */
                userId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    name?: string;
                    bio?: string;
                    image?: string;
                };
            };
        };
        responses: {
            /** @description A user object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["User"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    listTeams: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of teams */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": (components["schemas"]["Team"] & {
                        id: string;
                        createdAt: string;
                        updatedAt: string;
                        deletedAt?: string;
                        slug: string;
                        name: string;
                        ownerId: string;
                    })[];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    createTeam: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    deletedAt?: string;
                    slug: string;
                    name: string;
                };
            };
        };
        responses: {
            /** @description The created team */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Team"] & {
                        id: string;
                        createdAt: string;
                        updatedAt: string;
                        deletedAt?: string;
                        slug: string;
                        name: string;
                        ownerId: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    getTeam: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A team object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Team"] & {
                        id: string;
                        createdAt: string;
                        updatedAt: string;
                        deletedAt?: string;
                        slug: string;
                        name: string;
                        ownerId: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    updateTeam: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    name?: string;
                    /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
                    ownerId: string;
                };
            };
        };
        responses: {
            /** @description The updated team */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Team"] & {
                        id: string;
                        createdAt: string;
                        updatedAt: string;
                        deletedAt?: string;
                        slug: string;
                        name: string;
                        ownerId: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    deleteTeam: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description The team that was deleted */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Team"] & {
                        id: string;
                        createdAt: string;
                        updatedAt: string;
                        deletedAt?: string;
                        slug: string;
                        name: string;
                        ownerId: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    createTeamMember: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** @description User id (e.g. "user_tz4a98xxat96iws9zmbrgj3a") */
                    userId: string;
                    /** @enum {string} */
                    role?: "user" | "admin";
                };
            };
        };
        responses: {
            /** @description The created team member */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["TeamMember"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
        };
    };
    updateTeamMember: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
                /** @description Team member user ID */
                userId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** @enum {string} */
                    role?: "user" | "admin";
                };
            };
        };
        responses: {
            /** @description The updated team member */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["TeamMember"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    deleteTeamMember: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Team ID */
                teamId: string;
                /** @description Team member user ID */
                userId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description The deleted team member */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["TeamMember"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getSignedStorageUploadUrl: {
        parameters: {
            query: {
                /** @description Public project identifier (e.g. "@namespace/project-slug") */
                projectIdentifier: components["schemas"]["ProjectIdentifier"];
                /** @description Should be a hash of the contents of the file to upload with the correct file extension (eg, "9f86d081884c7d659a2feaa0c55ad015a.png"). */
                key: string;
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A signed upload URL */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /**
                         * Format: uri
                         * @description The signed upload URL.
                         */
                        signedUploadUrl: string;
                        /**
                         * Format: uri
                         * @description The public URL the object will have once uploaded.
                         */
                        publicObjectUrl: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    listProjects: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of projects */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"][];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    createProject: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** @description Display name for the project. Max length 1024 characters. */
                    name: string;
                    /** @description Unique project slug. Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. If not provided, it will be derived by slugifying `name`. */
                    slug?: string;
                };
            };
        };
        responses: {
            /** @description The created project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    getProjectByIdentifier: {
        parameters: {
            query: {
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
                /** @description Public project identifier (e.g. "@namespace/project-slug") */
                projectIdentifier: components["schemas"]["ProjectIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getProject: {
        parameters: {
            query?: {
                populate?: ("user" | "team" | "lastPublishedDeployment" | "lastDeployment") | ("user" | "team" | "lastPublishedDeployment" | "lastDeployment")[];
            };
            header?: never;
            path: {
                /** @description Project ID */
                projectId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    updateProject: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Project ID */
                projectId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    name?: string;
                };
            };
        };
        responses: {
            /** @description The updated project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Project"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getConsumerByProjectIdentifier: {
        parameters: {
            query: {
                /** @description Public project identifier (e.g. "@namespace/project-slug") */
                projectIdentifier: components["schemas"]["ProjectIdentifier"];
                populate?: ("user" | "project" | "deployment") | ("user" | "project" | "deployment")[];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    createBillingPortalSession: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A billing portal session URL */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** Format: uri */
                        url: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    getConsumer: {
        parameters: {
            query?: {
                populate?: ("user" | "project" | "deployment") | ("user" | "project" | "deployment")[];
            };
            header?: never;
            path: {
                /** @description Consumer ID */
                consumerId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    updateConsumer: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Consumer ID */
                consumerId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    plan?: string;
                    /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
                    deploymentId?: string;
                };
            };
        };
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    listConsumers: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
                populate?: ("user" | "project" | "deployment") | ("user" | "project" | "deployment")[];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of consumers */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"][];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    createConsumer: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    plan: string;
                    source?: string;
                    /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
                    deploymentId?: string;
                };
            };
        };
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    createConsumerCheckoutSession: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    plan: string;
                    source?: string;
                    /** @description Deployment id (e.g. "depl_tz4a98xxat96iws9zmbrgj3a") */
                    deploymentId?: string;
                };
            };
        };
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        checkoutSession: {
                            id: string;
                            /** Format: uri */
                            url: string;
                        };
                        consumer: components["schemas"]["Consumer"];
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    createConsumerBillingPortalSession: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Consumer ID */
                consumerId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A billing portal session URL */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** Format: uri */
                        url: string;
                    };
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    refreshConsumerApiKey: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Consumer ID */
                consumerId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    listConsumersForProject: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
                populate?: ("user" | "project" | "deployment") | ("user" | "project" | "deployment")[];
            };
            header?: never;
            path: {
                /** @description Project ID */
                projectId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of consumers subscribed to the given project */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Consumer"][];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getDeploymentByIdentifier: {
        parameters: {
            query: {
                populate?: ("user" | "team" | "project") | ("user" | "team" | "project")[];
                /** @description Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}") */
                deploymentIdentifier: components["schemas"]["DeploymentIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    getDeployment: {
        parameters: {
            query?: {
                populate?: ("user" | "team" | "project") | ("user" | "team" | "project")[];
            };
            header?: never;
            path: {
                /** @description deployment ID */
                deploymentId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    updateDeployment: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description deployment ID */
                deploymentId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    deletedAt?: string;
                    description?: string;
                };
            };
        };
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    listDeployments: {
        parameters: {
            query?: {
                offset?: number | null;
                limit?: number;
                sort?: "asc" | "desc";
                sortBy?: "createdAt" | "updatedAt";
                populate?: ("user" | "team" | "project") | ("user" | "team" | "project")[];
                /** @description Public project identifier (e.g. "@namespace/project-slug") */
                projectIdentifier?: components["schemas"]["ProjectIdentifier"];
                /** @description Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}") */
                deploymentIdentifier?: components["schemas"]["DeploymentIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description A list of deployments */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"][];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
        };
    };
    createDeployment: {
        parameters: {
            query?: {
                publish?: "true" | "false";
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /** @description Display name for the project. Max length 1024 characters. */
                    name: string;
                    /** @description Unique project slug. Must be ascii-only, lower-case, and kebab-case with no spaces between 1 and 256 characters. If not provided, it will be derived by slugifying `name`. */
                    slug?: string;
                    /** @description Optional semantic version of the project as a semver string. Ex: 1.0.0, 0.0.1, 5.0.1, etc. */
                    version?: string;
                    /** @description A short description of the project. */
                    description?: string;
                    /** @description Optional markdown readme documenting the project (supports GitHub-flavored markdown). */
                    readme?: string;
                    /** @description Optional logo image to use for the project. Logos should have a square aspect ratio. */
                    icon?: string;
                    /**
                     * Format: uri
                     * @description Optional URL to the source code of the project (eg, GitHub repo).
                     */
                    sourceUrl?: string;
                    /**
                     * Format: uri
                     * @description Optional URL to the product's homepage.
                     */
                    homepageUrl?: string;
                    origin: components["schemas"]["OriginAdapterConfig"];
                    /**
                     * @description List of PricingPlans configuring which Stripe subscriptions should be available for the project. Defaults to a single free plan which is useful for developing and testing your project.
                     * @default [
                     *       {
                     *         "name": "Free",
                     *         "slug": "free",
                     *         "lineItems": [
                     *           {
                     *             "slug": "base",
                     *             "usageType": "licensed",
                     *             "amount": 0
                     *           }
                     *         ],
                     *         "rateLimit": {
                     *           "enabled": true,
                     *           "interval": 60,
                     *           "limit": 1000,
                     *           "mode": "approximate"
                     *         }
                     *       }
                     *     ]
                     */
                    pricingPlans?: components["schemas"]["PricingPlan"][];
                    /**
                     * @description Optional list of billing intervals to enable in the pricingPlans.
                     *
                     *     Defaults to a single monthly interval `['month']`.
                     *
                     *     To add support for annual pricing plans, for example, you can use: `['month', 'year']`.
                     * @default [
                     *       "month"
                     *     ]
                     */
                    pricingIntervals?: components["schemas"]["PricingInterval"][];
                    defaultRateLimit?: components["schemas"]["RateLimit"] & unknown;
                    /** @default [] */
                    toolConfigs?: components["schemas"]["ToolConfig"][];
                };
            };
        };
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
        };
    };
    publishDeployment: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description deployment ID */
                deploymentId: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    version: string;
                };
            };
        };
        responses: {
            /** @description A deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["Deployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    adminGetConsumerByApiKey: {
        parameters: {
            query?: {
                populate?: ("user" | "project" | "deployment") | ("user" | "project" | "deployment")[];
            };
            header?: never;
            path: {
                /** @description Consumer API key */
                apiKey: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description An admin consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AdminConsumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
    adminActivateConsumer: {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Consumer ID */
                consumerId: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description An admin consumer object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AdminConsumer"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
            409: components["responses"]["409"];
            410: components["responses"]["410"];
        };
    };
    adminGetDeploymentByIdentifier: {
        parameters: {
            query: {
                populate?: ("user" | "team" | "project") | ("user" | "team" | "project")[];
                /** @description Public deployment identifier (e.g. "@namespace/project-slug@{hash|version|latest}") */
                deploymentIdentifier: components["schemas"]["DeploymentIdentifier"];
            };
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description An admin deployment object */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["AdminDeployment"];
                };
            };
            400: components["responses"]["400"];
            401: components["responses"]["401"];
            403: components["responses"]["403"];
            404: components["responses"]["404"];
        };
    };
}


================================================
FILE: packages/types/src/origin-adapter.ts
================================================
import { z } from '@hono/zod-openapi'

import { mcpServerInfoSchema } from './mcp'
import { toolNameSchema } from './tools'

export const originAdapterLocationSchema = z.literal('external')
// z.union([
//   z.literal('external'),
//   z.literal('internal')
// ])
export type OriginAdapterLocation = z.infer<typeof originAdapterLocationSchema>

// export const originAdapterInternalTypeSchema = z.union([
//   z.literal('docker'),
//   z.literal('mcp'),
//   z.literal('python-fastapi'),
//   // etc
// ])
// export type OriginAdapterInternalType = z.infer<
//   typeof originAdapterInternalTypeSchema
// >

export const commonOriginAdapterSchema = z.object({
  location: originAdapterLocationSchema.optional().default('external'),

  /** Required origin API HTTPS base URL */
  url: z.string().url()
    .describe(`Required base URL of the externally hosted origin API server. Must be a valid \`https\` URL.

NOTE: Agentic currently only supports \`external\` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.`)

  // TODO: Add support for `internal` hosted API servers
  // internalType: originAdapterInternalTypeSchema.optional()
})

// TODO: add future support for:
// - external mcp
// - internal docker
// - internal mcp
// - internal http
// - etc

export const openapiOriginAdapterConfigSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * OpenAPI 3.x spec describing the origin API server.
     */
    type: z.literal('openapi'),

    /**
     * Local file path, URL, or JSON stringified OpenAPI spec describing the
     * origin API server.
     *
     * Must be a 3.x OpenAPI spec (older versions are not supported).
     */
    spec: z
      .string()
      .describe(
        'Local file path, URL, or JSON stringified OpenAPI spec describing the origin API server.'
      )
  })
)
export type OpenAPIOriginAdapterConfig = z.infer<
  typeof openapiOriginAdapterConfigSchema
>

export const mcpOriginAdapterConfigSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * MCP server.
     */
    type: z.literal('mcp'),

    // Optional headers to pass to the origin API server
    headers: z.record(z.string(), z.string()).optional()
  })
)
export type MCPOriginAdapterConfig = z.infer<
  typeof mcpOriginAdapterConfigSchema
>

// TODO: Decide on whether to support `raw` origin adapters or not.
export const rawOriginAdapterConfigSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * Marks the origin server as a raw HTTP REST API without any additional
     * tool or service definitions.
     *
     * In this mode, Agentic's API gateway acts as a simple reverse-proxy
     * to the origin server, without validating tools.
     */
    type: z.literal('raw')
  })
)
export type RawOriginAdapterConfig = z.infer<
  typeof rawOriginAdapterConfigSchema
>

/**
 * Origin adapter is used to configure the origin API server downstream from
 * Agentic's API gateway. It specifies whether the origin API server denoted
 * by `url` is hosted externally or deployed internally to Agentic's
 * infrastructure. It also specifies the format for how origin tools are
 * defined: either an OpenAPI spec or an MCP server.
 *
 * NOTE: Agentic currently only supports `external` API servers. If you'd like
 * to host your API or MCP server on Agentic's infrastructure, please reach out
 * to support@agentic.so.
 */
export const originAdapterConfigSchema = z
  .discriminatedUnion('type', [
    openapiOriginAdapterConfigSchema,

    mcpOriginAdapterConfigSchema,

    rawOriginAdapterConfigSchema
  ])
  .describe(
    `Origin adapter is used to configure the origin API server downstream from Agentic's API gateway. It specifies whether the origin API server denoted by \`url\` is hosted externally or deployed internally to Agentic's infrastructure. It also specifies the format for how origin tools are defined: either an OpenAPI spec or an MCP server.

NOTE: Agentic currently only supports \`external\` API servers. If you'd like to host your API or MCP server on Agentic's infrastructure, please reach out to support@agentic.so.`
  )
  .openapi('OriginAdapterConfig')
export type OriginAdapterConfig = z.infer<typeof originAdapterConfigSchema>

export const openapiOperationParameterSourceSchema = z.union([
  z.literal('query'),
  z.literal('header'),
  z.literal('path'),
  z.literal('cookie'),
  z.literal('body'),
  z.literal('formData')
])
export type OpenAPIOperationParameterSource = z.infer<
  typeof openapiOperationParameterSourceSchema
>

export const openapiOperationHttpMethodSchema = z.union([
  z.literal('get'),
  z.literal('put'),
  z.literal('post'),
  z.literal('delete'),
  z.literal('patch'),
  z.literal('trace')
])
export type OpenAPIOperationHttpMethod = z.infer<
  typeof openapiOperationHttpMethodSchema
>

export const openapiToolOperationSchema = z.object({
  operationId: z.string().describe('OpenAPI operationId for the tool'),
  method: openapiOperationHttpMethodSchema.describe('HTTP method'),
  path: z.string().describe('HTTP path template'),
  parameterSources: z
    .record(z.string(), openapiOperationParameterSourceSchema)
    .describe(
      'Mapping from parameter name to HTTP source (query, path, JSON body, etc).'
    ),
  tags: z.array(z.string()).optional()
})
export type OpenAPIToolOperation = z.infer<typeof openapiToolOperationSchema>

export const openapiOriginAdapterSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * OpenAPI 3.x spec describing the origin API server.
     */
    type: z.literal('openapi'),

    /**
     * JSON stringified OpenAPI spec describing the origin API server.
     *
     * The origin API servers are be hidden in the embedded OpenAPI spec,
     * because clients should only be aware of the upstream Agentic API
     * gateway.
     */
    spec: z
      .string()
      .describe(
        'JSON stringified OpenAPI spec describing the origin API server.'
      ),

    /**
     * Mapping from tool name to OpenAPI Operation info.
     *
     * This is used by the Agentic API gateway to route tools to the correct
     * origin API operation, along with the HTTP method, path, params, etc.
     *
     * @internal
     */
    toolToOperationMap: z
      .record(toolNameSchema, openapiToolOperationSchema)
      .describe(
        'Mapping from tool name to OpenAPI Operation info. This is used by the Agentic API gateway to route tools to the correct origin API operation, along with the HTTP method, path, params, etc.'
      )
  })
)
export type OpenAPIOriginAdapter = z.infer<typeof openapiOriginAdapterSchema>

export const mcpOriginAdapterSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * MCP server.
     */
    type: z.literal('mcp'),

    // Optional headers to pass to the origin API server
    headers: z.record(z.string(), z.string()).optional(),

    /**
     * MCP server info: name, version, capabilities, instructions, etc.
     */
    serverInfo: mcpServerInfoSchema
  })
)
export type MCPOriginAdapter = z.infer<typeof mcpOriginAdapterSchema>

export const rawOriginAdapterSchema = commonOriginAdapterSchema.merge(
  z.object({
    /**
     * Marks the origin server as a raw HTTP REST API without any additional
     * tool or service definitions.
     *
     * In this mode, Agentic's API gateway acts as a simple reverse-proxy
     * to the origin server, without validating tools.
     *
     * @note This mode is currently only for internal testing.
     */
    type: z.literal('raw')
  })
)
export type RawOriginAdapter = z.infer<typeof rawOriginAdapterSchema>

/**
 * Origin adapter is used to configure the origin API server downstream from
 * Agentic's API gateway. It specifies whether the origin API server denoted
 * by `url` is hosted externally or deployed internally to Agentic's
 * infrastructure.
 *
 * It also specifies the format for how origin tools are defined: either an
 * OpenAPI spec or an MCP server.
 *
 * @note Currently, only external origin servers are supported. If you'd like
 * to host your API or MCP server on Agentic's infrastructure, please reach
 * out to support@agentic.so.
 */
export const originAdapterSchema = z
  .discriminatedUnion('type', [
    openapiOriginAdapterSchema,

    mcpOriginAdapterSchema,

    rawOriginAdapterSchema
  ])
  .describe(
    `Origin adapter is used to configure the origin API server downstream from Agentic's API gateway. It specifies whether the origin API server denoted by \`url\` is hosted externally or deployed internally to Agentic's infrastructure. It also specifies the format for how origin tools are defined: either an OpenAPI spec, an MCP server, or a raw HTTP REST API.`
  )
  .openapi('OriginAdapter')
export type OriginAdapter = z.infer<typeof originAdapterSchema>


================================================
FILE: packages/types/src/pricing.test.ts
================================================
import { assert, expectTypeOf, test } from 'vitest'

import type {
  CustomPricingPlanLineItemSlug,
  PricingPlanLineItem,
  PricingPlanList
} from './pricing'

test('PricingPlanLineItem "base" type', () => {
  expectTypeOf({
    slug: 'base',
    usageType: 'licensed',
    amount: 100
  } as const).toExtend<PricingPlanLineItem>()

  expectTypeOf<{
    slug: 'base'
    usageType: 'licensed'
    amount: number
  }>().toExtend<PricingPlanLineItem>()
})

test('PricingPlanLineItem "requests" per-unit type', () => {
  expectTypeOf({
    slug: 'requests',
    usageType: 'metered',
    billingScheme: 'per_unit',
    unitAmount: 100
  } as const).toExtend<PricingPlanLineItem>()

  expectTypeOf<{
    slug: 'requests'
    usageType: 'metered'
    billingScheme: 'per_unit'
    unitAmount: number
  }>().toExtend<PricingPlanLineItem>()

  expectTypeOf({
    slug: 'requests',
    usageType: 'metered',
    billingScheme: 'per_unit'
    // invalid because `unitAmount` is required
  } as const).not.toExtend<PricingPlanLineItem>()

  expectTypeOf<{
    slug: 'requests'
    usageType: 'metered'
    billingScheme: 'per_unit'
    unitAmount?: number // invalid because `unitAmount` is required
  }>().not.toExtend<PricingPlanLineItem>()
})

test('PricingPlanLineItem "requests" tiered type', () => {
  expectTypeOf<{
    slug: 'requests'
    usageType: 'metered'
    billingScheme: 'tiered'
    tiersMode: 'volume'
    tiers: [
      {
        amount: 300
        upTo: 1000
      },
      {
        amount: 200
        upTo: 2000
      },
      {
        amount: 100
        upTo: 'inf'
      }
    ]
  }>().toExtend<PricingPlanLineItem>()
})

test('PricingPlanLineItem "custom" licensed type', () => {
  expectTypeOf({
    slug: 'custom-licensed',
    usageType: 'licensed',
    amount: 100
  } as const).toExtend<PricingPlanLineItem>()

  expectTypeOf<{
    slug: 'custom-licensed'
    usageType: 'licensed'
    amount: number
  }>().toExtend<PricingPlanLineItem>()
})

test('PricingPlanLineItem "custom" metered per-unit type', () => {
  expectTypeOf({
    slug: 'custom-test',
    usageType: 'metered',
    billingScheme: 'per_unit',
    unitAmount: 100
  } as const).toExtend<PricingPlanLineItem>()

  expectTypeOf<{
    slug: 'custom-test'
    usageType: 'metered'
    billingScheme: 'per_unit'
    unitAmount: number
  }>().toExtend<PricingPlanLineItem>()
})

test('PricingPlanLineItem "custom" metered tiered type', () => {
  expectTypeOf<{
    slug: 'custom-test'
    usageType: 'metered'
    billingScheme: 'tiered'
    tiersMode: 'volume'
    tiers: [
      {
        amount: 300
        upTo: 1000
      },
      {
        amount: 200
        upTo: 2000
      },
      {
        amount: 100
        upTo: 'inf'
      }
    ]
  }>().toExtend<PricingPlanLineItem>()
})

test('PricingPlanList type', () => {
  // Empty array should be invalid
  expectTypeOf<[]>().not.toExtend<PricingPlanList>()

  // Empty lineItems should be invalid
  expectTypeOf<
    [
      {
        name: 'Free'
        slug: 'free'
        lineItems: []
      }
    ]
  >().not.toExtend<PricingPlanList>()

  expectTypeOf<
    [
      {
        name: 'Free'
        slug: 'free'
        lineItems: [
          {
            slug: 'base'
            usageType: 'licensed'
            amount: 0
          }
        ]
      }
    ]
  >().toExtend<PricingPlanList>()
})

test('PricingPlanLineItem "base" type discrimination', () => {
  const foo: PricingPlanLineItem = {
    slug: 'base',
    usageType: 'licensed',
    amount: 100
  }

  expectTypeOf(foo).toExtend<PricingPlanLineItem>()

  // These should fail if `slug` is not differentiating correctly.
  expectTypeOf(foo).toExtend<{
    slug: 'base'
    usageType: 'licensed'
    amount: number
    label?: string
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    slug: 'base'
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    usageType: 'licensed'
  }>()
})

test('PricingPlanLineItem "requests" per-unit type discrimination', () => {
  const foo: PricingPlanLineItem = {
    slug: 'requests',
    usageType: 'metered',
    billingScheme: 'per_unit',
    unitAmount: 100
  }

  expectTypeOf(foo).toExtend<PricingPlanLineItem>()

  // These should fail if `slug` is not differentiating correctly.
  expectTypeOf<typeof foo>().toExtend<{
    slug: 'requests'
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    usageType: 'metered'
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    billingScheme: 'per_unit'
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    unitAmount: number
  }>()
})

test('PricingPlanLineItem "metered" type discrimination', () => {
  const foo = {
    usageType: 'metered'
  } as PricingPlanLineItem

  expectTypeOf(foo).toExtend<PricingPlanLineItem>()
  assert(foo.usageType === 'metered')

  // These should fail if `usageType` is not differentiating correctly.
  expectTypeOf<typeof foo>().toExtend<{
    slug: 'requests' | CustomPricingPlanLineItemSlug
  }>()
  expectTypeOf<typeof foo>().toExtend<{
    billingScheme: 'per_unit' | 'tiered'
  }>()
})


================================================
FILE: packages/types/src/pricing.ts
================================================
import type { Simplify } from 'type-fest'
import { z } from '@hono/zod-openapi'

import { type RateLimit, rateLimitSchema } from './rate-limit'

/**
 * PricingPlanTier is a single tier in a tiered pricing plan.
 */
export const pricingPlanTierSchema = z
  .object({
    unitAmount: z.number().optional(),
    flatAmount: z.number().optional(),
    upTo: z.union([z.number(), z.literal('inf')])
  })
  .refine(
    (data) =>
      (data.unitAmount !== undefined) !== (data.flatAmount !== undefined),
    {
      message: 'Either unitAmount or flatAmount must be provided, but not both'
    }
  )
  .openapi('PricingPlanTier')
export type PricingPlanTier = z.infer<typeof pricingPlanTierSchema>

/**
 * The frequency at which a subscription is billed.
 */
export const pricingIntervalSchema = z
  .union([
    z.literal('day'),
    z.literal('week'),
    z.literal('month'),
    z.literal('year')
  ])
  .describe('The frequency at which a subscription is billed.')
  .openapi('PricingInterval')
export type PricingInterval = z.infer<typeof pricingIntervalSchema>

/**
 * List of billing intervals for subscriptions.
 */
export const pricingIntervalListSchema = z
  .array(pricingIntervalSchema)
  .nonempty({
    message: 'Must contain at least one pricing interval'
  })
  .describe('List of billing intervals for subscriptions.')

/**
 * Internal PricingPlanLineItem hash
 *
 * @internal
 */
export const pricingPlanLineItemHashSchema = z
  .string()
  .nonempty()
  .describe('Internal PricingPlanLineItem hash')

/**
 * PricingPlanLineItem slug which acts as a unique lookup key for LineItems
 * across deployments. They must be lower and kebab-cased ("base", "requests",
 * "image-transformations", etc).
 */
export const pricingPlanLineItemSlugSchema = z
  .string()
  .nonempty()
  .describe(
    'PricingPlanLineItem slug which acts as a unique lookup key for LineItems across deployments. They must be lower and kebab-cased ("base", "requests", "image-transformations").'
  )

/**
 * PricingPlan slug which acts as a unique lookup key for PricingPlans across deployments. They must be lower and kebab-cased and should have the interval as a suffix ("free", "starter-monthly", "pro-annual").
 */
export const pricingPlanSlugSchema = z
  .string()
  .nonempty()
  .describe(
    'PricingPlan slug which acts as a unique lookup key for PricingPlans across deployments. They must be lower and kebab-cased and should have the interval as a suffix ("free", "starter-monthly", "pro-annual").'
  )

/**
 * Map from internal PricingPlanLineItem **hash** to Stripe Price id
 */
export const stripePriceIdMapSchema = z
  .record(pricingPlanLineItemHashSchema, z.string().describe('Stripe Price id'))
  .describe('Map from internal PricingPlanLineItem **hash** to Stripe Price id')
  .openapi('StripePriceIdMap')
export type StripePriceIdMap = z.infer<typeof stripePriceIdMapSchema>

/**
 * Map from internal PricingPlanLineItem **slug** to Stripe Meter id
 */
export const stripeMeterIdMapSchema = z
  .record(pricingPlanLineItemHashSchema, z.string().describe('Stripe Meter id'))
  .describe('Map from internal PricingPlanLineItem **slug** to Stripe Meter id')
  .openapi('StripeMeterIdMap')
export type StripeMeterIdMap = z.infer<typeof stripeMeterIdMapSchema>

// export const pricingPlanLineItemTypeSchema = z.union([
//   z.literal('base'),
//   z.literal('requests'),
//   z.literal('custom')
// ])
// export type PricingPlanLineItemType = z.infer<
//   typeof pricingPlanLineItemTypeSchema
// >
export type CustomPricingPlanLineItemSlug = `custom-${string}`

const commonPricingPlanLineItemSchema = z.object({
  /**
   * Slugs act as the primary key for LineItems. They should be lower-cased and
   * kebab-cased ("base", "requests", "image-transformations").
   *
   * The `base` slug is reserved for a plan's default `licensed` line-item.
   *
   * The `requests` slug is reserved for charging using `metered` billing based
   * on the number of request made during a given billing interval.
   *
   * All other PricingPlanLineItem `slugs` are considered custom LineItems.
   *
   * Should be stable across deployments, so if a slug refers to one type of
   * product / line-item / metric in one deployment, it should refer to the same
   * product / line-item / metric in future deployments, even if they are
   * configured differently. If you are switching between a licensed and metered
   * line-item across deployments, they must use different slugs.
   */
  slug: z.string(),

  /**
   * Optional label for the line-item which will be displayed on customer bills.
   *
   * If unset, the line-item's `slug` will be used as the label.
   */
  label: z.string().optional().openapi('label', { example: 'API calls' })
})

/**
 * Licensed LineItems are used to charge for fixed-price services.
 */
export const pricingPlanLicensedLineItemSchema =
  commonPricingPlanLineItemSchema.merge(
    z.object({
      /**
       * Licensed LineItems are used to charge for fixed-price services.
       */
      usageType: z.literal('licensed'),

      /**
       * The fixed amount to charge per billing interval.
       *
       * Specified in the smallest currency unit (e.g. cents for USD).
       *
       * So 100 = $1.00 USD, 1000 = $10.00 USD, etc.
       */
      amount: z.number().nonnegative()
    })
  )

/**
 * Metered LineItems are used to charge for usage-based services.
 */
export const pricingPlanMeteredLineItemSchema =
  commonPricingPlanLineItemSchema.merge(
    z.object({
      /**
       * Metered LineItems are used to charge for usage-based services.
       */
      usageType: z.literal('metered'),

      /**
       * Optional label for the line-item which will be displayed on customer
       * bills.
       *
       * If unset, the line-item's `slug` will be used as the unit label.
       */
      unitLabel: z.string().optional(),

      /**
       * Describes how to compute the price per period. Either `per_unit` or
       * `tiered`.
       *
       * `per_unit` indicates that the fixed amount (specified in
       * `unitAmount`) will be charged per unit of total usage.
       *
       * `tiered` indicates that the unit pricing will be computed using a
       * tiering strategy as defined using `tiers` and `tiersMode`.
       */
      billingScheme: z.union([z.literal('per_unit'), z.literal('tiered')]),

      /**
       * The fixed amount to charge per unit of usage.
       *
       * Only applicable for `per_unit` billing schemes.
       *
       * Specified in the smallest currency unit (e.g. cents for USD).
       *
       * So 100 = $1.00 USD, 1000 = $10.00 USD, etc.
       */
      unitAmount: z.number().nonnegative().optional(),

      // Only applicable for `tiered` billing schemes

      /**
       * Defines if the tiering price should be `graduated` or `volume` based.
       *
       * In `volume`-based tiering, the maximum quantity within a period
       * determines the per unit price.
       *
       * In `graduated`-based tiering, the per-unit price changes successively
       * as the quantity grows.
       *
       * This field requires `billingScheme` to be set to `tiered`.
       */
      tiersMode: z
        .union([z.literal('graduated'), z.literal('volume')])
        .optional(),

      /**
       * Pricing tiers for `tiered` billing schemes.
       *
       * This field requires `billingScheme` to be set to `tiered`.
       */
      tiers: z.array(pricingPlanTierSchema).nonempty().optional(),

      // TODO: add support for tiered rate limits?

      /**
       * The default settings to aggregate the Stripe Meter's events with.
       *
       * Deafults to `{ formula: 'sum' }`.
       */
      defaultAggregation: z
        .object({
          /**
           * Specifies how events are aggregated for a Stripe Meter.
           * Allowed values are `count` to count the number of events and `sum`
           * to sum each event's value .
           *
           * Defaults to `sum`.
           */
          formula: z
            .union([z.literal('sum'), z.literal('count')])
            .default('sum')
        })
        .optional(),

      /**
       * Optionally apply a transformation to the reported usage or set
       * quantity before computing the amount billed.
       *
       * Cannot be combined with `tiers`.
       */
      transformQuantity: z
        .object({
          /**
           * Divide usage by this number.
           *
           * Must be a positive number.
           */
          divideBy: z.number().positive(),

          /**
           * After division, either round the result `up` or `down`.
           */
          round: z.union([z.literal('down'), z.literal('up')])
        })
        .optional()
    })
  )

/**
 * PricingPlanLineItems represent a single line-item in a Stripe Subscription.
 *
 * They map to a Stripe billing `Price` and possibly a corresponding Stripe
 * `Meter` for metered usage.
 */
export const pricingPlanLineItemSchema = z
  .discriminatedUnion('usageType', [
    pricingPlanLicensedLineItemSchema,
    pricingPlanMeteredLineItemSchema
  ])
  .refine(
    (data) => {
      if (data.slug === 'base') {
        return data.usageType === 'licensed'
      }

      return true
    },
    (data) => ({
      message: `Invalid PricingPlanLineItem "${data.slug}": reserved "base" LineItems must have "licensed" usage type.`
    })
  )
  .refine(
    (data) => {
      if (data.slug === 'requests') {
        return data.usageType === 'metered'
      }

      return true
    },
    (data) => ({
      message: `Invalid PricingPlanLineItem "${data.slug}": reserved "requests" LineItems must have "metered" usage type.`
    })
  )
  .refine(
    (data) => {
      if (data.slug !== 'base' && data.slug !== 'requests') {
        return data.slug.startsWith('custom-')
      }

      return true
    },
    (data) => ({
      message: `Invalid PricingPlanLineItem "${data.slug}": custom line-item slugs must start with "custom-". This is required so that TypeScript can discriminate between custom and reserved line-items.`
    })
  )
  .describe(
    'PricingPlanLineItems represent a single line-item in a Stripe Subscription. They map to a Stripe billing `Price` and possibly a corresponding Stripe `Meter` for usage-based line-items.'
  )
  .openapi('PricingPlanLineItem')
// export type PricingPlanLineItem = z.infer<typeof pricingPlanLineItemSchema>

// These are more complex discriminated unions based on: `slug`, `usageType`,
// and `billingScheme`. That's why we're not using zod's inference directly
// for these types. See `./pricing.test.ts` for examples.
export type PricingPlanLineItemInput =
  // "base" licensed line-item
  | Simplify<
      {
        slug: 'base'
      } & z.input<typeof pricingPlanLicensedLineItemSchema>
    >
  // "custom" licensed line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'licensed'
      } & z.input<typeof pricingPlanLicensedLineItemSchema>
    >
  // "requests" metered per-unit line-item
  | Simplify<
      {
        slug: 'requests'
        usageType: 'metered'
        billingScheme: 'per_unit'
        unitAmount: number
      } & Omit<
        z.input<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'per_unit'
        },
        'tiers' | 'tiersMode'
      >
    >
  // "requests" metered tiered line-item
  | Simplify<
      {
        slug: 'requests'
        usageType: 'metered'
        billingScheme: 'tiered'
      } & Omit<
        z.input<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'tiered'
        },
        'unitAmount' | 'transformQuantity'
      >
    >
  // "custom" metered per-unit line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'metered'
        billingScheme: 'per_unit'
        unitAmount: number
      } & Omit<
        z.input<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'per_unit'
        },
        'tiers' | 'tiersMode'
      >
    >
  // "custom" metered tiered line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'metered'
        billingScheme: 'tiered'
      } & Omit<
        z.input<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'tiered'
        },
        'unitAmount' | 'transformQuantity'
      >
    >

export type PricingPlanLineItem =
  // "base" licensed line-item
  | Simplify<
      {
        slug: 'base'
      } & z.infer<typeof pricingPlanLicensedLineItemSchema>
    >
  // "custom" licensed line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'licensed'
      } & z.infer<typeof pricingPlanLicensedLineItemSchema>
    >
  // "requests" metered per-unit line-item
  | Simplify<
      {
        slug: 'requests'
        usageType: 'metered'
        billingScheme: 'per_unit'
        unitAmount: number
      } & Omit<
        z.infer<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'per_unit'
        },
        'tiers' | 'tiersMode'
      >
    >
  // "requests" metered tiered line-item
  | Simplify<
      {
        slug: 'requests'
        usageType: 'metered'
        billingScheme: 'tiered'
      } & Omit<
        z.infer<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'tiered'
        },
        'unitAmount' | 'transformQuantity'
      >
    >
  // "custom" metered per-unit line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'metered'
        billingScheme: 'per_unit'
        unitAmount: number
      } & Omit<
        z.infer<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'per_unit'
        },
        'tiers' | 'tiersMode'
      >
    >
  // "custom" metered tiered line-item
  | Simplify<
      {
        slug: CustomPricingPlanLineItemSlug
        usageType: 'metered'
        billingScheme: 'tiered'
      } & Omit<
        z.infer<typeof pricingPlanMeteredLineItemSchema> & {
          billingScheme: 'tiered'
        },
        'unitAmount' | 'transformQuantity'
      >
    >

/**
 * Represents the config for a single Stripe subscription plan with one or more
 * LineItems.
 */
export const pricingPlanSchema = z
  .object({
    /**
     * Display name for the pricing plan.
     *
     * Used in UI and billing invoices.
     *
     * @required
     * @example "Free"
     * @example "Starter Monthly"
     * @example "Pro Annual"
     */
    name: z
      .string()
      .nonempty()
      .describe(
        'Display name for the pricing plan (eg, "Free", "Starter Monthly", "Pro Annual", etc)'
      )
      .openapi('name', { example: 'Starter Monthly' }),

    /**
     * A unique slug for the pricing plan which acts as a stable identifier
     * across deployments.
     *
     * Should be lower-kebab-cased.
     * Should be stable across deployments.
     *
     * For all plans aside from `free`, the `slug` should include the `interval`
     * as a suffix so pricing plans can be uniquely differentiated from each
     * other across billing intervals.
     *
     * @required
     * @example "free"
     * @example "starter-monthly"
     * @example "pro-annual"
     */
    slug: z
      .string()
      .nonempty()
      .describe(
        'PricingPlan slug (eg, "free", "starter-monthly", "pro-annual", etc). Should be lower-cased and kebab-cased. Should be stable across deployments.'
      )
      // TODO: Make `slug` optional and derive it from `name` if not provided.
      .openapi('slug', { example: 'starter-monthly' }),

    /**
     * The frequency at which this subscription is billed.
     */
    interval: pricingIntervalSchema.optional(),

    /**
     * Optional description of the pricing plan (UI-only).
     */
    description: z.string().optional(),

    /**
     * Optional list of features of the pricing plan (UI-only).
     */
    features: z.array(z.string()).optional(),

    /**
     * Optional number of days for a free trial period when a customer signs up
     * for a new subscription.
     */
    trialPeriodDays: z.number().nonnegative().optional(),

    /**
     * Optional rate limit to enforce for this pricing plan.
     *
     * You can use this to limit the number of API requests that can be made by
     * a customer during a given interval.
     *
     * If not set, the pricing plan will inherit the default platform rate-limit
     * set by `defaultRateLimit` in the Agentic project config.
     *
     * You can disable rate-limiting for this pricing plan by setting
     * `rateLimit.enabled` to `false`.
     *
     * Note that tool-specific rate limits may override pricing-plan-specific
     * rate-limits via `toolConfigs` in the Agentic project config.
     */
    rateLimit: rateLimitSchema.optional(),

    /**
     * List of LineItems which are included in the PricingPlan.
     *
     * Note: Agentic currently supports a max of 20 LineItems per pricing plan.
     */
    lineItems: z.array(pricingPlanLineItemSchema).nonempty().max(20, {
      message:
        'Agentic currently supports a max of 20 LineItems per pricing plan.'
    })
  })
  .describe(
    'Represents the config for a Stripe subscription with one or more PricingPlanLineItems.'
  )
  .openapi('PricingPlan')
// export type PricingPlan = z.infer<typeof pricingPlanSchema>

export type PricingPlanInput = Simplify<
  Omit<z.input<typeof pricingPlanSchema>, 'lineItems'> & {
    lineItems: [PricingPlanLineItemInput, ...PricingPlanLineItemInput[]]
  }
>

export type PricingPlan = Simplify<
  Omit<z.infer<typeof pricingPlanSchema>, 'lineItems'> & {
    lineItems: [PricingPlanLineItem, ...PricingPlanLineItem[]]
  }
>

/**
 * Map from PricingPlanLineItem **slug** to Stripe Product id
 */
export const stripeProductIdMapSchema = z
  .record(
    pricingPlanLineItemSlugSchema,
    z.string().describe('Stripe Product id')
  )
  .describe('Map from PricingPlanLineItem **slug** to Stripe Product id')
  .openapi('StripeProductIdMap')
export type StripeProductIdMap = z.infer<typeof stripeProductIdMapSchema>

/**
 * List of PricingPlans
 */
export const pricingPlanListSchema = z
  .array(pricingPlanSchema)
  .nonempty({
    message: 'Must contain at least one PricingPlan'
  })
  .describe('List of PricingPlans')
export type PricingPlanListInput = [PricingPlanInput, ...PricingPlanInput[]]
export type PricingPlanList = [PricingPlan, ...PricingPlan[]]

/**
 * Map from internal PricingPlanLineItem **slug** to Stripe Subscription Item id
 */
export const stripeSubscriptionItemIdMapSchema = z
  .record(
    pricingPlanLineItemSlugSchema,
    z.string().describe('Stripe Subscription Item id')
  )
  .describe(
    'Map from internal PricingPlanLineItem **slug** to Stripe Subscription Item id'
  )
  .openapi('StripeSubscriptionItemIdMap')
export type StripeSubscriptionItemIdMap = z.infer<
  typeof stripeSubscriptionItemIdMapSchema
>

// export const couponSchema = z
//   .object({
//     // used to uniquely identify this coupon across deployments
//     id: z.string(),

//     valid: z.boolean(),
//     stripeCoupon: z.string(),

//     name: z.string().optional(),

//     currency: z.string().optional(),
//     amount_off: z.number().optional(),
//     percent_off: z.number().optional(),

//     duration: z.string(),
//     duration_in_months: z.number().optional(),

//     redeem_by: z.date().optional(),
//     max_redemptions: z.number().optional()
//   })
//   .openapi('Coupon')
// export type Coupon = z.infer<typeof couponSchema>

/**
 * The default platform rate limit for `requests` is a limit of 1000 requests
 * per minute per customer.
 */
export const defaultRequestsRateLimit = {
  enabled: true,
  interval: 60,
  limit: 1000,
  mode: 'approximate'
} as const satisfies Readonly<RateLimit>

/**
 * The default free pricing plan which is used for projects that don't specify
 * custom pricing plans.
 */
export const defaultFreePricingPlan = {
  name: 'Free',
  slug: 'free',
  lineItems: [
    {
      slug: 'base',
      usageType: 'licensed',
      amount: 0
    }
  ],
  rateLimit: defaultRequestsRateLimit
} as const satisfies Readonly<PricingPlan>


================================================
FILE: packages/types/src/rate-limit.test.ts
================================================
import { expect, expectTypeOf, test } from 'vitest'

import {
  type RateLimit,
  type RateLimitInput,
  rateLimitSchema
} from './rate-limit'

test('rateLimitSchema valid', () => {
  expect(
    rateLimitSchema.parse({
      interval: 10,
      limit: 100
    })
  ).toMatchSnapshot()

  expect(
    rateLimitSchema.parse({
      interval: '10s',
      limit: 100
    })
  ).toMatchSnapshot()

  expect(
    rateLimitSchema.parse({
      interval: '1 day',
      limit: 1000,
      mode: 'strict'
    })
  ).toMatchSnapshot()

  expect(
    rateLimitSchema.parse({
      enabled: false
    })
  ).toMatchSnapshot()

  expect(
    rateLimitSchema.parse({
      interval: '10m',
      limit: 100,
      mode: 'strict',
      enabled: false
    })
  ).toMatchSnapshot()
})

test('rateLimitSchema invalid', () => {
  expect(() =>
    rateLimitSchema.parse({
      interval: '',
      limit: 5
    })
  ).toThrowErrorMatchingSnapshot()

  expect(() =>
    rateLimitSchema.parse({
      interval: 0,
      limit: 5
    })
  ).toThrowErrorMatchingSnapshot()

  expect(() =>
    rateLimitSchema.parse({
      interval: '--',
      limit: 10
    })
  ).toThrowErrorMatchingSnapshot()

  expect(() =>
    rateLimitSchema.parse({
      interval: '1 day',
      limit: -1000
    })
  ).toThrowErrorMatchingSnapshot()
})

test('RateLimit types', () => {
  expectTypeOf({
    interval: 10,
    limit: 100,
    mode: 'approximate',
    enabled: true
  } as const).toExtend<RateLimit>()

  expectTypeOf<{
    interval: 10
    limit: 100
    mode: 'strict'
    enabled: true
  }>().toExtend<RateLimit>()

  expectTypeOf({
    interval: '10s',
    limit: 100,
    mode: 'strict',
    enabled: true
  } as const).not.toExtend<RateLimit>()

  expectTypeOf<{
    interval: '10s'
    limit: 100
    mode: 'strict'
  }>().not.toExtend<RateLimit>()

  expectTypeOf({
    enabled: false
  } as const).toExtend<RateLimit>()

  expectTypeOf<{
    enabled: false
  }>().toExtend<RateLimit>()
})

test('RateLimitInput types', () => {
  expectTypeOf({
    interval: 10,
    limit: 100
  } as const).toExtend<RateLimitInput>()

  expectTypeOf<{
    interval: 10
    limit: 100
  }>().toExtend<RateLimitInput>()

  expectTypeOf({
    interval: 10,
    limit: 100,
    mode: 'strict'
  } as const).toExtend<RateLimitInput>()

  expectTypeOf<{
    interval: 10
    limit: 100
    mode: 'approximate'
  }>().toExtend<RateLimitInput>()

  expectTypeOf({
    interval: '3h',
    limit: 100
  } as const).toExtend<RateLimitInput>()

  expectTypeOf<{
    interval: '3h'
    limit: 100
  }>().toExtend<RateLimitInput>()

  expectTypeOf({
    enabled: false
  } as const).toExtend<RateLimitInput>()

  expectTypeOf<{
    enabled: false
  }>().toExtend<RateLimitInput>()
})


================================================
FILE: packages/types/src/rate-limit.ts
================================================
import { z } from '@hono/zod-openapi'
import parseIntervalAsMs from 'ms'

// TODO: Consider adding support for this in the future
// export const rateLimitBySchema = z.union([
//   z.literal('ip'),
//   z.literal('customer'),
//   z.literal('all')
// ])

export const rateLimitModeSchema = z.union([
  z.literal('strict'),
  z.literal('approximate')
])
export type RateLimitMode = z.infer<typeof rateLimitModeSchema>

/**
 * Rate limit config for metered LineItems.
 */
export const rateLimitSchema = z
  .union([
    z.object({
      /**
       * Whether or not this rate limit is enabled.
       */
      enabled: z.literal(false)
    }),
    z.object({
      /**
       * The interval at which the rate limit is applied.
       *
       * Either a positive integer expressed in seconds or a valid positive
       * [ms](https://github.com/vercel/ms) string (eg, "10s", "1m", "8h", "2d",
       * "1w", "1y", etc).
       */
      interval: z
        .union([
          z.number().positive(), // seconds

          z
            .string()
            .nonempty()
            .transform((value, ctx) => {
              try {
                // TODO: `ms` module has broken types
                const ms = parseIntervalAsMs(value as any) as unknown as number
                const seconds = Math.floor(ms / 1000)

                if (
                  typeof ms !== 'number' ||
                  Number.isNaN(ms) ||
                  ms <= 0 ||
                  seconds <= 0
                ) {
                  ctx.addIssue({
                    code: z.ZodIssueCode.custom,
                    message: `Invalid interval "${value}"`,
                    path: ctx.path
                  })

                  return z.NEVER
                }

                return seconds
              } catch {
                ctx.addIssue({
                  code: z.ZodIssueCode.custom,
                  message: `Invalid interval "${value}"`,
                  path: ctx.path
                })

                return z.NEVER
              }
            })
        ])
        .describe(
          `The interval at which the rate limit is applied. Either a positive integer expressed in seconds or a valid positive [ms](https://github.com/vercel/ms) string (eg, "10s", "1m", "8h", "2d", "1w", "1y", etc).`
        ),

      /**
       * Maximum number of operations per interval (unitless).
       */
      limit: z
        .number()
        .nonnegative()
        .describe('Maximum number of operations per interval (unitless).'),

      /**
       * How to enforce the rate limit:
       *
       * - `strict` (more precise but slower)
       * - `approximate` (the default; faster and asynchronous but less precise).
       *
       * The default rate-limiting mode is `approximate`, which means that requests
       * are allowed to proceed immediately, with the limit being enforced
       * asynchronously in the background. This is much faster than synchronous
       * mode, but it is less consistent if precise adherence to rate-limits is
       * required.
       *
       * With `strict` mode, requests are blocked until the current limit has
       * been confirmed. The downside with this approach is that it introduces
       * more latency to every request by default. The advantage is that it is
       * more precise and consistent.
       *
       * @default "approximate"
       */
      mode: rateLimitModeSchema
        .optional()
        .default('approximate')
        .describe(
          'How to enforce the rate limit: "strict" (more precise but slower) or "approximate" (the default; faster and asynchronous but less precise).'
        ),

      // TODO: Consider adding support for this in the future
      // /**
      //  * The key to rate-limit by.
      //  *
      //  * - `ip`: Rate-limit by incoming IP address.
      //  * - `customer`: Rate-limit by customer ID if available or IP address
      //  *   otherwise.
      //  * - `global`: Rate-limit all usage globally across customers.
      //  *
      //  * @default 'customer'
      //  */
      // rateLimitBy: rateLimitBySchema.optional().default('customer'),

      /**
       * Whether or not this rate limit is enabled.
       *
       * @default true
       */
      enabled: z.boolean().optional().default(true)
    })
  ])
  .openapi('RateLimit')

export type RateLimitInput = z.input<typeof rateLimitSchema>
export type RateLimit = z.infer<typeof rateLimitSchema>


================================================
FILE: packages/types/src/temp
================================================
import { z } from '@hono/zod-openapi'

export const authProviderTypeSchema = z
  .union([
    z.literal('github'),
    z.literal('google'),
    z.literal('spotify'),
    z.literal('twitter'),
    z.literal('linkedin'),
    z.literal('stripe')
  ])
  .openapi('AuthProviderType')
export type AuthProviderType = z.infer<typeof authProviderTypeSchema>

export const authProviderSchema = z.object({
  provider: authProviderTypeSchema,

  /** Provider-specific user id */
  id: z.string(),

  /** Provider-specific username */
  username: z.string().optional(),

  /** Standard oauth2 access token */
  accessToken: z.string().optional(),

  /** Standard oauth2 refresh token */
  refreshToken: z.string().optional(),

  /** Stripe public key */
  publicKey: z.string().optional(),

  /** OAuth scope(s) */
  scope: z.string().optional()
})
export type AuthProvider = z.infer<typeof authProviderSchema>

export const publicAuthProviderSchema = authProviderSchema
  .omit({
    accessToken: true,
    refreshToken: true,
    publicKey: true
  })
  .strip()
  .openapi('AuthProvider')
export type PublicAuthProvider = z.infer<typeof publicAuthProviderSchema>

export const authProvidersSchema = z.record(
  authProviderTypeSchema,
  authProviderSchema.optional()
)
export type AuthProviders = z.infer<typeof authProvidersSchema>

export const publicAuthProvidersSchema = z
  .record(authProviderTypeSchema, publicAuthProviderSchema.optional())
  .openapi('AuthProviders')
export type PublicAuthProviders = z.infer<typeof publicAuthProvidersSchema>


================================================
FILE: packages/types/src/tools.ts
================================================
import {
  isToolNameAllowed,
  isValidToolName,
  toolNameRe
} from '@agentic/platform-validators'
import { z } from '@hono/zod-openapi'

import { pricingPlanSlugSchema } from './pricing'
import { rateLimitSchema } from './rate-limit'

/**
 * Agentic tool name.
 *
 * Follows OpenAI/Anthropic/Gemini function calling naming conventions.
 *
 * @example `"get_weather"`
 * @example `"searchGoogle"`
 * @example `"get_user_info2"`
 */
export const toolNameSchema = z
  .string()
  .nonempty()
  .regex(toolNameRe)
  .refine(
    (name) => isValidToolName(name),
    (name) => ({
      message: `Tool name "${name}" is invalid; must match /^[a-zA-Z_][a-zA-Z0-9_-]{0,63}$/.`
    })
  )
  .refine(
    (name) => isToolNameAllowed(name),
    (name) => ({
      message: `Tool name "${name}" is reserved; please choose a different name.`
    })
  )
  .describe('Agentic tool name')

/**
 * A zod schema representing any JSON Schema `object` schema.
 */
export const jsonSchemaObjectSchema = z
  .object({
    type: z.literal('object'),
    // TODO: improve this schema
    properties: z.record(z.string(), z.any()).optional(),
    required: z.array(z.string()).optional(),
    additionalProperties: z
      .union([z.boolean(), z.record(z.string(), z.any())])
      .optional()
  })
  .passthrough()
  .openapi('JsonSchemaObject')

/**
 * Overrides a tool's default behavior for a given pricing plan.
 *
 * You can use this, for instance, to disable tools on certain pricing plans
 * or to customize the rate-limits for specific tools on a given pricing plan.
 */
export const pricingPlanToolOverrideSchema = z
  .object({
    /**
     * Whether this tool should be enabled for customers on a given pricing plan.
     *
     * If `undefined`, will use the tool's default enabled state.
     *
     * @default undefined
     */
    enabled: z.boolean().optional(),

    /**
     * Overrides whether to report default `requests` usage for metered billing
     * for customers a given pricing plan.
     *
     * Note: This is only relevant if the pricing plan includes a `requests`
     * line-item.
     *
     * @default undefined
     */
    reportUsage: z.boolean().optional(),

    /**
     * Customize or disable rate limits for this tool for customers on a given
     * pricing plan.
     *
     * To disable rate-limiting for this tool on a given pricing plan, set
     * `rateLimit.enabled` to `false`.
     *
     * @default undefined
     */
    rateLimit: rateLimitSchema.optional()
  })
  .openapi('PricingPlanToolOverride')
export type PricingPlanToolOverride = z.infer<
  typeof pricingPlanToolOverrideSchema
>

/**
 * Example tool usage.
 */
export const toolConfigExampleSchema = z.object({
  /**
   * The display name of the example.
   *
   * If not given, defaults to `Example 1`, `Example 2`, etc.
   */
  name: z
    .string()
    .optional()
    .describe(
      'The display name of the example. If not given, defaults to `Example 1`, `Example 2`, etc.'
    ),

  /**
   * The input prompt for agents to use when running this example.
   */
  prompt: z
    .string()
    .describe('The input prompt for agents to use when running this example.'),

  /**
   * An optional system prompt for agents to use when running this example.
   *
   * Defaults to `You are a helpful assistant. Be as concise as possible.`
   */
  systemPrompt: z
    .string()
    .optional()
    .describe(
      'An optional system prompt for agents to use when running this example. Defaults to `You are a helpful assistant. Be as concise as possible.`'
    ),

  /**
   * The arguments to pass to the tool for this example.
   */
  // TODO: validate example args against the tool's input schema during
  // config validation
  args: z
    .record(z.string(), z.any())
    .describe('The arguments to pass to the tool for this example.'),

  /**
   * Whether this example should be featured in the docs for the project.
   *
   * The first tool with a `featured` example will be the featured tool for the
   * project.
   */
  featured: z
    .boolean()
    .optional()
    .describe(
      'Whether this example should be featured in the docs for the project.'
    ),

  /**
   * A description of the example.
   */
  description: z.string().optional().describe('A description of the example.')
})

/**
 * Customizes a tool's default behavior across all pricing plans.
 */
export const toolConfigSchema = z
  .object({
    /**
     * The name of the tool, which acts as a unique, stable identifier for the
     * tool across deployments.
     */
    name: toolNameSchema,

    /**
     * Whether this tool should be enabled for all customers (default).
     *
     * If you want to hide a tool from customers but still have it present on
     * your origin server, set this to `false` for the given tool.
     *
     * @default true
     */
    enabled: z.boolean().optional(),

    /**
     * Whether this tool's output is deterministic and idempotent given the
     * same input.
     *
     * If `true`, tool outputs will be cached aggressively for identical
     * requests, though origin server response headers can still override this
     * behavior on a per-request basis.
     *
     * If `false`, tool outputs will be cached according to the origin server's
     * response headers on a per-request basis.
     *
     * @default false
     */
    pure: z.boolean().optional(),

    /**
     * A custom `Cache-Control` header to use for caching this tool's responses.
     *
     * If set, this field overrides `pure`.
     *
     * If not set and `pure` is `true`, the gateway will default to:
     * `public, max-age=31560000, s-maxage=31560000, stale-while-revalidate=3600`
     * (cache publicly for up to 1 year).
     *
     * If not set and `pure` is `false`, the gateway will default to `no-store`
     * which will disable caching. This is the default gateway behavior for
     * tools (no caching).
     *
     * Note that origin server response headers may also choose to disable
     * caching on a per-request basis.
     *
     * @default undefined
     */
    cacheControl: z.string().optional(),

    /**
     * Whether calls to this tool should be reported as usage for the default
     * `requests` line-item's metered billing.
     *
     * Note: This is only relevant if the customer's active pricing plan
     * includes a `requests` line-item.
     *
     * @default true
     */
    reportUsage: z.boolean().optional(),

    /**
     * Customize the default `requests`-based rate-limiting for this tool.
     *
     * To disable rate-limiting for this tool, set `rateLimit.enabled` to
     * `false`.
     *
     * If not set, the default rate-limiting for the active pricing plan will be
     * used.
     *
     * @default undefined
     */
    rateLimit: rateLimitSchema.optional(),

    /**
     * Whether to allow additional properties in the tool's input schema.
     *
     * The default MCP spec allows additional properties. Set this to `false` if
     * you want your tool to be more strict.
     *
     * @note This is only relevant if the tool has defined an `outputSchema`.
     *
     * @default undefined
     */
    inputSchemaAdditionalProperties: z.boolean().optional(),

    /**
     * Whether to allow additional properties in the tool's output schema.
     *
     * The default MCP spec allows additional properties. Set this to `false` if
     * you want your tool to be more strict.
     *
     * @note This is only relevant if the tool has defined an `outputSchema`.
     *
     * @default undefined
     */
    outputSchemaAdditionalProperties: z.boolean().optional(),

    /**
     * Allows you to override this tool's behavior or disable it entirely for
     * different pricing plans.
     *
     * This is a map from PricingPlan slug to PricingPlanToolOverride.
     *
     * @example
     * {
     *   "free": {
     *     "enabled": false
     *   }
     * }
     */
    pricingPlanOverridesMap: z
      .record(pricingPlanSlugSchema, pricingPlanToolOverrideSchema)
      .optional()
      .describe(
        "Allows you to override this tool's behavior or disable it entirely for different pricing plans. This is a map of PricingPlan slug to PricingPlanToolOverrides for that plan."
      ),

    // TODO?
    // headers

    examples: z
      .array(toolConfigExampleSchema)
      .optional()
      .describe(
        "Examples of how to use this tool. Used to generate example usage in the tool's docs."
      )
  })
  .openapi('ToolConfig')

export type ToolConfigInput = z.input<typeof toolConfigSchema>
export type ToolConfig = z.infer<typeof toolConfigSchema>

/**
 * Additional properties describing a Tool to clients.
 *
 * This matches MCP tool annotations 1:1.
 *
 * NOTE: All properties in ToolAnnotations are **hints**.
 *
 * They are not guaranteed to provide a faithful description of tool behavior
 * (including descriptive properties like `title`).
 *
 * Clients should never make tool use decisions based on ToolAnnotations
 * received from untrusted servers.
 */
export const toolAnnotationsSchema = z
  .object({
    /**
     * A human-readable title for the tool.
     */
    title: z.string().optional(),

    /**
     * If true, the tool does not modify its environment.
     *
     * Default: false
     */
    readOnlyHint: z.boolean().optional(),

    /**
     * If true, the tool may perform destructive updates to its environment.
     * If false, the tool performs only additive updates.
     *
     * (This property is meaningful only when `readOnlyHint == false`)
     *
     * Default: true
     */
    destructiveHint: z.boolean().optional(),

    /**
     * If true, calling the tool repeatedly with the same arguments
     * will have no additional effect on the its environment.
     *
     * (This property is meaningful only when `readOnlyHint == false`)
     *
     * Default: false
     */
    idempotentHint: z.boolean().optional(),

    /**
     * If true, this tool may interact with an "open world" of external
     * entities. If false, the tool's domain of interaction is closed.
     * For example, the world of a web search tool is open, whereas that
     * of a memory tool is not.
     *
     * Default: true
     */
    openWorldHint: z.boolean().optional()
  })
  .passthrough()

/**
 * Definition for an Agentic tool.
 *
 * This matches MCP tool scehemas 1:1.
 */
export const toolSchema = z
  .object({
    /**
     * The name of the tool, which acts as a unique, stable identifier for the
     * tool across deployments.
     *
     * @example `"get_weather"`
     * @example `"google_search"`
     */
    name: toolNameSchema,

    /**
     * A description of the tool intended to be used in prompts for LLMs to
     * understand when and how to use the tool.
     */
    description: z.string().optional(),

    /**
     * A JSON Schema object defining the expected parameters for the tool.
     */
    inputSchema: jsonSchemaObjectSchema,

    /**
     * An optional JSON Schema object defining the structure of the tool's
     * output.
     */
    outputSchema: jsonSchemaObjectSchema.optional(),

    /**
     * Optional additional tool information.
     *
     * Used by MCP servers.
     */
    annotations: toolAnnotationsSchema.optional()
  })
  .passthrough()
  .openapi('Tool')
export type Tool = z.infer<typeof toolSchema>


================================================
FILE: packages/types/src/types.ts
================================================
/**
 * This file exports backend model types which are inferred based on the
 * generated `openapi.d.ts` file. Some types are customized to provide stricter
 * types than what `@hono/zod-openapi` and `zod` v3 provide, but in general
 * these types are meant to use the backend API as a source of truth.
 */
import type { Simplify } from 'type-fest'

import type { components } from './openapi.d.ts'
import type { OriginAdapter } from './origin-adapter.js'
import type { PricingPlan } from './pricing'
import type { RateLimit } from './rate-limit.js'
import type { ToolConfig } from './tools'

// TODO: These extra simplify statements for populated references shouldn't be
// necessary here, but Hono's OpenAPI support is currently failing to generate
// these self-referential types correctly in some cases, so we're just hard-
// coding the types here to make them nicer. Same with derived fields.

export type User = components['schemas']['User']
export type Team = components['schemas']['Team']
export type TeamMember = components['schemas']['TeamMember']
export type AuthSession = components['schemas']['AuthSession']

export type Consumer = Simplify<
  components['schemas']['Consumer'] & {
    user?: User
    project?: Project
    deployment?: Deployment

    /**
     * A private admin URL for managing the customer's subscription. This URL
     * is only accessible by the customer.
     *
     * @example https://agentic.so/app/consumers/cons_123
     */
    adminUrl: string
  }
>

export type Project = Simplify<
  Omit<
    components['schemas']['Project'],
    'lastPublishedDeployment' | 'lastDeployment'
  > & {
    user?: User
    team?: Team
    lastPublishedDeployment?: Simplify<Omit<Deployment, 'project'>>
    lastDeployment?: Simplify<Omit<Deployment, 'project'>>

    /**
     * The public base HTTP URL for the project supporting HTTP POST requests for
     * individual tools at `/tool-name` subpaths.
     *
     * @example https://gateway.agentic.so/@agentic/search
     */
    gatewayBaseUrl: string

    /**
     * The public MCP URL for the project supporting the Streamable HTTP transport.
     *
     * @example https://gateway.agentic.so/@agentic/search/mcp
     */
    gatewayMcpUrl: string

    /**
     * The public marketplace URL for the project.
     *
     * @example https://agentic.so/marketplace/projects/@agentic/search
     */
    marketplaceUrl: string

    /**
     * A private admin URL for managing the project. This URL is only accessible
     * by project owners.
     *
     * @example https://agentic.so/app/projects/@agentic/search
     */
    adminUrl: string
  }
>
export type Deployment = Simplify<
  Omit<
    components['schemas']['Deployment'],
    'pricingPlans' | 'toolConfigs' | 'defaultRateLimit' | 'project'
  > & {
    pricingPlans: PricingPlan[]
    toolConfigs: ToolConfig[]
    defaultRateLimit: RateLimit
    project?: Simplify<
      Omit<Project, 'lastPublishedDeployment' | 'lastDeployment'>
    >

    /**
     * The public base HTTP URL for the deployment supporting HTTP POST requests
     * for individual tools at `/tool-name` subpaths.
     *
     * @example https://gateway.agentic.so/@agentic/search@latest
     */
    gatewayBaseUrl: string

    /**
     * The public MCP URL for the deployment supporting the Streamable HTTP
     * transport.
     *
     * @example https://gateway.agentic.so/@agentic/search@latest/mcp
     */
    gatewayMcpUrl: string

    /**
     * The public marketplace URL for the deployment's project.
     *
     * Note that only published deployments are visible on the marketplace.
     *
     * @example https://agentic.so/marketplace/projects/@agentic/search
     */
    marketplaceUrl: string

    /**
     * A private admin URL for managing the deployment. This URL is only accessible
     * by project owners.
     *
     * @example https://agentic.so/app/projects/@agentic/search/deployments/123
     */
    adminUrl: string
  }
>

export type AdminDeployment = Simplify<
  Omit<
    components['schemas']['AdminDeployment'],
    'pricingPlans' | 'toolConfigs' | 'defaultRateLimit' | 'origin' | 'project'
  > & {
    pricingPlans: PricingPlan[]
    toolConfigs: ToolConfig[]
    defaultRateLimit: RateLimit
    origin: OriginAdapter
  } & Pick<
      Deployment,
      | 'gatewayBaseUrl'
      | 'gatewayMcpUrl'
      | 'marketplaceUrl'
      | 'adminUrl'
      | 'project'
    >
>

export type AdminConsumer = Simplify<
  components['schemas']['AdminConsumer'] & {
    user?: User
    project?: Project
    deployment?: Deployment
  } & Pick<Consumer, 'adminUrl'>
>

export type AgenticMcpRequestMetadata = {
  agenticProxySecret: string
  sessionId: string
  isCustomerSubscriptionActive: boolean

  customerId?: string
  customerSubscriptionStatus?: string
  customerSubscriptionPlan?: string

  userId?: string
  userEmail?: string
  userUsername?: string
  userName?: string
  userCreatedAt?: string
  userUpdatedAt?: string

  deploymentId: string
  deploymentIdentifier: string
  projectId: string
  projectIdentifier: string

  ip?: string
} & (
  | {
      // If the customer has an active subscription, these fields are guaranteed
      // to be present in the metadata.
      isCustomerSubscriptionActive: true

      customerId: string
      customerSubscriptionStatus: string

      userId: string
      userEmail: string
      userUsername: string
      userCreatedAt: string
      userUpdatedAt: string
    }
  | {
      // If the customer does not have an active subscription, then the customer
      // fields may or may not be present.
      isCustomerSubscriptionActive: false
    }
)


================================================
FILE: packages/types/src/utils.ts
================================================
import type { PricingInterval, PricingPlan } from '@agentic/platform-types'

export function getPricingPlansByInterval({
  pricingInterval,
  pricingPlans
}: {
  pricingInterval: PricingInterval
  pricingPlans: PricingPlan[]
}): PricingPlan[] {
  return pricingPlans.filter(
    (pricingPlan) =>
      pricingPlan.interval === pricingInterval ||
      pricingPlan.interval === undefined
  )
}

const pricingIntervalToLabelMap: Record<PricingInterval, string> = {
  day: 'daily',
  week: 'weekly',
  month: 'monthly',
  year: 'yearly'
}

export function getLabelForPricingInterval(
  pricingInterval: PricingInterval
): string {
  return pricingIntervalToLabelMap[pricingInterval]
}


================================================
FILE: packages/types/src/webhook.ts
================================================
import { z } from '@hono/zod-openapi'

export const webhookSchema = z
  .object({
    url: z.string(),
    events: z.array(z.string())
  })
  .openapi('Webhook')
export type Webhook = z.infer<typeof webhookSchema>


================================================
FILE: packages/types/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts", "bin/*"],
  "exclude": ["node_modules"]
}


================================================
FILE: packages/validators/package.json
================================================
{
  "name": "@agentic/platform-validators",
  "version": "8.4.4",
  "description": "Validation utils for core strings and identifiers used across the Agentic platform.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "AGPL-3.0",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "packages/validators"
  },
  "engines": {
    "node": ">=18"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/platform-core": "workspace:*",
    "@paralleldrive/cuid2": "catalog:",
    "email-validator": "catalog:",
    "type-fest": "catalog:"
  },
  "publishConfig": {
    "access": "public",
    "files": [
      "dist"
    ],
    "types": "./dist/index.ts",
    "exports": {
      ".": {
        "types": "./dist/index.d.ts",
        "import": "./dist/index.js",
        "default": "./dist/index.js"
      }
    }
  }
}


================================================
FILE: packages/validators/readme.md
================================================
<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/platform-validators"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/platform-validators.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/platform-validators <!-- omit from toc -->

> Core schemas and validators shared across the Agentic platform.

- [Website](https://agentic.so/publishing)
- [Docs](https://docs.agentic.so)

> [!TIP]
> You likely don't need this package directly. See [@agentic/cli](https://github.com/transitive-bullshit/agentic/tree/main/packages/cli), [@agentic/platform](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform), and [@agentic/platform-tool-client](https://github.com/transitive-bullshit/agentic/tree/main/packages/platform-tool-client) for more public-facing packages.

## Install

```bash
npm i @agentic/platform-validators
```

## Usage

```ts
import { parseProjectIdentifier } from '@agentic/platform-validators'

const parsedProjectIdentifier = parseProjectIdentifier('@agentic/search')
```

## Identifiers

### Project Identifier

- `@username/project-slug`
- `@team-slug/project-slug`

**Examples:**

- `@agentic/search`

### Deployment Identifier

- `${projectIdentifier}` will implicitly use `${projectIdentifier}@latest`
- `${projectIdentifier}@latest` (the most recently published deployment)
- `${projectIdentifier}@dev` (the most recently pushed deployment)
- `${projectIdentifier}@deploymentHash` (a specific deployment)
- `${projectIdentifier}@version` (a specific published deployment specified via `semver`)

**Examples:**

- `@agentic/search`
- `@agentic/search@latest`
- `@agentic/search@1.0.0`

### Tool Identifier

- `${deploymentIdentifier}/tool_name`

**Examples:**

- `@agentic/search/search`
- `@agentic/search@latest/search`
- `@agentic/search@1.0.0/search`

### Tool Names

- Must start with a letter or underscore
- Can include only letters, numbers, and underscores
- Use either camelCase or snake_case consistently across all tools

[OpenAI vs Anthropic vs Google vs MCP tool name restrictions](https://chatgpt.com/share/68419382-73a0-8007-afce-0ded7d9f05e7)

## License

[GNU AGPL 3.0](https://choosealicense.com/licenses/agpl-3.0/)


================================================
FILE: packages/validators/src/__snapshots__/parse-deployment-identifier.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`parseDeploymentIdentifier > non-strict mode valid 1`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 2`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 3`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 4`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 5`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 6`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 7`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 8`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "dev",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 9`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "1.0.0",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 10`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 11`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 12`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 13`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 14`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 15`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 16`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 17`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 18`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 19`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 20`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 21`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 22`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 23`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 24`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > non-strict mode valid 25`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 1`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 2`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 3`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 4`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "dev",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 5`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "1.0.0",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 6`] = `
{
  "deploymentHash": "abc123lz",
  "deploymentIdentifier": "@username/foo-bar@abc123lz",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 7`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foobar123-yo@01234567",
  "projectIdentifier": "@username/foobar123-yo",
  "projectNamespace": "username",
  "projectSlug": "foobar123-yo",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 8`] = `
{
  "deploymentIdentifier": "@u/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@u/foo-bar",
  "projectNamespace": "u",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 9`] = `
{
  "deploymentIdentifier": "@a/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@a/foo-bar",
  "projectNamespace": "a",
  "projectSlug": "foo-bar",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 10`] = `
{
  "deploymentIdentifier": "@foo/foobar123-yo@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/foobar123-yo",
  "projectNamespace": "foo",
  "projectSlug": "foobar123-yo",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 11`] = `
{
  "deploymentIdentifier": "@foo/foobar123-yo@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/foobar123-yo",
  "projectNamespace": "foo",
  "projectSlug": "foobar123-yo",
}
`;

exports[`parseDeploymentIdentifier > strict mode valid 12`] = `
{
  "deploymentIdentifier": "@foo/bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/bar",
  "projectNamespace": "foo",
  "projectSlug": "bar",
}
`;


================================================
FILE: packages/validators/src/__snapshots__/parse-project-identifier.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`parseProjectIdentifier > non-strict mode valid 1`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 2`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 3`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 4`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 5`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 6`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 7`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 8`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 9`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 10`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 11`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 12`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 13`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 14`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 15`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 16`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 17`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 18`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 19`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 20`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 21`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > non-strict mode valid 22`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseProjectIdentifier > strict mode valid 1`] = `
{
  "projectIdentifier": "@username/foo",
  "projectNamespace": "username",
  "projectSlug": "foo",
}
`;

exports[`parseProjectIdentifier > strict mode valid 2`] = `
{
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > strict mode valid 3`] = `
{
  "projectIdentifier": "@username/foobar123-yo",
  "projectNamespace": "username",
  "projectSlug": "foobar123-yo",
}
`;

exports[`parseProjectIdentifier > strict mode valid 4`] = `
{
  "projectIdentifier": "@u/foo-bar",
  "projectNamespace": "u",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > strict mode valid 5`] = `
{
  "projectIdentifier": "@a/foo-bar",
  "projectNamespace": "a",
  "projectSlug": "foo-bar",
}
`;

exports[`parseProjectIdentifier > strict mode valid 6`] = `
{
  "projectIdentifier": "@foo/foobar123-yo",
  "projectNamespace": "foo",
  "projectSlug": "foobar123-yo",
}
`;

exports[`parseProjectIdentifier > strict mode valid 7`] = `
{
  "projectIdentifier": "@foo/bar",
  "projectNamespace": "foo",
  "projectSlug": "bar",
}
`;


================================================
FILE: packages/validators/src/__snapshots__/parse-tool-identifier.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`parseToolIdentifier > non-strict mode valid 1`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 2`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 3`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 4`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 5`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 6`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 7`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 8`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 9`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 10`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 11`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > non-strict mode valid 12`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 1`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 2`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foo-bar@01234567",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 3`] = `
{
  "deploymentHash": "abc123lz",
  "deploymentIdentifier": "@username/foo-bar@abc123lz",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 4`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 5`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foobar123-yo@01234567",
  "projectIdentifier": "@username/foobar123-yo",
  "projectNamespace": "username",
  "projectSlug": "foobar123-yo",
  "toolName": "foo_bar_BAR_901",
}
`;

exports[`parseToolIdentifier > strict mode valid 6`] = `
{
  "deploymentHash": "01234567",
  "deploymentIdentifier": "@username/foobar@01234567",
  "projectIdentifier": "@username/foobar",
  "projectNamespace": "username",
  "projectSlug": "foobar",
  "toolName": "get_weather01",
}
`;

exports[`parseToolIdentifier > strict mode valid 7`] = `
{
  "deploymentIdentifier": "@username/foobar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foobar",
  "projectNamespace": "username",
  "projectSlug": "foobar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 8`] = `
{
  "deploymentIdentifier": "@username/foobar@dev",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foobar",
  "projectNamespace": "username",
  "projectSlug": "foobar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 9`] = `
{
  "deploymentIdentifier": "@username/foobar@1.0.0",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foobar",
  "projectNamespace": "username",
  "projectSlug": "foobar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 10`] = `
{
  "deploymentIdentifier": "@username/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 11`] = `
{
  "deploymentIdentifier": "@username/foo-bar@dev",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 12`] = `
{
  "deploymentIdentifier": "@username/foo-bar@1.0.0",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foo-bar",
  "projectNamespace": "username",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 13`] = `
{
  "deploymentIdentifier": "@username/foobar123-yo@0.0.1",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foobar123-yo",
  "projectNamespace": "username",
  "projectSlug": "foobar123-yo",
  "toolName": "foo_bar_BAR_901",
}
`;

exports[`parseToolIdentifier > strict mode valid 14`] = `
{
  "deploymentIdentifier": "@username/foobar123-yo@0.0.1",
  "deploymentVersion": "latest",
  "projectIdentifier": "@username/foobar123-yo",
  "projectNamespace": "username",
  "projectSlug": "foobar123-yo",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 15`] = `
{
  "deploymentIdentifier": "@u/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@u/foo-bar",
  "projectNamespace": "u",
  "projectSlug": "foo-bar",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 16`] = `
{
  "deploymentIdentifier": "@a/foo-bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@a/foo-bar",
  "projectNamespace": "a",
  "projectSlug": "foo-bar",
  "toolName": "foo_123",
}
`;

exports[`parseToolIdentifier > strict mode valid 17`] = `
{
  "deploymentIdentifier": "@foo/foobar123-yo@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/foobar123-yo",
  "projectNamespace": "foo",
  "projectSlug": "foobar123-yo",
  "toolName": "foo_bar_BAR_901",
}
`;

exports[`parseToolIdentifier > strict mode valid 18`] = `
{
  "deploymentIdentifier": "@foo/foobar123-yo@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/foobar123-yo",
  "projectNamespace": "foo",
  "projectSlug": "foobar123-yo",
  "toolName": "foo",
}
`;

exports[`parseToolIdentifier > strict mode valid 19`] = `
{
  "deploymentIdentifier": "@foo/bar@latest",
  "deploymentVersion": "latest",
  "projectIdentifier": "@foo/bar",
  "projectNamespace": "foo",
  "projectSlug": "bar",
  "toolName": "baz",
}
`;


================================================
FILE: packages/validators/src/index.ts
================================================
export * from './namespace-blacklist'
export * from './parse-deployment-identifier'
export * from './parse-project-identifier'
export * from './parse-tool-identifier'
export * from './tool-name-blacklist'
export type * from './types'
export * from './validators'


================================================
FILE: packages/validators/src/namespace-blacklist.ts
================================================
export const namespaceBlacklist = new Set([
  // restricted because they would be confusing
  'admin',
  'root',
  'sudo',
  'mcp',
  'sse',
  'raw',
  'todo',
  'team',
  'api',
  'user',
  'ai',
  'llm',
  'agent',
  'agents',
  'free',
  'paid',
  'tool',
  'tools',
  'not',
  'openapi',
  'error',
  'legal',
  'legacy',
  'support',
  'email',
  'help',
  'faq',
  'privacy',
  'terms',
  'about',
  'contact',
  'internal',
  'public',
  'private',
  '404',
  '429',
  '403',
  '401',
  '400',
  '409',
  '408',
  '407',
  '406',
  '500',

  // bad words
  'fuck',
  'shit',
  'bitch',
  'cunt',
  'dick',
  'pussy',
  'ass',
  'asshole',
  'faggot',
  'fag',
  'fagot',
  'nigger',
  'nigga',
  'niggers',
  'niggas',
  'niggers',
  'porn',
  'sex',
  'anal',
  'blowjob',
  'cum',
  'penis',
  'vagina',
  'boobs',
  'tits',

  // reserved for companies
  'openai',
  'anthropic',
  'google',
  'microsoft',
  'meta',
  'alibaba',
  'amazon',
  'apple',
  'arista',
  'atlassian',
  'aws',
  'azure',
  'cloudflare',
  'cisco',
  'stripe',
  'vercel',
  'facebook',
  'twitter',
  'x',
  'instagram',
  'tiktok',
  'youtube',
  'linkedin',
  'github',
  'gitlab',
  'bitbucket',
  'slack',
  'discord',
  'telegram',
  'whatsapp',
  'snapchat',
  'pinterest',
  'reddit',
  'tumblr',
  'pornhub',
  'xvideos',

  // reserved for individuals
  'trump',
  'elon',
  'elonmusk'
])


================================================
FILE: packages/validators/src/parse-deployment-identifier.test.ts
================================================
import { describe, expect, test } from 'vitest'

import { parseDeploymentIdentifier } from './parse-deployment-identifier'
import {
  isValidDeploymentHash,
  isValidDeploymentIdentifier,
  isValidNamespace,
  isValidProjectIdentifier,
  isValidProjectSlug
} from './validators'

function success(...args: Parameters<typeof parseDeploymentIdentifier>) {
  const result = parseDeploymentIdentifier(...args)
  expect(result).toBeTruthy()
  expect(result!.projectIdentifier).toBeTruthy()
  expect(result!.projectNamespace).toBeTruthy()
  expect(result!.projectSlug).toBeTruthy()
  expect(result!.deploymentIdentifier).toBeTruthy()
  expect(result!.deploymentVersion || result!.deploymentHash).toBeTruthy()
  expect(isValidProjectIdentifier(result!.projectIdentifier)).toBe(true)
  expect(isValidProjectSlug(result!.projectSlug)).toBe(true)
  expect(isValidNamespace(result!.projectNamespace)).toBe(true)
  expect(isValidDeploymentIdentifier(result!.deploymentIdentifier)).toBe(true)

  if (result!.deploymentHash) {
    expect(isValidDeploymentHash(result!.deploymentHash)).toBe(true)
  }

  expect(result).toMatchSnapshot()
}

function error(...args: Parameters<typeof parseDeploymentIdentifier>) {
  expect(() => parseDeploymentIdentifier(...args)).throws()
}

describe('parseDeploymentIdentifier', () => {
  test('strict mode valid', () => {
    success('@username/foo-bar')
    success('@username/foo-bar@01234567')
    success('@username/foo-bar@latest')
    success('@username/foo-bar@dev')
    success('@username/foo-bar@1.0.0')
    success('@username/foo-bar@abc123lz')
    success('@username/foobar123-yo@01234567')

    success('@u/foo-bar')
    success('@a/foo-bar')
    success('@foo/foobar123-yo')
    success('@foo/foobar123-yo')
    success('@foo/bar')
  })

  test('strict mode invalid', () => {
    error()
    error('')
    error('foo')
    error('foo/bar')
    error('foo/bar/baz')
    error('foo/bar/baz/qux')
    error('@foo/bar/baz/qux')
    error('@foo/bar/baz/qux/quux')
    error('@foo/bar/baz/qux/quux/corge')
    error('@foo/bar/baz/qux/quux/corge/grault')
    error('@foo/bar/baz/qux/quux/corge/grault/garply')
    error('@foo/bar/baz/')
    error('@foo')
    error('@foo/bar/')

    error('@foo-bar@01234567')
    error('@%/foo-bar@01234567')
    error('@user/foo^bar@01234567')
    error('@user@foo^bar@01234567')
    error('@username/Foo-Bar@01234567')
    error('username/foo-bar')
    error('@Username/foo-bar')
    error('@username/Foo-bar')
    error('@username/foo-bar/')
    error('@username/foo_bar')

    error('@foo_bar@latest')

    error('//@username/foo-bar@01234567')
    error('https://@username/foo-bar@01234567')
    error('https://example.com/@username/foo-bar')
  })

  test('non-strict mode valid', () => {
    success('https://gateway.agentic.so/@username/foo-bar', { strict: false })
    success('https://gateway.agentic.so/@username/foo-bar@latest', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@01234567', {
      strict: false
    })
    success('/@username/foo-bar@01234567', { strict: false })
    success('@username/foo-bar@01234567/', { strict: false })

    success('/@username/foo-bar@01234567/', { strict: false })
    success('/@username/foo-bar@latest/', { strict: false })
    success('/@username/foo-bar@dev/', { strict: false })
    success('/@username/foo-bar@1.0.0/', { strict: false })
    success('/@username/foo-bar/', { strict: false })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@latest', {
      strict: false
    })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo', {
      strict: false
    })
    success('/@username/foo-bar@01234567/foo', { strict: false })
    success('@username/foo-bar@01234567/foo/', { strict: false })
    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })

    success('/@username/foo-bar@01234567/foo/', { strict: false })
    success('/@username/foo-bar@latest/foo/', { strict: false })
    success('/@username/foo-bar@dev/foo/', { strict: false })
    success('/@username/foo-bar@1.0.0/foo/', { strict: false })
    success('/@username/foo-bar/foo/', { strict: false })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@latest/foo/', {
      strict: false
    })
  })

  test('non-strict mode invalid', () => {
    error(undefined, { strict: false })
    error('', { strict: false })
    error('https://gateway.agentic.so', { strict: false })
    error('//gateway.agentic.so', { strict: false })
    error('https://gateway.agentic.so/@username', { strict: false })
    error('https://gateway.agentic.so/@username/', { strict: false })
    error('https://gateway.agentic.so/call/@username/foo-bar@latest/tool', {
      strict: false
    })
    error('/call/@username/foo-bar/foo', { strict: false })
    error('//@username/foo-bar/foo', { strict: false })
    error('@username/foo-bar/foo//', { strict: false })

    error('@username/foo-bar/foo😀', { strict: false })
    error('@username/Foo-Bar@dev/foo/', { strict: false })

    error('@username/Foo', { strict: false })
    error('@username/foo😀', { strict: false })
  })
})


================================================
FILE: packages/validators/src/parse-deployment-identifier.ts
================================================
import { HttpError } from '@agentic/platform-core'

import type {
  ParsedDeploymentIdentifier,
  ParseIdentifierOptions
} from './types'
import { parseToolIdentifier } from './parse-tool-identifier'
import { coerceIdentifier } from './utils'

const deploymentIdentifierImplicitRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})$/

const deploymentIdentifierHashRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})@([a-z0-9]{8})$/

const deploymentIdentifierVersionRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})@([\d.a-z-@]+)$/

export function parseDeploymentIdentifier(
  identifier?: string,
  { strict = true, errorStatusCode = 400 }: ParseIdentifierOptions = {}
): ParsedDeploymentIdentifier {
  const inputIdentifier = identifier

  if (!strict) {
    try {
      return parseToolIdentifier(identifier, {
        strict,
        errorStatusCode
      })
    } catch {
      // ignore
    }
  }

  if (!strict) {
    identifier = coerceIdentifier(identifier)
  }

  if (!identifier?.length) {
    throw new HttpError({
      statusCode: errorStatusCode,
      message: `Invalid deployment identifier "${inputIdentifier}"`
    })
  }

  const iMatch = identifier.match(deploymentIdentifierImplicitRe)

  if (iMatch) {
    return {
      projectIdentifier: `@${iMatch[1]!}/${iMatch[2]!}`,
      projectNamespace: iMatch[1]!,
      projectSlug: iMatch[2]!,
      deploymentIdentifier: `@${iMatch[1]!}/${iMatch[2]!}@latest`,
      deploymentVersion: 'latest'
    }
  }

  const hMatch = identifier.match(deploymentIdentifierHashRe)

  if (hMatch) {
    return {
      projectIdentifier: `@${hMatch[1]!}/${hMatch[2]!}`,
      projectNamespace: hMatch[1]!,
      projectSlug: hMatch[2]!,
      deploymentIdentifier: `@${hMatch[1]!}/${hMatch[2]!}@${hMatch[3]!}`,
      deploymentHash: hMatch[3]!
    }
  }

  const vMatch = identifier.match(deploymentIdentifierVersionRe)

  if (vMatch) {
    return {
      projectIdentifier: `@${vMatch[1]!}/${vMatch[2]!}`,
      projectNamespace: vMatch[1]!,
      projectSlug: vMatch[2]!,
      deploymentIdentifier: `@${vMatch[1]!}/${vMatch[2]!}@${vMatch[3]!}`,
      deploymentVersion: vMatch[3]!
    }
  }

  throw new HttpError({
    statusCode: errorStatusCode,
    message: `Invalid deployment identifier "${inputIdentifier}"`
  })
}


================================================
FILE: packages/validators/src/parse-project-identifier.test.ts
================================================
import { describe, expect, test } from 'vitest'

import { parseProjectIdentifier } from './parse-project-identifier'
import {
  isValidNamespace,
  isValidProjectIdentifier,
  isValidProjectSlug
} from './validators'

function success(...args: Parameters<typeof parseProjectIdentifier>) {
  const result = parseProjectIdentifier(...args)
  expect(result).toBeTruthy()
  expect(result!.projectIdentifier).toBeTruthy()
  expect(result!.projectNamespace).toBeTruthy()
  expect(result!.projectSlug).toBeTruthy()
  expect(isValidProjectIdentifier(result!.projectIdentifier)).toBe(true)
  expect(isValidProjectSlug(result!.projectSlug)).toBe(true)
  expect(isValidNamespace(result!.projectNamespace)).toBe(true)
  expect(result).toMatchSnapshot()
}

function error(...args: Parameters<typeof parseProjectIdentifier>) {
  expect(() => parseProjectIdentifier(...args)).throws()
}

describe('parseProjectIdentifier', () => {
  test('strict mode valid', () => {
    success('@username/foo')
    success('@username/foo-bar')
    success('@username/foobar123-yo')
    success('@u/foo-bar')
    success('@a/foo-bar')
    success('@foo/foobar123-yo')
    success('@foo/bar')
  })

  test('strict mode invalid', () => {
    error()
    error('')
    error('foo')
    error('foo/bar')
    error('foo/bar/baz')
    error('foo/bar/baz/qux')
    error('@foo/bar/baz/qux')
    error('@foo/bar/baz/qux/quux')
    error('@foo/bar/baz/qux/quux/corge')
    error('@foo/bar/baz/qux/quux/corge/grault')
    error('@foo/bar/baz/qux/quux/corge/grault/garply')
    error('@foo/bar/baz/')
    error('@foo')
    error('@foo/bar/')

    error('@foo-bar')
    error('@%/foo-bar')
    error('@user/foo^bar')
    error('@user@foo^bar')
    error('@username/Foo-Bar')
    error('username/foo-bar/foo')
    error('@Username/foo-bar/foo')
    error('@username/Foo-bar/foo')
    error('@username/foo-bar/')
    error('username/foo-bar')

    error('@foo_bar')
    error('@Username/foo-bar')
    error('@username/Foo-bar')
    error('@username/foo_bar')
    error('@username_/foo-bar')
    error('@username/fooBar123-yo/')

    error('//@username/foo-bar@01234567/foo')
    error('https://@username/foo-bar')
    error('https://example.com/@username/foo-bar')
  })

  test('non-strict mode valid', () => {
    success('https://gateway.agentic.so/@username/foo-bar', {
      strict: false
    })
    success('/@username/foo-bar', { strict: false })
    success('@username/foo-bar', { strict: false })
    success('https://gateway.agentic.so/@username/foo-bar', {
      strict: false
    })

    success('/@username/foo-bar', { strict: false })
    success('/@username/foo-bar', { strict: false })
    success('/@username/foo-bar', { strict: false })

    success('https://gateway.agentic.so/@username/foo-bar', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@01234567/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@latest', {
      strict: false
    })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo', {
      strict: false
    })
    success('/@username/foo-bar@01234567/foo', { strict: false })
    success('@username/foo-bar@01234567/foo/', { strict: false })
    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })

    success('/@username/foo-bar@01234567/foo/', { strict: false })
    success('/@username/foo-bar@latest/foo/', { strict: false })
    success('/@username/foo-bar@dev/foo/', { strict: false })
    success('/@username/foo-bar@1.0.0/foo/', { strict: false })
    success('/@username/foo-bar/foo/', { strict: false })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@latest/foo/', {
      strict: false
    })
  })

  test('non-strict mode invalid', () => {
    error(undefined, { strict: false })
    error('', { strict: false })
    error('https://gateway.agentic.so', { strict: false })
    error('//gateway.agentic.so', { strict: false })
    error('https://gateway.agentic.so/@username', { strict: false })
    error('https://gateway.agentic.so/call/@username/foo-bar@latest/tool', {
      strict: false
    })
    error('/call/@username/foo-bar/foo', { strict: false })
    error('//@username/foo-bar/foo', { strict: false })
    error('@username/foo-bar/foo//', { strict: false })

    error('@username/foo-bar/foo😀', { strict: false })
    error('@username/Foo-Bar@dev/foo/', { strict: false })
    error('@username/Foo-Bar', { strict: false })
    error('@username/foo😀', { strict: false })
  })
})


================================================
FILE: packages/validators/src/parse-project-identifier.ts
================================================
import { HttpError } from '@agentic/platform-core'

import type { ParsedProjectIdentifier, ParseIdentifierOptions } from './types'
import { parseDeploymentIdentifier } from './parse-deployment-identifier'
import { coerceIdentifier } from './utils'

const projectIdentifierRe = /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})$/

export function parseProjectIdentifier(
  identifier?: string,
  { strict = true, errorStatusCode = 400 }: ParseIdentifierOptions = {}
): ParsedProjectIdentifier {
  const inputIdentifier = identifier

  if (!strict) {
    try {
      return parseDeploymentIdentifier(identifier, {
        strict,
        errorStatusCode
      })
    } catch {
      // ignore
    }
  }

  if (!strict) {
    identifier = coerceIdentifier(identifier)
  }

  if (!identifier?.length) {
    throw new HttpError({
      statusCode: errorStatusCode,
      message: `Invalid project identifier "${inputIdentifier}"`
    })
  }

  const match = identifier.match(projectIdentifierRe)

  if (match) {
    return {
      projectIdentifier: `@${match[1]!}/${match[2]!}`,
      projectNamespace: match[1]!,
      projectSlug: match[2]!
    }
  }

  throw new HttpError({
    statusCode: errorStatusCode,
    message: `Invalid project identifier "${inputIdentifier}"`
  })
}


================================================
FILE: packages/validators/src/parse-tool-identifier.test.ts
================================================
import { describe, expect, test } from 'vitest'

import { parseToolIdentifier } from './parse-tool-identifier'
import {
  isValidDeploymentHash,
  isValidDeploymentIdentifier,
  isValidNamespace,
  isValidProjectIdentifier,
  isValidProjectSlug,
  isValidToolName
} from './validators'

function success(...args: Parameters<typeof parseToolIdentifier>) {
  const result = parseToolIdentifier(...args)
  expect(result).toBeTruthy()
  expect(result!.projectIdentifier).toBeTruthy()
  expect(result!.projectNamespace).toBeTruthy()
  expect(result!.projectSlug).toBeTruthy()
  expect(result!.deploymentIdentifier).toBeTruthy()
  expect(result!.deploymentVersion || result!.deploymentHash).toBeTruthy()
  expect(isValidProjectIdentifier(result!.projectIdentifier)).toBe(true)
  expect(isValidProjectSlug(result!.projectSlug)).toBe(true)
  expect(isValidNamespace(result!.projectNamespace)).toBe(true)
  expect(isValidDeploymentIdentifier(result!.deploymentIdentifier)).toBe(true)
  expect(isValidToolName(result!.toolName)).toBe(true)

  if (result!.deploymentHash) {
    expect(isValidDeploymentHash(result!.deploymentHash)).toBe(true)
  }

  expect(result).toMatchSnapshot()
}

function error(...args: Parameters<typeof parseToolIdentifier>) {
  expect(() => parseToolIdentifier(...args)).throws()
}

describe('parseToolIdentifier', () => {
  test('strict mode valid', () => {
    success('@username/foo-bar@01234567/foo')
    success('@username/foo-bar@01234567/foo')
    success('@username/foo-bar@abc123lz/foo')
    success('@username/foo-bar/foo')
    success('@username/foobar123-yo@01234567/foo_bar_BAR_901')
    success('@username/foobar@01234567/get_weather01')
    success('@username/foobar@latest/foo')
    success('@username/foobar@dev/foo')
    success('@username/foobar@1.0.0/foo')

    success('@username/foo-bar@latest/foo')
    success('@username/foo-bar@dev/foo')
    success('@username/foo-bar@1.0.0/foo')
    success('@username/foobar123-yo@0.0.1/foo_bar_BAR_901')
    success('@username/foobar123-yo@0.0.1/foo')

    success('@u/foo-bar/foo')
    success('@a/foo-bar/foo_123')
    success('@foo/foobar123-yo/foo_bar_BAR_901')
    success('@foo/foobar123-yo/foo')
    success('@foo/bar/baz')
  })

  test('strict mode invalid', () => {
    error()
    error('')
    error('foo')
    error('foo/bar')
    error('foo/bar/baz')
    error('foo/bar/baz/qux')
    error('@foo/bar/baz/qux')
    error('@foo/bar/baz/qux/quux')
    error('@foo/bar/baz/qux/quux/corge')
    error('@foo/bar/baz/qux/quux/corge/grault')
    error('@foo/bar/baz/qux/quux/corge/grault/garply')
    error('@foo/bar/baz/')
    error('@foo')
    error('@foo/bar')
    error('@foo/bar/')

    error('@foo-bar@01234567/foo')
    error('@%/foo-bar@01234567/foo')
    error('@user/foo^bar@01234567/foo')
    error('@user@foo^bar@01234567/foo')
    error('@username/Foo-Bar@01234567/foo')
    error('username/foo-bar/foo')
    error('@Username/foo-bar/foo')
    error('@username/Foo-bar/foo')
    error('@username/foo-bar/')
    error('@username/foo-bar')

    error('@foo_bar@latest/foo')
    error('@username/foo-bar@1.0.0/foo@')
    error('@username/foo-bar@/foo')
    error('@username/foo-bar@/foo/')
    error('@username/fooBar123-yo@0.0.1/foo/bar/123-456')

    error('//@username/foo-bar@01234567/foo')
    error('https://@username/foo-bar@01234567/foo')
    error('https://example.com/@username/foo-bar/foo')
  })

  test('non-strict mode valid', () => {
    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo', {
      strict: false
    })
    success('/@username/foo-bar@01234567/foo', { strict: false })
    success('@username/foo-bar@01234567/foo/', { strict: false })
    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })

    success('/@username/foo-bar@01234567/foo/', { strict: false })
    success('/@username/foo-bar@latest/foo/', { strict: false })
    success('/@username/foo-bar@dev/foo/', { strict: false })
    success('/@username/foo-bar@1.0.0/foo/', { strict: false })
    success('/@username/foo-bar/foo/', { strict: false })

    success('https://gateway.agentic.so/@username/foo-bar@01234567/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar/foo/', {
      strict: false
    })
    success('https://gateway.agentic.so/@username/foo-bar@latest/foo/', {
      strict: false
    })
  })

  test('non-strict mode invalid', () => {
    error(undefined, { strict: false })
    error('', { strict: false })
    error('https://gateway.agentic.so', { strict: false })
    error('//gateway.agentic.so', { strict: false })
    error('https://gateway.agentic.so/@username', { strict: false })
    error('https://gateway.agentic.so/@username/foo-bar', { strict: false })
    error('https://gateway.agentic.so/call/@username/foo-bar@latest/tool', {
      strict: false
    })
    error('/call/@username/foo-bar/foo', { strict: false })
    error('//@username/foo-bar/foo', { strict: false })
    error('@username/foo-bar/foo//', { strict: false })

    error('@username/foo-bar/foo😀', { strict: false })
    error('@username/Foo-Bar@dev/foo/', { strict: false })
  })
})


================================================
FILE: packages/validators/src/parse-tool-identifier.ts
================================================
import { HttpError } from '@agentic/platform-core'

import type { ParsedToolIdentifier, ParseIdentifierOptions } from './types'
import { coerceIdentifier } from './utils'

const toolIdentifierImplicitRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})\/([a-zA-Z_][a-zA-Z0-9_-]{0,63})$/

const toolIdentifierHashRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})@([a-z0-9]{8})\/([a-zA-Z_][a-zA-Z0-9_-]{0,63})$/

const toolIdentifierVersionRe =
  /^@([a-z0-9-]{1,256})\/([a-z0-9-]{1,256})@([\d.a-z-@]+)\/([a-zA-Z_][a-zA-Z0-9_-]{0,63})$/

export function parseToolIdentifier(
  identifier?: string,
  { strict = true, errorStatusCode = 400 }: ParseIdentifierOptions = {}
): ParsedToolIdentifier {
  const inputIdentifier = identifier

  if (!strict) {
    identifier = coerceIdentifier(identifier)
  }

  if (!identifier?.length) {
    throw new HttpError({
      statusCode: errorStatusCode,
      message: `Invalid tool identifier "${inputIdentifier}"`
    })
  }

  const iMatch = identifier.match(toolIdentifierImplicitRe)

  if (iMatch) {
    return {
      projectIdentifier: `@${iMatch[1]!}/${iMatch[2]!}`,
      projectNamespace: iMatch[1]!,
      projectSlug: iMatch[2]!,
      deploymentIdentifier: `@${iMatch[1]!}/${iMatch[2]!}@latest`,
      deploymentVersion: 'latest',
      toolName: iMatch[3]!
    }
  }

  const hMatch = identifier.match(toolIdentifierHashRe)

  if (hMatch) {
    return {
      projectIdentifier: `@${hMatch[1]!}/${hMatch[2]!}`,
      projectNamespace: hMatch[1]!,
      projectSlug: hMatch[2]!,
      deploymentIdentifier: `@${hMatch[1]!}/${hMatch[2]!}@${hMatch[3]!}`,
      deploymentHash: hMatch[3]!,
      toolName: hMatch[4]!
    }
  }

  const vMatch = identifier.match(toolIdentifierVersionRe)

  if (vMatch) {
    return {
      projectIdentifier: `@${vMatch[1]!}/${vMatch[2]!}`,
      projectNamespace: vMatch[1]!,
      projectSlug: vMatch[2]!,
      deploymentIdentifier: `@${vMatch[1]!}/${vMatch[2]!}@${vMatch[3]!}`,
      deploymentVersion: 'latest',
      toolName: vMatch[4]!
    }
  }

  throw new HttpError({
    statusCode: errorStatusCode,
    message: `Invalid tool identifier "${inputIdentifier}"`
  })
}


================================================
FILE: packages/validators/src/tool-name-blacklist.ts
================================================
// TODO: if we separate mcp endpoint from REST endpoint, we may be able to have
// tools named `mcp`. would be nice not to impose a blacklist.
export const toolNameBlacklist = new Set([
  // restricted because they are reserved for the platform
  'mcp',
  'sse'
])


================================================
FILE: packages/validators/src/types.ts
================================================
import type { Simplify } from 'type-fest'

export type ParseIdentifierOptions = {
  strict?: boolean
  errorStatusCode?: number
}

export type ParsedProjectIdentifier = {
  projectIdentifier: string
  projectNamespace: string
  projectSlug: string
}

export type ParsedDeploymentIdentifier = Simplify<
  ParsedProjectIdentifier & {
    deploymentIdentifier: string
    deploymentHash?: string
    deploymentVersion?: string
  } & (
      | {
          deploymentHash: string
        }
      | {
          deploymentVersion: string
        }
    )
>

export type ParsedToolIdentifier = Simplify<
  ParsedDeploymentIdentifier & {
    toolName: string
  }
>


================================================
FILE: packages/validators/src/utils.ts
================================================
export function coerceIdentifier(identifier?: string): string | undefined {
  if (!identifier) {
    return
  }

  try {
    const { pathname } = new URL(identifier)
    identifier = pathname
  } catch {}

  identifier = identifier.replace(/^\//, '')
  identifier = identifier.replace(/\/$/, '')

  return identifier
}


================================================
FILE: packages/validators/src/validators.test.ts
================================================
import { expect, test } from 'vitest'

import {
  isNamespaceAllowed,
  isToolNameAllowed,
  isValidDeploymentHash,
  isValidDeploymentIdentifier,
  isValidEmail,
  isValidPassword,
  isValidProjectIdentifier,
  isValidProjectSlug,
  isValidToolName,
  isValidUsername
} from './validators'

test('isValidEmail success', () => {
  expect(isValidEmail('t@t.com')).toBe(true)
  expect(isValidEmail('abc@gmail.com')).toBe(true)
  expect(isValidEmail('abc@foo.io')).toBe(true)
})

test('isValidEmail failure', () => {
  expect(isValidEmail('t@t')).toBe(false)
  expect(isValidEmail('abc')).toBe(false)
  expect(isValidEmail('@')).toBe(false)
})

test('isNamespaceAllowed', () => {
  expect(isNamespaceAllowed('foo')).toBe(true)
  expect(isNamespaceAllowed('foo-bar')).toBe(true)
  expect(isNamespaceAllowed('vercel')).toBe(false)
  expect(isNamespaceAllowed('ai')).toBe(false)
  expect(isNamespaceAllowed('fuck')).toBe(false)
})

test('isValidUsername success', () => {
  expect(isValidUsername('z')).toBe(true)
  expect(isValidUsername('abc')).toBe(true)
  expect(isValidUsername('abc-123')).toBe(true)
  expect(isValidUsername('foo123')).toBe(true)
  expect(isValidUsername('asldfkjasldkfjlaksdfjlkas')).toBe(true)
  expect(isValidUsername('a'.repeat(256))).toBe(true)
})

test('isValidUsername failure (invalid)', () => {
  expect(isValidUsername('ab%')).toBe(false)
  expect(isValidUsername('.')).toBe(false)
  expect(isValidUsername('$')).toBe(false)
  expect(isValidUsername('abc_123')).toBe(false)
  expect(isValidUsername('Foo123')).toBe(false)
  expect(isValidUsername('a'.repeat(257))).toBe(false)
})

test('isValidPassword success', () => {
  expect(isValidPassword('abc')).toBe(true)
  expect(isValidPassword('password')).toBe(true)
  expect(isValidPassword('asldfkjasldkfjlaksdfjlkas')).toBe(true)
})

test('isValidPassword failure', () => {
  expect(isValidPassword('aa')).toBe(false)
  expect(isValidPassword('.'))
  expect(isValidPassword('a'.repeat(1025))).toBe(false)
})

test('isValidProjectSlug success', () => {
  expect(isValidProjectSlug('a')).toBe(true)
  expect(isValidProjectSlug('ai')).toBe(true)
  expect(isValidProjectSlug('aaa')).toBe(true)
  expect(isValidProjectSlug('hello-world')).toBe(true)
  expect(isValidProjectSlug('123-abc')).toBe(true)
  expect(isValidProjectSlug('f'.repeat(256))).toBe(true)
})

test('isValidProjectSlug failure', () => {
  expect(isValidProjectSlug('hello_world')).toBe(false)
  expect(isValidProjectSlug('a_bc')).toBe(false)
  expect(isValidProjectSlug('abc.')).toBe(false)
  expect(isValidProjectSlug('abc_123')).toBe(false)
  expect(isValidProjectSlug('ah^23')).toBe(false)
  expect(isValidProjectSlug('Hello-World')).toBe(false)
  expect(isValidProjectSlug('f'.repeat(257))).toBe(false)
})

test('isValidDeploymentHash success', () => {
  expect(isValidDeploymentHash('abcdefgh')).toBe(true)
  expect(isValidDeploymentHash('01234567')).toBe(true)
  expect(isValidDeploymentHash('k2l3n6l2')).toBe(true)
})

test('isValidDeploymentHash failure', () => {
  expect(isValidDeploymentHash('aa')).toBe(false)
  expect(isValidDeploymentHash('')).toBe(false)
  expect(isValidDeploymentHash('Abcdefgh')).toBe(false)
  expect(isValidDeploymentHash('012345678')).toBe(false)
})

test('isValidProjectIdentifier success', () => {
  expect(isValidProjectIdentifier('@username/project-slug')).toBe(true)
  expect(isValidProjectIdentifier('@a/123')).toBe(true)
})

test('isValidProjectIdentifier failure', () => {
  expect(isValidProjectIdentifier('')).toBe(false)
  expect(isValidProjectIdentifier()).toBe(false)
  expect(isValidProjectIdentifier('foo')).toBe(false)
  expect(isValidProjectIdentifier('@foo')).toBe(false)
  expect(isValidProjectIdentifier('@foo//bar')).toBe(false)
  expect(isValidProjectIdentifier('@@foo/bar')).toBe(false)
  expect(isValidProjectIdentifier('@foo/bar/baz')).toBe(false)
  expect(isValidProjectIdentifier('@foo/bar/tool')).toBe(false)
  expect(isValidProjectIdentifier('@aaa//0123')).toBe(false)
  expect(isValidProjectIdentifier('@foo@bar')).toBe(false)
  expect(isValidProjectIdentifier('@abc/1.23')).toBe(false)
  expect(isValidProjectIdentifier('@012345678/123@latest')).toBe(false)
  expect(isValidProjectIdentifier('@foo@dev')).toBe(false)
  expect(isValidProjectIdentifier('@username/Project-Slug')).toBe(false)
  expect(isValidProjectIdentifier('@_/___')).toBe(false)
})

test('isValidDeploymentIdentifier success', () => {
  expect(isValidDeploymentIdentifier('@username/project-slug@01234567')).toBe(
    true
  )
  expect(isValidDeploymentIdentifier('@username/project-slug@latest')).toBe(
    true
  )
  expect(isValidDeploymentIdentifier('@username/project-slug@dev')).toBe(true)
  expect(isValidDeploymentIdentifier('@username/project-slug@0.0.1')).toBe(true)
  expect(isValidDeploymentIdentifier('@username/project-slug')).toBe(true)
  expect(isValidDeploymentIdentifier('@a/123@01234567')).toBe(true)
  expect(isValidDeploymentIdentifier('@a/123@0.1.0')).toBe(true)
  expect(isValidDeploymentIdentifier('@a/123@latest')).toBe(true)
  expect(isValidDeploymentIdentifier('@a/123@dev')).toBe(true)
  expect(isValidDeploymentIdentifier('@a/123')).toBe(true)
})

test('isValidDeploymentIdentifier failure', () => {
  expect(isValidDeploymentIdentifier('')).toBe(false)
  expect(isValidDeploymentIdentifier()).toBe(false)
  expect(isValidDeploymentIdentifier('foo')).toBe(false)
  expect(isValidDeploymentIdentifier('foo/bar')).toBe(false)
  expect(isValidDeploymentIdentifier('@@foo/bar')).toBe(false)
  expect(isValidDeploymentIdentifier('@foo/bar/baz')).toBe(false)
  expect(isValidDeploymentIdentifier('@foo/bar/tool')).toBe(false)
  expect(isValidDeploymentIdentifier('@a/123@0123A567/foo')).toBe(false)
  expect(isValidDeploymentIdentifier('@_/___@012.4567')).toBe(false)
  expect(isValidDeploymentIdentifier('@_/___@01234567')).toBe(false)
  expect(isValidDeploymentIdentifier('@aaa//0123@01234567')).toBe(false)
  expect(isValidDeploymentIdentifier('@foo@bar@01234567')).toBe(false)
  expect(isValidDeploymentIdentifier('@abc/1.23@01234567')).toBe(false)
  expect(isValidDeploymentIdentifier('012345678/123@latest')).toBe(false)
  expect(isValidDeploymentIdentifier('012345678/123@dev')).toBe(false)
  expect(isValidDeploymentIdentifier('012345678/123@1.0.1')).toBe(false)
})

test('isValidToolName success', () => {
  expect(isValidToolName('tool_name')).toBe(true)
  expect(isValidToolName('toolName')).toBe(true)
  expect(isValidToolName('_identIFIER0123')).toBe(true)
  expect(isValidToolName('abc_123_foo')).toBe(true)
  expect(isValidToolName('search_google')).toBe(true)
  expect(isValidToolName('searchGoogle')).toBe(true)
  expect(isValidToolName('searchGoogle2')).toBe(true)
  expect(isValidToolName('_searchGoogle')).toBe(true)
  expect(isValidToolName('tool-name')).toBe(true)
})

test('isValidToolName failure', () => {
  expect(isValidToolName('ab1.2')).toBe(false)
  expect(isValidToolName('-foo-bar')).toBe(false)
  expect(isValidToolName('abc/123')).toBe(false)
  expect(isValidToolName('search_google ')).toBe(false)
  expect(isValidToolName('-search_google')).toBe(false)
  expect(
    isValidToolName(
      'too_long_too_long_too_long_too_long_too_long_too_long_too_long_to'
    )
  ).toBe(false)
})

test('isToolNameAllowed', () => {
  expect(isToolNameAllowed('foo')).toBe(true)
  expect(isToolNameAllowed('tool_name')).toBe(true)
  expect(isToolNameAllowed('searchGoogle')).toBe(true)
  expect(isToolNameAllowed('mcp')).toBe(false)
  expect(isToolNameAllowed('sse')).toBe(false)
  expect(isToolNameAllowed()).toBe(false)
  expect(isToolNameAllowed('')).toBe(false)
})


================================================
FILE: packages/validators/src/validators.ts
================================================
import { isCuid } from '@paralleldrive/cuid2'
import emailValidator from 'email-validator'

import type { ParseIdentifierOptions } from './types'
import { namespaceBlacklist } from './namespace-blacklist'
import { parseDeploymentIdentifier } from './parse-deployment-identifier'
import { parseProjectIdentifier } from './parse-project-identifier'
import { toolNameBlacklist } from './tool-name-blacklist'

export const namespaceRe = /^[a-z0-9-]{1,256}$/
export const passwordRe = /^.{3,1024}$/

export const projectSlugRe = /^[a-z0-9-]{1,256}$/
export const deploymentHashRe = /^[a-z0-9]{8}$/

export const toolNameRe = /^[a-zA-Z_][a-zA-Z0-9_-]{0,63}$/

export function isValidEmail(value: string): boolean {
  return emailValidator.validate(value)
}

export function isValidNamespace(value?: string): boolean {
  return !!value && namespaceRe.test(value)
}

export function isNamespaceAllowed(value?: string): boolean {
  return !!value && isValidNamespace(value) && !namespaceBlacklist.has(value)
}

export function isValidUsername(value?: string): boolean {
  return isValidNamespace(value)
}

export function isValidTeamSlug(value?: string): boolean {
  return isValidNamespace(value)
}

export function isValidPassword(value?: string): boolean {
  return !!value && passwordRe.test(value)
}

export function isValidProjectSlug(value?: string): boolean {
  return !!value && projectSlugRe.test(value)
}

export function isValidDeploymentHash(value?: string): boolean {
  return !!value && deploymentHashRe.test(value)
}

export function isValidProjectIdentifier(
  value?: string,
  opts?: ParseIdentifierOptions
): boolean {
  try {
    return !!parseProjectIdentifier(value, opts)
  } catch {
    return false
  }
}

export function isValidDeploymentIdentifier(
  value?: string,
  opts?: ParseIdentifierOptions
): boolean {
  try {
    return !!parseDeploymentIdentifier(value, opts)
  } catch {
    return false
  }
}

export function isValidToolName(value?: string): boolean {
  return !!value && toolNameRe.test(value)
}

export function isToolNameAllowed(value?: string): boolean {
  return !!value && isValidToolName(value) && !toolNameBlacklist.has(value)
}

export function isValidCuid(value?: string): boolean {
  return !!value && isCuid(value)
}


================================================
FILE: packages/validators/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: pnpm-workspace.yaml
================================================
packages:
  - packages/*
  - stdlib/*
  - apps/*
  - docs
  - fixtures
  - fixtures/valid/*
  - examples/mcp-servers/*
  - examples/ts-sdks/*

catalog:
  '@ai-sdk/openai': ^1.3.23
  '@apideck/better-ajv-errors': ^0.3.6
  '@clack/prompts': ^0.11.0
  '@cloudflare/workers-types': ^4.20250620.0
  '@commander-js/extra-typings': ^14.0.0
  '@date-fns/utc': ^2.1.0
  '@dicebear/collection': ^9.2.3
  '@dicebear/core': ^9.2.3
  '@dotenvx/dotenvx': ^1.47.7
  '@edge-runtime/vm': ^5.0.0
  '@fisch0920/config': ^1.2.0
  '@fisch0920/drizzle-orm': ^0.43.7
  '@fisch0920/drizzle-zod': ^0.7.9
  '@fisch0920/markdown-to-html': ^1.1.0
  '@googleapis/customsearch': ^4.0.1
  '@hono/mcp': ^0.1.0
  '@hono/node-server': ^1.15.0
  '@hono/sentry': ^1.2.2
  '@hono/zod-openapi': ^0.19.9
  '@hono/zod-validator': ^0.7.0
  '@langchain/core': ^0.3.60
  '@langchain/openai': ^0.5.14
  '@llamaindex/openai': ^0.4.4
  '@llamaindex/workflow': ^1.1.9
  '@mastra/core': ^0.10.6
  '@mastra/schema-compat': ^0.10.3
  '@modelcontextprotocol/sdk': ^1.15.0
  '@nangohq/node': 0.42.22
  '@number-flow/react': ^0.5.10
  '@paralleldrive/cuid2': ^2.2.2
  '@pmndrs/assets': ^1.7.0
  '@radix-ui/react-collapsible': ^1.1.11
  '@radix-ui/react-dropdown-menu': 2.1.15
  '@radix-ui/react-label': ^2.1.7
  '@radix-ui/react-slot': 1.2.3
  '@radix-ui/react-tabs': ^1.1.12
  '@radix-ui/react-tooltip': ^1.2.7
  '@react-email/components': ^0.1.1
  '@react-three/cannon': ^6.6.0
  '@react-three/drei': ^10.4.4
  '@react-three/fiber': ^9.2.0
  '@react-three/postprocessing': ^3.0.4
  '@react-three/rapier': ^2.1.0
  '@redocly/openapi-core': ^1.34.3
  '@sentry/cli': ^2.46.0
  '@sentry/cloudflare': ^9.35.0
  '@sentry/core': ^9.35.0
  '@sentry/node': ^9.35.0
  '@sindresorhus/slugify': ^2.2.1
  '@standard-schema/spec': ^1.0.0
  '@tailwindcss/postcss': ^4.1.11
  '@tailwindcss/typography': ^0.5.16
  '@tanstack/react-form': ^1.14.1
  '@tanstack/react-query': ^5.81.5
  '@tanstack/react-query-devtools': ^5.81.5
  '@types/canvas-confetti': ^1.9.0
  '@types/jsrsasign': ^10.5.15
  '@types/ms': ^2.1.0
  '@types/node': ^24.0.14
  '@types/react': ^19.1.8
  '@types/react-dom': ^19.1.6
  '@types/semver': ^7.7.0
  '@types/three': ^0.178.0
  '@xsai/tool': ^0.3.0-beta.4
  agents: ^0.0.101
  ai: ^4.3.17
  ajv: ^8.17.1
  ajv-formats: ^3.0.1
  autoprefixer: ^10.4.21
  bcryptjs: ^3.0.2
  bumpp: ^10.2.0
  camelcase: ^8.0.0
  canvas-confetti: ^1.9.3
  class-variance-authority: ^0.7.1
  cleye: ^1.3.4
  clsx: ^2.1.1
  commander: ^14.0.0
  conf: ^14.0.0
  date-fns: ^4.1.0
  decamelize: ^6.0.0
  decircular: ^1.0.0
  dedent: ^1.6.0
  del-cli: ^6.0.0
  delay: ^6.0.0
  dotenv: 17.2.0
  drizzle-kit: ^0.31.4
  drizzle-orm: ^0.44.2
  duck-duck-scrape: ^2.2.7
  email-validator: ^2.0.4
  eslint: ^9.35.0
  eslint-plugin-drizzle: ^0.2.3
  eventid: ^2.0.1
  exit-hook: ^4.0.0
  fast-content-type-parse: ^3.0.0
  fast-uri: ^3.0.6
  fast-xml-parser: ^5.2.5
  fastmcp: ^3.8.2
  genkit: ^1.13.0
  genkitx-openai: ^0.22.3
  get-port: ^7.1.0
  google-auth-library: ^9.15.1
  googleapis: ^150.0.1
  hash-object: ^5.0.1
  hast-util-to-jsx-runtime: ^2.3.6
  hono: ^4.8.4
  is-obj: ^3.0.0
  is-relative-url: ^4.0.0
  jsonrepair: ^3.12.0
  jsrsasign: ^10.9.0
  knip: ^5.62.0
  ky: ^1.8.1
  langchain: ^0.3.29
  lint-staged: ^16.1.2
  llamaindex: ^0.11.8
  lucide-react: ^0.525.0
  mathjs: ^13.2.3
  mint: ^4.2.4
  motion: ^12.19.2
  ms: ^2.1.3
  next: ^15.3.5
  next-themes: ^0.4.6
  npm-run-all2: ^8.0.4
  octokit: ^5.0.3
  only-allow: ^1.2.1
  open: ^10.1.2
  openai: ^5.5.1
  openai-fetch: ^3.4.2
  openai-zod-to-json-schema: ^1.1.1
  openapi-typescript: ^7.8.0
  ora: ^8.2.0
  p-all: ^5.0.0
  p-map: ^7.0.3
  p-throttle: 6.2.0
  p-times: ^4.0.0
  parse-json: ^8.3.0
  plur: ^5.1.0
  postcss: ^8.5.6
  postgres: ^3.4.7
  posthog-js: ^1.256.2
  prettier: ^3.6.2
  react: ^19.1.0
  react-dom: ^19.1.0
  react-email: ^4.0.17
  react-infinite-scroll-hook: ^6.0.1
  react-lottie-player: ^2.1.0
  react-medium-image-zoom: ^5.2.14
  react-use: ^17.6.0
  resend: ^4.6.0
  restore-cursor: ^5.1.0
  semver: ^7.7.2
  server-only: ^0.0.1
  shiki: ^3.7.0
  simple-git-hooks: ^2.13.0
  sonner: ^2.0.6
  sort-keys: ^5.1.0
  string-strip-html: ^13.4.12
  stripe: ^18.2.1
  suspend-react: ^0.1.3
  tailwind-merge: ^3.3.1
  tailwindcss: ^4.1.11
  three: ^0.178.0
  tsup: ^8.5.0
  tsx: ^4.20.5
  turbo: ^2.5.5
  tw-animate-css: ^1.3.4
  twitter-api-sdk: ^1.2.1
  type-fest: ^4.41.0
  typescript: ^5.9.2
  unconfig: ^7.3.2
  vite-tsconfig-paths: ^5.1.4
  vitest: ^3.2.4
  wikibase-sdk: ^10.2.3
  wrangler: ^4.23.0
  xsai: ^0.3.0-beta.4
  zod: ^3.25.67
  zod-to-json-schema: ^3.24.5
  zod-validation-error: 4.0.0-beta.1
  zoominfo-api-auth-client: ^1.0.1

enablePrePostScripts: true

ignoredBuiltDependencies:
  - '@fisch0920/config'
  - puppeteer

minimumReleaseAge: 1440

onlyBuiltDependencies:
  - '@sentry/cli'
  - protobufjs
  - tree-sitter

packageManagerStrict: false

updateConfig:
  ignoreDependencies:
    - p-throttle
    - '@nangohq/node'


================================================
FILE: readme.md
================================================
> [!IMPORTANT]
> As of February, 2026, I'm archiving this project since it is no longer being actively developed. Agentic had a good run and explored some genuinely interesting ideas for the time, namely an HTTP <> MCP compatibility layer, a TS stdlib of AI functions, and cross-compat with all the major LLM libs + AI SDKs. But at the end of the day, it failed to gain traction, and I've moved on to other projects.

<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# Agentic <!-- omit from toc -->

You can think of Agentic as **RapidAPI for LLM tools**.

All tools listed on Agentic's marketplace have been carefully hand curated and are regularly tested with a comprehensive set of integration tests and evals. **Agentic aims for quality, not quantity**.

On the flip side, Agentic makes it easy to **publish your own MCP servers & OpenAPI services** to Agentic's MCP Gateway and instantly start charging for agentic tool use.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so)

## Key features

- **Highly Curated Tools**: All publicly listed Agentic tools are manually vetted to keep an extremely high quality bar.
- **Agentic UX**: All Agentic tools have been hand-crafted specifically for LLM tool use. We call this Agentic UX, and it's at the heart of why Agentic tools work better for LLM & MCP use cases than legacy APIs.
- **First-Class MCP Support**: On both the publishing and consumption sides, Agentic supports MCP as a truly first-class primitive – not an afterthought.
- **World-Class TypeScript DX**: Agentic is written in TS and strives for a Vercel-like DX, including one-line integrations with every major TS LLM SDK.
- **Stripe Billing**: Agentic uses Stripe for billing, and most tools are _usage-based_, so you'll only pay for what you (and your agents) actually use.
- **Blazing Fast MCP Gateway**: Agentic's MCP gateway is powered by _Cloudflare's global edge network_. Tools come with customizable caching and rate-limits, so you can REST assured that your agents will always have a fast and reliable experience.
- **Semver**: All Agentic tools are versioned using semver, so you can choose how to handle breaking changes.

## Getting started

- [MCP Marketplace](https://docs.agentic.so/marketplace) - Using tools
- [MCP Publishing](https://docs.agentic.so/publishing/quickstart) - Publishing your own tools

### TypeScript LLM SDKs

Agentic has first-class support for every major TS LLM SDK, including:

- [Vercel AI SDK](https://docs.agentic.so/marketplace/ts-sdks/ai-sdk)
- [OpenAI](https://docs.agentic.so/marketplace/ts-sdks/openai-chat)
- [LangChain](https://docs.agentic.so/marketplace/ts-sdks/langchain)
- [LlamaIndex](https://docs.agentic.so/marketplace/ts-sdks/llamaindex)
- [Firebase Genkit](https://docs.agentic.so/marketplace/ts-sdks/genkit)
- [Mastra](https://docs.agentic.so/marketplace/ts-sdks/mastra)

## Publish your own MCP products

<p align="center">
  <a href="https://agentic.so/publishing">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-publishing-social-image-dark-github.jpg" width="640">
  </a>
</p>

- [Learn more about publishing with Agentic](https://agentic.so/publishing)
- [Publish an existing MCP server with Agentic](https://docs.agentic.so/publishing/guides/existing-mcp-server)
- [Publish an existing OpenAPI service with Agentic](https://docs.agentic.so/publishing/guides/existing-openapi-service)

Anyone can publish their own live MCP products with Agentic, but you'll need to submit your MCP to us before it can be listed on the main Agentic marketplace.

## Join the community

- Follow us on [Twitter](https://x.com/transitive_bs)
- Read more in our [docs](https://docs.agentic.so)

## Contributing

**Agentic is proudly 100% open source.**

Interested in contributing or building Agentic from scratch? See [contributing.md](./contributing.md).


================================================
FILE: stdlib/ai-sdk/package.json
================================================
{
  "name": "@agentic/ai-sdk",
  "version": "8.4.4",
  "description": "Agentic adapter for the Vercel AI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/ai-sdk"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*"
  },
  "peerDependencies": {
    "ai": "catalog:"
  },
  "devDependencies": {
    "ai": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/ai-sdk/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/ai-sdk"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/ai-sdk.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/ai-sdk <!-- omit from toc -->

> Agentic adapter for the Vercel AI SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so/marketplace/ts-sdks/ai-sdk)

## Install

```bash
npm i @agentic/ai-sdk zod ai
```

## Usage

See https://docs.agentic.so/marketplace/ts-sdks/ai-sdk

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/ai-sdk/src/ai-sdk.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { expect, test } from 'vitest'

import { createAISDKTools, createAISDKToolsFromIdentifier } from './ai-sdk'

test('createAISDKTools', () => {
  expect(createAISDKTools(new EchoAITool())).toHaveProperty('echo')
})

test(
  'createAISDKToolsFromIdentifier',
  {
    timeout: 30_000
  },
  async () => {
    await expect(
      createAISDKToolsFromIdentifier('@agentic/search')
    ).resolves.toHaveProperty('search')
  }
)


================================================
FILE: stdlib/ai-sdk/src/ai-sdk.ts
================================================
import {
  type AIFunctionLike,
  AIFunctionSet,
  asAgenticSchema,
  isZodSchema
} from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { jsonSchema, type Tool, tool } from 'ai'

export type AISDKTools = Record<
  string,
  Tool & { execute: (args: any, options: any) => PromiseLike<any> }
>

/**
 * Converts a set of Agentic stdlib AI functions to an object compatible with
 * the Vercel AI SDK's `tools` parameter.
 */
export function createAISDKTools(
  ...aiFunctionLikeTools: AIFunctionLike[]
): AISDKTools {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return Object.fromEntries(
    fns.map((fn) => [
      fn.spec.name,
      tool({
        description: fn.spec.description,
        parameters: isZodSchema(fn.inputSchema)
          ? fn.inputSchema
          : jsonSchema(asAgenticSchema(fn.inputSchema).jsonSchema),
        execute: fn.execute
      })
    ])
  )
}

/**
 * Creates a Vercel AI SDK's `tools` object from a hosted Agentic project or
 * deployment identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const tools = await createAISDKToolsFromIdentifier('@agentic/search')
 * ```
 */
export async function createAISDKToolsFromIdentifier(
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<AISDKTools> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createAISDKTools(agenticToolClient)
}


================================================
FILE: stdlib/ai-sdk/src/index.ts
================================================
export * from './ai-sdk'


================================================
FILE: stdlib/ai-sdk/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/core/package.json
================================================
{
  "name": "@agentic/core",
  "version": "8.4.4",
  "description": "Agentic AI utils which work with any LLM and TypeScript AI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/core"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "dedent": "catalog:",
    "delay": "catalog:",
    "jsonrepair": "catalog:",
    "ky": "catalog:",
    "openai-zod-to-json-schema": "catalog:",
    "p-throttle": "catalog:",
    "type-fest": "catalog:",
    "zod-validation-error": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "devDependencies": {
    "openai-fetch": "catalog:"
  },
  "keywords": [
    "agentic",
    "ai",
    "sdk",
    "openai",
    "llm",
    "tools",
    "stdlib",
    "standard",
    "library",
    "functions",
    "typescript",
    "agent",
    "agents"
  ],
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/core/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/core"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/core.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/core <!-- omit from toc -->

> Agentic AI utils which work with any LLM and TypeScript AI SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so)

## Install

```bash
npm i @agentic/core zod
```

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/core/src/__snapshots__/parse-structured-output.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`parseArrayOutput - handles arrays surrounded by text correctly > should return ["a", "b", "c"] for "Array: ["a", "b", "c"]. That's all!" 1`] = `
[
  "a",
  "b",
  "c",
]
`;

exports[`parseArrayOutput - handles arrays surrounded by text correctly > should return [{"a": 1}, {"b": 2}] for "This is the array [{"a": 1}, {"b": 2}] in the text" 1`] = `
[
  {
    "a": 1,
  },
  {
    "b": 2,
  },
]
`;

exports[`parseArrayOutput - handles arrays surrounded by text correctly > should return [1, 2, 3] for "The array is [1,2,3]" 1`] = `
[
  1,
  2,
  3,
]
`;

exports[`parseArrayOutput - handles valid arrays correctly > should return ["a", "b", "c"] for "["a", "b", "c"] 1`] = `
[
  "a",
  "b",
  "c",
]
`;

exports[`parseArrayOutput - handles valid arrays correctly > should return [{"a": 1}, {"b": 2}] for [{"a": 1}, {"b": 2}] 1`] = `
[
  {
    "a": 1,
  },
  {
    "b": 2,
  },
]
`;

exports[`parseArrayOutput - handles valid arrays correctly > should return [1, 2, 3] for "[1,2,3]" 1`] = `
[
  1,
  2,
  3,
]
`;

exports[`parseBooleanOutput - handles \`false\` outputs correctly > should return false for "FALSE" 1`] = `false`;

exports[`parseBooleanOutput - handles \`false\` outputs correctly > should return false for "False" 1`] = `false`;

exports[`parseBooleanOutput - handles \`false\` outputs correctly > should return false for "false!" 1`] = `false`;

exports[`parseBooleanOutput - handles \`true\` outputs correctly > should return true for "TRUE" 1`] = `true`;

exports[`parseBooleanOutput - handles \`true\` outputs correctly > should return true for "True" 1`] = `true`;

exports[`parseBooleanOutput - handles \`true\` outputs correctly > should return true for "true." 1`] = `true`;

exports[`parseNumberOutput - handles float outputs correctly > should return -5.5 for "   -5.5 " 1`] = `-5.5`;

exports[`parseNumberOutput - handles float outputs correctly > should return 42.42 for "42.42" 1`] = `42.42`;

exports[`parseNumberOutput - handles integer outputs correctly > should return -5 for "  -5 " 1`] = `-5`;

exports[`parseNumberOutput - handles integer outputs correctly > should return 42 for "42" 1`] = `42`;

exports[`parseObjectOutput - handles JSON array of objects > should return first object {"a":1,"b":2} for [{"a":1,"b":2},{"c":3,"d":4}] 1`] = `
{
  "a": 1,
  "b": 2,
}
`;

exports[`parseObjectOutput - handles objects surrounded by text correctly > should return {"a":1,"b":2,"c":3} for "The object is {"a":1,"b":2,"c":3}" 1`] = `
{
  "a": 1,
  "b": 2,
  "c": 3,
}
`;

exports[`parseObjectOutput - handles objects surrounded by text correctly > should return {"name":"John","age":30,"city":"New York"} for "Object: {"name":"John","age":30,"city":"New York"}. That's all!" 1`] = `
{
  "age": 30,
  "city": "New York",
  "name": "John",
}
`;

exports[`parseObjectOutput - handles valid objects correctly > should return {"a":1,"b":2,"c":3} for {"a":1,"b":2,"c":3} 1`] = `
{
  "a": 1,
  "b": 2,
  "c": 3,
}
`;

exports[`parseObjectOutput - handles valid objects correctly > should return {"name":"John","age":30,"city":"New York"} for {"name":"John","age":30,"city":"New York"} 1`] = `
{
  "age": 30,
  "city": "New York",
  "name": "John",
}
`;

exports[`parseStructuredOutput - handles arrays correctly > should parse and return [1, 2, 3] for "[1, 2, 3]" 1`] = `
[
  1,
  2,
  3,
]
`;

exports[`parseStructuredOutput - handles booleans correctly > should parse and return true for "True" 1`] = `true`;

exports[`parseStructuredOutput - handles numbers correctly > should parse and return 123.45 for "123.45" 1`] = `123.45`;

exports[`parseStructuredOutput - handles objects correctly > should parse and return {"a": 1, "b": "two"} for "{"a": 1, "b": "two"}" 1`] = `
{
  "a": 1,
  "b": "two",
}
`;


================================================
FILE: stdlib/core/src/__snapshots__/utils.test.ts.snap
================================================
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`sanitizeSearchParams 1`] = `"a=1&c=13"`;

exports[`sanitizeSearchParams 2`] = `"a=1&a=2&a=3"`;

exports[`sanitizeSearchParams 3`] = `"b=a&b=b&foo=true"`;

exports[`sanitizeSearchParams 4`] = `"b=false&b=true&b=false"`;

exports[`sanitizeSearchParams 5`] = `"flag=foo&flag=bar&flag=baz&token=test"`;

exports[`sanitizeSearchParams 6`] = `""`;

exports[`sanitizeSearchParams 7`] = `""`;


================================================
FILE: stdlib/core/src/_utils.ts
================================================
// testing utils

import defaultKy, {
  type AfterResponseHook,
  type BeforeRequestHook,
  type KyInstance
} from 'ky'

const AGENTIC_TEST_MOCK_HEADER = 'x-agentic-test-mock'

function defaultBeforeRequest(request: Request): Response {
  return new Response(
    JSON.stringify({
      url: request.url,
      method: request.method,
      headers: request.headers
    }),
    {
      status: 200,
      headers: {
        'Content-Type': 'application/json',
        [AGENTIC_TEST_MOCK_HEADER]: '1'
      }
    }
  )
}

export function mockKyInstance(
  ky: KyInstance = defaultKy,
  {
    beforeRequest = defaultBeforeRequest,
    afterResponse
  }: {
    beforeRequest?: BeforeRequestHook
    afterResponse?: AfterResponseHook
  } = {}
): KyInstance {
  return ky.extend({
    hooks: {
      beforeRequest: beforeRequest ? [beforeRequest] : [],
      afterResponse: afterResponse ? [afterResponse] : []
    }
  })
}


================================================
FILE: stdlib/core/src/ai-function-set.test.ts
================================================
import { expect, test } from 'vitest'
import { z } from 'zod'

import { AIFunctionSet } from './ai-function-set'
import { createAIFunction } from './create-ai-function'
import { EchoAITool } from './echo'

export const CalculatorInputSchema = z.object({
  expr: z.string().describe('mathematical expression to evaluate')
})
export type CalculatorInput = z.infer<typeof CalculatorInputSchema>

const mockCalculator = createAIFunction(
  {
    name: 'calculator',
    description:
      'Computes the result of simple mathematical expressions. Handles basic arithmetic operations like addition, subtraction, multiplication, and division. Example expressions: "1 + 2", "3.4 * 5 / 9", "4 - 2"',
    inputSchema: CalculatorInputSchema
  },
  async (input: CalculatorInput) => {
    // eslint-disable-next-line no-eval, security/detect-eval-with-expression
    const result: number = eval(input.expr)
    return result
  }
)

test('AIFunctionSet constructor', () => {
  const mockAITool = new EchoAITool()
  const s0 = new AIFunctionSet([mockAITool, mockCalculator])

  expect(s0.size).toEqual(2)
  expect(s0.get('echo')).toBeDefined()
  expect(s0.get('calculator')).toBeDefined()
  expect([...s0].length).toEqual(2)

  const s1 = new AIFunctionSet([s0, mockAITool, mockCalculator, mockCalculator])
  expect(s0.size).toEqual(2)
  expect(s1.size).toEqual(2)
  expect(s1.get('echo')).toBeDefined()
  expect(s1.get('calculator')).toBeDefined()
  expect([...s1].length).toEqual(2)
})

test('AIFunctionSet constructor invalid function', () => {
  const mockAITool = new EchoAITool()

  expect(
    () => new AIFunctionSet([mockAITool, mockCalculator, { spec: {} } as any])
  ).toThrowError('Invalid AIFunctionLike: [object Object]')
})


================================================
FILE: stdlib/core/src/ai-function-set.ts
================================================
import type * as types from './types.ts'
import type { AIFunction } from './types.ts'
import { AIFunctionsProvider } from './fns'
import { isAIFunction } from './utils'

export type AIFunctionSetOptions = {
  transformNameKeysFn?: (name: string) => string
}

/**
 * A set of AI functions intended to make it easier to work with large sets of
 * AI functions across different clients.
 *
 * This class mimics a built-in `Set<AIFunction>`, but with additional utility
 * methods like `pick`, `omit`, and `map`.
 *
 * Function names are case-insensitive to make it easier to match them with
 * possible LLM hallucinations.
 */
export class AIFunctionSet implements Iterable<types.AIFunction> {
  protected readonly _map: Map<string, types.AIFunction>
  protected readonly _transformNameKeysFn: (name: string) => string

  constructor(
    aiFunctionLikeObjects?: types.AIFunctionLike[],
    { transformNameKeysFn = transformName }: AIFunctionSetOptions = {}
  ) {
    this._transformNameKeysFn = transformNameKeysFn

    // TODO: these `instanceof` checks seem to be failing on some platforms,
    // so for now we're using an uglier, but more reliable approach to parsing
    // the AIFunctionLike objects.
    const fns = aiFunctionLikeObjects?.flatMap((fn) => {
      if (fn instanceof AIFunctionsProvider) {
        return [...fn.functions]
      }

      if (fn instanceof AIFunctionSet) {
        return [...fn]
      }

      if (isAIFunction(fn)) {
        return fn
      }

      const fa = ((fn as any).functions ?? fn) as AIFunctionSet
      if (fa) {
        try {
          const fns = [...fa]
          if (fns.every(isAIFunction)) {
            return fns
          }
        } catch {}
      }

      throw new Error(`Invalid AIFunctionLike: ${fn}`)
    })

    // TODO: This is the cleaner approach which should work in theory, but is
    // not working in practice due to the `instanceof` checks failing.
    // const fns = aiFunctionLikeObjects?.flatMap((fn) =>
    //   fn instanceof AIFunctionsProvider
    //     ? [...fn.functions]
    //     : fn instanceof AIFunctionSet
    //       ? [...fn]
    //       : [fn]
    // )

    if (fns) {
      for (const fn of fns) {
        if (!isAIFunction(fn)) {
          throw new Error(`Invalid AIFunctionLike: ${fn}`)
        }
      }
    }

    this._map = new Map(
      fns
        ? fns.map((fn) => [this._transformNameKeysFn(fn.spec.name), fn])
        : null
    )
  }

  get size(): number {
    return this._map.size
  }

  add(fn: types.AIFunction): this {
    this._map.set(this._transformNameKeysFn(fn.spec.name), fn)
    return this
  }

  get(name: string): types.AIFunction | undefined {
    return this._map.get(this._transformNameKeysFn(name))
  }

  set(name: string, fn: types.AIFunction): this {
    this._map.set(this._transformNameKeysFn(name), fn)
    return this
  }

  has(name: string): boolean {
    return this._map.has(this._transformNameKeysFn(name))
  }

  clear(): void {
    this._map.clear()
  }

  delete(name: string): boolean {
    return this._map.delete(this._transformNameKeysFn(name))
  }

  pick(...keys: string[]): AIFunctionSet {
    const keysToIncludeSet = new Set(keys.map(this._transformNameKeysFn))
    return new AIFunctionSet(
      Array.from(this).filter((fn) =>
        keysToIncludeSet.has(this._transformNameKeysFn(fn.spec.name))
      )
    )
  }

  omit(...keys: string[]): AIFunctionSet {
    const keysToExcludeSet = new Set(keys.map(this._transformNameKeysFn))
    return new AIFunctionSet(
      Array.from(this).filter(
        (fn) => !keysToExcludeSet.has(this._transformNameKeysFn(fn.spec.name))
      )
    )
  }

  map<T>(fn: (fn: types.AIFunction) => T): T[] {
    return [...this.entries].map(fn)
  }

  /**
   * Returns a new AIFunctionSet containing only the AIFunctions in this set
   * matching the given tags.
   */
  getFilteredByTags(...tags: string[]): AIFunctionSet {
    const tagsSet = new Set(tags)
    return this.getFilteredBy((fn) => fn.tags?.some((t) => tagsSet.has(t)))
  }

  /**
   * Returns a new AIFunctionSet containing only the AIFunctions in this set
   * matching a custom filter function.
   */
  getFilteredBy(
    filterFn: (fn: AIFunction) => boolean | undefined
  ): AIFunctionSet {
    return new AIFunctionSet(Array.from(this).filter((fn) => filterFn(fn)))
  }

  /**
   * Returns the functions in this set as an array compatible with OpenAI's
   * chat completions `functions`.
   */
  get specs(): types.AIFunctionSpec[] {
    return this.map((fn) => fn.spec)
  }

  /**
   * Returns the functions in this set as an array compatible with OpenAI's
   * chat completions `tools`.
   */
  get toolSpecs(): types.AIToolSpec[] {
    return this.map((fn) => ({
      type: 'function' as const,
      function: fn.spec
    }))
  }

  /**
   * Returns the tools in this set compatible with OpenAI's `responses` API.
   *
   * Note that this is currently the same type as `AIFunctionSet.specs`, but
   * they are separate APIs which may diverge over time, so if you're using the
   * OpenAI `responses` API, you should reference this property.
   */
  get responsesToolSpecs(): types.AIFunctionSpec[] {
    return this.specs
  }

  get entries(): IterableIterator<types.AIFunction> {
    return this._map.values()
  }

  [Symbol.iterator](): Iterator<types.AIFunction> {
    return this.entries
  }
}

function transformName(name: string): string {
  // TODO: decamalize?
  return name.toLowerCase()
}


================================================
FILE: stdlib/core/src/assert.ts
================================================
export function assert(
  value: unknown,
  message?: string | Error
): asserts value {
  if (value) {
    return
  }

  if (!message) {
    throw new Error('Assertion failed')
  }

  throw typeof message === 'string' ? new Error(message) : message
}


================================================
FILE: stdlib/core/src/create-ai-function.test.ts
================================================
import { describe, expect, test } from 'vitest'
import { z } from 'zod'

import { createAIFunction } from './create-ai-function'
import { type Msg } from './message'

// TODO: Add tests for passing JSON schema directly.

const fullNameAIFunction = createAIFunction({
  name: 'fullName',
  description: 'Returns the full name of a person.',
  inputSchema: z.object({
    first: z.string(),
    last: z.string()
  }),
  execute: ({ first, last }) => {
    return `${first} ${last}`
  }
})

describe('createAIFunction()', () => {
  test('exposes OpenAI function calling spec', () => {
    expect(fullNameAIFunction.spec.name).toEqual('fullName')
    expect(fullNameAIFunction.spec.description).toEqual(
      'Returns the full name of a person.'
    )
    expect(fullNameAIFunction.spec.parameters).toEqual({
      properties: {
        first: { type: 'string' },
        last: { type: 'string' }
      },
      required: ['first', 'last'],
      type: 'object',
      additionalProperties: false
    })
  })

  test('executes the function with JSON string', async () => {
    expect(
      await fullNameAIFunction('{"first": "John", "last": "Doe"}')
    ).toEqual('John Doe')
  })

  test('executes the function with OpenAI Message', async () => {
    const message: Msg.FuncCall = {
      role: 'assistant',
      content: null,
      function_call: {
        name: 'fullName',
        arguments: '{"first": "Jane", "last": "Smith"}'
      }
    }

    expect(await fullNameAIFunction(message)).toEqual('Jane Smith')
  })
})


================================================
FILE: stdlib/core/src/create-ai-function.ts
================================================
import type * as types from './types'
import { asAgenticSchema } from './schema'
import { assert } from './utils'

export type CreateAIFunctionArgs<
  InputSchema extends types.AIFunctionInputSchema = types.AIFunctionInputSchema
> = {
  /** Name of the function. */
  name: string

  /** Description of the function. */
  description: string

  /**
   * Zod schema or AgenticSchema for the function parameters.
   *
   * You can use a JSON Schema for more dynamic tool sources such as MCP by
   * using the `createJsonSchema` utility function.
   */
  inputSchema: InputSchema

  /**
   * Whether to enable strict structured output generation based on the given
   * input schema. (this is a feature of the OpenAI API)
   *
   * Defaults to `true`.
   */
  strict?: boolean

  /**
   * Optional tags to help organize functions.
   */
  tags?: string[]
}

export type AIFunctionImplementation<
  InputSchema extends types.AIFunctionInputSchema,
  Output
> = (params: types.inferInput<InputSchema>) => types.MaybePromise<Output>

/**
 * Create a function meant to be used with OpenAI tool or function calling.
 *
 * The returned function will parse the arguments string and call the
 * implementation function with the parsed arguments.
 *
 * The `spec` property of the returned function is the spec for adding the
 * function to the OpenAI API `functions` property.
 */
export function createAIFunction<
  InputSchema extends types.AIFunctionInputSchema,
  Output
>(
  args: CreateAIFunctionArgs<InputSchema>,
  /** Underlying function implementation. */
  execute: AIFunctionImplementation<InputSchema, Output>
): types.AIFunction<InputSchema, Output>
export function createAIFunction<
  InputSchema extends types.AIFunctionInputSchema,
  Output
>(
  args: CreateAIFunctionArgs<InputSchema> & {
    /** Underlying function implementation. */
    execute: AIFunctionImplementation<InputSchema, Output>
  }
): types.AIFunction<InputSchema, Output>
export function createAIFunction<
  InputSchema extends types.AIFunctionInputSchema,
  Output
>(
  {
    name,
    description,
    inputSchema,
    strict = true,
    tags,
    execute
  }: CreateAIFunctionArgs<InputSchema> & {
    /** Underlying function implementation. */
    execute?: AIFunctionImplementation<InputSchema, Output>
  },
  /** Underlying function implementation. */
  executeArg?: AIFunctionImplementation<InputSchema, Output>
): types.AIFunction<InputSchema, Output> {
  assert(name, 'createAIFunction missing required "name"')
  assert(inputSchema, 'createAIFunction missing required "inputSchema"')
  assert(
    execute || executeArg,
    'createAIFunction missing required "execute" function implementation'
  )
  assert(
    !(execute && executeArg),
    'createAIFunction: cannot provide both "execute" and a second function argument. there should only be one function implementation.'
  )
  execute ??= executeArg
  assert(
    execute,
    'createAIFunction missing required "execute" function implementation'
  )
  assert(
    typeof execute === 'function',
    'createAIFunction "execute" must be a function'
  )

  const inputAgenticSchema = asAgenticSchema(inputSchema, { strict })

  /** Parse the arguments string, optionally reading from a message. */
  const parseInput = (
    input: string | types.Msg
  ): types.inferInput<InputSchema> => {
    if (typeof input === 'string') {
      return inputAgenticSchema.parse(input)
    } else {
      const args = input.function_call?.arguments
      assert(
        args,
        `Missing required function_call.arguments for function "${name}"`
      )
      return inputAgenticSchema.parse(args)
    }
  }

  // Call the underlying function implementation with the parsed arguments.
  const aiFunction: types.AIFunction<InputSchema, Output> = (
    input: string | types.Msg
  ) => {
    const parsedInput = parseInput(input)

    return execute(parsedInput)
  }

  // Override the default function name with the intended name.
  Object.defineProperty(aiFunction, 'name', {
    value: name,
    writable: false
  })

  aiFunction.inputSchema = inputSchema
  aiFunction.parseInput = parseInput
  aiFunction.execute = execute
  aiFunction.tags = tags
  aiFunction.spec = {
    name,
    description,
    parameters: inputAgenticSchema.jsonSchema,
    type: 'function',
    strict
  }

  return aiFunction
}


================================================
FILE: stdlib/core/src/echo.ts
================================================
import { z } from 'zod'

import { createAIFunction } from './create-ai-function'
import { aiFunction, AIFunctionsProvider } from './fns'

/**
 * Test AI tool with one function `echo`, which echoes the input.
 */
export class EchoAITool extends AIFunctionsProvider {
  @aiFunction({
    name: 'echo',
    description: 'Echoes the input.',
    inputSchema: z.object({
      query: z.string().describe('input query to echo')
    })
  })
  async echo({ query }: { query: string }) {
    return query
  }
}

/**
 * Test AI function `echo`, which echoes the input.
 */
export const echoAIFunction = createAIFunction(
  {
    name: 'echo',
    description: 'Echoes the input.',
    inputSchema: z.object({
      query: z.string().describe('input query to echo')
    })
  },
  ({ query }: { query: string }) => {
    return query
  }
)


================================================
FILE: stdlib/core/src/errors.ts
================================================
export class RetryableError extends Error {}

export class AbortError extends Error {}

export class ParseError extends RetryableError {}

export class TimeoutError extends Error {}


================================================
FILE: stdlib/core/src/fns.ts
================================================
import type * as types from './types'
import type { AIFunction } from './types'
import { AIFunctionSet } from './ai-function-set'
import {
  createAIFunction,
  type CreateAIFunctionArgs
} from './create-ai-function'
import { assert } from './utils'

export type PrivateAIFunctionMetadata = CreateAIFunctionArgs & {
  methodName: string
}

// Polyfill for `Symbol.metadata`
// https://github.com/microsoft/TypeScript/issues/53461
declare global {
  interface SymbolConstructor {
    readonly metadata: unique symbol
  }
}

;(Symbol as any).metadata ??= Symbol.for('Symbol.metadata')

const _metadata = Object.create(null)

if (typeof Symbol === 'function' && Symbol.metadata) {
  Object.defineProperty(globalThis, Symbol.metadata, {
    enumerable: true,
    configurable: true,
    writable: true,
    value: _metadata
  })
}

export abstract class AIFunctionsProvider {
  protected _functions?: AIFunctionSet

  /**
   * An `AIFunctionSet` containing all of the AI-compatible functions exposed
   * by this class.
   *
   * This property is useful for manipulating AI functions across multiple
   * sources, picking specific functions, ommitting certain functions, etc.
   */
  get functions(): AIFunctionSet {
    if (!this._functions) {
      const metadata = this.constructor[Symbol.metadata]
      assert(
        metadata,
        'Your runtime does not appear to support ES decorator metadata: https://github.com/tc39/proposal-decorator-metadata/issues/14'
      )
      const invocables =
        (metadata?.invocables as PrivateAIFunctionMetadata[]) ?? []

      const aiFunctions = invocables.map((invocable) => {
        const impl = (this as any)[invocable.methodName]
        assert(impl)

        return createAIFunction(invocable, impl)
      })

      this._functions = new AIFunctionSet(aiFunctions)
    }

    return this._functions
  }

  /**
   * Returns the AIFunctions provided by this class filtered by the given tags.
   */
  getFunctionsFilteredByTags(...tags: string[]): AIFunctionSet {
    return this.functions.getFilteredByTags(...tags)
  }

  /**
   * Returns the AIFunctions provided by this class which match a custom filter
   * function.
   */
  getFunctionsFilteredBy(
    filterFn: (fn: AIFunction) => boolean | undefined
  ): AIFunctionSet {
    return this.functions.getFilteredBy(filterFn)
  }
}

export function aiFunction<
  This extends AIFunctionsProvider,
  InputSchema extends types.AIFunctionInputSchema,
  OptionalArgs extends Array<undefined>,
  Return extends types.MaybePromise<any>
>(args: CreateAIFunctionArgs<InputSchema>) {
  return (
    _targetMethod: (
      this: This,
      input: types.inferInput<InputSchema>,
      ...optionalArgs: OptionalArgs
    ) => Return,
    context: ClassMethodDecoratorContext<
      This,
      (
        this: This,
        input: types.inferInput<InputSchema>,
        ...optionalArgs: OptionalArgs
      ) => Return
    >
  ) => {
    const methodName = String(context.name)
    if (!context.metadata.invocables) {
      context.metadata.invocables = []
    }

    assert(args.name, 'aiFunction requires a non-empty "name" argument')
    ;(context.metadata.invocables as PrivateAIFunctionMetadata[]).push({
      ...args,
      methodName
    })

    context.addInitializer(function () {
      ;(this as any)[methodName] = (this as any)[methodName].bind(this)
      // ;(this as any)[methodName].aiFunction = this.functions.get(
      //   name ?? methodName
      // )
    })
  }
}

// declare module './fns' {
//   // Define a type for methods decorated with @aiFunction
//   type AIFunctionMethod<
//     T extends z.ZodObject<any> = z.ZodObject<any>,
//     R = any
//   > = ((...args: any[]) => R) & {
//     aiFunction?: AIFunction<T, R>
//   }

//   interface AIFunctionsProvider {
//     [methodName: string]: AIFunctionMethod<any, any>
//   }
// }


================================================
FILE: stdlib/core/src/index.ts
================================================
export * from './ai-function-set'
export * from './create-ai-function'
export * from './echo'
export * from './errors'
export * from './fns'
export * from './message'
export * from './parse-structured-output'
export * from './schema'
export type * from './types'
export * from './utils'
export * from './zod-to-json-schema'


================================================
FILE: stdlib/core/src/message.test.ts
================================================
import type * as OpenAI from 'openai-fetch'
import { describe, expect, expectTypeOf, test } from 'vitest'

import type * as types from './types'
import { Msg } from './message'

describe('Msg', () => {
  test('creates a message and fixes indentation', () => {
    const msgContent = `
      Hello, World!
    `
    const msg = Msg.system(msgContent)
    expect(msg.role).toEqual('system')
    expect(msg.content).toEqual('Hello, World!')
  })

  test('supports disabling indentation fixing', () => {
    const msgContent = `
      Hello, World!
    `
    const msg = Msg.system(msgContent, { cleanContent: false })
    expect(msg.content).toEqual('\n      Hello, World!\n    ')
  })

  test('handles tool calls request', () => {
    const msg = Msg.toolCall([
      {
        id: 'fake-tool-call-id',
        type: 'function',
        function: {
          arguments: '{"prompt": "Hello, World!"}',
          name: 'hello'
        }
      }
    ])
    expectTypeOf(msg).toMatchTypeOf<types.Msg.ToolCall>()
    expect(Msg.isToolCall(msg)).toBe(true)
  })

  test('handles tool call response', () => {
    const msg = Msg.toolResult('Hello, World!', 'fake-tool-call-id')
    expectTypeOf(msg).toMatchTypeOf<types.Msg.ToolResult>()
    expect(Msg.isToolResult(msg)).toBe(true)
  })

  test('prompt message types should interop with openai-fetch message types', () => {
    expectTypeOf({} as OpenAI.ChatMessage).toMatchTypeOf<types.Msg>()
    expectTypeOf({} as types.Msg).toMatchTypeOf<OpenAI.ChatMessage>()
    expectTypeOf({} as types.Msg.System).toMatchTypeOf<OpenAI.ChatMessage>()
    expectTypeOf({} as types.Msg.User).toMatchTypeOf<OpenAI.ChatMessage>()
    expectTypeOf({} as types.Msg.Assistant).toMatchTypeOf<OpenAI.ChatMessage>()
    expectTypeOf({} as types.Msg.FuncCall).toMatchTypeOf<OpenAI.ChatMessage>()
    expectTypeOf({} as types.Msg.FuncResult).toMatchTypeOf<OpenAI.ChatMessage>()
  })
})


================================================
FILE: stdlib/core/src/message.ts
================================================
import type { Jsonifiable } from 'type-fest'

import { cleanStringForModel, stringifyForModel } from './utils'

/**
 * Generic/default OpenAI message without any narrowing applied.
 */
export interface Msg {
  /**
   * The role of the messages author. One of `system`, `user`, `assistant`,
   * 'tool', or `function`.
   */
  role: Msg.Role

  /**
   * The contents of the message. `content` may be null for assistant messages
   * with function calls or `undefined` for assistant messages if a `refusal`
   * was given by the model.
   */
  content?: string | null

  /**
   * The reason the model refused to generate this message or `undefined` if the
   * message was generated successfully.
   */
  refusal?: string | null

  /**
   * The name and arguments of a function that should be called, as generated
   * by the model.
   */
  function_call?: Msg.Call.Function

  /**
   * The tool calls generated by the model, such as function calls.
   */
  tool_calls?: Msg.Call.Tool[]

  /**
   * Tool call that this message is responding to.
   */
  tool_call_id?: string

  /**
   * The name of the author of this message. `name` is required if role is
   * `function`, and it should be the name of the function whose response is in the
   * `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of
   * 64 characters.
   */
  name?: string
}

export interface LegacyMsg {
  content: string | null
  role: Msg.Role
  function_call?: Msg.Call.Function
  tool_calls?: Msg.Call.Tool[]
  tool_call_id?: string
  name?: string
}

/** Used for multimodal chat messages. */
export type ChatMessageContentPart =
  | {
      type: 'text'
      text: string
    }
  // User messages only.
  | {
      type: 'image_url'
      image_url: {
        url: string
        detail?: 'low' | 'high' | 'auto' | (string & {})
      }
    }
  | {
      type: 'input_audio'
      input_audio: {
        data: string
        format: 'mp3' | 'wav' | (string & {})
      }
    }
  // Assistant messages only.
  | {
      type: 'refusal'
      refusal: string
    }

/** Narrowed OpenAI Message types. */
export namespace Msg {
  /** Possible roles for a message. */
  export type Role =
    | 'system'
    | 'developer'
    | 'user'
    | 'assistant'
    | 'function'
    | 'tool'

  export namespace Call {
    /**
     * The name and arguments of a function that should be called, as generated
     * by the model.
     */
    export type Function = {
      /**
       * The arguments to call the function with, as generated by the model in
       * JSON format.
       */
      arguments: string

      /** The name of the function to call. */
      name: string
    }

    /** The tool calls generated by the model, such as function calls. */
    export type Tool = {
      /** The ID of the tool call. */
      id: string

      /** The type of the tool. Currently, only `function` is supported. */
      type: 'function'

      /** The function that the model called. */
      function: Call.Function
    }
  }

  /** Message with text content for the system. */
  export type System = {
    role: 'system'
    content: string
    name?: string
  }

  /** Message with text content for the developer. */
  export type Developer = {
    role: 'developer'
    content: string
    name?: string
  }

  /** Message with text content from the user. */
  export type User = {
    role: 'user'
    name?: string
    content: string
  }

  /** Message with text content from the assistant. */
  export type Assistant = {
    role: 'assistant'
    name?: string
    content: string
  }

  /** Message with refusal reason from the assistant. */
  export type Refusal = {
    role: 'assistant'
    name?: string
    refusal: string
  }

  /** Message with arguments to call a function. */
  export type FuncCall = {
    role: 'assistant'
    name?: string
    content: null
    function_call: Call.Function
  }

  /** Message with the result of a function call. */
  export type FuncResult = {
    role: 'function'
    name: string
    content: string
  }

  /** Message with arguments to call one or more tools. */
  export type ToolCall = {
    role: 'assistant'
    name?: string
    content: null
    tool_calls: Call.Tool[]
  }

  /** Message with the result of a tool call. */
  export type ToolResult = {
    role: 'tool'
    tool_call_id: string
    content: string
  }
}

/** Utility functions for creating and checking message types. */
export namespace Msg {
  /** Create a system message. Cleans indentation and newlines by default. */
  export function system(
    content: string,
    opts?: {
      /** Custom name for the message. */
      name?: string
      /** Whether to clean extra newlines and indentation. Defaults to true. */
      cleanContent?: boolean
    }
  ): Msg.System {
    const { name, cleanContent = true } = opts ?? {}
    return {
      role: 'system',
      content: cleanContent ? cleanStringForModel(content) : content,
      ...(name ? { name } : {})
    }
  }

  /** Create a developer message. Cleans indentation and newlines by default. */
  export function developer(
    content: string,
    opts?: {
      /** Custom name for the message. */
      name?: string
      /** Whether to clean extra newlines and indentation. Defaults to true. */
      cleanContent?: boolean
    }
  ): Msg.Developer {
    const { name, cleanContent = true } = opts ?? {}
    return {
      role: 'developer',
      content: cleanContent ? cleanStringForModel(content) : content,
      ...(name ? { name } : {})
    }
  }

  /** Create a user message. Cleans indentation and newlines by default. */
  export function user(
    content: string,
    opts?: {
      /** Custom name for the message. */
      name?: string
      /** Whether to clean extra newlines and indentation. Defaults to true. */
      cleanContent?: boolean
    }
  ): Msg.User {
    const { name, cleanContent = true } = opts ?? {}
    return {
      role: 'user',
      content: cleanContent ? cleanStringForModel(content) : content,
      ...(name ? { name } : {})
    }
  }

  /** Create an assistant message. Cleans indentation and newlines by default. */
  export function assistant(
    content: string,
    opts?: {
      /** Custom name for the message. */
      name?: string
      /** Whether to clean extra newlines and indentation. Defaults to true. */
      cleanContent?: boolean
    }
  ): Msg.Assistant {
    const { name, cleanContent = true } = opts ?? {}
    return {
      role: 'assistant',
      content: cleanContent ? cleanStringForModel(content) : content,
      ...(name ? { name } : {})
    }
  }

  /**
   * Create an assistant refusal message. Cleans indentation and newlines by
   * default.
   */
  export function refusal(
    refusal: string,
    opts?: {
      /** Custom name for the message. */
      name?: string
      /** Whether to clean extra newlines and indentation. Defaults to true. */
      cleanRefusal?: boolean
    }
  ): Msg.Refusal {
    const { name, cleanRefusal = true } = opts ?? {}
    return {
      role: 'assistant',
      refusal: cleanRefusal ? cleanStringForModel(refusal) : refusal,
      ...(name ? { name } : {})
    }
  }

  /** Create a function call message with argumets. */
  export function funcCall(
    funcCall: {
      /** Name of the function to call. */
      name: string
      /** Arguments to pass to the function. */
      arguments: string
    },
    opts?: {
      /** The name descriptor for the message.(message.name) */
      name?: string
    }
  ): Msg.FuncCall {
    return {
      ...opts,
      role: 'assistant',
      content: null,
      function_call: funcCall
    }
  }

  /** Create a function result message. */
  export function funcResult(
    content: Jsonifiable,
    name: string
  ): Msg.FuncResult {
    const contentString = stringifyForModel(content)
    return { role: 'function', content: contentString, name }
  }

  /** Create a function call message with argumets. */
  export function toolCall(
    toolCalls: Msg.Call.Tool[],
    opts?: {
      /** The name descriptor for the message.(message.name) */
      name?: string
    }
  ): Msg.ToolCall {
    return {
      ...opts,
      role: 'assistant',
      content: null,
      tool_calls: toolCalls
    }
  }

  /** Create a tool call result message. */
  export function toolResult(
    content: Jsonifiable,
    toolCallId: string,
    opts?: {
      /** The name of the tool which was called */
      name?: string
    }
  ): Msg.ToolResult {
    const contentString = stringifyForModel(content)
    return {
      ...opts,
      role: 'tool',
      tool_call_id: toolCallId,
      content: contentString
    }
  }

  /** Get the narrowed message from an EnrichedResponse. */
  export function getMessage(
    // @TODO
    response: any
    // response: ChatModel.EnrichedResponse
  ): Msg.Assistant | Msg.Refusal | Msg.FuncCall | Msg.ToolCall {
    const msg = response.choices[0].message as Msg
    return narrowResponseMessage(msg)
  }

  /** Narrow a message received from the API. It only responds with role=assistant */
  export function narrowResponseMessage(
    msg: Msg
  ): Msg.Assistant | Msg.Refusal | Msg.FuncCall | Msg.ToolCall {
    if (msg.content === null && msg.tool_calls != null) {
      return Msg.toolCall(msg.tool_calls)
    } else if (msg.content === null && msg.function_call != null) {
      return Msg.funcCall(msg.function_call)
    } else if (msg.content !== null && msg.content !== undefined) {
      return Msg.assistant(msg.content)
    } else if (msg.refusal != null) {
      return Msg.refusal(msg.refusal)
    } else {
      // @TODO: probably don't want to error here
      console.warn('Invalid message', msg)
      throw new Error('Invalid message')
    }
  }

  /** Check if a message is a system message. */
  export function isSystem(message: Msg): message is Msg.System {
    return message.role === 'system'
  }
  /** Check if a message is a developer message. */
  export function isDeveloper(message: Msg): message is Msg.Developer {
    return message.role === 'developer'
  }
  /** Check if a message is a user message. */
  export function isUser(message: Msg): message is Msg.User {
    return message.role === 'user'
  }
  /** Check if a message is an assistant message. */
  export function isAssistant(message: Msg): message is Msg.Assistant {
    return message.role === 'assistant' && message.content != null
  }
  /** Check if a message is an assistant refusal message. */
  export function isRefusal(message: Msg): message is Msg.Refusal {
    return message.role === 'assistant' && message.refusal !== null
  }
  /** Check if a message is a function call message with arguments. */
  export function isFuncCall(message: Msg): message is Msg.FuncCall {
    return message.role === 'assistant' && message.function_call != null
  }
  /** Check if a message is a function result message. */
  export function isFuncResult(message: Msg): message is Msg.FuncResult {
    return message.role === 'function' && message.name != null
  }
  /** Check if a message is a tool calls message. */
  export function isToolCall(message: Msg): message is Msg.ToolCall {
    return message.role === 'assistant' && message.tool_calls != null
  }
  /** Check if a message is a tool call result message. */
  export function isToolResult(message: Msg): message is Msg.ToolResult {
    return message.role === 'tool' && !!message.tool_call_id
  }

  /** Narrow a ChatModel.Message to a specific type. */
  export function narrow(message: Msg.System): Msg.System
  export function narrow(message: Msg.Developer): Msg.Developer
  export function narrow(message: Msg.User): Msg.User
  export function narrow(message: Msg.Assistant): Msg.Assistant
  export function narrow(message: Msg.Assistant): Msg.Refusal
  export function narrow(message: Msg.FuncCall): Msg.FuncCall
  export function narrow(message: Msg.FuncResult): Msg.FuncResult
  export function narrow(message: Msg.ToolCall): Msg.ToolCall
  export function narrow(message: Msg.ToolResult): Msg.ToolResult
  export function narrow(
    message: Msg
  ):
    | Msg.System
    | Msg.Developer
    | Msg.User
    | Msg.Assistant
    | Msg.Refusal
    | Msg.FuncCall
    | Msg.FuncResult
    | Msg.ToolCall
    | Msg.ToolResult {
    if (isSystem(message)) {
      return message
    }
    if (isDeveloper(message)) {
      return message
    }
    if (isUser(message)) {
      return message
    }
    if (isAssistant(message)) {
      return message
    }
    if (isRefusal(message)) {
      return message
    }
    if (isFuncCall(message)) {
      return message
    }
    if (isFuncResult(message)) {
      return message
    }
    if (isToolCall(message)) {
      return message
    }
    if (isToolResult(message)) {
      return message
    }
    throw new Error('Invalid message type')
  }
}


================================================
FILE: stdlib/core/src/parse-structured-output.test.ts
================================================
import { assert, expect, test } from 'vitest'
import { z } from 'zod'

import {
  extractJSONFromString,
  parseArrayOutput,
  parseBooleanOutput,
  parseNumberOutput,
  parseObjectOutput,
  parseStructuredOutput
} from './parse-structured-output'

test('extractJSONFromString should extract JSON object from string', () => {
  let jsonStr = 'Some text {"name":"John Doe"} more text'
  let result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], { name: 'John Doe' })

  jsonStr =
    'Some text {"name":"John Doe","age":42,"address":{"street":"Main Street","number":42}} more text'
  result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], {
    name: 'John Doe',
    age: 42,
    address: { street: 'Main Street', number: 42 }
  })

  jsonStr = 'foo {"name":"John Doe","school":"St. John\'s"} bar'
  result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], { name: 'John Doe', school: "St. John's" })
})

test('extractJSONFromString should extract an invalid JSON object from string', () => {
  let jsonStr = 'Some text {"name":\'John Doe\'} more text'
  let result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], { name: 'John Doe' })

  jsonStr = 'Some text {"name":"John Doe","age":42,} more text'
  result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], { name: 'John Doe', age: 42 })
})

test('extractJSONFromString should extract multiple JSON objects from string', () => {
  let jsonStr = 'Some text {"name":"John Doe"} more text {"name":"Jane Doe"}'
  let result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], { name: 'John Doe' })
  assert.deepEqual(result[1], { name: 'Jane Doe' })

  jsonStr =
    'Some text {"name":"John Doe","age":42,"address":{"street":"Main Street","number":42}} more text {"name":"Jane Doe","age":42,"address":{"street":"Main Street","number":42}}'
  result = extractJSONFromString(jsonStr, 'object')
  assert.deepEqual(result[0], {
    name: 'John Doe',
    age: 42,
    address: { street: 'Main Street', number: 42 }
  })
  assert.deepEqual(result[1], {
    name: 'Jane Doe',
    age: 42,
    address: { street: 'Main Street', number: 42 }
  })
})

test('extractJSONFromString should extract JSON array from string', () => {
  let jsonString = 'Some text [1,2,3] more text'
  let result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result[0], [1, 2, 3])

  jsonString = 'Some text ["foo","bar","\'quoted\'"] more text'
  result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result[0], ['foo', 'bar', "'quoted'"])
})

test('extractJSONFromString should extract an invalid JSON array from string', () => {
  let jsonString = 'Some text [1,2,3,] more text'
  let result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result[0], [1, 2, 3])

  jsonString = "Some text ['foo','bar'] more text"
  result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result[0], ['foo', 'bar'])
})

test('extractJSONFromString should extract multiple JSON arrays from string', () => {
  const jsonString = 'Some text [1,2,3] more text [4,5,6]'
  const result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result[0], [1, 2, 3])
  assert.deepEqual(result[1], [4, 5, 6])
})

test('extractJSONFromString should return an empty array if no JSON object is found', () => {
  const jsonString = 'Some text'
  const result = extractJSONFromString(jsonString, 'object')
  assert.deepEqual(result, [])
})

test('extractJSONFromString should return an empty array if no JSON array is found', () => {
  const jsonString = 'Some text'
  const result = extractJSONFromString(jsonString, 'array')
  assert.deepEqual(result, [])
})

test('parseArrayOutput - handles valid arrays correctly', () => {
  const output1 = parseArrayOutput('[1,2,3]')
  const output2 = parseArrayOutput('["a", "b", "c"]')
  const output3 = parseArrayOutput('[{"a": 1}, {"b": 2}]')

  expect(output1).toMatchSnapshot('should return [1, 2, 3] for "[1,2,3]"')
  expect(output2).toMatchSnapshot(
    'should return ["a", "b", "c"] for "["a", "b", "c"]'
  )
  expect(output3).toMatchSnapshot(
    'should return [{"a": 1}, {"b": 2}] for [{"a": 1}, {"b": 2}]'
  )
})

test('parseArrayOutput - handles arrays surrounded by text correctly', () => {
  const output1 = parseArrayOutput('The array is [1,2,3]')
  const output2 = parseArrayOutput('Array: ["a", "b", "c"]. That\'s all!')
  const output3 = parseArrayOutput(
    'This is the array [{"a": 1}, {"b": 2}] in the text'
  )

  expect(output1).toMatchSnapshot(
    'should return [1, 2, 3] for "The array is [1,2,3]"'
  )
  expect(output2).toMatchSnapshot(
    'should return ["a", "b", "c"] for "Array: ["a", "b", "c"]. That\'s all!"'
  )
  expect(output3).toMatchSnapshot(
    'should return [{"a": 1}, {"b": 2}] for "This is the array [{"a": 1}, {"b": 2}] in the text"'
  )
})

test('parseArrayOutput - throws error for invalid arrays', () => {
  assert.throws(() => {
    parseArrayOutput('not a valid array')
  })
})

test('parseObjectOutput - handles valid objects correctly', () => {
  const output1 = parseObjectOutput('{"a":1,"b":2,"c":3}')
  const output2 = parseObjectOutput(
    '{"name":"John","age":30,"city":"New York"}'
  )

  expect(output1).toMatchSnapshot(
    'should return {"a":1,"b":2,"c":3} for {"a":1,"b":2,"c":3}'
  )
  expect(output2).toMatchSnapshot(
    'should return {"name":"John","age":30,"city":"New York"} for {"name":"John","age":30,"city":"New York"}'
  )
})

test('parseObjectOutput - handles objects surrounded by text correctly', () => {
  const output1 = parseObjectOutput('The object is {"a":1,"b":2,"c":3}')
  const output2 = parseObjectOutput(
    'Object: {"name":"John","age":30,"city":"New York"}. That\'s all!'
  )

  expect(output1).toMatchSnapshot(
    'should return {"a":1,"b":2,"c":3} for "The object is {"a":1,"b":2,"c":3}"'
  )
  expect(output2).toMatchSnapshot(
    'should return {"name":"John","age":30,"city":"New York"} for "Object: {"name":"John","age":30,"city":"New York"}. That\'s all!"'
  )
})

test('parseObjectOutput - handles JSON array of objects', () => {
  const output = parseObjectOutput('[{"a":1,"b":2},{"c":3,"d":4}]')

  expect(output).toMatchSnapshot(
    'should return first object {"a":1,"b":2} for [{"a":1,"b":2},{"c":3,"d":4}]'
  )
})

test('parseObjectOutput - throws error for invalid objects', () => {
  assert.throws(() => {
    parseObjectOutput('not a valid object')
  })
})

test('parseBooleanOutput - handles `true` outputs correctly', () => {
  const output1 = parseBooleanOutput('True')
  const output2 = parseBooleanOutput('TRUE')
  const output3 = parseBooleanOutput('true.')

  expect(output1).toMatchSnapshot('should return true for "True"')
  expect(output2).toMatchSnapshot('should return true for "TRUE"')
  expect(output3).toMatchSnapshot('should return true for "true."')
})

test('parseBooleanOutput - handles `false` outputs correctly', () => {
  const output1 = parseBooleanOutput('False')
  const output2 = parseBooleanOutput('FALSE')
  const output3 = parseBooleanOutput('false!')

  expect(output1).toMatchSnapshot('should return false for "False"')
  expect(output2).toMatchSnapshot('should return false for "FALSE"')
  expect(output3).toMatchSnapshot('should return false for "false!"')
})

test('parseBooleanOutput - throws error for invalid outputs', () => {
  assert.throws(() => {
    parseBooleanOutput('NotBooleanValue')
  })
})

test('parseNumberOutput - handles integer outputs correctly', () => {
  const output1 = parseNumberOutput('42', z.number().int())
  const output2 = parseNumberOutput('  -5 ', z.number().int())

  expect(output1).toMatchSnapshot('should return 42 for "42"')
  expect(output2).toMatchSnapshot('should return -5 for "  -5 "')
})

test('parseNumberOutput - handles float outputs correctly', () => {
  const output1 = parseNumberOutput('42.42', z.number())
  const output2 = parseNumberOutput('   -5.5 ', z.number())

  expect(output1).toMatchSnapshot('should return 42.42 for "42.42"')
  expect(output2).toMatchSnapshot('should return -5.5 for "   -5.5 "')
})

test('parseNumberOutput - throws error for invalid outputs', () => {
  assert.throws(() => {
    parseNumberOutput('NotANumber', z.number())
  })
})

test('parseStructuredOutput - handles arrays correctly', () => {
  const arraySchema = z.array(z.number())
  const output = '[1, 2, 3]'
  const result = parseStructuredOutput(output, arraySchema)

  expect(result).toMatchSnapshot(
    'should parse and return [1, 2, 3] for "[1, 2, 3]"'
  )
})

test('parseStructuredOutput - handles objects correctly', () => {
  const objectSchema = z.object({ a: z.number(), b: z.string() })
  const output = '{"a": 1, "b": "two"}'
  const result = parseStructuredOutput(output, objectSchema)

  expect(result).toMatchSnapshot(
    'should parse and return {"a": 1, "b": "two"} for "{"a": 1, "b": "two"}"'
  )
})

test('parseStructuredOutput - handles booleans correctly', () => {
  const booleanSchema = z.boolean()
  const output = 'True'
  const result = parseStructuredOutput(output, booleanSchema)

  expect(result).toMatchSnapshot('should parse and return true for "True"')
})

test('parseStructuredOutput - handles numbers correctly', () => {
  const numberSchema = z.number()
  const output = '123.45'
  const result = parseStructuredOutput(output, numberSchema)

  expect(result).toMatchSnapshot('should parse and return 123.45 for "123.45"')
})

test('parseStructuredOutput - throws error for invalid data', () => {
  const numberSchema = z.number()
  const output = 'not a number'

  assert.throws(() => {
    parseStructuredOutput(output, numberSchema)
  })
})


================================================
FILE: stdlib/core/src/parse-structured-output.ts
================================================
import type { JsonObject, JsonValue } from 'type-fest'
import { jsonrepair, JSONRepairError } from 'jsonrepair'
import { z, type ZodType } from 'zod'
import { fromZodError } from 'zod-validation-error'

import { ParseError } from './errors'
import { type SafeParseResult } from './types'

/**
 * Parses a string which is expected to contain a structured JSON value.
 *
 * The JSON value is fuzzily parsed in order to support common issues like
 * missing commas, trailing commas, and unquoted keys.
 *
 * The JSON value is then parsed against a `zod` schema to enforce the shape of
 * the output.
 *
 * @returns parsed output
 */
export function parseStructuredOutput<T>(
  value: unknown,
  outputSchema: ZodType<T>
): T {
  if (!value || typeof value !== 'string') {
    throw new Error('Invalid output: expected string')
  }

  const output = value as string

  let result
  if (outputSchema instanceof z.ZodArray || 'element' in outputSchema) {
    result = parseArrayOutput(output)
  } else if (outputSchema instanceof z.ZodObject || 'omit' in outputSchema) {
    result = parseObjectOutput(output)
  } else if (outputSchema instanceof z.ZodBoolean) {
    result = parseBooleanOutput(output)
  } else if (
    outputSchema instanceof z.ZodNumber ||
    'nonnegative' in outputSchema
  ) {
    result = parseNumberOutput(output, outputSchema as unknown as z.ZodNumber)
  } else {
    // Default to string output...
    result = output
  }

  // TODO: fix typescript issue here with recursive types
  const safeResult = (outputSchema.safeParse as any)(result)

  if (!safeResult.success) {
    throw fromZodError(safeResult.error)
  }

  return safeResult.data
}

export function safeParseStructuredOutput<T>(
  value: unknown,
  outputSchema: ZodType<T>
): SafeParseResult<T> {
  if (!value || typeof value !== 'string') {
    return {
      success: false,
      error: 'Invalid output: expected string'
    }
  }

  const output = value as string

  try {
    const data = parseStructuredOutput<T>(output, outputSchema)
    return {
      success: true,
      data
    }
  } catch (err: any) {
    // console.error(err)

    return {
      success: false,
      error: err.message
    }
  }
}

/**
 * Checks if character at the specified index in a string is escaped.
 *
 * @param str - string to check
 * @param i - index of the character to check
 * @returns whether the character is escaped
 */
function isEscaped(str: string, i: number): boolean {
  return i > 0 && str[i - 1] === '\\' && !(i > 1 && str[i - 2] === '\\')
}

/**
 * Extracts JSON objects or arrays from a string.
 *
 * @param input - string to extract JSON from
 * @param jsonStructureType - type of JSON structure to extract
 * @returns array of extracted JSON objects or arrays
 */
export function extractJSONFromString(
  input: string,
  jsonStructureType: 'object' | 'array'
) {
  const startChar = jsonStructureType === 'object' ? '{' : '['
  const endChar = jsonStructureType === 'object' ? '}' : ']'
  const extractedJSONValues: JsonValue[] = []
  let nestingLevel = 0
  let startIndex = 0
  const isInsideQuoted = { '"': false, "'": false }

  for (let i = 0; i < input.length; i++) {
    const ch = input.charAt(i)
    switch (ch) {
      case '"':
      case "'":
        if (!isInsideQuoted[ch === '"' ? "'" : '"'] && !isEscaped(input, i)) {
          isInsideQuoted[ch] = !isInsideQuoted[ch]
        }

        break

      default:
        if (!isInsideQuoted['"'] && !isInsideQuoted["'"]) {
          switch (ch) {
            case startChar:
              if (nestingLevel === 0) {
                startIndex = i
              }

              nestingLevel += 1

              break

            case endChar:
              nestingLevel -= 1
              if (nestingLevel === 0) {
                const candidate = input.slice(startIndex, i + 1)
                const parsed = JSON.parse(jsonrepair(candidate))
                if (parsed && typeof parsed === 'object') {
                  extractedJSONValues.push(parsed as JsonValue)
                }
              } else if (nestingLevel < 0) {
                throw new ParseError(
                  `Invalid JSON string: unexpected ${endChar} at position ${i}`
                )
              }
          }
        }
    }
  }

  if (nestingLevel !== 0) {
    throw new ParseError(
      'Invalid JSON string: unmatched ' + startChar + ' or ' + endChar
    )
  }

  return extractedJSONValues
}

const BOOLEAN_OUTPUTS: Record<string, boolean> = {
  true: true,
  false: false,
  t: true,
  f: false,
  yes: true,
  no: false,
  y: true,
  n: false,
  '1': true,
  '0': false
}

/**
 * Parses an array output from a string.
 *
 * @param output - string to parse
 * @returns parsed array
 */
export function parseArrayOutput(output: string): JsonValue[] {
  try {
    const arrayOutput = extractJSONFromString(output, 'array')
    if (arrayOutput.length === 0) {
      throw new ParseError('Invalid JSON array')
    }

    const parsedOutput = arrayOutput[0]
    if (!Array.isArray(parsedOutput)) {
      throw new ParseError('Expected JSON array')
    }

    return parsedOutput
  } catch (err: any) {
    if (err instanceof JSONRepairError) {
      throw new ParseError(err.message, { cause: err })
    } else if (err instanceof SyntaxError) {
      throw new ParseError(`Invalid JSON array: ${err.message}`, { cause: err })
    } else {
      throw err
    }
  }
}

/**
 * Parses an object output from a string.
 *
 * @param output - string to parse
 * @returns parsed object
 */
export function parseObjectOutput(output: string): JsonObject {
  try {
    const arrayOutput = extractJSONFromString(output, 'object')
    if (arrayOutput.length === 0) {
      throw new ParseError('Invalid JSON object')
    }

    let parsedOutput = arrayOutput[0]
    if (Array.isArray(parsedOutput)) {
      // TODO
      parsedOutput = parsedOutput[0]
    }

    if (!parsedOutput || typeof parsedOutput !== 'object') {
      throw new ParseError('Expected JSON object')
    }

    return parsedOutput as JsonObject
  } catch (err: any) {
    if (err instanceof JSONRepairError) {
      throw new ParseError(err.message, { cause: err })
    } else if (err instanceof SyntaxError) {
      throw new ParseError(`Invalid JSON object: ${err.message}`, {
        cause: err
      })
    } else {
      throw err
    }
  }
}

/**
 * Parses a boolean output from a string.
 *
 * @param output - string to parse
 * @returns parsed boolean
 */
export function parseBooleanOutput(output: string): boolean {
  output = output
    .toLowerCase()
    .trim()
    .replace(/[!.?]+$/, '')

  const booleanOutput = BOOLEAN_OUTPUTS[output]

  if (booleanOutput === undefined) {
    throw new ParseError(`Invalid boolean output: ${output}`)
  } else {
    return booleanOutput
  }
}

/**
 * Parses a number output from a string.
 *
 * @param output - string to parse
 * @param outputSchema - zod number schema
 * @returns parsed number
 */
export function parseNumberOutput(
  output: string,
  outputSchema: z.ZodNumber
): number {
  output = output.trim()

  const numberOutput = outputSchema.isInt
    ? Number.parseInt(output)
    : Number.parseFloat(output)

  if (Number.isNaN(numberOutput)) {
    throw new ParseError(`Invalid number output: ${output}`)
  }

  return numberOutput
}


================================================
FILE: stdlib/core/src/reset.d.ts
================================================
import '@fisch0920/config/ts-reset'


================================================
FILE: stdlib/core/src/schema.test.ts
================================================
import { expect, test } from 'vitest'
import { z } from 'zod'

import { asAgenticSchema, createJsonSchema, isZodSchema } from './schema'

test('isZodSchema', () => {
  expect(isZodSchema(z.object({}))).toBe(true)
  expect(isZodSchema({})).toBe(false)
})

test('asAgenticSchema', () => {
  expect(asAgenticSchema(z.object({})).jsonSchema).toEqual({
    type: 'object',
    properties: {},
    additionalProperties: false
  })
  expect(asAgenticSchema(createJsonSchema({})).jsonSchema).toEqual({})
})


================================================
FILE: stdlib/core/src/schema.ts
================================================
import type { z } from 'zod'
import { jsonrepair } from 'jsonrepair'

import type * as types from './types'
import { parseStructuredOutput } from './parse-structured-output'
import { stringifyForModel } from './utils'
import { zodToJsonSchema } from './zod-to-json-schema'

/**
 * Used to mark schemas so we can support both Zod and custom schemas.
 */
export const schemaSymbol = Symbol('agentic.schema')

/**
 * Structured schema used across Agentic, which wraps either a Zod schema or a
 * JSON Schema.
 *
 * JSON Schema support is important to support more dynamic tool sources such as
 * MCP.
 */
export type AgenticSchema<TData = unknown> = {
  /**
   * The JSON Schema.
   */
  readonly jsonSchema: types.JSONSchema

  /**
   * Parses the value, validates that it matches this schema, and returns a
   * typed version of the value if it does. Throw an error if the value does
   * not match the schema.
   */
  readonly parse: types.ParseFn<TData>

  /**
   * Parses the value, validates that it matches this schema, and returns a
   * typed version of the value if it does. Returns an error message if the
   * value does not match the schema, and will never throw an error.
   */
  readonly safeParse: types.SafeParseFn<TData>

  /**
   * Used to mark schemas so we can support both Zod and custom schemas.
   */
  [schemaSymbol]: true

  /**
   * Schema type for inference.
   */
  _type: TData

  /**
   * Source Zod schema if this object was created from a Zod schema.
   */
  _source?: any
}

export function isAgenticSchema(value: unknown): value is AgenticSchema {
  return (
    typeof value === 'object' &&
    value !== null &&
    schemaSymbol in value &&
    value[schemaSymbol] === true &&
    'jsonSchema' in value &&
    'parse' in value
  )
}

export function isZodSchema(value: unknown): value is z.ZodType {
  return (
    !!value &&
    typeof value === 'object' &&
    '_def' in value &&
    '~standard' in value &&
    (value['~standard'] as any)?.vendor === 'zod'
  )
}

export function asAgenticSchema<TData>(
  schema: z.Schema<TData> | AgenticSchema<TData>,
  opts: { strict?: boolean } = {}
): AgenticSchema<TData> {
  return isAgenticSchema(schema)
    ? schema
    : createAgenticSchemaFromZodSchema(schema, opts)
}

export function asZodOrJsonSchema<TData>(
  schema: z.Schema<TData> | AgenticSchema<TData>
): z.Schema<TData> | types.JSONSchema {
  return isZodSchema(schema) ? schema : schema.jsonSchema
}

/**
 * Create an AgenticSchema from a JSON Schema.
 *
 * All `AIFunction` input schemas accept either a Zod schema or a custom JSON
 * Schema. Use this function to wrap JSON schemas for use with `AIFunction`.
 *
 * Note that JSON Schemas are not validated by default, so you have to pass
 * in an optional `parse` function (using `ajv`, for instance) if you'd like to
 * validate them at runtime.
 */
export function createJsonSchema<TData = unknown>(
  jsonSchema: types.JSONSchema,
  {
    parse,
    safeParse,
    source
  }: {
    parse?: types.ParseFn<TData>
    safeParse?: types.SafeParseFn<TData>
    source?: any
  } = {}
): AgenticSchema<TData> {
  parse ??= (value: unknown) => {
    if (typeof value === 'string') {
      // TODO: better error messages for invalid JSON so the LLM has a better
      // feedback loop.
      value = JSON.parse(jsonrepair(value))
    }

    // TODO: use `cfValidateJsonSchema` from `@agentic/json-schema` here.
    return value as TData
  }

  safeParse ??= (value: unknown) => {
    try {
      const result = parse(value)
      return { success: true, data: result }
    } catch (err: any) {
      return { success: false, error: err.message ?? String(err) }
    }
  }

  return {
    [schemaSymbol]: true,
    _type: undefined as TData,
    jsonSchema,
    parse,
    safeParse,
    _source: source
  }
}

export function createAgenticSchemaFromZodSchema<TData>(
  zodSchema: z.Schema<TData>,
  opts: { strict?: boolean } = {}
): AgenticSchema<TData> {
  return createJsonSchema(zodToJsonSchema(zodSchema, opts), {
    parse: (value) => {
      return parseStructuredOutput(value, zodSchema)
    },
    source: zodSchema
  })
}

const DEFAULT_SCHEMA_PREFIX = `
---

Respond with JSON using the following JSON schema:

\`\`\`json`
const DEFAULT_SCHEMA_SUFFIX = '```'

export function augmentSystemMessageWithJsonSchema({
  schema,
  system,
  schemaPrefix = DEFAULT_SCHEMA_PREFIX,
  schemaSuffix = DEFAULT_SCHEMA_SUFFIX
}: {
  schema: types.JSONSchema
  system?: string
  schemaPrefix?: string
  schemaSuffix?: string
}): string {
  return [system, schemaPrefix, stringifyForModel(schema), schemaSuffix]
    .filter(Boolean)
    .join('\n')
    .trim()
}


================================================
FILE: stdlib/core/src/types.ts
================================================
import type { Jsonifiable } from 'type-fest'
import type { z } from 'zod'

import type { AIFunctionSet } from './ai-function-set'
import type { AIFunctionsProvider } from './fns'
import type { Msg } from './message'
import type { AgenticSchema } from './schema'

export type { Msg } from './message'
export type { AgenticSchema } from './schema'
export type { KyInstance } from 'ky'
export type { ThrottledFunction } from 'p-throttle'
export type { SetOptional, SetRequired, Simplify } from 'type-fest'

export type Nullable<T> = T | null

export type DeepNullable<T> = T extends object
  ? { [K in keyof T]: DeepNullable<T[K]> }
  : Nullable<T>

export type MaybePromise<T> = T | Promise<T>

export type JSONSchema = Record<string, unknown>

export type RelaxedJsonifiable = Jsonifiable | Record<string, unknown>

export interface AIFunctionSpec {
  /** AI Function name. */
  name: string

  /** Description of what the function does. */
  description: string

  /** JSON schema spec of the function's input parameters */
  parameters: JSONSchema

  /**
   * The type of the function tool. Always `function`.
   */
  type: 'function'

  /**
   * Whether to enable strict schema adherence when generating the function
   * parameters. Currently only supported by OpenAI's
   * [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
   */
  strict: boolean
}

export interface AIToolSpec {
  type: 'function'
  function: AIFunctionSpec
}

/**
 * A Zod object schema or a custom schema created from a JSON schema via
 * `createSchema()`.
 */
export type AIFunctionInputSchema = z.ZodObject<any> | AgenticSchema<any>

// eslint-disable-next-line @typescript-eslint/naming-convention
export type inferInput<InputSchema extends AIFunctionInputSchema> =
  InputSchema extends AgenticSchema<any>
    ? InputSchema['_type']
    : InputSchema extends z.ZodTypeAny
      ? z.infer<InputSchema>
      : never

/** The implementation of the function, with arg parsing and validation. */
export type AIFunctionImpl<Return> = Omit<
  (input: string | Msg) => MaybePromise<Return>,
  'name' | 'toString' | 'arguments' | 'caller' | 'prototype' | 'length'
>

/**
 * Flexible type which accepts any AI-function-like object, including:
 *   - `AIFunctionSet` - Sets of AI functions
 *   - `AIFunctionsProvider` - Client classes which expose an `AIFunctionSet`
 *      via the `.functions` property
 *   - `AIFunction` - Individual functions
 */
export type AIFunctionLike =
  | AIFunctionsProvider
  | AIFunction<AIFunctionInputSchema>
  | AIFunctionSet

/**
 * A function meant to be used with LLM function calling.
 */
export interface AIFunction<
  // TODO
  // InputSchema extends AIFunctionInputSchema = z.ZodObject<any>,
  InputSchema extends AIFunctionInputSchema = AIFunctionInputSchema,
  Output = any
> {
  /**
   * Invokes the underlying AI function `execute` but first validates the input
   * against this function's `inputSchema`. This method is callable and is
   * meant to be passed the raw LLM JSON string or an OpenAI-compatible Message.
   */
  (input: string | Msg): MaybePromise<Output>

  /** The schema for the input object (zod or custom schema). */
  inputSchema: InputSchema

  /** Parse the function arguments from a message. */
  parseInput(input: string | Msg): inferInput<InputSchema>

  /** The JSON schema function spec for the OpenAI API `functions` property. */
  spec: AIFunctionSpec

  /**
   * The underlying function implementation without any arg parsing or validation.
   */
  // TODO: this `any` shouldn't be necessary, but it is for `createAIFunction` results to be assignable to `AIFunctionLike`
  execute: (params: inferInput<InputSchema> | any) => MaybePromise<Output>

  /** Optional tags to help organize functions. */
  tags?: string[]
}

export type SafeParseResult<TData> =
  | {
      success: true
      data: TData
    }
  | {
      success: false
      error: string
    }

export type ParseFn<TData> = (value: unknown) => TData
export type SafeParseFn<TData> = (value: unknown) => SafeParseResult<TData>


================================================
FILE: stdlib/core/src/utils.test.ts
================================================
import ky from 'ky'
import pThrottle from 'p-throttle'
import { describe, expect, test } from 'vitest'

import { mockKyInstance } from './_utils'
import {
  omit,
  pick,
  pruneEmpty,
  pruneEmptyDeep,
  sanitizeSearchParams,
  stringifyForModel,
  throttleKy
} from './utils'

test('pick', () => {
  expect(pick({ a: 1, b: 2, c: 3 }, 'a', 'c')).toEqual({ a: 1, c: 3 })
  expect(
    pick({ a: { b: 'foo' }, d: -1, foo: null } as any, 'b', 'foo')
  ).toEqual({ foo: null })
})

test('omit', () => {
  expect(omit({ a: 1, b: 2, c: 3 }, 'a', 'c')).toEqual({ b: 2 })
  expect(omit({ a: { b: 'foo' }, d: -1, foo: null }, 'b', 'foo')).toEqual({
    a: { b: 'foo' },
    d: -1
  })
  expect(omit({ a: 1, b: 2, c: 3 }, 'foo', 'bar', 'c')).toEqual({ a: 1, b: 2 })
})

test('sanitizeSearchParams', () => {
  expect(
    sanitizeSearchParams({ a: 1, b: undefined, c: 13 }).toString()
  ).toMatchSnapshot()

  expect(sanitizeSearchParams({ a: [1, 2, 3] }).toString()).toMatchSnapshot()

  expect(
    sanitizeSearchParams({ b: ['a', 'b'], foo: true }).toString()
  ).toMatchSnapshot()

  expect(
    sanitizeSearchParams({ b: [false, true, false] }).toString()
  ).toMatchSnapshot()

  expect(
    sanitizeSearchParams({
      flag: ['foo', 'bar', 'baz'],
      token: 'test'
    }).toString()
  ).toMatchSnapshot()

  expect(sanitizeSearchParams({}).toString()).toMatchSnapshot()

  expect(sanitizeSearchParams({ a: [] }).toString()).toMatchSnapshot()
})

describe('stringifyForModel', () => {
  test('handles basic objects', () => {
    const input = {
      foo: 'bar',
      nala: ['is', 'cute'],
      kittens: null,
      cats: undefined,
      paws: 4.3
    }
    const result = stringifyForModel(input)
    expect(result).toEqual(JSON.stringify(input, null))
  })

  test('handles empty input', () => {
    const result = stringifyForModel()
    expect(result).toEqual('')
  })
})

test('pruneEmpty', () => {
  expect(
    pruneEmpty({
      a: 1,
      b: { foo: true },
      c: [true],
      d: 'foo',
      e: null,
      f: undefined
    })
  ).toEqual({
    a: 1,
    b: { foo: true },
    c: [true],
    d: 'foo'
  })

  expect(pruneEmpty({ a: 0, b: {}, c: [], d: '' })).toEqual({
    a: 0
  })
  expect(pruneEmpty({ b: {}, c: [], d: '' })).toEqual({})

  expect(
    pruneEmpty({
      a: null,
      b: { foo: [{}], bar: [null, undefined, ''] },
      c: ['', '', ''],
      d: '',
      e: undefined,
      f: [],
      g: {}
    })
  ).toEqual({
    b: { foo: [{}], bar: [null, undefined, ''] },
    c: ['', '', '']
  })
})

test('pruneEmptyDeep', () => {
  expect(
    pruneEmptyDeep({ a: 1, b: { foo: true }, c: [true], d: 'foo' })
  ).toEqual({
    a: 1,
    b: { foo: true },
    c: [true],
    d: 'foo'
  })

  expect(pruneEmptyDeep({ a: 0, b: {}, c: [], d: '' })).toEqual({
    a: 0
  })

  expect(
    pruneEmptyDeep({
      a: null,
      b: { foo: [{}], bar: [null, undefined, ''] },
      c: ['', '', ''],
      d: '',
      e: undefined
    })
  ).toEqual(undefined)
})

test(
  'throttleKy should rate-limit requests to ky properly',
  {
    timeout: 60_000
  },
  async () => {
    const interval = 1000
    const throttle = pThrottle({
      limit: 1,
      interval,
      strict: true
    })

    const ky2 = mockKyInstance(throttleKy(ky, throttle))

    const url = 'https://httpbin.org/get'

    for (let i = 0; i < 10; i++) {
      const before = Date.now()
      const res = await ky2.get(url)
      const after = Date.now()

      const duration = after - before
      // console.log(duration, res.status)
      expect(res.status).toBe(200)

      // leave a bit of wiggle room for the interval
      if (i > 0) {
        expect(duration >= interval - interval / 5).toBeTruthy()
      }
    }
  }
)


================================================
FILE: stdlib/core/src/utils.ts
================================================
import dedent from 'dedent'

import type * as types from './types'

export { assert } from './assert'
export { default as delay } from 'delay'

/**
 * From `inputObj`, create a new object that does not include `keys`.
 *
 * @example
 * ```js
 * omit({ a: 1, b: 2, c: 3 }, 'a', 'c') // { b: 2 }
 * ```
 */
export const omit = <
  T extends Record<string, unknown> | object,
  K extends keyof any
>(
  inputObj: T,
  ...keys: K[]
): Omit<T, K> => {
  const keysSet = new Set(keys)
  return Object.fromEntries(
    Object.entries(inputObj).filter(([k]) => !keysSet.has(k as any))
  ) as any
}

/**
 * From `inputObj`, create a new object that only includes `keys`.
 *
 * @example
 * ```js
 * pick({ a: 1, b: 2, c: 3 }, 'a', 'c') // { a: 1, c: 3 }
 * ```
 */
export const pick = <
  T extends Record<string, unknown> | object,
  K extends keyof T
>(
  inputObj: T,
  ...keys: K[]
): Pick<T, K> => {
  const keysSet = new Set(keys)
  return Object.fromEntries(
    Object.entries(inputObj).filter(([k]) => keysSet.has(k as any))
  ) as any
}

export function pruneUndefined<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(([, value]) => value !== undefined)
  ) as NonNullable<T>
}

export function pruneNullOrUndefined<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(
      ([, value]) => value !== undefined && value !== null
    )
  ) as NonNullable<T>
}

export function pruneNullOrUndefinedDeep<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  if (!obj || Array.isArray(obj) || typeof obj !== 'object') return obj

  return Object.fromEntries(
    Object.entries(obj)
      .filter(([, value]) => value !== undefined && value !== null)
      .map(([key, value]) =>
        Array.isArray(value)
          ? [
              key,
              value
                .filter((v) => v !== undefined && v !== null)
                .map(pruneNullOrUndefinedDeep as any)
            ]
          : typeof value === 'object'
            ? [key, pruneNullOrUndefinedDeep(value)]
            : [key, value]
      )
  ) as NonNullable<T>
}

export function pruneEmpty<T extends Record<string, any>>(
  obj: T
): NonNullable<{ [K in keyof T]: Exclude<T[K], undefined | null> }> {
  return Object.fromEntries(
    Object.entries(obj).filter(([, value]) => {
      if (value === undefined || value === null) return false
      if (typeof value === 'string' && !value) return false
      if (Array.isArray(value) && !value.length) return false
      if (
        typeof value === 'object' &&
        !Array.isArray(value) &&
        !Object.keys(value).length
      ) {
        return false
      }

      return true
    })
  ) as NonNullable<T>
}

export function pruneEmptyDeep<T>(
  value?: T
):
  | undefined
  | (T extends Record<string, any>
      ? { [K in keyof T]: Exclude<T[K], undefined | null> }
      : T extends Array<infer U>
        ? Array<Exclude<U, undefined | null>>
        : Exclude<T, null>) {
  if (value === undefined || value === null) return undefined

  if (typeof value === 'string') {
    if (!value) return undefined

    return value as any
  }

  if (Array.isArray(value)) {
    if (!value.length) return undefined

    value = value
      .map((v) => pruneEmptyDeep(v))
      .filter((v) => v !== undefined) as any

    if (!value || !Array.isArray(value) || !value.length) return undefined
    return value as any
  }

  if (typeof value === 'object') {
    if (!Object.keys(value).length) return undefined

    value = Object.fromEntries(
      Object.entries(value)
        .map(([k, v]) => [k, pruneEmptyDeep(v)])
        .filter(([, v]) => v !== undefined)
    )

    if (!value || !Object.keys(value).length) return undefined
    return value as any
  }

  return value as any
}

export function getEnv(name: string): string | undefined {
  try {
    return typeof process !== 'undefined'
      ? // eslint-disable-next-line no-process-env
        process.env?.[name]
      : undefined
  } catch {
    return undefined
  }
}

/**
 * Function that does nothing.
 */
export const noop = () => undefined

/**
 * Throttles HTTP requests made by a ky instance.
 *
 * Very useful for enforcing rate limits.
 */
export function throttleKy(
  ky: types.KyInstance,
  throttleFn: <Arguments extends readonly unknown[], ReturnValue>(
    function_: (...args_: Arguments) => ReturnValue
  ) => types.ThrottledFunction<(...args_: Arguments) => ReturnValue>
) {
  return ky.extend({
    hooks: {
      beforeRequest: [throttleFn(noop)]
    }
  })
}

/**
 * Creates a new `URLSearchParams` object with all values coerced to strings
 * that correctly handles arrays of values as repeated keys (or CSV) and
 * correctly removes `undefined` keys and values.
 */
export function sanitizeSearchParams(
  searchParams:
    | Record<
        string,
        string | number | boolean | string[] | number[] | boolean[] | undefined
      >
    | object,
  {
    csv = false
  }: {
    /**
     * Whether to use comma-separated-values for arrays or multiple entries.
     *
     * Defaults to `false` and will use multiple entries.
     */
    csv?: boolean
  } = {}
): URLSearchParams {
  const entries = Object.entries(searchParams).flatMap(([key, value]) => {
    if (key === undefined || value === undefined) {
      return []
    }

    if (Array.isArray(value)) {
      return value.map((v) => [key, String(v)])
    }

    return [[key, String(value)]]
  }) as [string, string][]

  if (!csv) {
    return new URLSearchParams(entries)
  }

  const csvEntries: Record<string, string> = {}
  for (const [key, value] of entries) {
    csvEntries[key] = csvEntries[key] ? `${csvEntries[key]},${value}` : value
  }

  return new URLSearchParams(csvEntries)
}

/**
 * Stringifies a JSON value in a way that's optimized for use with LLM prompts.
 *
 * Replacement for `JSON.stringify` when working with LLMs.
 *
 * @example
 * ```ts
 * stringifyForModel({ a: 1, b: 2 }) // '{"a":1,"b":2}'
 * ```
 */
export function stringifyForModel(
  jsonObject?: types.RelaxedJsonifiable,
  replacer: (number | string)[] | null = null,
  space: string | number = 0
): string {
  if (jsonObject === undefined) {
    return ''
  }

  if (typeof jsonObject === 'string') {
    return jsonObject
  }

  return JSON.stringify(jsonObject, replacer, space)
}

const dedenter = dedent.withOptions({ escapeSpecialCharacters: true })

/**
 * Cleans a string by removing extra newlines and indentation.
 *
 * @see: https://github.com/dmnd/dedent
 */
export function cleanStringForModel(text: string): string {
  return dedenter(text).trim()
}

export function isAIFunction(obj: any): obj is types.AIFunction {
  if (!obj) return false
  if (typeof obj !== 'function') return false
  if (!obj.inputSchema) return false
  if (!obj.parseInput) return false
  if (!obj.spec) return false
  if (!obj.execute) return false
  if (!obj.spec.name || typeof obj.spec.name !== 'string') return false

  return true
}

export function getErrorMessage(error?: unknown): string {
  if (!error) {
    return 'unknown error'
  }

  if (typeof error === 'string') {
    return error
  }

  const message = (error as any).message
  if (message && typeof message === 'string') {
    return message
  }

  try {
    return JSON.stringify(error)
  } catch {
    return 'unknown error'
  }
}

export function getShortDateString(date: Date = new Date()): string {
  return date.toISOString().split('T')[0]!
}


================================================
FILE: stdlib/core/src/zod-to-json-schema.test.ts
================================================
import { describe, expect, test } from 'vitest'
import { z } from 'zod'

import { zodToJsonSchema } from './zod-to-json-schema'

describe('zodToJsonSchema', () => {
  test('handles basic objects', () => {
    const params = zodToJsonSchema(
      z.object({
        name: z.string().min(1).describe('Name of the person'),
        age: z.number().int().optional().describe('Age in years')
      })
    )

    expect(params).toEqual({
      additionalProperties: false,
      type: 'object',
      required: ['name'],
      properties: {
        name: {
          type: 'string',
          description: 'Name of the person',
          minLength: 1
        },
        age: {
          type: 'integer',
          description: 'Age in years'
        }
      }
    })
  })

  test('handles enums and unions', () => {
    const params = zodToJsonSchema(
      z.object({
        name: z.string().min(1).describe('Name of the person'),
        sexEnum: z.enum(['male', 'female']),
        sexUnion: z.union([z.literal('male'), z.literal('female')])
      })
    )

    expect(params).toEqual({
      additionalProperties: false,
      type: 'object',
      required: ['name', 'sexEnum', 'sexUnion'],
      properties: {
        name: {
          type: 'string',
          description: 'Name of the person',
          minLength: 1
        },
        sexEnum: {
          type: 'string',
          enum: ['male', 'female']
        },
        sexUnion: {
          type: 'string',
          enum: ['male', 'female']
        }
      }
    })
  })

  test('handles optional properties in strict mode', () => {
    const params = zodToJsonSchema(
      z.object({
        name: z.string().optional(),
        age: z.number().optional().default(10)
      }),
      {
        strict: true
      }
    )

    expect(params).toEqual({
      additionalProperties: false,
      type: 'object',
      required: ['name', 'age'],
      properties: {
        name: {
          anyOf: [
            {
              type: 'string'
            },
            {
              type: 'null'
            }
          ]
        },
        age: {
          type: 'number',
          default: 10
        }
      }
    })
  })
})


================================================
FILE: stdlib/core/src/zod-to-json-schema.ts
================================================
import type { z } from 'zod'
import { zodToJsonSchema as zodToJsonSchemaImpl } from 'openai-zod-to-json-schema'

import type * as types from './types'
import { omit } from './utils'

/** Generate a JSON Schema from a Zod schema. */
export function zodToJsonSchema(
  schema: z.ZodType,
  {
    strict = false
  }: {
    strict?: boolean
  } = {}
): types.JSONSchema {
  return omit(
    zodToJsonSchemaImpl(schema, {
      $refStrategy: 'none',
      openaiStrictMode: strict
    }),
    '$schema',
    'default',
    'definitions',
    'description',
    'markdownDescription'
  )
}


================================================
FILE: stdlib/core/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/genkit/package.json
================================================
{
  "name": "@agentic/genkit",
  "version": "8.4.4",
  "description": "Agentic adapter for the Firebase Genkit AI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/genkit"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*"
  },
  "peerDependencies": {
    "genkit": "catalog:"
  },
  "devDependencies": {
    "genkit": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/genkit/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/genkit"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/genkit.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/genkit <!-- omit from toc -->

> Agentic adapter for the Firebase Genkit AI SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so/marketplace/ts-sdks/genkit)

## Install

```bash
npm i @agentic/genkit zod
```

## Usage

See https://docs.agentic.so/marketplace/ts-sdks/genkit

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/genkit/src/genkit.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { Genkit } from 'genkit'
import { expect, test } from 'vitest'

import { createGenkitTools, createGenkitToolsFromIdentifier } from './genkit'

test('createGenkitTools', () => {
  const genkit = new Genkit()
  expect(createGenkitTools(genkit, new EchoAITool())).toHaveLength(1)
})

test(
  'createGenkitToolsFromIdentifier',
  {
    timeout: 30_000
  },
  async () => {
    const genkit = new Genkit()
    const tools = await createGenkitToolsFromIdentifier(
      genkit,
      '@agentic/search'
    )
    expect(tools).toHaveLength(1)
    expect(tools[0]!.__action.name).toBe('search')
  }
)


================================================
FILE: stdlib/genkit/src/genkit.ts
================================================
import type { Genkit } from 'genkit'
import {
  type AIFunctionLike,
  AIFunctionSet,
  asZodOrJsonSchema,
  isZodSchema
} from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { z } from 'zod'

export type GenkitTool = ReturnType<Genkit['defineTool']>

/**
 * Converts a set of Agentic stdlib AI functions to an array of Genkit tools.
 */
export function createGenkitTools(
  genkit: Genkit,
  ...aiFunctionLikeTools: AIFunctionLike[]
): GenkitTool[] {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return fns.map((fn) => {
    const inputSchemaKey = isZodSchema(fn.inputSchema)
      ? ('inputSchema' as const)
      : ('inputJsonSchema' as const)

    return genkit.defineTool(
      {
        name: fn.spec.name,
        description: fn.spec.description,
        [inputSchemaKey]: asZodOrJsonSchema(fn.inputSchema),
        outputSchema: z.any()
      },
      fn.execute
    )
  })
}

/**
 * Creates an array of Genkit tools from a hosted Agentic project or deployment
 * identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const genkit = new Genkit()
 * const tools = await createGenkitToolsFromIdentifier(genkit, '@agentic/search')
 * ```
 */
export async function createGenkitToolsFromIdentifier(
  genkit: Genkit,
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<GenkitTool[]> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createGenkitTools(genkit, agenticToolClient)
}


================================================
FILE: stdlib/genkit/src/index.ts
================================================
export * from './genkit'


================================================
FILE: stdlib/genkit/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src", "*.config.ts"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/genkit/vitest.config.ts
================================================
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    server: {
      deps: {
        inline: true
      }
    }
  }
})


================================================
FILE: stdlib/langchain/package.json
================================================
{
  "name": "@agentic/langchain",
  "version": "8.4.4",
  "description": "Agentic adapter for the LangChain TS SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/langchain"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*"
  },
  "peerDependencies": {
    "@langchain/core": "catalog:"
  },
  "devDependencies": {
    "@langchain/core": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/langchain/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/langchain"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/langchain.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/langchain <!-- omit from toc -->

> Agentic adapter for the LangChain TS SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so/marketplace/ts-sdks/llamaindex)

## Install

```bash
npm i @agentic/langchain zod @langchain/core
```

## Usage

See https://docs.agentic.so/marketplace/ts-sdks/llamaindex

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/langchain/src/index.ts
================================================
export * from './langchain'


================================================
FILE: stdlib/langchain/src/langchain.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { expect, test } from 'vitest'

import {
  createLangChainTools,
  createLangChainToolsFromIdentifier
} from './langchain'

test('createLangChainTools', () => {
  expect(createLangChainTools(new EchoAITool())).toHaveLength(1)
})

test(
  'createLangChainToolsFromIdentifier',
  {
    timeout: 30_000
  },
  async () => {
    const tools = await createLangChainToolsFromIdentifier('@agentic/search')
    expect(tools).toHaveLength(1)
    expect(tools[0]!.name).toBe('search')
  }
)


================================================
FILE: stdlib/langchain/src/langchain.ts
================================================
import {
  type AIFunctionLike,
  AIFunctionSet,
  asZodOrJsonSchema,
  stringifyForModel
} from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { DynamicStructuredTool } from '@langchain/core/tools'

/**
 * Converts a set of Agentic stdlib AI functions to an array of LangChain
 * tools (`DynamicStructuredTool[]`).
 */
export function createLangChainTools(
  ...aiFunctionLikeTools: AIFunctionLike[]
): DynamicStructuredTool[] {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return fns.map(
    (fn) =>
      new DynamicStructuredTool({
        name: fn.spec.name,
        description: fn.spec.description,
        schema: asZodOrJsonSchema(fn.inputSchema),
        func: async (input) => {
          const result = await Promise.resolve(fn.execute(input))
          // LangChain tools require the output to be a string
          return stringifyForModel(result)
        }
      })
  )
}

/**
 * Creates a Vercel AI SDK's `tools` object from a hosted Agentic project or
 * deployment identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const tools = await createLangChainToolsFromIdentifier('@agentic/search')
 * ```
 */
export async function createLangChainToolsFromIdentifier(
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<DynamicStructuredTool[]> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createLangChainTools(agenticToolClient)
}


================================================
FILE: stdlib/langchain/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/license
================================================
All Agentic packages under the `stdlib/` folder are MIT licensed.

---

**MIT License**

Copyright (c) 2025 Travis Fischer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


================================================
FILE: stdlib/llamaindex/package.json
================================================
{
  "name": "@agentic/llamaindex",
  "version": "8.4.4",
  "description": "Agentic adapter for the LlamaIndex AI SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/llamaindex"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*"
  },
  "peerDependencies": {
    "llamaindex": "catalog:"
  },
  "devDependencies": {
    "llamaindex": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/llamaindex/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/llamaindex"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/llamaindex.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/llamaindex <!-- omit from toc -->

> Agentic adapter for the LlamaIndex TS SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so/marketplace/ts-sdks/llamaindex)

## Install

```bash
npm i @agentic/llamaindex zod llamaindex
```

## Usage

See https://docs.agentic.so/marketplace/ts-sdks/llamaindex

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/llamaindex/src/index.ts
================================================
export * from './llamaindex'


================================================
FILE: stdlib/llamaindex/src/llamaindex.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { expect, test } from 'vitest'

import {
  createLlamaIndexTools,
  createLlamaIndexToolsFromIdentifier
} from './llamaindex'

test('createLlamaIndexTools', () => {
  expect(createLlamaIndexTools(new EchoAITool())).toHaveLength(1)
})

test(
  'createLlamaIndexToolsFromIdentifier',
  {
    timeout: 30_000
  },
  async () => {
    const tools = await createLlamaIndexToolsFromIdentifier('@agentic/search')
    expect(tools).toHaveLength(1)
    expect(tools[0]!.metadata.name).toBe('search')
  }
)


================================================
FILE: stdlib/llamaindex/src/llamaindex.ts
================================================
import {
  type AIFunctionLike,
  AIFunctionSet,
  asZodOrJsonSchema
} from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { FunctionTool, type JSONValue } from 'llamaindex'

export type LlamaIndexTool = FunctionTool<any, JSONValue | Promise<JSONValue>>

/**
 * Converts a set of Agentic stdlib AI functions to an array of LlamaIndex
 * tools (`FunctionTool[]`).
 */
export function createLlamaIndexTools(
  ...aiFunctionLikeTools: AIFunctionLike[]
): LlamaIndexTool[] {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return fns.map((fn) =>
    FunctionTool.from(fn.execute, {
      name: fn.spec.name,
      description: fn.spec.description,
      // TODO: Investigate types here
      parameters: asZodOrJsonSchema(fn.inputSchema) as any
    })
  )
}

/**
 * Creates an array of LlamaIndex tools from a hosted Agentic project or
 * deployment identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const tools = await createLlamaIndexToolsFromIdentifier('@agentic/search')
 * ```
 */
export async function createLlamaIndexToolsFromIdentifier(
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<LlamaIndexTool[]> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createLlamaIndexTools(agenticToolClient)
}


================================================
FILE: stdlib/llamaindex/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/mastra/package.json
================================================
{
  "name": "@agentic/mastra",
  "version": "8.4.4",
  "description": "Agentic adapter for the Mastra AI Agent SDK.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/mastra"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit",
    "test:unit": "vitest run"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@agentic/platform-tool-client": "workspace:*",
    "@mastra/schema-compat": "catalog:",
    "ai": "catalog:"
  },
  "peerDependencies": {
    "@mastra/core": "catalog:"
  },
  "devDependencies": {
    "@mastra/core": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/mastra/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/mastra"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/mastra.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/mastra <!-- omit from toc -->

> Agentic adapter for the Mastra AI Agent SDK.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so/marketplace/ts-sdks/mastra)

## Install

```bash
npm i @agentic/mastra zod @mastra/core
```

## Usage

See https://docs.agentic.so/marketplace/ts-sdks/mastra

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/mastra/src/index.ts
================================================
export * from './mastra'


================================================
FILE: stdlib/mastra/src/mastra.test.ts
================================================
import { EchoAITool } from '@agentic/core'
import { expect, test } from 'vitest'

import { createMastraTools, createMastraToolsFromIdentifier } from './mastra'

test('createMastraTools', () => {
  expect(createMastraTools(new EchoAITool())).toHaveProperty('echo')
})

test(
  'createMastraToolsFromIdentifier',
  {
    timeout: 30_000
  },
  async () => {
    const tools = await createMastraToolsFromIdentifier('@agentic/search')
    expect(tools).toHaveProperty('search')
  }
)


================================================
FILE: stdlib/mastra/src/mastra.ts
================================================
import {
  type AIFunctionLike,
  AIFunctionSet,
  asAgenticSchema,
  isZodSchema
} from '@agentic/core'
import {
  AgenticToolClient,
  type AgenticToolClientOptions
} from '@agentic/platform-tool-client'
import { createTool } from '@mastra/core/tools'
import { convertSchemaToZod } from '@mastra/schema-compat'
import { jsonSchema } from 'ai'

export type MastraTool = ReturnType<typeof createTool>

/**
 * Converts a set of Agentic stdlib AI functions to an object compatible with
 * the Mastra Agent `tools` parameter.
 */
export function createMastraTools(
  ...aiFunctionLikeTools: AIFunctionLike[]
): Record<string, MastraTool> {
  const fns = new AIFunctionSet(aiFunctionLikeTools)

  return Object.fromEntries(
    fns.map((fn) => {
      // https://github.com/mastra-ai/mastra/tree/main/packages/schema-compat
      const aiSchema = isZodSchema(fn.inputSchema)
        ? fn.inputSchema
        : jsonSchema(asAgenticSchema(fn.inputSchema).jsonSchema)
      const inputSchema = convertSchemaToZod(aiSchema)

      return [
        fn.spec.name,
        createTool({
          id: fn.spec.name,
          description: fn.spec.description,
          inputSchema,
          execute: (ctx) => fn.execute(ctx.context)
        })
      ]
    })
  )
}

/**
 * Creates a Mastra Agent `tools` object from a hosted Agentic project or
 * deployment identifier.
 *
 * You'll generally use a project identifier, which will automatically use
 * that project's `latest` version, but if you want to target a specific
 * version or preview deployment, you can use a fully-qualified deployment
 * identifier.
 *
 * @example
 * ```ts
 * const tools = await createMastraToolsFromIdentifier('@agentic/search')
 * ```
 */
export async function createMastraToolsFromIdentifier(
  projectOrDeploymentIdentifier: string,
  opts: AgenticToolClientOptions = {}
): Promise<Record<string, MastraTool>> {
  const agenticToolClient = await AgenticToolClient.fromIdentifier(
    projectOrDeploymentIdentifier,
    opts
  )

  return createMastraTools(agenticToolClient)
}


================================================
FILE: stdlib/mastra/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/mcp/package.json
================================================
{
  "name": "@agentic/mcp",
  "version": "8.4.4",
  "description": "Agentic SDK for exposing tools from an MCP client in a way that easily interops with all TypeScript AI SDKs.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/mcp"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "@modelcontextprotocol/sdk": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/mcp/src/index.ts
================================================
export * from './mcp-tools'
export type * from './types'


================================================
FILE: stdlib/mcp/src/mcp-tools.ts
================================================
import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js'
import type {
  CallToolResult,
  ListToolsResult
} from '@modelcontextprotocol/sdk/types.js'
import {
  AIFunctionSet,
  AIFunctionsProvider,
  assert,
  createAIFunction,
  createJsonSchema
} from '@agentic/core'
import { Client as McpClient } from '@modelcontextprotocol/sdk/client/index.js'
import { type z } from 'zod'

import type { McpToolsFilter, McpToolsOptions } from './types'
import { paginate } from './paginate'

/**
 * Agentic tools provider wrapping an MCP client.
 *
 * You likely want to use `createMcpTools` to create an instance of `McpTools`
 * which enables exposing MCP server tools to the agentic ecosystem.
 *
 * @see https://modelcontextprotocol.io
 */
export class McpTools extends AIFunctionsProvider {
  readonly name: string
  readonly client: McpClient
  readonly rawToolResponses: boolean

  protected _toolsMap: Map<string, ListToolsResult['tools'][number]> | undefined
  protected readonly _toolsFilter: McpToolsFilter | undefined

  protected constructor({
    name,
    client,
    toolsFilter,
    rawToolResponses = false
  }: {
    client: McpClient
  } & McpToolsOptions) {
    super()

    this.name = name
    this.client = client
    this.rawToolResponses = rawToolResponses

    this._toolsFilter = toolsFilter
  }

  override get functions(): AIFunctionSet {
    assert(this._functions)
    return this._functions
  }

  /**
   * Initialize the McpTools instance by fetching all available tools from the MCP client.
   * This method must be called before using this class' tools.
   * It is called automatically when using `McpTools.from()`.
   */
  protected async _init() {
    const capabilties = this.client.getServerCapabilities()
    const initPromises: Promise<any>[] = []

    if (capabilties?.tools) {
      initPromises.push(this._initTools())
    }

    // TODO: handle prompts, resources, etc.
    await Promise.all(initPromises)
  }

  protected async _initTools() {
    const tools = await paginate({
      size: Infinity,
      handler: async ({ cursor }: { cursor?: string }) => {
        const { tools, nextCursor } = await this.client.listTools({ cursor })
        return { data: tools, nextCursor } as const
      }
    })

    const enabledTools = this._toolsFilter
      ? tools.filter((tool) => this._toolsFilter!(tool.name))
      : tools

    this._toolsMap = new Map(enabledTools.map((tool) => [tool.name, tool]))
    this._updateFunctions()
  }

  protected _updateFunctions() {
    assert(this._toolsMap)

    this._functions = new AIFunctionSet(
      Array.from(this._toolsMap.entries()).map(([_name, tool]) => {
        return createAIFunction(
          {
            name: `${this.name}_${tool.name}`,
            description: tool.description ?? `${this.name} ${tool.name}`,
            inputSchema: createJsonSchema(tool.inputSchema),
            strict: true
          },
          async (args) => {
            const result = await this.client.callTool({
              name: tool.name,
              arguments: args
            })

            if (this.rawToolResponses) {
              return result
            }

            return processToolCallResult(result as CallToolResult)
          }
        )
      })
    )
  }

  async callTool(name: string, args: z.infer<z.ZodObject<any>>) {
    const tool =
      this._toolsMap?.get(name) ?? this._toolsMap?.get(`${this.name}_${name}`)
    assert(tool, `Tool ${name} not found`)

    const result = await this.client.callTool({ name, arguments: args })
    return result
  }

  /**
   * Creates a new McpTools instance from an existing, fully initialized
   * MCP client.
   *
   * You probably want to use `createMcpTool` instead, which makes initializing
   * the MCP client and connecting to its transport easier.
   *
   * All tools within the `McpTools` instance will be namespaced under the given
   * `name`.
   */
  static async fromMcpClient(params: { client: McpClient } & McpToolsOptions) {
    const mcpTools = new McpTools(params)
    await mcpTools._init()
    return mcpTools
  }
}

/**
 * Creates a new McpTools instance by connecting to an MCP server. You must
 * provide either an existing `transport`, an existing `serverUrl`, or a
 * `serverProcess` to spawn.
 *
 * All tools within the `McpTools` instance will be namespaced under the given
 * `name`.
 */
export async function createMcpTools(
  params: McpToolsOptions
): Promise<McpTools> {
  const transport = await createMcpTransport(params)
  const client = new McpClient(
    { name: params.name, version: params.version || '1.0.0' },
    { capabilities: {} }
  )
  await client.connect(transport)

  return McpTools.fromMcpClient({ client, ...params })
}

/**
 * Creates a new MCP transport from either an existing `transport`, an existing
 * `serverUrl`, or a `serverProcess` to spawn.
 */
export async function createMcpTransport(
  params: McpToolsOptions
): Promise<Transport> {
  if (params.transport) return params.transport

  if (params.serverUrl) {
    const { SSEClientTransport } = await import(
      '@modelcontextprotocol/sdk/client/sse.js'
    )
    return new SSEClientTransport(new URL(params.serverUrl))
  }

  if (params.serverProcess) {
    const { StdioClientTransport } = await import(
      '@modelcontextprotocol/sdk/client/stdio.js'
    )
    return new StdioClientTransport(params.serverProcess)
  }

  throw new Error(
    'Unable to create a server connection with supplied options. Must provide transport, stdio, or sseUrl.'
  )
}

function toText(c: CallToolResult['content']) {
  return c.map((p) => p.text || '').join('')
}

function processToolCallResult(result: CallToolResult) {
  if (result.isError) return { error: toText(result.content) }

  if (result.content.every((c) => !!c.text)) {
    const text = toText(result.content)
    if (text.trim().startsWith('{') || text.trim().startsWith('[')) {
      try {
        return JSON.parse(text)
      } catch {
        return text
      }
    }
    return text
  }

  if (result.content.length === 1) return result.content[0]
  return result
}


================================================
FILE: stdlib/mcp/src/paginate.ts
================================================
export interface PaginateInput<T, C> {
  size: number
  handler: (data: {
    cursor?: C
    limit: number
  }) => Promise<{ data: T[]; nextCursor?: C }>
}

export async function paginate<T, C = number>(
  input: PaginateInput<T, C>
): Promise<T[]> {
  const acc: T[] = []
  let cursor: C | undefined

  while (acc.length < input.size) {
    const { data, nextCursor } = await input.handler({
      cursor,
      limit: input.size - acc.length
    })
    acc.push(...data)

    if (nextCursor === undefined || data.length === 0) {
      break
    }

    cursor = nextCursor
  }

  if (acc.length > input.size) {
    acc.length = input.size
  }

  return acc
}


================================================
FILE: stdlib/mcp/src/types.ts
================================================
import type { StdioServerParameters } from '@modelcontextprotocol/sdk/client/stdio.js'
import type { Transport } from '@modelcontextprotocol/sdk/shared/transport.js'

export type McpToolsFilter = (toolName: string) => boolean

export interface McpToolsOptions {
  /**
   * Provide a name for this client which will be its namespace for all tools and prompts.
   */
  name: string

  /**
   * Provide a version number for this client (defaults to 1.0.0).
   */
  version?: string

  /**
   * If you already have an MCP transport you'd like to use, pass it here to connect to the server.
   */
  transport?: Transport

  /**
   * Start a local server process using the stdio MCP transport.
   */
  serverProcess?: StdioServerParameters

  /**
   * Connect to a remote server process using the SSE MCP transport.
   */
  serverUrl?: string

  /**
   * Return tool responses in raw MCP form instead of processing them for Genkit compatibility.
   */
  rawToolResponses?: boolean

  /**
   * An optional filter function to determine which tools should be enabled.
   *
   * By default, all tools available on the MCP server will be enabled, but you
   * can use this to filter a subset of those tools.
   */
  toolsFilter?: McpToolsFilter
}

// TODO
// export interface McpServerOptions {
//   /** The name you want to give your server for MCP inspection. */
//   name: string
//
//   /** The version you want the server to advertise to clients. Defaults to 1.0.0. */
//   version?: string
// }


================================================
FILE: stdlib/mcp/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/serpapi/package.json
================================================
{
  "name": "@agentic/serpapi",
  "version": "8.4.4",
  "description": "Agentic SDK for SerpAPI Google Search.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/serpapi"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/serpapi/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/serpapi"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/serpapi.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/serpapi <!-- omit from toc -->

> Agentic SDK for [SerpAPI](https://serpapi.com) Google Search.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so)

## Install

```bash
npm i @agentic/serpapi zod
```

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/serpapi/src/index.ts
================================================
export * from './serpapi-client'


================================================
FILE: stdlib/serpapi/src/serpapi-client.ts
================================================
import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

/**
 * All types have been exported from the `serpapi` package, which we're
 * not using directly because it is bloated and has compatibility issues.
 */

export namespace serpapi {
  export const API_BASE_URL = 'https://serpapi.com'

  export type BaseResponse<P = Record<string | number | symbol, never>> = {
    search_metadata: {
      id: string
      status: string | 'Queued' | 'Processing' | 'Success'
      json_endpoint: string
      created_at: string
      processed_at: string
      raw_html_file: string
      total_time_taken: number
    }
    search_parameters: {
      engine: string
    } & Omit<BaseParameters & P, 'api_key' | 'no_cache' | 'async' | 'timeout'>
    serpapi_pagination?: {
      next: string
    }
    pagination?: {
      next: string
    }
    [key: string]: any
  }

  export type BaseParameters = {
    /**
     * Parameter defines the device to use to get the results. It can be set to
     * `desktop` (default) to use a regular browser, `tablet` to use a tablet browser
     * (currently using iPads), or `mobile` to use a mobile browser (currently
     * using iPhones).
     */
    device?: 'desktop' | 'tablet' | 'mobile'

    /**
     * Parameter will force SerpApi to fetch the Google results even if a cached
     * version is already present. A cache is served only if the query and all
     * parameters are exactly the same. Cache expires after 1h. Cached searches
     * are free, and are not counted towards your searches per month. It can be set
     * to `false` (default) to allow results from the cache, or `true` to disallow
     * results from the cache. `no_cache` and `async` parameters should not be used together.
     */
    no_cache?: boolean

    /**
     * Parameter defines the way you want to submit your search to SerpApi. It can
     * be set to `false` (default) to open an HTTP connection and keep it open until
     * you got your search results, or `true` to just submit your search to SerpApi
     * and retrieve them later. In this case, you'll need to use our
     * [Searches Archive API](https://serpapi.com/search-archive-api) to retrieve
     * your results. `async` and `no_cache` parameters should not be used together.
     * `async` should not be used on accounts with
     * [Ludicrous Speed](https://serpapi.com/plan) enabled.
     */
    async?: boolean

    /**
     * Parameter defines the SerpApi private key to use.
     */
    api_key?: string | null

    /**
     * Specify the client-side timeout of the request. In milliseconds.
     */
    timeout?: number
  }

  export type GoogleParameters = BaseParameters & {
    /**
     * Search Query
     * Parameter defines the query you want to search. You can use anything that you
     * would use in a regular Google search. e.g. `inurl:`, `site:`, `intitle:`. We
     * also support advanced search query parameters such as as_dt and as_eq. See the
     * [full list](https://serpapi.com/advanced-google-query-parameters) of supported
     * advanced search query parameters.
     */
    q: string

    /**
     * Location
     * Parameter defines from where you want the search to originate. If several
     * locations match the location requested, we'll pick the most popular one. Head to
     * the [/locations.json API](https://serpapi.com/locations-api) if you need more
     * precise control. location and uule parameters can't be used together. Avoid
     * utilizing location when setting the location outside the U.S. when using Google
     * Shopping and/or Google Product API.
     */
    location?: string

    /**
     * Encoded Location
     * Parameter is the Google encoded location you want to use for the search. uule
     * and location parameters can't be used together.
     */
    uule?: string

    /**
     * Google Place ID
     * Parameter defines the id (`CID`) of the Google My Business listing you want to
     * scrape. Also known as Google Place ID.
     */
    ludocid?: string

    /**
     * Additional Google Place ID
     * Parameter that you might have to use to force the knowledge graph map view to
     * show up. You can find the lsig ID by using our [Local Pack
     * API](https://serpapi.com/local-pack) or [Places Results
     * API](https://serpapi.com/places-results).
     * lsig ID is also available via a redirect Google uses within [Google My
     * Business](https://www.google.com/business/).
     */
    lsig?: string

    /**
     * Google Knowledge Graph ID
     * Parameter defines the id (`KGMID`) of the Google Knowledge Graph listing you
     * want to scrape. Also known as Google Knowledge Graph ID. Searches with kgmid
     * parameter will return results for the originally encrypted search parameters.
     * For some searches, kgmid may override all other parameters except start, and num
     * parameters.
     */
    kgmid?: string

    /**
     * Google Cached Search Parameters ID
     * Parameter defines the cached search parameters of the Google Search you want to
     * scrape. Searches with si parameter will return results for the originally
     * encrypted search parameters. For some searches, si may override all other
     * parameters except start, and num parameters. si can be used to scrape Google
     * Knowledge Graph Tabs.
     */
    si?: string

    /**
     * Domain
     * Parameter defines the Google domain to use. It defaults to `google.com`. Head to
     * the [Google domains page](https://serpapi.com/google-domains) for a full list of
     * supported Google domains.
     */
    google_domain?: string

    /**
     * Country
     * Parameter defines the country to use for the Google search. It's a two-letter
     * country code. (e.g., `us` for the United States, `uk` for United Kingdom, or
     * `fr` for France). Head to the [Google countries
     * page](https://serpapi.com/google-countries) for a full list of supported Google
     * countries.
     */
    gl?: string

    /**
     * Language
     * Parameter defines the language to use for the Google search. It's a two-letter
     * language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French).
     * Head to the [Google languages page](https://serpapi.com/google-languages) for a
     * full list of supported Google languages.
     */
    hl?: string

    /**
     * Set Multiple Languages
     * Parameter defines one or multiple languages to limit the search to. It uses
     * `lang_{two-letter language code}` to specify languages and `|` as a delimiter.
     * (e.g., `lang_fr|lang_de` will only search French and German pages). Head to the
     * [Google lr languages page](https://serpapi.com/google-lr-languages) for a full
     * list of supported languages.
     */
    lr?: string

    /**
     * as_dt
     * Parameter controls whether to include or exclude results from the site named in
     * the as_sitesearch parameter.
     */
    as_dt?: string

    /**
     * as_epq
     * Parameter identifies a phrase that all documents in the search results must
     * contain. You can also use the [phrase
     * search](https://developers.google.com/custom-search/docs/xml_results#PhraseSearchqt)
     * query term to search for a phrase.
     */
    as_epq?: string

    /**
     * as_eq
     * Parameter identifies a word or phrase that should not appear in any documents in
     * the search results. You can also use the [exclude
     * query](https://developers.google.com/custom-search/docs/xml_results#Excludeqt)
     * term to ensure that a particular word or phrase will not appear in the documents
     * in a set of search results.
     */
    as_eq?: string

    /**
     * as_lq
     * Parameter specifies that all search results should contain a link to a
     * particular URL. You can also use the
     * [link:](https://developers.google.com/custom-search/docs/xml_results#BackLinksqt)
     * query term for this type of query.
     */
    as_lq?: string

    /**
     * as_nlo
     * Parameter specifies the starting value for a search range. Use as_nlo and as_nhi
     * to append an inclusive search range.
     */
    as_nlo?: string

    /**
     * as_nhi
     * Parameter specifies the ending value for a search range. Use as_nlo and as_nhi
     * to append an inclusive search range.
     */
    as_nhi?: string

    /**
     * as_oq
     * Parameter provides additional search terms to check for in a document, where
     * each document in the search results must contain at least one of the additional
     * search terms. You can also use the [Boolean
     * OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)
     * query term for this type of query.
     */
    as_oq?: string

    /**
     * as_q
     * Parameter provides search terms to check for in a document. This parameter is
     * also commonly used to allow users to specify additional terms to search for
     * within a set of search results.
     */
    as_q?: string

    /**
     * as_qdr
     * Parameter requests search results from a specified time period (quick date
     * range). The following values are supported:
     * `d[number]`: requests results from the specified number of past days. Example
     * for the past 10 days: `as_qdr=d10`
     * `w[number]`: requests results from the specified number of past weeks.
     * `m[number]`: requests results from the specified number of past months.
     * `y[number]`: requests results from the specified number of past years. Example
     * for the past year: `as_qdr=y`
     */
    as_qdr?: string

    /**
     * as_rq
     * Parameter specifies that all search results should be pages that are related to
     * the specified URL. The parameter value should be a URL. You can also use the
     * [related:](https://developers.google.com/custom-search/docs/xml_results#RelatedLinksqt)
     * query term for this type of query.
     */
    as_rq?: string

    /**
     * as_sitesearch
     * Parameter allows you to specify that all search results should be pages from a
     * given site. By setting the as_dt parameter, you can also use it to exclude pages
     * from a given site from your search resutls.
     */
    as_sitesearch?: string

    /**
     * Advanced Search Parameters
     * (to be searched) parameter defines advanced search parameters that aren't
     * possible in the regular query field. (e.g., advanced search for patents, dates,
     * news, videos, images, apps, or text contents).
     */
    tbs?: string

    /**
     * Adult Content Filtering
     * Parameter defines the level of filtering for adult content. It can be set to
     * `active`, or `off` (default).
     */
    safe?: string

    /**
     * Exclude Auto-corrected Results
     * Parameter defines the exclusion of results from an auto-corrected query that is
     * spelled wrong. It can be set to `1` to exclude these results, or `0` to include
     * them (default).
     */
    nfpr?: string

    /**
     * Results Filtering
     * Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are
     * on or off. It can be set to `1` (default) to enable these filters, or `0` to
     * disable these filters.
     */
    filter?: string

    /**
     * Search Type
     * (to be matched) parameter defines the type of search you want to do.
     * It can be set to:
     * `(no tbm parameter)`: regular Google Search,
     * `isch`: [Google Images API](https://serpapi.com/images-results),
     * `lcl` - [Google Local API](https://serpapi.com/local-results)
     * `vid`: [Google Videos API](https://serpapi.com/videos-results),
     * `nws`: [Google News API](https://serpapi.com/news-results),
     * `shop`: [Google Shopping API](https://serpapi.com/shopping-results),
     * or any other Google service.
     */
    tbm?: string

    /**
     * Result Offset
     * Parameter defines the result offset. It skips the given number of results. It's
     * used for pagination. (e.g., `0` (default) is the first page of results, `10` is
     * the 2nd page of results, `20` is the 3rd page of results, etc.).
     * Google Local Results only accepts multiples of `20`(e.g. `20` for the second
     * page results, `40` for the third page results, etc.) as the start value.
     */
    start?: number

    /**
     * Number of Results
     * Parameter defines the maximum number of results to return. (e.g., `10` (default)
     * returns 10 results, `40` returns 40 results, and `100` returns 100 results).
     */
    num?: number

    /**
     * Page Number (images)
     * Parameter defines the page number for [Google
     * Images](https://serpapi.com/images-results). There are 100 images per page. This
     * parameter is equivalent to start (offset) = ijn * 100. This parameter works only
     * for [Google Images](https://serpapi.com/images-results) (set tbm to `isch`).
     */
    ijn?: string
  }

  export interface SearchResult extends BaseResponse<GoogleParameters> {
    search_metadata: SearchMetadata
    search_parameters: SearchParameters
    search_information: SearchInformation
    local_map?: LocalMap
    local_results?: LocalResults
    answer_box?: AnswerBox
    knowledge_graph?: KnowledgeGraph
    inline_images?: InlineImage[]
    inline_people_also_search_for?: InlinePeopleAlsoSearchFor[]
    related_questions?: SearchResultRelatedQuestion[]
    organic_results?: OrganicResult[]
    related_searches?: RelatedSearch[]
    pagination: Pagination
    serpapi_pagination: Pagination
    twitter_results?: TwitterResults
  }

  export interface TwitterResults {
    title: string
    link: string
    displayed_link: string
    tweets: Tweet[]
  }

  export interface Tweet {
    link: string
    snippet: string
    published_date: string
  }

  export interface AnswerBox {
    type: string
    title: string
    link: string
    displayed_link: string
    snippet: string
    snippet_highlighted_words: string[]
    images: string[]
    about_this_result: AboutThisResult
    about_page_link: string
    cached_page_link: string
  }

  export interface InlineImage {
    link: string
    source: string
    thumbnail: string
    original: string
    source_name: string
    title?: string
  }

  export interface InlinePeopleAlsoSearchFor {
    title: string
    items: SearchItem[]
    see_more_link: string
    see_more_serpapi_link: string
  }

  export interface SearchItem {
    name: string
    image: string
    link: string
    serpapi_link: string
  }

  export interface KnowledgeGraph {
    type: string
    kgmid: string
    knowledge_graph_search_link: string
    serpapi_knowledge_graph_search_link: string
    header_images: HeaderImage[]
    description: string
    source: Source
    buttons: Button[]
    people_also_search_for: SearchItem[]
    people_also_search_for_link: string
    people_also_search_for_stick: string
    list: { [key: string]: string[] }
  }

  export interface Button {
    text: string
    subtitle: string
    title: string
    link: string
    displayed_link: string
    snippet?: string
    snippet_highlighted_words?: string[]
    answer?: string
    thumbnail: string
    search_link: string
    serpapi_search_link: string
    date?: string
    list?: string[]
  }

  export interface HeaderImage {
    image: string
    source: string
  }

  export interface Source {
    name: string
    link: string
  }

  export interface LocalMap {
    link: string
    image: string
    gps_coordinates: LocalMapGpsCoordinates
  }

  export interface LocalMapGpsCoordinates {
    latitude: number
    longitude: number
    altitude: number
  }

  export interface LocalResults {
    places: Place[]
    more_locations_link: string
  }

  export interface Place {
    position: number
    title: string
    rating?: number
    reviews_original?: string
    reviews?: number
    place_id: string
    place_id_search: string
    lsig: string
    thumbnail: string
    gps_coordinates: PlaceGpsCoordinates
    service_options: ServiceOptions
    address?: string
    type?: string
    hours?: string
  }

  export interface PlaceGpsCoordinates {
    latitude: number
    longitude: number
  }

  export interface ServiceOptions {
    dine_in?: boolean
    takeout: boolean
    no_delivery?: boolean
  }

  export interface OrganicResult {
    position: number
    title: string
    link: string
    displayed_link: string
    thumbnail?: string
    favicon?: string
    snippet: string
    snippet_highlighted_words: string[]
    sitelinks?: Sitelinks
    rich_snippet?: RichSnippet
    about_this_result: AboutThisResult
    cached_page_link: string
    related_pages_link?: string
    source: string
    related_results?: RelatedResult[]
    date?: string
    related_questions?: OrganicResultRelatedQuestion[]
  }

  export interface AboutThisResult {
    keywords: string[]
    languages: string[]
    regions: string[]
  }

  export interface OrganicResultRelatedQuestion {
    question: string
    snippet: string
    snippet_links: SnippetLink[]
  }

  export interface SnippetLink {
    text: string
    link: string
  }

  export interface RelatedResult {
    position: number
    title: string
    link: string
    displayed_link: string
    snippet: string
    snippet_highlighted_words: string[]
    about_this_result: AboutThisResult
    cached_page_link: string
  }

  export interface RichSnippet {
    bottom: Bottom
  }

  export interface Bottom {
    extensions?: string[]
    questions?: string[]
  }

  export interface Sitelinks {
    inline: Inline[]
  }

  export interface Inline {
    title: string
    link: string
  }

  export interface Pagination {
    current: number
    next: string
    other_pages: { [key: string]: string }
    next_link?: string
  }

  export interface SearchResultRelatedQuestion {
    question: string
    snippet: string
    title: string
    link: string
    displayed_link: string
    thumbnail: string
    next_page_token: string
    serpapi_link: string
    date?: string
  }

  export interface RelatedSearch {
    query: string
    link: string
  }

  export interface SearchInformation {
    organic_results_state: string
    query_displayed: string
    total_results: number
    time_taken_displayed: number
    menu_items: MenuItem[]
  }

  export interface MenuItem {
    position: number
    title: string
    link: string
    serpapi_link?: string
  }

  export interface SearchMetadata {
    id: string
    status: string
    json_endpoint: string
    created_at: string
    processed_at: string
    google_url: string
    raw_html_file: string
    total_time_taken: number
  }

  export interface SearchParameters {
    engine: string
    q: string
    google_domain: string
    device?: 'desktop' | 'tablet' | 'mobile'
  }

  export type ClientParams = Partial<Omit<GoogleParameters, 'q'>>
}

/**
 * Lightweight wrapper around SerpAPI for Google search.
 *
 * @see https://serpapi.com/search-api
 */
export class SerpAPIClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string
  protected readonly params: serpapi.ClientParams

  constructor({
    apiKey = getEnv('SERPAPI_API_KEY') ?? getEnv('SERP_API_KEY'),
    apiBaseUrl = serpapi.API_BASE_URL,
    ky = defaultKy,
    ...params
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } & serpapi.ClientParams = {}) {
    assert(
      apiKey,
      'SerpAPIClient missing required "apiKey" (defaults to "SERPAPI_API_KEY")'
    )
    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl
    this.params = params

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl
    })
  }

  /**
   * Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.
   */
  @aiFunction({
    name: 'serpapi_google_search',
    description:
      'Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.',
    inputSchema: z.object({
      q: z.string().describe('search query'),
      num: z
        .number()
        .int()
        .default(5)
        .optional()
        .describe('number of results to return')
    })
  })
  async search(queryOrOpts: string | serpapi.GoogleParameters) {
    const defaultGoogleParams: Partial<serpapi.GoogleParameters> = {}
    const options: serpapi.GoogleParameters =
      typeof queryOrOpts === 'string'
        ? { ...defaultGoogleParams, q: queryOrOpts }
        : queryOrOpts
    const { timeout, ...rest } = this.params

    // console.log('SerpAPIClient.search', options)
    return this.ky
      .get('search', {
        searchParams: {
          ...rest,
          engine: 'google',
          api_key: this.apiKey,
          ...(options as any)
        },
        timeout
      })
      .json<serpapi.SearchResult>()
  }
}


================================================
FILE: stdlib/serpapi/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: stdlib/serper/package.json
================================================
{
  "name": "@agentic/serper",
  "version": "8.4.4",
  "description": "Agentic SDK for the Serper Google Search API.",
  "author": "Travis Fischer <travis@transitivebullsh.it>",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/transitive-bullshit/agentic.git",
    "directory": "stdlib/serper"
  },
  "type": "module",
  "sideEffects": false,
  "source": "./src/index.ts",
  "types": "./dist/index.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.js",
      "default": "./dist/index.js"
    }
  },
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsup",
    "clean": "del dist",
    "test": "run-s test:*",
    "test:typecheck": "tsc --noEmit"
  },
  "dependencies": {
    "@agentic/core": "workspace:*",
    "ky": "catalog:"
  },
  "peerDependencies": {
    "zod": "catalog:"
  },
  "publishConfig": {
    "access": "public"
  }
}


================================================
FILE: stdlib/serper/readme.md
================================================
<p align="center">
  <a href="https://agentic.so">
    <img alt="Agentic" src="https://raw.githubusercontent.com/transitive-bullshit/agentic/main/apps/web/public/agentic-social-image-light.jpg" width="640">
  </a>
</p>

<p>
  <a href="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml"><img alt="Build Status" src="https://github.com/transitive-bullshit/agentic/actions/workflows/main.yml/badge.svg" /></a>
  <a href="https://www.npmjs.com/package/@agentic/serper"><img alt="NPM" src="https://img.shields.io/npm/v/@agentic/serper.svg" /></a>
  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
</p>

# @agentic/serper <!-- omit from toc -->

> Agentic SDK for the [Serper](https://serper.dev) Google Search API.

- [Website](https://agentic.so)
- [Docs](https://docs.agentic.so)

## Install

```bash
npm i @agentic/serper zod
```

## License

[MIT](https://choosealicense.com/licenses/mit/)


================================================
FILE: stdlib/serper/src/index.ts
================================================
export * from './serper-client'


================================================
FILE: stdlib/serper/src/serper-client.ts
================================================
import {
  aiFunction,
  AIFunctionsProvider,
  assert,
  getEnv,
  omit
} from '@agentic/core'
import defaultKy, { type KyInstance } from 'ky'
import { z } from 'zod'

export namespace serper {
  export const API_BASE_URL = 'https://google.serper.dev'

  export const SearchParamsSchema = z.object({
    q: z.string().describe('search query'),
    autocorrect: z.boolean().default(true).optional(),
    gl: z.string().default('us').optional(),
    hl: z.string().default('en').optional(),
    page: z.number().int().default(1).optional(),
    num: z
      .number()
      .int()
      .default(10)
      .optional()
      .describe('number of results to return')
  })
  export type SearchParams = z.infer<typeof SearchParamsSchema>

  export const GeneralSearchSchema = SearchParamsSchema.extend({
    type: z
      .enum(['search', 'images', 'videos', 'places', 'news', 'shopping'])
      .default('search')
      .optional()
      .describe('Type of Google search to perform')
  })
  export type GeneralSearchParams = z.infer<typeof GeneralSearchSchema>

  export interface SearchResponse {
    searchParameters: SearchParameters & { type: 'search' }
    organic: Organic[]
    answerBox?: AnswerBox
    knowledgeGraph?: KnowledgeGraph
    topStories?: TopStory[]
    peopleAlsoAsk?: PeopleAlsoAsk[]
    relatedSearches?: RelatedSearch[]
  }

  export interface SearchImagesResponse {
    searchParameters: SearchParameters & { type: 'images' }
    images: Image[]
  }

  export interface SearchVideosResponse {
    searchParameters: SearchParameters & { type: 'videos' }
    videos: Video[]
  }

  export interface SearchPlacesResponse {
    searchParameters: SearchParameters & { type: 'places' }
    places: Place[]
  }

  export interface SearchNewsResponse {
    searchParameters: SearchParameters & { type: 'news' }
    news: News[]
  }

  export interface SearchShoppingResponse {
    searchParameters: SearchParameters & { type: 'shopping' }
    shopping: Shopping[]
  }

  export type Response =
    | SearchResponse
    | SearchImagesResponse
    | SearchVideosResponse
    | SearchPlacesResponse
    | SearchNewsResponse
    | SearchShoppingResponse

  export interface KnowledgeGraph {
    title: string
    type: string
    website: string
    imageUrl: string
    description: string
    descriptionSource: string
    descriptionLink: string
    attributes: Record<string, string>
  }

  export interface Organic {
    title: string
    link: string
    snippet: string
    position: number
    imageUrl?: string
    sitelinks?: SiteLink[]
  }

  export interface AnswerBox {
    snippet: string
    snippetHighlighted?: string[]
    title: string
    link: string
    date?: string
    position?: number
  }

  export interface SiteLink {
    title: string
    link: string
  }

  export interface PeopleAlsoAsk {
    question: string
    snippet: string
    title: string
    link: string
  }

  export interface RelatedSearch {
    query: string
  }

  export interface SearchParameters {
    q: string
    gl: string
    hl: string
    num: number
    autocorrect: boolean
    page: number
    type: string
    engine: string
  }

  export interface TopStory {
    title: string
    link: string
    source: string
    date: string
    imageUrl: string
  }

  export interface Image {
    title: string
    imageUrl: string
    imageWidth: number
    imageHeight: number
    thumbnailUrl: string
    thumbnailWidth: number
    thumbnailHeight: number
    source: string
    domain: string
    link: string
    googleUrl: string
    position: number
  }

  export interface Video {
    title: string
    link: string
    snippet: string
    date: string
    imageUrl: string
    position: number
  }

  export interface Place {
    position: number
    title: string
    address: string
    latitude: number
    longitude: number
    category: string
    phoneNumber?: string
    website: string
    cid: string
    rating?: number
    ratingCount?: number
  }

  export interface News {
    title: string
    link: string
    snippet: string
    date: string
    source: string
    imageUrl: string
    position: number
  }

  export interface Shopping {
    title: string
    source: string
    link: string
    price: string
    imageUrl: string
    delivery?: Record<string, string>
    rating?: number
    ratingCount?: number
    offers?: string
    productId?: string
    position: number
  }

  export type ClientParams = Partial<Omit<SearchParams, 'q'>>
}

/**
 * Lightweight wrapper around Serper for Google search.
 *
 * @see https://serper.dev
 */
export class SerperClient extends AIFunctionsProvider {
  protected readonly ky: KyInstance
  protected readonly apiKey: string
  protected readonly apiBaseUrl: string
  protected readonly params: serper.ClientParams

  constructor({
    apiKey = getEnv('SERPER_API_KEY'),
    apiBaseUrl = serper.API_BASE_URL,
    ky = defaultKy,
    ...params
  }: {
    apiKey?: string
    apiBaseUrl?: string
    ky?: KyInstance
  } & serper.ClientParams = {}) {
    assert(
      apiKey,
      'SerperClient missing required "apiKey" (defaults to "SERPER_API_KEY")'
    )

    super()

    this.apiKey = apiKey
    this.apiBaseUrl = apiBaseUrl
    this.params = params

    this.ky = ky.extend({
      prefixUrl: this.apiBaseUrl,
      headers: {
        'x-api-key': this.apiKey
      }
    })
  }

  /**
   * Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.
   */
  @aiFunction({
    name: 'serper_google_search',
    description:
      'Uses Google Search to return the most relevant web pages for a given query. Useful for finding up-to-date news and information about any topic.',
    inputSchema: serper.GeneralSearchSchema.pick({
      q: true,
      num: true,
      type: true
    })
  })
  async search(queryOrOpts: string | serper.GeneralSearchParams) {
    const searchType =
      typeof queryOrOpts === 'string' ? 'search' : queryOrOpts.type || 'search'
    return this._fetch<serper.SearchResponse>(
      searchType,
      typeof queryOrOpts === 'string' ? queryOrOpts : omit(queryOrOpts, 'type')
    )
  }

  async searchImages(queryOrOpts: string | serper.SearchParams) {
    return this._fetch<serper.SearchImagesResponse>('images', queryOrOpts)
  }

  async searchVideos(queryOrOpts: string | serper.SearchParams) {
    return this._fetch<serper.SearchVideosResponse>('videos', queryOrOpts)
  }

  async searchPlaces(queryOrOpts: string | serper.SearchParams) {
    return this._fetch<serper.SearchPlacesResponse>('places', queryOrOpts)
  }

  async searchNews(queryOrOpts: string | serper.SearchParams) {
    return this._fetch<serper.SearchNewsResponse>('news', queryOrOpts)
  }

  async searchProducts(queryOrOpts: string | serper.SearchParams) {
    return this._fetch<serper.SearchShoppingResponse>('shopping', queryOrOpts)
  }

  protected async _fetch<T extends serper.Response>(
    endpoint: string,
    queryOrOpts: string | serper.SearchParams
  ): Promise<T> {
    const params = {
      ...this.params,
      ...(typeof queryOrOpts === 'string' ? { q: queryOrOpts } : queryOrOpts)
    }

    return this.ky.post(endpoint, { json: params }).json<T>()
  }
}


================================================
FILE: stdlib/serper/tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["node_modules", "dist"]
}


================================================
FILE: todo.md
================================================
## API Gateway

- **MCP**: `https://gateway.agentic.so/@{username}/{project-slug}/mcp`
- **HTTP**: `GET/POST` `https://gateway.agentic.so/@{username}/{project-slug}/{tool-name}`

## TODO: Post-MVP

- **website**
  - llms.txt for all projects
  - handle browser back/forward with `?next=`
  - add some social proof to signup page
- api gateway stress tests
- auth
  - custom auth provider configs for projects/deployments
- stripe
  - declarative json-based pricing
    - like Saasify and https://github.com/tierrun/tier
    - https://github.com/tierrun/tier/blob/main/pricing/schema.json
    - https://blog.tier.run/tier-hello-world-demo
- re-add support for teams / organizations
- consider switching to [consola](https://github.com/unjs/consola) for logging?
- consider switching to `bun` (for `--hot` reloading!!)
- validate stability of pricing plan slugs across deployments
  - same for pricing plan line-items
- replace `ms` package
- **API gateway**
  - SSE support? (no; post-mvp if at all; only support [streamable http](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http) like smithery does, or maybe support both?)
  - signed requests
  - add support for custom headers on responses
  - add ability to only report stripe usage on non-cached requests
  - add support for ToolConfig.cost defaulting to 1, to easily support tools which cost multiple "credits"
  - extra `Sentry` instrumentation (`setUser`, `captureMessage`, etc)
  - test handling of binary bodies and responses
  - improve logger vs console for non-hono path and util methods
  - consider replacing `eventId` with uuids for `requestId`?
  - openapi origin kitchen sink
    - add more test cases to e2e tests for diff content types
  - mcp origin kitchen sink
  - add support for `/sse`? need to test with claude desktop
  - test handling of resources
- `@agentic/platform-hono`
  - fix sentry middleware
    - https://github.com/honojs/middleware/blob/main/packages/sentry/src/index.ts
    - https://github.com/honojs/middleware/issues/943
    - https://github.com/getsentry/sentry-javascript/tree/master/packages/cloudflare
- **Origin MCP servers**
  - how to guarantee that the request is coming from agentic?
    - `_meta` for tool calls
    - _still need a way of doing this for initial connection requests_
    - _=> ask in the official mcp developers discord_
  - mcp auth provider support
  - test binary bodies / responses / mcp resources
  - resources
  - prompts
  - other MCP features?
- additional transactional emails
- handle or validate against dynamic MCP origin tools
- upgrade to zod v4
- decide whether deployment fields like `defaultRateLimit` and others should be generated and stored in the db, or should be inferred based on `undefined` values
- support multiple rate-limits by slug
  - RateLimit-Policy: "burst";q=100;w=60,"daily";q=1000;w=86400
  - https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/
- handle hosting of deployment and user images
- about page inspiration: https://mastra.ai/about
- simplify overlap between `@agentic/core` and `@agentic/platform-core`
- consider simplifying `AgenticToolClient` to only require one package per TS LLM SDK
  - `createAISDKToolsFromIdentifier(projectIdentifier)`
- consider allowing deployments to specify their proxy secret instead of a single, per-project proxy secret
- add docs on using multiple tools with `AIFunctionSet`
- add support for `crewai`
- add scroll appearance motion to hero animation
- add ts sdk examples to e2e tests
- add feature about optimized context to docs
- import react example usage component into docs
- add [ping](https://modelcontextprotocol.io/specification/2025-03-26/basic/utilities/ping) support to mcp servers
- fix readme css <img height="..."> not taking effect because of tailwind css preflight which sets `img, video { height: auto }`
  - we still want this for every other scenario; just want to sandbox the github-style readme markdown css...
- add `--llm` flag to cli (https://x.com/badlogicgames/status/1940370344990441726)
- support claude Desktop Extensions ([DXT](https://github.com/anthropics/dxt)) ([post](https://www.anthropic.com/engineering/desktop-extensions))
- add mcp-remote to support stdio-only mcp clients like claude desktop
- add docs on how to use with [chatgpt's mcp custom connectors](https://platform.openai.com/docs/mcp) ([requires pro account or team/enterprise/edu workspace](https://help.openai.com/en/articles/11487775-connectors-in-chatgpt#h_d2a53d4230))
- add support for enterprise / custom / contact us pricing
- consider changing homepage hero CTA to include publishing
- docs: add notes about constraints on mcp origin servers (static tools)
- analytics dashboard
- UX onboarding
- visual pricing plan config + previews
- marketplace public project detail page
  - add breadcrumb nav: marketplace > @agentic > search
  - add last published date somewhere
  - tool input/output schemas; move `$schema` to the top
  - break out into a few subcomponents; some can be server components
  - mcp inspector


================================================
FILE: tsconfig.json
================================================
{
  "extends": "@fisch0920/config/tsconfig-node",
  "include": ["*.config.ts"],
  "exclude": ["node_modules"]
}


================================================
FILE: tsup.config.ts
================================================
import { defineConfig } from 'tsup'

export default defineConfig([
  {
    entry: ['src/index.ts'],
    outDir: 'dist',
    target: 'node18',
    platform: 'node',
    format: ['esm'],
    splitting: false,
    sourcemap: true,
    minify: false,
    shims: true,
    dts: true
  }
])


================================================
FILE: turbo.json
================================================
{
  "$schema": "https://turbo.build/schema.json",
  "ui": "stream",
  "tasks": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**", ".next/**", "!.next/cache/**"],
      "outputLogs": "new-only",
      "inputs": ["$TURBO_DEFAULT$", ".env", ".env.*"]
    },
    "clean": {
      "cache": false,
      "dependsOn": ["^clean"]
    },
    "test": {
      "dependsOn": ["test:format", "test:lint", "test:typecheck", "test:unit"]
    },
    "test:lint": {
      "dependsOn": ["//#test:lint", "^test:lint"],
      "outputLogs": "errors-only"
    },
    "test:typecheck": {
      "dependsOn": ["^test:typecheck"],
      "outputLogs": "errors-only"
    },
    "test:unit": {
      "dependsOn": ["^test:unit"],
      "outputLogs": "errors-only"
    },
    "test:format": {
      "dependsOn": ["//#test:format", "^test:format"]
    },
    "//#test:format": {},
    "//#test:lint": {},
    "dev": {
      "cache": false,
      "persistent": true
    },
    "docs": {
      "cache": false,
      "persistent": true
    }
  }
}